---
title: "List Shipment Templates"
method: GET
path: "/public/v3/ShipmentTemplates"
tags: ["ShipmentTemplates"]
---

# List Shipment Templates

`GET /public/v3/ShipmentTemplates`

Retrieve all shipment templates.

## Query parameters

- `Name` string
- `PageSize` integer
- `PageNumber` integer

## Headers

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

## Response `200`

The requested shipment templates

- ShipmentTemplateResponsePaginatedResponse
  - `totalRecords` integer
  - `pageNumber` integer
  - `pageSize` integer
  - `data` ShipmentTemplateResponse[], nullable
    - `shipmentTemplateId` string, nullable
    - `name` string, nullable
    - `description` string, nullable
    - `isDefaultTemplate` boolean
    - `autoCompleteMinutesDelay` integer
    - `customFields` StringStringKeyValuePair[], nullable
      - `key` string, nullable
      - `value` string, nullable
    - `shipmentLegs` ShipmentLegTemplateResponse[], 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
      - `fromLocationId` integer, nullable
      - `toLocationId` integer, 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
    - `shipmentCollaborators` ShipmentCollaboratorResponse[], nullable — The list of collaborators and their access level
      - `userId` string, nullable
      - `name` string, nullable
      - `email` string, nullable
      - `publicShipmentId` string, nullable
      - `roleName` string, nullable
      - `collaboratorSource` string, nullable
  - `next` string, nullable
  - `previous` string, nullable

## Other responses

- `400` — The requested shipment templates are 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/versions/9a8d869e3cdc/schema)