Sign in
Containers

Get Container

Retrieves details of a particular shipping container associated with a specific carrier and shipping location. With this endpoint, you can access information on a specific container used for shipments, ensuring effective logistics management.

get/v4/containers/{containerId}

Path parameters

containerIdstring required

An identifier assigned by the PRO SHIPPING system or by you (alias) for the shipping container, important for managing cargo and logistics at scale.

Query parameters

returnShipmentsboolean

A boolean parameter that, when set to true, modifies the response to include a list of shipments allocated to the container. <br /> <br />Note: By default, this field is set to false, meaning that only the container's general details will be returned unless specified in the request.

Response

Returns the details of the container.

ContainerIdstring nullable

An identifier for the shipping container, important for managing cargo and logistics at scale.

ContainerStatus'Active' | 'Manifested'

Indicates the current status of the container, providing information on whether it is active or manifested.

CreatedDateUtcstring date-time

A timestamp indicating when each container was created, formatted in Coordinated Universal Time (UTC). This allows users to track the age and relevance of their container records.

ManifestNumbersstring[] nullable

Unique identifiers for the manifests associated with the container. This field is populated only if the container has been manifested, ensuring seamless audit trails and helps customers verify and track the overall shipment manifest that includes all shipments within the container.

CarrierCodestring nullable

The unique identifier for the carrier associated with each container. This confirms which carrier is linked to the container, essential for logistics tracking.

ShippingLocationIdstring nullable

A unique identifier for the shipping location assigned by the system from which the container originates. With it, you can track and manage containers by a particular location.

ShippingLocationAliasstring nullable

A unique user-defined identifier for the shipping location associated with the container, making it easier to reference and identify locations.

TotalWeightnumber 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 for the weight provided, such as TotalWeight, indicating whether the weight is specified in kilograms (KG) or grams (G), ensuring clarity for shipping calculations. <br /> <br />Note: By default, this field is set to KG.

TotalShipmentsinteger

The total number of shipments contained within the specified container. This field helps users understand the shipping capacity and complexity of the container.

TotalPackagesinteger

An integer representing the total number of packages contained within the shipments linked to the container. This information helps users understand the volume of packages being transported.

Example response

{
  "ContainerId": "South East 1234",
  "CarrierCode": "RM",
  "ShippingLocationId": "93f6d928-9456-434a-9d69-60f3b7dea091",
  "ShippingLocationAlias": "Northern Warehouse",
  "TotalWeight": 12.5,
  "TotalShipments": 23,
  "TotalPackages": 23,
  "Shipments": [
    {
      "TrackingNumber": "TT000860906GB",
      "BarcodeNumber": "4C0069786000000014AC0",
      "Reference1": "OrderRef71"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.