@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Deal API
@base https://api.ebay.com/buy/deal/v1
@version v1.3.0
@auth OAuth2
@endpoints 4
@toc deal_item(1), event(2), event_item(1)

@group deal_item
@endpoint GET /deal_item
@required {X-EBAY-C-MARKETPLACE-ID: str}
@optional {category_ids: str, commissionable: str, delivery_country: str, limit: str, offset: str, X-EBAY-C-ENDUSERCTX: str}
@returns(200) {dealItems: [map], href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)}
@errors {400, 403, 500}

@endgroup

@group event
@endpoint GET /event/{event_id}
@required {X-EBAY-C-MARKETPLACE-ID: str, event_id: str}
@optional {X-EBAY-C-ENDUSERCTX: str}
@returns(200) {applicableCoupons: [map], description: str, endDate: str, eventAffiliateWebUrl: str, eventId: str, eventWebUrl: str, images: [map], startDate: str, terms: map{fullText: str, summary: str}, title: str}
@errors {400, 403, 404, 500}

@endpoint GET /event
@required {X-EBAY-C-MARKETPLACE-ID: str}
@optional {limit: str, offset: str, X-EBAY-C-ENDUSERCTX: str}
@returns(200) {events: [map], href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)}
@errors {400, 403, 500}

@endgroup

@group event_item
@endpoint GET /event_item
@required {event_ids: str, X-EBAY-C-MARKETPLACE-ID: str}
@optional {category_ids: str, delivery_country: str, limit: str, offset: str, X-EBAY-C-ENDUSERCTX: str}
@returns(200) {eventItems: [map], href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)}
@errors {400, 403, 500}

@endgroup

@end