v5 - Replenishments - Demo Endpoints

Retrieve a transport load carrier label

Retrieve a transport load carrier label for an existing replenishment.

GET /retailer-demo/replenishments/2312208179/load-carrier-labels

  • Request

  • Response

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

This endpoint has no request body.

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

Status: 200 OK

PDFCONTENT

Retrieve a generated pick list

Retrieve a generated pick list for an existing replenishment.

GET /retailer-demo/replenishments/2312208179/pick-list

  • Request

  • Response

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

This endpoint has no request body.

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

Status: 200 OK

PDFCONTENT

Retrieve replenishment list by state

Retrieve an existing replenishment based on the state.

GET /retailer-demo/replenishments?state=ANNOUNCED

  • 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

{
  "replenishments" : [ {
    "replenishmentId" : "2312208180",
    "reference" : "MYREF02",
    "creationDateTime" : "2021-01-20T11:55:32+01:00",
    "lines" : [ {
      "ean" : "0846127026185"
    } ]
  }, {
    "replenishmentId" : "2312208179",
    "reference" : "MYREF01",
    "creationDateTime" : "2021-01-20T11:35:33+01:00",
    "lines" : [ {
      "ean" : "8716393000627"
    }, {
      "ean" : "0846127026185"
    } ],
    "invalidLines" : [ {
      "type" : "UNKNOWN_FBB_PRODUCT"
    } ]
  } ]
}

Retrieve a drop off replenishment with 2 load carriers

Retrieve a drop off replenishment containing 2 load carriers that will be delivered at the warehouse of bol.com. Also includes one invalid line, caused by an unknown BSKU.

GET /retailer-demo/replenishments/2312208179

  • 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

{
  "replenishmentId" : "2312208179",
  "creationDateTime" : "2021-01-20T11:35:33+01:00",
  "reference" : "MYREF01",
  "labelingByBol" : true,
  "state" : "ANNOUNCED",
  "deliveryInformation" : {
    "expectedDeliveryDate" : "2021-01-22",
    "transporterCode" : "POSTNL",
    "destinationWarehouse" : {
      "streetName" : "Mechie Trommelenweg",
      "houseNumber" : "1",
      "zipCode" : "5145ND",
      "city" : "Waalwijk",
      "countryCode" : "NL",
      "attentionOf" : "t.a.v. bol.com"
    }
  },
  "numberOfLoadCarriers" : 2,
  "loadCarriers" : [ {
    "sscc" : "020001200000007628",
    "transportState" : "ANNOUNCED",
    "transportStateUpdateDateTime" : "2021-01-20T11:35:34+01:00"
  }, {
    "sscc" : "020001200000007635",
    "transportState" : "ANNOUNCED",
    "transportStateUpdateDateTime" : "2021-01-20T11:35:34+01:00"
  } ],
  "lines" : [ {
    "ean" : "8716393000627",
    "lineState" : "ANNOUNCED",
    "quantityAnnounced" : 2,
    "quantityReceived" : 0,
    "quantityInProgress" : 0,
    "quantityWithGradedState" : 0,
    "quantityWithRegularState" : 0
  }, {
    "ean" : "0846127026185",
    "lineState" : "ANNOUNCED",
    "quantityAnnounced" : 5,
    "quantityReceived" : 0,
    "quantityInProgress" : 0,
    "quantityWithGradedState" : 0,
    "quantityWithRegularState" : 0
  } ],
  "invalidLines" : [ {
    "type" : "UNKNOWN_FBB_PRODUCT",
    "quantityAnnounced" : 0,
    "quantityReceived" : 2,
    "quantityInProgress" : 0,
    "quantityWithGradedState" : 0,
    "quantityWithRegularState" : 0
  } ],
  "stateTransitions" : [ {
    "state" : "ANNOUNCED",
    "stateDateTime" : "2021-01-20T11:35:34+01:00"
  } ]
}

Retrieve a pick up replenishment with 1 load carrier

Retrieve a pick up replenishment containing 1 load carrier and 1 item that will be picked up at the pickup location.

GET /retailer-demo/replenishments/2312208180

  • 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

{
  "replenishmentId" : "2312208180",
  "creationDateTime" : "2021-01-20T11:55:32+01:00",
  "reference" : "MYREF02",
  "labelingByBol" : false,
  "state" : "ANNOUNCED",
  "deliveryInformation" : {
    "expectedDeliveryDate" : "2021-01-22",
    "transporterCode" : "POSTNL",
    "destinationWarehouse" : {
      "streetName" : "Mechie Trommelenweg",
      "houseNumber" : "1",
      "zipCode" : "5145ND",
      "city" : "Waalwijk",
      "countryCode" : "NL",
      "attentionOf" : "t.a.v. bol.com"
    }
  },
  "pickupAppointment" : {
    "commentToTransporter" : "Custom reference",
    "address" : {
      "streetName" : "Utrechtseweg",
      "houseNumber" : "99",
      "houseNumberExtension" : "A",
      "zipCode" : "3702AA",
      "city" : "Zeist",
      "countryCode" : "NL",
      "attentionOf" : "Station"
    },
    "pickupTimeSlot" : {
      "fromDateTime" : "2021-01-21T09:30:00+01:00",
      "untilDateTime" : "2021-01-21T11:30:00+01:00"
    }
  },
  "numberOfLoadCarriers" : 1,
  "loadCarriers" : [ {
    "sscc" : "020001200000007642",
    "transportLabelTrackAndTrace" : "3SJTXX116666423",
    "transportState" : "ANNOUNCED",
    "transportStateUpdateDateTime" : "2021-01-20T11:55:33+01:00"
  } ],
  "lines" : [ {
    "ean" : "0846127026185",
    "lineState" : "ANNOUNCED",
    "quantityAnnounced" : 1,
    "quantityReceived" : 0,
    "quantityInProgress" : 0,
    "quantityWithGradedState" : 0,
    "quantityWithRegularState" : 0
  } ],
  "stateTransitions" : [ {
    "state" : "ANNOUNCED",
    "stateDateTime" : "2021-01-20T11:55:32+01:00"
  } ]
}

Retrieve the available pick up timeslots for 2 load carriers

Retrieve a list of available timeslots for picking up the items from the retailer warehouse.

POST /retailer-demo/replenishments/pickup-time-slots

  • Request

  • Response

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

{
  "address" : {
    "streetName" : "Utrechtseweg",
    "houseNumber" : "99",
    "houseNumberExtension" : "A",
    "zipCode" : "3702 AA",
    "city" : "Zeist",
    "countryCode" : "NL"
  },
  "numberOfLoadCarriers" : 2
}

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

Status: 200 OK

{
  "timeSlots" : [ {
    "fromDateTime" : "2024-01-21T09:00:00+01:00",
    "untilDateTime" : "2024-01-21T11:00:00+01:00"
  }, {
    "fromDateTime" : "2024-01-21T09:30:00+01:00",
    "untilDateTime" : "2024-01-21T11:30:00+01:00"
  }, {
    "fromDateTime" : "2024-01-21T10:00:00+01:00",
    "untilDateTime" : "2024-01-21T12:00:00+01:00"
  }, {
    "fromDateTime" : "2024-01-21T15:00:00+01:00",
    "untilDateTime" : "2024-01-21T17:00:00+01:00"
  }, {
    "fromDateTime" : "2024-01-21T15:30:00+01:00",
    "untilDateTime" : "2024-01-21T17:30:00+01:00"
  }, {
    "fromDateTime" : "2024-01-21T16:00:00+01:00",
    "untilDateTime" : "2024-01-21T18:00:00+01:00"
  }, {
    "fromDateTime" : "2024-01-21T16:30:00+01:00",
    "untilDateTime" : "2024-01-21T18:30:00+01:00"
  } ]
}

Retrieve product labels for 2 items

Retrieve the product labels for two different EAN’s.

POST /retailer-demo/replenishments/product-labels

  • Request

  • Response

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

{
  "labelFormat" : "AVERY_J8159",
  "products" : [ {
    "ean" : "0846127026185",
    "quantity" : 5
  }, {
    "ean" : "8716393000627",
    "quantity" : 2
  } ]
}

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

Status: 200 OK

PDFCONTENT

Create a pick up replenishment with 1 load carrier and 1 item

Create a pick up replenishment that consists of 1 load carrier and 1 item, where the items will be labeled by the partner.

POST /retailer-demo/replenishments

  • Request

  • Response

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

{
  "reference" : "MYREF02",
  "pickupAppointment" : {
    "address" : {
      "streetName" : "Utrechtseweg",
      "houseNumber" : "99",
      "zipCode" : "3702 AA",
      "city" : "Zeist",
      "countryCode" : "NL",
      "attentionOf" : "Station"
    },
    "pickupTimeSlot" : {
      "fromDateTime" : "2024-01-21T09:30:00+01:00",
      "untilDateTime" : "2024-01-21T11:30:00+01:00"
    },
    "commentToTransporter" : "Custom reference"
  },
  "labelingByBol" : false,
  "numberOfLoadCarriers" : 1,
  "lines" : [ {
    "ean" : "0846127026185",
    "quantity" : 1
  } ]
}

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

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_REPLENISHMENT",
  "description" : "Create replenishment with reference 'MYREF02'.",
  "status" : "PENDING",
  "createTimestamp" : "2021-04-08T15:52:54+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Create a drop off replenishment with 2 load carriers and 2 items

Create a drop off replenishment that consists of 2 load carriers and 2 items, where the items will be labeled by bol.com.

POST /retailer-demo/replenishments

  • Request

  • Response

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

{
  "reference" : "MYREF01",
  "deliveryInfo" : {
    "expectedDeliveryDate" : "2024-02-01",
    "transporterCode" : "POSTNL"
  },
  "labelingByBol" : true,
  "numberOfLoadCarriers" : 2,
  "lines" : [ {
    "ean" : "0846127026185",
    "quantity" : 5
  }, {
    "ean" : "8716393000627",
    "quantity" : 2
  } ]
}

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

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_REPLENISHMENT",
  "description" : "Create replenishment with reference 'MYREF01'.",
  "status" : "PENDING",
  "createTimestamp" : "2021-04-08T15:52:54+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Cancel a replenishment

Cancel an already existing replenishment.

PUT /retailer-demo/replenishments/2312188192

  • Request

  • Response

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

{
  "state" : "CANCELLED"
}

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

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "2312188192",
  "eventType" : "UPDATE_REPLENISHMENT",
  "description" : "Update replenishment with replenishment id '2312188192'.",
  "status" : "PENDING",
  "createTimestamp" : "2021-04-08T15:52:54+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Update the expected delivery date

Update the expected delivery date for a drop off replenishment in case the earlier provided date is not feasible anymore.

PUT /retailer-demo/replenishments/2312188192

  • Request

  • Response

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

{
  "deliveryInfo" : {
    "expectedDeliveryDate" : "2024-01-29"
  }
}

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

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "2312188192",
  "eventType" : "UPDATE_REPLENISHMENT",
  "description" : "Update replenishment with replenishment id '2312188192'.",
  "status" : "PENDING",
  "createTimestamp" : "2021-04-08T15:52:54+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Add 4 load carriers to a replenishment

Add 4 load carriers to an existing replenishment.

PUT /retailer-demo/replenishments/2312188192

  • Request

  • Response

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

{
  "numberOfLoadCarriers" : 4
}

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

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "2312188192",
  "eventType" : "UPDATE_REPLENISHMENT",
  "description" : "Update replenishment with replenishment id '2312188192'.",
  "status" : "PENDING",
  "createTimestamp" : "2021-04-08T15:52:54+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Update the load carriers of a replenishment

Adjust the replenishment to two load carriers that already existed in the replenishment.

PUT /retailer-demo/replenishments/2312188192

  • Request

  • Response

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

{
  "numberOfLoadCarriers" : 2,
  "loadCarriers" : [ {
    "sscc" : "020001200000007703"
  }, {
    "sscc" : "020001200000007710"
  } ]
}

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

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "2312188192",
  "eventType" : "UPDATE_REPLENISHMENT",
  "description" : "Update replenishment with replenishment id '2312188192'.",
  "status" : "PENDING",
  "createTimestamp" : "2021-04-08T15:52:54+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}