LoadPatchCarrier

value for PATCH /carrier: add (no carrier yet) or replace.

  • address
    Type: object · CarrierAddress

    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

    TMS carrier id for this load (not Augment’s id).

  • contacts
    Type: array object[] · LoadPatchCarrierContact[]

    Contact for PATCH on /carrier (nested) or /carrier/contacts.

    • email
      Type: string

      Contact email.

    • id
      Type: string

      TMS contact id (not Augment’s id).

    • name
      Type: string

      Contact name.

    • phone
      Type: string

      E.164 or supported format; see CarrierContact on create load.

    • phoneExtension
      Type: string

      Digits only.

    • role
      Type: stringenum

      Optional. DISPATCHER or AP_REP (same as load CarrierContact).

      values
      • DISPATCHER
      • AP_REP
  • dotNumber
    Type: integer

    USDOT number, if sent.

  • drivers
    Type: array object[] · LoadPatchCarrierDriver[]

    Driver for PATCH on /carrier (nested) or /carrier/drivers.

    • id
      Type: string

      TMS driver id (not Augment’s id).

    • name
      Type: string

      Driver name on the load.

    • phone
      Type: string

      E.164 or supported format; see Carrier.drivers on create load.

    • phoneExtension
      Type: string

      Digits only.

  • mcNumber
    Type: integer

    US MC number, if sent.

  • name
    Type: string

    Carrier name.

  • scac
    Type: string

    SCAC (Standard Carrier Alpha Code)—short alphabetic carrier code, often used in rail/intermodal.