REST API v1
API reference
The documented interface is in developer preview. Hosted test and live API requests are not generally available.
Quotes
Request route and parcel data; select a returned quote ID. Quotes expose only customer price. Sandbox estimates and prices are synthetic, valid for 15 minutes.
Shipments
Create one simulated booking, list your shipments, retrieve current state or request cancellation. POST creation requires an idempotency key. Live funding and carrier booking remain unavailable.
Labels
Download authenticated PDF bytes. The local sandbox returns a void A4 fixture. Thermal format is accepted as a query value but returns label_not_available for sandbox shipments.
Tracking
Read persisted normalized events. UTC instants are preserved across UK daylight-saving time. Duplicate equivalent instants are suppressed; timezone-naive input is not guessed.
Collections
The local endpoint confirms the schedule already attached at booking. It does not modify or cancel collection. Live carrier-specific scheduling needs a separate reviewed adapter.
Orders
Generic imported-order resources exclude marketplace tokens and raw data. The sandbox contains a synthetic Shopify order. Link one order with order_id during creation; duplicate links return a conflict.
Webhooks
Register and list subscriptions in the sandbox; no delivery is sent. Event payloads and signing helpers are available for verification tests. Live dispatch and subscription lifecycle remain launch gaps.