eBay · Schema
CompactCustomPolicyResponse
The response payload for requests that return a list of custom policies.
AuctionsCommerceProductsMarketplaceFortune 500
Properties
| Name | Type | Description |
|---|---|---|
| customPolicyId | string | The unique custom policy identifier for the policy being returned. Note: This value is automatically assigned by the system when the policy is created.< |
| 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. |
| name | string | 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 on |
| policyType | string | Specifies the type of Custom Policy being returned. Two Custom Policy types are supported:
|
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CompactCustomPolicyResponse",
"title": "CompactCustomPolicyResponse",
"type": "object",
"properties": {
"customPolicyId": {
"type": "string",
"description": "The unique custom policy identifier for the policy being returned.<br><br><span class=\"tablenote\"><strong>Note:</strong> This value is automatically assigned by the system when the policy is created.</span>"
},
"label": {
"type": "string",
"description": "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.<br><br><b>Max length:</b> 65"
},
"name": {
"type": "string",
"description": "The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><span class=\"tablenote\"><strong>Note:</strong> This field is visible only to the seller. </span><br><br><b>Max length:</b> 65"
},
"policyType": {
"type": "string",
"description": "Specifies the type of Custom Policy being returned. <br><br>Two Custom Policy types are supported: <ul><li>Product Compliance (PRODUCT_COMPLIANCE)</li> <li>Takeback (TAKE_BACK)</li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay API documentation</a>"
}
},
"description": "The response payload for requests that return a list of custom policies."
}