Changelog
How changes to the two APIs are announced, and what ShopEazy promises will not break.
Everything that changes for a caller of the two public APIs is written down in one changelog: the Storefront API (/v1/store) and the Merchant API (/v1/merchant, Beta). Each entry says which API it is for. Internal changes that alter no behaviour are not listed.
The log follows the Keep a Changelog format, with entries under Added, Changed, Deprecated and Fixed. This page sets out the promise behind it and does not copy the entries.
The promise
- Additive only within v1. Both APIs change only by adding: a new operation, an optional parameter or request field, a new response field, enum value or error code.
- Deprecate before you remove. Anything going away is marked deprecated first, with a sunset date at least 90 days later. It keeps working, unchanged, until then.
- Headers tell you. Every response from a deprecated operation carries
DeprecationandSunsetheaders. Each deprecation is also listed under Deprecated in the changelog. - Breaking changes only in a new version. They ship as
/v2, beside v1.
Read Versioning and deprecation for the details.
What to watch
| Where | Look for |
|---|---|
| Deprecated | A date you need to move before |
| Added | New operations, fields and error codes you may want |
| Changed | A behaviour change. The changelog says when one can break a caller |
Each API has its own contract version, and each client package has the same version as its contract: @shopeazy/storefront-client follows the Storefront API, and @shopeazy/merchant-client follows the Merchant API.
Deprecated now
| What | API | Deprecated | Sunset |
|---|---|---|---|
The old Storefront API paths, before /v1/store | Storefront | With the move to /v1/store | 1 February 2027 |
The pre-paging list fields (products, services, kits, policies, orders, bookings, members, and count) | Storefront | 22 October 2026 | 1 February 2027 |