Integrations & API
The API Management screen is where you connect stores and systems. Orders flow in, shipping prices and labels flow back, and your store is told as each order is labelled, shipped and delivered.
{
"carrier_code": "NZPOST",
"service_code": "CPOLP",
"receiver": { "contact": "A. Smith", "city": "Wellington" },
"packages": [{ "weight": 1.2, "length": 30, "width": 20, "height": 10 }]
}
→ 201 { "shipment_number": "SHP2214", "tracking_number": "00794…", "labels": [ … ] }| Webhook | Event | Result |
|---|---|---|
| 10:02 | labels_created | 200 OK |
| 10:41 | shipped | 200 OK |
| 11:05 | delivered | Retrying |
Illustrations with sample data. Screens are simplified and appear in your own branding.
Connecting
- API Management
One place for your stores, API credentials, webhooks, API logs and documentation.
- Stores
Connect Shopify or any other platform, in test or live mode, each with its own settings.
- Per-store settings
Choose the sender address, when orders are fulfilled and which notifications are sent.
- Secure access
OAuth client credentials, with rate limiting and a log of every request.
The API
- eCommerce API
Create, list and cancel orders; get shipping options; book shipments; fetch labels and tracking; manage packages and addresses.
- Webhooks
Signed status updates (labels created, shipped, delivered, cancelled) sent back to your store.
- Delivery log and retries
Every webhook is logged; failures are retried automatically and can be resent.
- Inventory API
Products, stock and inbound orders.
Optional module - Platform API and single sign-on
Create customer accounts and addresses from another system, and sign users in without a second password.
Set up by your administrator - Documentation
Download the OpenAPI specification and Postman collections.
- Test store
A built-in simulator to test an integration end to end before going live.
Set up by your administrator