Import Bol

post

https://api-test.cargodocs.com/v3/common/shipments/{importRef}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

importRef

string

required

Shipper Id

Body Params

shipmentReference

string

Unique shipment reference number

shipmentType

string

Possible shipment type for this post

autoCollaboration

boolean

sets

array of objects

Sets in transit details

sets

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden access denied config issue

500

Internal Server Error

503

Service Unavailable

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Parcel success response