API References

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.

Body Params

Add Container Request

string
required
length between 1 and 100

Shipping Location Id
SAPIENT Shipping Location Id (assigned by SAPIENT) or Alias (assigned by you) of the shipping location that this container is for.

string | null

Container Id
The Container Name/Alias for this container
Defaults to a globally unique identifier.

string
required
length between 2 and 2

Destination Country Code
2 Digit ISO Country Code, per ISO 3166 Standard

date | null

Export Date
Automatically set when a container is finalised
Format YYYY-MM-DD

string | null

MAWB
Master Airway Bill number. Must be provided in the following format: nnn-nnnnnnnn.
Must be provided prior to manifesting the container in order for the shipments in the container to be manifested successfully.

string
enum

RM Service
If not supplied the system will apply the default.
Accepted values are:
P - Priority (Default)
E - Economy
S - Surface

Allowed:
string
enum

RM Product
If not supplied the system will apply the default.
Accepted values are:
T - International Tracked (Default)
R - International Tracked and Signed, International Signed
O - International Max Sort

Allowed:
string
enum
required

RM Content Format
Accepted values are:
G = Large
P = Small

Allowed:
string | null

RM OE Code
Royal Mail OE Code
Defaults to GBR

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated about 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago