Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Containers

Get Container

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.

get/v4/containers/{containerId}

Path parameters

containerIdstring required

Container Id <br />SAPIENT Container Id (assigned by SAPIENT) or Alias (assigned by you) for the container.

Query parameters

returnShipmentsboolean

If set to True, the response will return a list of the shipments allocated to the container. <br />Defaults to False if not provided.

Response

Returns a details of the container.

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

CreatedDateUtcstring date-time

Created Date UTC

ManifestNumbersstring[] nullable

Manifest Numbers.

CarrierCodestring nullable

Carrier Code <br />The carrier that the container is for. Only shipments created for this carrier can be added to this container.

ShippingLocationIdstring nullable

Shipping Location Id <br />The assigned Id for this location.

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

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

TotalShipmentsinteger

Total Shipments <br />The total number of shipments in the container.

TotalPackagesinteger

Total Packages <br />The total number of packages in the container

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"
    }
  ]
}