---
title: "Get Containers"
method: GET
path: "/v4/internationalArrivalsContainers/rm"
tags: ["International Arrivals Containers"]
---

# Get Containers

`GET /v4/internationalArrivalsContainers/rm`

Retrieve detailed information on all the international arrivals containers set up on the customer's account. With this endpoint, you can gain insights into the international containerised shipments, including current statuses, weights, and other relevant details.

## Query parameters

- `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.

- object — The paged response containing the entities for the requested page only, and the total number available.
  - `Containers` object[], required — Provides a list of all the containers that match the specified query parameters.
    - `ContainerId` string, nullable — The unique identifier assigned to the container. This ID can be the name or alias assigned to it, if the user assigned alias was not provided in the request, then the **ContainerId** will be returned, ensuring that each container can be distinctly referenced.
    - `ContainerBarcode` string, nullable — The barcode assigned to the container, which is used for tracking and managing the container in the system. This barcode is essential for scanning and identifying the container during transit.
    - `CreatedDateUtc` string, date-time — The date and time, in UTC format, when the container was created. This information is useful for historical tracking and understanding the timeline of shipments.
    - `ShippingLocationAlias` string, nullable — The name or alias of the shipping location associated with the container. Only shipments created for this specific location can be added to this container, ensuring proper handling and organization.
    - `ShippingLocationId` string, nullable — A unique identifier for the shipping location assigned by the system, allowing users to reference and manage specific locations effectively.
    - `ContainerStatus` 'Active' | 'Manifested' — Indicates the current status of the container, providing information on whether it is active or manifested.
    - `DestinationCountryCode` string, required — An abbreviation representing the destination country to which this container will be shipped, typically following the ISO 3166-1 alpha-2 standard, for example, "US" for the United States of America.
    - `ExportDate` string, date, nullable — The date provided by the customer or automatically set by the system when the container is finalised and ready for export. If the container is finalised on a different date, then this date will be overwritten.
    - `Mawb` string, nullable — A unique identifier assigned to a specific air freight shipment.
    - `RmService` 'P' | 'E' | 'S' — Indicates the Royal Mail service associated with the shipment. <br /> <br />***Note:** This field must be populated with P.*
    - `RmProduct` 'T' | 'R' | 'O' — Indicates the Royal Mail product type for the shipment.<br><br>The accepted values are the following:<ul><li><b>T</b> - International Tracked</li><li><b>R</b> - International Tracked Signed, International Signed</li><li><b>O</b> - International Max Sort</li></ul>
    - `RmContentFormat` 'G' | 'P', required — Indicates the content format of the shipments within the container. <br /> <br />The accepted values are the following: <br /><ul><li>**G** - Large letters and parcels</li><li>**P** - Small letters</li></ul>
    - `RmOeCode` string, nullable — Indicates the Royal Mail OE Code which is used for proper identification and classification of shipments destined for export.
    - `ContainerLabel` string, nullable — The printed label for the container, which typically contains the container barcode number.
    - `TotalWeight` number, double — The total weight of the shipments contained within the shipping container. This value is essential for understanding the logistics and capacity of the container.
    - `WeightUnitOfMeasure` 'KG' | 'Grams' — The unit of measurement used for specifying <b>TotalWeight</b>, indicating whether the weight is expressed in kilograms (kg) or grams (g). This provides clarity for weight-related logistics.
    - `TotalShipments` integer — The total number of shipments that are currently included within the container, providing an overview of its capacity and contents.
    - `TotalPackages` integer — The total number of individual packages that are currently within the container, allowing customers to navigate the specifics of their shipments.
  - `TotalCount` integer, required — An integer indicating the total number of containers that match the query criteria. This count provides you with an overview of how many container records are available in the system based on the filters applied.

## 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)