How do I read PO shipment custom fields (like Cargo Ready Date) from the External API?

The External API now returns custom field values on purchase order shipments.

Where to find them

Call GET /purchase-order-shipments for the list, or GET /purchase-order-shipments/{id} for one shipment. Each shipment includes a custom_fields object keyed by the field's label, for example:

"custom_fields": { "Cargo Ready Date": "2026-10-20" }

Things to know

• Only filled-in fields appear. If a field is defined for shipments but has no value on that shipment, it is left out. The object can be empty ({}).
• Dates are returned as YYYY-MM-DD.
• To see every field defined for PO shipments, including unset ones, call GET /custom-fields filtered to the PO shipment object type.
• Read-only. You can read these values through the External API but can't create or update them there. Edit them in Luminous on the shipment.

To create the fields in the first place, see How to Use Custom Fields on PO Shipments in Luminous.