Versioning
The API lives under /v1. Webhook messages carry "api_version" (today 2026-10-01).
May change at any time, without notice:
- new endpoints, new optional request fields, new response fields;
- new event types (endpoints only receive the types they subscribed to);
- new error
codes for new situations, new values of fields documented as open lists (for example a new shipment status); - the order of fields in JSON, the length of ids and tokens.
Build your integration to ignore fields it does not know and to read code for errors.
Never changes within /v1 and an api_version:
- the meaning or type of an existing field, removing a field, making an optional field required;
- the signature scheme (Standard Webhooks
v1).
Breaking changes come as a new version (/v2, a new api_version) announced at least
6 months before the old one stops, by email to the owners of every company with active
tokens or endpoints, and in the changelog.