Retail BrandsAPI v1.7OpenAPIretailbrands.global

Versioning

This documentation describes version 1.7 of the API.

The major version is in the URL (/v1) and changes only for breaking changes, with advance notice. Inside a major version we add things but do not remove or rename them, so an integration written today keeps working.

What counts as non-breaking

New endpoints, new optional parameters, new fields in a response, new values in an enumeration documented as open, and new data points in the catalogue. Write your client to ignore fields it does not know.

Pinning a version

Send RB-Version: 1.7 to pin the behaviour of a request to this version. Without it you get the current version. Every response carries the version that served it in the RB-Version header.

GET /v1/brands/zara
RB-Version: 1.7

See the changelog for what changed in each version.