Retailer API migration guide v3 to v4

At we are working hard to help our partners grow their business every day. One way how we do that is by innovating on partner tooling functionalities in our seller dashboard, but also in the Retailer API channel. Our latest innovations are that significant that we introduce a new version, Retailer API v4.

New features in version 4

Be advised that that new features are introduced in version 4 only. For details regarding the implementation of this features, please take a look at the (functional) documentation. Implementation of new features is not in scope of this migration guide.

Changed resources

To guide you through the right steps and take important changes into account, you can use this migration guide to migrate from version 3 to version 4. Changes mentioned are compared to the v3 version.

We put a lot of effort in aligning all resources by holding them against a list of pre-defined conventions. Examples of these conventions are:

  • Date or DateTime included in field name, e.g. orderPlacedDateTime;

  • Dates and DateTimes are in ISO 8601 format;

  • Country codes is in ISO 3166-1 format;

  • ENUM values are uppercase;

  • Primary identifiers follow the logic of <object>Id (e.g. orderId, inboundId, shipmentId, etc.).

Besides the pre-defined conventions we have made changes to several resources to align the models and make them more logical.

Table 1. Table of changed resources
Resource Impact


Low (4 changes)


High (29 changes)


Low (2 changes)


Low (5 changes)


Low (2 changes)


Medium (10 changes)


High (52 changes)


Endpoints removed


High (36 changes)


High (47 changes)

Shipping labels

Endpoint removed


No changes