Bulkchain User Documentation

Bulkchain v3.0.0

We are pleased to announce the release of Bulkchain version 3.0.0!

Release date

This version is released to UAT on [TBC].

Bulkchain users must validate the changes in this version, along with each user's most important business scenario’s. For any help regarding demo data to test those scenario’s, this can be requested via bulkchainsupport@nxtport.com.

This version is released to PRD on [TBC].

Improvements

API

Make sure to request the latest open API spec via bulkchainsupport@nxtport.com.

Object

Change

Operations

Role

Messages

Stock Keeping Unit

portOfDestination has been removed

Create SKU

Update SKU

Create VLO

Update VLO (assign SKU)

LSP

BCTV0006 - updated

BCBV0034 - removed

Stock Keeping Unit

numberOfSku and isBatch added as optional attributes to enable creation of SKU in batch. When a SKU batch is created, a batchKey will be generated which is mentioned in the notifications and can be used in following operations.

Create SKU as batch

LSP

TO

New success notification:

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

Stock Keeping Unit

New method has been added to update a SKU by its batchKey. In case the SKU belongs to a batch, it can only be updated by its batchKey.

PUT /v1/skus/batch/{batchKey}

Update SKU as batch

LSP

TO

SA

BCBV0044 - new

BCBV0045 - new

Stock Keeping Unit

New method has been added to update the numberOfSku for a batch.

PATCH /v1/skus/batch/{batchKey}/numberofsku

Update SKU as batch

LSP

BCBV0046 - new

Stock Keeping Unit

skuIdentificationCode should not be unique, business validation rule has been removed to support the creation of a SKU batch

Create SKU

Update SKU

LSP

TO

BCBV0003 - removed

Stock Keeping Unit

batchKey has been added as an optional query parameter

visitKey has been added as an optional query parameter

Response message has been extended with following properties:

  • batchKey

  • lspVisitReference

  • toVisitReference

  • lspTdoNxtEntityId

  • lspTdoReference

  • toTdoNxtEntityId

  • toTdoReference

Get SKU

LSP

TO

SA

/

Visit

Response message has been extended with following properties:

  • lspTdoReference

  • toTdoReference

Get Visit

LSP

TO

/

Vessel Load Order

portOfDestination has been replaced by portOfDischarge

Create VLO

Update VLO as LSP

Update VLO as SA

LSP

SA

BCTV0001

Vessel Load Order

Validation rule added that if a VLO containers dangerous SKU, that all SKU must be dangerous

Create VLO

Update VLO as LSP (assign SKU)

LSP

BCBV0041 - new

Vessel Load Order

shippingLine has been added as optional attribute

Create VLO

Update VLO as LSP

Update VLO as SA

LSP

SA

BCTV0001

Vessel Load Order

contactPerson and contactPhone have been added as optional attributes

Create VLO

Update VLO as LSP

LSP

BCTV0001

Package Code

Get method has been added to retrieve package codes. The synchronous response contains the list of codes and names according to CL017 in PN/TS. A package code must be added when creating a SKU.

Get Package Codes

LSP

SA

TO

/

Terminal

Get method has been added to retrieve terminals with a Bulkchain subscription. The synchronous response contains the nxtEntityId, name and terminalCodes

Get Terminals

LSP

SA

TO

/

UI

NxtPort is building a new User Interface that enhances the UX and therefore is more future-proof. Following features have been developed so far and are available in this version:

Feature

Role

Terminal Delivery Order (TDO) list

LSP, TO

Add new TDO

LSP

TDO detail

LSP, TO

Edit / delete TDO

LSP

Add Stock Keeping Unit (SKU) to TDO

LSP

Add Visit to TDO

LSP

Assign SKU to Visit

LSP

SKU detail

LSP, TO

Edit SKU

LSP, TO

Delete SKU

LSP

Visit detail

LSP, TO

Edit / delete Visit

LSP

Vessel Load Order (VLO) list

LSP, TO and SA

Add new VLO

LSP

The URL to access the UI remains identical. Which is Bulkchain for UAT.

Terminal Delivery Order (TDO) list

image-20261001-101240.png

Add new TDO

image-20261001-101543.png

TDO detail

image-20261001-102459.png

Edit / delete TDO

image-20261001-123549.png

Add Stock Keeping Unit (SKU) to TDO

image-20261001-102322.png

Add Visit to TDO

image-20261001-101902.png

Assign SKU to Visit

image-20261001-102424.png

SKU detail

image-20261001-102557.png

Edit SKU

image-20261001-123447.png

Delete SKU

image-20261001-123515.png

Visit detail

image-20261001-103820.png

Edit / delete Visit

image-20261001-123644.png

Vessel Load Order (VLO) list

image-20261001-101100.png

Add new VLO

image-20261001-192318.png