---
title: "Get Containers"
method: GET
path: "/v4/containers"
tags: ["Containers"]
---

# Get Containers

`GET /v4/containers`

Provides a list of all containers set up on the system.
<br />Information about the associated carrier, shipping location, total weight, number of shipments and packages in the containers will be returned.

## Query parameters

- `carrierCode` string
- `shippingLocationId` string
- `pageSize` integer
- `pageNumber` integer
- `sortBy` 'CreatedDateUtc' | 'ContainerId' | 'CarrierCode' | 'ShippingLocationAlias' | 'TotalWeight' | 'TotalShipments' | 'TotalPackages' — Sort By
- `sortDir` 'Ascending' | 'Descending' — Order Direction
- `containerStatus` 'Active' | 'Manifested' | 'All' — Container Status

## Response `200`

Returns a list of containers.

- ContainersPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `Containers` Container[], required — Containers <br />The containers for the requested page only.
    - `ContainerId` string, nullable — Container Id <br />The Container Identifier
    - `ContainerStatus` 'Active' | 'Manifested' — Indicates the current status of the container, providing information on whether it is active or manifested.
    - `CreatedDateUtc` string, date-time — Created Date UTC
    - `CarrierCode` string, nullable — Carrier Code <br />The carrier that the container is for. Only shipments created for this carrier can be added to this container.
    - `ShippingLocationId` string, nullable — Shipping Location Id <br />The assigned Id for this location.
    - `ShippingLocationAlias` string, nullable — Shipping Location <br />The shipping location name/alias that this container is for. Only shipments created for this location can be added to this container.
    - `TotalWeight` number, double — Total Weight <br />The total weight of all the shipments currently added to the container.
    - `WeightUnitOfMeasure` 'KG' | 'Grams' — The unit of measure used for all weight values in the shipment, expressed in grams and kilograms, for example, **DeclaredWeight**, **ItemWeight**. This is crucial for accurately describing shipment weight. <br /> <br />***Note:** By default, this field is set to KG.*
    - `TotalShipments` integer — Total Shipments <br />The total number of shipments in the container.
    - `TotalPackages` integer — Total Packages <br />The total number of packages in the container
  - `TotalCount` integer, required — Total Count <br />The total number of containers available

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `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)