eBay · Schema

CustomPolicyCreateRequest

This type is used by the request payload of the createCustomPolicy method to define a new custom policy for a specific marketplace.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
description string Details of the seller's specific policy and terms for this policy.

Max length: 15,000
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 visibl
policyType string Specifies the type of custom policy being created.

Two Custom Policy types are supported:
  • Product Compliance (PRODUCT_COMPLIANCE)
  • Takeback (TAKE_BACK)
For implementa
View JSON Schema on GitHub

JSON Schema

ebay-custompolicycreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomPolicyCreateRequest",
  "title": "CustomPolicyCreateRequest",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Details of the seller's specific policy and terms for this policy.<br><br><b>Max length:</b> 15,000"
    },
    "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><br><span class=\"tablenote\"><strong>Note:</strong> This field is visible only to the seller. </span><br><b>Max length:</b> 65"
    },
    "policyType": {
      "type": "string",
      "description": "Specifies the type of custom policy being created. <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": "This type is used by the request payload of the createCustomPolicy method to define a new custom policy for a specific marketplace."
}