Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
International Arrivals Containers

Update Container

Update the details of an existing international arrivals containers associated with a specific Royal Mail shipment.

put/v4/internationalArrivalsContainers/rm/update/{containerId}

Path parameters

containerIdstring required

An identifier assigned by the SAPIENT system or by you (alias), or a barcode number for this container associated with the shipment, important for managing cargo and logistics at scale.

Request body

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

{
  "DestinationCountryCode": "GB",
  "Mawb": "125-12345678",
  "RmOeCode": "GBR"
}

Response

The container has been successfully updated.