Versioning

What changes in v1, and what never does.

The Storefront API is versioned in its path: /v1/storefront. Within v1:

  • Never removed or renamed: endpoints, fields, and the meaning of a field.
  • May be added: new endpoints, new optional request fields, new fields in responses, new values where a field lists values (a new delivery status).

Write your code to ignore fields it doesn't know and to handle unknown values of a listed field (show a neutral state), and it keeps working as v1 grows.

A change that would break code comes as v2, with v1 kept running alongside it. Every change is in the Changelog.