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://developer.zippex.app/api

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.

Quotes

Get delivery pricing before creating a delivery. Quotes docs

POST/v1/quotes

Create a delivery price quote with pickup + dropoff. Valid for 15 minutes.

Payments

Collect payment before dispatching a live delivery. Payments docs

POST/v1/checkouts

Create the payment your customer completes (items + delivery). Returns a hosted checkout_url that works on web, iOS, and Android — plus client_secret / customer / ephemeral_key / publishable_key for developers who want to render Stripe’s native sheet themselves. Required before creating a live delivery.

Deliveries

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

POST/v1/deliveries

Create a delivery from a quote. Live keys dispatch a driver; test keys simulate.

GET/v1/deliveries

List deliveries scoped to the calling key’s mode. Supports cursor pagination and status filter.

GET/v1/deliveries/{deliveryId}

Retrieve a single delivery with current status and (live mode) driver location.

Roadmap

These endpoints are planned but not yet available on direct API keys. They are documented here so you know what to expect, calling them today will return a 404. Email support@zippex.com if any of these are blocking your integration.

POST/v1/deliveries/{deliveryId}/cancel

Cancel a pending or in-progress delivery.

GET/v1/deliveries/{deliveryId}/proof

Signed URLs for proof-of-delivery photos.

GET/v1/deliveries/{deliveryId}/tracking

Real-time driver location and ETA.

POST/v1/webhooks

GET/v1/webhooks

List 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