Carrier

  • dotNumber
    Type: integer
    required

    Integer numbers.

  • name
    Type: string
    required
  • address
    Type: object

    Carrier address on a load. Optional on the parent object; when present, include every required field below.

    • city
      Type: string
      required

      Required when address is provided

    • country
      Type: string
      required

      Required when address is provided. 2-letter ISO country code: https://www.iban.com/country-codes

    • postalCode
      Type: string
      required

      Required when address is provided

    • stateOrProvince
      Type: string
      required

      Required when address is provided

    • street1
      Type: string
      required

      Required when address is provided

    • company
      Type: string
    • locationName
      Type: string
    • street2
      Type: string
  • carrierId
    Type: string
  • contacts
    Type: array object[] · CarrierContact[]

    Optional contact object. If provided, role is required.

    • role
      enum
      required

      Required if contact is provided.

      • AP_REP — Accounts Payable Specialist
      • DISPATCHER — Dispatcher
      values
      • AP_REP
      • DISPATCHER
    • email
      Type: string
    • id
      Type: string
    • name
      Type: string
    • phone
      Type: string

      Phone number in E.164 format (e.g., +12081234567) or common local format. Supports US, CA, MX, PH.

    • phoneExtension
      Type: string

      Phone number extension (numeric only).

  • drivers
    Type: array object[]
    • phone
      Type: string
      required

      Phone number in E.164 format (e.g., +12081234567) or common local format. Supports US, CA, MX, PH.

    • id
      Type: string
    • name
      Type: string
    • phoneExtension
      Type: string

      Phone number extension (numeric only).

  • mcNumber
    Type: integer

    Integer numbers.

  • scac
    Type: string