API v3 – Orders

Orders are one of the most commonly used parts of the bol.com API. The ability to process orders in your own ERP or e-commerce platform offers many benefits.

On this page, the flow for retrieving and handling orders is described. However, sometimes an order or order item can be cancelled by you or your customer. In both cases, you need to take action. Please view the cancellations page for more detail.

 

Endpoint overview

The following endpoints are all considered to fit the order flow.

Information regarding available transporters can be found at the bottom of this page.

 

Intended use

Depending on the intended purpose there are multiple flows you could use for order management. See below for some of the most used flows, other variants are possible as well. All flows intend to use the process-status endpoint. This endpoint allows you to check the status of your request.

 

1 Check orders

The ‘Get open orders list’ in combination with the ‘Get single order’ endpoint can be used to retrieve order information.

  • Get open orders list
  • Get single order (for more detail)

 

2 Regular order flow

The regular order flow allows for the retrieval and processing of orders. The following endpoints are required to ensure a correct processing of the order.

  • Get open orders list
  • Get single order
  • Put ship order

 

3 Retrieve shipment information

Besides open orders it’s also possible to retrieve information on confirmed shipments. This flow consists of two endpoints. One returning a list with minimal information, the second one returning the details for a single shipment.

  • Get shipments list
  • Get single shipment

 

4 Confirm order with shipping label

Sellers who are familiar with the manual order flow know the discounted shipping labels via bol.com. This option is also available through API. All information regarding this flow can be found on the dedicated shipping labels page.

 

Appendix A – Transporters

The table below shows all available transporter codes that can be used while creating a shipment or adding a transporter code to a shipment that was created earlier. Please make sure that the transporter code is available for the version of the API that you are using at that time.

Note: Some transporters use a DASH while others use an UNDERSCORE. Please make sure to use the correct one.

Transporter / service API transporter code
Briefpost BRIEFPOST
UPS UPS
PostNL TNT
PostNL extra@home TNT-EXTRA
PostNL Briefpost TNT_BRIEF
TNT Express TNT-EXPRESS
Dynalogic DYL
DPD Nederland DPD-NL
DPD België DPD-BE
Bpost België BPOST_BE
Bpost Briefpost BPOST_BRIEF
DHLFORYOU DHLFORYOU
GLS GLS
FedEx Nederland FEDEX_NL
FedEx Belgie FEDEX_BE
Anders OTHER
DHL DHL
DHL Germany DHL_DE
DHL Global mail DHL-GLOBAL-MAIL
Transportservice Nederland TSN
Fiege FIEGE
TransMission TRANSMISSION
Parcel.nl PARCEL-NL
LogoiX LOGOIX
Packs PACKS
Bezorgafspraak COURIER
NedWRK (Red je pakketje) RJP