Orders and shipments

Depending on your usage, the Get delivery options endpoint might also apply to your process if you are purchasing labels from bol.com.

Get orders: can be used to return a list of open orders.

This endpoint is used to get all your current open orders, sorted by the creation date in descending order. The endpoint supports pagination by using the page query parameter and allows you to filter on FBB orders if you are participating in Logistics Via Bol.com and FBR orders. In the response, you will find – amongst other attributes – the orderId and order items. This orderId can be used to get the order details in the get a single order.

Get a single order: returns a single order.

With the orderId from the Get orders endpoint, you can use this endpoint to fetch all the order details for this specific orderId. In the response, you will find shipment details giving data that can be used for your shipment, and billing details giving data can be used to make up an invoice.

Next to that, you will find all the order items that are part of the order. This can either be 1 if the customer ordered only 1 item, or more if the customer ordered more than 1 item within the same customer order.

The items within the order are known as order items, and are referred to as the orderItemId. With this ID, you can either choose to ship this order item or to cancel this specific order item.

By default the single order request will return all items in the order, including both Fulfilment by bol.com (FBB) and Fulfilment by retailer (FBR) fulfilment methods. You should check the fulfilment method per orderItem when reviewing your open order. The order items can also be a mixture of v5/verzenden-via-bol.adoc and non-Verzenden via bol.com shipping methods, which will be indicated by the distributionParty being either BOL or RETAILER.

The Get a single order request filters by default on status=ALL. It returns all open items as well as all items that were shipped or cancelled within the last 48 hours. Besides quantity ordered the response includes the fields quantityCancelled and quantityShipped. See Get orders with all statuses for more information.

Ship order item: is used to ship an order item and provide shipment information.

With this endpoint, it is possible to ship an order item from a specific customer order. There are two ways to ship an order item:

Cancel order item: is used to cancel an order item and provide a reason for the cancellation.

There are two scenarios that can occur regarding cancelling an order item:

Get shipments: returns a list of shipments.

This endpoint is used to get all your shipments, sorted by the shipment date in descending order. The endpoint supports pagination by using the page query parameter, and allows you to filter on FBB orders if you are participating in Logistics Via Bol.com and FBR orders. Moreover, you can search within all the shipments on orderId, so that you can find easily and quick a single shipment based on the orderId.

In the response, you will find – among other attributes – the shipmentId, shipmentItems and the related transport information. You can use the shipmentId to fetch more shipment details using the Get a single shipment endpoint. Moreover, the transportId is in the same response, and can be used to add transport information in case you didn’t do so while shipping the order item.

Get a single shipment: returns a single shipment.

To fetch the details of a shipment, you can use this endpoint to get all the shipment details based on the shipmentId. In the response, you will find the items that where shipped, the transport information, and the details of the customer. In compliance with GDPR, we omit the transport information from the response when the transport is more than a year old.

Add transport information: is used to add transport information to a shipment.

It is possible that you already want to ship an order item, but you don’t know the track and trace details at that moment in time. When this occurs, the customer will not be informed of the track and trace-related information. This is not an optimal customer experience for your customer. In this scenario, this endpoint allows you to still send us the track and trace code. From that moment on, the customer will also receive updates on events when this track and trace code is scanned.

Customers pay attention to the track and trace code, and it is therefore important that you provide this data.

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.