---
title: "Get Shipment Alerts"
method: GET
path: "/public/v3/Shipments/{shipmentId}/alerts"
tags: ["Shipments"]
---

# Get Shipment Alerts

`GET /public/v3/Shipments/{shipmentId}/alerts`

View the alerts that were triggered on the specified shipment.

## Path parameters

- `shipmentId` string, required

## Query parameters

- `Start` string, date-time
- `End` string, date-time
- `PageSize` integer
- `PageNumber` integer

## Headers

- `x-tive-account-id` integer, required

## Response `200`

The requested alerts for shipment

- AlertResponsePaginatedResponse
  - `totalRecords` integer
  - `pageNumber` integer
  - `pageSize` integer
  - `data` AlertResponse[], nullable
    - `alertId` string, nullable
    - `accountId` integer
    - `deviceId` string, nullable
    - `deviceName` string, nullable
    - `shipmentId` string, nullable
    - `publicShipmentId` string, nullable
    - `isClosed` boolean
    - `details` AlertDetailResponse[], nullable
      - `type` string, nullable
      - `details` object, nullable
      - `dateTime` string, date-time
      - `reasons` string[], nullable
      - `location` LocationResponse
        - `name` string, nullable
        - `coordinates` CoordinateResponse
          - `latitude` number, double
          - `longitude` number, double
        - `address` AddressResponse
          - `street` string, nullable
          - `sublocality` string, nullable
          - `locality` string, nullable
          - `state` string, nullable
          - `country` string, nullable
          - `postalCode` string, nullable
        - `formattedAddress` string, nullable
        - `locationMethod` string, nullable
        - `locationOrigin` 1 | 2 | 3 | 4
        - `nodeType` 'Warehouse' | 'ConsumerPickupPoint' | 'DistributionCenter' | 'RiskZone' | 'Airport' | 'Seaport' | 'ProductionFacility' | 'Terminal' | 'BorderCrossing' | 'ServiceStop'
        - `shareLocation` boolean
        - `shareLocationExternally` boolean
        - `includeCollaboratorsWhenSharing` boolean
        - `labels` Label[], nullable
          - `labelId` integer
          - `labelText` string, nullable
    - `trigger` AlertTriggerResponse
      - `alertPresetId` integer
      - `type` string, nullable
      - `triggerValue` string, nullable
      - `triggerUnit` string, nullable
      - `alertOn` string, nullable
      - `intervalDelay` integer, nullable
      - `intervalDelayUnit` string, nullable
      - `isEnabled` boolean, nullable
      - `isActiveAtOrigin` boolean
      - `isActiveInTransit` boolean
      - `isActiveAtDestination` boolean
    - `statusChanges` AlertStatusChangeResponse[], nullable — The status change history for this alert
      - `fromStatus` AlertResolutionStatusResponse
        - `statusId` integer — The ID of this status
        - `statusName` string, nullable — The name of this status
      - `toStatus` AlertResolutionStatusResponse, required
        - `statusId` integer — The ID of this status
        - `statusName` string, nullable — The name of this status
      - `createdAt` string, date-time — The date and time this resolution status change was made
      - `byUserId` string, uuid, nullable — The ID of the user who changed this resolution status (empty for system status changes)
    - `comments` AlertCommentResponse[], nullable — The comment history for this alert
      - `comment` string, nullable — The comment text
      - `formattedComment` string, nullable — The formatted comment text
      - `createdAt` string, date-time — The date and time this comment was created
      - `byUserId` string, uuid, nullable — The ID of the user who created this comment (blank for system generated comments
  - `next` string, nullable
  - `previous` string, nullable

## Other responses

- `400` — The requested shipment is not available
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/tive/apis/tive-public-api.md) · [All operations](https://skmtc.net/tive/apis/tive-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tive/tive-public-api/revisions/9a8d869e3cdc/schema)
