eBay · Schema

RegionSet

This type consists of the regionIncluded and regionExcluded arrays, which indicate the areas to where the seller does and doesn't ship.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
regionExcluded array An array of one or more regionName values that specify the areas to where a seller does not ship. A regionExcluded list should only be set in the top-level shipToLocations contain
regionIncluded array An array of one or more regionName fields that specify the areas to where a seller ships.
Each eBay marketplace supports its own set of allowable shipping locations.

View JSON Schema on GitHub

JSON Schema

ebay-regionset-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RegionSet",
  "title": "RegionSet",
  "type": "object",
  "properties": {
    "regionExcluded": {
      "type": "array",
      "description": "An array of one or more <b>regionName</b> values that specify the areas to where a seller does not ship. A <b>regionExcluded</b> list should only be set in the top-level <b>shipToLocations</b> container and not within the <b>shippingServices.shipToLocations</b> container used to specify which shipping regions are serviced by each available shipping service option. <p>Many sellers are willing to ship to many international locations, but they may want to exclude some world regions or some countries as places they are willing to ship to.<br><br>This array will be returned as empty if no shipping regions are excluded with the fulfillment business policy.<br> <br><span class=\"tablenote\"><b>Note: </b> The <b>regionExcluded</b> array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a <b>createFulfillmentPolicy</b> or <b>updateFulfillmentPolicy</b> request, it will be ignored.</span>",
      "items": {
        "$ref": "#/components/schemas/Region"
      }
    },
    "regionIncluded": {
      "type": "array",
      "description": "An array of one or more <b>regionName</b> fields that specify the areas to where a seller ships. <br>Each eBay marketplace supports its own set of allowable shipping locations.<br> <br><span class=\"tablenote\"><b>Note: </b> The <b>regionIncluded</b> array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a <b>createFulfillmentPolicy</b> or <b>updateFulfillmentPolicy</b> request, it will be ignored.</span>",
      "items": {
        "$ref": "#/components/schemas/Region"
      }
    }
  },
  "description": "This type consists of the <b>regionIncluded</b> and <b>regionExcluded</b> arrays, which indicate the areas to where the seller does and doesn't ship."
}