Skip to main content

Storefront API changelog

Every change to the published Storefront API is listed here, newest first. Breaking changes are announced here before they ship — see Versioning for the notice period.

To be told rather than to check: a breaking change is emailed to the merchants whose storefront calls the affected endpoint, at the contact address on their Shopify account. If you are the developer and not the account holder, ask the merchant to forward those, or watch this page — its address is stable and the version at the top always matches info.version in the specification.

1.0.0​

First published version. These endpoints were already serving the app's own theme blocks; they are now documented and covered by a contract test, so they can no longer change without notice.

No request or response field changed. POST /leave and POST /birthday now return a declared object instead of an untyped one — the same keys with the same values, so nothing to change on your side.

  • GET /member — points balance, pending points and the customer's coupons
  • GET /config — branding, earning rules and the reward catalogue
  • GET /activities — the member's points history
  • POST /register — join the programme
  • POST /redeem — exchange points for a reward
  • POST /birthday — set the member's birthday
  • POST /leave — end the membership