---
title: "Get Shipments"
method: GET
path: "/v4/shipments/{shippingLocationId}"
tags: ["Shipments"]
---

# Get Shipments

`GET /v4/shipments/{shippingLocationId}`

Provides a list of shipments for the specified shipping location in a given time period.

## Path parameters

- `shippingLocationId` string, required

## Query parameters

- `shippingAccountId` string
- `carrierCode` string
- `status` 'Created' | 'OnHold' | 'Cancelled' | 'ReadyToPrint' | 'LabelPrinted' | 'Confirmed' | 'Picked' — Get Shipments Status Type
- `destinationCountryCode` string
- `dateFrom` string, date
- `dateTo` string, date
- `pageSize` integer
- `pageNumber` integer

## Response `200`

Returns a list of shipments.

- ShipmentsPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `Shipments` ShipmentResponse[], required — Shipments <br />The shipments for the requested page only.
    - `ShippingAccountId` string, uuid — Shipping Account Id
    - `ShipmentId` string, uuid — Shipment Id
    - `TrackingNumber` string, nullable — Tracking Number
    - `BarcodeNumber` string, nullable — Barcode Number
    - `Reference1` string, nullable — Reference 1
    - `ShipmentDate` string, date — Shipment Date
    - `Status` string, nullable — Status
    - `ManifestNumber` string, nullable — Manifest Number
    - `ContainerId` string, nullable — Container Id
    - `Carrier` string, nullable — Carrier Code
    - `DestinationCountryCode` string, nullable — Destination Country Code
    - `LastUpdatedBy` string, nullable — Last Updated By
    - `LastUpdatedDateUtc` string, date-time — Last Updated Date UTC
  - `TotalCount` integer, required — Total Count <br />The total number of shipments matching the request.

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `404` — The shipping location was not found.
- `500` — Internal Server Error

---

[API](https://skmtc.dev/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)