metadata APIv1.4.2

getItemConditionPolicies

GET
/marketplace/{marketplace_id}/get_item_condition_policies
This method returns item condition metadata on one, multiple, or all eBay categories on an eBay marketplace. This metadata consists of the different item conditions (with IDs) that an eBay category supports, and a boolean to indicate if an eBay category requires an item condition.

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 single category for the specified marketplace. If you only want to view item condition metadata for one eBay category or a select group of eBay categories, you can pass in up to 50 eBay category ID through the filter query parameter.

Important!: Certified - Refurbished-eligible sellers, and sellers who are eligible to list with the new values (EXCELLENT_REFURBISHED, VERY_GOOD_REFURBISHED, and GOOD_REFURBISHED) in category 9355, must use an OAuth token created with the authorization code grant flow and https://api.ebay.com/oauth/api_scope/sell.inventory scope in order to retrieve the refurbished conditions for the relevant categories.

These restricted item conditions will not be returned if an OAuth token created with the client credentials grant flow and https://api.ebay.com/oauth/api_scope scope is used, or if any seller is not eligible to list with that item condition.

See the Specifying OAuth scopes topic for more information about specifying scopes.

Tip: If you retrieve metadata on all eBay categories for a marketplace, the response payload can be quite large. For this reason, we suggest that you consider using the Accept-Encoding request header and set its value to application/gzip. By doing this, the response payload output will be compressed into a GZIP file.

Input

Resource URI (production)

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

URI parameters

ParameterTypeDescription
marketplace_idstringThis 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.

Occurrence: Required

filterstringThis 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 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned.

Example: filter=categoryIds:{100|101|102}

Note that you must URL-encode the parameter list, which results in the following filter for the above example:

  filter=categoryIds%3A%7B100%7C101%7C102%7D

Occurrence: Optional

HTTP request headers

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

OAuth scope

This request requires an access token created with either authorization code grant flow or client credentials grant flow. Please refer to the note below for more details.

The access token must be created 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

https://api.ebay.com/oauth/api_scope/sell.inventory

See OAuth access tokens for more information.

IMPORTANT: An OAuth token created with the client credentials grant flow and https://api.ebay.com/oauth/api_scope scope is generally used for this method. However, Certified Refurbished-eligible sellers must use an OAuth token created with the authorization code grant flow and https://api.ebay.com/oauth/api_scope/sell.inventory scope in order to retrieve the 'Certified Refurbished' condition (condition ID 2000) for the relevant categories.

Output

HTTP response headers

Output container/fieldTypeDescription
itemConditionPoliciesarray of ItemConditionPolicyA list of category IDs and the policies for how to indicate an item's condition in each of the listed categories.

Occurrence: Always

itemConditionPolicies.categoryIdstringThe category ID to which the item-condition policy applies.

Occurrence: Always

itemConditionPolicies.categoryTreeIdstringA 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.

Occurrence: Always

itemConditionPolicies.itemConditionRequiredbooleanThis flag denotes whether or not you must list the item condition in a listing for the specified category. If set to true, you must specify an item condition for the associated category.

Occurrence: Always

itemConditionPolicies.itemConditionsarray of ItemConditionThe item-condition values allowed in the category.

Note: In all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified Refurbished', and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition.

Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center.


Note: For the Cell Phones & Smartphones category (9355), the SELLER_REFURBISHED condition is being deprecated. Sellers trying to list an item in this category (9355) with the condition SELLER_REFURBISHED will be blocked. Starting September 1, 2021, existing listings for this category (9355) with this item condition will be ended by eBay but three new additional refurbished items conditions will be available: EXCELLENT_REFURBISHED, VERY_GOOD_REFURBISHED, and GOOD_REFURBISHED. To be eligible to list with these three item conditions, sellers will have to go through an application process. See Cameras & Photo, Cell Phones & Accessories... for details.

Occurrence: Always

itemConditionPolicies.itemConditions.conditionDescriptionstringThe human-readable label for the condition (e.g., "New"). This value is typically localized for each site.

Note that the display name can vary by category. For example, the description for condition ID 1000 could be called "New: with Tags" in one category and "Brand New" in another. For details on condition IDs and descriptions, see Item condition ID and name values.

Occurrence: Always

itemConditionPolicies.itemConditions.conditionIdstringThe ID value of the selected item condition. For information on the supported condition ID values, see Item condition ID and name values.

Occurrence: Always

itemConditionPolicies.itemConditions.usageUsageEnumThe value returned in this field indicates if there are any usage restrictions or requirements for the corresponding item condition in the corresponding category.

Note: Currently, the only supported value is 'RESTRICTED', and this field will only be returned for the following conditions: 2000, 2010, 2020, 2030. Sellers must be pre-approved to use any of these item conditions.

Occurrence: Conditional

warningsarray of ErrorDetailV3A 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.categorystringThe 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.domainstringName of the domain containing the service or application.

Occurrence: Conditional

warnings.errorIdintegerA 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 stringIdentifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.

Occurrence: Conditional

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

Occurrence: Conditional

warnings.messagestringAn 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 stringIdentifies specific response elements associated with the error, if any. Path format is the same as inputRefId.

Occurrence: Conditional

warnings.parametersarray of ErrorParameterV3This 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.namestringName of the entity that threw the error.

Occurrence: Conditional

warnings.parameters.valuestringA description of the error.

Occurrence: Conditional

warnings.subdomainstringName 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. Specify multiple categories using the following syntax: <code>filter=categoryIds:{catId1|catId2|catId3}</code>
46003API_METADATAREQUESTThe specified categoryId was not found for the marketplace.
46004API_METADATAREQUESTOnly the first 50 Category IDs specified in the <b>filter</b> parameter are returned, the rest are ignored.

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 eBay category policies regarding item conditions

This example retrieves the policies for two specific categories, 90638 and 181923.

This method returns a list of leaf categories from the category tree of the specified marketplace. Each node in the response shows the policies that govern how to list item condition in each of the returned categories.

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. This example uses the parameter: filter=categoryIds:{181923|90638}.

Additionally, this example uses an OAuth token created with the client credentials grant flow; however, Certified Refurbished-eligible sellers must use an OAuth token created with the authorization code grant flow in order to retrieve the Certified Refurbished condition (condition ID 2000) for the relevant categories.
GET
https://api.ebay.com/sell/metadata/v1/marketplace/EBAY_US/get_item_condition_policies?filter=categoryIds%3A%7B181923%7C90638%7D

Output

If the call is successful, the response body contains the policies for specifying item conditions for items listed in the categories specified in the request.