APIHub
Back to Explore

Deal API

<span class="tablenote"><b>Note:</b> This is a <a href="https://developer.ebay.com/api-docs/static/versioning.html#limited" target="_blank"> <img src="/cms/img/docs/partners-api.svg" class="legend-icon partners-icon" title="Limited Release" alt="Limited Release" />(Limited Release)</a> API available only to select developers approved by business units.</span><br /><br />This API allows third-party

Shopping
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

2687ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/deal_item

This method retrieves a paginated set of deal items. The result set contains all deal items associated with the specified search criteria and marketplace ID. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.

  • category_ids (query) — The unique identifier of the eBay category for the search.
  • commissionable (query) — A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace.
  • delivery_country (query) — A filter for items that can be shipped to the specified country.
  • limit (query, limit) — The maximum number of items, from the current result set, returned on a single page.
  • offset (query, offset) — The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0
  • X-EBAY-C-MARKETPLACE-ID (header, required) — A header used to specify the eBay marketplace ID.
GET

/event

This method returns paginated results containing all eBay events for the specified marketplace. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.

  • limit (query, limit) — The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
  • offset (query, offset) — The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0
  • X-EBAY-C-MARKETPLACE-ID (header, required) — A header used to specify the eBay marketplace ID.
GET

/event/{event_id}

This method retrieves the details for an eBay event. The result set contains detailed information associated with the specified event ID, such as applicable coupons, start and end dates, and event terms. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.

  • X-EBAY-C-MARKETPLACE-ID (header, required) — A header used to specify the eBay marketplace ID.
  • event_id (path, required) — The unique identifier for the eBay event.
GET

/event_item

This method returns a paginated set of event items. The result set contains all event items associated with the specified search criteria and marketplace ID. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.

  • category_ids (query) — The unique identifier of the eBay category for the search. Maximum Value: 1
  • delivery_country (query) — A filter for items that can be shipped to the specified country.
  • event_ids (query, required) — The unique identifiers for the eBay events. Maximum Value: 1
  • limit (query, limit) — The maximum number of items, from the current result set, returned on a single page. Default: 20
  • offset (query, offset) — The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0
  • X-EBAY-C-MARKETPLACE-ID (header, required) — A header used to specify the eBay marketplace ID.

4 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://api.ebay.com{basePath}/deal_item"

api.ebay.com{basepath} · HTTPS only