Add Container

post

https://api.intersoftsapient.net/v4/internationalArrivalsContainers/rm

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.

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.

Body Params

Add Container Request

Add International Arrivals Container Request

ShippingLocationId

string

required

length between 1 and 100

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.

ContainerId

string | null

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.

Note: If not provided, then a globally unique identifier is generated and used as the Container ID.

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

401

Unauthorized

403

Forbidden

500

Internal Server Error

200The container has been successfully created.

400Invalid request response.