{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Item API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Item", "type": "folder" }, "items": [ { "info": { "name": "getItem", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/item/:item_id", "headers": [ { "name": "X-EBAY-C-ENDUSERCTX", "value": "" }, { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fieldgroups", "value": "", "type": "query", "description": "This parameter controls what is returned in the response. If this field is not set, the method returns all the details of the item.

Note: Multiple fieldgroups can be set and applied simultaneously. However, COMPACT must be used alone. Otherwise, an error will occur.
Valid Values:" }, { "name": "item_id", "value": "", "type": "path", "description": "This path parameter specifies the unique RESTful identifier of the item being retrieved.

RESTful Item ID Format: v1|#|#

For a single SKU listing, pass in the item ID:
v1|2**********2|0
For a multi-SKU listing, pass in the identifier of the variation:
v1|1**********2|4**********2

For more information about item IDs for RESTful APIs, refer to Item ID legacy API compatibility overview in the Buying Integration Guide." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision.

The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any" }, { "info": { "name": "getItemByLegacyId", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/item/get_item_by_legacy_id", "headers": [ { "name": "X-EBAY-C-ENDUSERCTX", "value": "" }, { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fieldgroups", "value": "", "type": "query", "description": "This field controls what is returned in the response. If this field is not set, the method returns all details about the item. Multiple fieldgroups can be set.

Valid Values:" }, { "name": "legacy_item_id", "value": "", "type": "query", "description": "This query parameter is the unique identifier that specifies the item being retrieved.

Note: When passing in the ID for a multi-variation listing, you must also use the legacy_variation_id field and pass in the ID of the specific item variation. If not, all variation within the multi-SKU listing will be retrieved.
The following is an example of using the value of the ItemID field for a specific item to get the RESTful itemId value.
browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9
" }, { "name": "legacy_variation_id", "value": "", "type": "query", "description": "This query parameter specifies the legacy item ID of a specific item in a multi-variation listing, such as that for the red shirt size L item.

Important! A legacy_item_id value must always be passed in when specifying a legacy_variation_id value.

" }, { "name": "legacy_variation_sku", "value": "", "type": "query", "description": "This query parameter specifies the legacy SKU of an item. SKUs are the unique identifiers of an item created by the seller.

The following is an example of using the value of the ItemID and SKU fields to get the RESTful itemId value.
browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9&legacy_variation_sku=V**********M

Important! A legacy_item_id value must always be passed in when specifying a legacy_variation_sku value.

" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method is a bridge between the eBay legacy APIs, such as Shopping and Finding, and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an \"item\" and what the item ID represents. This method lets you use the legacy item ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item_id, which you can use wit" }, { "info": { "name": "getItems", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/item/", "headers": [ { "name": "X-EBAY-C-ENDUSERCTX", "value": "" }, { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "item_ids", "value": "", "type": "query", "description": "A comma separated list of the unique identifiers of the items to retrieve (maximum 20).

Note: In any given request, either item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.
RESTful Item ID Format: v1|#|#

For a single SKU listing, pass in the item ID:
v1|2**********2|0
For a multi-SKU listing, pass in the identifier of the variation:
v1|1**********2|4**********2

For more information about item IDs for RESTful APIs, refer to Item ID legacy API compatibility overview in the Buying Integration Guide." }, { "name": "item_group_ids", "value": "", "type": "query", "description": "A comma separated list of the unique identifiers of the item groups being retrieved (maximum 10).

Note: In any given request, either item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.
RESTful Group Item ID Format: ############

For example:
3**********9
" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method retrieves the details about specific items that buyers need to make a purchasing decision.

Note: This is a \"Limited(Limited Release) available only to select Partners.

For this method, only the following fields are returned: bidCount, " }, { "info": { "name": "getItemsByItemGroup", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/item/get_items_by_item_group", "headers": [ { "name": "X-EBAY-C-ENDUSERCTX", "value": "" }, { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fieldgroups", "value": "", "type": "query", "description": "This field controls what is returned in the response. If this field is not set, the method returns all details about the item.

Valid Values:

ADDITIONAL_SELLER_DETAILS - This field group adds the userId field to the response." }, { "name": "item_group_id", "value": "", "type": "query", "description": "This query parameter specifies the unique identifier of an item group for which information is to be returned. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

This ID is returned in the itemGroupHref field of the search and getItem methods.

For Example:
https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?item_group_id=3**********6
" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method retrieves details about individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

You pass in the item_group_id as a URI parameter.

This method returns two main containers: