Home
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.
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 theitemAffiliateWebUrl
field to forward your buyer to the ebay.com site. This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
Parameter | Type | Description |
---|---|---|
limit | string | The maximum number of items, from the current result set, returned on a single page. Occurrence: Optional |
offset | string | 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 Occurrence: Optional |
category_ids | string | The unique identifier of the eBay category for the search. Occurrence: Optional |
commissionable | string | A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace. Occurrence: Optional |
delivery_country | string | A filter for items that can be shipped to the specified country. Occurrence: Optional |
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
Header | Type | Description |
---|---|---|
X-EBAY-C-MARKETPLACE-ID | string | A header used to specify the eBay marketplace ID. Occurrence: Required |
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/buy.deal
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
This call has no response headers.
Output container/field | Type | Description |
---|---|---|
dealItems | array of DealItem | A list of deal items that match the search criteria. Occurrence: Conditional |
dealItems.additionalImages | array of Image | The additional images for the deal item. Occurrence: Conditional |
dealItems.additionalImages.height | string | The height of the image. Occurrence: Conditional |
dealItems.additionalImages.imageUrl | string | The relative path to the image location. Occurrence: Conditional |
dealItems.additionalImages.text | string | The text associated with the image. Occurrence: Conditional |
dealItems.additionalImages.width | string | The width of the image. Occurrence: Conditional |
dealItems.categoryAncestorIds | array of string | The IDs of the ancestors for the primary category. Occurrence: Conditional |
dealItems.categoryId | string | The ID of the leaf category for the deal item. A leaf category is the lowest level in a category and has no children. Occurrence: Conditional |
dealItems.commissionable | boolean | A boolean value specifying whether the listing has commission. Occurrence: Conditional |
dealItems.dealAffiliateWebUrl | string | The deal associated with the item with affiliate attribution. Occurrence: Conditional |
dealItems.dealEndDate | string | The date after which the deal ends. Occurrence: Conditional |
dealItems.dealStartDate | string | The date on which the deal starts. Occurrence: Conditional |
dealItems.dealWebUrl | string | The web URL for the deal associated with the item. Occurrence: Conditional |
dealItems.energyEfficiencyClass | string | A string value specifying the Energy Efficiency class. Occurrence: Conditional |
dealItems.image | Image | The primary image for the deal item. Occurrence: Conditional |
dealItems.image.height | string | The height of the image. Occurrence: Conditional |
dealItems.image.imageUrl | string | The relative path to the image location. Occurrence: Conditional |
dealItems.image.text | string | The text associated with the image. Occurrence: Conditional |
dealItems.image.width | string | The width of the image. Occurrence: Conditional |
dealItems.itemAffiliateWebUrl | string | The item web URL with affiliate attribution. Occurrence: Conditional |
dealItems.itemGroupId | string | The unique identifier for the deal item group. This is the parent item ID for the seller-defined variations. Occurrence: Conditional |
dealItems.itemGroupType | ItemGroupTypeEnum | An enumeration value that indicates the type of item group. An item group contains items that have various aspect differences, such as color, size, or storage capacity. Occurrence: Conditional |
dealItems.itemId | string | The unique identifier for the deal item. Occurrence: Conditional |
dealItems.itemWebUrl | string | The web URL for the deal item. Occurrence: Conditional |
dealItems.legacyItemId | string | The legacy item ID associated with the deal item. Occurrence: Always |
dealItems.marketingPrice | MarketingPrice | The original price for the deal item, and the discount amount and percentage. Occurrence: Conditional |
dealItems.marketingPrice.discountAmount | Amount | The monetary value of the seller discount. Occurrence: Conditional |
dealItems.marketingPrice.discountAmount.currency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the value field. Occurrence: Conditional |
dealItems.marketingPrice.discountAmount.value | string | The monetary value, in the currency specified by the currency field. Occurrence: Conditional |
dealItems.marketingPrice.discountPercentage | string | The percentage of the seller discount based on the value returned in the originalPrice field. Occurrence: Conditional |
dealItems.marketingPrice.originalPrice | Amount | The monetary value of the item prior to the discount. Occurrence: Conditional |
dealItems.marketingPrice.originalPrice.currency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the value field. Occurrence: Conditional |
dealItems.marketingPrice.originalPrice.value | string | The monetary value, in the currency specified by the currency field. Occurrence: Conditional |
dealItems.marketingPrice.priceTreatment | PriceTreatmentEnum | The pricing treatment (discount) that was applied to the price of the item. Occurrence: Conditional |
dealItems.price | Amount | The price for the deal item. Occurrence: Conditional |
dealItems.price.currency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the value field. Occurrence: Conditional |
dealItems.price.value | string | The monetary value, in the currency specified by the currency field. Occurrence: Conditional |
dealItems.qualifiedPrograms | array of ProgramEnum | A list of programs applicable to the item. Occurrence: Conditional |
dealItems.shippingOptions | array of ShippingOption | The cost required to ship the deal item. Occurrence: Conditional |
dealItems.shippingOptions.shippingCost | Amount | The final shipping cost for all items after all discounts are applied. Occurrence: Always |
dealItems.shippingOptions.shippingCost.currency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the value field. Occurrence: Conditional |
dealItems.shippingOptions.shippingCost.value | string | The monetary value, in the currency specified by the currency field. Occurrence: Conditional |
dealItems.shippingOptions.shippingCostType | string | The class of the shipping cost. Occurrence: Always |
dealItems.title | string | The title of the deal item. Occurrence: Conditional |
dealItems.unitPrice | Amount | The price per unit for the deal item. Some European countries require listings for certain types of products to include the price per unit so that buyers can accurately compare prices. Occurrence: Conditional |
dealItems.unitPrice.currency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the value field. Occurrence: Conditional |
dealItems.unitPrice.value | string | The monetary value, in the currency specified by the currency field. Occurrence: Conditional |
dealItems.unitPricingMeasure | string | The designation used to specify the quantity of the deal item, such as size, weight, volume, and count. This helps buyers compare prices. Occurrence: Conditional |
href | string | The relative path to the current set of results. Occurrence: Conditional |
limit | integer | The maximum number of items, from the current result set, returned on a single page. Occurrence: Conditional |
next | string | The relative path to the next set of results. Occurrence: Conditional |
offset | integer | 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. Occurrence: Conditional |
prev | string | The relative path to the previous set of results. Occurrence: Conditional |
total | integer | The total number of matches for the search criteria. Occurrence: Conditional |
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
Status | Meaning |
---|---|
200 | OK |
400 | Bad Request |
403 | Forbidden |
500 | Internal Server Error |
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
180000 | API_DEAL | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
180001 | API_DEAL | REQUEST | Invalid, missing or unsupported marketplace. Please refer to documentation. |
180002 | API_DEAL | REQUEST | The specified limit is invalid. Maximum value supported is 100. |
180003 | API_DEAL | REQUEST | The specified offset is invalid. |
180005 | API_DEAL | REQUEST | category_ids length exceeded. Please check documentation for maximum values supported. |
180007 | API_DEAL | REQUEST | Invalid or unsupported filter 'commissionable' for the requested marketplace. Please refer to documentation. |
180009 | API_DEAL | REQUEST | Not authorized. Please contact developer support for assistance. |
180010 | API_DEAL | REQUEST | Invalid filter for 'delivery_country'. Please refer to the documentation for supported values. |
This call has no warnings.
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
This sample retrieves a paginated set of deal items associated with the specified search criteria and marketplace ID.
The inputs are the category_ids and limit URI parameters. There is no payload with this request.
GEThttps://api.ebay.com/buy/deal/v1/deal_item?category_ids=257818&limit=1
If the call is successful, one deal item matching the specified search criteria and marketplace will be returned.