{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Category_tree API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Category_tree", "type": "folder" }, "items": [ { "info": { "name": "eBay Get Aspects for All Leaf Categories in a Marketplace", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/category_tree/:category_tree_id/fetch_item_aspects", "params": [ { "name": "category_tree_id", "value": "", "type": "path", "description": "The unique identifier of the eBay category tree. The category tree ID for an eBay marketplace can be retrieved using the getDefaultCategoryTreeId method." } ], "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 returns a complete list of aspects for all of the leaf categories that belong to an eBay marketplace. The eBay marketplace is specified through the category_tree_id URI parameter.

Note: A successful call returns a payload as a gzipped JSON file sent as a binary file using the content-type:application/octet-stream in the response. This file may be large (over 100 MB, compressed). Extract the JSON file from the compressed file wit" }, { "info": { "name": "eBay Get a Default Category Tree ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/get_default_category_tree_id", "params": [ { "name": "marketplace_id", "value": "", "type": "query", "description": "The unique identifier of the eBay marketplace for which the category tree ID is requested. For a list of supported marketplace IDs, see Marketplaces with Default Category Trees." } ], "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": "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." }, { "info": { "name": "eBay Get a Category Tree", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/category_tree/:category_tree_id", "headers": [ { "name": "Accept-Encoding", "value": "" } ], "params": [ { "name": "category_tree_id", "value": "", "type": "path", "description": "The unique identifier of the eBay category tree. The category tree ID for an eBay marketplace can be retrieved using the getDefaultCategoryTreeId method." } ], "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 complete category tree that is identified by the category_tree_id parameter. The value of category_tree_id was returned by the getDefaultCategoryTreeId method 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 method can return a very large payload, so gzip compress" }, { "info": { "name": "eBay Get a Category Subtree", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/category_tree/:category_tree_id/get_category_subtree", "headers": [ { "name": "Accept-Encoding", "value": "" } ], "params": [ { "name": "category_id", "value": "", "type": "query", "description": "The unique identifier of the category at the top of the subtree being requested. Metadata on this category and all its descendant categories are retrieved.

Note: If the category_id submitted identifies a leaf node of the tree, the call response will contain information about only that leaf node, which is a valid subtree. " }, { "name": "category_tree_id", "value": "", "type": "path", "description": "The unique identifier of the eBay category tree. The category tree ID for an eBay marketplace can be retrieved using the getDefaultCategoryTreeId method." } ], "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 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 method can return a very large payload, so gzip compression is supported. To enable gzip compression, include the Accept-EncodinggetDefaultCategoryTreeId method." }, { "name": "q", "value": "", "type": "query", "description": "A quoted string that describes or characterizes the item being offered for sale. The string format is free form, and can contain any combination of phrases or keywords. eBay will parse the string and return suggested categories for the item." } ], "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 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.

You identify the tree using the category_tree_id" }, { "info": { "name": "getItemAspectsForCategory", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/category_tree/:category_tree_id/get_item_aspects_for_category", "params": [ { "name": "category_id", "value": "", "type": "query", "description": "The unique identifier of the leaf category for which aspects are being requested.

Note: If the category_id submitted does not identify a leaf node of the tree, this call returns an error. " }, { "name": "category_tree_id", "value": "", "type": "path", "description": "The unique identifier of the eBay category tree. The category tree ID for an eBay marketplace can be retrieved using the getDefaultCategoryTreeId method." } ], "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 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
    • " }, { "info": { "name": "eBay Get Compatibility Properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/category_tree/:category_tree_id/get_compatibility_properties", "params": [ { "name": "category_tree_id", "value": "", "type": "path", "description": "This is the unique identifier of category tree. The following is the list of category_tree_id values and the eBay marketplaces that they represent. One of these ID values must be passed in as a path parameter, and the category_id value, that is passed in as query parameter, must be a valid eBay category on that eBay marketplace that supports parts compatibility for cars, trucks, or motorcycles.

    • eBay US: 0
    • eBay Motors US: 100
    • eBay Canada: 2
    • eBay UK: 3
    • eBay Germany: 77
    • eBay Australia: 15
    • eBay France: 71
    • eBay Italy: 101
    • eBay Spain: 186
    " }, { "name": "category_id", "value": "", "type": "query", "description": "The unique identifier of an eBay category. This eBay category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcycles.

    The getAutomotivePartsCompatibilityPolicies method of the Selling Metadata API can be used to retrieve all eBay categories for an eBay marketplace that support parts compatibility for vehicles." } ], "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 call retrieves the compatible vehicle aspects that are used to define a motor vehicle that is compatible with a motor vehicle part or accessory. The values that are retrieved here might include motor vehicle aspects such as 'Make', 'Model', 'Year', 'Engine', and 'Trim', and each of these aspects are localized for the eBay marketplace.

    The category_tree_id value is passed in as a path parameter, and this value identifies the eBay category tree. The category_i" }, { "info": { "name": "eBay Get Compatibility Property Values", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/category_tree/:category_tree_id/get_compatibility_property_values", "params": [ { "name": "category_tree_id", "value": "", "type": "path", "description": "This is the unique identifier of the category tree. The following is the list of category_tree_id values and the eBay marketplaces that they represent. One of these ID values must be passed in as a path parameter, and the category_id value, that is passed in as query parameter, must be a valid eBay category on that eBay marketplace that supports parts compatibility for cars, trucks, or motorcycles.

    • eBay US: 0
    • eBay Motors US: 100
    • eBay Canada: 2
    • eBay UK: 3
    • eBay Germany: 77
    • eBay Australia: 15
    • eBay France: 71
    • eBay Italy: 101
    • eBay Spain: 186
    " }, { "name": "compatibility_property", "value": "", "type": "query", "description": "One compatible vehicle property applicable to the specified eBay marketplace and eBay category is specified in this required filter. Compatible vehicle properties are returned in the compatibilityProperties.name field of a getCompatibilityProperties response.

    For example, if you wanted to retrieve all vehicle trims for a 2018 Toyota Camry, you would set this filter as follows: compatibility_property=Trim and then include the following three name/value filters through one filter parameter: filter=Year:2018,Make:Toyota,Model:Camry.

    So, putting this all together, the URI would look something like this:

    GET https://api.ebay.com/commerce/
    taxonomy/v1/category_tree/100/
    get_compatibility_property_values?
    category_id=6016&compatibility_property=Trim
    &filter=Year:2018,Make:Toyota,Model:Camry
    " }, { "name": "category_id", "value": "", "type": "query", "description": "The unique identifier of an eBay category. This eBay category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcycles.

    The getAutomotivePartsCompatibilityPolicies method of the Selling Metadata API can be used to retrieve all eBay categories for an eBay marketplace that support parts compatibility for vehicles." }, { "name": "filter", "value": "", "type": "query", "description": "One or more compatible vehicle property name/value pairs are passed in through this query parameter. The compatible vehicle property name and corresponding value are delimited with a colon (:), such as filter=Year:2018, and multiple compatible vehicle property name/value pairs are delimited with a comma (,).

    Note: Commas are used as delimiters between filter values. If a value includes a comma (e.g., BodyStyle:AWD B9 8W5,C8WD) you must include a backslash (\\) immediately before the comma to prevent it from being evaluated as a delimiter.

    As with all query parameter values, the filter parameters must be URL encoded. For more information about encoding request parameters, refer to URL encoding query parameter values.
    For example, to retrieve all vehicle trims for a 2022 Audi A4:
    • Set the compatibility_property filter to compatibility_property=Trim
    • Include the following name/value filters using one filter parameter:
      • Year:2022
      • Make:Audi
      • Model:A4
      • BodyStyle:AWD B9 8W5\\,8WD
    The resulting comma-separated filter query parameter is:
    filter=Year:2022,Make:Audi,Model:A4,BodyStyle:AWD B9 8W5\\,8WD

    The following sample shows the same filter but with URL encoding for the blank spaces.
    GET https://api.ebay.com/commerce/
    taxonomy/v1/category_tree/100/
    get_compatibility_property_values?category_id=6016&compatibility_property=Trim&filter=Year:2022,Make:Audi,Model:A4,BodyStyle:AWD%20B9%208W5%5C%2C8WD
    For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/taxonomy/types/txn:ConstraintFilter" } ], "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 call retrieves applicable compatible vehicle property values based on the specified eBay marketplace, specified eBay category, and filters used in the request. Compatible vehicle properties are returned in the compatibilityProperties.name field of a getCompatibilityProperties response.

    One compatible vehicle property applicable to the specified eBay marketplace and eBay category is specified through the required compatibility_property