eBay · Schema

ListingPolicies

This type is used to identify business policies including payment, return, and fulfillment policies, as well as to identify custom policies. These policies are, or will be, associated with the listing. Every published offer must have a payment, return, and fulfillment business policy associated with it. Additionally, depending on the country/countries in which sellers are offering products and/or services to consumers (e.g., residents of the European Union,) specifying additional polices may be required.

This type is also used to override the shipping costs of one or more shipping service options that are associated with the fulfillment policy, to enable eBay Plus eligibility for a listing, or to enable the Best Offer feature on the listing.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
bestOfferTerms object This container is used if the seller would like to support the Best Offer feature on their listing. To enable the Best Offer feature, the seller will have to set the bestOfferEnabled
eBayPlusIfEligible boolean This field is included in an offer and set to true if a Top-Rated seller is opted in to the eBay Plus program. With the eBay Plus program, qualified sellers must commit to next-day delive
fulfillmentPolicyId string This unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing. This fulfillment business policy will set all fulfillmen
paymentPolicyId string This unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing. This payment business policy will set all payment-related se
productCompliancePolicyIds array This field contains the array of unique identifiers indicating the seller-created global product compliance policies that will be used once an offer is published and converted to a listing.
regionalProductCompliancePolicies object A comma-delimited list of unique identifiers indicating the seller-created country-specific product compliance policies that that will be used once an offer is published and converted to a list
regionalTakeBackPolicies object The list of unique identifiers indicating the seller-created country-specific take-back policies that will be used once an offer is published and converted to a listing. The law in some countri
returnPolicyId string This unique identifier indicates the return business policy that will be used once an offer is published and converted to an eBay listing. This return business policy will set all return policy settin
shippingCostOverrides array This container is used if the seller wishes to override the shipping costs or surcharge for one or more domestic or international shipping service options defined in the fulfillment listing policy. To
takeBackPolicyId string This unique identifier indicates the seller-created global take-back policy that will be used once an offer is published and converted to a listing.

One (1) global take-back policy may b
View JSON Schema on GitHub

JSON Schema

ebay-listingpolicies-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListingPolicies",
  "title": "ListingPolicies",
  "type": "object",
  "properties": {
    "bestOfferTerms": {
      "description": "This container is used if the seller would like to support the Best Offer feature on their listing. To enable the Best Offer feature, the seller will have to set the <strong>bestOfferEnabled</strong> field to <code>true</code>, and the seller also has the option of setting 'auto-accept' and 'auto-decline' price thresholds.<br><br><span class=\"tablenote\"><b>Note:</b> Best Offer is unavailable for multi-variation listings.</span><br>This container is only returned if Best Offer is enabled on listing.",
      "$ref": "#/components/schemas/BestOffer"
    },
    "eBayPlusIfEligible": {
      "type": "boolean",
      "description": "This field is included in an offer and set to <code>true</code> if a Top-Rated seller is opted in to the eBay Plus program. With the eBay Plus program, qualified sellers must commit to next-day delivery of the item, and the buyers must have an eBay Plus subscription to be eligible to receive the benefits of this program, which are free, next-day delivery, as well as free returns.<br><br><span class=\"tablenote\"><b>Note:</b> Currently, this program is only available on the Germany and Australian sites.</span><br>This field will be returned in the <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffer\" target=\"_blank\">getOffer</a> and <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffers\" target=\"_blank\">getOffers</a> methods if set for the offer."
    },
    "fulfillmentPolicyId": {
      "type": "string",
      "description": "This unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing. This fulfillment business policy will set all fulfillment-related settings for the eBay listing.<br><br>Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the fulfillment business policy before assigning it to the offer to make sure it is compatible with the inventory item and the offer settings. The seller may also want to review the shipping service costs in the fulfillment policy, and that seller might decide to override the shipping costs for one or more shipping service options by using the <strong>shippingCostOverrides</strong> container.<br><br>Business policies can be created and managed in My eBay or with the <a href=\"/api-docs/sell/account/overview.html\" target=\"_blank\">Account API</a>. To get a list of all return policies associated with a seller's account on a specific eBay Marketplace, use the Account API's <a href=\"/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies\" target=\"_blank\">getFulfillmentPolicies</a> method. There are also calls in the <strong>Account API</strong> to retrieve a fulfillment policy by policy ID or policy name.<br><br>This field will be returned in the <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffer\" target=\"_blank\">getOffer</a> and <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffers\" target=\"_blank\">getOffers</a> methods if set for the offer."
    },
    "paymentPolicyId": {
      "type": "string",
      "description": "This unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing. This payment business policy will set all payment-related settings for the eBay listing.<br><br>Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the payment business policy to make sure that it is compatible with the marketplace and listing category before assigning it to the offer.<br><br>Business policies can be created and managed in My eBay or with the <a href=\"/api-docs/sell/account/overview.html\" target=\"_blank\">Account API</a>. To get a list of all payment policies associated with a seller's account on a specific eBay Marketplace, use the Account API's <a href=\"/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies\" target=\"_blank\">getPaymentPolicies</a> method. There are also calls in the <strong>Account API</strong> to retrieve a payment policy by policy ID or policy name.<br><br>This field will be returned in the <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffer\" target=\"_blank\">getOffer</a> and <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffers\" target=\"_blank\">getOffers</a> methods if set for the offer."
    },
    "productCompliancePolicyIds": {
      "type": "array",
      "description": "This field contains the array of unique identifiers indicating the seller-created <i>global</i> product compliance policies that will be used once an offer is published and converted to a listing.<br><br>Product compliance policies provide buyers with important information and disclosures about products. For example, if you sell batteries and specific disclosures are required to be shared with all potential buyers, your global product compliance policy could contain the required disclosures.<br><br>A maximum of six (6) global product compliance policies may apply to <i>each offer</i>.<span class=\"tablenote\"><b>Note:</b> For countries that support country-specific policies, use <a href=\"#request.listingPolicies.regionalProductCompliancePolicies\">regionalProductCompliancePolicies</a> to apply them to an offer.</span>",
      "items": {
        "type": "string"
      }
    },
    "regionalProductCompliancePolicies": {
      "description": "A comma-delimited list of unique identifiers indicating the seller-created <i>country-specific</i> product compliance policies that that will be used once an offer is published and converted to a listing.<br><br>Product compliance policies provide buyers with important information and disclosures about products. For example, if you sell batteries in a country requiring disclosures that apply <i>only</i> to that country, a country-specific product compliance policy could contain this information.<br><br>Each offer may include up to six (6) product compliance policies for <i>each</i> of the following countries:<ul><li>United Kingdom [GB]</li><li>Germany [DE]</li><li>France [FR]</li><li>Italy [IT]</li><li>Spain [ES]</li></ul><br>For example, if a seller offers products in the UK, Germany, and Italy, each of which requires custom product compliance information, up to 18 policies (i.e., 6 policies x 3 countries,) may be included with each offer.<span class=\"tablenote\"><b>Note:</b> Product compliance policies that apply to <i>all</i> countries to which a seller ships are specified using <a href=\"#request.listingPolicies.productCompliancePolicyIds\">productCompliancePolicyIds</a>.</span>",
      "$ref": "#/components/schemas/RegionalProductCompliancePolicies"
    },
    "regionalTakeBackPolicies": {
      "description": "The list of unique identifiers indicating the seller-created <i>country-specific</i> take-back policies that will be used once an offer is published and converted to a listing. The law in some countries may require sellers to take back a used product when the buyer buys a new product.<br><br>Each offer may include one (1) country-specific take-back policy for <i>each</i> of the following countries:<ul><li>United Kingdom [GB]</li><li>Germany [DE]</li><li>France [FR]</li><li>Italy [IT]</li><li>Spain [ES]</li></ul><br><span class=\"tablenote\"><b>Note:</b> Take-back policies that apply to <i>all</i> countries to which a seller ships are specified using <a href=\"#request.listingPolicies.takeBackPolicyId\">takeBackPolicyId</a>.</span>",
      "$ref": "#/components/schemas/RegionalTakeBackPolicies"
    },
    "returnPolicyId": {
      "type": "string",
      "description": "This unique identifier indicates the return business policy that will be used once an offer is published and converted to an eBay listing. This return business policy will set all return policy settings for the eBay listing.<br><br><span class=\"tablenote\"><b>Note:</b> As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers.</span><br>Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the return business policy before assigning it to the offer to make sure it is compatible with the inventory item and the offer settings.<br><br>Business policies can be created and managed in My eBay or with the <a href=\"/developer.ebay.com/api-docs/sell/account/overview.html\" target=\"_blank\">Account API</a>. To get a list of all return policies associated with a seller's account on a specific eBay Marketplace, use the Account API's <a href=\"/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies\" target=\"_blank\">getReturnPolicies</a> call. There are also calls in the <strong>Account API</strong> to retrieve a return policy by policy ID or policy name.<br><br>This field will be returned in the <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffer\" target=\"_blank\">getOffer</a> and <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffers\" target=\"_blank\">getOffers</a> methods if set for the offer."
    },
    "shippingCostOverrides": {
      "type": "array",
      "description": "This container is used if the seller wishes to override the shipping costs or surcharge for one or more domestic or international shipping service options defined in the fulfillment listing policy. To override the costs of a specific domestic or international shipping service option, the seller must know the priority/order of that shipping service in the fulfillment listing policy. The name of a shipping service option can be found in the <strong>shippingOptions.shippingServices.shippingServiceCode</strong> field of the fulfillment policy, and the priority/order of that shipping service option is found in the <strong>shippingOptions.shippingServices.sortOrderId</strong> field. Both of these values can be retrieved by searching for that fulfillment policy with the <strong>getFulfillmentPolicies</strong> or <strong>getFulfillmentPolicyByName</strong> calls of the <strong>Account API</strong>. The <strong>shippingCostOverrides.priority</strong> value should match the <strong>shippingOptions.shippingServices.sortOrderId</strong> in order to override the shipping costs for that shipping service option. The seller must also ensure that the <strong>shippingServiceType</strong> value is set to <code>DOMESTIC</code> to override a domestic shipping service option, or to <code>INTERNATIONAL</code> to override an international shipping service option.<br><br>A separate <strong>ShippingCostOverrides</strong> node is needed for each shipping service option whose costs are being overridden. All defined fields of the <strong>shippingCostOverrides</strong> container should be included, even if the shipping costs and surcharge values are not changing.<br><br>The <strong>shippingCostOverrides</strong> container is returned in the <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffer\" target=\"_blank\">getOffer</a> and <a href=\"/api-docs/sell/inventory/resources/offer/methods/getOffers\" target=\"_blank\">getOffers</a> calls if one or more shipping cost overrides are being applied to the fulfillment policy.",
      "items": {
        "$ref": "#/components/schemas/ShippingCostOverride"
      }
    },
    "takeBackPolicyId": {
      "type": "string",
      "description": "This unique identifier indicates the seller-created <i>global</i> take-back policy that will be used once an offer is published and converted to a listing.<br><br>One (1) global take-back policy may be specified <i>per offer</i>.<br><span class=\"tablenote\"><b>Note:</b> For countries that support country-specific policies, use <a href=\"#request.listingPolicies.regionalTakeBackPolicies\">regionalTakeBackPolicies</a> to apply them to an offer.</span>"
    }
  },
  "description": "This type is used to identify business policies including payment, return, and fulfillment policies, as well as to identify custom policies. These policies are, or will be, associated with the listing. Every published offer must have a payment, return, and fulfillment business policy associated with it. Additionally, depending on the country/countries in which sellers are offering products and/or services to consumers (e.g., residents of the European Union,) specifying additional polices may be required.<br><br>This type is also used to override the shipping costs of one or more shipping service options that are associated with the fulfillment policy, to enable eBay Plus eligibility for a listing, or to enable the Best Offer feature on the listing."
}