This method returns paginated results containing all eBay events for the specified marketplace.
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 theitemAffiliateWebUrl field to forward your buyer to the ebay.com site. Input
Resource URI (production)
URI parameters
| Parameter | Type | Description |
|---|---|---|
| limit | string | The maximum number of items, from the current result set, returned on a single page. Default: 20Maximum 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
This method has the additional request header requirements listed below. See HTTP request headers- opens rest request components page for details.
| Header | Type | Description |
|---|---|---|
| X-EBAY-C-MARKETPLACE-ID | string | A 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
| 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
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.