v10 - Shipments - Demo Endpoints
Create a shipment for multiple order items
Create a shipment for multiple order items within order 7616222700 using own transport.
POST /retailer-demo/shipments
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: application/vnd.retailer.v10+json
Authorization: Bearer token (omitted)
{
"orderItems" : [ {
"orderItemId" : "6107331383",
"quantity" : 1
}, {
"orderItemId" : "6107331307",
"quantity" : 3
} ],
"transport" : {
"transporterCode" : "TNT",
"trackAndTrace" : "3SBOLD1234567"
}
}
Content-Type: application/vnd.retailer.v10+json
Status: 202 ACCEPTED
{
"processStatusId" : "1",
"eventType" : "CREATE_SHIPMENT",
"description" : "Create shipment.",
"status" : "PENDING",
"createTimestamp" : "2025-08-06T14:08:34+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/shared-demo/process-status/1",
"method" : "GET"
} ]
}
Create a shipment for order item id 6107434013
Create a shipment for order item id 6107434013 within order 7616222250 using own transport.
POST /retailer-demo/shipments
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: application/vnd.retailer.v10+json
Authorization: Bearer token (omitted)
{
"orderItems" : [ {
"orderItemId" : "6107434013",
"quantity" : 1
} ],
"transport" : {
"transporterCode" : "TNT",
"trackAndTrace" : "3SAOLD1234567"
}
}
Content-Type: application/vnd.retailer.v10+json
Status: 202 ACCEPTED
{
"processStatusId" : "1",
"eventType" : "CREATE_SHIPMENT",
"description" : "Create shipment.",
"status" : "PENDING",
"createTimestamp" : "2025-08-06T14:08:34+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/shared-demo/process-status/1",
"method" : "GET"
} ]
}
Create a shipment using a shipping-label for order item 6702312887
Create a shipment using a shipping-label for order item 6702312887 using shipping label code PLR00000014.
POST /retailer-demo/shipments
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: application/vnd.retailer.v10+json
Authorization: Bearer token (omitted)
{
"orderItems" : [ {
"orderItemId" : "6702312887",
"quantity" : 1
} ],
"shippingLabelId" : "d4c50077-0c19-435f-9bee-1b30b9f4ba1a"
}
Content-Type: application/vnd.retailer.v10+json
Status: 202 ACCEPTED
{
"processStatusId" : "1",
"eventType" : "CREATE_SHIPMENT",
"description" : "Create shipment.",
"status" : "PENDING",
"createTimestamp" : "2025-08-06T14:08:34+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/shared-demo/process-status/1",
"method" : "GET"
} ]
}
Retrieve FBR shipment based on order id
This endpoint returns a list of all shipped orders via your own fulfilment.
GET /retailer-demo/shipments?order-id=7616222250
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"shipments" : [ {
"shipmentId" : "914587795",
"shipmentDateTime" : "2018-04-20T19:20:11+02:00",
"shipmentReference" : "Shipment1",
"order" : {
"orderId" : "7616222250",
"orderPlacedDateTime" : "2018-01-08T10:45:12+01:00"
},
"shipmentItems" : [ {
"orderItemId" : "6107434013",
"ean" : "8718712021740"
} ],
"transport" : {
"transportId" : "358612589"
}
} ]
}
Retrieve all FBR shipments
This endpoint returns a list of all shipped orders via your own fulfilment.
GET /retailer-demo/shipments?fulfilment-method=FBR
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"shipments" : [ {
"shipmentId" : "914587795",
"shipmentDateTime" : "2018-04-20T19:20:11+02:00",
"order" : {
"orderId" : "7616222250",
"orderPlacedDateTime" : "2018-01-08T10:45:12+01:00"
},
"shipmentItems" : [ {
"orderItemId" : "6107434013",
"ean" : "8421152081990"
} ],
"transport" : {
"transportId" : "358612589"
}
}, {
"shipmentId" : "953266576",
"shipmentDateTime" : "2018-04-20T19:10:19+02:00",
"order" : {
"orderId" : "7616222700",
"orderPlacedDateTime" : "2018-01-08T10:45:12+01:00"
},
"shipmentItems" : [ {
"orderItemId" : "6107331383",
"ean" : "8421152081990"
} ],
"transport" : {
"transportId" : "356988715"
}
}, {
"shipmentId" : "953267579",
"shipmentDateTime" : "2018-04-20T18:46:01+02:00",
"order" : {
"orderId" : "7616222700",
"orderPlacedDateTime" : "2018-01-08T10:45:12+01:00"
},
"shipmentItems" : [ {
"orderItemId" : "6107432387",
"ean" : "8421152081990"
} ],
"transport" : {
"transportId" : "356988715"
}
}, {
"shipmentId" : "953316694",
"shipmentDateTime" : "2019-07-04T18:16:28+02:00",
"shipmentReference" : "WSR1096399593",
"order" : {
"orderId" : "4616526971",
"orderPlacedDateTime" : "2018-01-08T10:45:12+01:00"
},
"shipmentItems" : [ {
"orderItemId" : "6702312887",
"ean" : "8421152081990"
} ],
"transport" : {
"transportId" : "356567193"
}
} ]
}
Retrieve all FBB shipments
This endpoint returns a list of all shipped orders via 'Fulfillment by bol.com'.
GET /retailer-demo/shipments?fulfilment-method=FBB
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"shipments" : [ {
"shipmentId" : "953992381",
"shipmentDateTime" : "2019-08-06T16:27:41+02:00",
"order" : {
"orderId" : "1045972070",
"orderPlacedDateTime" : "2018-01-08T10:45:12+01:00"
},
"shipmentItems" : [ {
"orderItemId" : "2070686066",
"ean" : "8421152081990"
} ],
"transport" : {
"transportId" : "309119453"
}
} ]
}
Retrieve a specific shipment by shipment id
Retrieves shipment information for order 7616222250 by using shipment id 914587795 in the URI.
GET /retailer-demo/shipments/914587795
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"shipmentId" : "914587795",
"shipmentDateTime" : "2018-04-20T19:20:11+02:00",
"shipmentReference" : "Shipment1",
"pickupPoint" : true,
"order" : {
"orderId" : "7616222250",
"orderPlacedDateTime" : "2018-04-20T16:13:31+02:00"
},
"shipmentDetails" : {
"pickupPointName" : "Albert Heijn: UTRECHT",
"salutation" : "MALE",
"firstName" : "Anakin",
"surname" : "Skywalker",
"streetName" : "Tatooinestraat",
"houseNumber" : "100",
"houseNumberExtension" : "B",
"zipCode" : "3528BJ",
"city" : "Utrecht",
"countryCode" : "NL",
"email" : "25whxgzlkmvotjhskwf5x27wlrldny@verkopen.test2.bol.com",
"deliveryPhoneNumber" : "0612345678",
"language" : "nl"
},
"billingDetails" : {
"salutation" : "MALE",
"firstName" : "Anakin",
"surname" : "Skywalker",
"streetName" : "Tatooinestraat",
"houseNumber" : "100",
"houseNumberExtension" : "B",
"extraAddressInformation" : "Extra informatie",
"zipCode" : "3528BJ",
"city" : "UTRECHT",
"countryCode" : "NL",
"email" : "25whxgzlkmvotjhskwf5x27wlrldny@verkopen.test2.bol.com",
"company" : "Pieter Post",
"vatNumber" : "NL123456789B01",
"kvkNumber" : "99887766",
"orderReference" : "Mijn order ref"
},
"shipmentItems" : [ {
"orderItemId" : "6107434013",
"fulfilment" : {
"method" : "FBR",
"latestDeliveryDate" : "2018-04-21"
},
"offer" : {
"offerId" : "8f6085e3-de98-c97f-e053-3542090a63b3",
"reference" : "Test1"
},
"product" : {
"ean" : "8712626055150",
"title" : "Star Wars - Original Trilogy"
},
"quantity" : 3,
"unitPrice" : 34.99,
"commission" : 14.0
} ],
"transport" : {
"transportId" : "358612589",
"transporterCode" : "TNT",
"trackAndTrace" : "3SAOLD1234567"
}
}
Retrieve a specific shipment by shipment id
Retrieves shipment information for the first order item in order 7616222700 by using shipment id 953266576 in the URI.
GET /retailer-demo/shipments/953266576
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"shipmentId" : "953266576",
"shipmentDateTime" : "2018-04-20T19:10:19+02:00",
"shipmentReference" : "Shipment2",
"pickupPoint" : false,
"order" : {
"orderId" : "7616222700",
"orderPlacedDateTime" : "2018-04-20T16:09:47+02:00"
},
"shipmentDetails" : {
"salutation" : "FEMALE",
"firstName" : "Leia",
"surname" : "Organa",
"streetName" : "Alderaanweg",
"houseNumber" : "100",
"zipCode" : "3528BJ",
"city" : "Utrecht",
"countryCode" : "NL",
"email" : "2fjb3hdaioycvdscjnngqhmw5f5edk@verkopen.test2.bol.com",
"company" : "Senator.nl",
"language" : "nl"
},
"billingDetails" : {
"salutation" : "FEMALE",
"firstName" : "Leia",
"surname" : "Organa",
"streetName" : "Alderaanweg",
"houseNumber" : "100",
"houseNumberExtension" : "B",
"extraAddressInformation" : "Extra informatie",
"zipCode" : "3528BJ",
"city" : "UTRECHT",
"countryCode" : "NL",
"email" : "2fjb3hdaioycvdscjnngqhmw5f5edk@verkopen.test2.bol.com",
"company" : "Pieter Post",
"vatNumber" : "NL123456789B01",
"kvkNumber" : "99887766",
"orderReference" : "Mijn order ref"
},
"shipmentItems" : [ {
"orderItemId" : "6107331383",
"fulfilment" : {
"method" : "FBR",
"latestDeliveryDate" : "2018-04-21"
},
"offer" : {
"offerId" : "8f6283e3-de98-c92f-e053-3598790a63b5",
"reference" : "Test3"
},
"product" : {
"ean" : "8712626055143",
"title" : "Star Wars Prequel Trilogy"
},
"quantity" : 1,
"unitPrice" : 24.5,
"commission" : 2.0
} ],
"transport" : {
"transportId" : "356988715",
"transporterCode" : "TNT",
"trackAndTrace" : "3SBOLD1234567",
"transportEvents" : [ {
"eventCode" : "AT_TRANSPORTER",
"eventDateTime" : "2021-07-28T22:21:07+02:00"
}, {
"eventCode" : "IN_TRANSIT",
"eventDateTime" : "2021-07-29T10:21:07+02:00"
}, {
"eventCode" : "DELIVERED_AT_CUSTOMER",
"eventDateTime" : "2021-07-29T13:21:07+02:00"
} ]
}
}
Retrieve a specific shipment by shipment id
Retrieves shipment information for the second order item in order 7616222700 by using shipment id 953267579 in the URI.
GET /retailer-demo/shipments/953267579
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"shipmentId" : "953267579",
"shipmentDateTime" : "2018-04-20T18:46:01+02:00",
"shipmentReference" : "Shipment3",
"pickupPoint" : false,
"order" : {
"orderId" : "7616222700",
"orderPlacedDateTime" : "2018-04-20T16:09:47+02:00"
},
"shipmentDetails" : {
"salutation" : "FEMALE",
"firstName" : "Leia",
"surname" : "Organa",
"streetName" : "Alderaanweg",
"houseNumber" : "100",
"zipCode" : "3528BJ",
"city" : "Utrecht",
"countryCode" : "NL",
"email" : "2fjb3hdaioycvdscjnngqhmw5f5edk@verkopen.test2.bol.com",
"company" : "Senator.nl",
"language" : "nl"
},
"billingDetails" : {
"salutation" : "FEMALE",
"firstName" : "Leia",
"surname" : "Organa",
"streetName" : "Alderaanweg",
"houseNumber" : "100",
"houseNumberExtension" : "B",
"extraAddressInformation" : "Extra informatie",
"zipCode" : "3528BJ",
"city" : "UTRECHT",
"countryCode" : "NL",
"email" : "2fjb3hdaioycvdscjnngqhmw5f5edk@verkopen.test2.bol.com",
"company" : "Pieter Post",
"vatNumber" : "NL123456789B01",
"kvkNumber" : "99887766",
"orderReference" : "Mijn order ref"
},
"shipmentItems" : [ {
"orderItemId" : "6107432387",
"fulfilment" : {
"method" : "FBR",
"latestDeliveryDate" : "2018-04-21"
},
"offer" : {
"offerId" : "8f6085e3-de98-c97f-e053-3542090a63b3",
"reference" : "Test2"
},
"product" : {
"ean" : "8804269223123",
"title" : "HJC Integraalhelm RPHA-11 Star Wars Kylo Ren-S"
},
"quantity" : 1,
"unitPrice" : 699.95,
"commission" : 24.0
} ],
"transport" : {
"transportId" : "356988715",
"transporterCode" : "TNT",
"trackAndTrace" : "3SBOLD1234567"
}
}
Retrieve a specific shipment by shipment id
Retrieves shipment information for order 4616526971 by using shipment id 953316694 in the URI.
GET /retailer-demo/shipments/953316694
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"shipmentId" : "953316694",
"shipmentDateTime" : "2018-04-20T09:33:11+02:00",
"shipmentReference" : "Shipment4",
"pickupPoint" : false,
"order" : {
"orderId" : "4616526971",
"orderPlacedDateTime" : "2018-04-20T09:33:11+02:00"
},
"shipmentDetails" : {
"salutation" : "MALE",
"firstName" : "Han",
"surname" : "Solo",
"streetName" : "Corelliaweg",
"houseNumber" : "100",
"zipCode" : "3528BJ",
"city" : "Utrecht",
"countryCode" : "NL",
"email" : "2pyshjc6ppxbrot5ek4ipiogcjgggo@verkopen.test2.bol.com",
"language" : "nl"
},
"billingDetails" : {
"salutation" : "MALE",
"firstName" : "Han",
"surname" : "Solo",
"streetName" : "Corelliaweg",
"houseNumber" : "100",
"houseNumberExtension" : "B",
"extraAddressInformation" : "Extra informatie",
"zipCode" : "3528BJ",
"city" : "UTRECHT",
"countryCode" : "NL",
"email" : "2pyshjc6ppxbrot5ek4ipiogcjgggo@verkopen.test2.bol.com",
"company" : "Pieter Post",
"vatNumber" : "NL123456789B01",
"kvkNumber" : "99887766",
"orderReference" : "Mijn order ref"
},
"shipmentItems" : [ {
"orderItemId" : "6702312887",
"fulfilment" : {
"method" : "FBR",
"latestDeliveryDate" : "2018-04-21"
},
"offer" : {
"offerId" : "8f6085e3-de98-c97f-e053-3542090a63b3",
"reference" : "Test2"
},
"product" : {
"ean" : "8804269223123",
"title" : "HJC Integraalhelm RPHA-11 Star Wars Kylo Ren-S"
},
"quantity" : 1,
"unitPrice" : 699.95,
"commission" : 15.0
} ],
"transport" : {
"transportId" : "356567193",
"transporterCode" : "DPD",
"trackAndTrace" : "543211234567"
}
}
Retrieve a specific shipment by shipment id
Retrieves shipment information for order 7616247328 by using shipment id 953992381 in the URI.
GET /retailer-demo/shipments/953992381
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"shipmentId" : "953992381",
"shipmentDateTime" : "2018-04-20T17:10:05+02:00",
"shipmentReference" : "Shipment5",
"pickupPoint" : false,
"order" : {
"orderId" : "7616247328",
"orderPlacedDateTime" : "2018-04-20T12:58:39+02:00"
},
"shipmentDetails" : {
"salutation" : "MALE",
"firstName" : "Chewbakka",
"surname" : "Wookiee",
"streetName" : "Kashyyykstraat",
"houseNumber" : "100",
"zipCode" : "3528BJ",
"city" : "Utrecht",
"countryCode" : "NL",
"email" : "2awq74thj24b7rsxqubtvl3v3efq66@verkopen.test2.bol.com",
"language" : "nl"
},
"billingDetails" : {
"salutation" : "MALE",
"firstName" : "Chewbakka",
"surname" : "Wookiee",
"streetName" : "Kashyyykstraat",
"houseNumber" : "100",
"houseNumberExtension" : "B",
"extraAddressInformation" : "Extra informatie",
"zipCode" : "3528BJ",
"city" : "UTRECHT",
"countryCode" : "NL",
"email" : "2awq74thj24b7rsxqubtvl3v3efq66@verkopen.test2.bol.com",
"company" : "Pieter Post",
"vatNumber" : "NL123456789B01",
"kvkNumber" : "99887766",
"orderReference" : "Mijn order ref"
},
"shipmentItems" : [ {
"orderItemId" : "6107989317",
"fulfilment" : {
"method" : "FBB",
"latestDeliveryDate" : "2018-04-21"
},
"offer" : {
"offerId" : "8f6085e3-de98-c97f-e053-3542090a63b3",
"reference" : "Test4"
},
"product" : {
"ean" : "8718526069334",
"title" : "Star Wars - Nappy Star wars T-shirt - XL"
},
"quantity" : 1,
"unitPrice" : 25.0,
"commission" : 3.0
} ],
"transport" : {
"transportId" : "356972369",
"transporterCode" : "TNT",
"trackAndTrace" : "3SCOLD1234567"
}
}
Get a list of all invoice requests filtered by shipment id
Retrieves a list of all invoice requests filtered by shipment id 544644695.
GET /retailer-demo/shipments/invoices/requests?shipment-id=544644695
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"invoiceRequests" : [ {
"shipmentId" : "544644695",
"orderId" : "4691862037",
"customerAccountNumber" : "3004850316",
"billingDetails" : {
"salutation" : "MALE",
"firstName" : "Billie",
"surname" : "Jansen",
"streetName" : "Dorpstraat",
"houseNumber" : "1",
"houseNumberExtension" : "B",
"zipCode" : "1111ZZ",
"city" : "Utrecht",
"countryCode" : "NL",
"company" : "bol.com",
"vatNumber" : "NL999999999B99",
"kvkNumber" : "99887766"
},
"products" : [ {
"description" : "Eucerin Hyaluron-filler",
"quantity" : 2,
"unitPrice" : 10.0
} ],
"status" : "INVOICE_REQUESTED",
"statusTransitions" : [ {
"status" : "INVOICE_REQUESTED",
"statusDateTime" : "2023-02-10T14:48:03+01:00"
}, {
"status" : "INVOICE_UPLOADED",
"statusDateTime" : "2023-02-10T14:59:44+01:00"
}, {
"status" : "FINISHED",
"statusDateTime" : "2023-02-10T15:16:13+01:00"
} ]
} ]
}
Get a list of all open invoice requests
Retrieves a list of all invoice requests with OPEN state regardless shipment id.
GET /retailer-demo/shipments/invoices/requests?state=OPEN
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v10+json
Status: 200 OK
{
"invoiceRequests" : [ {
"shipmentId" : "987654",
"orderId" : "4691862037",
"customerAccountNumber" : "3004850316",
"billingDetails" : {
"salutation" : "MALE",
"firstName" : "Billie",
"surname" : "Jansen",
"streetName" : "Dorpstraat",
"houseNumber" : "1",
"houseNumberExtension" : "B",
"zipCode" : "1111ZZ",
"city" : "Utrecht",
"countryCode" : "NL",
"company" : "bol.com",
"vatNumber" : "NL999999999B99",
"kvkNumber" : "99887766"
},
"products" : [ {
"description" : "Eucerin Hyaluron-filler",
"quantity" : 2,
"unitPrice" : 10.0
} ],
"status" : "INVOICE_REQUESTED",
"statusTransitions" : [ {
"status" : "INVOICE_REQUESTED",
"statusDateTime" : "2020-12-09T12:34:56+01:00"
} ]
}, {
"shipmentId" : "665578",
"orderId" : "564734839",
"customerAccountNumber" : "5664838354",
"billingDetails" : {
"salutation" : "MALE",
"firstName" : "Jon",
"surname" : "Groot",
"streetName" : "Dorpstraat",
"houseNumber" : "1",
"houseNumberExtension" : "B",
"zipCode" : "2222ZZ",
"city" : "Utrecht",
"countryCode" : "NL",
"company" : "bol.com",
"vatNumber" : "NL999999999B99",
"kvkNumber" : "99887766"
},
"products" : [ {
"description" : "Boxer Live In Brussels",
"quantity" : 1,
"unitPrice" : 10.0
} ],
"status" : "INVOICE_REQUESTED",
"statusTransitions" : [ {
"status" : "INVOICE_REQUESTED",
"statusDateTime" : "2020-12-09T11:34:56+01:00"
} ]
} ]
}
Upload an invoice for shipment id 987654
Uploads an invoice as the binary data for shipment id 987654. Note that the "boundary" field in the content-type header and request body is dynamic and should be generated by your HTTP client at upload time.
POST /retailer-demo/shipments/invoices/987654
-
Request
-
Response
Accept: application/vnd.retailer.v10+json
Content-Type: multipart/form-data;boundary=rzuEGIMlrFHbrq
Authorization: Bearer token (omitted)
--rzuEGIMlrFHbrq
Content-Disposition: form-data; name="invoice"; filename="invoice.pdf"
Content-Type: application/pdf
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--rzuEGIMlrFHbrq--
Content-Type: application/vnd.retailer.v10+json
Status: 202 ACCEPTED
{
"processStatusId" : "1",
"eventType" : "UPLOAD_INVOICE",
"description" : "The invoice is uploaded and needs to be processed.",
"status" : "PENDING",
"createTimestamp" : "2025-08-06T14:08:35+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/shared-demo/process-status/1",
"method" : "GET"
} ]
}