API
Versioning
How the ShopAssist API is versioned, what counts as a breaking change and how deprecations are announced.
The major version is in the path: https://api.shopassist.coec.dk/v1. The current version is v1.
Non-breaking changes
These can happen at any time within v1, so build your client to tolerate them:
- new endpoints and new optional request fields;
- new response fields;
- new enum values, error codes and
details.reasonvalues; - new webhook event types and fields.
Breaking changes
Breaking changes get a new major version (/v2). After /v2 is generally available, /v1 keeps working for at least 12 months, and its responses carry Deprecation and Sunset headers. Changes are announced in the changelog and by email to owners of organizations with active API keys.
Webhooks
Webhook payloads carry "api_version": "v1". See webhooks.
Last updated on