Request a quote

Below is all the information you need to use our API to request pricing for a booking across the metro areas of Sydney, Melbourne, Brisbane, Canberra, Adelaide, and Perth.

NOTE:

• Interstate options are currently only available through the customer login portal here.
• Quotes can only be generated for one parcel at a time. For deliveries with multiple parcel types, please use the customer login portal here.

Request

Endpoint

Request Headers

{
  "Authorization" : "Bearer your-token-goes-here",
  "Content-Type"  : "application/json"
}

You will need to retrieve the bearer token by logging into your customer account and navigating to the “My Account” section.
There is a short guide here on how to access that information!

Note: This is a secret key and links to your account. For your own security, please do not share it or expose the key publicly.

Body

The body of a submission needs to include 3 main things;

• Information about the service itself,
• Pickup information,
• Drop off information.

Do note that if you wish you see multiple quote options in the same response, leaving the deliverySpeed entry blank will return an array of all the available options at the same time.
An example will be attached below.

‘Pickup’ and ‘Dropoff’ location object details

Example:

{
    "PurchaseOrderNumber":"ABCD1234",
    "PackageDescription": "1 box with some cakes",
    "ReadyDateTime": "2020-12-24T10:20:00.06Z",
    "VehicleType": "Car",
    "PackageType": "Box",
    
    "Pickup": {
        "ContactName": "John Smith",
        "Email": "test@test.com",
        "Phone": "0000 0000",
        "UnitNumber": "",
        "StreetNumber": "123",
        "Street": "Main St",
        "Suburb": "North Sydney",
        "State": "NSW",
        "Postcode": "2000",
        "Country": "Australia",
        "Notes" : ""
    },
    
    "Dropoff": {
        "ContactName": "Jane Smith",
        "Email": "test@test.com",
        "Phone": "0000 0000",
        "UnitNumber": "ACME Co.",
        "StreetNumber": "123",
        "Street": "Main St",
        "Suburb": "North Sydney",
        "State": "NSW",
        "Postcode": "2000",
        "Country": "Australia",
        "Notes" : ""
    }
}

Alternatively, for your convenience, you can choose to submit a full, concatenated, address instead of the individualised components.
When a full street address is submitted, the FullAddress field MUST include the following elements;

• Street Number
• Street Name
• Suburb
• Postcode

A booking cannot be completed if it is missing any of the above components.
Eg.

• This is acceptable:

   "FullAddress": "123 Main St, North Sydney, 2060, NSW",

• This is not acceptable:

   "FullAddress": "20 Main St, NSW",

The other components of the pickup or drop off location must still be submitted. The submission, in total, would then contain these 6 strings;

• ContactName

• Phone

• Email

• Notes

• FullAddress

Example (With FullAddress address substitution):

{
    "PurchaseOrderNumber":"ABCD1234",
    "PackageDescription": "1 box with some cakes",
    "ReadyDateTime": "2020-12-24T10:20:00.06Z",
    "VehicleType": "Car",
    "PackageType": "Box",
    
    "Pickup": {
        "ContactName": "John Smith",
        "Email": "test@test.com",
        "Phone": "0000 0000",
        "UnitNumber": "ACME Company",
        "FullAddress": "610 Appleby St, Sydney, 2000, NSW",
        "Notes" : ""
    },
    
    "Dropoff": {
        "ContactName": "Jane Smith",
        "Email": "test@test.com",
        "Phone": "0000 0000",
        "UnitNumber": "Unit 609",
        "FullAddress": "123 Main St, North Sydney, NSW, 2000, NSW",
        "Notes" : ""
    }
}

Response

There are 5 possible responses when creating a booking;

• Successful requests will return a confirmation of the delivery speed, a price, and a delivery time SLA.
• If the deliveryspeed has been submitted as VIP, the response will additionally include two additional fields, on top of the regular data returned.
• If the deliveryspeed has been submitted as "", the response will contain a collection of replies, with each deliveryspeed option listed with its associated price and delivery time SLA.
• If mandatory information is missing from the request, the response will indicate which fields need to be filled in.
• If there are issues unrelated to the submitted data

Success

Example of deliveryspeed submitted as Same day or 3 hour:

{
    "deliverySpeed": "Same day",
    "price": 42.0,
    "deliveredBy": "2020-12-24T11:20:00Z",
}

Example of deliveryspeed submitted as VIP:

{
    "deliverySpeed": "VIP",
    "price": 42.0,
    "deliveredBy": "2020-12-24T11:20:00Z",
    "earliestPickupEta": "2020-12-24T11:20:00Z",
    "earliestDropEta": "2020-12-24T11:20:00Z"
}

Example of deliveryspeed submitted as "":

[
    {
        "deliverySpeed": "Same day",
        "price": 68,
        "deliveredBy": "2020-12-25T06:00:00Z"
    },
    {
        "deliverySpeed": "Same day",
        "price": 68,
        "deliveredBy": "2020-12-25T09:30:00Z"
    },
    {
        "deliverySpeed": "3 hour",
        "price": 86,
        "deliveredBy": "2020-12-25T01:00:00Z"
    },
    {
        "deliverySpeed": "VIP",
        "price": 159,
        "deliveredBy": "2020-12-24T11:20:00Z"
    }
]

If information is missing from the request

Example:

{
  "message": "The request is invalid.",
  "modelState": {
    "getQuoteRequest.Pickup.Suburb":   [ "The Suburb field is required." ],
    "getQuoteRequest.Pickup.Postcode": [ "The Postcode field is required." ],
  }
}

Other issues