API overview
Trackbay has a public integration API for customer systems (ERP, WMS), authenticated with an API key in the X-API-Key header. Keys are created by a TenantAdmin (see API keys).
- Field app (Test environment): https://test-trackbay.grafokett.se
- Interactive documentation with "try it": https://trackbay-api-staging.onrender.com/api/public/docs
Public endpoints
| Method | Path | Roles | Description |
|---|---|---|---|
GET | /api/public/v1/deliveries/{id} | API key | A single delivery with its full tracking history. 404 if it does not exist or belongs to a different tenant (indistinguishable by design). |
PATCH | /api/public/v1/deliveries/{id}/status | API key | Updates a delivery's status. 400 on an invalid transition, 404 if the delivery doesn't exist/belongs to another tenant. |
GET | /api/public/v1/orders | API key | Lists every order for the key's tenant, newest first. Product lines are omitted here - fetch a single order for those. |
POST | /api/public/v1/orders | API key | Creates an order for the key's tenant. 409 if the order number is already used within that tenant. |
GET | /api/public/v1/orders/{id} | API key | A single order, including its product lines with picked/remaining quantities. 404 if it does not exist or belongs to a different tenant (indistinguishable by design). |
PATCH | /api/public/v1/orders/{id}/status | API key | Updates an order's status. 400 on an invalid transition, 404 if the order doesn't exist/belongs to another tenant, 409 if the order is currently blocked or archived. |
GET | /api/public/v1/orders/{orderId}/delivery | API key | The delivery for a given order (orders and deliveries are 1:1). 404 if the order has no delivery, doesn't exist, or belongs to a different tenant (all indistinguishable by design). |
Generated table
The table is produced by yarn generate from the API's OpenAPI specification. Do not edit it by hand.