A new version of the Retailer API has been released on 1st April 2023.
The Retailer API version 9 introduces eminent new features and significant improvements in the API.
New features:
Reporting - Following endpoints continue to remain in Beta and are now available in v10 (Beta) in the Reporting resource of the Advertiser API:
- Request a share of voice report for categories - Offers share of voice report for a campaign on a category level.
- Request a share of voice report for search terms - Offers share of voice report for a campaign on search term level.
- Retrieve a share of voice report by report id - Retrieves a share of voice report based on the report ID.
For more information on the aforementioned endpoints, see the functional documentation.
Shipments - Following endpoints continue to remain in Beta and are now available in v10 (Beta) in the Shipments resource of the Retailer API:
- Get a list of invoice requests - Retrieves a list of all the invoice requests received from customers.
- Upload an invoice for shipment id - Uploads an invoice associated with a shipment.
For more information on the aforementioned endpoints, see the functional documentation.
Insights - Following endpoint continues to remain in Beta and is now available in v10 (Beta) in the Insights resource of the Retailer API:
- Get price star boundaries by EAN - Offers an indication of the price performance levels of your products.
For more information on the aforementioned endpoint, see the functional documentation.
Products - Following endpoints moved out of Beta and are now available in v9 (GA) in the Products resource of the Retailer API:
- Get a list of competing offers by EAN - Provides the competitiveness of the active offers in detail.
- Get product ids by EAN - Provides the bol.com product ID and the EANs associated with the product.
- Get product placement - Provides information about a product’s location and the categories under which it is currently listed.
- Get product list filters - Provides the filter options and categories for a product on the webshop.
- Get product list - Provides insights on the current position of a product within categories or on the search results pages for the specified country.
- Get product assets - Provides information about image assets of a product on the webshop.
- Get product ratings - Provides the ratings for a product on the webshop.
For more information on the aforementioned endpoints, see the functional documentation.
Retailers - Following endpoints moved out of Beta and are now available in v9 (GA) in the Retailers resource of the Retailer API:
- Get retailer information by retailer id - Provides the customer ratings and reviews for a specific retailer within bol.com.
For more information on the aforementioned endpoints, see the functional documentation.
Improvements:
Invoices – Following endpoint includes changes in the response body of the API.
- Get all invoices - The enum value for
invoiceType
field has been renamed fromBOL_RETAIL_MEDIA_GROUP
(BRMG) toADVERTISING_VIA_BOL
(Avb).
For more information on the aforementioned endpoints, see the functional documentation.
For more information about the overview of the changes, see v9 (GA) and v10 (Beta) Release Notes.
Upgrade from v8 to leverage the advantages of the enhanced designs and features in the new v9 API. For more information, see v8-v9 migration guides.