getRegulatoryPolicies: eBay Metadata API

GET/marketplace/{marketplace_id}/get_regulatory_policies

This method returns regulatory 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 for every listing category in the specified 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 gzip.

Input

Resource URI

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

filter=string

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.Note: This method is not supported in the `EBAY_HK`, `EBAY_MY`, `EBAY_TW`, or `EBAY_PH` marketplaces. 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. 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

Copy complete valid JSON to clipboard

{ /* RegulatoryPolicyResponse */

"regulatoryPolicies" : [

{ /* RegulatoryPolicy */

"categoryId" : "string",

"categoryTreeId" : "string",

"supportedAttributes" : [

{ /* RegulatoryAttribute */

"name" : "RegulatoryAttributeEnum : [HAZMAT,ENERGY_EFFICIENCY,MANUFACTURER_CONTACT...]",

"usage" : "GenericUsageEnum : [OPTIONAL,RECOMMENDED,REQUIRED]"

}

]

}

"warnings" : [

{ /* ErrorDetailV3 */

"category" : "string",

"domain" : "string",

"errorId" : "integer",

"inputRefIds" : [

"string"

"longMessage" : "string",

"message" : "string",

"outputRefIds" : [

"string"

"parameters" : [

{ /* ErrorParameterV3 */

"name" : "string",

"value" : "string"

}

"subdomain" : "string"

}

]

}

Response fields

Output container/field	Type	Description
regulatoryPolicies	array of RegulatoryPolicy	A list of eBay policies that define whether or not you must include required regulatory information for leaf categories on the given marketplace. Occurrence: Always
regulatoryPolicies.categoryId	string	The unique identifier of the leaf category to which the corresponding policies pertain. Occurrence: Always
regulatoryPolicies.categoryTreeId	string	The unique identifier of the category tree, which reflects the specified marketplace. Occurrence: Always
regulatoryPolicies.supportedAttributes	array of RegulatoryAttribute	A list of supported regulatory attributes for this marketplace. Occurrence: Always
regulatoryPolicies.supportedAttributes.name	RegulatoryAttributeEnum	A unique value identifying a specific regulatory attribute. Occurrence: Always
regulatoryPolicies.supportedAttributes.usage	GenericUsageEnum	The enumeration value in this field indicates whether the corresponding attribute is recommended or required for the corresponding leaf category. Occurrence: Always
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. 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: `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.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 `inputRefId`. Occurrence: Conditional
warnings.parameters	array 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.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.
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.
46005	API_METADATA	REQUEST	Only {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter.

Warnings

This call has no warnings.

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 regulatory policies for categories in a marketplace

This example retrieves the regulatory policies for category '7*', in the EBAY_DE marketplace.

This method returns a list of leaf categories from the category tree of the specified marketplace. Each node contains the name and usage.

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_DE/get_regulatory_policies?filter=categoryIds%3A%7B159899%7C178628%7C178662%7D

Output

If the call is successful, the response body contains the regulatory policy data for the specified categories in the EBAY_DE marketplace.

{
    "regulatoryPolicies": [
        {
            "categoryTreeId": "71",
            "categoryId": "159899",
            "supportedAttributes": [
                {
                    "name": "MANUFACTURER_CONTACT",
                    "usage": "RECOMMENDED"
                },
                {
                    "name": "PRODUCT_SAFETY",
                    "usage": "RECOMMENDED"
                }
            ]
        },
        {
            "categoryTreeId": "71",
            "categoryId": "178628",
            "supportedAttributes": [
                {
                    "name": "ENERGY_EFFICIENCY",
                    "usage": "OPTIONAL"
                },
                {
                    "name": "MANUFACTURER_CONTACT",
                    "usage": "REQUIRED"
                },
                {
                    "name": "PRODUCT_SAFETY",
                    "usage": "RECOMMENDED"
                }
            ]
        },
        {
            "categoryTreeId": "71",
            "categoryId": "178662",
            "supportedAttributes": [
                {
                    "name": "ENERGY_EFFICIENCY",
                    "usage": "OPTIONAL"
                },
                {
                    "name": "MANUFACTURER_CONTACT",
                    "usage": "REQUIRED"
                },
                {
                    "name": "PRODUCT_SAFETY",
                    "usage": "RECOMMENDED"
                }
            ]
        }
    ]
}