Release Notes Retailer API Version 6

Version 6.3 (BETA)

Version Release Date Release Type

6.3

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 6.2 (BETA)

Version Release Date Release Type

6.2

25-08-2021

Minor

The get shipments endpoint has been modified to include information on transport events, to allow monitoring of shipments.

For more information, please have a look at the revised orders and shipments documentation, under the 'monitoring a shipment' section.

The demo scenario for the updated order endpoints can be found here.

Version 6.1 (BETA)

Version Release Date Release Type

6.1

23-08-2021

Minor

The product content API has been revised, a new feature was added to allow API users to provide image assets along with their product content.

For more information, please have a look at the revised product content API documentation, under the 'managing images via the content API' section.

The demo scenario for the updated order endpoints can be found here.

Version 6.0 (BETA)

Version Release Date Release Type

6.0

01-04-2021

Major

Version 6 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 5 when Version 6 becomes GA. For more information see the API lifecycle schedule which can be found here.