Note: This method supports the eBay Product Based Shopping Experience (PBSE), which is applicable to only the US, UK, AU, and CA (English) marketplaces.
Note that you can also use GetCategoryFeatures in the Trading API to retrieve similar information.
For more information about using this method with PBSE, see the Product-Based Shopping Experience Playbook.
Use the marketplace_id path parameter to specify the marketplace you want to review and use the filter query parameter to limit the categories returned in the response.
Tip: This method can return a very large response payload and we strongly recommend you get the results from this call in a GZIP file by including the following HTTP header with your request:
Resource URI (production)
|filter||string||This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned. |
When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node.
The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50
Note that you must URL-encode the parameter list, which results in the following filter for the above example:
|marketplace_id||string||This path parameter specifies the eBay marketplace for which policy information is retrieved. See the following page for a list of valid eBay marketplace IDs: Request components. |
HTTP request headers
This request requires an access token created with the client credentials grant flow, using one scope from the following list:
See OAuth access tokens for more information.
|productAdoptionPolicies||array of ProductAdoptionPolicy||A list of category IDs from the marketplace specified in the request where each returned element represents a leaf node in the category tree. Each element in the list contains the policies governing whether or not items listed in that category must include an ePID value (which links the item to the eBay Catalog). |
|productAdoptionPolicies.categoryId||string||The category ID to which the listing policies apply. |
|productAdoptionPolicies.categoryTreeId||string||A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. |
A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes.
|productAdoptionPolicies.exclusion||Exclusion||A list of brands that are excluded from the ePID product-adoption requirements for the related category ID. |
|productAdoptionPolicies.exclusion.brands||array of string||A list of brands that are excluded from requiring a link to the eBay Catalog for the associated categoryId. |
If productRequired is set to
|productAdoptionPolicies.productRequired||boolean||If set to |
Important! It is possible for a productAdoptionPolicies container to not contain this productRequired field. This occurs if the eBay category is not part of the PBSE Phase 1 or Phase 2 mandate. In these scenarios, please treat the response the same as if this field were present and contained a value of
|warnings||array of ErrorDetailV3||A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request. |
|warnings.category||string||The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:|
|warnings.domain||string||Name of the domain containing the service or application. |
|warnings.errorId||integer||A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. |
|warnings.inputRefIds||array of string||Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation. |
|warnings.longMessage||string||An expanded version of message that should be around 100-200 characters long, but is not required to be such. |
|warnings.message||string||An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale. |
|warnings.outputRefIds||array of string||Identifies specific response elements associated with the error, if any. Path format is the same as |
|warnings.parameters||array of ErrorParameterV3||This optional complex field type contains a list of one or more context-specific |
|warnings.parameters.name||string||Name of the entity that threw the error. |
|warnings.parameters.value||string||A description of the error. |
|warnings.subdomain||string||Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain. |
For more on errors, plus the codes of other common errors, see Handling errors.
|46000||API_METADATA||APPLICATION||There was a problem with an eBay internal system or process.Contact eBay developer support for assistance.|
|46001||API_METADATA||REQUEST||The specified marketplace ID was not found.|
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get the eBay category policies that govern ePID (product adoption) requirements
This method returns a list of leaf categories from the category tree of the specified marketplace, starting with the parent node indicated by the specified category ID.
Each node in the response shows the policies that govern whether or not items listed in that category require an ePID value in their item descriptions. If
true, then items listed in that category must have an ePID value specified in the body of the item description.
By default, this method returns the leaf nodes of the entire category tree for the specified marketplace. When you retrieve the entire tree, be sure to get the result as a GZIP file (see the top of the call page for syntax). To limit the response, specify up to 50 category IDs using the filter query parameter. Note that you must URL-encode the category ID filter parameter value. This example uses the parameter: