Queue Messages

Here is the standard message definition for a relevant customer queue that can be parsed to fetch information like customers, actions, messages, and operational dates.

Parcels Status Queue

Queue Sample Name: Parcels_Status_Queue_Prod_0a2b38f1-44e4-11e9-9ed6-0a24491b68de

  "newStatus": "TRANSFER_DRAFTED",
  "parcelReference": "Test-28 - New - Copy",
  "customerId": "2838651e-3f2d-11e9-96a8-9cb6d0ecd454",
  "action": "DRAFT_TRANSFER",
  "updatedDate": "Fri Mar 04 14:19:37 GMT 2022",
  "message": "The parcel status has been updated",
  "user": "zValeUser1",
  "transactionId": "869e00d6-0ee6-48ac-93ec-ab2df44440c7",
  "setId": "35ad6b2b-9845-4e01-b354-9c6029babce4"

Document Status

The Parcels Status Queue will have additional information about the documents appended to the shipment. This information will only be visible when APPROVE_COLLAB action applies in DocHub only. Here is what the JSON looks like.

  "shipmentReference": "Shipment 1",
  "instance": "DocHub",
  "newStatus": "DRAFTED",
  "parcelReference": "P1",
  "documents": [
      "documentDate": "2018-05-21 15:03:06.661",
      "documentId": "213feede-4421-11e9-9854-9cb6d0ecd454",
      "documentStatus": "Collaborating",
      "documentLocked": false,
      "documentName": "Bill of Exchange"
      "documentDate": "2018-05-21 15:03:06.661",
      "documentId": "213fef68-4421-11e9-9854-9cb6d0ecd454",
      "documentStatus": "To be finalised",
      "documentLocked": false,
      "documentName": "Certificate Instructions"
  "customerId": "28377d11-3f2d-11e9-96a8-9cb6d0ecd454",
  "action": "APPROVE_COLLAB",
  "setId": "ed98e69f-23db-11e9-9cad-9cb6d0ecd454",
  "updatedDate": "Fri Mar 17 17:26:20 GMT 2023",
  "message": "The set status has been updated",
  "user": "zBhpUser1",
  "transactionId": "7c1bfdc8-4421-11e9-9854-9cb6d0ecd454"

The documents array consist of of document object that provide all the appended documents against shipment during APPROVE_COLLAB action.

  • documentDate: Date-Time field indicating the stamp when the document was uploaded.
  • documentId: essDOCS generated document ID.
  • documentStatus: Indicates current document status.
  • documentLocked: Boolean indicator to verify if the document is locked or not. Document is locked if it is being used by other user.
  • documentName: Document name set during the uploading process.

Queue Parameter Description

Queue Response ParameterDescription
customerIdCustomer unique id who is actually the sender.
actionThe action related to the parcel. This can be one of the actions as available in Available Actions.
messageCustom message set over the package.
updatedDateLast package transition date.
parcelReferenceSystem reference number for the parcel.
userUser details who last operated over the parcel.
transactionIdUnique transaction id generated by the system.
setIdThe unique parcel id.
newStatusCurrent parcel status.
instanceessDocs application instance to track down the parcel. e.g. DocHub, DocEx, etc.