--- title: "Load Draft" method: POST path: "/LOAD_DRAFT" tags: ["Load Building"] --- # Load Draft `POST /LOAD_DRAFT` ## Request - Base URL: `https://apidocs.goaugment.com` (the document declares no server; this is the origin it was published from) - URL: `https://apidocs.goaugment.com/LOAD_DRAFT` - Auth: none required - TypeScript: (a function with typed inputs; its response is checked against the schema) > 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. ## Request body - LoadDraftEvent: Fields present on every v2 webhook event. - `id` string, required: Unique event identifier (ULID) - `workflow` 'TRACK_AND_TRACE' | 'CARRIER_SUPPORT' | 'POD_COLLECTION' | 'LOAD_BUILDING' | 'CARRIER_SELECTION' | 'SCHEDULING' | 'CUSTOMER_SUPPORT' | 'null', nullable, required: 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. - `occurredAt` string, date-time, required: When the underlying activity occurred (ISO 8601) - `loadNumber` string, nullable, required: Your load reference number - `customerLoadInternalId` string, nullable, required: Your internal load ID, if provided during load creation - `eventType` 'LOAD_DRAFT', required: Event name for an assembled load draft. - `data` LoadDraftPayload, required: Load draft payload containing all information needed to create a load in the TMS. - `loadDraftId` string, required: Stable identifier for this load draft, assigned by Augment. Present on every LOAD_DRAFT event and used to correlate the draft with subsequent updates. - `referenceNumbers` object: Customer reference numbers associated with the load. - `shipmentNumber` string: Shipment number - `customerReferenceNumber` string: Customer reference number - `customerLoadNumber` string: Customer load number - `releaseNumber` string: Release number - `bolNumber` string: Bill of lading number - `poNumber` string: Purchase order number - `proNumber` string: PRO number - `driverNumber` string: Driver number - `tractorNumber` string: Tractor number - `trailerNumber` string: Trailer number - `others` object[]: Additional reference numbers not covered by named fields - `type` string: Reference number type label - `value` string: Reference number value - `customerInformation` object: Shipper and billing information. - `name` string: Customer name - `contact` object: Customer contact information - `email` string - `phone` string - `address` object: Customer billing address - `name` string: Location name - `streetAddress` string - `city` string - `state` string - `zip` string - `country` string: ISO 3166-1 alpha-2 country code - `notes` string: Customer-facing notes - `internalNotes` string: Internal operational notes - `shipperId` string: Shipper identifier - `divisionTerm` string: Division or billing term associated with the customer - `stops` object[]: Ordered list of pickup and delivery stops on the load. - `stopNumber` integer: 1-based stop sequence number - `stopType` 'PICKUP' | 'DELIVERY': Whether the stop is a pickup or delivery - `referenceNumber` string: Stop-level reference number - `facilityName` string: Name of the facility - `facilityCode` string: Facility code, if known - `facilityAddress` object: Address of the facility - `name` string: Location name - `streetAddress` string - `city` string - `state` string - `zip` string - `country` string: ISO 3166-1 alpha-2 country code - `facilityContact` object: Contact information for the facility - `email` string - `phone` string - `handlingType` 'LIVE' | 'DROP_TRAILER': Load/unload handling type for the stop - `appointmentType` 'APPOINTMENT' | 'FIRST_COME_FIRST_SERVE': Scheduling method for the stop - `appointmentTime` object: Scheduled appointment window - `start` string: Appointment start as a UTC ISO 8601 timestamp ending in `Z`. - `end` string: Appointment end as a UTC ISO 8601 timestamp ending in `Z`. - `timezone` string: IANA timezone identifier - `dropTime` object: Drop time window for drop-trailer stops - `start` string: Drop window start as a UTC ISO 8601 timestamp ending in `Z`. - `end` string: Drop window end as a UTC ISO 8601 timestamp ending in `Z`. - `timezone` string: IANA timezone identifier - `driverInstructions` string: Special instructions for the driver at this stop - `notes` string: Customer-facing notes for the stop - `internalNotes` string: Internal operational notes for the stop - `shippingHours` string: Shipping hours for the facility - `receivingHours` string: Receiving hours for the facility - `operatingHours` string: General operating hours for the facility - `timezone` string: IANA timezone identifier for the facility's local time - `loadDetails` 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`. - `handlingUnit` object: Handling unit information (e.g. pallets) - `unitType` 'PALLET' | 'PIECE' | 'CARTON' | 'TOTE' | 'SKID' | 'CRATE' | 'BOX' | 'DRUM' | 'CASE' | 'FLOOR_LOADED' | 'ROLL' | 'SHEET': Type of handling unit - `unitCount` string: Number of handling units - `packagingUnit` object: Packaging unit information (e.g. cartons inside pallets) - `unitType` 'PALLET' | 'PIECE' | 'CARTON' | 'TOTE' | 'SKID' | 'CRATE' | 'BOX' | 'DRUM' | 'CASE' | 'FLOOR_LOADED' | 'ROLL' | 'SHEET': Type of packaging unit - `unitCount` string: Number of packaging units - `commodity` string: Commodity description (typically 40 characters or fewer) - `description` string: Extended commodity description - `dimensions` object: Load dimensions - `length` string - `lengthUnit` string - `width` string - `widthUnit` string - `height` string - `heightUnit` string - `volume` string - `volumeUnit` string - `weight` object: Total load weight - `value` string - `unit` string - `valueAmount` object: Declared value of the load - `value` string - `unit` string - `cargoCharacteristics` object - `stackable` boolean: Whether cargo can be stacked - `hazmat` boolean: Whether cargo contains hazardous materials - `perishable` boolean: Whether cargo is perishable or temperature-sensitive - `hazardousDetails` object: Details of the hazardous material being transported. Populated only when `hazmat` is true. - `name` string: Hazardous material name - `nameQualifier` string: Qualifier for the hazardous material name - `unCode` string: UN/NA identification code - `contact` string: Emergency contact name - `number` string: Emergency contact phone number - `hazardClass` string: Hazard class - `placardsNeeded` string: Placards required for transport - `placardNumber` string: Placard number - `packingGroup` string: Packing group - `flashpointTemp` string: Flashpoint temperature - `controlTemp` string: Control temperature - `emergencyTemp` string: Emergency temperature - `tempQualifier` string: Unit or qualifier for the temperature values - `freightClass` '50' | '55' | '60' | '65' | '70' | '77.5' | '85' | '92.5' | '100' | '110' | '125' | '150' | '175' | '200' | '250' | '300' | '400' | '500': NMFC freight class used for LTL rating. Sent as a string. - `nmfc` string: NMFC item number, as given on the tender (e.g. 149980 or 149980-02). - `cargoItems` 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. - `handlingUnit` object: Handling unit information (e.g. pallets) - `unitType` 'PALLET' | 'PIECE' | 'CARTON' | 'TOTE' | 'SKID' | 'CRATE' | 'BOX' | 'DRUM' | 'CASE' | 'FLOOR_LOADED' | 'ROLL' | 'SHEET': Type of handling unit - `unitCount` string: Number of handling units - `packagingUnit` object: Packaging unit information (e.g. cartons inside pallets) - `unitType` 'PALLET' | 'PIECE' | 'CARTON' | 'TOTE' | 'SKID' | 'CRATE' | 'BOX' | 'DRUM' | 'CASE' | 'FLOOR_LOADED' | 'ROLL' | 'SHEET': Type of packaging unit - `unitCount` string: Number of packaging units - `commodity` string: Commodity description (typically 40 characters or fewer) - `description` string: Extended commodity description - `dimensions` object: Cargo item dimensions - `length` string - `lengthUnit` string - `width` string - `widthUnit` string - `height` string - `heightUnit` string - `volume` string - `volumeUnit` string - `weight` object: Weight of this cargo item - `value` string - `unit` string - `valueAmount` object: Declared value of the cargo item - `value` string - `unit` string - `cargoCharacteristics` object - `stackable` boolean: Whether cargo can be stacked - `hazmat` boolean: Whether cargo contains hazardous materials - `perishable` boolean: Whether cargo is perishable or temperature-sensitive - `hazardousDetails` object: Details of the hazardous material being transported. Populated only when `hazmat` is true. - `name` string: Hazardous material name - `nameQualifier` string: Qualifier for the hazardous material name - `unCode` string: UN/NA identification code - `contact` string: Emergency contact name - `number` string: Emergency contact phone number - `hazardClass` string: Hazard class - `placardsNeeded` string: Placards required for transport - `placardNumber` string: Placard number - `packingGroup` string: Packing group - `flashpointTemp` string: Flashpoint temperature - `controlTemp` string: Control temperature - `emergencyTemp` string: Emergency temperature - `tempQualifier` string: Unit or qualifier for the temperature values - `freightClass` '50' | '55' | '60' | '65' | '70' | '77.5' | '85' | '92.5' | '100' | '110' | '125' | '150' | '175' | '200' | '250' | '300' | '400' | '500': NMFC freight class used for LTL rating. Sent as a string. - `nmfc` string: NMFC item number, as given on the tender (e.g. 149980 or 149980-02). - `loadRequirements` object: Equipment and service requirements. - `mode` 'FTL' | 'LTL' | 'DRAYAGE': Transportation mode - `loadType` 'SPOT' | 'CONTRACT' | 'DEDICATED' | 'PROJECT': Rate type / load type - `equipment` object: Equipment requirements - `equipmentType` 'DRY_VAN' | 'FLATBED' | 'REEFER' | 'CONTAINER' | 'CONESTOGA' | 'CONTAINERS' | 'DECKS_SPECIALIZED' | 'DECKS_STANDARD' | 'DRY_BULK' | 'FLATBEDS' | 'HAZARDOUS_MATERIALS' | 'OTHER_EQUIPMENT' | 'REEFERS' | 'TANKERS' | 'VANS_SPECIALIZED' | 'VANS_STANDARD' | 'AUTO_CARRIER' | 'B_TRAIN' | 'CONTAINER_INSULATED' | 'CONTAINER_REFRIGERATED' | 'CONVEYOR' | 'DOUBLE_DROP' | 'DUMP_TRAILER' | 'DROP_DECK_LANDOLL' | 'FLATBED_AIR_RIDE' | 'FLATBED_CONESTOGA' | 'FLATBED_DOUBLE' | 'FLATBED_HAZMAT' | 'FLATBED_HOTSHOT' | 'FLATBED_MAXI' | 'FLATBED_OR_STEP_DECK' | 'FLATBED_OVERDIMENSION' | 'FLATBED_VAN_REEFER' | 'FLATBED_WITH_CHAINS' | 'FLATBED_WITH_SIDES' | 'FLATBED_WITH_TARPS' | 'FLATBED_WITH_TEAM' | 'HOPPER_BOTTOM' | 'INSULATED_VAN_OR_REEFER' | 'LOWBOY' | 'LOWBOY_OR_REM_GOOSENECK_RGN' | 'LOWBOY_OVERDIMENSION' | 'MOVING_VAN' | 'OTHER' | 'PNEUMATIC' | 'POWER_ONLY' | 'POWER_ONLY_LOAD_OUT' | 'POWER_ONLY_TOW_AWAY' | 'REEFER_AIR_RIDE' | 'REEFER_DOUBLE' | 'REEFER_HAZMAT' | 'REEFER_INTERMODAL' | 'REEFER_LOGISTICS' | 'REEFER_OR_VENTED_VAN' | 'REEFER_PALLET_EXCHANGE' | 'REEFER_WITH_TEAM' | 'REMOVABLE_GOOSENECK' | 'SPRINTER_VAN' | 'SPRINTER_VAN_HAZMAT' | 'SPRINTER_VAN_TEMP_CONTROLLED' | 'SPRINTER_VAN_WITH_TEAM' | 'STEP_DECK' | 'STEP_DECK_OR_REM_GOOSENECK_RGN' | 'STEPDECK_CONESTOGA' | 'STRAIGHT_BOX_TRUCK' | 'STRAIGHT_BOX_TRUCK_HAZMAT' | 'STRAIGHT_BOX_TRUCK_REEFER' | 'STRETCH_TRAILER' | 'TANKER_ALUMINUM' | 'TANKER_INTERMODAL' | 'TANKER_STEEL' | 'TRUCK_AND_TRAILER' | 'VAN' | 'VAN_AIR_RIDE' | 'VAN_BLANKET_WRAP' | 'VAN_CONESTOGA' | 'VAN_DOUBLE' | 'VAN_HOTSHOT' | 'VAN_INSULATED' | 'VAN_INTERMODAL' | 'VAN_LIFT_GATE' | 'VAN_LOGISTICS' | 'VAN_OPEN_TOP' | 'VAN_OR_FLATBED' | 'VAN_OR_FLATBED_WITH_TARPS' | 'VAN_OR_REEFER' | 'VAN_PALLET_EXCHANGE' | 'VAN_ROLLER_BED' | 'VAN_TRIPLE' | 'VAN_VENTED' | 'VAN_WITH_CURTAINS' | 'VAN_WITH_TEAM' | 'VAN_HAZMAT' | 'HOTSHOT_FLATBED' | 'STRAIGHT_TRUCK' | 'VAN_SPRINTER' | 'REMOVABLE_GOOSE_NECK' | 'TANKER' | 'BOX_TRUCK': Equipment type - `size` string: Equipment size (e.g. 53) - `unit` string: Unit of measure for equipment size - `additionalRequiredServices` string[]: Additional services required for the load (e.g. liftgate, team driver) - `tarpSize` string, nullable: Tarp size required, if applicable - `temperatureRequirement` object, nullable: Temperature control requirements - `required` boolean: Whether temperature control is required - `hasBulkhead` boolean: Whether a bulkhead is required - `zones` object[]: Temperature zones for multi-zone reefer loads - `zoneId` string: Zone identifier - `minTemp` object, nullable: Minimum temperature - `value` number - `unit` 'F' | 'C' - `maxTemp` object, nullable: Maximum temperature - `value` number - `unit` 'F' | 'C' - `rates` object: Pricing information for the load. - `baseRate` string: Base rate in dollars - `lineHaul` string: Line haul rate in dollars - `accessorials` object[]: Accessorial charges - `type` string: Accessorial charge type - `rate` string: Accessorial charge amount in dollars - `totalRate` string: Total rate in dollars - `collectionMethod` 'PrePaid' | 'Collect' | 'ThirdParty' | 'CollectOnDelivery': Payment collection method - `documentDates` string[]: ISO 8601 date strings associated with documents on the load (e.g. BOL date, delivery date) ## Response `200` Load created successfully - LoadDraftCreationResponse: Response returned by the TMS after creating a load from a draft. The `loadNum` field must be present. - `loadNum` string, 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. - `message` string: Optional success or error message from the TMS describing the result of the load creation. - `referenceNumbers` object: Optional reference numbers returned by the TMS (e.g. load number, customer order number, trace IDs). - `shipmentNumber` string - `customerReferenceNumber` string - `customerLoadNumber` string - `releaseNumber` string - `bolNumber` string - `poNumber` string - `proNumber` string - `driverNumber` string - `tractorNumber` string - `trailerNumber` string - `others` object[] - `type` string - `value` string --- [API](https://skmtc.dev/goaugment/apis/webhooks.md) - [All operations](https://skmtc.dev/goaugment/apis/webhooks/llms.txt) - [OpenAPI document](https://skmtc.dev/goaugment/apis/webhooks/revisions/a074b2ada419?raw)