Search for Available Sets

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

customerIds

array of strings

required

customerIds*

status

string

required

Defaults to ACTIVE

List of available status for the shipment

ALL - All Parcels from Inbox & Filed
ACTIVE - Parcels from Inbox Only
FILED - Parcels from Filed Only
AMENDMENT_CANCELLED - Exported or Importer Raised RFA(Recut or Split) and has an option to Cancel RFA then we have Copy of AMENDMENT_CANCELLED at FILED .
AMENDMENT_ISSUED - Exported or Importer Raised RFA(Recut or Split) and Carrier Accept RFA , The Importer or Exporter Who raised RFA ,then we have Copy of AMENDMENT_ISSUED at FILED
AMENDMENT_REJECTED - Exported or Importer Raised RFA(Recut or Split) and Carrier REJECT RFA , The Importer or Exporter Who raised RFA ,then we have Copy of AMENDMENT_REJECTED at FILED
CONVERT_SENT - Title Holder sent a request to the Issuer(s) to convert the selected eDoc(s) to paper
CONVERTED - Converted the selected eDocs to Paper .eDoc(s) will be identified as 'Converted to Paper'
CORRECTING_DOCUMENT - Exporter Bank who has Title has Rejected one or more of Documents (Not BL) to Exporter by Partial Return , then Exporter Performed Accept the Rejection to correct the documents, then Status is CORRECTING_DOCUMENT in Inbox for Exporter
DOCUMENTS_REJECTED - Exporter Bank who has Title has Rejected one or more of Documents (Not BL)to Exporter by Partial Return , then Exporter Bank has Status DOCUMENTS_REJECTED in Inbox
DOCUMENTS_RETURNED - Exporter Bank who has Title has Rejected one or more of Documents (Not BL) to Exporter by Partial Return , then Exporter has Status DOCUMENTS_RETURNED in Inbox
ENDORSEMENT_DRAFTED - Exporter Drafts Presentation then the Parcel in a state of ENDORSEMENT_DRAFTED in INBOX
ENDORSEMENT_SIGNED - Exporter Signed Drafts Presentation then the Parcel in a state of ENDORSEMENT_SIGNED in INBOX
ENDORSEMENT_SENT - Exporter Sends the Signed Presentation then we have Parcel in a state of ENDORSEMENT_SENT in FILED
ENDORSEMENT_RETURNED - When Banks Performs Full Return of Parcel to Exporter ,Exporter status becomes ENDORSEMENT_RETURNED in INBOX & Bank status is ENDORSEMENT_RETURNED at FILED
PRODUCED - Title Holder Produces/Surrenders BL then has Status PRODUCED in FILED
TITLE_HELD - Party who has TITLE
VOIDED - Exporter or Importer Requested to VOID BL for Carrier & Carrier Accepted, then Exporter or Importer has Status VOIDED in FILED
VOID_REQUESTED - Exporter or Importer Requested to VOID BL for Carrier in INBOX
DRAFT - The shipment that are DRAFT or initiated by the exporter that is yet to be submitted for further processing.
SIGNING - All parcels that are assigned to the exporter for signing.
SIGNED - The parcel that are signed but not forwarded yet.
ISSUED - N/A
PAPER_FINALISED - N/A

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