eBay · Schema

ReturnPolicy

This type is used by the returnPolicy response container, a container which defines a seller's return business policy for a specific marketplace.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
categoryTypes array This container indicates which category group that the return policy applies to.

Note: Return business policies are not applicable to motor vehicle listings, so t
description string A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250
extendedHolidayReturnsOffered boolean

Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neithe

internationalOverride object This container shows the seller's international return policy settings. This container is only returned if the seller has set a separate international return policy for the business policies. Internat
marketplaceId string The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBa
name string A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64
refundMethod string If a seller indicates that they will accept buyer returns, this value will be set to MONEY_BACK. For implementation help, refer to <
returnPolicyId string A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created.
returnsAccepted boolean If this field is returned as true, the seller accepts returns.

Note:Top-Rated sellers must accept item returns and the handlingTime
returnShippingCostPayer string This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Depending on the retur
View JSON Schema on GitHub

JSON Schema

ebay-returnpolicy-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ReturnPolicy",
  "title": "ReturnPolicy",
  "type": "object",
  "properties": {
    "categoryTypes": {
      "type": "array",
      "description": "This container indicates which category group that the return policy applies to.<br><br><span class=\"tablenote\"><b>Note</b>: Return business policies are not applicable to motor vehicle listings, so the <b>categoryTypes.name</b> value will always be <code>ALL_EXCLUDING_MOTORS_VEHICLES</code> for return business policies.</span>",
      "items": {
        "$ref": "#/components/schemas/CategoryType"
      }
    },
    "description": {
      "type": "string",
      "description": "A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.  <br><br><b>Max length</b>: 250"
    },
    "extendedHolidayReturnsOffered": {
      "type": "boolean",
      "description": "<p class=\"tablenote\"><span  style=\"color: #dd1e31;\"><b>Important!</b></span> This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.</p> "
    },
    "internationalOverride": {
      "description": "This container shows the seller's international return policy settings. This container is only returned if the seller has set a separate international return policy for the business policies. International return policies are optional, even if the seller ships to international locations. If a separate international return policy is not set, all of the domestic return policy settings also apply to international orders.",
      "$ref": "#/components/schemas/InternationalReturnOverrideType"
    },
    "marketplaceId": {
      "type": "string",
      "description": "The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>"
    },
    "name": {
      "type": "string",
      "description": "A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64"
    },
    "refundMethod": {
      "type": "string",
      "description": "If a seller indicates that they will accept buyer returns, this value will be set to <code>MONEY_BACK</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay API documentation</a>"
    },
    "restockingFeePercentage": {
      "type": "string",
      "description": "<p class=\"tablenote\"><span  style=\"color: #dd1e31;\"><b>Important!</b></span> This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored and it is no longer returned.</p>"
    },
    "returnInstructions": {
      "type": "string",
      "description": "This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy.<br><p class=\"tablenote\"><span  style=\"color: #dd1e31;\"><b>Important!</b></span> This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies\">getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code> for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for DE)"
    },
    "returnMethod": {
      "type": "string",
      "description": "This field is only returned if the seller is willing to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a>"
    },
    "returnPeriod": {
      "description": "This container indicates the number of calendar days that the buyer has to return an item. The return period begins when the item is marked \"delivered\" at the buyer's specified ship-to location.  <br><br>Most categories support 30-day and 60-day return periods.<br><br><span class=\"tablenote\"><b>Note</b>: Unless the seller has set a separate international return policy through the <b>internationalOverride</b> container, this return period will be valid for domestic and international returns (if the seller ships internationally).</span>",
      "$ref": "#/components/schemas/TimeDuration"
    },
    "returnPolicyId": {
      "type": "string",
      "description": "A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created."
    },
    "returnsAccepted": {
      "type": "boolean",
      "description": "If this field is returned as <code>true</code>, the seller accepts returns. <br><br><span class=\"tablenote\"><strong>Note:</strong>Top-Rated sellers must accept item returns and the <b>handlingTime</b> should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see <a href=\"https://pages.ebay.com/help/sell/top-rated.html \">Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits</a>.</span>"
    },
    "returnShippingCostPayer": {
      "type": "string",
      "description": "This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>.  <br><br>Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a>"
    }
  },
  "description": "This type is used by the <b>returnPolicy</b> response container, a container which defines a seller's return business policy for a specific marketplace."
}