About the Bol.com category

Roland · September 21, 2022, 11:05am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Welcome to the bol.com Retailer API | Retailer API Documentation

Connector package documentation

1. Setting up HTTP Client Bol.com

1.1 Steps

In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Bol.com HTTP Client as the prototype of the HTTP Client.
Fill in the Base URI, Token URI, Client Type, Client id and Client Secret.
You can optionally enable logging of request to get the log of the authentication.
Click on Grant access to Bol.com to get the Key.
Save the HTTP Client after the key has been provided.

image1184×770 30 KB

2. Subscribing to Entities from Bol.com

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select Bol.com Advertiser Subscriber, Bol.com Retailer Subscriber or Bol.com Shared Subscriber as the subscriber.

Select the entity you want to subscribe from Bol.com.
Add any request parameters needed to subscribe to the entity (optional).
You can optionally add a transformer to transform the request parameters into something you need.
Select the Bol.com HTTP Client to use. (Please set the Client Type according to what you need for the Subscriber)

2.2 General Concept

We follow Bol.com documentation on building this connector so you can easily use the connector based on Bol.com API Reference.

Entity

It’s the entity you want to subscribe from Bol.com. Please refer to the entities in Management APIs from Bol.com API Reference.

Request Parameters

These are the parameters you can provide to get the needed entity based on Bol.com API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Retrieve an offer by its offer id.

Because the offer id is inside path, we put it like that. This will be sent to Bol system as /retailer/offers/7ec7658e-972a-454f-b0e8-9c1b2151ee61

Input Transformer

Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.

HTTP Client

It’s the HTTP Client configuration you will use to access Bol.com. (Please set the Client Type according to what you need for the Subscriber)

3. Publishing Entity to Bol.com

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select Bol.com Advertiser Publisher or Bol.com Retailer Publisher as the publisher.

image1077×212 8.17 KB
Select the action that you want the publisher to do with the data currently Bol.com support CREATE, UPDATE and DELETE.
Select the Bol.com entity you want the data to be published to.
Select the HTTP Client to use. (Please set the Client Type according to what you need for the Publisher)

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).

Action

Currently we support CREATE (HTTP POST method), UPDATE (HTTP PUT method) and DELETE (HTTP DELETE method).

Entity

We support publishing to most Bol.com endpoints. Please refer to the entities in Management APIs from Bol.com API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For endpoints that require object as the request payload, please look at the example below. For example, we want to Create a Thread. Please select “CREATE” as the action and “Create a new offer” as the entity of the publisher.

You can put the payload you want to send to Bol.com into payload property in the data. Here is an example of the Payload for creating the offer.

Alumio will send an API request to Bol.com with URL /retailer/offers.