v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

International Arrivals 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/internationalArrivalsContainers/rm/{containerId}

Path parameters

containerIdstring required

An identifier assigned by the SAPIENT system or by you (alias), or a barcode number of the container for which the details will be returned in the response.

Query parameters

returnShipmentsboolean

A boolean parameter that, when set to true, modifies the response to include a list of shipments allocated to the container. 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 a details of the container.

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

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

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

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

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

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

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

Mawbstring nullable

A unique identifier assigned to a specific air freight shipment.

RmService'P' | 'E' | 'S'

Indicates the Royal Mail service associated with the shipment. Note: This field must be populated with P.

RmProduct'T' | 'R' | 'O'

Indicates the Royal Mail product type for the shipment. The accepted values are the following:<ul><li>T - International Tracked</li><li>R - International Tracked Signed, International Signed</li><li>O - International Max Sort</li></ul>

RmContentFormat'G' | 'P' required

Indicates the content format of the shipments within the container. The accepted values are the following: <ul><li>G - Large letters and parcels</li><li>P - Small letters</li></ul>

RmOeCodestring nullable

Indicates the Royal Mail OE Code which is used for proper identification and classification of shipments destined for export.

ContainerLabelstring nullable

The printed label for the container, which typically contains the container barcode number.

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 used for specifying TotalWeight, indicating whether the weight is expressed in kilograms (kg) or grams (g). This provides clarity for weight-related logistics.

TotalShipmentsinteger

The total number of shipments that are currently included within the container, providing an overview of its capacity and contents.

TotalPackagesinteger

The total number of individual packages that are currently within the container, allowing customers to navigate the specifics of their shipments.

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.

Example response

{
  "ContainerId": "South East 1234",
  "ContainerBarcode": "CA00000027GB",
  "ShippingLocationAlias": "Northern Warehouse",
  "ShippingLocationId": "93f6d928-9456-434a-9d69-60f3b7dea091",
  "DestinationCountryCode": "GB",
  "Mawb": "125-12345678",
  "RmOeCode": "GBR",
  "TotalWeight": 12.5,
  "TotalShipments": 23,
  "TotalPackages": 23,
  "Shipments": [
    {
      "TrackingNumber": "TT000860906GB",
      "BarcodeNumber": "4C0069786000000014AC0",
      "Reference1": "OrderRef71"
    }
  ]
}