Search

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

This API allows partners to find specific transactions or all transactions for a customer that they are authorised 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.

Query Params

offset

number

Pagination offset of search results

size

number

The max number of search results.

Body Params

status

string

required

Defaults to ACTIVE

instance

string

required

Defaults to DOCHUB

essDocs Query instance. This indicates the system from which the relevant result is to be fetched.

transactionId

string

A unique transaction id associated with the setId

parcelRef

string

External parcel reference number set by the Exporter

shipmentRef

string

Shipment reference set by the exporter during creation of a shipment

destinationName

string

Filter to extract shipment based on the provided destination name

cargoName

string

Implied cargo name against the shipment

billOfLadingNumber

string

Bill of Lading number associated with the shipment

billOfLadingDate

string

BoL generation date in YYYY-MM-DD format

billOfLadingDateRange

array of strings

To filter the results based on the BoL date. Required format is YYYY-MM-DD

billOfLadingDateRange

consignorCompanyName

string

Shipment consignor company name

consigneeCompanyName

string

Shipment current consignee company name

toOrder

boolean

Indicates a flag to order the result in ascending order. Set to true if the result is to be ordered

loadPort

string

Shipment loading port

vesselName

string

Shipping vessel name

Responses

400

Bad Request

401

Unauthorized

403

Forbidden access denied config issue

500

Internal Server Error

503

Service Unavailable

200Parcel success response

defaultunexpected error