v1.
What can change without a new version
Insidev1, we can:
- Add a new endpoint.
- Add a new field to a response. Don’t fail on a field you don’t recognize — new fields will appear over time as this API grows past inventory.
- Add a new, optional request parameter.
-
Add a new error
codefor a situation that previously didn’t have one. - Start refusing a value that could never have worked, for example a barcode with a wrong GS1 check digit. We announce it in the changelog before or together with the release, and say which field and which value changed. Values you already stored are never altered or hidden by this.
Stricter checks on values that never worked
A stricter check applies only when the old value was always invalid, so nothing a working integration sent is refused. It is an addition to whatv1 validates, not a change in what a field means. If a check could refuse a value that used to work, it is a breaking change and gets a new version.
What would require a new version
Removing a field, renaming a field, changing what a field means, removing an endpoint, or changing what acode means would all be breaking changes. None of that happens inside v1 without a new version appearing in the URL first, and advance notice before the old version stops answering.
This is early access
This API is new, and covers inventory, connections, and network search today (see the overview for the full current picture). Expect it to grow — new resources, new permissions, new endpoints — without those additions breaking anything you’ve already built againstv1. If something described on this site ever stops matching what the API actually does, that’s a bug in the docs, not a silent change you’re expected to detect yourself.
A machine-readable OpenAPI 3.1 document mirrors this API’s contract and is what generates parts of this site. It is a working document ahead of the guides above, so it can describe an operation before this site does, or before that operation is actually live — this site is the record of what you can call today; treat anything the document alone claims as not shipped yet.