Skip to content


API - Usage Methods

Linking Methods

Sequoia v1.74

LinkJobToAgentInventory

Links an Air Import inventory record to an Air Import job within sequoia.

Payload Schema / Return value
Request: LinkJobToAgentInventory.Xsd
Response (success): 'True'
Response (failure): See Error Reporting above

Transactions
Transactions are supported by specifying a TransactionId on the request.

Sequoia v1.74

LinkJobToDeclaration

Links a job to a declaration record in Sequoia.

Payload Schema / Return value
Request: LinkJobToDeclaration.xsd
Response (success): 'True'
Response (failure): See Error Reporting above

Notes
The type of job and type of declaration must be the same (i.e., an Export Job (Air or Ocean) can only be associated with an Export declaration type (EFD, ECR, etc)).

Transactions
Transactions are supported by specifying a TransactionId on the request.

Sequoia v1.74

LinkJobToShipment

Links a job to a shipment record within sequoia.

Payload Schema / Return value
Request: LinkJobToShipment.Xsd
Response (success): 'True'
Response (failure): See Error Reporting above

Notes
The type of job and type of shipment must be the same (i.e., an Air Export Job can only be associated with an Air Export Shipment).

Transactions
Transactions are supported by specifying a TransactionId on the request.

Sequoia v3.20

LinkShipmentToConsolidation

Links a shipment to a consolidation record within sequoia.

Payload Schema / Return value
Request: LinkShipmentToConsolidation.Xsd
Response (success): 'True'
Response (failure): See Error Reporting above

Notes
The type of shipment and type of consolidation must be the same (i.e., an Air Export Shipment can only be associated with an Air Export Consolidation).

Transactions
Transactions are supported by specifying a TransactionId on the request.

Sequoia v1.74

UnlinkJobFromAgentInventory

Removes the link between an Air Import job and an Air Import inventory record within Sequoia.

Payload Schema / Return value
Request: LinkJobToAgentInventory.Xsd
Response (success): 'True'
Response (failure): See Error Reporting above

Notes
Note that the schema is the same one used to link the two entities.

Transactions
Transactions are supported by specifying a TransactionId on the request.

Sequoia v1.74

UnlinkJobFromShipment

Removes the link between a job and a shipment record within sequoia.

Payload Schema / Return value
Request: LinkJobToShipment.Xsd
Response (success): 'True'
Response (failure): See Error Reporting above

Notes
Note that the schema is the same one used to link the two entities.

Transactions
Transactions are supported by specifying a TransactionId on the request.