Quote schemas

This section contains the schemas for the Quotes API

Request body schema for quote

Name Type Required Description
dropoff_postcode string true destination postcode for the quote
dropoff_state string false destination state for the quote. Required when dropoff_postcode is unassigned or set to AU
dropoff_suburb string true The dropoff suburb
parcel_attributes Array, see table true An array of parcel specifications to be included in the quote.

Each item can be used to specify the qty, dimensions, and other information about the products to be shipped, and the parcel used to ship it.

At minimum, only the qty and weight fields are required. There is a maximum of 1000 parcels per quote request.
product_attributes Array, see table false An array of product details to be included in the quote
order_date string(date) false delivery date for the order, required for priority orders
return_all_quotes boolean false If set to true, the system returns all quotes instead of cheapest/fastest quote. Defaults to false.
dutiable_amount number false conditional Declared value for customs when shipping international.

Mandatory for International orders.
product_currency string false Three letter ISO 4217 currency code that applies to the products which is used for customs.
dropoff_country_code string false The destination country code for the quote in ISO 3166 Alpha-2 format. If unassigned, defaults to the country code of the merchant’s primary location, or otherwise ‘AU’
dropoff_address string false The dropoff address for the quote. Mandatory for OnDemand orders.
service_levels [string] false An array of service leves to return quotes for. Valid values include:
- standard
- express
- priorty
- on_demand
features [string] false Some carriers provide add-on services or features that you can indicate in the order. These services are identified by a unique string, and are dependent on the carrier. To request these services, add the appropriate string in this field. For example, white_glove, or identity_on_delivery.
pickup_at string false In order to fulfill the delivery commitment made to the customer, the carrier needs to know the pickup and delivery times for the parcel(s). Below, you can find all the fields that the carrier may require. The specific fields that are mandatory depends on the carrier and the requested service.

The start of the pickup window for OnDemand orders in the format YYYY-MM-DDTHH:mm:ss+HH:mm
pickup_deadline_at string false The end of the pickup window for OnDemand orders in the format YYYY-MM-DDTHH:mm:ss+HH:mm
dropoff_at string false The start of the dropoff window for OnDemand orders in the format YYYY-MM-DDTHH:mm:ss+HH:mm
dropoff_deadline_at string false The end of the dropoff window for OnDemand orders in the format YYYY-MM-DDTHH:mm:ss+HH:mm

Request schema for parcel_attributes

Name Type Required Description
package_type string false Set to pallet if the package is a pallet, otherwise leave this field out. You can’t mix pallets with other types of parcels within an order.
weight number false Weight of the parcel in kilos.
depth number false Depth of the parcel in metres
length number false Length of the parcel in metres
width number false Width of the parcel in metres.
label_number string false Parcel number in the carrier system.

This is used when the order is a tracking order, to match the parcel number in a carrier against the parcel recorded in shippit.
qty number false conditional – The number of products specified by the entry.

There is a maximum of 1000 parcels per quote request.

Should not be present if a product_attributes key is present in the request.

If Allocate each item in an order to a separate carton is enabled in Shippit, a separate parcel is generated for each product listed.

Request schema for product_attributes

Name Type Required Description
title string false Title or description of the product
tariff_code string false Tariff or HS code for international orders declarations
quantity integer false The number of products
price number false Unit price of each product line item. Used to calculate duties and taxes

Response schema for quote

Name Type Required Description
courier_type string false The name of the courier or service level giving the quote.
error string false Error response, if any, received from the carrier(s) during quoting.
quotes Array, see table false List of quotes returned for the service level or carrier.
service_level string false The service level associated with this quote or group of quotes.
success boolean false Whether or not this service level was able to obtain a valid quote from the carrier(s).

Response schema for quotes

Name Type Required Description
delivery_date string(date) false Estimated date of delivery for the order
delivery_window string false For priority orders, machine-readable estimated range of times when the delivery could take place.
delivery_window_desc string false For priority orders, human-readable estimated range of times when the delivery could take place.
price number false Amount quoted by the carrier.
courier_type string false optional If returned inside a quote response for a service level (e.g. standard), the carrier returning the quote. May be omitted if a specific carrier was requested.
customs_duty number false Customs duty component for international orders, if applicable. This amount is included in the price if the carrier is configured to return a DDP quote.
import_tax number false Import tax component for international orders, if applicable. This amount is included in the price if the carrier is configured to return a DDP quote.
import_fee number false Import fees component for international orders, if applicable. This amount is included in the price if the carrier is configured to return a DDP quote.
incoterm any false A universal term of trade that defines the responsibility and obligations with the transport of goods. Most commonly used to indicate the responsible party for payment of duties and taxes.
estimated_transit_time string false Estimated amount of time for the quote to arrive.