Getting started

Set up your integration with the Delivereasy APIs.

Welcome to the Delivereasy API documentation. We expose two public APIs:

Lastmile API — our delivery booking solution for scheduling and tracking deliveries.
Marketplace API — for marketplace partners to receive orders, manage menus, and control store status.

Authentication

All API requests require an API key passed in the X-DELIVEREASY-API-KEY header.

curl -H "X-DELIVEREASY-API-KEY: your_api_key_here" \
  https://api.delivereasy.co.nz/api/2025-04-01/lastmile/bookings

To get access to our APIs, you need to be in contact with Delivereasy. We don’t currently offer a self-service API system.

Environments

Each API has two environments:

Environment	Base URL pattern	Purpose
Staging	`https://api.staging.delivereasy.co.nz`	Development and testing with fake data
Production	`https://api.delivereasy.co.nz`	Live data

Your API key works in both environments. Use the staging environment while building your integration, then switch to production when you’re ready to go live.

Versioning

Our APIs are versioned by date. When a new version is released, you can continue using the previous version until you’re ready to upgrade. The version is included in the URL path:

https://api.delivereasy.co.nz/api/2026-01-01/marketplace/orders/abc123
https://api.delivereasy.co.nz/api/2025-04-01/lastmile/bookings

Next steps

Marketplace API

Receive orders, manage menus, and control store status.

Lastmile API

Create and track delivery bookings.

Webhooks

Receive real-time updates about bookings and orders.

Testing

Learn how to test your integration in staging.