Welcome to the bol.com Retailer API

This site offers a comprehensive guide to working with bol.com’s Retailer API and integrating your environment with our platform.

Please make sure that you have read and understood the Terms of Service that apply to the Retailer API before connecting.

Definition

The Retailer API refers to the combined set of API functions which we are offering to all business retailers that are registered on the bol.com retailer platform.

Step 1. Get a Retailer Account

Before you can start connecting you need to sign up for a retailer account. This will enable you to authenticate yourself and connect to the API and FTPS.

Step 2. Choose an integration method

These guides will help you to develop your own custom solution to integrate your systems with our platform. However, there are also several third-party solutions that can make this process easier.

Step 3. Get to know the API

The following topics will familiarize you with the building blocks of developing against the Retailer API:

Step 4. Set up a demo environment

We recommend that you test your bol.com API connections against our demo environment. This demo describes test requests for users to validate that their API connection is working.

In addition, we offer a Postman export which should be updated with your production API credentials.

Step 5. Start building

Now you can start putting together the integration and begin making real sales! We recommend always starting your development with Offers, then moving to Orders, and after that start implementing the more advanced Content management.

The following links explain your expectations from us and our legal requirements regarding the use of our Retailer API:

Migration guides and release notes

The comprehensive migration guides will help you with the migration from older versions of the API. In addition you can also review the release notes for each version.

Migration guides

Release notes

API Overview

APIs Functional Documentation API Reference

Product Content API

link

link

Offers API

link

link

Orders API

link

link

Shipments API

link

link

Shipping labels API

link

link

Returns API

link

link

Insights API

link

link

Commissions API

link

link

Invoices API

link

link

Replenishments API

link

link

Inventory API

link

link

Transports API

link

link

Process Status API

link

link

Subscriptions API (beta)

link

link

Retailer API versions

Below you can find version-specific documentation, containing API features that may differ between released versions.

Versions marked with beta may contain features that are not openly available. Reach out to Partner Service to see if you can participate in one of our closed beta tests.
Resource Description V3 (deprecated) V4 (deprecated) V5 (GA)

ApiSpec

Swagger/OpenAPI spec for use in documentation tools and code generators.

v3 Raw

v4 Raw

v5 Raw

API Reference documentation

Technical documentation, based on Redoc.

v3 Redoc

v4 Redoc

v5 Redoc

Postman Suite

Retailer API endpoints documented using Postman. Can be imported to the Postman app for easy execution.

v3 Postman

v4 Postman

v5 Postman

Demo environment

Documentation covering available endpoints in demo environment.

v3 Demo docs

v4 Demo docs

v5 Demo docs