Get started with the Bol.com Retailer API

Using bol.com’s Retailer API: From authentication (OAuth) to rate-limiting, from key-concepts to the demo environment, here you can find 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 is the combined set of functionalities we are offering in API form 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 enabel 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 proces easier

Step 3. Get to know the API

The following topics will familiarize you with the building blocks of developming agains 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 their API connection is working.

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

Step 5. Start building

Now you can start puting 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 integration

Here are some links to documentation regarding what you can expect from us and what we would like you to know regarding the use of our Retailer API.

Migration Guide & Release notes

To help you with the migration from V3 to V4 we have created a comprehensive migration guide. In addition you can also take a look at the release notes

API Overview

APIs Functional Documentation API Reference

Product Content API

link

link

Offer API

link

link

Order API

link

link

Shipment API

link

link

Shipping labels API

link

link

Return API

link

link

Insights API

link

link

Commission API

link

link

Invoices API

link

link

Inbound API

link

link

Inventory API

link

link

Transports API

link

link

Process Status API

link

link

Pricing API (beta)

link

link

Subscriptions API (beta)

link

link

Retailer API versions

Version specific documentation, containing API specifics that may differ between released versions. Please note that 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

ApiSpec

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

v3 Formatted

v3 Raw

v4 Formatted

v4 Raw

API Reference documentation

Technical documentation, based on Redoc.

v3 Redoc

v4 Redoc

Postman Suite

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

v3 Postman

v4 Postman

Demo environment

Documentation covering available endpoints in demo environment.

v3 Demo docs

v4 Demo docs