{"files":{"SKILL.md":"---\nname: deal-api\ndescription: \"Deal API skill. Use when working with Deal for deal_item, event, event_item. Covers 4 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Deal API\nAPI version: v1.3.0\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://api.ebay.com/buy/deal/v1\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /deal_item -- this method retrieves a paginated set of deal items. the result set contains all deal items associated with the specified search criteria and marketplace id.restrictionsthis 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.\n3. Explore available endpoints below\n\n## Endpoints\n4 endpoints across 3 groups. See references/api-spec.lap for full details.\n\n### Deal_item\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /deal_item | This method retrieves a paginated set of deal items. The result set contains all deal items associated with the specified search criteria and marketplace ID.RestrictionsThis 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. |\n\n### Event\n| Method | Path | Description |\n|--------|------|-------------|\n| 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. |\n| GET | /event | This method returns paginated results containing all eBay events for the specified marketplace.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. |\n\n### Event_item\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /event_item | This method returns a paginated set of event items. The result set contains all event items associated with the specified search criteria and marketplace ID.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. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all deal_item?\" -> GET /deal_item\n- \"Get event details?\" -> GET /event/{event_id}\n- \"List all event?\" -> GET /event\n- \"List all event_item?\" -> GET /event_item\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Deal API\n@base https://api.ebay.com/buy/deal/v1\n@version v1.3.0\n@auth OAuth2\n@endpoints 4\n@toc deal_item(1), event(2), event_item(1)\n\n@group deal_item\n@endpoint GET /deal_item\n@desc This method retrieves a paginated set of deal items. The result set contains all deal items associated with the specified search criteria and marketplace ID.RestrictionsThis 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # This header identifies the eBay marketplace.See HTTP request headers for supported marketplace ID values.}\n@optional {category_ids: str # This query parameter specifies the unique identifier of the eBay category for the search.For details see Get Categories for Buy APIs., commissionable: str # This query parameter allows the response to filter by commissionable items.If set to true, only commissionable items will be returned in the response. If set to false, commissionable items will not be returned in the response.Note: This filter is currently only supported for the US marketplace., delivery_country: str # This query parameter allows the response to only return items that can be shipped to the specified country (2-digit ISO code)., limit: str # The maximum number of items, from the current result set, returned on a single page., offset: str # 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, X-EBAY-C-ENDUSERCTX: str # 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.}\n@returns(200) {dealItems: [map], href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)} # OK\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endgroup\n\n@group event\n@endpoint GET /event/{event_id}\n@desc 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # This header identifies the eBay marketplace.See HTTP request headers for supported marketplace ID values., event_id: str # This path parameters specifies the unique identifier for the eBay event being retrieved.Use the getEvents method to retrieve event IDs.}\n@optional {X-EBAY-C-ENDUSERCTX: str # 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.}\n@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} # OK\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /event\n@desc This method returns paginated results containing all eBay events for the specified marketplace.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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # This header identifies the eBay marketplace.See HTTP request headers for supported marketplace ID values.}\n@optional {limit: str # The maximum number of items, from the current result set, returned on a single page.Default: 20Maximum Value: 100, offset: str # 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, X-EBAY-C-ENDUSERCTX: str # 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.}\n@returns(200) {events: [map], href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)} # OK\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endgroup\n\n@group event_item\n@endpoint GET /event_item\n@desc This method returns a paginated set of event items. The result set contains all event items associated with the specified search criteria and marketplace ID.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.\n@required {event_ids: str # This query parameter specifies the unique identifiers for the eBay event items being retrieved.Use the getEvents method to retrieve event IDs.Maximum Value: 1, X-EBAY-C-MARKETPLACE-ID: str # This header identifies the eBay marketplace.See HTTP request headers for supported marketplace ID values.}\n@optional {category_ids: str # This query parameter specifies the unique identifiers of the eBay categories for the search.For details see Get Categories for Buy APIs.Maximum Value: 1, delivery_country: str # This query parameter allows the response to only return items that can be shipped to the specified country (2-digit ISO code)., limit: str # The maximum number of items, from the current result set, returned on a single page.Default: 20, offset: str # 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, X-EBAY-C-ENDUSERCTX: str # 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.}\n@returns(200) {eventItems: [map], href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)} # OK\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}}