Stop Update

​

This endpoint is called when Augie obtains an update to a specific stop on a load (arrival, unload, or departure). Clients should implement this endpoint to receive updates.

Body
required
application/json
  • brokerageLoadInternalId
    Type: string | null
    required

    Optional internal load ID in the TMS. Use loadNumber as the main ID. Will be null if not provided.

  • loadNumber
    Type: string
    required

    The unique identifier for the load

  • stopUpdate
    Type: object · StopUpdate
    required
Responses
  • 200

    Load updated successfully

Request Example for post/callback/stop-update
curl https://api.prod.goaugment.com/callback/stop-update \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "loadNumber": "",
  "brokerageLoadInternalId": null,
  "stopUpdate": {
    "stopSequenceNumber": 1,
    "stopId": "",
    "status": "AT_PICKUP",
    "arrivalTime": null,
    "unloadStartTime": null,
    "unloadEta": null,
    "departureTime": null,
    "timezone": "America/Chicago",
    "accessorials": [
      "AFTER_HOURS"
    ],
    "dockDoor": "",
    "notes": ""
  }
}'
No Body

Load updated successfully