v3 - Shipments - Demo Endpoints

Retrieve FBR shipment based on order id

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

{
  "shipments" : [ {
    "shipmentId" : 914587795,
    "shipmentDate" : "2018-04-20T19:20:11+02:00",
    "shipmentItems" : [ {
      "orderItemId" : "6107434013",
      "orderId" : "7616222250"
    } ],
    "transport" : {
      "transportId" : 358612589
    }
  }, {
    "shipmentId" : 953266576,
    "shipmentDate" : "2018-04-20T19:10:19+02:00",
    "shipmentItems" : [ {
      "orderItemId" : "6107331383",
      "orderId" : "7616222700"
    } ],
    "transport" : {
      "transportId" : 356988715
    }
  }, {
    "shipmentId" : 953267579,
    "shipmentDate" : "2018-04-20T18:46:01+02:00",
    "shipmentItems" : [ {
      "orderItemId" : "6107432387",
      "orderId" : "7616222700"
    } ],
    "transport" : {
      "transportId" : 356988715
    }
  }, {
    "shipmentId" : 953316694,
    "shipmentDate" : "2019-07-04T18:16:28+02:00",
    "shipmentReference" : "WSR1096399593",
    "shipmentItems" : [ {
      "orderItemId" : "6702312887",
      "orderId" : "4616526971"
    } ],
    "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.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

{
  "shipments" : [ {
    "shipmentId" : 953992381,
    "shipmentDate" : "2019-08-06T16:27:41+02:00",
    "shipmentItems" : [ {
      "orderItemId" : "2070686066",
      "orderId" : "1045972070"
    } ],
    "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.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

{
  "shipmentId" : 914587795,
  "pickUpPoint" : true,
  "shipmentDate" : "2018-04-20T19:20:11+02:00",
  "shipmentReference" : "Shipment1",
  "shipmentItems" : [ {
    "orderItemId" : "6107434013",
    "orderId" : "7616222250",
    "orderDate" : "2018-04-20T16:13:31+02:00",
    "latestDeliveryDate" : "2018-04-21T00:00:00+02:00",
    "ean" : "8712626055150",
    "title" : "Star Wars - Original Trilogy",
    "quantity" : 3,
    "offerPrice" : 104.97,
    "offerCondition" : "NEW",
    "offerReference" : "Test1",
    "fulfilmentMethod" : "FBR"
  } ],
  "transport" : {
    "transportId" : 358612589,
    "transporterCode" : "TNT",
    "trackAndTrace" : "3SAOLD1234567"
  },
  "customerDetails" : {
    "pickUpPointName" : "Albert Heijn: UTRECHT",
    "salutationCode" : "01",
    "firstName" : "Anakin",
    "surname" : "Skywalker",
    "streetName" : "Tatooinestraat",
    "houseNumber" : "100",
    "houseNumberExtended" : "B",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "25whxgzlkmvotjhskwf5x27wlrldny@verkopen.test2.bol.com",
    "deliveryPhoneNumber" : "0612345678"
  },
  "billingDetails" : {
    "salutationCode" : "01",
    "firstName" : "Anakin",
    "surname" : "Skywalker",
    "streetName" : "Tatooinestraat",
    "houseNumber" : "100",
    "houseNumberExtended" : "B",
    "addressSupplement" : "A",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "3528 BJ",
    "city" : "UTRECHT",
    "countryCode" : "NL",
    "email" : "25whxgzlkmvotjhskwf5x27wlrldny@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "chamberOfCommerceNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  }
}

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

{
  "shipmentId" : 953266576,
  "pickUpPoint" : false,
  "shipmentDate" : "2018-04-20T19:10:19+02:00",
  "shipmentReference" : "Shipment2",
  "shipmentItems" : [ {
    "orderItemId" : "6107331383",
    "orderId" : "7616222700",
    "orderDate" : "2018-04-20T16:09:47+02:00",
    "latestDeliveryDate" : "2018-04-21T00:00:00+02:00",
    "ean" : "8712626055143",
    "title" : "Star Wars Prequel Trilogy",
    "quantity" : 1,
    "offerPrice" : 24.5,
    "offerCondition" : "GOOD",
    "offerReference" : "Test3",
    "fulfilmentMethod" : "FBR"
  } ],
  "transport" : {
    "transportId" : 356988715,
    "transporterCode" : "TNT",
    "trackAndTrace" : "3SBOLD1234567"
  },
  "customerDetails" : {
    "salutationCode" : "02",
    "firstName" : "Leia",
    "surname" : "Organa",
    "streetName" : "Alderaanweg",
    "houseNumber" : "100",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "2fjb3hdaioycvdscjnngqhmw5f5edk@verkopen.test2.bol.com",
    "company" : "Senator.nl"
  },
  "billingDetails" : {
    "salutationCode" : "02",
    "firstName" : "Leia",
    "surname" : "Organa",
    "streetName" : "Alderaanweg",
    "houseNumber" : "100",
    "houseNumberExtended" : "B",
    "addressSupplement" : "A",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "3528 BJ",
    "city" : "UTRECHT",
    "countryCode" : "NL",
    "email" : "2fjb3hdaioycvdscjnngqhmw5f5edk@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "chamberOfCommerceNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  }
}

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

{
  "shipmentId" : 953267579,
  "pickUpPoint" : false,
  "shipmentDate" : "2018-04-20T18:46:01+02:00",
  "shipmentReference" : "Shipment3",
  "shipmentItems" : [ {
    "orderItemId" : "6107432387",
    "orderId" : "7616222700",
    "orderDate" : "2018-04-20T16:09:47+02:00",
    "latestDeliveryDate" : "2018-04-21T00:00:00+02:00",
    "ean" : "8804269223123",
    "title" : "HJC Integraalhelm RPHA-11 Star Wars Kylo Ren-S",
    "quantity" : 1,
    "offerPrice" : 699.95,
    "offerCondition" : "NEW",
    "offerReference" : "Test2",
    "fulfilmentMethod" : "FBR"
  } ],
  "transport" : {
    "transportId" : 356988715,
    "transporterCode" : "TNT",
    "trackAndTrace" : "3SBOLD1234567"
  },
  "customerDetails" : {
    "salutationCode" : "02",
    "firstName" : "Leia",
    "surname" : "Organa",
    "streetName" : "Alderaanweg",
    "houseNumber" : "100",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "2fjb3hdaioycvdscjnngqhmw5f5edk@verkopen.test2.bol.com",
    "company" : "Senator.nl"
  },
  "billingDetails" : {
    "salutationCode" : "02",
    "firstName" : "Leia",
    "surname" : "Organa",
    "streetName" : "Alderaanweg",
    "houseNumber" : "100",
    "houseNumberExtended" : "B",
    "addressSupplement" : "A",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "3528 BJ",
    "city" : "UTRECHT",
    "countryCode" : "NL",
    "email" : "2fjb3hdaioycvdscjnngqhmw5f5edk@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "chamberOfCommerceNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  }
}

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

{
  "shipmentId" : 953316694,
  "pickUpPoint" : false,
  "shipmentDate" : "2018-04-20T09:33:11+02:00",
  "shipmentReference" : "Shipment4",
  "shipmentItems" : [ {
    "orderItemId" : "6702312887",
    "orderId" : "4616526971",
    "orderDate" : "2018-04-20T09:33:11+02:00",
    "latestDeliveryDate" : "2018-04-21T00:00:00+02:00",
    "ean" : "8804269223123",
    "title" : "HJC Integraalhelm RPHA-11 Star Wars Kylo Ren-S",
    "quantity" : 1,
    "offerPrice" : 699.95,
    "offerCondition" : "NEW",
    "offerReference" : "Test2",
    "fulfilmentMethod" : "FBR"
  } ],
  "transport" : {
    "transportId" : 356567193,
    "transporterCode" : "DPD",
    "trackAndTrace" : "543211234567",
    "shippingLabelCode" : "PLR00000009"
  },
  "customerDetails" : {
    "salutationCode" : "01",
    "firstName" : "Han",
    "surname" : "Solo",
    "streetName" : "Corelliaweg",
    "houseNumber" : "100",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "2pyshjc6ppxbrot5ek4ipiogcjgggo@verkopen.test2.bol.com"
  },
  "billingDetails" : {
    "salutationCode" : "01",
    "firstName" : "Han",
    "surname" : "Solo",
    "streetName" : "Corelliaweg",
    "houseNumber" : "100",
    "houseNumberExtended" : "B",
    "addressSupplement" : "A",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "3528 BJ",
    "city" : "UTRECHT",
    "countryCode" : "NL",
    "email" : "2pyshjc6ppxbrot5ek4ipiogcjgggo@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "chamberOfCommerceNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  }
}

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

{
  "shipmentId" : 953992381,
  "pickUpPoint" : false,
  "shipmentDate" : "2018-04-20T17:10:05+02:00",
  "shipmentReference" : "Shipment5",
  "shipmentItems" : [ {
    "orderItemId" : "6107989317",
    "orderId" : "7616247328",
    "orderDate" : "2018-04-20T12:58:39+02:00",
    "latestDeliveryDate" : "2018-04-21T00:00:00+02:00",
    "ean" : "8718526069334",
    "title" : "Star Wars - Nappy Star wars T-shirt - XL",
    "quantity" : 1,
    "offerPrice" : 25.0,
    "offerCondition" : "NEW",
    "offerReference" : "Test4",
    "fulfilmentMethod" : "FBB"
  } ],
  "transport" : {
    "transportId" : 356972369,
    "transporterCode" : "TNT",
    "trackAndTrace" : "3SCOLD1234567"
  },
  "customerDetails" : {
    "salutationCode" : "01",
    "firstName" : "Chewbakka",
    "surname" : "Wookiee",
    "streetName" : "Kashyyykstraat",
    "houseNumber" : "100",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "2awq74thj24b7rsxqubtvl3v3efq66@verkopen.test2.bol.com"
  },
  "billingDetails" : {
    "salutationCode" : "01",
    "firstName" : "Chewbakka",
    "surname" : "Wookiee",
    "streetName" : "Kashyyykstraat",
    "houseNumber" : "100",
    "houseNumberExtended" : "B",
    "addressSupplement" : "A",
    "extraAddressInformation" : "Extra informatie",
    "zipCode" : "3528 BJ",
    "city" : "UTRECHT",
    "countryCode" : "NL",
    "email" : "2awq74thj24b7rsxqubtvl3v3efq66@verkopen.test2.bol.com",
    "company" : "Pieter Post",
    "vatNumber" : "NL123456789B01",
    "chamberOfCommerceNumber" : "99887766",
    "orderReference" : "Mijn order ref"
  }
}