Quote API
The Quote API returns a quote when given a destination location and parcel attributes.
Retrieve quote
POST /quotes
Submits a request for quotes from different carriers.
At minimum, a quote requires a delivery location, and dimensions of the parcels being delivered. However, different carriers and delivery methods can require additional fields to satisfy their requirements. There is a maximum of 1000 parcels per quote request.
By default, Shippit returns a quote from the fastest or cheapest carrier. However, for the purposes of showing different options, such as in a carrier selection page, you can choose to have Shippit display all quotes. To do this, pass the return_all_quotes
field as true
.
The quotes returned are filtered based on the requirements given by different carriers. Depending on the information submitted in the order, and the carrier settings in the Shippit admin page, you might not see quotes from all configured carriers.
To perform this operation, you must be authenticated with an authentication token.
Body
{
"quote": {
"dropoff_postcode": "2000",
"dropoff_state": "NSW",
"dropoff_suburb": "Sydney",
"parcel_attributes": [
{
"qty": 1,
"weight": 1
}
]
}
}