Skip to main content
GET
List shipment custom fields
Lists all custom fields attached to a specific shipment.

Path parameters

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

Query Parameters

include
string

Comma-separated relationships to include: definition, entity, updated_by.

Response

OK

data
Custom field · object[]

Pagination links. Each value is an absolute URL. self repeats the request URL as sent, including its query string and its encoding. current, first, prev, next, and last repeat the request's query parameters, with page[number] and page[size] in unencoded brackets.

meta
meta · object
included
(Custom field definition · object | Shipment model · object | Container model · object | Tracking Request · object | object)[]