Sign in
Containers

Get Containers

Retrieves a list of shipping containers associated with a specific carrier and shipping location. With this endpoint, you can access information about the containers used for shipments, ensuring effective logistics management.

get/v4/containers

Query parameters

carrierCodestring

A unique identifier for the shipping carrier for which container information is being requested. This code is typically alphanumeric and helps in identifying the specific carrier linked to the container.

shippingLocationIdstring

A unique identifier for the shipping location assigned by the system (ShippingLocationId) or by you (LocationAlias). This parameter allows users to filter the results to only those containers associated with a specific shipping site.

pageSizeinteger

An integer that defines the maximum number of containers (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, "CreateDate" could be used to sort containers chronologically, arranging the results in a more user-friendly order. <br /> <br />Note: By default, this field 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",
      "CarrierCode": "RM",
      "ShippingLocationId": "93f6d928-9456-434a-9d69-60f3b7dea091",
      "ShippingLocationAlias": "Northern Warehouse",
      "TotalWeight": 12.5,
      "TotalShipments": 23,
      "TotalPackages": 23
    }
  ],
  "TotalCount": 32
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.