Import Bol

post https://api-test.cargodocs.com/v3/common/import/

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.

Query Params

importRef

string

required

Import reference number by the Tanker

Body Params

instance

string

required

essDocs portla instance which is being used for this endpoint. Customers will be using DocHub

shipmentReference

string

Unique shipment reference number. This is usually same as importRef

shipmentType

string

Possible shipment type for this post

autoCollaboration

boolean

Usually set for issuers. Optional for Tankers

sets

array of objects

Sets in transit details

sets

signatories

array of objects

This object defines the uploadable documents associated with there relevant signatories in terms of role.

signatories

externalReference

string

Shipment external referencee

locale

string

Langugae details

quantityFormat

string

Quantity format used through out the api

vessel

object

Shipment vessel details object

voyageReference

string

Voyage standard reference number

exportReference

string

Shipment export reference number

shipAgent

object

Shipping agent detail object

freightForwarder

object

inspector

object

Inspection officer assigned to the shipment

serviceTypeAtReceipt

string

serviceTypeAtDelivery

string

loadType

string

masterName

string

Shipment assigned master

Responses

400

Bad Request

401

Unauthorized

403

Forbidden access denied config issue

500

Internal Server Error

503

Service Unavailable

200Parcel success response