Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
International Arrivals Containers

Add Container

Create and name (with and ID or alias) a new international arrivals container to be used for manifesting a specific group of shipments. Define which carrier and shipping location the container should be linked to. <br /> <br />Unlike the common Containers API, the International arrival Containers endpoint is used for Royal Mail shipments that are being imported into GB only. For shipments in these containers, a Data Solution file is generated and sent to Royal Mail, which allows them to associate the shipments in the container with the container ID of the container, for better tracking and visibility purposes.

post/v4/internationalArrivalsContainers/rm

Request body

ShippingLocationIdstring required

A unique identifier for the shipping location assigned by the system or by you (alias) from which the container is being dispatched, ensuring that all containers are correctly linked to their respective shipping points.

ContainerIdstring nullable

An identifier assigned by the SAPIENT system or by you (alias) for this container associated with the shipment, important for managing cargo and logistics at scale. <br /> <br />Note: If not provided, then a globally unique identifier is generated and used as the Container ID.

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. <br /> <br />Note: The date must be in the YYYY-MM-DD format.

Mawbstring nullable

A unique identifier assigned to a specific air freight shipment. If provided, it must be in the nnn-nnnnnnnn format. <br /> <br />Note: This number is vital for tracking and managing the shipment and must be included prior to manifesting the container to ensure that all shipments within the container are successfully manifested.

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: <br /><ul><li>T - International Tracked</li><li>R - International Tracked Signed, International Signed</li><li>O - International Max Sort</li></ul> <br />Note: By default, this field is set to T.

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>

RmOeCodestring nullable

Indicates the Royal Mail OE Code which is used for proper identification and classification of shipments destined for export. <br /> <br />Note: By default, this field is set to GBR.

Example request

{
  "ShippingLocationId": "Central Warehouse",
  "ContainerId": "South East 1234",
  "DestinationCountryCode": "GB",
  "Mawb": "125-12345678",
  "RmOeCode": "GBR"
}

Response

The container has been successfully created.

ContainerIdstring required

The unique identifier assigned to the newly created container. This ID is returned to the user as confirmation that the container has been successfully added to the system.

Barcodestring required

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.

Labelstring required

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

Example response

{
  "ContainerId": "South East 1234",
  "Barcode": "TT12345678GB",
  "Label": "Base64EncodedString…"
}