Load Building

Load Draft

v1 equivalent: loadDraft (flat payload — the data fields below are sent at the top level, without the envelope).

Sent when Augment's load building agent has assembled a load draft and is ready to create a load in the TMS. workflow is LOAD_BUILDING. The envelope loadNumber / customerLoadInternalId are null because the load does not exist in the TMS yet.

post/LOAD_DRAFT

Request

Base URL
https://apidocs.goaugment.com (the document declares no server; this is the origin it was published from)
Auth
none required
TypeScript
https://skmtc.dev/goaugment/apis/webhooks/docs/LOAD_DRAFT/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring required

Unique event identifier (ULID)

The Augment workflow that produced this event, or null when no single workflow can be attributed. New values may be added over time, so treat this as an open set rather than a fixed list.

occurredAtstring date-time required

When the underlying activity occurred (ISO 8601)

loadNumberstring nullable required

Your load reference number

customerLoadInternalIdstring nullable required

Your internal load ID, if provided during load creation

eventType'LOAD_DRAFT' required

Event name for an assembled load draft.

Example request

{
  "data": {
    "customerInformation": {
      "address": {
        "country": "US"
      }
    },
    "stops": [
      {
        "facilityAddress": {
          "country": "US"
        }
      }
    ],
    "loadDetails": {
      "dimensions": {
        "lengthUnit": "IN",
        "widthUnit": "IN",
        "heightUnit": "IN",
        "volumeUnit": "CUFT"
      },
      "weight": {
        "unit": "LBS"
      },
      "valueAmount": {
        "unit": "USD"
      },
      "freightClass": "70",
      "nmfc": "149980-02",
      "cargoItems": [
        {
          "dimensions": {
            "lengthUnit": "IN",
            "widthUnit": "IN",
            "heightUnit": "IN",
            "volumeUnit": "CUFT"
          },
          "weight": {
            "unit": "LBS"
          },
          "valueAmount": {
            "unit": "USD"
          },
          "freightClass": "70",
          "nmfc": "149980-02"
        }
      ]
    }
  }
}

Response

Load created successfully

loadNumstring required

The load number assigned by the TMS to the newly created load. This is the primary identifier used to link the Augment load draft to the TMS load.

messagestring

Optional success or error message from the TMS describing the result of the load creation.

Example response

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

Changes

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