Skip to main content

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, and only in the EBAY_FR marketplace.

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 application/gzip.

Input

Resource URI (production)

GET https://api.ebay.com/sell/metadata/v1/marketplace/{marketplace_id}/get_extended_producer_responsibility_policies?

URI parameters

ParameterTypeDescription
marketplace_idstringA path parameter that specifies the eBay marketplace for which policy information shall be retrieved.

Tip: See Request components for a list of valid eBay marketplace IDs.

Occurrence: Required

filterstringA 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%7D

Maximum: 50

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

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/fieldTypeDescription
extendedProducerResponsibilitiesarray of ExtendedProducerResponsibilityPolicy

An array of response fields detailing the Extended Producer Responsibility policies supported for the specified marketplace.

Occurrence: Always

extendedProducerResponsibilities.categoryIdstring

The unique identifier for the category under which the policy applies.

Occurrence: Always

extendedProducerResponsibilities.categoryTreeIdstring

The unique identifier for the category tree under which the policy applies.

Occurrence: Always

extendedProducerResponsibilities.supportedAttributesarray 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.enabledForVariationsboolean

An indication of whether the attribute can be enabled for listing variations.

If the value is true, the attribute may be specified at the variation level.

Occurrence: Always

extendedProducerResponsibilities.supportedAttributes.nameExtendedProducerResponsibilityEnum

The name of the attribute included in the policy.

Occurrence: Always

extendedProducerResponsibilities.supportedAttributes.usageGenericUsageEnum

The usage guidelines for the attribute, in the specified marketplace.

Occurrence: Always

warningsarray of ErrorDetailV3

A collection of warnings generated for the request.

Occurrence: Conditional

warnings.categorystring

The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:

  • Application: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.
  • Business: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.
  • Request: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.

Occurrence: Conditional

warnings.domainstring

Name of the domain containing the service or application.

Occurrence: Conditional

warnings.errorIdinteger

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.inputRefIdsarray 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.longMessagestring

An expanded version of message that should be around 100-200 characters long, but is not required to be such.

Occurrence: Conditional

warnings.messagestring

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.outputRefIdsarray of string

Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.

Occurrence: Conditional

warnings.parametersarray of ErrorParameterV3

This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.

Occurrence: Conditional

warnings.parameters.namestring

Name of the entity that threw the error.

Occurrence: Conditional

warnings.parameters.valuestring

A description of the error.

Occurrence: Conditional

warnings.subdomainstring

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.

StatusMeaning
200Success
204No content
400Bad Request
404Not found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
46000API_METADATAAPPLICATIONThere was a problem with an eBay internal system or process.Contact eBay developer support for assistance.
46001API_METADATAREQUESTThe specified marketplace ID was not found.

Warnings

For more on warnings, plus the codes of other common warnings, see Handling errors.

CodeDomainCategoryMeaning
46002API_METADATAREQUESTThe filter value is invalid. Sample supported values: filter=categoryIds:{catId1|catId2|catId3}.
46003API_METADATAREQUESTThe specified categoryId was not found for the marketplace.
46004API_METADATAREQUESTOnly 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 markeplace.

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.