Create or update load

​

Create a load, or replace an existing load matched by loadNumber.

The whole payload is validated on every request. Which fields are required depends on the load's status: stop appointment windows are optional while the load is a DRAFT and required on every route stop once the load reaches CUSTOMER_CONFIRMED or later. See Load Status Validation for the full status-by-status breakdown.

Body·

required
application/json
  • brokerage
    Type:
    required
    Properties: 1
  • load
    Type:
    required
    Properties: 30
  • carrier
    Type: nullable

    The carrier on the load. Send null to clear the carrier assigned to the load. When you send an object, name and dotNumber are required, and every entry in drivers needs a phone. A carrier object that fails validation is reported as one body.carrier entry in the 422 details; its message names the nested field.

    Properties: 8
  • carrierPaymentStatuses
    Type:

    Per-carrier payment status entries for this load. Each entry represents the payment outcome for one carrier on the load (e.g., TONU + linehaul on a co-brokered load yields two entries). Sending this field replaces any prior set of statuses for the load.

    Properties: 6
  • customer
    Type:
    Properties: 2
  • trackingEvents
    Type:

    Providing this field replaces all existing tracking events for the Load, including an empty array, which clears them. Omit the field to preserve existing tracking events. To append events instead of replacing them, use the POST /v2/loads/tracking endpoint.

    Properties: 16

Responses

  • 204

    Load created successfully

  • application/json
  • application/json
  • application/json
Request Example for post/v2/loads
curl https://api.prod.goaugment.com/v2/loads \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "brokerage": {},
  "load": {
    "loadNumber": "1",
    "mode": "FTL",
    "status": "DRAFT",
    "isPostedToDAT": false,
    "route": [
      {
        "sequence": 1,
        "stopActivity": "PICKUP",
        "expectedArrivalWindowStart": "2025-09-01T12:00:00Z",
        "expectedArrivalWindowEnd": "2025-09-01T14:00:00Z",
        "address": {
          "street1": "1 Santa Monica Blvd",
          "city": "Santa Monica",
          "stateOrProvince": "CA",
          "postalCode": "90401",
          "country": "US"
        }
      },
      {
        "sequence": 2,
        "stopActivity": "DELIVERY",
        "expectedArrivalWindowStart": "2025-09-02T12:00:00Z",
        "expectedArrivalWindowEnd": "2025-09-02T14:00:00Z",
        "address": {
          "street1": "1 Market St",
          "city": "San Francisco",
          "stateOrProvince": "CA",
          "postalCode": "94105",
          "country": "US"
        }
      }
    ],
    "items": [
      {
        "quantity": 600,
        "packagingUnit": {
          "unitType": "CARTON",
          "quantity": 60
        },
        "handlingUnit": {
          "unitType": "PALLET",
          "quantity": 3
        },
        "description": "600 pieces packed in 60 cartons on 3 pallets",
        "totalWeightLbs": 12000,
        "lengthInches": 48,
        "widthInches": 40,
        "heightInches": 60,
        "freightClass": "70",
        "nmfc": "123456"
      }
    ]
  }
}'
No Body

Load created successfully

Previous
Get load by load number
Next
Patch a load