Retailer API migration guide from V4 to V5

Version 5 of the Retailer API introduces some significant improvements to’s partner developer tools. We recommend upgrading from V4 to take advantage of the enhanced designs and features in the new API.

The API lifecycle schedule can be found here. Please ensure that you migrate from V4 before it is removed on 04 April 2021.

New features in v5

New features in v5 are not documented in the migration guide. For details regarding the implementation of these features, refer to the release notes and related documentation.

  • Search terms: see the items that customers are searching for.

  • Get orders with all statuses: track all orders from the last 48 hours, even if they have been shipped or cancelled.

  • Replenishments API: the Inbounds API is now the Replenishments API, and includes the ability to use’s first mile replenishments.

Changed resources from v4

To guide you through the right steps and take important changes into account, you can use this migration guide to migrate from V4 to v5. Any changes in this guide are compared to V4.

  • We changed IDs from integers to strings throughout V5 of the Retailer API. In the case of the Process status, the process-status-id is now a string. This will affect every endpoint that uses the processStatusId - often called id - in its response message. See the migration guides for more information. If you have this field stored, you should update it.

  • All BETA features, including the Unpublished Offers Report and the Subscriptions API, will be moved to V6 on 1 April, and removed from earlier versions on 1 May. You should migrate your endpoints if you are still using these features.

Table 1. Table of changed resources
Resource Impact


No changes

Replenishments (formerly Inbounds)

Resource has been replaced


Medium (8 changes)


No changes


Low (2 changes)


Low (7 changes)


Medium (11 changes)

Product content

Low (1 change)

Process status

High (5 changes)


Medium (19 changes)


Low (1 change)

Shipping labels

Low (3 changes)


Low: (2 changes)