List shipment custom fields
Shipments
List shipment custom fields
List every custom field value attached to a shipment in the Terminal49 API, including the api_slug, current value, and resolved option for enum fields.
GET
List shipment custom fields
Lists all custom fields attached to a specific shipment.
Path parameters
| Parameter | Required | Description |
|---|---|---|
shipment_id | Yes | The ID of the shipment |
Authorization
Requiresshow permission on the shipment.
Response
Returns a JSONAPI array of custom field resources including:value- The raw stored valuedisplay_value- Formatted value for display- Relationships to the definition and user who last updated the field
Authorizations
Use a Terminal49 API key in the Authorization header with the Token prefix.
Authorization: Token YOUR_API_KEY
Path Parameters
Shipment ID