Work with shipment metafields
Three actions let you read and write Fulfil metafields on a customer shipment. They’re built to work together: look up the metafield you want, then write a value to it.
Get metafield
Returns a single metafield definition for a Fulfil model, looked up by its code or name. Use it to grab the metafield ID the set actions need.
Inputs
- Code or name (required) — the metafield’s code or display name.
- Model (required) — the Fulfil model the metafield belongs to, for example
stock.shipment.outfor customer shipments.
Set customer shipment metafield
Writes a single metafield value on a customer shipment.
Inputs
- Customer shipment ID (required) — the Fulfil customer shipment to update.
- Metafield ID (required) — the ID returned by Get metafield.
- Value (required) — the value to store.
Set metafields for customer shipment
Writes several metafield values on a customer shipment in one call.
Inputs
- Customer shipment ID (required) — the Fulfil customer shipment to update.
- Metafields (required) — a JSON array where each entry has a
field(the metafield ID) and avalue.
Example:
[
{ "field": "42", "value": "priority" },
{ "field": "57", "value": "2026-07-30" }
]Typical use
Run Get metafield once to resolve the ID, then feed it into Set customer shipment metafield or Set metafields for customer shipment. Metafield IDs are stable, so you can also hard-code them in your Flow and skip the lookup once you know them.