Prepare CargoWise Shipment Reference
Prepares a customer-proven reference row for the CargoWise Shipment Identifiers table without querying CargoWise. Connect the output to Write Reference Table.
@lainstack/cargowise/prepare-shipment-reference · TMS · Available on Lainstack Cloud
How to use it
Section titled “How to use it”Prepare CargoWise Shipment Reference turns one known pair, a CargoWise shipment number and another reference for the same shipment, into one row for the CargoWise Shipment Identifiers Reference Table. It does not call CargoWise and does not check that the pair is true. Use only values the customer or a trusted source has proven to belong together.
The block stores nothing itself. Connect its identifierRows output to @lainstack/reference-table/write, targeting the Shipment Identifiers table of the installed CargoWise Shipment Operations Data Pack. After that, @lainstack/cargowise/find-indexed-shipment finds the shipment by this reference.
- Reference types are house bill, master bill, booking reference, shipper reference, order reference and container number. Shipment numbers come from
@lainstack/cargowise/get-shipment, whoseidentifierRowsyou write the same way. - The row is scoped to the chosen Connection. A lookup with another Connection does not see it.
- Values are trimmed and Unicode-normalized for matching but keep their case. Each is at most 160 characters after trimming.
observed_atis the time the step ran.- Writing the same pair again updates the same row. Its key comes from the Connection, shipment number, reference type and reference value.
Settings
Section titled “Settings”| Setting | Key | Type | Details |
|---|---|---|---|
| CargoWise connection (required) | credentialId |
Connection | Scopes the prepared relationship to one CargoWise environment. At most 160 characters. |
| CargoWise shipment number (required) | shipmentNumber |
Text | The exact customer-proven CargoWise forwarding shipment or job number. This Block does not retrieve it from CargoWise. Type a value or insert an upstream variable. |
| Reference type (required) | identifierType |
One of House bill / HAWB, Master bill / MAWB, Booking reference, Shipper reference, Order reference, Container number |
The customer-proven operational reference represented by this value. |
| Reference value (required) | referenceValue |
Text | A customer-proven reference for this exact shipment. This Block does not retrieve it from CargoWise. Type a value or insert an upstream variable. |
Outputs
Section titled “Outputs”| Output | Path | Type |
|---|---|---|
| Identifier rows | identifierRows |
Table |