Bulkchain User Documentation

Success notifications

Format

{
  "MessageHeader": {
    "MessageTimestamp": "{messageTimestamp}",
    "MessageId": "{messageId}",
    "CorrelationId": "{correlationId}"
  },
  "NotificationDate": "{notificationDate}",
  "EventType": "{eventType}",
  "Body": {
    "LspNxtEntityId": "{lspNxtEntityId}",
    "TdoKey": "{tdoKey}",
    "SkuKey": "{skuKey}",
    "Event": "{event}"
  }
}

Example

{
  "MessageHeader": {
    "MessageTimestamp": "2026-03-26T11:01:46.3663835+00:00",
    "MessageId": "9e5ee9ef-f76f-4603-a746-8c8ce9965801",
    "CorrelationId": "b6b45204-8f84-46d7-b0b0-27822cff048a"
  },
  "NotificationDate": "2026-03-26T11:01:46.3663836+00:00",
  "EventType": "CreateSkuSucceeded",
  "Body": {
    "LspNxtEntityId": "NXT25000016528",
    "TdoKey": "0749fd72-e1d9-4fb5-80a8-16f6f3274329",
    "SkuKey": "0c706548-243a-46e9-8f27-6f4b00b17c33",
    "Event": "A Terminal Delivery Order has been updated by the following Logistics Service Provider: NXT25000016528. A SKU has been added."
  }
}

Success notifications

Category

Event

EventType

Key(s)

Receivers

Reference

Terminal Delivery Order

A new Terminal Delivery Order has been created by [lspNxtEntityId]

CreateTdoSucceeded

tdoKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-Createterminaldeliveryorder

A Terminal Delivery Order has been deleted by the following Logistics Service Provider:[lspNxtEntityId].

DeleteTdoSucceeded

tdoKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-Deletionoftheterminaldeliveryorder

A Terminal Delivery Order has been updated by the following Logistics Service Provider:[lspNxtEntityId].

UpdateTdoAsLspSucceeded

tdoKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-Updategeneralterminaldeliveryorderinfo

A Terminal Delivery Order has been updated by the following Terminal Operator:[toNxtEntityId].

UpdateTdoAsToSucceeded

tdoKey

LSP, TO

https://documentation.nxtport.com/bulkchain/terminal-operator-integration-specifications#TerminalOperatorintegrationspecifications-Updategeneralterminaldeliveryorderinfo

Stock Keeping Unit

A Terminal Delivery Order has been updated by the following Logistics Service Provider:[lspNxtEntityId]. A SKU has been added.

CreateSkuSucceeded

tdoKey
skuKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-AddnewSKU

A Terminal Delivery Order has been updated by the following Logistics Service Provider:[lspNxtEntityId]. A SKU batch has been created.

CreateSkuBatchSucceeded

tdoKey

batchKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#Add-new-SKU

A Terminal Delivery Order has been updated by the following Logistics Service Provider:[lspNxtEntityId]. A SKU has been deleted.

DeleteSkuSucceeded

tdoKey
skuKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-DeleteSKU

A SKU has been updated by the following Logistics Service Provider:[lspNxtEntityId].

UpdateSkuSucceeded

skuKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-UpdateSKUinfo

A goods condition has been added to a SKU by the following Logistics Service Provider:[lspNxtEntityId].

CreateGoodsConditionsSucceeded

skuKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-AddgoodsconditiontoSKU

A SKU has been updated by the following Terminal Operator:[toNxtEntityId].

UpdateSkuAsToSucceeded

skuKey

LSP, TO, SA

https://documentation.nxtport.com/bulkchain/terminal-operator-integration-specifications#TerminalOperatorintegrationspecifications-Updateofthestockkeepingunitduringtheterminalstay

A goods condition has been added to a SKU by the following Terminal Operator:[toNxtEntityId].

CreateGoodsConditionsSucceeded

skuKey

LSP, TO, SA

https://documentation.nxtport.com/bulkchain/terminal-operator-integration-specifications#TerminalOperatorintegrationspecifications-Updateofthestockkeepingunitduringtheterminalstay

A SKU has been updated by the following Ship Agent:[NxtEntityId].

UpdateSkuAsSaSucceeded

skuKey

LSP, TO, SA


A SKU batch has been updated by the following Logistics Service Provider:[lspNxtEntityId].

UpdateSkuBatchSucceeded

batchKey

LSP, TO


A SKU batch has been updated by the following Terminal Operator:[toNxtEntityId].

UpdateSkuBatchSucceeded

batchKey

LSP, TO, SA


A SKU batch has been updated by the following Ship Agent:[NxtEntityId].

UpdateSkuBatchSucceeded

batchKey

LSP, TO, SA


The number of SKU for a batch has been updated by the following Logistics Service Provider:[lspNxtEntityId].

UpdateSkuBatchNumberOfSkuSucceeded

batchKey

LSP, TO


Vessel Load Order

A new Vessel Load Order has been created by Logistics Service Provider [lspNxtEntityId]. The state is set to "Draft".

CreateVloAsLspSucceeded

vloKey

LSP


A Vessel Load Order has been updated by the following Logistics Service Provider: [lspNxtEntityId].

UpdateVloAsLspSucceeded

vloKey

LSP


A Vessel Load Order has been shared by [performedByRole value to be provided here dynamically] with NxtEntityId [performedByNxtEntityId value to be provided here dynamically]. The state is set to [vloState value to be provided here dynamically].

UpdateVloStateSucceeded

vloKey

LSP, SA, TO


A Vessel Load Order has been updated by the following Logistics Service Provider: [lspNxtEntityId]. 1 or more SKU have been assigned.

ReplaceAssignedSkusToVloSucceeded

vloKey

LSP


A Vessel Load Order has been updated by the following Logistics Service Provider: [lspNxtEntityId]. 1 or more SKU have been unassigned.

ReplaceAssignedSkusToVloSucceeded

vloKey

LSP


A Vessel Load Order has been updated by the following Ship Agent: [NxtEntityId].

UpdateVloAsSaSucceeded

vloKey

SA, LSP


A Vessel Load Order has been rejected by [performedByRole value to be provided here dynamically] with NxtEntityId [performedByNxtEntityId value to be provided here dynamically]. The state is set to [vloState value to be provided here dynamically].

UpdateVloStateSucceeded

vloKey

SA, LSP, TO


A Vessel Load Order has been deleted by the following Logistics Service Provider: [lspNxtEntityId].

DeleteVloSucceeded

vloKey

LSP (SA and TO depending on the Vessel Load Order state)


Visit

A Terminal Delivery Order has been updated by the following Logistics Service Provider:[lspNxtEntityId]. A visit has been added.

CreateVisitSucceeded

tdoKey

visitKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-Addnewvisitintheterminaldeliveryorder

A Terminal Delivery Order has been updated by the following Logistics Service Provider:[lspNxtEntityId]. A visit has been deleted.

DeleteVisitSucceeded

tdoKey

visitKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-Deletevisitintheterminaldeliveryorder

A Terminal Delivery Order has been updated by the following Logistics Service Provider:[lspNxtEntityId]. A visit has been updated.

UpdateVisitAsLspSucceeded

tdoKey

visitKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-Updatevisitinfointheterminaldeliveryorder

A Terminal Delivery Order has been updated by the following Terminal Operator:[toNxtEntityId]. A visit has been updated.

UpdateVisitAsToSucceeded

tdoKey

visitKey

LSP, TO

https://documentation.nxtport.com/bulkchain/terminal-operator-integration-specifications#TerminalOperatorintegrationspecifications-Updatevisitinfointheterminaldeliveryorder

A Terminal Delivery Order has been updated by the following Logistics Service Provider: [lspNxtEntityId]. Assigned SKUs for the visit have been updated.

ReplaceAssignedSkusToVisitSucceeded

tdoKey

visitKey

LSP, TO

https://documentation.nxtport.com/bulkchain/logistics-service-provider-integration-specificati#LogisticsServiceProviderintegrationspecifications-UnassignSKUfromvisitintheterminaldeliveryorder

Terminal Delivery Confirmation

A new Terminal Delivery Confirmation has been created by [toNxtEntityId].

CreateTdcSucceeded

tdoKey

tdcKey

visitKey

LSP, TO

https://documentation.nxtport.com/bulkchain/terminal-operator-integration-specifications#TerminalOperatorintegrationspecifications-Terminaldeliveryconfirmation