ShippingZoneExpanded Data Type

CarrierZonePrime with embedded destinations and price rules. Use this representation to fetch all zone details in one call.

Available Since
1.3.0
Properties
Name Type Description
destinations array of ShippingDestination A list of Zone destinations.
prices array of ShippingPrice A list of prices in various currencies.
Inherited from ShippingZone
NameTypeDescription
id number Unique numeric identifier for the ShippingZone.
name string The name of the shipping zone.
ShippingZoneExpanded (JSON) 
{
  "carrierZoneExpanded" : {
    "destinations" : {
      "carrierDestination" : [ {
        "id" : 12345,
        "country" : {
          "id" : 12345,
          "code" : "UK",
          "name" : "United Kingdom",
          "standardVat" : { },
          "reducedVat" : { },
          "currency" : { },
          "pricePrecision" : 2,
          "priceFractionalDigits" : 2,
          "default" : true
        }
      }, {
        "id" : 12345,
        "country" : {
          "id" : 12345,
          "code" : "UK",
          "name" : "United Kingdom",
          "standardVat" : { },
          "reducedVat" : { },
          "currency" : { },
          "pricePrecision" : 2,
          "priceFractionalDigits" : 2,
          "default" : true
        }
      } ]
    },
    "prices" : {
      "carrierPrice" : [ {
        "id" : 12345,
        "price" : 5.0,
        "weightLimit" : -1.0,
        "country" : {
          "id" : 12345,
          "code" : "UK",
          "name" : "United Kingdom",
          "standardVat" : { },
          "reducedVat" : { },
          "currency" : { },
          "pricePrecision" : 2,
          "priceFractionalDigits" : 2,
          "default" : true
        }
      }, {
        "id" : 12345,
        "price" : 5.0,
        "weightLimit" : -1.0,
        "country" : {
          "id" : 12345,
          "code" : "UK",
          "name" : "United Kingdom",
          "standardVat" : { },
          "reducedVat" : { },
          "currency" : { },
          "pricePrecision" : 2,
          "priceFractionalDigits" : 2,
          "default" : true
        }
      } ]
    },
    "id" : 12345,
    "name" : "Western Europe"
  }
}
ShippingZoneExpanded Data Type

CarrierZonePrime with embedded destinations and price rules. Use this representation to fetch all zone details in one call.

Available Since
1.3.0
Properties
Name Type Description
carrierDestination list of ShippingDestination A list of Zone destinations.
carrierPrice list of ShippingPrice A list of prices in various currencies.
Inherited from ShippingZone
NameTypeDescription
id int Unique numeric identifier for the ShippingZone.
name string The name of the shipping zone.
ShippingZoneExpanded (XML) 
<carrierZoneExpanded>
  <destinations>
    <carrierDestination>
      <id>...</id>
      <country>
        <id>...</id>
        <code>UK</code>
        <name>United Kingdom</name>
        <standardVat/>
        <reducedVat/>
        <currency/>
        <pricePrecision>2</pricePrecision>
        <priceFractionalDigits>2</priceFractionalDigits>
        <default>...</default>
      </country>
    </carrierDestination>
  </destinations>
  <prices>
    <carrierPrice>
      <id>...</id>
      <price>5.00</price>
      <weightLimit>-1</weightLimit>
      <country>
        <id>...</id>
        <code>UK</code>
        <name>United Kingdom</name>
        <standardVat/>
        <reducedVat/>
        <currency/>
        <pricePrecision>2</pricePrecision>
        <priceFractionalDigits>2</priceFractionalDigits>
        <default>...</default>
      </country>
    </carrierPrice>
  </prices>
  <id>...</id>
  <name>Western Europe</name>
</carrierZoneExpanded>