The API version lives in the URL path. The current version is v1, served under /api/partner/v1.
Every response carries the version header:
Additive-only changes
Within v1 the contract only grows. The following can happen without warning and should not break a well-built integration:
- a new endpoint,
- a new optional field on a response,
- a new optional filter or query parameter,
- a new value in an existing list, for example a new order status,
- a new webhook event type.
Build defensively: ignore fields you do not recognise, and treat status-like values you have not seen before as a safe default rather than failing.
Breaking changes get a new version
Removing or renaming a field, changing a field’s type, tightening validation, or changing the meaning of a value are breaking changes. They appear under a new path, such as /api/partner/v2, not in place.
Changelog discipline
Every new value added to a list, such as statuses, payment states, fulfilment methods, or webhook types, is called out on the Changelog. If your integration matches on those values exhaustively, check the changelog when you upgrade. Last modified on July 1, 2026
