Skip to main content

GET/custom_policy/

This method retrieves the list of custom policies specified by the policy_types query parameter for the selected eBay marketplace.

Note: The following eBay marketplaces support Custom Policies:

  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)


For details on header values, see HTTP request headers.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/custom_policy/?

URI parameters

ParameterTypeDescription
policy_typesstringThis query parameter specifies the type of custom policies to be returned.

Multiple policy types may be requested in a single call by providing a comma-delimited set of all policy types to be returned.

Note: Omitting this query parameter from a request will also return policies of all policy types.

Two Custom Policy types are supported:
  • Product Compliance (PRODUCT_COMPLIANCE)
  • Takeback (TAKE_BACK)

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.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThis header parameter specifies the eBay markeplace for the custom policy that is being created. Supported values for this header can be found in the MarketplaceIdEnum type definition.

Note: The following eBay marketplaces support Custom Policies:
  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code 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/sell.account

https://api.ebay.com/oauth/api_scope/sell.account.readonly

eBayUser

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
customPoliciesarray of CompactCustomPolicyResponse

This array contains the custom policies that match the input criteria.

Occurrence: Always

customPolicies.customPolicyIdstring

The unique custom policy identifier for the policy being returned.

Note: This value is automatically assigned by the system when the policy is created.

Occurrence: Always

customPolicies.labelstring

Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to detailed policy information.

Max length: 65

Occurrence: Always

customPolicies.namestring

The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller, policy type, and eBay marketplace.
Note: This field is visible only to the seller.

Max length: 65

Occurrence: Always

customPolicies.policyTypeCustomPolicyTypeEnum

Specifies the type of Custom Policy being returned.

Two Custom Policy types are supported:

  • Product Compliance (PRODUCT_COMPLIANCE)
  • Takeback (TAKE_BACK)

Occurrence: Always

hrefstring

This field is for future use.

Occurrence: Conditional

limitinteger

This field is for future use.

Occurrence: Conditional

nextstring

This field is for future use.

Occurrence: Conditional

offsetinteger

This field is for future use.

Occurrence: Conditional

prevstring

This field is for future use.

Occurrence: Conditional

totalinteger

This field is for future use.

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
400Bad Request
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
20411API_ACCOUNTREQUESTInvalid/Missing policyTypes {policyType}
20415API_ACCOUNTREQUESTInvalid/Missing marketplaceId
20500API_ACCOUNTAPPLICATIONSystem error.

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 all Custom Policies

This call returns all the current policies for the specified marketplace.

Input

This method requires you to specify the eBay marketplace ID using the X-EBAY-C-MARKETPLACE-ID HTTP header. It does not use a request payload.

GEThttps://api.ebay.com/sell/account/v1/custom_policy

Output

If the call is successful, an array of all custom policies defined by the seller for the specified eBay marketplace is returned.