Back to overview

ATTENTION: API v4 will be switched of on May 1, 2022 > time to migrate!

Placed on:20 December 2021

The API V4 will be switched off on the 1st of May 2022, so it is important to migrate in time. Now is the right time to switch to the API V6. Switching to the V5 is also possible, however, the V5 will exist for a shorter period of time than the V6. Therefore, we advise you to immediately switch to the V6. The API V6 not only offers you new features – you are also immediately ready for the future! We are happy to provide you with more information about this.

What is expected of you now?
You can arrange the migration yourself or have it done with the help of an integration partner. Are you already using 1 of our integration partners? Then you will automatically migrate to API V5 or V6. Please check this with your integration partner to be sure. If you have your own IT team or developer, please arrange the migration according to the below-stated migration guides.

The API V4 will continue to work for a few more months; you have until May 1, 2022 to migrate. Do this in time, so that your processes continue to work properly after this date. Take into account the IT time needed to migrate. Migrating can take up to a few weeks, depending on your integration and IT skills.

Use the following migration guides to make a smooth transition if you arrange the migration yourself:
Migration guide for V4 to V6
Migration guide for V4 to V5

How do I know which API version I’m using?
In the ‘Accept header’ of your API requests, you can see which API version you are using. Is it not possible to see this yourself? Then ask your developer or integration partner which API version you are currently using.

What are the benefits of the Retailer API V6?
The Retailer API V6 contains the following new functionalities:

  • Subscription API for process status and shipment events. For more information see Subscriptions.
  • Image labeling for product content. For more information see image labeling.
  • Transport events for shipments. For more information see monitoring a shipment.

Planning next versions
On this release planning page, you can read more about when an API version becomes available and when a version is removed. Keep a close eye on this planning, so that you know when you need to switch to the next API version.