---
title: "get shipments"
method: GET
path: "/freights/shipments"
tags: ["Freight"]
---

# get shipments

`GET /freights/shipments`

## Request

- Base URL: `https://stg.wearewarp.com/api/v1`
- URL: `https://stg.wearewarp.com/api/v1/freights/shipments`
- Auth: API key in header `apikey`

## Query parameters

- `page` number
- `pageSize` number
- `orderNumber` string
- `orderId` string
- `shipmentNumber` string
- `shipmentId` string
- `refNumber` string
- `createDateStart` string
- `createDateEnd` string

## Response `200`

successful operation

- GetShipmentsSuccess
  - `data` Shipment[]
    - `shipmentId` string
    - `shipmentNumber` string: The display number (code) of the shipment.
    - `orderId` string
    - `orderNumber` string: The display number (code) of the order.
    - `createDate` string
    - `shipmentType` 'LTL' | 'FTL' | 'PARCEL'
    - `trackingNumber` string: Identifier accepted by POST /freights/tracking. Usually the shipment code (e.g. S-00524-2635).
    - `listItems` ShipmentItem[]
      - `id` string
      - `itemNumber` string
      - `name` string
      - `itemId` string
      - `qty` number
      - `qtyUnit` string
      - `weightUnit` 'lbs' | 'kgs'
      - `weightPerUnit` number
      - `sizeUnit` 'IN' | 'FT'
      - `length` number
      - `width` number
      - `height` number
      - `temperature_limit` object: min/max are absent when the item is not temperature controlled.
        - `min` number
        - `max` number
      - `stackable` boolean
      - `isHazardous` boolean
      - `barcode` string[]: The barcodes of the item (note the singular key in this response).
    - `pickupInfo` DeliveryInfo
      - `contacts` unknown[]
        - unknown
      - `address` Address
        - `street2` string
        - `street` string, required
        - `city` string, required
        - `state` string, required
        - `zipcode` string, required
      - `locationName` string
      - `instructions` string
      - `refNums` unknown[]
        - unknown
      - `windows` unknown[]
        - unknown
      - `appointmentInfo` object
      - `accessCode` string
      - `requiresAppointment` boolean
    - `deliveryInfo` DeliveryInfo
      - `contacts` unknown[]
        - unknown
      - `address` Address
        - `street2` string
        - `street` string, required
        - `city` string, required
        - `state` string, required
        - `zipcode` string, required
      - `locationName` string
      - `instructions` string
      - `refNums` unknown[]
        - unknown
      - `windows` unknown[]
        - unknown
      - `appointmentInfo` object
      - `accessCode` string
      - `requiresAppointment` boolean
  - `total` number
  - `page` number
  - `pageSize` number

## Other responses

- `400`: Bad Request - the request payload is missing fields or contains invalid data.
- `401`: Unauthorized - the apikey header is missing or does not match any active API key.
- `403`: Forbidden - the customer account is suspended. The body carries `message` only, without `code`.
- `429`: Too Many Requests - the quoting rate limit of the API key was exceeded (only POST /freights/quote, /freights/freight-quote and /freights/quote/multi-stops are rate limited; limits apply per UTC hour and per UTC day). The `Retry-After` header holds the number of seconds until the window resets.
- `500`: Internal Server Error - an unknown error has occurred.

---

[API](https://skmtc.dev/wearewarp/apis/warp-api-documentation.md) · [All operations](https://skmtc.dev/wearewarp/apis/warp-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/wearewarp/apis/warp-api-documentation/revisions/01526741bb48?raw)