deal APIv1.3.0

DealItem

The detailed data returned for the deal item.

Type that uses DealItem

Call that uses DealItem

Fields

Field
Type
Description
additionalImages
array of Image
The additional images for the deal item.
categoryAncestorIds
array of string
The IDs of the ancestors for the primary category.
categoryId
The ID of the leaf category for the deal item. A leaf category is the lowest level in a category and has no children.
commissionable
A boolean value specifying whether the listing has commission.
dealAffiliateWebUrl
The deal associated with the item with affiliate attribution.
dealEndDate
The date after which the deal ends.
dealStartDate
The date on which the deal starts.
dealWebUrl
The web URL for the deal associated with the item.
energyEfficiencyClass
A string value specifying the Energy Efficiency class.
image
The primary image for the deal item.
itemAffiliateWebUrl
The item web URL with affiliate attribution.
itemGroupId
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.
itemGroupType
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.
itemId
The unique identifier for the deal item.

Note: This field is only returned for single-SKU items.
itemWebUrl
The web URL for the deal item.
legacyItemId
The legacy item ID associated with the deal item.
marketingPrice
The original price for the deal item, and the discount amount and percentage.
price
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.
qualifiedPrograms
array of ProgramEnum
A list of programs applicable to the item.
shippingOptions
The cost required to ship the deal item.
title
The title of the deal item.
unitPrice
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"
unitPricingMeasure
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"