Queue a run for collection

Below is all the information you need to use our API to request a run of bookings be collected from your shop or facility!

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.

NOTES:

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

Method	Endpoint	Notes
POST	https://api.zoom2u.com/api/v1/delivery/sortingfacility/queue

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

Name	Location	Type	Mandatory	Description
SmartSortFacility	Main body	String	Yes	Location of the facility that the pieces are being directed to. - `sydney` is currently the only available option until further notice.
Items	Main body	Object	Yes	Container for consignment and item information
PurchaseOrderNumber	Items	String	Yes	The customer reference number. Usually a PO Number or quote reference number. Can be blank.
PackageDescription	Items	String	No	Short text description of the items or delivery.
PinType	Items	String	No	Some of our customers have the capacity to require an ID check upon delivery, requiring the courier to enter the last 4 digits of a drivers licence or passport (see below) in order for the delivery to be completed. If the numbers match the delivery will be able to be completed, otherwise the driver will return the delivery. Valid options include; - `""` - No ID Check required - `Drivers Licence` - `Passport` - `Blind Citizens Card` Important: If you are unsure, leave this field empty.
Pin	Items	String	No*	If the `PinType` field contains a valid ID, this field must contain the last 4 digits of the requested ID. Notes; - Mandatory when `PinType` is not empty - Alphanumerical is ok - No spaces.
HasAuthorityToLeave	Items	String	No	You, as the sender, are allowing the parcel to be left unattended (in a safe location) if the recipient is not home. - `True` - parcel(s) can be left unattended, only if its safe and only if the recipient is not already home. - `False` - parcels cannot be left unattended regardless. Default if not provided is `False`
AuthorityToLeavePermitted	Items	String	No	Determines whether or not the recipient is allowed to provide an Authority To Leave if they are not available to receive the delivery. Submitting a `True` value only enables this option for the recipient, it does not guarantee that the recipient will use it. - `True` - `False` This is not mutually exclusive or inclusive of the `HasAuthorityToLeave` field above.
Pieces	Items	Object	Yes	Container for the specific piece information. Multiple pieces are allowed to be submitted under the same booking/consignment for the same recipient.
Barcode	Pieces	String	Yes	Barcode attached to the specific item (this needs to be the at the individual item level, not the broad booking/consignment level). `Important:` This will be used to match against the barcode on the physical piece itself.
Reference	Pieces	String	Yes	Individual reference number for the piece. It is not uncommon for this to be a copy of the `barcode`.
Dropoff	Items	Object	Yes	Delivery location details.

The reference table for the Dropoff object can be found on the request a quote or create a booking pages.

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

Name	Type	Description
`batchRef`	String	Receipt number for the successful submission. This will be the primary identifier when troubleshooting logs.
`results`	Object	Object containing tracking and confirmation information.
`reference`	String	A copy of the `PurchaseOrderNumber` as confirmation. This is the persistent customer and recipient facing reference number, and the reference number needed if making any modifications to the booking later.
`price`	String
`tracking-link`	String	URL sent to the customer and the recipient to track the location of the driver and the delivery.
`trackingCode`	String	Unique tracking code.

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

Other issues

HTTP Status Code	Meaning	Description	Troubleshooting
`400`	Bad Request	The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).	- Check the request syntax!
`401`	Unauthorised	The request has not been applied because it lacks valid authentication credentials for the target resource.	- Check the bearer token is valid and has been submitted correctly. - Check the url is correct
`403`	Forbidden	The server understood the request but refuses to authorize it.
`404`	Not found	The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.	- Check the endpoint URL to make sure it is correct.
`415`	Unsupported media Type	The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.	- Check the `Content-Type` field has been correctly assigned - Check the syntax of the body data is correct, and is of the same language as the `Content-Type` tag