v3 - Orders - Demo Endpoints
Cancel an order item for order 7616222250
Cancel order item 6107434013 for order 7616222250.
PUT /retailer-demo/orders/6107434013/cancellation
Accept: application/vnd.retailer.v3+json
Content-Type: application/vnd.retailer.v3+json
Authorization: Bearer token (omitted)
{
"reasonCode" : "OUT_OF_STOCK"
}
Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED
{
"id" : 1,
"entityId" : "6107434013",
"eventType" : "CANCEL_ORDER",
"description" : "Cancel order item with id 6107434013.",
"status" : "PENDING",
"createTimestamp" : "2021-04-08T15:52:51+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-demo/process-status/1",
"method" : "GET"
} ]
}
Cancel an order item for order 7616222700
Cancel order item 6107331383 for order 7616222700.
PUT /retailer-demo/orders/6107331383/cancellation
Accept: application/vnd.retailer.v3+json
Content-Type: application/vnd.retailer.v3+json
Authorization: Bearer token (omitted)
{
"reasonCode" : "OUT_OF_STOCK"
}
Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED
{
"id" : 1,
"entityId" : "6107331383",
"eventType" : "CANCEL_ORDER",
"description" : "Cancel order item with id 6107331383.",
"status" : "PENDING",
"createTimestamp" : "2021-04-08T15:52:51+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-demo/process-status/1",
"method" : "GET"
} ]
}
Cancel an order item for order 7616222700
Cancel order item 6107432387 for order 7616222700.
PUT /retailer-demo/orders/6107432387/cancellation
Accept: application/vnd.retailer.v3+json
Content-Type: application/vnd.retailer.v3+json
Authorization: Bearer token (omitted)
{
"reasonCode" : "OUT_OF_STOCK"
}
Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED
{
"id" : 1,
"entityId" : "6107432387",
"eventType" : "CANCEL_ORDER",
"description" : "Cancel order item with id 6107432387.",
"status" : "PENDING",
"createTimestamp" : "2021-04-08T15:52:51+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-demo/process-status/1",
"method" : "GET"
} ]
}
Cancel an order item for order 4616526971
Cancel order item 6702312887 for order 4616526971.
PUT /retailer-demo/orders/6702312887/cancellation
Accept: application/vnd.retailer.v3+json
Content-Type: application/vnd.retailer.v3+json
Authorization: Bearer token (omitted)
{
"reasonCode" : "OUT_OF_STOCK"
}
Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED
{
"id" : 1,
"entityId" : "6702312887",
"eventType" : "CANCEL_ORDER",
"description" : "Cancel order item with id 6702312887.",
"status" : "PENDING",
"createTimestamp" : "2021-04-08T15:52:51+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-demo/process-status/1",
"method" : "GET"
} ]
}
Get single FBB order with order id 1042823870
Get the single order details for FBB order 1042823870 containing more than 1 order item.
GET /retailer-demo/orders/1042823870
Accept: application/vnd.retailer.v3+json
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v3+json
Status: 200 OK
{
"orderId" : "1042823870",
"pickUpPoint" : false,
"dateTimeOrderPlaced" : "2019-04-30T16:47:32+02:00",
"customerDetails" : {
"shipmentDetails" : {
"salutationCode" : "01",
"firstName" : "Hans",
"surName" : "de Grote",
"streetName" : "Skywalkerstraat",
"houseNumber" : "199",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "27zoytzc3crf2r6bctxfa3m2mrjbci@verkopen.test2.bol.com",
"language" : "nl"
},
"billingDetails" : {
"salutationCode" : "01",
"firstName" : "Hans",
"surName" : "de Grote",
"streetName" : "Skywalkerstraat",
"houseNumber" : "199",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "27zoytzc3crf2r6bctxfa3m2mrjbci@verkopen.test2.bol.com",
"vatNumber" : "NL123456789B01",
"chamberOfCommerceNumber" : "99887766",
"orderReference" : "Mijn order ref"
}
},
"orderItems" : [ {
"orderItemId" : "6107771545",
"offerReference" : "MijnOffer0021",
"ean" : "8785056370398",
"title" : "Star Wars Prequel Trilogy",
"quantity" : 1,
"offerPrice" : 19.99,
"offerId" : "8f1183e3-de98-c92f-e053-3590612a63b7",
"transactionFee" : 2.21,
"latestDeliveryDate" : "2018-04-22",
"expiryDate" : "2018-04-25",
"offerCondition" : "GOOD",
"cancelRequest" : false,
"fulfilmentMethod" : "FBB"
}, {
"orderItemId" : "6107771546",
"offerReference" : "MijnOffer1121",
"ean" : "8717418510749",
"title" : "Star Wars - The happy family 2",
"quantity" : 1,
"offerPrice" : 32.98,
"offerId" : "8f6485e3-de66-c08f-e053-8602590a63b4",
"transactionFee" : 6.38,
"latestDeliveryDate" : "2018-01-16",
"expiryDate" : "2018-01-16",
"offerCondition" : "NEW",
"cancelRequest" : false,
"fulfilmentMethod" : "FBB"
} ]
}
Get single FBB order with order id 1043965710
Get the single order details for FBB order 1043965710 containing 1 order item.
GET /retailer-demo/orders/1043965710
Accept: application/vnd.retailer.v3+json
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v3+json
Status: 200 OK
{
"orderId" : "1043965710",
"pickUpPoint" : false,
"dateTimeOrderPlaced" : "2019-04-30T21:56:39+02:00",
"customerDetails" : {
"shipmentDetails" : {
"salutationCode" : "01",
"firstName" : "Pieter",
"surName" : "Post",
"streetName" : "Skywalkerstraat",
"houseNumber" : "21",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
"language" : "nl"
},
"billingDetails" : {
"salutationCode" : "01",
"firstName" : "Pieter",
"surName" : "Post",
"streetName" : "Skywalkerstraat",
"houseNumber" : "21",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
"vatNumber" : "NL123456789B01",
"chamberOfCommerceNumber" : "99887766",
"orderReference" : "Mijn order ref"
}
},
"orderItems" : [ {
"orderItemId" : "6107989317",
"offerReference" : "MijnOffer6627",
"ean" : "8717418510749",
"title" : "Star Wars - The happy family",
"quantity" : 2,
"offerPrice" : 44.9,
"offerId" : "8f2785e3-de98-c97f-e053-3585190a63c1",
"transactionFee" : 2.22,
"latestDeliveryDate" : "2019-05-01",
"expiryDate" : "2019-05-04",
"offerCondition" : "NEW",
"cancelRequest" : false,
"fulfilmentMethod" : "FBB"
} ]
}
Get single FBR order with order id 1042831430
Get the single order details for FBR order 1042831430 containing more than 1 order item.
GET /retailer-demo/orders/1042831430
Accept: application/vnd.retailer.v3+json
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v3+json
Status: 200 OK
{
"orderId" : "1042831430",
"pickUpPoint" : false,
"dateTimeOrderPlaced" : "2019-04-20T12:58:39+02:00",
"customerDetails" : {
"shipmentDetails" : {
"salutationCode" : "01",
"firstName" : "Hans",
"surName" : "de Grote",
"streetName" : "Skywalkerstraat",
"houseNumber" : "199",
"houseNumberExtended" : "B",
"extraAddressInformation" : "Apartment",
"zipCode" : "1200",
"city" : "BRUSSEL",
"countryCode" : "BE",
"email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
"language" : "nl"
},
"billingDetails" : {
"salutationCode" : "01",
"firstName" : "Hans",
"surName" : "de Grote",
"streetName" : "Skywalkerstraat",
"houseNumber" : "199",
"zipCode" : "1200",
"city" : "BRUSSEL",
"countryCode" : "BE",
"email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
"vatNumber" : "NL123456789B01",
"chamberOfCommerceNumber" : "99887766",
"orderReference" : "Mijn order ref"
}
},
"orderItems" : [ {
"orderItemId" : "6107331382",
"offerReference" : "MijnOffer0021",
"ean" : "8712626055143",
"title" : "Star Wars - The happy family 2",
"quantity" : 1,
"offerPrice" : 22.98,
"offerId" : "8f6283e3-de98-c92f-e053-3598790a63b5",
"transactionFee" : 2.22,
"latestDeliveryDate" : "2018-04-18",
"expiryDate" : "2018-04-21",
"offerCondition" : "NEW",
"cancelRequest" : false,
"fulfilmentMethod" : "FBR"
}, {
"orderItemId" : "6107331383",
"offerReference" : "MijnOffer1121",
"ean" : "8717418510749",
"title" : "Star Wars - The happy family 2",
"quantity" : 3,
"offerPrice" : 30.9,
"offerId" : "8f6125e3-de98-c08f-e053-3523590a63b9",
"transactionFee" : 2.22,
"latestDeliveryDate" : "2018-04-21",
"expiryDate" : "2018-04-21",
"offerCondition" : "NEW",
"cancelRequest" : false,
"fulfilmentMethod" : "FBR"
} ]
}
Get single FBR order with order id A4K8290LP0
Get the single order details for FBR order A4K8290LP0 containing 1 order item. To simulate retrieving an order with exact delivery date use id 'B3K8290LP0'.
GET /retailer-demo/orders/A4K8290LP0
Accept: application/vnd.retailer.v3+json
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v3+json
Status: 200 OK
{
"orderId" : "A4K8290LP0",
"pickUpPoint" : false,
"dateTimeOrderPlaced" : "2019-12-06T13:04:34+01:00",
"customerDetails" : {
"shipmentDetails" : {
"salutationCode" : "02",
"firstName" : "Hans",
"surName" : "de Grote",
"streetName" : "Skywalkerstraat",
"houseNumber" : "199",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
"language" : "nl"
},
"billingDetails" : {
"salutationCode" : "01",
"firstName" : "Hans",
"surName" : "de Grote",
"streetName" : "Skywalkerstraat",
"houseNumber" : "199",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
"vatNumber" : "NL123456789B01",
"chamberOfCommerceNumber" : "99887766",
"orderReference" : "Mijn order ref"
}
},
"orderItems" : [ {
"orderItemId" : "2070906705",
"offerReference" : "MijnOffer0021",
"ean" : "8718846038683",
"title" : "adidas Originals Booklet case Bohemian color for iPhone 7/8 colourful",
"quantity" : 1,
"offerPrice" : 34.99,
"offerId" : "8f6283e3-de98-c92f-e053-3598790a63b5",
"transactionFee" : 2.22,
"latestDeliveryDate" : "2019-12-15",
"expiryDate" : "2019-12-18",
"offerCondition" : "NEW",
"cancelRequest" : false,
"fulfilmentMethod" : "FBR"
} ]
}
Get single FBR order with order id 1043946570
Get the single order details for FBB order 1043965710 containing 1 order item.
GET /retailer-demo/orders/1043946570
Accept: application/vnd.retailer.v3+json
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v3+json
Status: 200 OK
{
"orderId" : "1043946570",
"pickUpPoint" : true,
"dateTimeOrderPlaced" : "2019-04-29T18:18:21+02:00",
"customerDetails" : {
"shipmentDetails" : {
"pickUpPointName" : "Albert Heijn: UTRECHT",
"salutationCode" : "01",
"firstName" : "Pieter",
"surName" : "Post",
"streetName" : "Skywalkerstraat",
"houseNumber" : "21",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "2puwjjic7wxsbmkj3bc2v6jsj2wimk@verkopen.test2.bol.com",
"language" : "nl"
},
"billingDetails" : {
"salutationCode" : "01",
"firstName" : "Pieter",
"surName" : "Post",
"streetName" : "Skywalkerstraat",
"houseNumber" : "21",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "2puwjjic7wxsbmkj3bc2v6jsj2wimk@verkopen.test2.bol.com",
"vatNumber" : "NL123456789B01",
"chamberOfCommerceNumber" : "99887766",
"orderReference" : "Mijn order ref"
}
},
"orderItems" : [ {
"orderItemId" : "6042823871",
"offerReference" : "MijnOffer6627",
"ean" : "8717418510749",
"title" : "Star Wars - The happy family 2",
"quantity" : 3,
"offerPrice" : 33.0,
"offerId" : "8f6285e3-de98-c97f-e053-3544090a63b3",
"transactionFee" : 2.22,
"latestDeliveryDate" : "2019-05-01",
"expiryDate" : "2019-05-04",
"offerCondition" : "NEW",
"cancelRequest" : false,
"fulfilmentMethod" : "FBR"
} ]
}
Get single FBR order with order id B3K8290LP0
Get the single order details for FBR order B3K8290LP0 containing 1 order item with an exact delivery date. To simulate retrieving an order with latest delivery date use id 'A4K8290LP0'.
GET /retailer-demo/orders/B3K8290LP0
Accept: application/vnd.retailer.v3+json
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v3+json
Status: 200 OK
{
"orderId" : "B3K8290LP0",
"pickUpPoint" : false,
"dateTimeOrderPlaced" : "2020-01-01T13:04:34+01:00",
"customerDetails" : {
"shipmentDetails" : {
"salutationCode" : "02",
"firstName" : "Hans",
"surName" : "de Grote",
"streetName" : "Skywalkerstraat",
"houseNumber" : "199",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
"language" : "nl"
},
"billingDetails" : {
"salutationCode" : "01",
"firstName" : "Hans",
"surName" : "de Grote",
"streetName" : "Skywalkerstraat",
"houseNumber" : "199",
"zipCode" : "1234 AB",
"city" : "PLATOONDORP",
"countryCode" : "NL",
"email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
"vatNumber" : "NL123456789B01",
"chamberOfCommerceNumber" : "99887766",
"orderReference" : "Mijn order ref"
}
},
"orderItems" : [ {
"orderItemId" : "2070906706",
"offerReference" : "MijnOffer0021",
"ean" : "8718846038683",
"title" : "adidas Originals Booklet case Bohemian color for iPhone 7/8 colourful",
"quantity" : 1,
"offerPrice" : 34.99,
"offerId" : "8f6283e3-de98-c92f-e053-3598790a63b5",
"transactionFee" : 2.22,
"expiryDate" : "2020-01-09",
"exactDeliveryDate" : "2020-01-08",
"offerCondition" : "NEW",
"cancelRequest" : false,
"fulfilmentMethod" : "FBR"
} ]
}
Get all open FBB orders
Get a paginated list of open FBB orders sorted by date in descending order.
GET /retailer-demo/orders?fulfilment-method=FBB
Accept: application/vnd.retailer.v3+json
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v3+json
Status: 200 OK
{
"orders" : [ {
"orderId" : "1043965710",
"dateTimeOrderPlaced" : "2019-04-30T21:56:39+02:00",
"orderItems" : [ {
"orderItemId" : "6107989317",
"ean" : "8717418510749",
"cancelRequest" : false,
"quantity" : 2
} ]
}, {
"orderId" : "1042823870",
"dateTimeOrderPlaced" : "2019-04-30T16:47:32+02:00",
"orderItems" : [ {
"orderItemId" : "6107771545",
"ean" : "8785056370398",
"cancelRequest" : false,
"quantity" : 1
}, {
"orderItemId" : "6107771546",
"ean" : "8785073140359",
"cancelRequest" : false,
"quantity" : 1
} ]
} ]
}
Get all open FBR orders
Get a paginated list of open FBR orders sorted by date in descending order.
GET /retailer-demo/orders?fulfilment-method=FBR
Accept: application/vnd.retailer.v3+json
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.
Content-Type: application/vnd.retailer.v3+json
Status: 200 OK
{
"orders" : [ {
"orderId" : "1043946570",
"dateTimeOrderPlaced" : "2019-04-29T18:18:21+02:00",
"orderItems" : [ {
"orderItemId" : "6042823871",
"ean" : "8717418510749",
"cancelRequest" : false,
"quantity" : 3
} ]
}, {
"orderId" : "1042831430",
"dateTimeOrderPlaced" : "2019-04-20T12:58:39+02:00",
"orderItems" : [ {
"orderItemId" : "6107331382",
"ean" : "8712626055143",
"cancelRequest" : false,
"quantity" : 1
}, {
"orderItemId" : "6107331383",
"ean" : "8804269223123",
"cancelRequest" : false,
"quantity" : 1
} ]
}, {
"orderId" : "A4K8290LP0",
"dateTimeOrderPlaced" : "2019-12-06T13:04:34+01:00",
"orderItems" : [ {
"orderItemId" : "2070906705",
"ean" : "8718846038683",
"cancelRequest" : false,
"quantity" : 1
} ]
}, {
"orderId" : "B3K8290LP0",
"dateTimeOrderPlaced" : "2020-01-01T13:04:34+01:00",
"orderItems" : [ {
"orderItemId" : "2070906706",
"ean" : "8718846038683",
"cancelRequest" : false,
"quantity" : 1
} ]
} ]
}
Create a shipment for order item id 6107434013
Create a shipment for order item id 6107434013 within order 7616222250 using own transport.
PUT /retailer-demo/orders/6107434013/shipment
Accept: application/vnd.retailer.v3+json
Content-Type: application/vnd.retailer.v3+json
Authorization: Bearer token (omitted)
{
"transport" : {
"transporterCode" : "TNT",
"trackAndTrace" : "3SAOLD1234567"
}
}
Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED
{
"id" : 1,
"entityId" : "6107434013",
"eventType" : "CONFIRM_SHIPMENT",
"description" : "Confirm shipment for order item 6107434013.",
"status" : "PENDING",
"createTimestamp" : "2021-04-08T15:52:52+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-demo/process-status/1",
"method" : "GET"
} ]
}
Create a shipment for order item id 6107331383
Create a shipment for order item id 6107331383 within order 7616222700 using own transport.
PUT /retailer-demo/orders/6107331383/shipment
Accept: application/vnd.retailer.v3+json
Content-Type: application/vnd.retailer.v3+json
Authorization: Bearer token (omitted)
{
"transport" : {
"transporterCode" : "TNT",
"trackAndTrace" : "3SBOLD1234567"
}
}
Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED
{
"id" : 1,
"entityId" : "6107331383",
"eventType" : "CONFIRM_SHIPMENT",
"description" : "Confirm shipment for order item 6107331383.",
"status" : "PENDING",
"createTimestamp" : "2021-04-08T15:52:52+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-demo/process-status/1",
"method" : "GET"
} ]
}
Create a shipment for order item id 6107432387
Create a shipment for order item id 6107432387 within order 7616222700 using own transport.
PUT /retailer-demo/orders/6107432387/shipment
Accept: application/vnd.retailer.v3+json
Content-Type: application/vnd.retailer.v3+json
Authorization: Bearer token (omitted)
{
"transport" : {
"transporterCode" : "TNT",
"trackAndTrace" : "3SBOLD1234567"
}
}
Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED
{
"id" : 1,
"entityId" : "6107432387",
"eventType" : "CONFIRM_SHIPMENT",
"description" : "Confirm shipment for order item 6107432387.",
"status" : "PENDING",
"createTimestamp" : "2021-04-08T15:52:52+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-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.
PUT /retailer-demo/orders/6702312887/shipment
Accept: application/vnd.retailer.v3+json
Content-Type: application/vnd.retailer.v3+json
Authorization: Bearer token (omitted)
{
"shippingLabelCode" : "PLR00000014"
}
Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED
{
"id" : 1,
"entityId" : "6702312887",
"eventType" : "CONFIRM_SHIPMENT",
"description" : "Confirm shipment for order item 6702312887.",
"status" : "PENDING",
"createTimestamp" : "2021-04-08T15:52:52+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-demo/process-status/1",
"method" : "GET"
} ]
}