Release Notes Retailer API Version 5
Version 5.8 (GA)
| Version | Release Date | Release Type |
|---|---|---|
5.8 |
30-08-2021 |
Minor |
| BREAKING CHANGE |
The error messages that are returned when trying to cancel orders have been improved to be more specific. Before this release, the returned error message would be "Unable to cancel the order item, because part of the order is already handled", which will now be replaced with one of two possible messages:
-
"Unable to cancel the order item, because the order item is already cancelled"
-
"Unable to cancel the order item, because the order item has already been shipped"
This will allow API users to more specifically detect the cause of the failure and properly handle any follow-up actions.
|
For users that have built logic against the previous error message, this is a breaking change. Please update your implementation accordingly. |
Version 5.7 (GA)
| Version | Release Date | Release Type | Breaking Changes |
|---|---|---|---|
5.7 |
01-07-2021 |
Minor |
No |
Invoice VAT code changes
The TaxCategory.ID.value and ClassifiedTaxCategory.ID.value VAT codes for the Invoices endpoint have been modified to align better with the European standard list of codes, which can be found here. This change will start to become visible with the release of v5.7.
-
Previously, code "B" was used incorrectly. "B" codes are in a process of being fully transitioned to "O". If you are still receiving VAT code "B", you should not change your mapping until this transition is complete, but note that code "O" is the correct tax category and will eventually replace all instances of "B". During the transition you will see items as both "B" and "O" given as an output; these have the same meaning.
-
Tax category "G" has been added for non-EU goods.
Additionally the internal classifications of the VAT codes have been refined and allows us to provide better tax reporting.
Version 5.6 (GA)
| Version | Release Date | Release Type | Breaking Changes |
|---|---|---|---|
5.6 |
14-05-2021 |
Minor |
No |
Beta endpoints removed from all but most recent version
In line with the announcement we did earlier, we have removed beta endpoints from any version but the most recent active version. This means that, currently, beta endpoints are only available in the v6 version of the retailer API. Please update your accept and content-type headers if you haven’t already done so. This release introduces no changes to the beta functionality itself.
Going forward, with every release there are three main options for the open betas:
-
Beta endpoints will become GA and will be released with the most recent GA version;
-
Beta endpoints will remain beta, and move to the most recent BETA version. One month after release, beta endpoints will be removed from earlier versions of the API allowing users time to migrate;
-
Beta endpoints will be removed if after analysis the decision is made to no longer support the functionality in its current form.
Version 5.5 (GA)
| Version | Release Date | Release Type | Breaking Changes |
|---|---|---|---|
5.5 |
12-05-2021 |
Minor |
No |
Time frame type delivery method added
The timeFrameType attribute indicates the delivery method as chosen by the customer in the checkout process of the order. It contains amongst other Evening Delivery for Verzenden via bol.com where Evening Parcel shipping label is the only option and you are not able to switch to the mailbox label.
For more information for Verzenden via bol.com specific information, see Verzenden via bolcom and all other orders see Orders and shipments
|
The demo scenario for the updated order endpoints can be found here. |
Version 5.4 (GA)
| Version | Release Date | Release Type | Breaking Changes |
|---|---|---|---|
5.4 |
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.