Retailer API Migration Guide
New versioning strategy from Retailer API v10 onwards
As bol, we listen to the feedback of our partners and strive to the best developer experience. Therefore, we changed the way that our API is versioned. The Retailer API v10 was the last time that the entire API was released on a new version. From now on, the versioning is applied on resource level. For more information, please check this post.
It is important to migrate to the Retailer API v10 to enjoy the benefits of the new versioning strategy. This will be the last time that you have to migrate without anything substantial changing in your way of working. Please find below an overview of the most important changes between deprecated versions and the Retailer API v10
Deadline to migrate for v7/v8: May 1st, 2024
Deadline to migrate for v9: November 1st, 2024
Breaking changes between v7,v8,v9 and v10
Process status (v7 users)
| Path | v7 | v10 |
| /shared/process-status | ||
| /retailer/process-status |
Invoices (v7,v8 users)
| Change | v7,v8 | v10 |
| Renamed enum value for the invoiceType field | BOL_RETAIL_MEDIA_GROUP (BRMG) | ADVERTISING_VIA_BOL (Avb) |
Shipping orders (v7,v8,v9 users)
| Change | v7,v8,v9 | v10 |
| Endpoint to ship an order item | PUT - /retailer/orders/shipment | POST - /retailer/shipments |
| Possibility to ship multiple items in 1 request | ||
| Possbility to create multiple shipments for 1 order item |
Price star boundaries (v7,v8,v9 users)
| Change | v7,v8,v9 | v10 |
| Path | /retailer/insights/{ean}/price-star-boundaries | /retailer/products/{ean}/price-star-boundaries |
Accepted headers (v7,v8,v9 users)
Accept and/or content-type headers should be changed from application/vnd.retailer.v7/v8/v9+(format) to application/vnd.retailer.v10+(format)