Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
International Arrivals Containers

Get Containers

Retrieve detailed information on all the international arrivals containers set up on the customer's account. With this endpoint, you can gain insights into the international containerised shipments, including current statuses, weights, and other relevant details.

get/v4/internationalArrivalsContainers/rm

Query parameters

shippingLocationIdstring

A unique identifier for the shipping location assigned by the system or by you (alias), allowing users to filter the data by the shipping location.

pageSizeinteger

An integer that defines the number of container entries (records) returned per page in the response. For instance, if pageSize is set to 20, the API will return up to 20 containers in each response. <br /> <br />Note: By default, this value is set to 100.

pageNumberinteger

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets. For example, if pageNumber is set to 3, the API will return the results corresponding to the third page of containers based on the specified pageSize. <br /> <br />Note: By default, this value is set to 1.

sortBy'CreatedDateUtc' | 'ContainerId' | 'CarrierCode' | 'ShippingLocationAlias' | 'TotalWeight' | 'TotalShipments' | 'TotalPackages'

Sort By

A string specifying the field by which to organise the search results. For instance, "CreatedDateUtc" could be used to sort containers chronologically, arranging the results in a more user-friendly order. <br /> <br />Note: By default, this value is set to CreatedDateUtc.

sortDir'Ascending' | 'Descending'

Order Direction

A string indicating the direction in which to sort the results, typically set to "ascending" or "descending." For example, setting sortDir to "Ascending" while using "CreatedDateUtc" as sortBy would arrange the container from latest creation date to oldest creation date. <br /> <br />Note: By default, this value is set to Ascending.

containerStatus'Active' | 'Manifested' | 'All'

Container Status

Indicates the current status of the container, helping customers quickly find the containers that meet their specific criteria. <br /> <br />Note: By default, this field is set to Active.

Response

Returns a list of containers.

TotalCountinteger required

An integer indicating the total number of containers that match the query criteria. This count provides you with an overview of how many container records are available in the system based on the filters applied.

Example response

{
  "Containers": [
    {
      "ContainerId": "South East 1234",
      "ContainerBarcode": "CA00000027GB",
      "ShippingLocationAlias": "Northern Warehouse",
      "ShippingLocationId": "93f6d928-9456-434a-9d69-60f3b7dea091",
      "DestinationCountryCode": "GB",
      "Mawb": "125-12345678",
      "RmOeCode": "GBR",
      "TotalWeight": 12.5,
      "TotalShipments": 23,
      "TotalPackages": 23
    }
  ],
  "TotalCount": 32
}