Create a shipment custom field
Shipments
Create shipment custom field
Create or update a custom field value on a shipment in the Terminal49 API. Attach internal metadata like PO numbers, customer codes, or workflow tags.
POST
Create a shipment custom field
Creates or updates a custom field on a shipment. If a custom field with the specified
api_slug already exists, it will be updated.
Path parameters
Request body
The shipment is implied by the path, so do not send
data.relationships.entity on this endpoint.
Authorization
Requiresupdate permission on the shipment.
Response
Returns201 Created with the custom field resource on success.
Behavior
- Uses
find_or_initialize_byinternally, so it creates if missing or updates if it exists - Values are validated against the definition’s data type
- For enum fields, values are validated against the definition’s options
Example request
Example response
Authorizations
Use a Terminal49 API key in the Authorization header with the Token prefix.
Authorization: Token YOUR_API_KEY
Path Parameters
Shipment ID
Body
application/json