Find Indexed CargoWise Shipment
Finds a previously stored shipment by an exact, Connection-scoped operational reference.
@lainstack/cargowise/find-indexed-shipment · TMS · Available on Lainstack Cloud
How to use it
Section titled “How to use it”Find Indexed CargoWise Shipment looks up a shipment in this workspace’s CargoWise Shipment Identifiers Reference Table. It never calls CargoWise. It finds only references an earlier run stored there: @lainstack/cargowise/get-shipment or @lainstack/cargowise/prepare-shipment-reference, followed by @lainstack/reference-table/write.
Use it to turn a house bill, booking or container number from an email or document into the CargoWise shipment number. Then call @lainstack/cargowise/get-shipment with that number when you need CargoWise to confirm it.
- The match is exact for the chosen reference type and Connection. Values are trimmed and Unicode-normalized but keep their case, so “hawb-1” does not match “HAWB-1”.
- Three paths: Match (one shipment), None (no stored row) and Many (two or more shipments share the reference). Many lists at most 5 candidates and sets
truncatedwhen there are more. - A reference stored under another Connection is not found.
- The CargoWise Shipment Operations Data Pack must be installed in the workspace, or the step fails. A table that does not match the pack fails with an incompatible Data Pack error.
- A data-lake outage fails the step. Server errors are retryable.
Settings
Section titled “Settings”| Setting | Key | Type | Details |
|---|---|---|---|
| CargoWise connection (required) | credentialId |
Connection | Scopes the local Reference Data lookup to one CargoWise environment. At most 160 characters. |
| Reference type (required) | identifierType |
One of Shipment number, House bill / HAWB, Master bill / MAWB, Booking reference, Shipper reference, Order reference, Container number |
The exact indexed reference type to search. |
| Reference value (required) | referenceValue |
Text | Searches previously stored CargoWise Shipment Identifiers. It does not query CargoWise live. Type a value or insert an upstream variable. |
Outputs
Section titled “Outputs”| Output | Path | Type |
|---|---|---|
| Match status | matchStatus |
Text |
| Shipment identity | shipmentIdentity |
Record |
| Shipment source type | shipmentIdentity.dataSourceType |
Text |
| Shipment source key | shipmentIdentity.dataSourceKey |
Text |
| Shipment number | shipmentIdentity.shipmentNumber |
Text |
| Candidate shipments | candidates |
List |
| Candidates truncated | truncated |
Yes or no |
| Exit | Port | Notes |
|---|---|---|
| Match | found |
|
| None | not_found |
|
| Many | ambiguous |