Terminal49

Terminal49 Custom Fields API

The Custom Fields API from Terminal49 — 2 operation(s) for custom fields.

GitHub OpenAPI

Operations 5

GET /custom_fields List custom fields #
POST /custom_fields Create a custom field #
GET /custom_fields/{id} Get a custom field #
PATCH /custom_fields/{id} Update a custom field #
DELETE /custom_fields/{id} Delete a custom field #

Documentation

📖
Documentation
https://terminal49.com/docs/api-docs/getting-started/tracking-shipments-and-containers/
📖
APIReference
https://terminal49.com/docs/api-docs/api-reference/introduction
📖
Documentation
https://terminal49.com/docs/api-docs/getting-started/list-shipments-and-containers/
📖
Documentation
https://terminal49.com/docs/api-docs/in-depth-guides/quickstart/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/terminal49/openapi/terminal49-custom-fields-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/terminal49/json-schema/terminal49-custom-field-schema.json
📊
JSONSchema
https://artifacts.apis.io/terminal49/json-schema/terminal49-links-schema.json
📊
JSONSchema
https://artifacts.apis.io/terminal49/json-schema/terminal49-custom-field-value-schema.json
📊
JSONSchema
https://artifacts.apis.io/terminal49/json-schema/terminal49-meta-schema.json
📊
JSONSchema
https://artifacts.apis.io/terminal49/json-schema/terminal49-link-self-schema.json

Other Resources

🔗
PostmanCollection
https://artifacts.apis.io/terminal49/collections/terminal49.postman_collection.json
🔗
OpenCollection
https://artifacts.apis.io/terminal49/collections/terminal49.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/terminal49:terminal49-custom-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

terminal49-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Terminal49 API Reference Custom Fields API
  version: 0.2.0
  contact:
    name: Terminal49 API support
    url: https://www.terminal49.com
    email: support@terminal49.com
  description: 'The Terminal 49 API offers a convenient way to programmatically track your shipments from origin to destination.


    Please enter your API key into the "Variables" tab before using these endpoints within Postman.'
  x-label: Beta
  termsOfService: https://www.terminal49.com/terms
  x-synced-from: https://terminal49.com/docs/openapi.json
  x-synced-at: '2026-08-24T18:47:48.161Z'
servers:
- url: https://api.terminal49.com/v2
  description: Production
security:
- authorization: []
tags:
- name: Custom Fields
paths:
  /custom_fields:
    get:
      summary: List custom fields
      operationId: get-custom-fields
      tags:
      - Custom Fields
      parameters:
      - schema:
          type: integer
          default: 1
        in: query
        name: page[number]
      - schema:
          type: integer
          default: 25
        in: query
        name: page[size]
      - schema:
          type: string
        in: query
        name: filter[entity_type]
        description: Filter by entity type (Shipment or Container)
      - schema:
          type: string
        in: query
        name: filter[entity_id]
        description: Filter by entity ID
      - schema:
          type: string
        in: query
        name: filter[definition_id]
        description: Filter by custom field definition ID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/custom_field'
                  links:
                    $ref: '#/components/schemas/links'
                  meta:
                    $ref: '#/components/schemas/meta'
    post:
      summary: Create a custom field
      operationId: post-custom-fields
      tags:
      - Custom Fields
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/custom_field'
                  links:
                    $ref: '#/components/schemas/link-self'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  required:
                  - type
                  - attributes
                  - relationships
                  properties:
                    type:
                      type: string
                      enum:
                      - custom_field
                    attributes:
                      type: object
                      required:
                      - api_slug
                      - value
                      properties:
                        api_slug:
                          type: string
                        value:
                          $ref: '#/components/schemas/custom_field_value'
                    relationships:
                      type: object
                      properties:
                        entity:
                          type: object
                          properties:
                            data:
                              type: object
                              required:
                              - type
                              - id
                              properties:
                                type:
                                  type: string
                                  enum:
                                  - shipment
                                  - container
                                id:
                                  type: string
                                  format: uuid
            example:
              data:
                type: custom_field
                attributes:
                  api_slug: customer_reference_number
                  value: ABC124
                relationships:
                  entity:
                    data:
                      type: shipment
                      id: YOUR_SHIPMENT_ID
  /custom_fields/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
      description: Custom field ID
    get:
      summary: Get a custom field
      operationId: get-custom-fields-id
      tags:
      - Custom Fields
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/custom_field'
                  links:
                    $ref: '#/components/schemas/link-self'
    patch:
      summary: Update a custom field
      operationId: patch-custom-fields-id
      tags:
      - Custom Fields
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/custom_field'
                  links:
                    $ref: '#/components/schemas/link-self'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  required:
                  - type
                  - attributes
                  properties:
                    type:
                      type: string
                      enum:
                      - custom_field
                    attributes:
                      type: object
                      required:
                      - value
                      properties:
                        value:
                          $ref: '#/components/schemas/custom_field_value'
    delete:
      summary: Delete a custom field
      operationId: delete-custom-fields-id
      tags:
      - Custom Fields
      responses:
        '200':
          description: OK
components:
  schemas:
    meta:
      title: meta
      type: object
      properties:
        size:
          type: integer
        total:
          type: integer
    custom_field_value:
      description: Raw custom field value (type depends on definition)
      oneOf:
      - type: string
      - type: number
      - type: boolean
      - type: array
        items:
          type: string
      - type: object
    links:
      title: links
      type: object
      properties:
        last:
          type: string
          format: uri
        next:
          type: string
          format: uri
        prev:
          type: string
          format: uri
        first:
          type: string
          format: uri
        self:
          type: string
          format: uri
    custom_field:
      title: Custom field
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - custom_field
        attributes:
          type: object
          properties:
            api_slug:
              type: string
            value:
              $ref: '#/components/schemas/custom_field_value'
            display_value:
              type:
              - string
              - 'null'
              description: Formatted value for display
          required:
          - api_slug
        relationships:
          type: object
          properties:
            entity:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - shipment
                      - container
                      - tracking_request
                    id:
                      type: string
                      format: uuid
                  required:
                  - type
                  - id
            definition:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - custom_field_definition
                    id:
                      type: string
                      format: uuid
                  required:
                  - type
                  - id
      required:
      - id
      - type
    link-self:
      title: link
      type: object
      properties:
        self:
          type: string
          format: uri
  securitySchemes:
    authorization:
      name: Authorization
      type: apiKey
      in: header
      description: 'Use a Terminal49 API key in the `Authorization` header with the `Token` prefix.


        `Authorization: Token YOUR_API_KEY`'
x-tagGroups:
- name: End Points
  tags:
  - Shipments
  - Containers
  - Custom Field Definitions
  - Custom Field Options
  - Custom Fields
  - Tracking Requests
  - Webhooks
  - Webhook Notifications
  - Metro Areas
  - Documents
  - Email Submissions
  - Document Schemas
  - Search
- name: Routing (Paid)
  tags:
  - Routing (Paid)