This endpoint allows companies to book multiple deliveries to be delivered as run when picked up from a central collection point. ie retail store or warehouse.

This workflow usually involves passing booking information throughout the day, which is then collectively routed and delivered in one go.
Bookings carried out in this way need to be pre-arranged with our team so that warehouse information can be saved, and drivers arranged.
Please reach out to [email protected] for assistance configuring this, or [email protected] if you need assistance setting up your account initially.

REQUEST

Endpoint

MethodEndpointNotes
POSThttps://api.zoom2u.com/api/v1/queue

 

Request Headers

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

 

Body

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

  • High level information about the consignment
  • A list of individual pieces, including their barcodes
  • Drop off information.
  • A freeform ‘additionalData’ field that will be returned in webhook responses (can be used for returning your own identifiers or custom information)
  • A test flag, to be used for testing.

Note: Any other information will be ignored by the API and will go uncollected.
The pickup information is defined in the customer account details, and will need to be setup ahead of time by contacting Zoom2u ([email protected])

 

Example

{
    "items": [
    {
      "purchaseOrderNumber": "string",
      "packageDescription": "string",
      "notes": "string",
      "hasAuthorityToLeavePermited": true,
      "pieces": [
        {
          "reference": "string",
          "barCode": "string"
        }
      ],
      "dropOff": {
        "email": "string",
        "suburb": "string",
        "phone": "string",
        "state": "string",
        "street": "string",
        "streetNumber": "string",
        "country": "string",
        "contactName": "string",
        "postcode": "string"
      }
    }
  ],
  "isTest": false
}

 

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",

 

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):

 

{
    "items": [
    {
      "purchaseOrderNumber": "string",
      "packageDescription": "string",
      "notes": "string",
      "hasAuthorityToLeavePermited": true,
      "pieces": [
        {
          "reference": "string",
          "barCode": "string"
        }
      ],
      "dropOff": {
        "email": "string",
        "suburb": "string",
        "phone": "string",
        "contactName": "string",
        "fulladdress": "123 main street, sydney, 2000, NSW, Australia"
      }
    }
  ],
  "isTest": false
}

 

Other issues

HTTP Status CodeMeaningDescriptionTroubleshooting
400Bad RequestThe 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!
401UnauthorisedThe 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
403ForbiddenThe server understood the request but refuses to authorize it.
404Not foundThe 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.
415Unsupported media TypeThe 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