About Issuer API

Issuer Exchange API handles all relevant operations required by Line/NVOCC Customers/Future Warehouse. Some endpoints are regularly used whereas a couple of the endpoints are needed to be executed as required. Several Action endpoints use can use to Action over a transaction (or more specifically the eBoL/eWW/etc. in a set of documents). Due to the value of these documents (eBoLs, etc.), and to avoid cross-platform liabilities, essDOCS employs a Verified by CargoDocs step, which requires the user to confirm any step before it is actioned.

Token

Endpoint	Type	Description
Token	GET	Developers can utilize this endpoint to generate authentication token which is used to execute the remaining endpoints throughout the API.

As Required

Endpoints under this, are required whenever the issuer needs to update as demanded to ensure all the values in terms of IDs are updated.

Endpoint	Type	Description
Get Employee	GET	This endpoint allows the Partner to collect the Employee details for parties to action a set of electronic documents and for auditing purposes.
Shipper Consignee Bearer	GET	This API allows the carriers to match their consignee names to Consignees signed up to transfer eBoLs in CargoDocs. Note that this API is not required if the eBoL is a Bearer eBoL and the eBoL is issued to the shipper.

Origin/Export Team

Endpoint	Type	Description
Import Bol	POST	This endpoint allows you to import BoL/SWB data using Json (CargoDocs format). On upload of the Json, the carrier will receive the Set-id response, which is the UUID for the BoL/SWB.
Search	POST	This API allows issuers to find specific transactions or all transactions for a customer that they are authorized to download / manage. It always returns a list of set DTOs, which includes set_id & transaction_id; and set meta data If search result is unique, then will return document XML data and document_ids along with DTO.
Copy Bol	GET	This endpoint allows a issuer to download a copy of documents within a set. If the customer holds the original eBoL, the partner can download a version of the BoL watermarked Original in CargoDocs.
Sign Issue Bol	POST	This is a Set Action endpoint that is used for different actions through out the API for different purposes. This endpoint has a relevant request body to Sign and Issue Bol to a third party.
Re-Issue	POST	This is a Set Action endpoint that is used for different actions through out the API for different purposes. This endpoint has a relevant request body to re-issue the existing Bol.
Accept Request	POST	This is a Set Action endpoint that is used for different actions through out the API for different purposes. This endpoint has a relevant request body to accept Bol request.
Convert Bol	POST	This is a Set Action endpoint that is used for different actions through out the API for different purposes. This endpoint has a relevant request body to convert Bol for next stage.
Reject Request	POST	This is a Set Action endpoint that is used for different actions through out the API for different purposes. This endpoint has a relevant request body to Reject Bol request.

Destination/Import Team

Endpoint	Type	Description
Convert Bol [Destination Team]	POST	This is a Set Action endpoint that is used for different actions through out the API for different purposes. This endpoint has a relevant request body to convert Bol to next stage if assigned to Destination Team already.
Accomplish [UNDER DEVELOPMENT]	POST	N/A
Return [UNDER DEVELOPMENT]	POST	N/A