Create a booking

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.
  We will return an error message for any attempted interstate deliveries, however as a developer it is advised that you handle these error messages accordingly.
• Quotes can only be generated for one parcel at a time. For deliveries with multiple parcel types, please use the customer login portal here.
• When creating runs, bookings will be pushed through into a holding table awaiting confirmation, allowing you to post bookings until you are ready to carry out the order.
  Once all consignment data has been sent, contact Zoom2u to confirm submission and have the runs created.
  Please notify Zoom2u up to 24 hours before a run is to be carried out so drivers can be arranged. Do note consignment data does not have to be sent 24 hours prior.

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.

If fields in the request are left blank, Zoom2u will assume a standard box requires a standard 3 hour delivery window, however it is best to provide as much information as possible with every request.

‘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 address MUST includes the following elements;

• Street Number
• Street Name
• Suburb
• Postcode
• State

A booking cannot be completed if it is missing any of the above components.
The unit number or business name should be provided in the FullAddress field if applicable, but is not mandatory if it is not applicable.
Eg.

• This is acceptable:

   "FullAddress": "610 Appleby St, Kensington, 2000, NSW",

• This is not acceptable:

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

• 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",
        "FullAddress": "610 Appleby St, Sydney, 2000, NSW",
        "Notes" : ""
    },
    
    "Dropoff": {
        "ContactName": "Jane Smith",
        "Email": "test@test.com",
        "Phone": "0000 0000",
        "FullAddress": "ACME Co, 123 Main St, North Sydney, NSW, 2000, NSW",
        "Notes" : ""
    }
}

Response

There are 3 possible responses when creating a booking;

• Successful requests will return a booking reference, a price confirmation, and a unique tracking URL.
• 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:

{
    "reference": "Z20180101999999",
    "price": 42.0,
    "tracking-link": "https://track.zoom2u.com/A1B2C3D4E",
    "trackingCode": "A1B2C3D4E"
}

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