Queue a booking to the Smart Sort Facility

Below is all the information you need to use our API to send a single booking, or collection of bookings, to one of our Smart Sort Facilities!

Our Smart Sort Facilities allow our customers to send bulk parcels to an aggregate facility for a next day (or even that afternoon!) delivery service.
This aggregate style of delivery allows for the processing of not only bulk volume, but also affords a cheaper per-delivery service through our efficient routing algorithms.

NOTE:

• When creating runs, bookings will be pushed through into a our queue for processing and routing in the next cycle, allowing you to send booking data & ship the freight during the whole day.
  
  Freight will need to be at the sorting facility before processing and routing, which occurs at 5am Monday-Friday.
  This may mean shipping freight and sending the API data at different times.
  
  
• Also note that you, as the customer, are responsible for arranging the delivery of these items to the Smart Sort Facility.This can be done either with our delivery or freight services here, through your own network, or with a third party carrier!
  
  
• You are required to make sure each item being sent has a barcode attached to it. This is to ensure each piece and parcel can be scanned and tracked and delivered correctly.

Request

Endpoint

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.

Example Submission

Body

Example request body:

{
    "SmartSortFacility" : "sydney",
    "Items":[
        {
        "PurchaseOrderNumber": "ABCD1234",
        "PackageDescription": "1 box with some cakes",
        "Pin": "1234",
        "PinType": "Passport",
        "HasAuthorityToLeave": "true",
        "AuthorityToLeavePermitted": "true",
        "Pieces": [
                    {
                        "Reference": "PACK1",
                        "Barcode": "BAR10000012345678"
                    },
                    {
                        "Reference": "PACK2",
                        "Barcode": "BAR10000012345674"
                    }
                ],
                "Dropoff": {
                    "ContactName": "Jane Smith (ACME Co.)",
                    "Email": "test@test.com",
                    "Phone": "0000 0000",
                    "UnitNumber": "",
                    "StreetNumber": "123",
                    "Street": "Miller St",
                    "Suburb": "North Sydney",
                    "State": "NSW",
                    "Postcode": "2060",
                    "Country": "Australia",
                    "Notes": "See reception for more information"
                    }
                }
            ]
}

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 5 strings;

• ContactName

• Phone

• Email

• Notes

• FullAddress

Example (With FullAddress address substitution):

    "Dropoff": {
        "ContactName": "Jane Smith",
        "Email": "test@test.com",
        "Phone": "0000 0000",
        "UnitNumber": "Unit 609",
        "FullAddress": "123 Main St, North Sydney, NSW, 2000",
        "Notes" : ""
    }

Response

{
    "results": [
        {
            "reference": "ABCD1234",
            "price": 0,
            "tracking-link": "https://track.zoom2u.com/NQTPEUJ9C",
            "trackingCode": "NQTPEUJ9C"
        }
    ],
    "batchRef": "20191405041456"
}

Other issues