ShippingDestination Data Type

A destination country or region within a shipping zone. Determines which customer addresses a zone's shipping rates apply to.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the ShippingDestination.
country Country Destination country.
ShippingDestination (JSON) 
{
  "carrierDestination" : {
    "id" : 12345,
    "country" : {
      "id" : 12345,
      "code" : "UK",
      "name" : "United Kingdom",
      "standardVat" : {
        "id" : 12345,
        "percentValue" : 19.0
      },
      "reducedVat" : {
        "id" : 12345,
        "percentValue" : 19.0
      },
      "currency" : {
        "id" : 12345,
        "code" : "EUR",
        "symbol" : "€",
        "name" : "Euro"
      },
      "pricePrecision" : 2,
      "priceFractionalDigits" : 2,
      "default" : true
    }
  }
}
ShippingDestination Data Type

A destination country or region within a shipping zone. Determines which customer addresses a zone's shipping rates apply to.

Available Since
1.3.0
Properties
Name Type Description
country Country Destination country.
id int Unique numeric identifier for the ShippingDestination.
ShippingDestination (XML) 
<carrierDestination>
  <id>...</id>
  <country>
    <id>...</id>
    <code>UK</code>
    <name>United Kingdom</name>
    <standardVat>
      <id>...</id>
      <percentValue>19</percentValue>
    </standardVat>
    <reducedVat>
      <id>...</id>
      <percentValue>19</percentValue>
    </reducedVat>
    <currency>
      <id>...</id>
      <code>EUR</code>
      <symbol>€</symbol>
      <name>Euro</name>
    </currency>
    <pricePrecision>2</pricePrecision>
    <priceFractionalDigits>2</priceFractionalDigits>
    <default>...</default>
  </country>
</carrierDestination>