Skip to main content

GET/custom_policy/{custom_policy_id}

This method retrieves the custom policy specified by the custom_policy_id path parameter.

Note: Custom policies are no longer coupled with a specific eBay marketplace, so the EBAY-C-MARKETPLACE-ID request header is no longer needed or relevant for any of the Custom Policy methods.

Input

Resource URI

GET https://api.ebay.com/sell/account/v1/custom_policy/{custom_policy_id}

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
custom_policy_idstringThis path parameter is the unique identifier of the custom policy to retrieve.

This ID can be retrieved for a custom policy by using the getCustomPolicies method.

Occurrence: Required

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 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
customPolicyIdstring

The unique custom policy identifier for a policy.

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

Occurrence: Always

descriptionstring

Details of the seller's specific policy and terms associated with the policy. Buyers access this information from the View Item page for items to which the policy has been applied.

Max length: 15,000

Occurrence: Always

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

namestring

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

Max length: 65

Occurrence: Always

policyTypeCustomPolicyTypeEnum

Specifies the type of Custom Policy.

Two Custom Policy types are supported:

  • Product Compliance (PRODUCT_COMPLIANCE)
  • Takeback (TAKE_BACK)

Occurrence: Always

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
404Not Found
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
20415API_ACCOUNTREQUESTInvalid/Missing marketplaceId
20416API_ACCOUNTREQUESTInvalid/Missing customPolicyId
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 a Fulfillment Policy by ID

This example retrieves a custom policy using the policy's unique eBay-assigned ID.

Input

Specify the policy you want to get using the custom_policy_id path parameter. This call does not use a request payload.

GEThttps://api.ebay.com/sell/account/v1/custom_policy/2********4

Output

A successful call returns the details of the custom policy.

Got thoughts? Click the feedback button – your insights help us improve!