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 /shipments/{shipment_id}/custom_fields

List shipment custom fields

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields \
  --header 'Authorization: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "api_slug": "<string>",
        "value": "<string>",
        "display_value": "<string>"
      },
      "relationships": {
        "entity": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "definition": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

Lists all custom fields attached to a specific shipment.

Path parameters

Parameter	Required	Description
shipment_id	Yes	The ID of the shipment

Authorization

Requires show permission on the shipment.

Response

Returns a JSONAPI array of custom field resources including:

• value - The raw stored value
• display_value - Formatted value for display
• Relationships to the definition and user who last updated the field

Authorizations

Authorization · string · header · required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Path Parameters

shipment_id · string · required

Shipment ID

Response

200 - application/json

OK

data · Custom field · object[]

Show child attributes

links · links · object

Show child attributes

meta · meta · object

Show child attributes