CratedFeature
API-first by design
Everything in the admin panel is also available programmatically. One REST API for shipment creation, status transitions, label retrieval, analytics, and webhook management. OpenAPI spec included.
Example request
POST /api/shipments/{spaceId}/shipments Authorization: Bearer {token} Content-Type: application/json { "providerId": "inpost-b2b", "recipient": { "name": "Anna Kowalska", "phone": "+48600000000" }, "parcels": [{ "weight": 2.5, "dimensions": {"length": 30, "width": 20, "height": 15} }], "data": { "orderId": "ORD-2026-001", "channel": "shopware" } }
Shipment APIs
POST /shipments — create a shipment via any configured provider
GET /shipments — list with filtering, sorting, pagination
GET /shipments/:id — full shipment with events and status entries
POST /shipments/:id/complete — transition to Completed
POST /shipments/:id/return — transition to Returned
POST /shipments/:id/cancel — transition to Cancelled
GET /shipments/:id/label — fetch the carrier label as PDF
GET /shipments/:id/tracking — get the carrier tracking page URL
Provider config APIs
GET /provider-configs — list all configs in a space
POST /provider-configs — create a new provider config
GET /provider-configs/:id — get config details
PUT /provider-configs/:id — update credentials, templates, defaults
DELETE /provider-configs/:id — remove a config
Webhook APIs
GET /webhooks — list all webhooks in a space
POST /webhooks — create a new webhook endpoint
GET /webhooks/:id — get webhook details
PUT /webhooks/:id — update URL, method, keys, active state
GET /webhooks/:id/events — list delivery events for a webhook
Analytics APIs
GET /analytics/shipments — volume, terminal status, time-in-status
GET /analytics/providers — delivery time per carrier
Query params: from, to, granularity (day | week | month)
Authentication
Session tokens issued by the Kratos identity server. Space-scoped access — each token is tied to a specific space. Suitable for connecting warehouses, storefronts, ERPs, and internal tools with isolated credentials per integration.
OpenAPI spec
Full OpenAPI 3 specification ships with the platform. Import into Postman, Insomnia, or any OpenAPI-compatible client. Generate typed SDKs for your language of choice.