eBay · Schema

ReturnPolicyDetails

This container defines the category policies that relate to domestic and international return policies (the return shipping is made via a domestic or an international shipping service, respectively).

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
policyDescriptionEnabled boolean If set to true, this flag indicates you can supply a detailed return policy description within your return policy (for example, by populating the returnInstructions field in the Ac
refundMethods array A list of refund methods allowed for the associated category.
returnMethods array A list of return methods allowed for the associated category.
returnPeriods array A list of return periods allowed for the associated category.

Note that different APIs require you to enter the return period in different ways. For example, the Account API uses the complex <
returnsAcceptanceEnabled boolean If set to true, this flag indicates the seller can configure how they handle domestic returns.
returnShippingCostPayers array A list of allowed values for who pays for the return shipping cost.

Note that for SNAD returns, the seller is always responsible for the return shipping cost.
View JSON Schema on GitHub

JSON Schema

ebay-returnpolicydetails-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ReturnPolicyDetails",
  "title": "ReturnPolicyDetails",
  "type": "object",
  "properties": {
    "policyDescriptionEnabled": {
      "type": "boolean",
      "description": "If set to <code>true</code>, this flag indicates you can supply a detailed return policy description within your return policy (for example, by populating the <b>returnInstructions</b> field in the Account API's <b>createReturnPolicy</b>). User-supplied return policy details are allowed only in the DE, ES, FR, and IT marketplaces."
    },
    "refundMethods": {
      "type": "array",
      "description": "A list of refund methods allowed for the associated category.",
      "items": {
        "type": "string",
        "description": " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:RefundMethodEnum'>eBay API documentation</a>"
      }
    },
    "returnMethods": {
      "type": "array",
      "description": "A list of return methods allowed for the associated category.",
      "items": {
        "type": "string",
        "description": " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ReturnMethodEnum'>eBay API documentation</a>"
      }
    },
    "returnPeriods": {
      "type": "array",
      "description": "A list of return periods allowed for the associated category.  <br><br>Note that different APIs require you to enter the return period in different ways. For example, the Account API uses the complex <b>TimeDuration</b> type, which takes two values (a <b>unit</b> and a <b>value</b>), whereas the Trading API takes a single value (such as <code>Days_30</code>).",
      "items": {
        "$ref": "#/components/schemas/TimeDuration"
      }
    },
    "returnsAcceptanceEnabled": {
      "type": "boolean",
      "description": "If set to <code>true</code>, this flag indicates the seller can configure how they handle domestic returns."
    },
    "returnShippingCostPayers": {
      "type": "array",
      "description": "A list of allowed values for who pays for the return shipping cost.  <br><br>Note that for SNAD returns, the seller is always responsible for the return shipping cost.",
      "items": {
        "type": "string",
        "description": " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/metadata/types/sel:ReturnShippingCostPayerEnum'>eBay API documentation</a>"
      }
    }
  },
  "description": "This container defines the category policies that relate to domestic and international return policies (the return shipping is made via a domestic or an international shipping service, respectively)."
}