Release Notes Retailer API Version 4

Version 4.3 (GA)

Version Release Date Release Type

4.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 4.2 (GA)

Version Release Date Release Type Breaking Changes

4.2

23-12-2020

Minor

No

Meets customer expectation attribute on get delivery options

A new attribute meetsCustomerExpectation has been added to the get delivery options endpoint.

This meetsCustomerExpectation attribute indicates if you can use this label without it having a negative consequence on your performance score.

Demo scenario for get delivery options here.

Version 4.1 (GA)

Version Release Date Release Type Breaking Changes

4.1

15-11-2020

Minor

No

Customer language attribute on get order and get shipment

A new attribute language has been added to the get order and get shipment endpoint.

This language attribute of the customer can be used in case of contact.

Demo scenario for get single order here.

Demo scenario for get single shipment here.

Version 4.0 (GA)

Version Release Date Release Type Breaking Changes

4.0

01-10-2020

Major

Yes

BREAKING CHANGES

Version 4 of the Retailer API contains new functionality and various API changes/optimizations for better consistency, naming, and usability. Please migrate to this version as soon as possible, as version 3 of the retailer API will be phased out on 1 October 2021. You can also wait for Retailer API v5 which will be released on 1 April 2021. The API lifecycle schedule can be found here.

For more details regarding the changes see here, but in short:

  • New Product Content API

  • New Shipping label flow API

  • New Insights API

  • New Pricing API (Beta)

  • New Subscription API (Beta)

  • More consistent Order API

  • Improved Process status API for bulk requests

  • Improved Return API

  • Removed Reductions API

Detailed information to help users upgrade to V4 of the Retailer API is available in the migration guide.