Deal API
Note: This is a (Limited Release) API available only to select developers approved by business units. This API allows third-party developers to search for and…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Note: This is a (Limited Release) API available only to select developers approved by business units. This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
Endpoints 4
deal_item
- GETgetDealItems
/deal_item?category_ids=string&commissionable=string&delivery_country=string&limit=string&offset=stringThis method retrieves a paginated set of deal items. The result set contains all deal items associated with the specified search criteria and marketplace ID.…
event
- GETgetEvents
/event?limit=string&offset=stringThis method returns paginated results containing all eBay events for the specified marketplace. Request headers This method uses the X-EBAY-C-ENDUSERCTX… - GETgetEvent
/event/:event_idThis method retrieves the details for an eBay event. The result set contains detailed information associated with the specified event ID, such as applicable…
event_item
- GETgetEventItems
/event_item?category_ids=string&delivery_country=string&event_ids=string&limit=string&offset=stringThis method returns a paginated set of event items. The result set contains all event items associated with the specified search criteria and marketplace ID.…
API details
- Base URL
https://api.ebay.com{basePath}- Authentication
- OAuth 2.0 (client credentials flow) with 1 scope
- Operations
- 4 operations on 4 pathsGET 4
- Main resources
- event 2deal_item 1event_item 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
v1.3.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Deal API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Deal API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “getDealItems” (GET /deal_item?category_ids=string&commissionable=string&delivery_country=string&limit=string&offset=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Deal API?
Note: This is a (Limited Release) API available only to select developers approved by business units. This API allows third-party developers to search for and… It is listed under E-commerce and has 4 endpoints.
Who publishes the Deal API?
It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Deal API?
Requests go to https://api.ebay.com{basePath}. Endpoint paths are added to this base URL.
How do I authenticate with the Deal API?
With OAuth 2.0 (client credentials flow) with 1 scope.
How many endpoints does the Deal API have?
4 operations on 4 paths (4 GET). The largest groups are event, deal_item, event_item.
Is forking the Deal API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.