Update shipment custom field

Update an existing custom field value on a shipment in the Terminal49 API, identified by the custom field definition’s api_slug for that shipment record.

PATCH /shipments/{shipment_id}/custom_fields/{api_slug}

Update a shipment custom field

cURL

curl --request PATCH \
  --url https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields/{api_slug} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

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": {
    "self": "<string>"
  }
}

Updates a specific custom field on a shipment by its api_slug.

Path parameters

Parameter	Required	Description
shipment_id	Yes	The ID of the shipment
api_slug	Yes	The api_slug of the custom field definition

Request body

Parameter	Required	Description
value	Yes	The new value to set

Authorization

Requires update permission on the shipment.

Response

Returns 200 OK with the updated custom field resource on success.

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

api_slug · string · required

Custom field api_slug

Body

application/json

data · object

Show child attributes

Response

200 - application/json

OK

data · Custom field · object

Show child attributes

links · link · object

Show child attributes