Versioning policy
The version is in the path: /v1.
Within v1 we only add:
- New endpoints.
- New optional request fields.
- New response fields.
- New event types.
- New values in fixed lists, such as an order status or a cancel reason.
- New error codes.
So ignore any field, value or type you do not know, and never fail because of one.
Within v1 we never:
- Remove or rename a field.
- Change a field’s type or meaning.
- Make an optional field required.
- Change the signing scheme.
A change that breaks your code ships as /v2. v1 is retired 12 months after v2 is announced. From the day of the announcement, every endpoint that will stop answers with Deprecation and Sunset headers, and Sunset carries the retirement date.
Changes
v1.0 Coming soon
The first release:
- Keys, signing and the sandbox.
- Linking with a code or QR.
- Places and pausing orders.
- CM v1 menus: full publish, patches, state, versions and hashes, nightly reconcile.
- Pickup orders.
- Batched, signed events and the events log.
Next: pricing from your system, products for shops, stock, offers, accounting, delivery.