getEvents: eBay Deal API | eBay Developers Program

GET/event

This method returns paginated results containing all eBay events for the specified marketplace.

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/event?

limit=string&

offset=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. Default: `20` Maximum Value: `100` 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

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

{ /* EventSearchResponse */

"events" : [

{ /* Event */

"applicableCoupons" : [

{ /* Coupon */

"redemptionCode" : "string",

"terms" :

{ /* Terms */

"fullText" : "string",

"summary" : "string"

}

"description" : "string",

"endDate" : "string",

"eventAffiliateWebUrl" : "string",

"eventId" : "string",

"eventWebUrl" : "string",

"images" : [

{ /* Image */

"height" : "string",

"imageUrl" : "string",

"text" : "string",

"width" : "string"

}

"startDate" : "string",

"terms" :

{ /* Terms */

"fullText" : "string",

"summary" : "string"

"title" : "string"

}

"href" : "string",

"limit" : "integer",

"next" : "string",

"offset" : "integer",

"prev" : "string",

"total" : "integer"

}

Response fields

Output container/field	Type	Description
events	array of Event	A list of results that match the search criteria. Occurrence: Conditional
events.applicableCoupons	array of Coupon	A list of coupons associated with the event. Occurrence: Conditional
events.applicableCoupons.redemptionCode	string	The coupon code. Occurrence: Conditional
events.applicableCoupons.terms	Terms	The terms of use associated with the coupon. Occurrence: Conditional
events.applicableCoupons.terms.fullText	string	A full-text description of the terms. Occurrence: Conditional
events.applicableCoupons.terms.summary	string	A summarized description of the terms. Occurrence: Conditional
events.description	string	The event description. Occurrence: Conditional
events.endDate	string	The end date for the event. Occurrence: Conditional
events.eventAffiliateWebUrl	string	The URL of the View Event page for the event, which includes the affiliate tracking ID. Occurrence: Conditional
events.eventId	string	The unique identifier for the event. Occurrence: Conditional
events.eventWebUrl	string	The web URL for the event. Occurrence: Conditional
events.images	array of Image	The images for the event. Occurrence: Conditional
events.images.height	string	The height of the image. Occurrence: Conditional
events.images.imageUrl	string	The relative path to the image location. Occurrence: Conditional
events.images.text	string	The text associated with the image. Occurrence: Conditional
events.images.width	string	The width of the image. Occurrence: Conditional
events.startDate	string	The start date for the event. Occurrence: Conditional
events.terms	Terms	The terms associated with the event. Occurrence: Conditional
events.terms.fullText	string	A full-text description of the terms. Occurrence: Conditional
events.terms.summary	string	A summarized description of the terms. Occurrence: Conditional
events.title	string	The title of the event. 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 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.

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.
180009	API_DEAL	REQUEST	Not authorized. Please contact developer support for assistance.

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

This sample retrieves a paginated set of events associated with the specified marketplace ID.

Input

The input is the limit URI parameter. There is no payload with this request.

GEThttps://api.ebay.com/buy/deal/v1/event?limit=1

Output

If the call is successful, one event matching the specified marketplace will be returned.

{
    "events": [
        {
            "eventId": "5**********2",
            "title": "Up to 60% off Cool Products",
            "description": "Use this event to grab great deals.",
            "startDate": "2020-07-02T15:00:00.000Z",
            "endDate": "2020-07-19T06:59:00.000Z",
            "images": [
                {
                    "imageUrl": "https://i.ebayimg.com/00/s/O**********=/z/n**********s/$_1.JPG",
                    "height": "924",
                    "width": "1536",
                    "text": "Up to 60% off"
                },
                {
                    "imageUrl": "https://i.ebayimg.com/00/s/M**********=/z/1**********o/$_1.JPG",
                    "height": "361",
                    "width": "1536",
                    "text": "Up to 60% off"
                }
            ],
            "eventWebUrl": "https://www.ebay.com/e/ad/c**********4"
        }
    ],
    "total": 465,
    "href": "https://api.ebay.com/buy/deal/v1/event?offset=0&limit=1",
    "next": "https://api.ebay.com/buy/deal/v1/event?offset=1&limit=1",
    "limit": 1,
    "offset": 0
}