v5 - Orders - Demo Endpoints

Cancel an order item for order 7616222250

Cancel order item 6107434013 for order 7616222250.

PUT /retailer-demo/orders/cancellation

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: application/vnd.retailer.v5+json
Authorization: Bearer token (omitted)

{
  "orderItems" : [ {
    "orderItemId" : "6107434013",
    "reasonCode" : "OUT_OF_STOCK"
  } ]
}

Content-Type: application/vnd.retailer.v5+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "6107434013",
  "eventType" : "CANCEL_ORDER",
  "description" : "Cancel order item with id 6107434013.",
  "status" : "PENDING",
  "createTimestamp" : "2021-06-23T10:11:12+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/cancellation

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: application/vnd.retailer.v5+json
Authorization: Bearer token (omitted)

{
  "orderItems" : [ {
    "orderItemId" : "6107331383",
    "reasonCode" : "OUT_OF_STOCK"
  } ]
}

Content-Type: application/vnd.retailer.v5+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "6107331383",
  "eventType" : "CANCEL_ORDER",
  "description" : "Cancel order item with id 6107331383.",
  "status" : "PENDING",
  "createTimestamp" : "2021-06-23T10:11:12+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/cancellation

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: application/vnd.retailer.v5+json
Authorization: Bearer token (omitted)

{
  "orderItems" : [ {
    "orderItemId" : "6107432387",
    "reasonCode" : "OUT_OF_STOCK"
  } ]
}

Content-Type: application/vnd.retailer.v5+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "6107432387",
  "eventType" : "CANCEL_ORDER",
  "description" : "Cancel order item with id 6107432387.",
  "status" : "PENDING",
  "createTimestamp" : "2021-06-23T10:11:12+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/cancellation

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: application/vnd.retailer.v5+json
Authorization: Bearer token (omitted)

{
  "orderItems" : [ {
    "orderItemId" : "6702312887",
    "reasonCode" : "OUT_OF_STOCK"
  } ]
}

Content-Type: application/vnd.retailer.v5+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "6702312887",
  "eventType" : "CANCEL_ORDER",
  "description" : "Cancel order item with id 6702312887.",
  "status" : "PENDING",
  "createTimestamp" : "2021-06-23T10:11:12+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

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orderId" : "1042823870",
  "pickupPoint" : false,
  "orderPlacedDateTime" : "2019-04-30T16:47:32+02:00",
  "shipmentDetails" : {
    "salutation" : "MALE",
    "firstName" : "Hans",
    "surname" : "de Grote",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "199",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "27zoytzc3crf2r6bctxfa3m2mrjbci@verkopen.test2.bol.com",
    "language" : "nl"
  },
  "billingDetails" : {
    "salutation" : "MALE",
    "firstName" : "Pieter",
    "surname" : "Post",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "21",
    "houseNumberExtension" : "X",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "kvkNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  },
  "orderItems" : [ {
    "orderItemId" : "6107771545",
    "cancellationRequest" : false,
    "fulfilment" : {
      "method" : "FBB",
      "latestDeliveryDate" : "2018-04-22",
      "expiryDate" : "2018-04-25",
      "timeFrameType" : "REGULAR"
    },
    "offer" : {
      "offerId" : "8f1183e3-de98-c92f-e053-3590612a63b7",
      "reference" : "MijnOffer0021"
    },
    "product" : {
      "ean" : "8785056370398",
      "title" : "Star Wars Prequel Trilogy"
    },
    "quantity" : 1,
    "quantityShipped" : 1,
    "quantityCancelled" : 0,
    "unitPrice" : 19.99,
    "commission" : 2.21
  }, {
    "orderItemId" : "6107771546",
    "cancellationRequest" : false,
    "fulfilment" : {
      "method" : "FBB",
      "latestDeliveryDate" : "2018-01-16",
      "expiryDate" : "2018-01-16",
      "timeFrameType" : "REGULAR"
    },
    "offer" : {
      "offerId" : "8f6485e3-de66-c08f-e053-8602590a63b4",
      "reference" : "MijnOffer1121"
    },
    "product" : {
      "ean" : "8717418510749",
      "title" : "Star Wars - The happy family 2"
    },
    "quantity" : 1,
    "quantityShipped" : 1,
    "quantityCancelled" : 0,
    "unitPrice" : 32.98,
    "commission" : 6.38
  } ]
}

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

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orderId" : "1043965710",
  "pickupPoint" : false,
  "orderPlacedDateTime" : "2019-04-30T21:56:39+02:00",
  "shipmentDetails" : {
    "salutation" : "MALE",
    "firstName" : "Pieter",
    "surname" : "Post",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "21",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
    "language" : "nl"
  },
  "billingDetails" : {
    "salutation" : "MALE",
    "firstName" : "Pieter",
    "surname" : "Post",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "21",
    "houseNumberExtension" : "X",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "kvkNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  },
  "orderItems" : [ {
    "orderItemId" : "6107989317",
    "cancellationRequest" : false,
    "fulfilment" : {
      "method" : "FBB",
      "latestDeliveryDate" : "2019-05-01",
      "expiryDate" : "2019-05-04",
      "timeFrameType" : "REGULAR"
    },
    "offer" : {
      "offerId" : "8f2785e3-de98-c97f-e053-3585190a63c1",
      "reference" : "MijnOffer6627"
    },
    "product" : {
      "ean" : "8717418510749",
      "title" : "Star Wars - The happy family"
    },
    "quantity" : 2,
    "quantityShipped" : 2,
    "quantityCancelled" : 0,
    "unitPrice" : 22.45,
    "commission" : 2.22
  } ]
}

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

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orderId" : "1042831430",
  "pickupPoint" : false,
  "orderPlacedDateTime" : "2019-04-20T12:58:39+02:00",
  "shipmentDetails" : {
    "salutation" : "MALE",
    "firstName" : "Hans",
    "surname" : "de Grote",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "199",
    "houseNumberExtension" : "B",
    "extraAddressInformation" : "Apartment",
    "zipCode" : "1200",
    "city" : "BRUSSEL",
    "countryCode" : "BE",
    "email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
    "language" : "nl"
  },
  "billingDetails" : {
    "salutation" : "MALE",
    "firstName" : "Pieter",
    "surname" : "Post",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "21",
    "houseNumberExtension" : "X",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "kvkNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  },
  "orderItems" : [ {
    "orderItemId" : "6107331382",
    "cancellationRequest" : false,
    "fulfilment" : {
      "method" : "FBR",
      "distributionParty" : "RETAILER",
      "latestDeliveryDate" : "2018-04-18",
      "expiryDate" : "2018-04-21",
      "timeFrameType" : "REGULAR"
    },
    "offer" : {
      "offerId" : "8f6283e3-de98-c92f-e053-3598790a63b5",
      "reference" : "MijnOffer0021"
    },
    "product" : {
      "ean" : "8712626055143",
      "title" : "Star Wars - The happy family 2"
    },
    "quantity" : 1,
    "quantityShipped" : 1,
    "quantityCancelled" : 0,
    "unitPrice" : 22.98,
    "commission" : 2.22
  }, {
    "orderItemId" : "6107331383",
    "cancellationRequest" : false,
    "fulfilment" : {
      "method" : "FBR",
      "distributionParty" : "RETAILER",
      "latestDeliveryDate" : "2018-04-21",
      "expiryDate" : "2018-04-21",
      "timeFrameType" : "REGULAR"
    },
    "offer" : {
      "offerId" : "8f6125e3-de98-c08f-e053-3523590a63b9",
      "reference" : "MijnOffer1121"
    },
    "product" : {
      "ean" : "8717418510749",
      "title" : "Star Wars - The happy family 2"
    },
    "quantity" : 3,
    "quantityShipped" : 2,
    "quantityCancelled" : 0,
    "unitPrice" : 10.3,
    "commission" : 2.22
  } ]
}

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

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orderId" : "A4K8290LP0",
  "pickupPoint" : false,
  "orderPlacedDateTime" : "2019-12-06T13:04:34+01:00",
  "shipmentDetails" : {
    "salutation" : "FEMALE",
    "firstName" : "Hans",
    "surname" : "de Grote",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "199",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
    "language" : "nl"
  },
  "billingDetails" : {
    "salutation" : "MALE",
    "firstName" : "Pieter",
    "surname" : "Post",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "21",
    "houseNumberExtension" : "X",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "kvkNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  },
  "orderItems" : [ {
    "orderItemId" : "2070906705",
    "cancellationRequest" : false,
    "fulfilment" : {
      "method" : "FBR",
      "distributionParty" : "RETAILER",
      "latestDeliveryDate" : "2019-12-15",
      "expiryDate" : "2019-12-18",
      "timeFrameType" : "REGULAR"
    },
    "offer" : {
      "offerId" : "8f6283e3-de98-c92f-e053-3598790a63b5",
      "reference" : "MijnOffer0021"
    },
    "product" : {
      "ean" : "8718846038683",
      "title" : "adidas Originals Booklet case Bohemian color for iPhone 7/8 colourful"
    },
    "quantity" : 1,
    "quantityShipped" : 1,
    "quantityCancelled" : 0,
    "unitPrice" : 34.99,
    "commission" : 2.22
  } ]
}

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

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orderId" : "1043946570",
  "pickupPoint" : true,
  "orderPlacedDateTime" : "2019-04-29T18:18:21+02:00",
  "shipmentDetails" : {
    "pickupPointName" : "Albert Heijn: UTRECHT",
    "salutation" : "MALE",
    "firstName" : "Pieter",
    "surname" : "Post",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "21",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2puwjjic7wxsbmkj3bc2v6jsj2wimk@verkopen.test2.bol.com",
    "language" : "nl"
  },
  "billingDetails" : {
    "salutation" : "MALE",
    "firstName" : "Pieter",
    "surname" : "Post",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "21",
    "houseNumberExtension" : "X",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "kvkNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  },
  "orderItems" : [ {
    "orderItemId" : "6042823871",
    "cancellationRequest" : false,
    "fulfilment" : {
      "method" : "FBR",
      "distributionParty" : "RETAILER",
      "latestDeliveryDate" : "2019-05-01",
      "expiryDate" : "2019-05-04",
      "timeFrameType" : "REGULAR"
    },
    "offer" : {
      "offerId" : "8f6285e3-de98-c97f-e053-3544090a63b3",
      "reference" : "MijnOffer6627"
    },
    "product" : {
      "ean" : "8717418510749",
      "title" : "Star Wars - The happy family 2"
    },
    "quantity" : 3,
    "quantityShipped" : 3,
    "quantityCancelled" : 0,
    "unitPrice" : 11.0,
    "commission" : 2.22
  } ]
}

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 'AK8290LP0'.

GET /retailer-demo/orders/B3K8290LP0

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orderId" : "B3K8290LP0",
  "pickupPoint" : false,
  "orderPlacedDateTime" : "2020-01-01T13:04:34+01:00",
  "shipmentDetails" : {
    "salutation" : "FEMALE",
    "firstName" : "Hans",
    "surname" : "de Grote",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "199",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2mqmu3hefoawq3mqgzxh4hbpkyh2rs@verkopen.test2.bol.com",
    "language" : "nl"
  },
  "billingDetails" : {
    "salutation" : "MALE",
    "firstName" : "Pieter",
    "surname" : "Post",
    "streetName" : "Skywalkerstraat",
    "houseNumber" : "21",
    "houseNumberExtension" : "X",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "1234AB",
    "city" : "PLATOONDORP",
    "countryCode" : "NL",
    "email" : "2yldzdi2wjcf5ir4sycq7lufqpytxy@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "kvkNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  },
  "orderItems" : [ {
    "orderItemId" : "2070906706",
    "cancellationRequest" : false,
    "fulfilment" : {
      "method" : "FBR",
      "distributionParty" : "RETAILER",
      "exactDeliveryDate" : "2020-01-08",
      "expiryDate" : "2020-01-09",
      "timeFrameType" : "REGULAR"
    },
    "offer" : {
      "offerId" : "8f6283e3-de98-c92f-e053-3598790a63b5",
      "reference" : "MijnOffer0021"
    },
    "product" : {
      "ean" : "8718846038683",
      "title" : "adidas Originals Booklet case Bohemian color for iPhone 7/8 colourful"
    },
    "quantity" : 1,
    "quantityShipped" : 1,
    "quantityCancelled" : 0,
    "unitPrice" : 34.99,
    "commission" : 2.22
  } ]
}

Get FBB orders with status ALL

Get a paginated list of FBB orders with status ALL sorted by date in descending order.

GET /retailer-demo/orders?fulfilment-method=FBB&status=ALL

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orders" : [ {
    "orderId" : "1043965710",
    "orderPlacedDateTime" : "2019-04-30T21:56:39+02:00",
    "orderItems" : [ {
      "orderItemId" : "6107989317",
      "ean" : "8717418510749",
      "quantity" : 2,
      "quantityShipped" : 2,
      "quantityCancelled" : 0
    } ]
  }, {
    "orderId" : "1042823870",
    "orderPlacedDateTime" : "2019-04-30T16:47:32+02:00",
    "orderItems" : [ {
      "orderItemId" : "6107771545",
      "ean" : "8785056370398",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    }, {
      "orderItemId" : "6107771546",
      "ean" : "8785073140359",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    } ]
  } ]
}

Get FBB orders with status OPEN

Get a paginated list of FBB orders with status OPEN sorted by date in descending order.

GET /retailer-demo/orders?fulfilment-method=FBB&status=OPEN

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orders" : [ {
    "orderId" : "1043965710",
    "orderPlacedDateTime" : "2019-04-30T21:56:39+02:00",
    "orderItems" : [ {
      "orderItemId" : "6107989317",
      "ean" : "8717418510749",
      "quantity" : 2,
      "quantityShipped" : 2,
      "quantityCancelled" : 0
    } ]
  }, {
    "orderId" : "1042823870",
    "orderPlacedDateTime" : "2019-04-30T16:47:32+02:00",
    "orderItems" : [ {
      "orderItemId" : "6107771545",
      "ean" : "8785056370398",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    }, {
      "orderItemId" : "6107771546",
      "ean" : "8785073140359",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    } ]
  } ]
}

Get FBR orders with status ALL

Get a paginated list of FBR orders with status ALL sorted by date in descending order.

GET /retailer-demo/orders?fulfilment-method=FBR&status=ALL

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orders" : [ {
    "orderId" : "1043946570",
    "orderPlacedDateTime" : "2019-04-29T18:18:21+02:00",
    "orderItems" : [ {
      "orderItemId" : "6042823871",
      "ean" : "8717418510749",
      "quantity" : 3,
      "quantityShipped" : 3,
      "quantityCancelled" : 0
    } ]
  }, {
    "orderId" : "1042831430",
    "orderPlacedDateTime" : "2019-04-20T12:58:39+02:00",
    "orderItems" : [ {
      "orderItemId" : "6107331382",
      "ean" : "8712626055143",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    }, {
      "orderItemId" : "6107331383",
      "ean" : "8804269223123",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    } ]
  }, {
    "orderId" : "A4K8290LP0",
    "orderPlacedDateTime" : "2019-12-06T13:04:34+01:00",
    "orderItems" : [ {
      "orderItemId" : "2070906705",
      "ean" : "8718846038683",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    } ]
  }, {
    "orderId" : "B3K8290LP0",
    "orderPlacedDateTime" : "2020-01-01T13:04:34+01:00",
    "orderItems" : [ {
      "orderItemId" : "2070906706",
      "ean" : "8718846038683",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    } ]
  } ]
}

Get FBR orders with status OPEN

Get a paginated list of FBR orders with status OPEN sorted by date in descending order.

GET /retailer-demo/orders?fulfilment-method=FBR&status=OPEN

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json

Status: 200 OK

{
  "orders" : [ {
    "orderId" : "1043946570",
    "orderPlacedDateTime" : "2019-04-29T18:18:21+02:00",
    "orderItems" : [ {
      "orderItemId" : "6042823871",
      "ean" : "8717418510749",
      "quantity" : 3,
      "quantityShipped" : 3,
      "quantityCancelled" : 0
    } ]
  }, {
    "orderId" : "1042831430",
    "orderPlacedDateTime" : "2019-04-20T12:58:39+02:00",
    "orderItems" : [ {
      "orderItemId" : "6107331382",
      "ean" : "8712626055143",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    }, {
      "orderItemId" : "6107331383",
      "ean" : "8804269223123",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    } ]
  }, {
    "orderId" : "A4K8290LP0",
    "orderPlacedDateTime" : "2019-12-06T13:04:34+01:00",
    "orderItems" : [ {
      "orderItemId" : "2070906705",
      "ean" : "8718846038683",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    } ]
  }, {
    "orderId" : "B3K8290LP0",
    "orderPlacedDateTime" : "2020-01-01T13:04:34+01:00",
    "orderItems" : [ {
      "orderItemId" : "2070906706",
      "ean" : "8718846038683",
      "quantity" : 1,
      "quantityShipped" : 1,
      "quantityCancelled" : 0
    } ]
  } ]
}

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/shipment

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: application/vnd.retailer.v5+json
Authorization: Bearer token (omitted)

{
  "orderItems" : [ {
    "orderItemId" : "6107434013"
  } ],
  "transport" : {
    "transporterCode" : "TNT",
    "trackAndTrace" : "3SAOLD1234567"
  }
}

Content-Type: application/vnd.retailer.v5+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "6107434013",
  "eventType" : "CONFIRM_SHIPMENT",
  "description" : "Confirm shipment for order item 6107434013.",
  "status" : "PENDING",
  "createTimestamp" : "2021-06-23T10:11:12+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/shipment

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: application/vnd.retailer.v5+json
Authorization: Bearer token (omitted)

{
  "orderItems" : [ {
    "orderItemId" : "6107331383"
  } ],
  "transport" : {
    "transporterCode" : "TNT",
    "trackAndTrace" : "3SBOLD1234567"
  }
}

Content-Type: application/vnd.retailer.v5+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "6107331383",
  "eventType" : "CONFIRM_SHIPMENT",
  "description" : "Confirm shipment for order item 6107331383.",
  "status" : "PENDING",
  "createTimestamp" : "2021-06-23T10:11:12+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/shipment

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: application/vnd.retailer.v5+json
Authorization: Bearer token (omitted)

{
  "orderItems" : [ {
    "orderItemId" : "6107432387"
  } ],
  "transport" : {
    "transporterCode" : "TNT",
    "trackAndTrace" : "3SBOLD1234567"
  }
}

Content-Type: application/vnd.retailer.v5+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "6107432387",
  "eventType" : "CONFIRM_SHIPMENT",
  "description" : "Confirm shipment for order item 6107432387.",
  "status" : "PENDING",
  "createTimestamp" : "2021-06-23T10:11:12+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/shipment

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: application/vnd.retailer.v5+json
Authorization: Bearer token (omitted)

{
  "orderItems" : [ {
    "orderItemId" : "6702312887"
  } ],
  "shippingLabelId" : "d4c50077-0c19-435f-9bee-1b30b9f4ba1a"
}

Content-Type: application/vnd.retailer.v5+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "6702312887",
  "eventType" : "CONFIRM_SHIPMENT",
  "description" : "Confirm shipment for order item 6702312887.",
  "status" : "PENDING",
  "createTimestamp" : "2021-06-23T10:11:12+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}