bol_list_orders
List orders
List the seller's bol orders (50 per page), each with its order items, EANs, quantities, prices, fulfilment method and the buyer's shipment details (personal data). By default only OPEN orders fulfilled by the retailer (FBR). Use change_interval_minute or latest_change_date to poll for recent changes. GET /retailer/orders.
Parameterspagestatusfulfilment_methodlatest_change_datechange_interval_minute
bol_get_order
Get an order
One order by id: the order items (with their order item ids), prices, quantities, fulfilment, the buyer's shipment and billing details (personal data) and the latest delivery dates. GET /retailer/orders/{order-id}.
Parametersorder_idrequired
bol_list_shipments
List shipments
List shipments up to 3 months old, newest first (50 per page): shipment id, date, the order items shipped and the transport (track and trace). Filter by order_id OR fulfilment_method (order_id wins). GET /retailer/shipments.
Parameterspageorder_idfulfilment_method
bol_get_shipment
Get a shipment
One shipment by id: shipment date, order items, transport and track and trace details, the buyer's delivery address (personal data). GET /retailer/shipments/{shipment-id}.
Parametersshipment_idrequired
bol_list_returns
List returns
List customer returns (RMA): return id, registration date, fulfilment method and the return items with their handling status. Set handled explicitly: true = handled returns (newest first), false = returns still to handle (oldest first); bol documents no default. GET /retailer/returns.
Parameterspagehandledfulfilment_method
bol_get_return
Get a return
One return by id: return items, reasons, handling results, the customer's details (personal data). GET /retailer/returns/{return-id}.
Parametersreturn_idrequired
bol_list_offers
List offers
List the seller's offers (Offers API v11): offer id, EAN, condition, price bundles, stock, fulfilment, on-hold flag and last-modified time. Filter by offer ids, EANs, your reference, for-sale state or last-modified time. Cursor paging: pass the previous reply's next_cursor. GET /retailer/offers (v11).
Parameterseanscursorfor_saleoffer_idspage_sizereferencelast_modified_since
bol_get_offer
Get an offer
One offer by id (Offers API v11): condition, price bundles, stock, fulfilment, countries, product. GET /retailer/offers/{offer-id} (v11).
Parametersoffer_idrequired
bol_get_offer_not_for_sale_reasons
Why an offer is not for sale
The reasons an offer is not for sale per country (an offer that is for sale everywhere has none) (content, price, stock, shop status, selling rights, on hold, assortment policy), each with a code and description. GET /retailer/offers/{offer-id}/not-for-sale-reasons (v11).
Parametersoffer_idrequired
bol_update_offer
Update an offer
WRITE: change an existing offer on bol (Offers API v11 PATCH): put it on hold or back on sale, set your reference, replace its price bundles and/or its own stock. Only the fields you pass change. A price or stock change goes live on bol.com. Use bol_list_offers first to see the current values. PATCH /retailer/offers/{offer-id} (v11).
Parameterspriceson_holdoffer_idrequiredreferencestock_amountstock_managed_by_retailer
bol_list_inventory
List FBB inventory
Fulfilment by bol (FBB/LVB) inventory only, not your own stock (50 per page): EAN, title, regular and graded stock, and the stock level. Filter by EAN or title, stock level, stock type or a quantity range. GET /retailer/inventory.
Parameterspagequerystatestockquantity
bol_list_invoices
List invoices
List bol invoices (the seller's statements from bol), by default the past 4 weeks: invoice id, issue date, type, period and the media types it can be downloaded in. Pass both dates to look further back (max 31 days). GET /retailer/invoices.
Parametersperiod_end_dateperiod_start_date
bol_get_invoice_specification
Get an invoice specification
The transactions (sales, commissions, shipping, returns) behind one bol invoice, as JSON, up to 25,000 lines per page. GET /retailer/invoices/{invoice-id}/specification.
Parameterspageinvoice_idrequired
bol_get_commissions
Calculate commissions
Calculate bol's commission for up to 100 products: for each EAN, a selling price and optionally a condition, returns the fixed amount, the percentage, total cost and any reductions. Read-only (a POST because of the request body). POST /retailer/commission.
Parametersproductsrequired
bol_get_competing_offers
Competing offers for an EAN
The offers on bol.com for one EAN from all retailers: price, condition, fulfilment, the best offer. Optionally only the best offer or one condition and country. GET /retailer/products/{ean}/offers.
Parameterseanrequiredpageconditioncountry_codebest_offer_only
bol_get_performance_indicator
Get a performance indicator
The seller's weekly measurements of one bol performance indicator (cancellations, fulfilment, phone availability, response time, case/item ratio, track and trace, returns, reviews) for an ISO year and week. GET /retailer/insights/performance/indicator.
Parametersnamerequiredweekrequiredyearrequired
bol_get_sales_forecast
Get a sales forecast
bol's sales forecast for one offer: expected sales on the whole bol.com platform for the next 1-12 weeks. GET /retailer/insights/sales-forecast.
Parametersoffer_idrequiredweeks_aheadrequired
bol_get_process_status
Get a process status
The status of an asynchronous bol process (a write that answered 202) by its process status id: PENDING, SUCCESS, FAILURE or TIMEOUT, with the error message on failure. GET /shared/process-status/{process-status-id}.
Parametersprocess_status_idrequired
