GOgoaugment
Load Management

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.

post/v2/loads

Request

Request body

Example request

{
  "load": {
    "accessorials": [
      "AFTER_HOURS"
    ],
    "route": [
      {
        "expectedArrivalWindowStart": "2025-08-21T12:34:56Z",
        "expectedArrivalWindowEnd": "2025-08-21T12:34:56Z",
        "actualArrivalTime": "2025-08-21T12:34:56Z",
        "actualCompletionTime": "2025-08-21T12:34:56Z",
        "expectedDropWindowStart": "2025-08-21T12:34:56Z",
        "expectedDropWindowEnd": "2025-08-21T12:34:56Z",
        "mustArriveByDate": "2025-08-21T12:34:56Z",
        "customData": {
          "pickupNumber": "PU-111",
          "bolNumber": "0007031665",
          "dock": {
            "door": "42"
          }
        }
      }
    ],
    "externalTrackingStatus": {
      "message": "Tracking Now",
      "updatedAt": "2025-08-21T12:34:56Z"
    },
    "bidExpiration": "2025-08-21T12:34:56Z",
    "notes": [
      {
        "timestamp": "2025-08-21T12:34:56Z"
      }
    ],
    "customData": {
      "customerLoadId": "ABC-12345",
      "priorityTier": 2,
      "whiteGloveDelivery": true,
      "tags": [
        "rush",
        "high-value"
      ],
      "routing": {
        "region": "NE",
        "requiresAppointment": true
      }
    }
  },
  "trackingEvents": [
    {
      "nextSequence": 2,
      "nextEtaUtc": "2025-08-21T12:34:56Z",
      "eventType": "INFO",
      "eventSource": "MACROPOINT",
      "eventUtc": "2025-08-21T12:34:56Z",
      "city": "St Louis",
      "country": "US",
      "stateOrProvince": "MO",
      "latitude": 38.56045466,
      "longitude": -90.4000096,
      "temperatureF": 26,
      "notes": "Location update received. Locator: 6166485924, Source: Ping",
      "dispatcher": {
        "phone": "+12081234567"
      },
      "driver": {
        "phone": "+12081234567"
      }
    }
  ],
  "carrier": {
    "contacts": [
      {
        "phone": "+12081234567"
      }
    ],
    "drivers": [
      {
        "phone": "+12081234567"
      }
    ]
  },
  "brokerage": {
    "contacts": [
      {
        "phone": "+12081234567"
      }
    ]
  }
}

Response

Load created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.