Sign in
Shipping Options

Retrieve List of Shipping Options

When integrating the Print API with your own shop, you might want to give customers an option to select among different shipping levels. This endpoint allows you to request available shipping methods (including cost) with minimal input data:

  • country
  • page_count
  • quantity
  • pod_package_id
  • currency only required if you don't want USD

A valid state_code must be included in the shipping address to receive accurate shipping information.

<details close> <summary>Countries that require valid state code (ISO 3166-1 alpha-2 code in parentheses)</summary>
  • United Arab Emirates (AE)
  • American Samoa (AS)
  • Australia (AU)
  • Brazil (BR)
  • Canada (CA)
  • China (CN)
  • Colombia (CO)
  • Costa Rica (CR)
  • Cayman Islands (KY)
  • Spain (ES)
  • Micronesia (FM)
  • Hong Kong (HK)
  • Honduras (HN)
  • Indonesia (ID)
  • India (IN)
  • Iraq (IQ)
  • Italy (IT)
  • Jamaica (JM)
  • Japan (JP)
  • Saint Kitts and Nevis (KN)
  • Korea (KR)
  • Mexico (MX)
  • Marshall Islands (MH)
  • Northern Mariana Islands (MP)
  • Nauru (NR)
  • Palau (PW)
  • Papua New Guinea (PG)
  • French Polynesia (PF)
  • Russian Federation (RU)
  • El Salvador (SV)
  • Somalia (SO)
  • Taiwan (TW)
  • United States Minor Outlying Islands (UM)
  • United States (US)
  • Venezuela (VE)
  • Virgin Islands, U.S. (VI)
</details>

You can further restrict shipping options that support post box delivery by adding is_postbox=true to your shipping address data.

post/shipping-options/

Request body

currencystring

Currency to base cost calculations on, defaults to USD. Available currencies are AUD, CAD, EUR, GBP, and USD.

Example request

{
  "currency": "USD",
  "line_items": [
    {
      "page_count": 32,
      "pod_package_id": "0600X0900.BW.STD.PB.060UW444.MXX",
      "quantity": 1
    },
    {
      "page_count": 324,
      "pod_package_id": "0850X1100.FC.STD.PB.060UW444.MXX",
      "quantity": 2
    }
  ],
  "shipping_address": {
    "city": "Washington",
    "country": "US",
    "postcode": "20540",
    "state_code": "DC",
    "street1": "101 Independence Ave SE"
  }
}

Response

OK

business_onlyboolean required

Delivery only on working days

cost_excl_taxstring

The shipping cost excluding taxes as a decimal string. This attribute will only be set on the detail endpoint representation, and only if the query parameters 'quantity' and 'currency' are provided

currencystring

Currency of cost_excl_tax

home_onlyboolean required

Delivery also on non working days

idnumber required
level'MAIL' | 'PRIORITY_MAIL' | 'GROUND_HD' | 'GROUND_BUS' | 'GROUND' | 'EXPEDITED' | 'EXPRESS' required
max_delivery_datestring required

Latest estimated delivery date in (ISO 8601) format. When no pod_package_id is provided in the request, the estimate is based on product types with the longest estimated production time (usually hardcover books).

max_dispatch_datestring

Latest estimated dispatch (handover to carrier) date in (ISO 8601) format. When no pod_package_id is provided in the request, the estimate is based on product types with the longest estimated production time (usually hardcover books).

min_delivery_datestring required

Earliest estimated delivery date in (ISO 8601) format. When no pod_package_id is provided in the request, the estimate is based on product types with the shortest estimated production time (usually non-hardcover books).

min_dispatch_datestring

Earliest estimated dispatch (handover to carrier) date in (ISO 8601) format. When no pod_package_id is provided in the request, the estimate is based on product types with the shortest estimated production time (usually non-hardcover books).

postbox_okboolean required

Support of delivery to postboxes

total_days_maxnumber

Highest estimate of total business days from start of production to delivery. When no pod_package_id is provided in the request, the estimate is based on product types with the longest estimated production time (usually hardcover books).

total_days_minnumber

Lowest estimate of total business days from start of production to delivery. When no pod_package_id is provided in the request, the estimate is based on product types with the shortest estimated production time (usually non-hardcover books).

traceableboolean required

If this shipping provides the possibility to create a tracking link

transit_timenumber required

Average transit time in days

Example response

[
  {
    "business_only": false,
    "cost_excl_tax": null,
    "currency": "EUR",
    "home_only": false,
    "id": 21,
    "level": "EXPRESS",
    "max_delivery_date": "2018-02-01",
    "max_dispatch_date": "2018-01-28",
    "min_delivery_date": "2018-01-29",
    "min_dispatch_date": "2018-01-25",
    "postbox_ok": false,
    "shipping_buffer": 0,
    "total_days_max": 8,
    "total_days_min": 6,
    "traceable": true,
    "transit_time": 4
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.