LoadDraftPayload

Load draft payload containing all information needed to create a load in the TMS.

  • customerInformation
    Type: object

    Shipper and billing information.

    • address
      Type: object

      Customer billing address

    • contact
      Type: object

      Customer contact information

    • divisionTerm
      Type: string

      Division or billing term associated with the customer

    • internalNotes
      Type: string

      Internal operational notes

    • name
      Type: string

      Customer name

    • notes
      Type: string

      Customer-facing notes

    • shipperId
      Type: string

      Shipper identifier

  • documentDates
    Type: array string[]

    ISO 8601 date strings associated with documents on the load (e.g. BOL date, delivery date)

  • loadDetails
    Type: object

    Commodity and cargo details. The fields on this object describe the load as a whole. When the source supplies per-line detail, cargoItems carries it and these top-level fields act as the summary for the load. Augment passes both through exactly as supplied and does not derive or reconcile them, so do not assume the summary equals the sum of cargoItems.

    • cargoCharacteristics
      Type: object
    • cargoItems
      Type: array object[]

      Per-line cargo detail. Each entry uses the same fields as the summary above and describes a single line. Present only when the source supplied per-line detail — some sources populate the summary fields only, so an absent or empty cargoItems does not by itself mean the load carries a single commodity.

    • commodity
      Type: string

      Commodity description (typically 40 characters or fewer)

    • description
      Type: string

      Extended commodity description

    • dimensions
      Type: object

      Load dimensions

    • handlingUnit
      Type: object

      Handling unit information (e.g. pallets)

    • packagingUnit
      Type: object

      Packaging unit information (e.g. cartons inside pallets)

    • valueAmount
      Type: object

      Declared value of the load

    • weight
      Type: object

      Total load weight

  • loadRequirements
    Type: object

    Equipment and service requirements.

    • additionalRequiredServices
      Type: array string[]

      Additional services required for the load (e.g. liftgate, team driver)

    • equipment
      Type: object

      Equipment requirements

    • loadType
      Type: string enum

      Rate type / load type

      values
      • SPOT
      • CONTRACT
      • DEDICATED
      • PROJECT
    • mode
      Type: string enum

      Transportation mode

      values
      • FTL
      • LTL
      • DRAYAGE
    • tarpSize
      Type: string | null

      Tarp size required, if applicable

    • temperatureRequirement
      Type: object | null

      Temperature control requirements

  • rates
    Type: object

    Pricing information for the load.

    • accessorials
      Type: array object[]

      Accessorial charges

    • baseRate
      Type: string

      Base rate in dollars

    • collectionMethod
      Type: string enum

      Payment collection method

      values
      • PrePaid
      • Collect
      • ThirdParty
      • CollectOnDelivery
    • lineHaul
      Type: string

      Line haul rate in dollars

    • totalRate
      Type: string

      Total rate in dollars

  • referenceNumbers
    Type: object

    Customer reference numbers associated with the load.

    • bolNumber
      Type: string

      Bill of lading number

    • customerLoadNumber
      Type: string

      Customer load number

    • customerReferenceNumber
      Type: string

      Customer reference number

    • driverNumber
      Type: string

      Driver number

    • others
      Type: array object[]

      Additional reference numbers not covered by named fields

    • poNumber
      Type: string

      Purchase order number

    • proNumber
      Type: string

      PRO number

    • releaseNumber
      Type: string

      Release number

    • shipmentNumber
      Type: string

      Shipment number

    • tractorNumber
      Type: string

      Tractor number

    • trailerNumber
      Type: string

      Trailer number

  • stops
    Type: array object[]

    Ordered list of pickup and delivery stops on the load.

    • appointmentTime
      Type: object

      Scheduled appointment window

    • appointmentType
      Type: string enum

      Scheduling method for the stop

      values
      • APPOINTMENT
      • FIRST_COME_FIRST_SERVE
    • driverInstructions
      Type: string

      Special instructions for the driver at this stop

    • dropTime
      Type: object

      Drop time window for drop-trailer stops

    • facilityAddress
      Type: object

      Address of the facility

    • facilityCode
      Type: string

      Facility code, if known

    • facilityContact
      Type: object

      Contact information for the facility

    • facilityName
      Type: string

      Name of the facility

    • handlingType
      Type: string enum

      Load/unload handling type for the stop

      values
      • LIVE
      • DROP_TRAILER
    • internalNotes
      Type: string

      Internal operational notes for the stop

    • notes
      Type: string

      Customer-facing notes for the stop

    • operatingHours
      Type: string

      General operating hours for the facility

    • receivingHours
      Type: string

      Receiving hours for the facility

    • referenceNumber
      Type: string

      Stop-level reference number

    • shippingHours
      Type: string

      Shipping hours for the facility

    • stopNumber
      Type: integer

      1-based stop sequence number

    • stopType
      Type: string enum

      Whether the stop is a pickup or delivery

      values
      • PICKUP
      • DELIVERY
    • timezone
      Type: string

      IANA timezone identifier for the facility's local time