getDealItems: eBay Deal API | eBay Developers Program

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.

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.

Input

Resource URI

GET https://api.ebay.com/buy/deal/v1/deal_item?

limit=string&

offset=string&

category_ids=string&

commissionable=string&

delivery_country=string

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

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	This query parameter specifies the unique identifier of the eBay category for the search. For details see Get Categories for Buy APIs. Occurrence: Optional
commissionable	string	This query parameter allows the response to filter by commissionable items. If set to `true`, only commissionable items will be returned in the response. If set to `false`, commissionable items will not be returned in the response. Note: This filter is currently only supported for the US marketplace. Occurrence: Optional
delivery_country	string	This query parameter allows the response to only return items that can be shipped to the specified country (2-digit ISO code). Occurrence: Optional

HTTP request headers

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-ENDUSERCTX	string	This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations. For additional information, refer to Use request headers section of the Buying Integration Guide. Occurrence: Optional
X-EBAY-C-MARKETPLACE-ID	string	This header identifies the eBay marketplace. See HTTP request headers for supported marketplace ID values. Occurrence: Required

Header

Type

Description

X-EBAY-C-ENDUSERCTX

string

This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.

For additional information, refer to Use request headers section of the Buying Integration Guide.

Occurrence: Optional

X-EBAY-C-MARKETPLACE-ID

string

This header identifies the eBay marketplace.

See HTTP request headers for supported marketplace ID values.

Occurrence: Required

OAuth scope

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.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* DealItemSearchResponse */

"dealItems" : [

{ /* DealItem */

"additionalImages" : [

{ /* Image */

"height" : "string",

"imageUrl" : "string",

"text" : "string",

"width" : "string"

}

"categoryAncestorIds" : [

"string"

"categoryId" : "string",

"commissionable" : "boolean",

"dealAffiliateWebUrl" : "string",

"dealEndDate" : "string",

"dealStartDate" : "string",

"dealWebUrl" : "string",

"energyEfficiencyClass" : "string",

"image" :

{ /* Image */

"height" : "string",

"imageUrl" : "string",

"text" : "string",

"width" : "string"

"itemAffiliateWebUrl" : "string",

"itemGroupId" : "string",

"itemGroupType" : "ItemGroupTypeEnum : [SELLER_DEFINED_VARIATIONS]",

"itemId" : "string",

"itemWebUrl" : "string",

"legacyItemId" : "string",

"marketingPrice" :

{ /* MarketingPrice */

"discountAmount" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"discountPercentage" : "string",

"originalPrice" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"priceTreatment" : "PriceTreatmentEnum : [MINIMUM_ADVERTISED_PRICE,LIST_PRICE,MARKDOWN]"

"price" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"qualifiedPrograms" : [

"ProgramEnum : [EBAY_PLUS]"

"shippingOptions" : [

{ /* ShippingOption */

"shippingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"shippingCostType" : "string"

}

"title" : "string",

"unitPrice" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"unitPricingMeasure" : "string"

}

"href" : "string",

"limit" : "integer",

"next" : "string",

"offset" : "integer",

"prev" : "string",

"total" : "integer"

}

Response fields

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. Note: This field is returned for multiple-SKU items. 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. Note: This field is only returned for single-SKU items. 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. Default: The currency of the authenticated user's country. 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. Default: The currency of the authenticated user's country. 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. Note: The pricing treatment affects how and where the discounted price can be displayed. Occurrence: Conditional
dealItems.price	Amount	The price for the deal item. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the `X-EBAY-C-MARKETPLACE-ID` request header specifying the supported marketplace (such as `EBAY_GB`) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. Occurrence: Conditional
dealItems.price.currency	CurrencyCodeEnum	The three-letter ISO 4217 code representing the currency of the amount in the value field. Default: The currency of the authenticated user's country. 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. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the `X-EBAY-C-MARKETPLACE-ID` request header specifying the supported marketplace (such as `EBAY_GB`) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. Occurrence: Always
dealItems.shippingOptions.shippingCost.currency	CurrencyCodeEnum	The three-letter ISO 4217 code representing the currency of the amount in the value field. Default: The currency of the authenticated user's country. 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. Valid Values: `FIXED` or `CALCULATED` Code so that your app gracefully handles any future changes to this list. 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. For example: `"unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"` Occurrence: Conditional
dealItems.unitPrice.currency	CurrencyCodeEnum	The three-letter ISO 4217 code representing the currency of the amount in the value field. Default: The currency of the authenticated user's country. 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. For example, the following tells the buyer that the item is 7.99 per 100 grams. `"unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"` 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. Default: `20` 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. 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: 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

HTTP status codes

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

Error codes

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.

Warnings

This call has no warnings.

Samples

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.

Sample 1: Retrieve Deal Items for a Specified Marketplace

This sample retrieves a paginated set of deal items associated with the specified search criteria and marketplace ID.

Input

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

Output

If the call is successful, one deal item matching the specified search criteria and marketplace will be returned.

{
    "dealItems": [
        {
            "itemId": "v1|1**********0|0",
            "legacyItemId": "1**********0",
            "title": "sample item title",
            "image": {
                "imageUrl": "https://i.ebayimg.com/images/g/~**********N/s-l225.jpg"
            },
            "marketingPrice": {
                "originalPrice": {
                    "value": "29.99",
                    "currency": "USD"
                },
                "discountPercentage": "17.0",
                "discountAmount": {
                    "value": "5.0",
                    "currency": "USD"
                },
                "priceTreatment": "LIST_PRICE"
            },
            "price": {
                "value": "24.99",
                "currency": "USD"
            },
            "shippingOptions": [
                {
                    "shippingCost": {
                        "value": "0.0",
                        "currency": "USD"
                    },
                    "shippingCostType": "FIXED"
                }
            ],
            "itemWebUrl": "https://www.ebay.com/itm/sample-item-title/1**********0?_trkparms=%**********0",
            "categoryId": "257818",
            "categoryAncestorIds": [
                "12576",
                "11815",
                "185284"
            ],
            "commissionable": true,
            "dealWebUrl": "https://www.ebay.com/deals/1**********6",
            "dealStartDate": "2020-07-08T15:26:00Z",
            "dealEndDate": "2020-07-15T14:59:59Z"
        }
    ],
    "total": 29705,
    "href": "https://api.ebay.com/buy/deal/v1/deal_item?offset=0&limit=1",
    "next": "https://api.ebay.com/buy/deal/v1/deal_item?offset=1&limit=1",
    "limit": 1,
    "offset": 0
}