GET/marketplace/{marketplace_id}/get_extended_producer_responsibility_policies
This method returns the Extended Producer Responsibility policies for one, multiple, or all eBay categories in an eBay marketplace.
The identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the filter query parameter, this method will return metadata on every applicable category for the specified marketplace.
Note: Currently, the Extended Producer Responsibility policies are only applicable to a limited number of categories.
Note: Extended Producer Responsibility IDs are no longer set at the listing level so category-level metadata is no longer returned. Instead, sellers will provide/manage these IDs at the account level by going to Account Settings.
Tip: This method can potentially return a very large response payload. eBay recommends that the response payload be compressed by passing in the Accept-Encoding request header and setting the value to gzip.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| marketplace_id | string | This path parameter specifies the eBay marketplace for which policy information shall be retrieved. See HTTP Request Headers for a list of supported eBay marketplace ID values. Occurrence: Required |
| filter | string | A query parameter that can be used to limit the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree that should be returned. When a categoryId value is specified, the returned category tree includes the policies for that parent node, as well as the policies for any child nodes below that parent node. Pass in the categoryId values using a URL-encoded, pipe-separated ('|') list. For example: filter=categoryIds%3A%7B100%7C101%7C102%7DMaximum: 50 Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Accept-Encoding | string | This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip. For more information, refer to HTTP request headers. Occurrence: Strongly Recommended |
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| extendedProducerResponsibilities | array of ExtendedProducerResponsibilityPolicy | An array of response fields detailing the Extended Producer Responsibility policies supported for the specified marketplace. Occurrence: Always |
| extendedProducerResponsibilities.categoryId | string | The unique identifier for the category under which the policy applies. Occurrence: Always |
| extendedProducerResponsibilities.categoryTreeId | string | The unique identifier for the category tree under which the policy applies. Occurrence: Always |
| extendedProducerResponsibilities.supportedAttributes | array of ExtendedProducerResponsibility | The details regarding the attributes included in the policy, such as their usage guidelines and whether they can be specified at the listing variation level. Occurrence: Always |
| extendedProducerResponsibilities.supportedAttributes.enabledForVariations | boolean | An indication of whether the attribute can be enabled for listing variations. Occurrence: Always |
| extendedProducerResponsibilities.supportedAttributes.name | ExtendedProducerResponsibilityEnum | The name of the attribute included in the policy. Occurrence: Always |
| extendedProducerResponsibilities.supportedAttributes.usage | GenericUsageEnum | The usage guidelines for the attribute, in the specified marketplace. Occurrence: Always |
| warnings | array of ErrorDetailV3 | A collection of warnings generated for the request. Occurrence: Conditional |
| warnings.category | string | The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:
Occurrence: Conditional |
| warnings.domain | string | Name of the domain containing the service or application. Occurrence: Conditional |
| 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. Occurrence: Conditional |
| 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. Occurrence: Conditional |
| warnings.longMessage | string | An expanded version of message that should be around 100-200 characters long, but is not required to be such. Occurrence: Conditional |
| 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. Occurrence: Conditional |
| warnings.outputRefIds | array of string | Identifies specific response elements associated with the error, if any. Path format is the same as Occurrence: Conditional |
| warnings.parameters | array of ErrorParameterV3 | This optional complex field type contains a list of one or more context-specific Occurrence: Conditional |
| warnings.parameters.name | string | Name of the entity that threw the error. Occurrence: Conditional |
| warnings.parameters.value | string | A description of the error. Occurrence: Conditional |
| warnings.subdomain | string | Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 204 | No content |
| 400 | Bad Request |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 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. |
Warnings
For more on warnings, plus the codes of other common warnings, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 46002 | API_METADATA | REQUEST | The filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}. |
| 46003 | API_METADATA | REQUEST | The specified categoryId was not found for the marketplace. |
| 46004 | API_METADATA | REQUEST | Only 50 Category IDs specified in the filter are considered. |
Samples
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 Extended Producer Responsibility policies for categories in a marketplace
This example retrieves the Extended Producer Responsibility policies for three specific categories, 183598, 11521, and 139968, in the EBAY_FR marketplace.
This method returns a list of leaf categories from the category tree of the specified marketplace. Each node in the response shows the policy attributes, their usage guidelines, and whether they can be specified at the listing variation level.
Input
This method does not use a request payload.
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.
GEThttps://api.ebay.com/sell/metadata/v1/marketplace/EBAY_FR/get_extended_producer_responsibility_policies?filter=categoryIds%3A%7B183598%7C11521%7C139968%7D
Output
If the call is successful, the response body contains the Extended Producer Responsibility policy data for the specified categories in the EBAY_FR marketplace.