Terminal49 Document Schemas API

openapi: 3.2.0
info:
  title: Terminal49 API Reference Document Schemas 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: Document Schemas
paths:
  /document_schemas/{id}:
    get:
      summary: Get a document schema
      tags:
      - Document Schemas
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: Schema id in full-version format, e.g. commercial_invoice@2026-03-23.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/document_schema'
                  links:
                    $ref: '#/components/schemas/link-self'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/error'
              examples:
                schema_not_found:
                  summary: Document schema not found
                  value:
                    errors:
                    - status: '404'
                      title: Not Found
                      detail: Couldn't find DocumentSchema with 'id'=unknown@2026-03-23
      operationId: get-document_schemas-id
components:
  schemas:
    link-self:
      title: link
      type: object
      properties:
        self:
          type: string
          format: uri
    error:
      title: Error model
      type: object
      properties:
        detail:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        source:
          type:
          - object
          - 'null'
          properties:
            pointer:
              type:
              - string
              - 'null'
            parameter:
              type:
              - string
              - 'null'
        code:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        meta:
          type:
          - object
          - 'null'
          additionalProperties: true
      required:
      - title
    document_schema:
      title: Document Schema
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - document_schema
        attributes:
          type: object
          properties:
            document_type:
              type: string
              description: Document type this schema applies to (for example, commercial_invoice).
            label:
              type: string
              description: Human-readable label for the document type.
            schema_version:
              type: string
              description: Public schema version identifier.
            full_version:
              type: string
              description: Fully-qualified schema version id (for example, commercial_invoice@2026-03-23).
            current:
              type: boolean
              description: Whether this schema version is currently active.
            draft:
              type: boolean
              description: Whether this schema version is marked as draft.
            active_at:
              type:
              - string
              - 'null'
              format: date-time
              description: Timestamp when this schema version became active.
            schema_format:
              type: string
              enum:
              - json_schema
              description: Schema payload format.
            description:
              type:
              - string
              - 'null'
              description: Optional notes describing this schema.
            schema_payload:
              type: object
              additionalProperties: true
              description: JSON Schema payload used to validate and describe extracted fields.
            created_at:
              type: string
              format: date-time
              description: When this schema record was created.
            updated_at:
              type: string
              format: date-time
              description: When this schema record was last updated.
        links:
          type: object
          properties:
            self:
              type: string
      required:
      - id
      - type
  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)