API lifecycle

This topic describes the release planning and application lifecycle for the bol Marketing Catalog API. In order to provide our users with a stable platform we offer predictable releases, clear deprecation periods, and a clear and well-communicated roadmap.

Versioning policy

The Marketing Catalog API applies semantic versioning for its versioning scheme.

This means that given a version number MAJOR.MINOR.PATCH, we increment the:

  • MAJOR version for incompatible API changes,

  • MINOR version when adding functionality in a backwards-compatible manner, and

  • PATCH version when making backwards-compatible bug fixes.

When adding new features to the API, we will always try to do so in a backward-compatible manner. When we really need to make a breaking change, we will release a new major version which could require work for you to adapt to the new API version.

We make the following commitments on major releases:

  • A major version will exist for at least 18 months (except for the beta releases).

  • When a new major version is released, the previous major version will be supported for 6 months.

Major releases planning

API version Release Deprecation End-of-life

Beta (v0)

15 November 2023

1 January 2024

1 February 2024

v1

1 January 2024

-

> 1 July 2025

v2

-

-

-

Changelog

version Release Changelog

1.3.0

15 March 2024

Added endpoint to return the variants of a certain product.

Added endpoint to return the recommendations for a certain product.

See API documentation for more information.

Added allRelevantCategories and allRelevantRefinements fields to the response of the /products/lists/popular endpoint. These fields will be set when the include-relevant-categories resp. include-relevant-refinements query parameter is set to true.

1.2.0

1 March 2024

Added endpoint to convert a bol product ID to the corresponding EAN. See API documentation for more information.

Added documentation for the concepts GCP, Category and return codes for offers.

1.1.0

15 February 2024

Added strikethrough prices in all responses where a price is returned. Field: offer.strikethroughPrice

1.0.0

1 January 2024

Initial release