Skip to main content


This method retrieves the details for an eBay event. The result set contains detailed information associated with the specified event ID, such as applicable coupons, start and end dates, and event terms.


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 site.


Resource URI


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

URI parameters

event_idstringThis path parameters specifies the unique identifier for the eBay event being retrieved.

Use the getEvents method to retrieve event IDs.

Occurrence: Required

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.

X-EBAY-C-ENDUSERCTXstringThis 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-IDstringThis 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):

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.


HTTP response headers

This call has no response headers.

Response payload

{ /* Event */
"applicableCoupons" : [
{ /* Coupon */
"terms" :
{ /* Terms */ }
"images" : [
{ /* Image */
"height" : "string",
"text" : "string",
"terms" :
{ /* Terms */ },

Response fields

Output container/fieldTypeDescription
applicableCouponsarray of Coupon

A list of coupons associated with the event.

Occurrence: Conditional


The coupon code.

Occurrence: Conditional


The terms of use associated with the coupon.

Occurrence: Conditional


A full-text description of the terms.

Occurrence: Conditional


A summarized description of the terms.

Occurrence: Conditional


The event description.

Occurrence: Conditional


The end date for the event.

Occurrence: Conditional


The URL of the View Event page for the event, which includes the affiliate tracking ID.

Occurrence: Conditional


The unique identifier for the event.

Occurrence: Conditional


The web URL for the event.

Occurrence: Conditional

imagesarray of Image

The images for the event.

Occurrence: Conditional


The height of the image.

Occurrence: Conditional


The relative path to the image location.

Occurrence: Conditional


The text associated with the image.

Occurrence: Conditional


The width of the image.

Occurrence: Conditional


The start date for the event.

Occurrence: Conditional


The terms associated with the event.

Occurrence: Conditional


A full-text description of the terms.

Occurrence: Conditional


A summarized description of the terms.

Occurrence: Conditional


The title of the event.

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.

404Not Found
500Internal Server Error

Error codes

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

180000API_DEALAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
180004API_DEALREQUESTThe event Id is invalid for the requested marketplace.
180009API_DEALREQUESTNot authorized. Please contact developer support for assistance.


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.

Sample 1: Retrieve Event Details

This sample retrieves the details associated with the specified event ID.


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



If the call is successful, the details associated with the specified event will be returned.