Webhook

Load Draft

​

Payload is identical in v1 and v2 — no migration needed for this event.

Augment POSTs this payload to your configured load-draft endpoint when Augment's load building agent has assembled a load draft and is ready to create a load in the TMS.

Augment will POST to {baseUrl}/{shipperId}/load-drafts, where {baseUrl} is the URL configured for your integration and {shipperId} is the ID of the shipper associated with the load in the TMS.

The TMS should use the load draft data to create a new load and return the assigned load number in the response.

Body·
required
application/json

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

  • loadDraftId
    Type: string
    required

    Stable identifier for this load draft, assigned by Augment. Present on every load draft delivery and used to correlate the draft with subsequent updates.

  • customerInformation
    Type: object

    Shipper and billing information.

  • 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.

  • loadRequirements
    Type: object

    Equipment and service requirements.

  • rates
    Type: object

    Pricing information for the load.

  • referenceNumbers
    Type: object

    Customer reference numbers associated with the load.

  • stops
    Type: array object[]

    Ordered list of pickup and delivery stops on the load.

Responses
  • application/json
Request Example for postloadDraft
{
  "loadDraftId": "01JR7ZC3M8Q9W2D4F6H8K0N2P4",
  "referenceNumbers": {
    "customerReferenceNumber": "CUST-REF-12345",
    "bolNumber": "BOL-9988",
    "poNumber": "PO-44521",
    "shipmentNumber": "SHP-2026-0042"
  },
  "customerInformation": {
    "name": "Acme Foods Inc.",
    "contact": {
      "email": "ops@acme-foods.example.com",
      "phone": "+13125550199"
    },
    "address": {
      "name": "Acme HQ",
      "streetAddress": "500 W Madison St",
      "city": "Chicago",
      "state": "IL",
      "zip": "60661",
      "country": "US"
    },
    "shipperId": "SHIPPER-ACME-001",
    "notes": "Call 1 hour before arrival",
    "internalNotes": "Tier 1 customer: escalate any delays"
  },
  "stops": [
    {
      "stopNumber": 1,
      "stopType": "PICKUP",
      "facilityName": "Acme DC - Chicago",
      "facilityCode": "ACM-CHI-01",
      "facilityAddress": {
        "streetAddress": "1200 S Cicero Ave",
        "city": "Chicago",
        "state": "IL",
        "zip": "60623",
        "country": "US"
      },
      "facilityContact": {
        "email": "dock@acme-chi.example.com",
        "phone": "+17735550144"
      },
      "handlingType": "LIVE",
      "appointmentType": "APPOINTMENT",
      "appointmentTime": {
        "start": "2026-07-02T13:00:00Z",
        "end": "2026-07-02T15:00:00Z",
        "timezone": "America/Chicago"
      },
      "driverInstructions": "Check in at guard shack with BOL"
    },
    {
      "stopNumber": 2,
      "stopType": "DELIVERY",
      "facilityName": "Midwest Grocers DC",
      "facilityAddress": {
        "streetAddress": "8400 Industrial Pkwy",
        "city": "Detroit",
        "state": "MI",
        "zip": "48210",
        "country": "US"
      },
      "handlingType": "DROP_TRAILER",
      "appointmentType": "FIRST_COME_FIRST_SERVE",
      "dropTime": {
        "start": "2026-07-03T10:00:00Z",
        "end": "2026-07-03T22:00:00Z",
        "timezone": "America/Detroit"
      }
    }
  ],
  "loadDetails": {
    "handlingUnit": {
      "unitType": "PALLET",
      "unitCount": "24"
    },
    "commodity": "Mixed frozen goods",
    "weight": {
      "value": "42000",
      "unit": "LBS"
    },
    "dimensions": {
      "length": "48",
      "lengthUnit": "IN",
      "width": "40",
      "widthUnit": "IN",
      "height": "60",
      "heightUnit": "IN"
    },
    "cargoCharacteristics": {
      "stackable": false,
      "hazmat": false,
      "perishable": true
    },
    "cargoItems": [
      {
        "handlingUnit": {
          "unitType": "PALLET",
          "unitCount": "14"
        },
        "packagingUnit": {
          "unitType": "CARTON",
          "unitCount": "560"
        },
        "commodity": "Frozen poultry",
        "description": "Boxed frozen poultry, keep at -10F",
        "dimensions": {
          "length": "48",
          "lengthUnit": "IN",
          "width": "40",
          "widthUnit": "IN",
          "height": "60",
          "heightUnit": "IN"
        },
        "weight": {
          "value": "26000",
          "unit": "LBS"
        },
        "valueAmount": {
          "value": "48000",
          "unit": "USD"
        },
        "cargoCharacteristics": {
          "stackable": false,
          "hazmat": false,
          "perishable": true
        }
      },
      {
        "handlingUnit": {
          "unitType": "PALLET",
          "unitCount": "10"
        },
        "packagingUnit": {
          "unitType": "CARTON",
          "unitCount": "400"
        },
        "commodity": "Frozen vegetables",
        "description": "Mixed vegetable cartons",
        "dimensions": {
          "length": "48",
          "lengthUnit": "IN",
          "width": "40",
          "widthUnit": "IN",
          "height": "48",
          "heightUnit": "IN"
        },
        "weight": {
          "value": "16000",
          "unit": "LBS"
        },
        "valueAmount": {
          "value": "12000",
          "unit": "USD"
        },
        "cargoCharacteristics": {
          "stackable": true,
          "hazmat": false,
          "perishable": true
        }
      }
    ]
  },
  "loadRequirements": {
    "mode": "FTL",
    "loadType": "SPOT",
    "equipment": {
      "equipmentType": "REEFER",
      "size": "53",
      "unit": "FT"
    },
    "temperatureRequirement": {
      "required": true,
      "hasBulkhead": false,
      "zones": [
        {
          "zoneId": "Z1",
          "minTemp": {
            "value": -10,
            "unit": "F"
          },
          "maxTemp": {
            "value": 0,
            "unit": "F"
          }
        }
      ]
    },
    "additionalRequiredServices": [
      "TEAM_DRIVER"
    ]
  },
  "rates": {
    "baseRate": "1850.00",
    "lineHaul": "1700.00",
    "accessorials": [
      {
        "type": "FUEL_SURCHARGE",
        "rate": "150.00"
      }
    ],
    "totalRate": "1850.00",
    "collectionMethod": "PrePaid"
  },
  "documentDates": [
    "2026-07-01"
  ]
}

{
  "loadNum": "LOAD-12345",
  "message": "Load created successfully"
}

Load created successfully