Release Notes Retailer API Version 5

Version 5.4 (GA)

Version Release Date Release Type Breaking Changes

5.0

01-04-2021

Major

Yes

BREAKING CHANGES

Version 5 of the Retailer API contains new functionality and various API changes/optimizations for better consistency, naming, and usability. Please migrate to this version as soon as possible, as version 4 of the retailer API will be phased out. The API lifecycle schedule can be found here.

In short, changes have been made to make the Retailer API more consistent and stable and new and improved features like:

  • New Replenishments API (formerly known as Inbounds API)

  • New Search Terms API

  • Improved visibility of order data

Detailed information to help users upgrade to the V5 of the Retailer API is available in the

Version 5.3 (BETA)

Version Release Date Release Type Breaking Changes

5.3

24-02-2021

Minor

No

Replenishments API improvements

An updated version of the Replenishments API (previously known as “Inbounds”) has been added to the V5 Beta.The API design has been significantly improved, and we have added the ability to use first mile replenishments, which Is a service provided by bol.com where you can arrange for us to collect your goods from any convenient location and ship them to the bol.com fulfilment center.

For more information, see Replenishments with Fulfilment by bol.com.

The demo scenario for the new replenishments endpoints can be found here.

Version 5.2 (BETA)

Version Release Date Release Type Breaking Changes

5.2

11-02-2021

Minor

No

Order API updates

An updated implementation of the get orders list and the get single order have been released in beta. Please read the documentation carefully to find out what has changed. This update addresses some of the issues with reduced visibility of orders that are part of fulfilment by bol.com.

For more information, see Orders and shipments.

The demo scenario for the updated order endpoints can be found here.

Version 5.1 (BETA)

Version Release Date Release Type Breaking Changes

5.1

02-12-2020

Minor

No

Search terms API

The Search terms API retrieves the search volume for a specified search term and period. The search volume allows you to see what bol.com customers are searching for. Based on the search volume per search term, you can optimize your product content or spot opportunities for extending your assortment or analyzing trends for inventory management.

For more information, see Search terms.

The demo scenario for search terms can be found here.

Version 5.0 (BETA)

Version Release Date Release Type

5.0

02-12-2020

Major

Version 5 of the Retailer API contains new functionality and various API changes/optimizations for better consistency, naming, and usability. Unchanged endpoints will be migrated from Version 4 when Version 5 becomes GA. For more information see the API lifecycle schedule which can be found here.