---
title: "Get Container"
method: GET
path: "/v4/containers/{containerId}"
tags: ["Containers"]
---

# Get Container

`GET /v4/containers/{containerId}`

Provides details for a specific container.
<br />Information about the associated carrier, shipping location, total weight, number of shipments and packages in the containers will be returned.

## Path parameters

- `containerId` string, required

## Query parameters

- `returnShipments` boolean

## Response `200`

Returns a details of the container.

- GetContainerResponse — Get Container Response
  - `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
  - `ManifestNumbers` string[], nullable — Manifest Numbers.
  - `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
  - `Shipments` ContainerShipments[], nullable — Shipment Details <br />The shipments assigned to the container. Only populated if 'returnShipments' was set to true in the request query parameters.
    - `TrackingNumber` string, nullable — A unique identifier assigned to each shipment linked to the container, allowing users to track the progress and status of the shipment during transit.
    - `BarcodeNumber` string, nullable — A unique barcode associated with each shipment within the container, used for scanning and tracking purposes throughout the shipping process, enabling efficient handling and verification.
    - `Reference1` string, nullable — The shipper's reference for this shipment. This is usually the shipper's order number that is provided to the consumer when the order was made.
    - `ManifestNumber` string, nullable — A unique identifier assigned to a shipping manifest. <br /> <br />***Note:** This field is only populated if the container has been manifested.*

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — The container does not exist.
- `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)