deal APIv1.3.0

getEventItems

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.

Input

Resource URI (production)

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

URI parameters

ParameterTypeDescription
limitstringThe maximum number of items, from the current result set, returned on a single page.

Default: 20

Occurrence: Optional

offsetstringThe 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

event_idsstringThe unique identifiers for the eBay events.

Maximum Value: 1

Occurrence: Required

category_idsstringThe unique identifier of the eBay category for the search.

Maximum Value: 1

Occurrence: Optional

delivery_countrystringA filter for items that can be shipped to the specified country.

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringA header used to specify the eBay marketplace ID.

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.

Output

HTTP response headers

{ /* EventItemSearchResponse */
"href" : "string",
"limit" : "integer",
"next" : "string",
"prev" : "string",
}
Output container/fieldTypeDescription
eventItemsarray of EventItemA list of event items that match the search criteria.

Occurrence: Conditional

eventItems.additionalImagesarray of ImageThe additional images for the event item.

Occurrence: Conditional

eventItems.additionalImages.heightstringThe height of the image.

Occurrence: Conditional

eventItems.additionalImages.imageUrlstringThe relative path to the image location.

Occurrence: Conditional

eventItems.additionalImages.textstringThe text associated with the image.

Occurrence: Conditional

eventItems.additionalImages.widthstringThe width of the image.

Occurrence: Conditional

eventItems.categoryAncestorIdsarray of stringThe IDs of the ancestors for the primary category.

Occurrence: Conditional

eventItems.categoryIdstringThe ID of the leaf category for the event item. A leaf category is the lowest level in a category and has no children.

Occurrence: Conditional

eventItems.energyEfficiencyClassstringA string value specifying the Energy Efficiency class.

Occurrence: Conditional

eventItems.eventIdstringThe unique event identifier associated with the item.

Occurrence: Conditional

eventItems.imageImageThe image for the event item.

Occurrence: Conditional

eventItems.image.heightstringThe height of the image.

Occurrence: Conditional

eventItems.image.imageUrlstringThe relative path to the image location.

Occurrence: Conditional

eventItems.image.textstringThe text associated with the image.

Occurrence: Conditional

eventItems.image.widthstringThe width of the image.

Occurrence: Conditional

eventItems.itemAffiliateWebUrlstringThe item web URL with affiliate attribution.

Occurrence: Conditional

eventItems.itemGroupIdstringThe unique identifier for the event item group. This is the parent item ID for the seller-defined variations.

Note: This field is returned for multiple-SKU items.

Occurrence: Conditional

eventItems.itemGroupTypeItemGroupTypeEnumAn 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

eventItems.itemIdstringThe unique identifier for the event item.

Note: This field is only returned for single-SKU items.

Occurrence: Conditional

eventItems.itemWebUrlstringThe web URL for the event item.

Occurrence: Conditional

eventItems.legacyItemIdstringThe legacy item ID associated with the event item.

Occurrence: Always

eventItems.marketingPriceMarketingPriceThe original price for the event item, and the discount amount and percentage.

Occurrence: Conditional

eventItems.marketingPrice.discountAmountAmountThe monetary value of the seller discount.

Occurrence: Conditional

eventItems.marketingPrice.discountAmount.currencyCurrencyCodeEnumThe 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

eventItems.marketingPrice.discountAmount.valuestringThe monetary value, in the currency specified by the currency field.

Occurrence: Conditional

eventItems.marketingPrice.discountPercentagestringThe percentage of the seller discount based on the value returned in the originalPrice field.

Occurrence: Conditional

eventItems.marketingPrice.originalPriceAmountThe monetary value of the item prior to the discount.

Occurrence: Conditional

eventItems.marketingPrice.originalPrice.currencyCurrencyCodeEnumThe 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

eventItems.marketingPrice.originalPrice.valuestringThe monetary value, in the currency specified by the currency field.

Occurrence: Conditional

eventItems.marketingPrice.priceTreatmentPriceTreatmentEnumThe 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

eventItems.priceAmountThe applicable price for the event item.

Occurrence: Conditional

eventItems.price.currencyCurrencyCodeEnumThe 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

eventItems.price.valuestringThe monetary value, in the currency specified by the currency field.

Occurrence: Conditional

eventItems.qualifiedProgramsarray of ProgramEnumA list of programs applicable to the event item.

Occurrence: Conditional

eventItems.shippingOptionsarray of ShippingOptionThe cost required to ship the event item.

Occurrence: Conditional

eventItems.shippingOptions.shippingCostAmountThe 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

eventItems.shippingOptions.shippingCost.currencyCurrencyCodeEnumThe 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

eventItems.shippingOptions.shippingCost.valuestringThe monetary value, in the currency specified by the currency field.

Occurrence: Conditional

eventItems.shippingOptions.shippingCostTypestringThe 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

eventItems.titlestringThe title of the event item.

Occurrence: Conditional

eventItems.unitPriceAmountThe price per unit for the event 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

eventItems.unitPrice.currencyCurrencyCodeEnumThe 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

eventItems.unitPrice.valuestringThe monetary value, in the currency specified by the currency field.

Occurrence: Conditional

eventItems.unitPricingMeasurestringThe designation used to specify the quantity of the event 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

hrefstringThe relative path to the current set of results.

Occurrence: Conditional

limitintegerThe maximum number of items, from the current result set, returned on a single page.

Default: 20

Occurrence: Conditional

nextstringThe relative path to the next set of results.

Occurrence: Conditional

offsetintegerThe 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

prevstringThe relative path to the previous set of results.

Occurrence: Conditional

totalintegerThe total number of matches for the specified 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.

StatusMeaning
200OK
400Bad Request
403Forbidden
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
180000API_DEALAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
180001API_DEALREQUESTInvalid, missing or unsupported marketplace. Please refer to documentation.
180002API_DEALREQUESTThe specified limit is invalid. Maximum value supported is 100.
180003API_DEALREQUESTThe specified offset is invalid.
180004API_DEALREQUESTThe event Id is invalid.
180004API_DEALREQUESTThe event Id is invalid.
180005API_DEALREQUESTcategory_ids length exceeded. Please check documentation for maximum values supported.
180006API_DEALREQUESTevent_ids length exceeded. Maximum supported is one.
180008API_DEALREQUESTMissing eventId. Please provide a valid event Id for the marketplace.
180009API_DEALREQUESTNot authorized. Please contact developer support for assistance.
180010API_DEALREQUESTInvalid filter for 'delivery_country'. Please refer to the documentation for supported values.

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 Event Items for a Specified Marketplace

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

Input

The inputs are the event_ids and limit URI parameters. There is no payload with this request.
GET
https://api.ebay.com/buy/deal/v1/event_item?event_ids=5f063b3ba8f4407ef3d37951&limit=1

Output

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