---
title: "Stop Update"
method: POST
path: "/STOP_UPDATE"
tags: ["Track & Trace"]
---

# Stop Update

`POST /STOP_UPDATE`

## 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/STOP_UPDATE`
- Auth: none declared
- TypeScript: <https://skmtc.dev/goaugment/apis/webhooks/docs/STOP_UPDATE/post.ts> (a function with typed inputs; its response is checked against the schema)

> v1 equivalent: `stopUpdate` (flat payload).

Sent when a stop's status changes. For example, when a driver arrives at a pickup, departs a facility, or a delivery is completed. Contains the stop sequence, updated status, timing information, and the stop's address when it is known.

## Request body

- StopUpdateEvent: 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` 'STOP_UPDATE', required: Event name for a stop status update.
  - `data` StopUpdate, required: A stop status change at a pickup or delivery.
    - `stopSequenceNumber` integer, required: 1-based stop sequence number
    - `stopId` string: External stop identifier
    - `status` 'AT_PICKUP' | 'AT_DELIVERY' | 'IN_TRANSIT' | 'DELIVERED', required: Status code indicating the current state of the load at the stop
    - `arrivalTime` string, date-time: Arrival time at the stop as a UTC ISO 8601 timestamp ending in `Z`.
    - `departureTime` string, date-time: Departure time from the stop as a UTC ISO 8601 timestamp ending in `Z`.
    - `unloadStartTime` string, date-time: Unload start time as a UTC ISO 8601 timestamp ending in `Z`.
    - `unloadEta` string, date-time: Estimated unload completion time as a UTC ISO 8601 timestamp ending in `Z`.
    - `timezone` string, required: IANA timezone (e.g., America/Chicago) of the stop location.
    - `accessorials` AccessorialsEnum[]
    - `dockDoor` string: Dock door assignment
    - `notes` string: Free-text context
    - `address` StopAddress: Address of this stop, from the load's route. Omitted when no matching route stop is found. When present, every required field below is populated.
      - `company` string: Company or facility name at this address
      - `street1` string, required: Primary street address
      - `street2` string: Secondary address line (suite, unit, etc.)
      - `city` string, required
      - `stateOrProvince` string, required
      - `postalCode` string, required
      - `country` string, required: ISO 3166-1 alpha-2 country code

## Response `200`

Event acknowledged

---

[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)