Release Notes bol Retailer API Version 9

Version 9.13

Version Release Date Release Type

9.13

18-12-2023

Minor
New fields introduced

New features

Version 8, 9 and 10 of the API introduces the following updates:

Retailer API

The following endpoints have a new field, enabled, which indicates whether a notification subscription is enabled or not. You are able to enable or disable subscriptions yourself.

Your subscriptions might now be disabled automatically in certain scenarios. For more information on why your subscription might be disabled automatically, please see the Subscriptions documentation.

Version 9.12

Version Release Date Release Type

9.12

02-08-2023

Minor

Improvements to Get a list of competing offers by EAN endpoint of the Retailer API

This release contains changes to the maxDeliveryDate field of the Get a list of competing offers by EAN endpoint.

This mandatory field indicates the latest date by which a package can be delivered to the customer. However, there are instances when this date remains unavailable, particularly when bol.bom offers a product as a pre-order. In such cases, to ensure a comprehensive view of all competing offers, the dummy date 2077-05-04 will be used as a placeholder for all bol pre-order offers that do not have a maxDeliveryDate available. This allows the inclusion of pre-order offers in the complete set of competing offers.

The placeholder date is a dummy date and should not be confused with the actual delivery date.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get a list of competing offers can be found here.

Version 9.11

Version Release Date Release Type

9.11

04-07-2023

Minor
BREAKING CHANGES

OpenAPI Specification upgrades and Advertising API naming consistency

This release contains the following changes:

Version 9.10 (GA)

Version Release Date Release Type

9.10 (GA)

30-03-2023

Major
BREAKING CHANGES

New features and improvements

Version 9 (GA) of the Retailer API introduces the following new resources offering useful endpoints:

In addition to the new features, v9 of the retailer API also offers the following improvements:

  • Invoices - Includes changes in the response of the Get all invoices endpoint of the Invoices API.

    The value for the invoiceType field has been changed to the following:

    Version Old Enum Value New Enum Value

    v9 [GA] onwards

    BOL_RETAIL_MEDIA_GROUP (BRMG)

    ADVERTISING_VIA_BOL (Avb)

    For more information, see the functional documentation and the Redoc.

  • It is recommended to upgrade to version 9 quickly, as version 8 of the Retailer API will phase out in accordance to the Release schedule. Detailed information to help you upgrade to a higher version of the API is available in the v8-v9 migration guides.

  • The demo scenarios for the above endpoints are provided below:

Version 9.9 (BETA)

Version Release Date Release Type

9.9

22-03-2023

Minor

Improvements to Get product id by EAN BETA endpoint of the Retailer API

This release contains the following changes to the Get product id by EAN endpoint of the Retailer API:

Type of change

Previous version

Current version

Name

Get product id by EAN

Get product ids by EAN

URL

/retailer/products/{ean}/bol-product-id

/retailer/products/{ean}/product-ids

Response

No changes

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get products id by EAN endpoint can be found here.

Version 9.8 (BETA)

Version Release Date Release Type

9.8

13-03-2023

Minor

New endpoints added to the Retailer API

This release contains the addition of the following new endpoint to the Products resource of the Retailer API:

  • Get product id by EAN

Get product id by EAN

This endpoint enables you to retrieve the bol Product ID and the EANs associated with a product.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get product id by EAN endpoint can be found here.

Version 9.7 (BETA)

Version Release Date Release Type

9.7

01-03-2023

Minor

New endpoints added to the Advertising API

This release contains the addition of the following three new endpoints to the Reporting resource of the Advertising API:

  • Request a share of voice report for search terms

  • Request a share of voice report for categories

  • Retrieve a share of voice report by report id

These endpoints help you create and retrieve the Share of Voice reports that provide insights into the impression share and click share of your campaigns based on category level and on the search term level.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Reporting endpoints can be found here.

Version 9.6 (BETA)

Version Release Date Release Type

9.6

23-02-2023

Minor

New endpoints added to the Products API

This release contains the addition of the following two new endpoints to the Products API:

  • Get product assets

  • Get product ratings

Product assets

This endpoint helps you to retrieve detailed information about image assets of a product on the webshop.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get product assets endpoint can be found here.

Product ratings

This endpoint helps you retrieve the ratings provided by the customers for a product on the webshop.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get product ratings endpoint can be found here.

Improvements to the Retailer information and Product placement endpoints

This release contains changes to the following two endpoints in the Products API:

  • Get product placement

  • Get retailer information by retailer id

Product placement

Subcategories have been added to the categories field in the response. As a result, categories and subcategories are now displayed in a hierarchical format distinctly highlighting the parent and child categories under which a product listed in the webshop.

For more information, see the functional documentation and the Redoc.

Retailer information

The field topRetailer has been added to the response of the Retailer information endpoint. It indicates if a retailer is a top seller or not.

For more information, see the functional documentation and the Redoc.

Version 9.5 (BETA)

Version Release Date Release Type

9.5

07-02-2023

Minor

New endpoints added to the Products API

This release contains the addition of the following two new endpoints to the Products API:

  • Get product list filters

  • Get product list

Product list filters

This endpoint helps you retrieve categories and filter options for a product on the webshop based on the category or search term

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get product list filters endpoint can be found here.

Product list

This endpoint helps you retrieve a list of products based on category, search term, or filters that reflects the current ranking of a product within that list for the specified country on the webshop.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get product list endpoint can be found here.

Version 9.4

Version Release Date Release Type

9.4

23-12-2022

Minor

Improvements in Competing offers endpoint

This release contains the removal the attribute listPrice from the response body of Competing offers endpoint. As a result, the response will no longer contain the information about the initial selling price of the product before a discount was applied. This field was only displayed in the response when a product was on a discounted price (value of price attribute).

For more information on this endpoint, see the functional documentation and the Redoc.

Version 9.3

Version Release Date Release Type

9.3

16-12-2022

Minor

Improved validation for Accept-Language header

This release contains an improvement to the validation of Accept-Language header. Only the following values without any wildcard characters such as asterisks (*) are now acceptable by the Accept-Language header:

  • nl

  • nl-BE

  • fr

  • fr-BE

  • nl-NL

All endpoints will accept different values for their Accept-Language header. Refer to the Redoc to see which exact values are applicable to each of the endpoints.

As a result of this update, you no longer receive a 400 status code error. Instead, now you receive a 406 not acceptable status code containing the aforementioned valid list of languages that are accepted.

Version 9.2 (BETA)

Version Release Date Release Type

9.2

16-12-2022

Minor

New endpoint added to the Products API

This release contains the addition of a new endpoint called Get product placement to the Products API.

Product Placement

This endpoint helps you to retrieve the product category and location of a specific product in the webshop.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get product placement endpoint can be found here.

Version 9.1 (BETA)

Version Release Date Release Type

9.1

24-11-2022

Minor

New resources and endpoints added

This release contains the addition of the following two new APIs to the Retailer API:

New resources New endpoints

Products API

Get a list of competing offers by EAN

Retailers API

Get retailer information by retailer id

Competing offers

This endpoint helps you retrieve all the active offers for a product providing detailed information about the competitiveness of the offers.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get competing offers endpoint can be found here.

Retailers information

This endpoint helps you to retrieve the customer ratings and reviews for a specific retailer.

For more information, see the functional documentation and the Redoc.

The demo scenarios for Get retailer ratings endpoint can be found here.

Version 9.0 (BETA)

Version Release Date Release Type

9.0

01-10-2022

Major

Price star boundaries

This release contains improvements to the Insights API, which includes price star boundaries insights to be able to create more competing offers:

For more information, see the functional documentation and the Redoc.

The demo scenarios for price star boundaries can be found here.