v3 - Inbounds - Demo Endpoints

Get delivery windows

This ‘Fulfillment by bol.com’ (FBB) specific endpoint lets you retrieve the available timeslots for a shipment of articles to the bol.com warehouse. This information is used in the Create Inbound Shipment endpoint. This endpoint only accepts parameters “?delivery-date=2018-05-31&items-to-send=1”, which are mandatory for functionality on demo. Using any other values for these parameters will result in an internal server error.

GET /retailer-demo/inbounds/delivery-windows?delivery-date=2018-05-31&items-to-send=1

  • 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

{
  "timeSlots" : [ {
    "start" : "2018-05-31T00:00:00+02:00",
    "end" : "2018-05-31T01:00:00+02:00"
  }, {
    "start" : "2018-05-31T01:00:00+02:00",
    "end" : "2018-05-31T02:00:00+02:00"
  }, {
    "start" : "2018-05-31T02:00:00+02:00",
    "end" : "2018-05-31T03:00:00+02:00"
  }, {
    "start" : "2018-05-31T03:00:00+02:00",
    "end" : "2018-05-31T04:00:00+02:00"
  }, {
    "start" : "2018-05-31T04:00:00+02:00",
    "end" : "2018-05-31T05:00:00+02:00"
  }, {
    "start" : "2018-05-31T05:00:00+02:00",
    "end" : "2018-05-31T06:00:00+02:00"
  }, {
    "start" : "2018-05-31T06:00:00+02:00",
    "end" : "2018-05-31T07:00:00+02:00"
  }, {
    "start" : "2018-05-31T07:00:00+02:00",
    "end" : "2018-05-31T08:00:00+02:00"
  }, {
    "start" : "2018-05-31T08:00:00+02:00",
    "end" : "2018-05-31T09:00:00+02:00"
  }, {
    "start" : "2018-05-31T09:00:00+02:00",
    "end" : "2018-05-31T10:00:00+02:00"
  }, {
    "start" : "2018-05-31T10:00:00+02:00",
    "end" : "2018-05-31T11:00:00+02:00"
  }, {
    "start" : "2018-05-31T11:00:00+02:00",
    "end" : "2018-05-31T12:00:00+02:00"
  }, {
    "start" : "2018-05-31T12:00:00+02:00",
    "end" : "2018-05-31T13:00:00+02:00"
  }, {
    "start" : "2018-05-31T13:00:00+02:00",
    "end" : "2018-05-31T14:00:00+02:00"
  }, {
    "start" : "2018-05-31T14:00:00+02:00",
    "end" : "2018-05-31T15:00:00+02:00"
  }, {
    "start" : "2018-05-31T15:00:00+02:00",
    "end" : "2018-05-31T16:00:00+02:00"
  }, {
    "start" : "2018-05-31T16:00:00+02:00",
    "end" : "2018-05-31T17:00:00+02:00"
  }, {
    "start" : "2018-05-31T17:00:00+02:00",
    "end" : "2018-05-31T18:00:00+02:00"
  }, {
    "start" : "2018-05-31T18:00:00+02:00",
    "end" : "2018-05-31T19:00:00+02:00"
  }, {
    "start" : "2018-05-31T19:00:00+02:00",
    "end" : "2018-05-31T20:00:00+02:00"
  }, {
    "start" : "2018-05-31T20:00:00+02:00",
    "end" : "2018-05-31T21:00:00+02:00"
  }, {
    "start" : "2018-05-31T21:00:00+02:00",
    "end" : "2018-05-31T22:00:00+02:00"
  }, {
    "start" : "2018-05-31T22:00:00+02:00",
    "end" : "2018-05-31T23:00:00+02:00"
  }, {
    "start" : "2018-05-31T23:00:00+02:00",
    "end" : "2018-05-31T00:00:00+02:00"
  } ]
}

Get FBB transporter list

This ‘Fulfillment by bol.com’ (FBB) specific endpoint lets you retrieve a list of all possible transporters you can use to ship to the bol.com warehouse. In order to create an inbound you will need one of the available transporter options.

GET /retailer-demo/inbounds/fbb-transporters

  • 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

{
  "fbbTransporters" : [ {
    "name" : "Ad Dollevoet",
    "code" : "Ad Dollevoet"
  }, {
    "name" : "Barsan",
    "code" : "Barsan"
  }, {
    "name" : "Beentjes",
    "code" : "Beentjes"
  }, {
    "name" : "Boers",
    "code" : "Boers"
  }, {
    "name" : "Bosman",
    "code" : "Bosman"
  }, {
    "name" : "Centraal Boekhuis",
    "code" : "Centraal Boekhuis"
  }, {
    "name" : "Claassen",
    "code" : "Claassen"
  }, {
    "name" : "Dachser",
    "code" : "Dachser"
  }, {
    "name" : "DHL",
    "code" : "DHL"
  }, {
    "name" : "DPD",
    "code" : "DPD"
  }, {
    "name" : "Driesen",
    "code" : "Driesen"
  }, {
    "name" : "Duuren",
    "code" : "Duuren"
  }, {
    "name" : "Eck",
    "code" : "Eck"
  }, {
    "name" : "Fedex",
    "code" : "Fedex"
  }, {
    "name" : "Fiege",
    "code" : "Fiege"
  }, {
    "name" : "Geodis",
    "code" : "Geodis"
  }, {
    "name" : "GLS",
    "code" : "GLS"
  }, {
    "name" : "Hoek Transport",
    "code" : "Hoek Transport"
  }, {
    "name" : "JWA carrier",
    "code" : "JWA"
  }, {
    "name" : "Melis",
    "code" : "Melis"
  }, {
    "name" : "OHL International",
    "code" : "OHL"
  }, {
    "name" : "PostNL",
    "code" : "PostNL"
  }, {
    "name" : "Promese",
    "code" : "Promese"
  }, {
    "name" : "De Rooy",
    "code" : "Rooy"
  }, {
    "name" : "Schenker ",
    "code" : "Schenker "
  }, {
    "name" : "Transmission",
    "code" : "Transmission"
  }, {
    "name" : "UPS",
    "code" : "UPS"
  }, {
    "name" : "v.d. Heuvel Transport /  Nedpak",
    "code" : "v.d. Heuvel Transport /  Nedpak"
  }, {
    "name" : "Van Maanen",
    "code" : "Van Maanen"
  }, {
    "name" : "Versteijnen",
    "code" : "Versteijnen"
  }, {
    "name" : "Vonk",
    "code" : "Vonk"
  }, {
    "name" : "Wanrooij",
    "code" : "Wanrooij"
  }, {
    "name" : "z_Bloktijden",
    "code" : "z_Bloktijden"
  } ]
}

Get inbound by inbound id

This ‘Fulfillment by bol.com’ (FBB) specific endpoint lets you retrieve a specific inbound shipment by using the inbound id 5850051250.

GET /retailer-demo/inbounds/5850051250

  • 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

{
  "id" : 5850051250,
  "reference" : "ZENDINGLVB1GVR",
  "creationDate" : "2018-04-03T14:59:52+02:00",
  "state" : "ArrivedAtWH",
  "labellingService" : false,
  "announcedBSKUs" : 1,
  "announcedQuantity" : 5,
  "receivedBSKUs" : 1,
  "receivedQuantity" : 5,
  "timeSlot" : {
    "start" : "2018-04-05T12:00:00+02:00",
    "end" : "2018-04-05T17:00:00+02:00"
  },
  "products" : [ {
    "ean" : "8718526069334",
    "bsku" : "2950003119187",
    "announcedQuantity" : 5,
    "receivedQuantity" : 1,
    "state" : "Announced"
  } ],
  "stateTransitions" : [ {
    "state" : "ArrivedAtWH",
    "stateDate" : "2018-04-05T14:15:22+02:00"
  }, {
    "state" : "PreAnnounced",
    "stateDate" : "2018-04-03T15:11:45+02:00"
  }, {
    "state" : "Draft",
    "stateDate" : "2018-04-03T14:59:52+02:00"
  } ],
  "fbbTransporter" : {
    "name" : "UPS",
    "code" : "UPS"
  }
}

Get inbound shipment list

This ‘Fulfillment by bol.com’ (FBB) specific endpoint returns a list of your inbound shipments with new stock to the bol.com warehouse. The list is paged, though the demo environment only contains 1 page with 1 shipment. The GET single inbound endpoint can be used for a more detailed response.

GET /retailer-demo/inbounds

  • 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

{
  "inbounds" : [ {
    "id" : 5850051250,
    "reference" : "ZENDINGLVB1GVR",
    "creationDate" : "2018-04-03T14:59:52+02:00",
    "state" : "ArrivedAtWH",
    "labellingService" : false,
    "announcedBSKUs" : 1,
    "announcedQuantity" : 5,
    "receivedBSKUs" : 1,
    "receivedQuantity" : 5,
    "timeSlot" : {
      "start" : "2018-04-05T12:00:00+02:00",
      "end" : "2018-04-05T17:00:00+02:00"
    },
    "fbbTransporter" : {
      "name" : "UPS",
      "code" : "UPS"
    }
  } ]
}

Retrieve ‘Fulfillment by bol.com’ (FBB) shipping label

This endpoint is not available in demo.

GET /retailer-demo/inbounds/5850051250/shippinglabel

  • Request

  • Response

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

This endpoint has no request body.

Content-Type: application/vnd.retailer.v3+pdf
Status: 200 OK

THIS IS A FAKE PDF FILE AND IS INTENDED FOR TESTING PURPOSES ONLY. For more information check our documentation on https://developers.bol.com

Retrieve ‘Fulfillment by bol.com’ (FBB) packinglist details

This endpoint is not available in demo.

GET /retailer-demo/inbounds/5850051250/packinglist

  • Request

  • Response

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

This endpoint has no request body.

Content-Type: application/vnd.retailer.v3+pdf
Status: 200 OK

THIS IS A FAKE PDF FILE AND IS INTENDED FOR TESTING PURPOSES ONLY. For more information check our documentation on https://developers.bol.com

Retrieve ‘Fulfillment by bol.com’ (FBB) product labels

This endpoint is not available in demo.

POST /retailer-demo/inbounds/productlabels

  • Request

  • Response

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

{
  "productLabels" : [ {
    "ean" : "0038781100893",
    "quantity" : 1
  }, {
    "ean" : "5030917058226",
    "quantity" : 2
  } ]
}

Content-Type: application/vnd.retailer.v3+pdf
Status: 200 OK

THIS IS A FAKE PDF FILE AND IS INTENDED FOR TESTING PURPOSES ONLY. For more information check our documentation on https://developers.bol.com

Create inbound shipment for FBB

This request creates a new inbound shipment of goods for your Fulfillment by bol.com inventory.

POST /retailer-demo/inbounds

  • Request

  • Response

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

{
  "reference" : "ZENDINGLVB1GVR",
  "timeSlot" : {
    "start" : "2018-04-05T12:00:00+02:00",
    "end" : "2018-04-05T17:00:00+02:00"
  },
  "fbbTransporter" : {
    "code" : "UPS",
    "name" : "UPS"
  },
  "labellingService" : "false",
  "products" : [ {
    "ean" : "8718526069334",
    "announcedQuantity" : 5
  } ]
}

Content-Type: application/vnd.retailer.v3+json
Status: 202 ACCEPTED

{
  "id" : 1,
  "eventType" : "CREATE_INBOUND",
  "description" : "Create an inbound with reference ZENDINGLVB1GVR.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:21:56+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}