---
title: "List Shipments"
method: GET
path: "/public/v3/Shipments"
tags: ["Shipments"]
---

# List Shipments

`GET /public/v3/Shipments`

List all shipments within the specified account.

## Query parameters

- `States` string[]
- `Start` string, date-time
- `End` string, date-time
- `ShipmentIds` string[] — string
- `PageSize` integer
- `PageNumber` integer

## Headers

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

## Response `200`

The requested shipments

- ShipmentResponsePaginatedResponse
  - `totalRecords` integer
  - `pageNumber` integer
  - `pageSize` integer
  - `data` ShipmentResponse[], nullable
    - `shipmentId` string, nullable
    - `publicShipmentId` string, nullable
    - `deviceIds` string[], nullable
    - `autoComplete` boolean
    - `shipFromDate` string, date-time, nullable
    - `etaDate` string, date-time, nullable
    - `shipmentLegs` ShipmentLegResponse[], nullable
      - `mode` string, nullable
      - `driverType` string, nullable
      - `carrierId` string, uuid, nullable
      - `containerId` string, nullable
      - `airWaybill` string, nullable
      - `fromCoordinates` CoordinateResponse
        - `latitude` number, double
        - `longitude` number, double
      - `fromAddress` AddressResponse
        - `street` string, nullable
        - `sublocality` string, nullable
        - `locality` string, nullable
        - `state` string, nullable
        - `country` string, nullable
        - `postalCode` string, nullable
      - `toCoordinates` CoordinateResponse
        - `latitude` number, double
        - `longitude` number, double
      - `toAddress` AddressResponse
        - `street` string, nullable
        - `sublocality` string, nullable
        - `locality` string, nullable
        - `state` string, nullable
        - `country` string, nullable
        - `postalCode` string, nullable
      - `orderNo` integer
      - `legLabel` string, nullable
      - `alertPresetIds` integer[], nullable
      - `isActiveLegOfShipment` boolean
      - `startDateTimeUtc` string, date-time, nullable
      - `completedDateTimeUtc` string, date-time, nullable
      - `arrivalDateTimeUtc` string, date-time, nullable
      - `departureDateTimeUtc` string, date-time, nullable
      - `shipFromDate` string, date-time, nullable
      - `etaDate` string, date-time, nullable
      - `currentEtaUtc` string, date-time, nullable
      - `distanceLeftKm` number, double, nullable
    - `customFields` StringStringKeyValuePair[], nullable
      - `key` string, nullable
      - `value` string, nullable
    - `autoCompleteMinutesDelay` integer
    - `sharedUrl` string, nullable
    - `isShared` boolean, nullable
    - `isStarted` boolean
    - `isDeparted` boolean
    - `isCompleted` boolean
    - `lastLocation` 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
    - `endOfTripConfiguration` EndOfTripConfigurationResponse
      - `sendToCollaborators` boolean
      - `users` string[], nullable
    - `trackerStartDelay` 'ZeroMinutes' | 'ThirtyMinutes' | 'OneHour' | 'OneAndHalfHours' | 'TwoHours' | 'FourHours' — The period of time the tracker should wait before measuring or transmitting data after the start button is pressed. This is ONLY for Solo Pro Devices.
    - `commodities` CommodityDto[], nullable — The list of commodities attached to the shipment
      - `commodityId` integer
      - `name` string, nullable
      - `categoryId` integer
      - `categoryName` string, nullable
      - `customerId` integer, nullable
      - `sourceCommodityId` integer, nullable
      - `isDisabled` boolean
    - `mbolNumber` string, nullable — The Master Bill of Lading Number associated to this shipment.
    - `mbolCarrierScac` string, nullable — The SCAC code of the carrier for the Master Bill of Lading Number associated to this shipment.
  - `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)