API Features

Sample API calls with a step by step guide

You can use our API "Recipes" to see sample API calls. This allows you to test your integration, and compare any API calls you are using to the sample payload.

Sandbox with simulated couriers

We have a fully functional sandbox environment that you can use for testing. This includes a simulated courier endpoint which allows you to test the API responses at each stage of your delivery.

Get a quote

Our API allows you to get a quote before booking a delivery. This quote allows you see the exact price of the job before confirm your delivery.

Single Drop Deliveries

Our API supports Single deliveries (a delivery with a single pickup and single delivery location). You can specify the earliest time your goods will be ready for pickup, or have a pickup window (i.e. pickup between these times). You can do the same for deliveries, with deadline to deliver before, or a delivery window. If you would like pricing for pickup and delivery windows please contact our sales team.

Multi Drop Deliveries - fixed or flexible

Our API also supports Multi drop deliveries (a delivery with a single pickup, and multiple delivery locations). We offer all of the same timing options as the single drop deliveries. We can optimise your multi drop delivery sequence and make it as efficient as possible, or if you mark your sequence as fixed, we will follow the order you specify.

Instant or scheduled collections

You are able to book deliveries for pickup right now, or schedule them for the future. The only limitation is that the pickup and the delivery must be on the same day.

Range of Vehicle Types

We offer a range of vehicle types including: Bicycles, Cargobikes, Motorbikes, Cars, Small Vans, and Large Vans. Our system will automatically choose the correct vehicle type depending on the size and weight of the goods being delivered. If you want to choose a specific vehicle (e.g. you would prefer a car over a motorbike) then you can specify the vehicle. The only requirement is that the vehicle is big enough to carry the goods being delivered.

Support for Fragile goods

If the goods you are sending are fragile, you can mark this in the API booking. This will ensure the courier and Customer Support teams are aware that the goods need special care. We also have a "Do not Rotate" flag that can be used where goods must be transported upright. Please also mark this clearly on the outside of the parcels.

Support for Age Restricted Goods

If you are shipping Age Restricted Goods then you can mark this in the API booking. This will ensure that the courier carries out an Age Check at delivery. If the recipient is younger than the age you have specified, or cannot provide ID showing their age then the goods will be returned.

Support for multiple parcels

Our API allows you to list every parcel you are sending including a description. This ensures that the courier is able to check that everything is picked up, and delivered correctly.

Support for PIN authentication

If you are delivering goods of very high value, or controlled substances we support a PIN authentication. The recipient is sent a unique numeric code by SMS, and email. The courier must enter the code at delivery before handing over the goods. If the recipient cannot produce the code then the goods will be returned.

Support for what3words

If the delivery location is difficult to find, or the entrance is not obvious you can add a what3words reference to your booking. This will be used as the couriers delivery location. You can also add text based descriptions to help your courier find the correct location.

Support for printed parcel labels

If you are shipping large quantities of parcels and use a label printer then you can use the API to request a shipping label for each parcel. This will contain all of the information that the courier needs.

Ability to add leave safe instructions

If you would like the courier to leave the goods in a specified safe place you can add these instructions to your booking.

Ability to request photographic proof of pickup and delivery

You can specify whether you would like a photo at pickup, and/ or a photo, signature, or both at delivery.

Ability to follow the live status of the job including location, delivery status via webhooks

Once you have booked a job, you can see the live status of the job, and track the live location of the courier via webhooks. This includes the couriers live ETAs.