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:
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) later in 2023. When this change occurs, a seller will be able to apply any custom policy to listings on any eBay marketplace where they sell, and the X-EBAY-C-MARKETPLACE-ID request header will no longer be relevant.
For details on header values, see HTTP request headers.
Input
Resource URI
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 |
|---|---|---|
| policy_types | string | This 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:
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.
| Header | Type | Description |
|---|---|---|
| X-EBAY-C-MARKETPLACE-ID | string | This header parameter specifies the eBay marketplace 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:
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) later in 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. 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/field | Type | Description |
|---|---|---|
| customPolicies | array of CompactCustomPolicyResponse | This array contains the custom policies that match the input criteria. Occurrence: Always |
| customPolicies.customPolicyId | string | The unique custom policy identifier for the policy being returned. Occurrence: Always |
| customPolicies.label | string | 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. Occurrence: Always |
| customPolicies.name | string | The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller, policy type, and eBay marketplace. Occurrence: Always |
| customPolicies.policyType | CustomPolicyTypeEnum | Specifies the type of Custom Policy being returned.
Occurrence: Always |
| href | string | This field is for future use. Occurrence: Conditional |
| limit | integer | This field is for future use. Occurrence: Conditional |
| next | string | This field is for future use. Occurrence: Conditional |
| offset | integer | This field is for future use. Occurrence: Conditional |
| prev | string | This field is for future use. Occurrence: Conditional |
| total | integer | 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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 20411 | API_ACCOUNT | REQUEST | Invalid/Missing policyTypes {policyType} |
| 20415 | API_ACCOUNT | REQUEST | Invalid/Missing marketplaceId |
| 20500 | API_ACCOUNT | APPLICATION | System 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.