Skip to main content

GET/marketplace/{marketplace_id}/get_category_policies

This method returns eBay category policy metadata for all leaf categories on the specified marketplace.

By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.

If you specify a valid marketplace ID but that marketplace does not contain policy information, or if you filter out all results, a successful call returns a 204 No content status code with an empty response body.

Input

Resource URI

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

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

ParameterTypeDescription
marketplace_idstringThis path parameter specifies the eBay marketplace for which policy information is retrieved.

See HTTP Request Headers for a list of supported eBay marketplace ID values.

Occurrence: Required

filterstringThis query parameter limits the response by only returning metadata for the specified�leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the�Taxonomy API and looking for a "leafCategory": true tag.

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:{3767|171784}

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
categoryPoliciesarray of CategoryPolicy

This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter.

Occurrence: Always

categoryPolicies.autoPayEnabledboolean

If this field is returned as true, the corresponding category supports immediate payment for listings. The immediate payment feature is applicable to fixed-price listings, to auction listings with the 'Buy It Now' option enabled, and for a motor vehicle listing that requires an initial deposit. If the immediate payment feature is enabled for a listing, the buyer must pay immediately after clicking the 'Buy it Now' button.

This field is only returned when true (not returned when false).

Occurrence: Conditional

categoryPolicies.b2bVatEnabledboolean

If this field is returned as true, the corresponding category supports business-to-business (B2B) VAT listings. If this field is not present, the category does not have B2B VAT listings. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only.

This field is only returned when true (not returned when false).

Occurrence: Conditional

categoryPolicies.categoryIdstring

The unique identifier of the eBay leaf category for which metadata is being returned.

Occurrence: Always

categoryPolicies.categoryTreeIdstring

The unique identifier of the category tree.

Occurrence: Always

categoryPolicies.expiredboolean

If this field is returned as true, the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. You can use the getExpiredCategories method (of the Taxonomy API) to find the leaf category that replaced the expired category.

This field is only returned when true (not returned when false).

Occurrence: Conditional

categoryPolicies.intangibleEnabledboolean

If this field is returned as true, the category supports the listing of intangible goods or services.

Occurrence: Conditional

categoryPolicies.lsdboolean

If this field (Lot Size Disabled) is returned as true, the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction.

This field is only returned when true (not returned when false).

Occurrence: Conditional

categoryPolicies.minimumReservePricenumber

Indicates the Minimum Reserve Price for an auction listing in this category. If there is no Minimum Reserve Price, a value of 0.0 is returned in this field.

Occurrence: Conditional

categoryPolicies.orpaboolean

If this field (Override Reserve Price Allowed) is returned as true, all leaf categories on the site allow the seller to completely remove the reserve price for an active auction�listing. For information on removing or reducing reserve prices, see Setting a reserve price.

Occurrence: Conditional

categoryPolicies.orraboolean

If this field (Override Reduce Reserve Allowed) is returned as true, the seller can reduce or remove a reserve price that had already been reduced for an active auction�listing.

Occurrence: Conditional

categoryPolicies.paymentMethodsarray of PaymentEnum

An array that indicates the acceptable offline payment methods that can be used when listing an item for sale in the corresponding category.

Occurrence: Conditional

categoryPolicies.reduceReserveAllowedboolean

If this field (Reduce Reserve Allowed) is true, the corresponding leaf category allows the seller to reduce an item's reserve price. If false, this field is not returned in the response and the corresponding leaf category on the site do not normally allow sellers to reduce an item's reserve price.

This field is only returned when true (not returned when false).

Occurrence: Conditional

categoryPolicies.virtualboolean

If this field is returned as true, the corresponding category is an eBay virtual category, a category in which items may not be listed.

This field is only returned when true (not returned when false).

Occurrence: Conditional

warningsarray of ErrorDetailV3

An array 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.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 {maxCategoryIdsAllowed} Category IDs are allowed in the 'filter' parameter.

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 policy metadata for a specified marketplace

This example retrieves the eBay policies for the two specified leaf categories, 3767 and 171784.

This method returns an array of leaf categories from the category tree of the specified marketplace. Each node in the response contains metadata for the policies in each returned category.

Input

This method does not use a request payload. This sample limits the response to only two category IDs using the filter query parameter: filter=categoryIds:{3767|171784}

GEThttps://api.ebay.com/sell/metadata/v1/marketplace/EBAY_US/get_category_policies?filter=categoryIds:{3767|171784}

Output

If the call is successful, the response body contains the eBay policy metadata of the marketplace for the categories specified in the request.