Bulkchain User Documentation
Bulkchain User Documentation
Breadcrumbs

API endpoint per feature for TO

This section describes the different API endpoints made available by Bulkchain. To facilitate development of the integration with Bulkchain, a set of OpenAPI specifications are available for each API endpoint: https://documentation.nxtport.com/bulkchain/open-api-specification-swagger.

Depending on the environment you would like to access, please add following prefix to the URL:

Category

Feature

API endpoint

Terminal Delivery Order

Get terminal delivery order(s)

GET /v1/tdos

Update general TDO info

PATCH /v1/tdos/{tdoKey}

Stock Keeping Unit

Get stock keeping unit(s)

GET /v1/skus

Update of the stock keeping unit during the terminal stay

PUT /v1/skus/{skuKey}

Add goods condition to SKU

POST /v1/skus/{skuKey}/goodsconditions

Package Codes

Get package codes

GET /v1/package-codes

Visit

Get visit(s)

GET /v1/tdos/{tdoKey}/visits

Update visit info

PATCH /v1/tdos/{tdoKey}/visits/{visitKey}

Terminal Delivery Confirmation

Terminal delivery confirmation

POST /v1/tdcs

Vessel Load Order

Get vessel load order(s)

GET /v1/vlos

Set state to Mate's Receipt

PUT /v1/vlos/{vloKey}/state

Set state to Final Mate's Receipt

PUT /v1/vlos/{vloKey}/state

Reject VLO to Ship Agent

PUT /v1/vlos/{vloKey}/state