bol Retailer API integration
The bol Retailer API lets a seller on bol (bol.com, the Dutch and Belgian marketplace) run its shop: create, update and delete offers (Offer API v11) and see why one is not for sale, list and cancel orders, ship them or buy shipping labels, handle returns, answer invoice requests, manage Fulfilment by bol stock and replenishments, read commissions, competing offers, product data, ratings, promotions, sales forecasts, search terms and performance indicators, manage economic operators and event subscriptions, and follow asynchronous requests with process statuses. Invoices (answers declared as raw bytes), the deprecated v10 offer and subscription routes, beta routes and the Advertising API are not exposed. Authentication uses the client id and secret from the bol seller dashboard (Settings, API settings) to obtain short-lived OAuth2 tokens (client credentials).
Say what should happen.
The workflow builds itself.
What you can do with bol Retailer API
Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.
Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.
Offer, 7 operations
create_offerCreate offerPOSTCreates an offer synchronously (Offer API v11) for an EAN (or ISBN) with condition, bundle pricing, fulfilment method and optionally stock, countries (NL, BE), reference and economic operator. Returns the new offerId.delete_offerDelete offerDELETEDeletes one of your offers, immediately (Offer API v11). To change an offer EAN, delete the offer and create a new one.get_offerGet offerGETReturns one of your offers: EAN, reference, condition, bundle prices, stock (amount and corrected stock), fulfilment, country availability and the bol product id.get_offer_insightsGet offer insightsGETReturns, for one of your offers, the product visits or buy box percentage per day, week or month over the requested number of periods, in total and per country.list_competing_offersList competing offersGETUse this endpoint to get a list of offers available in the webshop. The list includes offers for all retailers.list_offersList offersGETLists your offers, up to 100 per page with a cursor, filtered by offer ids, EANs, reference, for-sale status or last modification time; each with EAN, condition, pricing, stock, fulfilment and country availability.update_offerUpdate offerPATCHUpdates parts of an offer in one call (Offer API v11): pricing, stock, fulfilment, country availability, reference, on-hold flag, unknown product title or economic operator. Fields left out stay unchanged.
Economic operator, 5 operations
create_economic_operatorCreate economic operatorPOSTCreates an economic operator (the EU-responsible manufacturer, importer or distributor shown to customers under the Digital Services Act) with legal name, address and contact details. Its id is the economicOperatorId of an offer.delete_economic_operatorDelete economic operatorDELETEDeletes one of your economic operators and returns the deleted record.get_economic_operatorGet economic operatorGETReturns one of your economic operators: legal name, address, contact details and your external reference.list_economic_operatorsList economic operatorsGETLists your economic operators, optionally searching by (part of) the name, up to 100 per page.update_economic_operatorUpdate economic operatorPUTReplaces the details of one of your economic operators: legal name, address, contact details and external reference.
Subscription, 5 operations
create_subscriptionCreate subscriptionPOSTCreates an event notification subscription: event types (resources), a destination (webhook URL, Pub/Sub topic or SQS queue) and the platform. AWS_SQS also needs an identity.delete_subscriptionDelete subscriptionDELETEDeletes an event notification subscription; its notifications stop.get_subscriptionGet subscriptionGETReturns one event notification subscription: event types, destination, platform, enabled flag and identity.list_subscriptionsList subscriptionsGETLists your event notification subscriptions with their event types, destination, platform (WEBHOOK, GCP_PUBSUB or AWS_SQS) and enabled flag.update_subscriptionUpdate subscriptionPATCHRetailers can use this endpoint to modify the details of an existing event notification subscription. Only the fields provided in the request body will be updated - any omitted fields will remain unchanged.
Replenishment, 4 operations
create_replenishmentCreate replenishmentPOSTAnnounces a replenishment of stock to a bol warehouse (Fulfilment by bol): reference, product lines, number of load carriers, labelling by bol, and a delivery date or a pickup appointment. Returns a process status.get_replenishmentGet replenishmentGETReturns one replenishment: state, reference, delivery information and destination warehouse, load carriers, lines with announced and received quantities, and state transitions.list_replenishmentsList replenishmentsGETLists your replenishments (stock shipments to bol warehouses), 50 per page, filtered by reference, EAN, creation date range or state.update_replenishmentUpdate replenishmentPUTUpdates a replenishment: cancel it (state CANCELLED), change the expected delivery date, the number of load carriers or their SSCC codes. Returns a process status.
Return, 4 operations
create_returnCreate returnPOSTCreate a return, and automatically handle it with the provided handling result. When successfully created, the resulting return id is provided in the process status.get_returnGet returnGETRetrieve a return based on the return id.handle_returnHandle returnPUTHandles a return item, or changes the handling result of an already handled one, with a handling result (for example RETURN_RECEIVED) and the quantity returned. Returns a process status.list_returnsList returnsGETGet a paginated list of multi-item returns. Handled returns are sorted by date in descending order, while unhandled returns are sorted by date in ascending order.
Process status, 3 operations
get_process_statusGet process statusGETReturns the status of an asynchronous request (PENDING, SUCCESS, FAILURE or TIMEOUT) by the process status id it answered with, plus its entity id, event type and error message.get_process_statuses_bulkGet process statuses bulkPOSTReturns the status of up to 1000 asynchronous requests at once, by process status id.list_process_statusesList process statusesGETLists the process statuses of earlier asynchronous requests on one entity (for example an order item id) for one event type (for example CREATE_SHIPMENT), newest first, 50 per page.
Shipment, 3 operations
create_shipmentCreate shipmentPOSTShips order items of one order: give the transporter and track and trace code, or the shippingLabelId of a label bought with create_shipping_label. Returns a process status.get_shipmentGet shipmentGETRetrieve a single shipment by its corresponding id.list_shipmentsList shipmentsGETA paginated list to retrieve all your shipments up to 3 months old. The shipments will be sorted by date in descending order.
Commission, 2 operations
get_commissionGet commissionGETCommissions can be filtered by condition, which defaults to NEW. We will calculate the commission amount from the EAN and price.get_commissions_bulkGet commissions bulkPOSTCalculates the bol commission (fixed amount, percentage, total cost) and any active reductions for up to 100 products at once, each given by EAN, unit price and optionally condition.
Order, 2 operations
get_orderGet orderGETReturns one order with its shipment and billing details and every item: EAN and title, quantity, quantities shipped and cancelled, unit and total price, commission, fulfilment method, latest delivery date and any cancellation request.list_ordersList ordersGETLists your orders, 50 per page, filtered by fulfilment method (FBR, FBB or ALL), status (OPEN, SHIPPED or ALL), latest change date or a recent change interval in minutes, or only VVB (Verzenden via bol) orders.
Product destination, 2 operations
get_product_destinationsGet product destinationsGETReturns which bol warehouse (with its address) each requested EAN must be sent to, by the id that request_product_destinations produced.request_product_destinationsRequest product destinationsPOSTAsks bol which warehouse each of 1 to 50 EANs must be sent to before a replenishment. Returns a process status; once it succeeds, its entityId is the id to pass to get_product_destinations.
Promotion, 2 operations
get_promotionGet promotionGETReturns one promotion: title, type, start and end time, countries and campaign.list_promotionsList promotionsGETGets a paginated list of all promotions for a retailer.
Shipping label, 2 operations
create_shipping_labelCreate shipping labelPOSTBuys a shipping label for order items, using a shippingLabelOfferId from get_delivery_options. Returns a process status; once it succeeds, its entityId is the shipping label id for get_shipping_label.get_shipping_labelGet shipping labelGETDownloads a purchased shipping label as a PDF file, by shipping label id.
Asset, 1 operation
get_product_assetsGet product assetsGETReturns the images of a product by EAN: usage (primary or additional), order and each size variant with dimensions, MIME type and URL.
Cancellation, 1 operation
cancel_order_itemsCancel order itemsPUTCancels order items of one order with a reason code, either to confirm a cancellation the customer requested or because you cannot deliver them. Returns a process status.
Category, 1 operation
list_product_categoriesList product categoriesGETLists the bol product categories with their subcategories, in the requested language.
Delivery date, 1 operation
list_replenishment_delivery_datesList replenishment delivery datesGETLists the dates on which a replenishment can be delivered to a bol warehouse.
Delivery option, 1 operation
get_delivery_optionsGet delivery optionsPOSTLists the shipping label options (transporter, label type, price, size and weight limits, validity) available for a set of order items; pass one shippingLabelOfferId to create_shipping_label.
Indicator, 1 operation
get_performance_indicatorsGet performance indicatorsGETReturns your weekly scores and norms for bol performance indicators such as cancellations, fulfilment, phone availability, case items, tracking, reviews or returns, for a given ISO year and week.
Inventory, 1 operation
list_fbb_inventoryList fbb inventoryGETLists your stock held in bol warehouses (Fulfilment by bol, LVB/FBB) with regular and graded quantities per EAN, 50 per page, filterable by quantity range, stock level, stock type or EAN/title. Your own stock is not included.
Invoice, 1 operation
upload_shipment_invoiceUpload shipment invoicePOSTUploads the invoice of a shipment as a PDF file (at most 2 MB, one per shipment), typically to answer a customer invoice request from list_invoice_requests. Returns a process status.
List, 1 operation
search_productsSearch productsPOSTLists bol products (titles and EANs), 50 per page, by search term or category, optionally narrowed by filter ranges or filter values from list_product_list_filters and sorted.
List filter, 1 operation
list_product_list_filtersList product list filtersGETReturns the categories, range filters and value filters available for a search term or category, to narrow search_products.
Load carrier label, 1 operation
get_load_carrier_labelsGet load carrier labelsGETReturns the load carrier labels of a replenishment as a PDF file, for the warehouse or for the transporter.
Not for sale reason, 1 operation
get_offer_not_for_sale_reasonsGet offer not for sale reasonsGETExplains why an offer is not for sale, per country: reason category, code, description and any missing mandatory content attributes.
Pick list, 1 operation
get_pick_listGet pick listGETReturns the pick list of a replenishment as a PDF file.
Pickup time slot, 1 operation
get_pickup_time_slotsGet pickup time slotsPOSTReturns the time slots in which bol can pick up a replenishment at a given address for a number of load carriers.
Placement, 1 operation
get_product_placementGet product placementGETGets the list of categories and the URL where the product is placed in the webshop.
Price star boundary, 1 operation
get_price_star_boundariesGet price star boundariesGETGets a list of all price star boundaries for a specific EAN.
Product, 1 operation
list_promotion_productsList promotion productsGETGets a paginated list of all products that are present within a promotion.
Product id, 1 operation
get_product_idsGet product idsGETGet the bol.com specific product identifier and the related EANs.
Product label, 1 operation
get_product_labelsGet product labelsPOSTGenerates printable product labels (a PDF file) for EANs and quantities, in the chosen label printer format.
Product rank, 1 operation
get_product_ranksGet product ranksGETReturns how an EAN ranked on a given past day (up to three months back): its rank and impressions per search term or category, whether the placement was sponsored, 50 results per page.
Profile, 1 operation
list_delivery_promise_profilesList delivery promise profilesGETRetrieves a list of delivery promise profiles for the authenticated retailer. A profile defines the retailer handover days with latest order times, expected carrier delivery time and carrier working days
Rating, 1 operation
get_product_ratingsGet product ratingsGETReturns the customer ratings of a product by EAN: how many ratings it has for each star value.
Request, 1 operation
list_invoice_requestsList invoice requestsGETGets a list of paginated invoice requests initiated by customers.
Retailer, 1 operation
get_retailerGet retailerGETReturns the public information of a retailer (use current for your own account): display and company name, VAT and KvK numbers, registration date, top-retailer flag, ratings and review counts.
Sales forecast, 1 operation
get_sales_forecastGet sales forecastGETGet sales forecast to estimate the sales expectations on the total bol.com platform for the requested number of weeks ahead.
Search term, 1 operation
get_search_termsGet search termsGETRetrieves the search volume for a specified search term and period. The search volume allows you to see what bol.com customers are searching for.
Signature key, 1 operation
list_signature_keysList signature keysGETLists the public keys that verify the signature header of bol push notifications.
Test, 1 operation
send_test_notificationSend test notificationPOSTSends a test push notification to a subscription destination to check it works, and returns a reference to track it.
Transport, 1 operation
add_transport_infoAdd transport infoPUTAdds the transporter code and track and trace code to the transport of an existing shipment; the transport id is in the shipment returned by get_shipment. Returns a process status.
Use bol Retailer API from Claude Code, Cursor or Codex
Connect bol Retailer API in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its bol Retailer API operations become tools the client can call, next to every other integration you connected.
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"
[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"{
"mcpServers": {
"livecontext": {
"type": "http",
"url": "https://livecontext.ai/mcp",
"headers": {
"X-API-Key": "YOUR_API_KEY"
}
}
}
}How to connect bol Retailer API
- Create your workspace
Sign up free. Nothing to install.
- Connect bol Retailer API once
Add your bol Retailer API connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
- Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.
bol Retailer API integration FAQ
What can you do with the bol Retailer API integration?
LiveContext exposes 70 operations on bol Retailer API, covering offer, economic operator, subscription and replenishment.
