v3 - Process status - Demo Endpoints

Generate a process-status 'PENDING' using entity id and event type

The demo environment is static and can therefore not actually confirm shipments. Use only the following entity id and event type to simulate a 'PENDING' process-status: 555551 and CONFIRM_SHIPMENT.

GET /retailer-demo/process-status/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

{
  "id" : 1,
  "entityId" : "555551",
  "eventType" : "CONFIRM_SHIPMENT",
  "description" : "This is a mocked process status.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:21:56.799+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Generate a process-status 'FAILURE' using entity id and event type

The demo environment is static and can therefore not actually change transports. Use only the following entity id and event type to simulate a 'FAILURE' process-status: 555554 and CHANGE_TRANSPORT.

GET /retailer-demo/process-status/4

  • 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" : 4,
  "entityId" : "555554",
  "eventType" : "CHANGE_TRANSPORT",
  "description" : "This is a mocked process status.",
  "status" : "FAILURE",
  "createTimestamp" : "2020-10-26T10:21:56.812+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/4",
    "method" : "GET"
  } ]
}

Generate a process-status 'TIMEOUT' using entity id and event type

The demo environment is static and can therefore not actually create an inbound packinglist. Use only the following entity id and event type to simulate a 'TIMEOUT' process-status: 555553 and CREATE_INBOUND.

GET /retailer-demo/process-status/3

  • 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" : 3,
  "entityId" : "555553",
  "eventType" : "CREATE_INBOUND",
  "description" : "This is a mocked process status.",
  "status" : "TIMEOUT",
  "createTimestamp" : "2020-10-26T10:21:56.824+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/3",
    "method" : "GET"
  } ]
}

Generate a process-status 'SUCCESS' using entity id and event type

The demo environment is static. To simulate retrieving a process-status you can use '2' in your process-status request to simulate a 'SUCCESS' status.

GET /retailer-demo/process-status/2

  • 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" : 2,
  "entityId" : "555552",
  "eventType" : "CANCEL_ORDER",
  "description" : "This is a mocked process status.",
  "status" : "SUCCESS",
  "createTimestamp" : "2020-10-26T10:21:56.834+01:00"
}

Generate a process-status 'SUCCESS'

The demo environment is static. To simulate retrieving a process-status you can use '2' in your process-status request to simulate a 'SUCCESS' status.

GET /retailer-demo/process-status/2

  • 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" : 2,
  "entityId" : "555552",
  "eventType" : "CANCEL_ORDER",
  "description" : "This is a mocked process status.",
  "status" : "SUCCESS",
  "createTimestamp" : "2020-10-26T10:21:56.848+01:00"
}

Generate a process-status 'TIMEOUT'

The demo environment is static. To simulate retrieving a process-status you can use '3' in your process-status request to simulate a 'TIMEOUT' status.

GET /retailer-demo/process-status/3

  • 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" : 3,
  "entityId" : "555553",
  "eventType" : "CREATE_INBOUND",
  "description" : "This is a mocked process status.",
  "status" : "TIMEOUT",
  "createTimestamp" : "2020-10-26T10:21:56.86+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/3",
    "method" : "GET"
  } ]
}

Generate a process-status 'FAILURE'

The demo environment is static. To simulate retrieving a process-status you can use '4' in your process-status request to simulate a 'FAILURE' status.

GET /retailer-demo/process-status/4

  • 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" : 4,
  "entityId" : "555554",
  "eventType" : "CHANGE_TRANSPORT",
  "description" : "This is a mocked process status.",
  "status" : "FAILURE",
  "createTimestamp" : "2020-10-26T10:21:56.87+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/4",
    "method" : "GET"
  } ]
}

Generate a process-status 'PENDING'

The demo environment is static. To simulate retrieving a process-status you can use '1' in your process-status request to simulate a 'PENDING' status.

GET /retailer-demo/process-status/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

{
  "id" : 1,
  "entityId" : "555551",
  "eventType" : "CONFIRM_SHIPMENT",
  "description" : "This is a mocked process status.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:21:56.879+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Generate process-statuses using a list of process-status id’s

The demo environment is static. Use the following process-status id’s to get a list of process-statuses: '1', '2', '3' and '4'.

POST /retailer-demo/process-status

  • Request

  • Response

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

{
  "processStatusQueries" : [ {
    "id" : 1
  }, {
    "id" : 2
  }, {
    "id" : 3
  }, {
    "id" : 4
  } ]
}

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

{
  "processStatuses" : [ {
    "id" : 1,
    "entityId" : "555551",
    "eventType" : "CONFIRM_SHIPMENT",
    "description" : "This is a mocked process status.",
    "status" : "PENDING",
    "createTimestamp" : "2020-10-26T10:21:56.898+01:00",
    "links" : [ {
      "rel" : "self",
      "href" : "http://api.bol.com/retailer-demo/process-status/1",
      "method" : "GET"
    } ]
  }, {
    "id" : 2,
    "entityId" : "555552",
    "eventType" : "CANCEL_ORDER",
    "description" : "This is a mocked process status.",
    "status" : "SUCCESS",
    "createTimestamp" : "2020-10-26T10:21:56.898+01:00"
  }, {
    "id" : 3,
    "entityId" : "555553",
    "eventType" : "CREATE_INBOUND",
    "description" : "This is a mocked process status.",
    "status" : "TIMEOUT",
    "createTimestamp" : "2020-10-26T10:21:56.898+01:00",
    "links" : [ {
      "rel" : "self",
      "href" : "http://api.bol.com/retailer-demo/process-status/3",
      "method" : "GET"
    } ]
  }, {
    "id" : 4,
    "entityId" : "555554",
    "eventType" : "CHANGE_TRANSPORT",
    "description" : "This is a mocked process status.",
    "status" : "FAILURE",
    "createTimestamp" : "2020-10-26T10:21:56.898+01:00",
    "links" : [ {
      "rel" : "self",
      "href" : "http://api.bol.com/retailer-demo/process-status/4",
      "method" : "GET"
    } ]
  } ]
}