Skip to content
ShopentlyLearn

Versioning and OpenAPI

Build against the explicit /api/v1 contract and the downloadable OpenAPI document.

API version

API version
The URL version identifies the public API contract.
Engine release
The Engine release number in OpenAPI identifies the implementation that exported the document; it is not the resource's expected_version.
Resource version
Treat business resource versions as concurrency values and obtain them from current responses.

OpenAPI

Download OpenAPI
  • Keep the downloaded contract with your integration's tests.
  • Check required fields, allowed enum values and response schemas when updating the integration.