Changelog

What changed, and what never will.

The compatibility promise: from general availability onwards, changes to this API are additive. We add endpoints, we add fields, we add optional parameters. We do not rename or remove published fields, change types, or repurpose existing parameters. If a breaking change ever becomes unavoidable, it ships as a new endpoint next to the old one, and the old one keeps working. That day arrived on 2026-09-19 with v1.0.0, so the promise is in force from the entry directly below. The rows under it are the pre-release run-up, kept as the record of how this API got here.

2026-09-19

v1.0.0 — general availability. This is the first released version of the Storekeeper API, and the compatibility promise above binds from today: the 25 published operations, their 64 response models, and every field name, path segment and operationId in the OpenAPI document are frozen, and the document itself now says "version": "1.0.0". A breaking change from here ships as a new operation next to the old one and the old one keeps working — it does not ship in place, and no entry on this page is ever edited again. Twenty rows dated 2026-09-16 to 2026-09-18 are replaced by this one. They announced the run-up to this release: resource names in paths went singular (/api/orders became /api/order, and fifteen more), a country became country_code and a language language_code, errors became RFC 9457 problem documents served as application/problem+json, /api narrowed to access tokens minted from a Storekeeper API key and began enforcing a per-key rate limit, the signed-in pages moved under /admin, query parameters and write bodies started refusing a value they cannot read instead of guessing at it, and the documentation moved off /api to /docs. None of those rows described a released version, because there was not one — they described this one, which is why they collapse into it rather than standing as history. If you built against a pre-release build, that list is what to check. The nine SDKs on /sdks are regenerated from the 1.0.0 document.

Changelog

Wat er veranderde, en wat nooit verandert.

De compatibiliteitsbelofte: vanaf general availability zijn wijzigingen aan deze API additief. We voegen endpoints toe, we voegen velden toe, we voegen optionele parameters toe. We hernoemen of verwijderen geen gepubliceerde velden, veranderen geen types en hergebruiken geen bestaande parameters. Mocht een brekende wijziging ooit onvermijdelijk zijn, dan verschijnt die als nieuw endpoint naast het oude, en blijft het oude werken. Die dag kwam op 2026-09-19 met v1.0.0, dus de belofte geldt vanaf de melding hier direct onder. Wat daaronder staat is de aanloop naar deze release, bewaard als verslag van hoe deze API hier gekomen is.

2026-09-19

v1.0.0 — general availability. Dit is de eerste uitgebrachte versie van de Storekeeper API, en de compatibiliteitsbelofte hierboven geldt vanaf vandaag: de 25 gepubliceerde operaties, hun 64 responsmodellen en elke veldnaam, padnaam en operationId in het OpenAPI-document liggen vast, en het document zelf zegt nu "version": "1.0.0". Een brekende wijziging verschijnt vanaf nu als een nieuwe operatie naast de oude en de oude blijft werken — ze wordt niet ter plekke vervangen, en geen enkele melding op deze pagina wordt ooit nog bewerkt. Twintig meldingen van 2026-09-16 tot en met 2026-09-18 zijn door deze ene vervangen. Zij kondigden de aanloop naar deze release aan: resourcenamen in paden werden enkelvoud (/api/orders werd /api/order, en vijftien andere), een land werd country_code en een taal language_code, fouten werden RFC 9457-problem documents onder application/problem+json, /api accepteert alleen nog access tokens die uit een Storekeeper API-sleutel zijn gemunt en handhaaft een limiet per sleutel, de ingelogde pagina's verhuisden naar /admin, queryparameters en schrijfacties weigeren sindsdien een waarde die ze niet kunnen lezen in plaats van ernaar te gissen, en de documentatie verhuisde van /api naar /docs. Geen van die meldingen beschreef een uitgebrachte versie, want die was er niet — ze beschreven deze, en daarom gaan ze erin op in plaats van als geschiedenis te blijven staan. Heb je tegen een pre-release build gebouwd, dan is dat lijstje wat je moet nalopen. De negen SDK's op /sdks worden opnieuw gegenereerd uit het 1.0.0-document.