Shippingsettings

For a list of methods for this resource, see the end of this page.

Resource representations

The merchant account's shipping settings.

{
  "accountId": unsigned long,
  "services": [
    {
      "name": string,
      "active": boolean,
      "deliveryCountry": string,
      "currency": string,
      "deliveryTime": {
        "minTransitTimeInDays": unsigned integer,
        "maxTransitTimeInDays": unsigned integer
      },
      "rateGroups": [
        {
          "applicableShippingLabels": [
            string
          ],
          "singleValue": {
            "noShipping": boolean,
            "flatRate": {
              "value": string,
              "currency": string
            },
            "pricePercentage": string,
            "carrierRateName": string,
            "subtableName": string
          },
          "mainTable": {
            "name": string,
            "rowHeaders": {
              "prices": [
                {
                  "value": string,
                  "currency": string
                }
              ],
              "weights": [
                {
                  "value": string,
                  "unit": string
                }
              ],
              "numberOfItems": [
                string
              ],
              "postalCodeGroupNames": [
                string
              ],
              "locations": [
                {
                  "locationIds": [
                    string
                  ]
                }
              ]
            },
            "columnHeaders": {
              "prices": [
                {
                  "value": string,
                  "currency": string
                }
              ],
              "weights": [
                {
                  "value": string,
                  "unit": string
                }
              ],
              "numberOfItems": [
                string
              ],
              "postalCodeGroupNames": [
                string
              ],
              "locations": [
                {
                  "locationIds": [
                    string
                  ]
                }
              ]
            },
            "rows": [
              {
                "cells": [
                  {
                    "noShipping": boolean,
                    "flatRate": {
                      "value": string,
                      "currency": string
                    },
                    "pricePercentage": string,
                    "carrierRateName": string,
                    "subtableName": string
                  }
                ]
              }
            ]
          },
          "subtables": [
            {
              "name": string,
              "rowHeaders": {
                "prices": [
                  {
                    "value": string,
                    "currency": string
                  }
                ],
                "weights": [
                  {
                    "value": string,
                    "unit": string
                  }
                ],
                "numberOfItems": [
                  string
                ],
                "postalCodeGroupNames": [
                  string
                ],
                "locations": [
                  {
                    "locationIds": [
                      string
                    ]
                  }
                ]
              },
              "columnHeaders": {
                "prices": [
                  {
                    "value": string,
                    "currency": string
                  }
                ],
                "weights": [
                  {
                    "value": string,
                    "unit": string
                  }
                ],
                "numberOfItems": [
                  string
                ],
                "postalCodeGroupNames": [
                  string
                ],
                "locations": [
                  {
                    "locationIds": [
                      string
                    ]
                  }
                ]
              },
              "rows": [
                {
                  "cells": [
                    {
                      "noShipping": boolean,
                      "flatRate": {
                        "value": string,
                        "currency": string
                      },
                      "pricePercentage": string,
                      "carrierRateName": string,
                      "subtableName": string
                    }
                  ]
                }
              ]
            }
          ],
          "carrierRates": [
            {
              "name": string,
              "carrierName": string,
              "carrierService": string,
              "originPostalCode": string,
              "percentageAdjustment": string,
              "flatAdjustment": {
                "value": string,
                "currency": string
              }
            }
          ]
        }
      ],
      "minimumOrderValue": {
        "value": string,
        "currency": string
      }
    }
  ],
  "postalCodeGroups": [
    {
      "name": string,
      "country": string,
      "postalCodeRanges": [
        {
          "postalCodeRangeBegin": string,
          "postalCodeRangeEnd": string
        }
      ]
    }
  ]
}
Property name Value Description Notes
accountId unsigned long The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
postalCodeGroups[] list A list of postal code groups that can be referred to in services. Optional.
postalCodeGroups[].country string The CLDR territory code of the country the postal code group applies to. Required.
postalCodeGroups[].name string The name of the postal code group, referred to in headers. Required.
postalCodeGroups[].postalCodeRanges[] list A range of postal codes. Required.
postalCodeGroups[].postalCodeRanges[].postalCodeRangeBegin string A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
postalCodeGroups[].postalCodeRanges[].postalCodeRangeEnd string A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
services[] list The target account's list of services. Optional.
services[].active boolean A boolean exposing the active status of the shipping service. Required.
services[].currency string The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
services[].deliveryCountry string The CLDR territory code of the country to which the service applies. Required.
services[].deliveryTime nested object Time spent in various aspects from order to the delivery of the product. Required.
services[].deliveryTime.maxTransitTimeInDays unsigned integer Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
services[].deliveryTime.minTransitTimeInDays unsigned integer Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
services[].minimumOrderValue nested object Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
services[].minimumOrderValue.currency string The currency of the price. writable
services[].minimumOrderValue.value string The price represented as a number. writable
services[].name string Free-form name of the service. Must be unique within target account. Required.
services[].rateGroups[] list Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
services[].rateGroups[].applicableShippingLabels[] list A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
services[].rateGroups[].carrierRates[] list A list of carrier rates that can be referred to by mainTable or singleValue.
services[].rateGroups[].carrierRates[].carrierName string Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
services[].rateGroups[].carrierRates[].carrierService string Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
services[].rateGroups[].carrierRates[].flatAdjustment nested object Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
services[].rateGroups[].carrierRates[].flatAdjustment.currency string The currency of the price. writable
services[].rateGroups[].carrierRates[].flatAdjustment.value string The price represented as a number. writable
services[].rateGroups[].carrierRates[].name string Name of the carrier rate. Must be unique per rate group. Required.
services[].rateGroups[].carrierRates[].originPostalCode string Shipping origin for this carrier rate. Required.
services[].rateGroups[].carrierRates[].percentageAdjustment string Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
services[].rateGroups[].mainTable nested object A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
services[].rateGroups[].mainTable.columnHeaders nested object Headers of the table's columns. Optional: if not set then the table has only one dimension.
services[].rateGroups[].mainTable.columnHeaders.locations[] list A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.columnHeaders.locations[].locationIds[] list A non-empty list of location IDs. They must all be of the same location type (e.g., state).
services[].rateGroups[].mainTable.columnHeaders.numberOfItems[] list A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.columnHeaders.postalCodeGroupNames[] list A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.columnHeaders.prices[] list A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.columnHeaders.prices[].currency string The currency of the price. writable
services[].rateGroups[].mainTable.columnHeaders.prices[].value string The price represented as a number. writable
services[].rateGroups[].mainTable.columnHeaders.weights[] list A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.columnHeaders.weights[].unit string The weight unit.

Acceptable values are:
  • "kg"
  • "lb"
services[].rateGroups[].mainTable.columnHeaders.weights[].value string The weight represented as a number.
services[].rateGroups[].mainTable.name string Name of the table. Required for subtables, ignored for the main table.
services[].rateGroups[].mainTable.rowHeaders nested object Headers of the table's rows. Required.
services[].rateGroups[].mainTable.rowHeaders.locations[] list A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rowHeaders.locations[].locationIds[] list A non-empty list of location IDs. They must all be of the same location type (e.g., state).
services[].rateGroups[].mainTable.rowHeaders.numberOfItems[] list A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rowHeaders.postalCodeGroupNames[] list A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rowHeaders.prices[] list A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rowHeaders.prices[].currency string The currency of the price. writable
services[].rateGroups[].mainTable.rowHeaders.prices[].value string The price represented as a number. writable
services[].rateGroups[].mainTable.rowHeaders.weights[] list A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rowHeaders.weights[].unit string The weight unit.

Acceptable values are:
  • "kg"
  • "lb"
services[].rateGroups[].mainTable.rowHeaders.weights[].value string The weight represented as a number.
services[].rateGroups[].mainTable.rows[] list The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
services[].rateGroups[].mainTable.rows[].cells[] list The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
services[].rateGroups[].mainTable.rows[].cells[].carrierRateName string The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rows[].cells[].flatRate nested object A flat rate. Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rows[].cells[].flatRate.currency string The currency of the price. writable
services[].rateGroups[].mainTable.rows[].cells[].flatRate.value string The price represented as a number. writable
services[].rateGroups[].mainTable.rows[].cells[].noShipping boolean If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rows[].cells[].pricePercentage string A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
services[].rateGroups[].mainTable.rows[].cells[].subtableName string The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
services[].rateGroups[].singleValue nested object The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
services[].rateGroups[].singleValue.carrierRateName string The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
services[].rateGroups[].singleValue.flatRate nested object A flat rate. Can only be set if all other fields are not set.
services[].rateGroups[].singleValue.flatRate.currency string The currency of the price. writable
services[].rateGroups[].singleValue.flatRate.value string The price represented as a number. writable
services[].rateGroups[].singleValue.noShipping boolean If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
services[].rateGroups[].singleValue.pricePercentage string A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
services[].rateGroups[].singleValue.subtableName string The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
services[].rateGroups[].subtables[] list A list of subtables referred to by mainTable. Can only be set if mainTable is set.
services[].rateGroups[].subtables[].columnHeaders nested object Headers of the table's columns. Optional: if not set then the table has only one dimension.
services[].rateGroups[].subtables[].columnHeaders.locations[] list A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].columnHeaders.locations[].locationIds[] list A non-empty list of location IDs. They must all be of the same location type (e.g., state).
services[].rateGroups[].subtables[].columnHeaders.numberOfItems[] list A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].columnHeaders.postalCodeGroupNames[] list A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].columnHeaders.prices[] list A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].columnHeaders.prices[].currency string The currency of the price. writable
services[].rateGroups[].subtables[].columnHeaders.prices[].value string The price represented as a number. writable
services[].rateGroups[].subtables[].columnHeaders.weights[] list A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].columnHeaders.weights[].unit string The weight unit.

Acceptable values are:
  • "kg"
  • "lb"
services[].rateGroups[].subtables[].columnHeaders.weights[].value string The weight represented as a number.
services[].rateGroups[].subtables[].name string Name of the table. Required for subtables, ignored for the main table.
services[].rateGroups[].subtables[].rowHeaders nested object Headers of the table's rows. Required.
services[].rateGroups[].subtables[].rowHeaders.locations[] list A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rowHeaders.locations[].locationIds[] list A non-empty list of location IDs. They must all be of the same location type (e.g., state).
services[].rateGroups[].subtables[].rowHeaders.numberOfItems[] list A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rowHeaders.postalCodeGroupNames[] list A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rowHeaders.prices[] list A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rowHeaders.prices[].currency string The currency of the price. writable
services[].rateGroups[].subtables[].rowHeaders.prices[].value string The price represented as a number. writable
services[].rateGroups[].subtables[].rowHeaders.weights[] list A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rowHeaders.weights[].unit string The weight unit.

Acceptable values are:
  • "kg"
  • "lb"
services[].rateGroups[].subtables[].rowHeaders.weights[].value string The weight represented as a number.
services[].rateGroups[].subtables[].rows[] list The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
services[].rateGroups[].subtables[].rows[].cells[] list The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
services[].rateGroups[].subtables[].rows[].cells[].carrierRateName string The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rows[].cells[].flatRate nested object A flat rate. Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rows[].cells[].flatRate.currency string The currency of the price. writable
services[].rateGroups[].subtables[].rows[].cells[].flatRate.value string The price represented as a number. writable
services[].rateGroups[].subtables[].rows[].cells[].noShipping boolean If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rows[].cells[].pricePercentage string A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
services[].rateGroups[].subtables[].rows[].cells[].subtableName string The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.

Methods

custombatch
Retrieves and updates the shipping settings of multiple accounts in a single request.
get
Retrieves the shipping settings of the account.
getsupportedcarriers
Retrieves supported carriers and carrier services for an account.
list
Lists the shipping settings of the sub-accounts in your Merchant Center account.
patch
Updates the shipping settings of the account. This method supports patch semantics.
update
Updates the shipping settings of the account.

Send feedback about...

Content API for Shopping