Update Container

put

https://api.intersoftsapient.net/v4/internationalArrivalsContainers/rm/update/{containerId}

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

Path Params

containerId

string

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.

Body Params

Update International Arrivals Container Request

DestinationCountryCode

string

required

length between 2 and 2

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.

ExportDate

date | null

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.

Note: The date must be in the YYYY-MM-DD format.

Mawb

string | null

A unique identifier assigned to a specific air freight shipment. If provided, it must be in the nnn-nnnnnnnn format.

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

string

enum

Indicates the Royal Mail service associated with the shipment.

Note: This field must be populated with P.

Allowed:

RmProduct

string

enum

Indicates the Royal Mail product type for the shipment.

The accepted values are the following:

T - International Tracked
R - International Tracked Signed, International Signed
O - International Max Sort

Note: By default, this field is set to T.

Allowed:

RmContentFormat

string

enum

required

Indicates the content format of the shipments within the container.

The accepted values are the following:

G - Large letters and parcels
P - Small letters

Allowed:

RmOeCode

string | null

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

Note: By default, this field is set to GBR.

Responses

200

The container has been successfully updated.

401

Unauthorized

403

Forbidden

404

The container does not exist.

500

Internal Server Error

400Invalid request response.