Guides

Get a quote

Compare prices across Shipperfy carrier rates and your own carrier accounts.

A quote returns the services and prices a carrier offers for a parcel. Quotes are requested per carrier connection, so to compare everything available to you, request a quote from each one and combine the results.

All requests need an Authorization: Bearer header. See Access & authentication.

1. List your carriers#

Each carrier on your account is an integration install, and its id goes in the quote URL.

GET /api/v2/IntegrationInstall?category=couriers

Installs with scope set to reseller are Shipperfy carrier rates.
The others are your own carrier accounts.

2. Request a quote#

POST /shipping/quote/<carrierInstallId>

{
  "contentsType": "SALE_OF_GOODS",
  "international": false,
  "senderAddress": {
    "contact": "Main Warehouse",
    "line1": "1 Example St",
    "suburb": "Sydney",
    "state": "NSW",
    "postalCode": "2000",
    "country": "Australia",
    "countryCode": "AU"
  },
  "receiverAddress": {
    "contact": "Jane Smith",
    "line1": "99 Sample Rd",
    "suburb": "Melbourne",
    "state": "VIC",
    "postalCode": "3000",
    "country": "Australia",
    "countryCode": "AU"
  },
  "parcels": [
    { "weight": 800, "length": 30, "width": 20, "height": 10, "packageType": "CTN" }
  ]
}

Weight is in grams and dimensions are in centimetres.
Package types are SAT (satchel), CTN (box), BAG and ENV (envelope).
Contents types are GIFT, SAMPLE, DOCUMENT, SALE_OF_GOODS, RETURN and OTHER.
Set international to true for overseas parcels. International rates are only available with Australia Post eParcel and MyPost Business. See International shipping.

3. Compare the results#

The response is a list of services. Each one has:

Field	Meaning
`plan`, `planId`	The service name and its id. You need the `planId` to create the shipment
`express`	Whether it is an express service
`grossAmount`, `netAmount`, `taxAmount`	Price, with and without tax
`surcharge`, `transitCoverPrice`, `dutiesAmount`	Extras included in the price
`currency`	Currency of the amounts
`etaFrom`, `etaTo`	Estimated delivery window
`pickupDate`, `firstMileType`	When it is collected, and whether it is `pickup` or `drop off`
`features`, `options`	Available features and options, such as tracking or signature on delivery

To cover all your carriers, send the same request to each install and merge the lists. If one carrier fails, the others are still valid.

Next: Create a shipment.