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

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Path Parameters

shipment_id
string
required

Shipment ID

Response

200 - application/json

OK

data
Custom field ยท object[]
meta
meta ยท object