Back to overview

bol.com Retailer API v10: Live on 29th Sep 2023

Placed on:29 September 2023

A new version of the Retailer API has been released on 29th September 2023.

The Retailer API version 10 introduces eminent new features and significant improvements in the API.

Advertising API

  • The following resources of Advertising API have not been migrated to v10:
    • Ad Groups
    • Assortments
    • Campaigns
    • Keywords
    • Negative Keywords
    • Target Products

For more information on why these resources have not been migrated, see here.

For a comprehensive list of frequently asked questions pertaining to this transition, see here.

  • The Reporting resource remains in Beta and is migrated to v10 of the API.

Retailer API

The following resources of Retailer API offers significant improvements:

Insights and Products

  • The Get price star boundaries by EAN endpoint has moved out of Beta and has been relocated from the Insights resource to the Products resource in v10 of the Retailer API.
  • The Get a list of competing offers by EAN endpoint of the Products resource offers updates to the maxDeliveryDate field in the response. v10 onwards, the maxDeliveryDate field is no longer mandatory, and hence there will be no utilization of the placeholder date.

Orders and Shipments

  • The Ship order item endpoint has been relocated from the Orders resource and has been added as Create a shipment to the Shipments resource.
  • A new quantity field is added to the request body of the Create a shipment endpoint of the Shipments resource and it supports multiple objects in the orderItems array. Consequently, starting from version 10 onwards, it is possible to split an order item into multiple shipments and purchase multiple shipping labels for a single order item.
  • A new enum value, INBOUND_COLLECT has been added to the response body of Get a shipment by shipment id endpoint of the Shipments resource.
  • The Beta endpoints Get a list of invoice requests and Upload an invoice for shipment id have moved out of Beta and are migrated to v10 of the Retailer API.

Shipping Labels

Shared API

For more information on the improvements, see the v10 functional documentation.

For more information about the overview of the changes, see v10 Release Notes.

Upgrade from v9 to leverage the advantages of the enhanced designs and features in the new v10 API. For more information, see v9-v10 migration guides.

Tags