GET/event/{event_id}
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.
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
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
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 |
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
Response fields
| Output container/field | Type | Description |
|---|---|---|
| applicableCoupons | array of Coupon | A list of coupons associated with the event. Occurrence: Conditional |
| applicableCoupons.redemptionCode | string | The coupon code. Occurrence: Conditional |
| applicableCoupons.terms | Terms | The terms of use associated with the coupon. Occurrence: Conditional |
| applicableCoupons.terms.fullText | string | A full-text description of the terms. Occurrence: Conditional |
| applicableCoupons.terms.summary | string | A summarized description of the terms. Occurrence: Conditional |
| description | string | The event description. Occurrence: Conditional |
| endDate | string | The end date for the event. Occurrence: Conditional |
| eventAffiliateWebUrl | string | The URL of the View Event page for the event, which includes the affiliate tracking ID. Occurrence: Conditional |
| eventId | string | The unique identifier for the event. Occurrence: Conditional |
| eventWebUrl | string | The web URL for the event. Occurrence: Conditional |
| images | array of Image | The images for the event. Occurrence: Conditional |
| images.height | string | The height of the image. Occurrence: Conditional |
| images.imageUrl | string | The relative path to the image location. Occurrence: Conditional |
| images.text | string | The text associated with the image. Occurrence: Conditional |
| images.width | string | The width of the image. Occurrence: Conditional |
| startDate | string | The start date for the event. Occurrence: Conditional |
| terms | Terms | The terms associated with the event. Occurrence: Conditional |
| terms.fullText | string | A full-text description of the terms. Occurrence: Conditional |
| terms.summary | string | A summarized description of the terms. Occurrence: Conditional |
| title | string | 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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 403 | Forbidden |
| 404 | Not Found |
| 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. |
| 180004 | API_DEAL | REQUEST | The event Id is invalid for the requested marketplace. |
| 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 Event Details
This sample retrieves the details associated with the specified event ID.
Input
The input is the event_id URI parameter. There is no payload with this request.
GEThttps://api.ebay.com/buy/deal/v1/event/5**********2
Output
If the call is successful, the details associated with the specified event will be returned.