ShippingPrice Data Type

A shipping rate applied to orders shipped to a carrier zone. Contains a base price for the first item and an incremental price for each additional item.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the price.
price number
weightLimit number
country Country Optional country override. When set, this price rule applies only to this specific country rather than all countries in the zone.
ShippingPrice (JSON)
{
  "carrierPrice" : {
    "id" : 12345,
    "price" : 5.0,
    "weightLimit" : -1.0,
    "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
    }
  }
}
ShippingPrice Data Type

A shipping rate applied to orders shipped to a carrier zone. Contains a base price for the first item and an incremental price for each additional item.

Available Since
1.3.0
Properties
Name Type Description
country Country Optional country override. When set, this price rule applies only to this specific country rather than all countries in the zone.
id int Unique numeric identifier for the price.
price decimal  
weightLimit decimal  
ShippingPrice (XML)
<carrierPrice>
  <id>...</id>
  <price>5.00</price>
  <weightLimit>-1</weightLimit>
  <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>
</carrierPrice>