Please note that this documentation describes the beta version of our Retailer API version 3. This page is intended only for use by the partners participating in our beta testing program.
Endpoints can still be subject to change and support is limited in the beta phase.
You have decided that you want to connect your system to bol.com. Great! On this page we will help you get started.
Please make sure that you have read and understand the Terms of Service that apply to the retailer API before connecting.
Not a plug-and-play solution.
Please keep in mind that we do NOT offer a plug-and-play solution. There are several ways to connect to bol.com, but all require knowledge of software development and programming.
There are, however, several third party plug-and-play solutions on the market which can be purchased or used on a subscription basis. We have listed a few of them on the website for retailers.
Before you start, make sure you have a bol.com retailer account. You cannot connect to us without it.
With your retailer account you can gather your content FTPS account (for content management) and your API credentials (for all other processes). More detailed information on how to authenticate with the API can be found here.
Please note that the content FTPS flow is not part of the beta.
The base url for all your API connections is https://api.bol.com/retailer.
Developing your connections
You can now start automating your complete workflow of selling on bol.com. You can manage your products, offers, orders and shipments, retrieve and confirm cancellations, handle your returns, view your invoices and even print your shipping labels.
Additionally, if you make use of fulfilment by bol.com, various other endpoints are available to manage these processes.
Before you start, make sure you understand the key concepts of our data model and the process flow of selling on bol.com. Also, make sure that you adhere to our conventions when developing your connections.
To make development easier, you can use our standard postman export. Please be aware that you need to update the public Postman environment first with your production API credentials.
By default, the postman collection is pointing to the demo environment. If you wish to change this to the production environment, you can change the environment variable accordingly.
Building your checks
Please understand that much of our processing is asynchronous. If you create, for example, an offer or shipment through the API, always use a process status request afterwards. This way you can verify that the process was completed successfully.
We recommend you test your bol.com API connections against our demo environment. This way you can test your API calls and add products without them being shown on the website.
All endpoints are represented in the demo environment, except those where the response is a PDF.