GET/custom_policy/{custom_policy_id}
This method retrieves the custom policy specified by the custom_policy_id path parameter.
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 |
|---|---|---|
| custom_policy_id | string | This 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
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 |
|---|---|---|
| customPolicyId | string | The unique custom policy identifier for a policy. Occurrence: Always |
| description | string | Contains the seller's policy and policy terms. Buyers access this information from the View Item page for items to which the policy has been applied. Occurrence: Always |
| 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 the seller's policy information. Occurrence: Always |
| name | string | The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type. Occurrence: Always |
| policyType | CustomPolicyTypeEnum | Specifies the type of Custom Policy being returned. 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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 20415 | API_ACCOUNT | REQUEST | Invalid/Missing marketplaceId |
| 20416 | API_ACCOUNT | REQUEST | Invalid/Missing customPolicyId |
| 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 a custom policy by ID
This example retrieves a custom policy using the policy's unique eBay-assigned ID.
Input
Specify the policy you want to retrieve by inputting the unique identifier of the custom policy at the end of the call URI. 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.