Public beta

API Reference

Complete reference for all Zippex Delivery API endpoints.

OpenAPI 3.1 spec

Generate clients, mock servers, or import into Insomnia, Stoplight, or your IDE.

Postman collection

All endpoints with example bodies. Set the {{api_key}} variable and start sending.

Run in Postman

Opens Postman with the Zippex collection imported. Replace the placeholder API key with your own from the dashboard.

Base URL

https://api.zippex.com

All endpoints require authentication via API key unless noted otherwise.

Path parameters use curly-brace notation in this reference, for example /v1/deliveries/{deliveryId}. For a guided implementation walkthrough, start with the Getting Started guide.

Merchants

Create your Zippex account and manage pickup locations. Authentication docs

POST/v1/merchants/register

POST/v1/merchants/locations

Add a pre-configured pickup location.

GET/v1/merchants/locations

List all configured pickup locations.

Quotes

Get delivery pricing before creating a delivery. Quotes docs

POST/v1/quotes

Get a delivery price quote. Valid for 15 minutes.

GET/v1/quotes/{quoteId}

Retrieve an existing quote by ID.

Deliveries

Create, track, list, and cancel deliveries. Deliveries docs

POST/v1/deliveries

Create a new delivery request.

GET/v1/deliveries

List deliveries with optional filters and pagination.

GET/v1/deliveries/{deliveryId}

Get a single delivery by ID.

POST/v1/deliveries/{deliveryId}/cancel

Cancel a pending or scheduled delivery.

GET/v1/deliveries/{deliveryId}/proof

Get signed URLs for proof-of-delivery photos (1-hour expiry).

Tracking

Real-time driver location and ETA. Tracking docs

GET/v1/deliveries/{deliveryId}/tracking

Get real-time driver location and ETA.

Webhooks

Receive real-time status updates via HTTP callbacks. Webhooks docs

POST/v1/webhooks

GET/v1/webhooks

List all registered webhooks.

DELETE/v1/webhooks/{webhookId}

Remove a webhook endpoint.

HTTP Status Codes

Code	Meaning
200	Success
201	Created
204	Deleted (no content)
400	Bad request — invalid parameters
401	Unauthorized — invalid or missing API key
404	Not found
410	Gone — resource expired (e.g., quote)
429	Rate limit exceeded
500	Internal server error

Webhook Events

Event	Description
delivery.created	Delivery request submitted
delivery.driver_assigned	Driver accepted the delivery
delivery.driver_at_pickup	Driver arrived at pickup location
delivery.in_transit	Package picked up and in transit
delivery.driver_at_dropoff	Driver arrived at the dropoff location
delivery.delivered	Delivery completed
delivery.cancelled	Delivery was cancelled
delivery.failed	Delivery failed