Get CargoWise Shipment
Retrieves a forwarding shipment by CargoWise shipment number. Synthetic-contract readiness until live conformance passes.
@lainstack/cargowise/get-shipment · TMS · Available on Lainstack Cloud
How to use it
Section titled “How to use it”Get CargoWise Shipment asks CargoWise eAdaptor Next for one forwarding shipment by its exact shipment or job number. It confirms the shipment exists and returns its identity, not the full shipment record. Readiness is synthetic-contract only until live tenant conformance passes.
Use @lainstack/cargowise/find-indexed-shipment first when you only have a house bill, booking or container number.
- Found carries the shipment and two Table values: one read observation row and one shipment-number identifier row. They are not stored. Write them with
@lainstack/reference-table/writeinto the CargoWise Shipment Operations Data Pack tables, so later lookups can find this shipment. - CargoWise rejected means CargoWise answered with status ERR.
shipmentis null and both Tables are empty. - HTTP errors, OAuth failures and timeouts (30 seconds per request) fail the step. So does a response that is malformed, larger than 5 MB, or names a different shipment.
- The Connection signs in with the CargoWise-issued RSA client certificate and private key. A certificate and key that do not match fail the step.
fetchedAtis when the step ran.
Settings
Section titled “Settings”| Setting | Key | Type | Details |
|---|---|---|---|
| CargoWise connection (required) | credentialId |
Connection | The eAdaptor Next Connection used for this request. Synthetic-contract readiness until live conformance passes. At most 160 characters. |
| Shipment number (required) | shipmentNumber |
Text | The exact CargoWise forwarding shipment or job number. Type a value or insert an upstream variable. |
Outputs
Section titled “Outputs”| Output | Path | Type |
|---|---|---|
| CargoWise status | status |
Text |
| Shipment | shipment |
Record |
| Shipment source type | shipment.dataSourceType |
Text |
| Shipment source key | shipment.dataSourceKey |
Text |
| Shipment number | shipment.shipmentNumber |
Text |
| Fetched at | shipment.fetchedAt |
Text |
| Shipment read observation Table | shipmentReadObservationRows |
Table |
| Shipment identifier Table | identifierRows |
Table |
| Exit | Port | Notes |
|---|---|---|
| Found | out |
|
| CargoWise rejected | rejected |