Bulkchain User Documentation
Bulkchain User Documentation
Breadcrumbs

API endpoint per feature for LSP

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

Create terminal delivery order

POST /v1/tdos

Get terminal delivery order(s)

GET /v1/tdos

Update general TDO info

PUT /v1/tdos/{tdoKey}

Deletion of the terminal delivery order

DELETE /v1/tdos/{tdoKey}

Stock Keeping Unit

Add new SKU

POST /v1/skus

Get stock keeping unit(s)

GET /v1/skus

Delete SKU

DELETE /v1/skus/{skuKey}

Update SKU info

PUT /v1/skus/{skuKey}

Add goods condition to SKU

POST /v1/skus/{skuKey}/goodsconditions

Visit

Add new visit in the terminal delivery order

POST /v1/tdos/{tdoKey}/visits

Get visit(s)

GET /v1/tdos/{tdoKey}/visits

Delete visit

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

Update visit info

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

(Un)assign SKU to visit

PUT /v1/tdos/{tdoKey]/visits/{visitKey}/skus

Vessel Load Order

Create vessel load order

POST /v1/vlos

Get vessel load order(s)

GET /v1/vlos

Update general VLO info

PUT /v1/vlos/{vloKey}

(Un)assign SKU’s

PUT /v1/vlos/{vloKey}/skus

Share VLO with Ship Agent

PUT /v1/vlos/{vloKey}/state

Delete vessel load order

DELETE /v1/vlos/{vloKey}