API lifecycle

Versioning

New integrations should use the v2 routes and wrapped request/response objects.

Current version

The current public API version is v2.

/api/v2/address
/api/v2/order
/api/v2/stock
/api/v2/file
/api/v2/assets/image/product/{imageType}/{sku}/{width}

Legacy endpoints

Existing unversioned endpoints under /api/ and legacy asset routes remain available for current integrations, but they are deprecated. They do not use the v2 wrapper contract.

Schemas

Swagger includes request wrappers, response wrappers, and the underlying models used by the public API.

Open Swagger