POST shipping/quote

Request a shipping costs quote.

Request

Body

Must contain the shipment info, including at least one item and a country.

Property Description Type Details
State Optional ISO 3166-2 country subdivision code. string Length: 0-3, inclusive
Country The ISO 3166-1-alpha-2 country code. Country -
Preference Optional custom preference for the shipping method. By default, the least expensive shipping method available will be selected. Set this field to "Tracked" if you want Print API to always select a tracked shipping method if available. ShippingPreference -
Items The items in the shipment. in:Shipment.Item -
{
  "country": "NL",
  "preference": "Auto",
  "items": [
    {
      "productId": "fotoprints_15x10",
      "pageCount": 10,
      "quantity": 1
    }
  ]
}
<?xml version="1.0"?>
<Shipment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Country>NL</Country>
  <Preference>Auto</Preference>
  <Items>
    <Item>
      <ProductId>fotoprints_15x10</ProductId>
      <PageCount>10</PageCount>
      <Quantity>1</Quantity>
    </Item>
  </Items>
</Shipment>

Response

Body

The calculated shipping quote.

Property Description Type Details
Shipping The purchase cost of shipping, before taxes. decimal number -
Handling The purchase cost of handling, before taxes. decimal number -
TaxRate The tax rate for shipping and handling. E.g. 0.21 for 21%. decimal number -
Payment The payment due in the Print API payment screen for shipping and handling, after taxes. decimal number Payment screen only
Method Info about the selected shipping method. out:ShippingMethod -
{
  "shipping": 1.38,
  "handling": 0.40,
  "taxRate": 0.21,
  "payment": 2.15,
  "method": {
    "name": "Brief (50 g)",
    "isTrackable": false
  }
}
<?xml version="1.0"?>
<Quote xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Shipping>1.38</Shipping>
  <Handling>0.40</Handling>
  <TaxRate>0.21</TaxRate>
  <Payment>2.15</Payment>
  <Method>
    <Name>Brief (50 g)</Name>
    <IsTrackable>false</IsTrackable>
  </Method>
</Quote>