getReturnPolicies

{
  "type": "object",
  "description": "The response payload for the <b>getReturnPolicies</b> method. <br /><br /><span class=\"tablenote\"><b>Note</b>: Pagination has not yet been enabled for <b>getReturnPolicies</b>, so all of the pagination-related fields are for future use.</span>",
  "properties": {
    "href": {
      "type": "string",
      "description": "This field is for future use."
    },
    "limit": {
      "type": "integer",
      "format": "int32",
      "description": "This field is for future use."
    },
    "next": {
      "type": "string",
      "description": "This field is for future use."
    },
    "offset": {
      "type": "integer",
      "format": "int32",
      "description": "This field is for future use."
    },
    "prev": {
      "type": "string",
      "description": "This field is for future use."
    },
    "returnPolicies": {
      "type": "array",
      "description": "A list of all of the seller's return business policies defined for the specified marketplace. This array will be returned as empty if no return business policies are defined for the specified marketplace.",
      "items": {
        "type": "object",
        "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.",
        "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": {
              "type": "object",
              "description": "The category type discerns whether the policy applies to motor vehicle listings, or to any other items except motor vehicle listings. <br/><br/>Each business policy can be associated with either or both categories ('MOTORS_VEHICLES' and 'ALL_EXCLUDING_MOTORS_VEHICLES'); however, return business policies are not applicable for motor vehicle listings.",
              "properties": {
                "default": {
                  "type": "boolean",
                  "description": "<span class=\"tablenote\"><strong>Note:</strong> This field has been deprecated and is no longer used.<ul><li>Do not include this field in any <b>create</b> or <b>update</b> method.</li><li>This field may be returned within the payload of a <b>get</b> method, but it can be ignored.</li></ul></span>"
                },
                "name": {
                  "type": "string",
                  "description": "The category type to which the policy applies (motor vehicles or non-motor vehicles). <br /><br />The <code>MOTORS_VEHICLES</code> category type is not valid for return policies. eBay flows do not support the return of motor vehicles. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CategoryTypeEnum'>eBay API documentation</a>"
                }
              }
            }
          },
          "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": {
            "type": "object",
            "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.",
            "properties": {
              "returnMethod": {
                "type": "string",
                "description": "This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return. The buyer must be willing to accept a replacement item; otherwise, the seller will need to issue a refund for a return. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a>"
              },
              "returnPeriod": {
                "type": "object",
                "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/>You must set the value to one that's accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods. For a definitive list of return periods for one or more categories, call <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies\">getReturnPolicies</a> method of the <b>Metadata API</b>. <br/><br/>The <b>TimeDuration</b> type is used to set/indicate the return period, and you set the <b>unit</b> value to <code>DAY</code> and the <b>value</b> field to either <code>30</code> or <code>60</code> (or other value, as appropriate).  <br/><br/>Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours.  <br/><br/>This field is conditionally required if the <b>internationalOverride.returnsAccepted</b> field is set to <code>true</code>.",
                "properties": {
                  "unit": {
                    "type": "string",
                    "description": "These enum values represent the time measurement unit, such as <code>DAY</code>. A span of time is defined when you apply the value specified in the <b>value</b> field to the value specified for <b>unit</b>. <br/><br/>See <b>TimeDurationUnitEnum</b> for a complete list of possible time-measurement units. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:TimeDurationUnitEnum'>eBay API documentation</a>"
                  },
                  "value": {
                    "type": "integer",
                    "format": "int32",
                    "description": "An integer that represents an amount of time, as measured by the time-measurement unit specified in the <b>unit</b> field."
                  }
                }
              },
              "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 'significantly not as described' (SNAD) issues.  <br/><br/>This field is conditionally required if the <b>internationalOverride.returnsAccepted</b> field is set to <code>true</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a>"
              },
              "returnsAccepted": {
                "type": "boolean",
                "description": "If set to <code>true</code>, the seller accepts international returns. If set to <code>false</code>, the seller does not accept international returns.  <br/><br/>This field is conditionally required if the seller chooses to have a separate international return policy."
              }
            }
          },
          "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. <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": {
            "type": "object",
            "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>",
            "properties": {
              "unit": {
                "type": "string",
                "description": "These enum values represent the time measurement unit, such as <code>DAY</code>. A span of time is defined when you apply the value specified in the <b>value</b> field to the value specified for <b>unit</b>. <br/><br/>See <b>TimeDurationUnitEnum</b> for a complete list of possible time-measurement units. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:TimeDurationUnitEnum'>eBay API documentation</a>"
              },
              "value": {
                "type": "integer",
                "format": "int32",
                "description": "An integer that represents an amount of time, as measured by the time-measurement unit specified in the <b>unit</b> field."
              }
            }
          },
          "returnPolicyId": {
            "type": "string",
            "description": "A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created."
          },
          "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>"
          },
          "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>"
          }
        }
      }
    },
    "total": {
      "type": "integer",
      "format": "int32",
      "description": "The total number of return business policies retrieved in the result set.  <br/><br/>If no return business policies are defined for the specified marketplace, this field is returned with a value of <code>0</code>."
    }
  }
}