Overview
- GET /item
- GET /item/get_item_by_legacy_id
- GET /item/get_items_by_item_group
- GET /item/{item_id}
- PARAMETERS /item/{item_id}
- GET /merchandised_product
- GET /merchandised_product/get_also_bought_products
- GET /merchandised_product/get_also_viewed_products
- GET /category_tree/{category_tree_id}
- PARAMETERS /category_tree/{category_tree_id}
- GET /category_tree/{category_tree_id}/get_category_subtree
- PARAMETERS /category_tree/{category_tree_id}/get_category_subtree
- GET /category_tree/{category_tree_id}/get_category_suggestions
- PARAMETERS /category_tree/{category_tree_id}/get_category_suggestions
- GET /category_tree/{category_tree_id}/get_item_aspects_for_category
- PARAMETERS /category_tree/{category_tree_id}/get_item_aspects_for_category
- GET /order/{orderId}/shipping_fulfillment
- PARAMETERS /order/{orderId}/shipping_fulfillment
- GET /order/{orderId}/shipping_fulfillment/{fulfillmentId}
- PARAMETERS /order/{orderId}/shipping_fulfillment/{fulfillmentId}
- GET /order/{orderId}
- PARAMETERS /order/{orderId}
- GET /order
- GET /item_summary/search
- GET /item_description
- GET /get_default_category_tree_id
GET /item
Summary: Get Item
The Item feed file is generated each day. This call lets you download a daily TSV_GZIP (tab separated value gzip) Item feed file of all the items that were listed on a specific day in a specific category. For each item, all the item details are returned, except for the item description. The description of each item is excluded because these can be huge and items in an item group (an item with variations, such as size and color) can share the same description. The item descriptions are returned i
OpenAPI snippet URL
GET /item/get_item_by_legacy_id
Summary: Get Item Get Item By Legacy
This call is a bridge between the eBay legacy APIs, such as Trading, Shopping, and Finding and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an “item”. There is also a difference in what the item Id represents and in the format of the item Id value returned. This call 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
OpenAPI snippet URL
GET /item/get_items_by_item_group
Summary: Get Item Get Items By Item Group
This call retrieves the details of the 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. You use this call to show the item details of items with multiple aspects, such as color, size, storage capacity, etc. This call returns two main containers; items and commonDescriptions. The items container has an array of containers with the details of each item in th
OpenAPI snippet URL
GET /item/{item_id}
Summary: Get Item Item
This call 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 eBay ite
OpenAPI snippet URL
PARAMETERS /item/{item_id}
OpenAPI snippet URL
GET /merchandised_product
Summary: Get Merchandised Product
This call returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product Id (EPID), title, and user reviews and ratings for the product. You can use the epid returned by this call in the Browse API search call to retrieve items for this product. Restrictions For a list of supported sites and other restrictions, see API Restrictions.
OpenAPI snippet URL
GET /merchandised_product/get_also_bought_products
Summary: Get Merchandised Product Get Also Bought Products
This call returns products that were also bought when shoppers bought the product specified in the request. Showing ‘also bought’ products inspires up-selling and cross-selling. You specify the product by one of the following. epid (eBay Product Id) gtin (Global Trade Item Number) brand (brand name such as Nike) plus mpn (Manufacturer’s Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Maximum: A maximum of 12 products are returned. The call wi
OpenAPI snippet URL
GET /merchandised_product/get_also_viewed_products
Summary: Get Merchandised Product Get Also Viewed Products
This call returns products that were also viewed when shoppers viewed the product specified in the request. Showing ‘also viewed’ products encourages up-selling and cross-selling. You specify the product by one of the following. epid (eBay Product Id) gtin (Global Trade Item Number) brand (brand name such as Nike) plus mpn (Manufacturer’s Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Maximum: A maximum of 12 products are returned. The call
OpenAPI snippet URL
GET /category_tree/{category_tree_id}
Summary: Get Category Tree Category Tree
This call retrieves the complete category tree that is identified by the category_tree_id parameter. The value of category_tree_id was returned by the getDefaultCategoryTreeId call in the categoryTreeId field. The response contains details of all nodes of the specified eBay category tree, as well as the eBay marketplaces that use this category tree. Note: This call can return a very large payload, so you are strongly advised to submit the request with the following HTTP header: Accep
OpenAPI snippet URL
PARAMETERS /category_tree/{category_tree_id}
OpenAPI snippet URL
GET /category_tree/{category_tree_id}/get_category_subtree
Summary: Get Category Tree Category Tree Get Category Subtree
This call retrieves the details of all nodes of the category tree hierarchy (the subtree) below a specified category of a category tree. You identify the tree using the category_tree_id parameter, which was returned by the getDefaultCategoryTreeId call in the categoryTreeId field. Note: This call can return a very large payload, so you are strongly advised to submit the request with the following HTTP header: Accept-Encoding: application/gzip With this header (in addition to the requ
OpenAPI snippet URL
PARAMETERS /category_tree/{category_tree_id}/get_category_subtree
OpenAPI snippet URL
GET /category_tree/{category_tree_id}/get_category_suggestions
Summary: Get Category Tree Category Tree Get Category Suggestions
This call returns an array of category tree leaf nodes in the specified category tree that are considered by eBay to most closely correspond to the query string q. Returned with each suggested node is a localized name for that category (based on the Accept-Language header specified for the call), and details about each of the category’s ancestor nodes, extending from its immediate parent up to the root of the category tree. Note: This call can return a large payload, so you are advised to submit
OpenAPI snippet URL
PARAMETERS /category_tree/{category_tree_id}/get_category_suggestions
OpenAPI snippet URL
GET /category_tree/{category_tree_id}/get_item_aspects_for_category
Summary: Get Category Tree Category Tree Get Item Aspects For Category
This call returns a list of aspects that are appropriate or necessary for accurately describing items in the specified leaf category. Each aspect identifies an item attribute (for example, color) for which the seller will be required or encouraged to provide a value (or variation values) when offering an item in that category on eBay. For each aspect, getItemAspectsForCategory provides complete metadata, including: The aspect’s data type, format, and entry mode Whether the aspect is required in
OpenAPI snippet URL
PARAMETERS /category_tree/{category_tree_id}/get_item_aspects_for_category
OpenAPI snippet URL
GET /order/{orderId}/shipping_fulfillment
Summary: Get Order Order Shipping Fulfillment
Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order’s unique identifier, orderId. This value is returned in the getOrders call’s members.orderId field when you search for orders by creation date or shipment status.
OpenAPI snippet URL
PARAMETERS /order/{orderId}/shipping_fulfillment
OpenAPI snippet URL
GET /order/{orderId}/shipping_fulfillment/{fulfillmentId}
Summary: Get Order Order Shipping Fulfillment Fulfillment
Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order’s orderId). The fulfillmentId value was originally generated by the createShippingFulfillment call, and is returned by the getShippingFulfillments call in the members.fulfillmentId field.
OpenAPI snippet URL
PARAMETERS /order/{orderId}/shipping_fulfillment/{fulfillmentId}
OpenAPI snippet URL
GET /order/{orderId}
Summary: Get Order Order
Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the getOrders call’s orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status. The returned Order object contains information you can use to create and process fulfillments, including: Information about the buyer and seller Information about the order’s line items The plans for packaging, addressing and shipping the order The s
OpenAPI snippet URL
PARAMETERS /order/{orderId}
OpenAPI snippet URL
GET /order
Summary: Get Order
Use this call to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a list of orders using the orderIds parameter. The returned Order objects contain information you can use to create and process fulfillments, including: Information about the buyer and seller Information about the order’s line items The plans for packaging, addressing and shipping the order The status of
OpenAPI snippet URL
GET /item_summary/search
Summary: Get Item Summary Search
This call performs an advanced search for items. You can search by keyword, category, eBay product Id (EPID), or gtin. Or a combination of these. Encoding Parameters and Headers As with all query parameter values, the fields parameter value and request header values must be URL encoded. For better readability, the examples in this document omit the encoding. Example: search?q=world cup soccer ball&aspect_filter=categoryId:20863,Brand:{Nike|Wilson} Encoded Example: se
OpenAPI snippet URL
GET /item_description
Summary: Get Item Description
The Description feed file is generated each day. This call lets you download a daily TSV_GZIP (tab separated value gzip) Description feed file containing the descriptions of all the items that were listed on a specific day in a specific category. To store the complete item details, you would always run the getItemFeed and getItemDescriptionFeed calls with the same parameters. /item?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /item_descripti
OpenAPI snippet URL
GET /get_default_category_tree_id
Summary: Get Get Default Category Tree
A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the default for that marketplace. This call retrieves a reference to the default category tree associated with the specified eBay marketplace ID. The response includes only the tree’s unique identifier and version, which you can use to retrieve more details about the tree, its structure, and its individual category nodes.
OpenAPI snippet URL