deal APIv1.3.0

getEvent

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.

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/{event_id}

URI parameters

ParameterTypeDescription
event_idstringThe unique identifier for the eBay event.

Occurrence: Required

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

{ /* Event */
"applicableCoupons" : [
{ /* Coupon */
"terms" :
{ /* Terms */ }
}
],
"images" : [
{ /* Image */
"height" : "string",
"text" : "string",
}
],
"terms" :
{ /* Terms */ },
}
Output container/fieldTypeDescription
applicableCouponsarray of CouponA list of coupons associated with the event.

Occurrence: Conditional

applicableCoupons.redemptionCodestringThe coupon code.

Occurrence: Conditional

applicableCoupons.termsTermsThe terms of use associated with the coupon.

Occurrence: Conditional

applicableCoupons.terms.fullTextstringA full-text description of the terms.

Occurrence: Conditional

applicableCoupons.terms.summarystringA summarized description of the terms.

Occurrence: Conditional

descriptionstringThe event description.

Occurrence: Conditional

endDatestringThe end date for the event.

Occurrence: Conditional

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

Occurrence: Conditional

eventIdstringThe unique identifier for the event.

Occurrence: Conditional

eventWebUrlstringThe web URL for the event.

Occurrence: Conditional

imagesarray of ImageThe images for the event.

Occurrence: Conditional

images.heightstringThe height of the image.

Occurrence: Conditional

images.imageUrlstringThe relative path to the image location.

Occurrence: Conditional

images.textstringThe text associated with the image.

Occurrence: Conditional

images.widthstringThe width of the image.

Occurrence: Conditional

startDatestringThe start date for the event.

Occurrence: Conditional

termsTermsThe terms associated with the event.

Occurrence: Conditional

terms.fullTextstringA full-text description of the terms.

Occurrence: Conditional

terms.summarystringA summarized description of the terms.

Occurrence: Conditional

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

StatusMeaning
200OK
403Forbidden
404Not Found
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.
180004API_DEALREQUESTThe event Id is invalid for the requested marketplace.
180009API_DEALREQUESTNot 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.

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.
GET
https://api.ebay.com/buy/deal/v1/event/5efd358dc0b33c2

Output

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