Create a custom field definition

Create a new custom field definition in the Terminal49 API to attach structured metadata like reference codes or enums to shipments and containers.

POST /custom_field_definitions

Create a custom field definition

cURL

curl --request POST \
  --url https://api.terminal49.com/v2/custom_field_definitions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "api_slug": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "reference_type": "<string>",
      "validation": {},
      "default_format": "<string>",
      "default_value": "<string>"
    }
  },
  "links": {
    "self": "<string>"
  }
}

Create a custom field definition to describe metadata you want to store on shipments or containers.

Request body

Parameter	Required	Description
entity_type	Yes	The entity type this field applies to (Shipment or Container)
api_slug	Yes	Unique identifier for the field
display_name	Yes	Human-readable name for the field
data_type	Yes	Data type for values (for example: short_text, number, date, reference)
description	No	Optional description of the field’s purpose
validation	No	Validation rules (for example: required, pattern, max_length)
default_format	No	Default format string for numbers or dates
default_value	No	Default value for new custom fields
reference_type	No	Required when data_type is reference

Authorizations

Authorization · string · header · required

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

Authorization: Token YOUR_API_KEY

Body

application/json

data · object

Show child attributes

Response

201 - application/json

Created

data · Custom field definition · object

Show child attributes

links · link · object

Show child attributes