Retailer API versioning strategy and reminder: migrate to v10 on time

As previously announced, we have worked on a new way to release new Retailer API functionalities and to phase out old functionalities. This new 'versioning strategy' means you only have to update your API integration if something actually has changed.

Retailer API v10, released on October 1, 2023, was the start of this new versioning strategy. The new strategy has the great advantage that you do not have to make any adjustments to your integration in the future if nothing changes for you. In addition, we can now release new functionality more often than before.

Instead of introducing a new version for the entire Retailer API every six months, the versioning will now take place at a lower level: on resource level. This makes maintaining your API integration easier. For example, the resource 'Orders' could remain at v10, while 'Offers' moves to v11.

A resource only moves to a new version when:

• There is a breaking change on an endpoint within a resource
• An endpoint within a resource is removed completely

The old version of the resource will then be supported for at least another year.

Deadline migration to Retailer API v10

As announced, from November 1, 2024, we will only support Retailer API v10. Older Retailer API versions will be permanently removed on this date. If you want to continue using the Retailer API, please migrate to v10 before this date.

To help you migrate to v10, the migration guides below have been created:

• Migration guide Retailer API v7 to v8
• Migration guide Retailer API v8 to v9
• Migration guide Retailer API v9 to v10

If you have any questions about the migration to v10, you can contact us at retailer-api-migration@bol.com.