It's easy to integrate delivery into your ecommerce storefront or expand your on-demand offering! Begin by creating a new application in your account dashboard to retrieve your authentication token that grants access to all API resources as outlined on this document.

See our service coverage map to ensure you are within a supported geographic zone, or start your integration today and launch with us as we expand.

Dispatching a courier will incur usage costs that are applied to your account. To request a detailed delivery quote before dispatching a delivery, use our Delivery Quote API.

Using our HTTP based API, you can make requests to our platform with a variety of languages. All HTTP requests must specify a bearer token in the Authorization header. You'll find your API key in your account dashboard, where you can create and configure your application.

Lists all Deliveries for a particular account.

$ curl https://api.ollo.co/v1/deliveries

[
	{
	  "id": {Delivery.id}",
	  "created": {Delivery.created},
	  ...{Delivery}
	},
	{
	  "id": "{Delivery.id}",
	  "created": "{Delivery.created}",
	  ...{Delivery}
	}
]

Get all known properties for a Delivery.

$ curl https://api.ollo.co/v1/deliveries/{Delivery.id}

{
	"id": "{Delivery.id}",
	"status": "{DeliveryStatus}",
	"origin": "{Delivery.origin}",
	"destination": "{Delivery.destination}",
	"customer_name: "{Customer.name}",
	"customer_phone": "{Customer.phone}",
	"customer_email": "{Customer.email}",
	"created": "{Delivery.created}",
	"updated": "{Delivery.updated}",
	"price": "{Delivery.price}",
	"pickup_eta": "{Delivery.pickup_eta}",
	"dropoff_eta": "{Delivery.dropoff_eta}",
	"estimated_duration": "{Delivery.estimated_duration}"
}

Get a detailed delivery quote including estimated cost, pickup time, and arrival time, before dispatching a courier . If your integration sends our API multiple requests with matching parameters, note that we may return cached responses for up to 5 minutes.

$ curl -X POST https://api.ollo.co/v1/deliveries/quote

{
	"origin": "{Delivery.origin}",
	"destination": "{Delivery.destination}",
	"express": "{Delivery.express}",
	"when": "{Delivery.when}"
}

{
	"id": "{Delivery.quote_id}",
	"price": "{Delivery.price}"
}

Create a new delivery with the parcel origin and destination addresses.

Ensure the specified origin and destination are within a supported service zone, otherwise a 403 Forbidden status is returned. When issuing a Delivery Quote request these parameters will be validated with a successful 2xx status.

Optionally, a quote_id can be provided within 1 hour of its creation. Providing an expired quote_id will result in a 400 Bad Request response. A valid quote_id is required to make a "express" delivery request.

$ curl -X POST https://api.ollo.co/v1/deliveries

{
	"quote_id": "{Delivery.quote_id}",
	"origin": "{Delivery.pickup}",
	"destination": "{Delivery.destination}",
	"customer_email": "{Delivery.customer_email}"
}

{
	"id": "{Delivery.id}",
	"created": "{Delivery.created}",
	"price": "{Delivery.price}",
	"pickup_eta": "{Delivery.pickup_eta}",
	"dropoff_eta": "{Delivery.dropoff_eta}",
	"estimated_duration": "{Delivery.estimated_duration}"
}

These are type definitions of objects for our API calls, events, and webhooks

By integrating webhooks, your application can listen for our platform events to trigger additional reactions in real-time, such as communicating with a customer or updating internal records.

Webhook endpoints are configured in your application settings per environment. Although this is a current list of all the events we send, be advised we may add more events at any time, so you should not assume that only these types exist.