API quick reference
A single index of every bol Partner API: its functional documentation, reference documentation (Redoc), machine-readable OpenAPI specs, Postman collections, and demo coverage across versions.
Documentation & reference by resource
Functional documentation and Redoc reference for each API resource, grouped by integrator type so you can quickly see which are relevant to you. Product Content and Products are shared by Retailers and Suppliers; Process Status is used by all integrators.
| Integrator | API | Functional documentation | API reference |
|---|---|---|---|
Retailers |
Offers API (v11) |
|
|
Offers API (v10) |
|
|
|
Orders API |
|
|
|
Shipments API |
|
|
|
Shipping Labels API |
|
|
|
Transports API |
|
|
|
Returns API |
|
|
|
Replenishments API |
|
|
|
Inventory API |
|
|
|
Invoices API |
|
|
|
Commissions API |
|
|
|
Promotions API |
|
|
|
Subscriptions API |
|
|
|
Retailers |
|
|
|
Insights API |
|
|
|
Economic Operators API |
|
|
|
Product Content API |
|
|
|
Products |
|
|
|
Suppliers |
Product Content API |
|
|
Products |
|
|
|
Advertisers |
Advertising API |
|
Campaign Management API Budget Management API Reporting API Bulk Reporting API Insights API |
Shared (all integrators) |
Process Status API |
|
|
Specs, tools & releases by API
Version-specific artifacts — release notes, OpenAPI specs, Redoc, Postman collections and demo coverage — for each API product, grouped by integrator type. NA means the artifact is not available for that API.
| Integrator | API | Release notes | OpenAPI spec | Redoc | Postman | Demo |
|---|---|---|---|---|---|---|
Retailers |
Offer API v11 |
NA |
||||
Retailer API v10 |
||||||
Economic Operators v1 |
NA |
|||||
Suppliers |
Supplier API v10 |
NA |
||||
Advertisers |
Advertising API v11 |
NA |
NA |
NA |