API - Usage Methods
Shipment Methods
CreateShipment
Creates a Shipment record in Sequoia.
| Payload | Schema / Return value |
|---|---|
| Request: | Shipment.xsd |
| Response (success): | A string representing the shipment reference |
| Response (failure): | See Error Reporting above |
Usage
ShipmentReference is an auto generated field and should not be specified in the request. FhlStatus and FhlStatusDateTime cannot be used in this method - if supplied they will be ignored.
Transactions
Transactions are supported by specifying a TransactionId on the request.
DeleteShipment
Deletes the Shipment record indicated either by the internal shipment reference or the consignment details (Master and, optionally, House) of the record. Note, this will not remove the record from the database, but marks the record as deleted so that it is no longer usable.
| Payload | Schema / Return value |
|---|---|
| Request: | ShipmentIdentifier.xsd |
| Response (success): | True |
| Response (failure): | See Error Reporting above |
Transactions
Transactions are supported by specifying a TransactionId on the request.
UpdateShipment
Updates an existing shipment record in Sequoia.
| Payload | Schema / Return value |
|---|---|
| Request: | Shipment.xsd |
| Response (success): | A string representing the internal shipment reference. |
| Response (failure): | See Error Reporting above |
Notes
FhlStatus and FhlStatusDateTime cannot be used in the UpdateShipment method (if supplied they will be ignored).
Transactions
Transactions are supported by specifying a TransactionId on the request.