Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Containers

Get Containers

Provides a list of all containers set up on the system. <br />Information about the associated carrier, shipping location, total weight, number of shipments and packages in the containers will be returned.

get/v4/containers

Query parameters

carrierCodestring

CarrierCode <br />Filter by carrier

shippingLocationIdstring

Shipping Location Id <br />SAPIENT Shipping Location Id (assigned by SAPIENT) or Alias (assigned by you). <br />Filter by shipping location

pageSizeinteger

The maximum number of records per page.

pageNumberinteger

The number of the requested page, starting at 1.

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

Sort By

Sort By <br />Default: CreatedDateUtc

sortDir'Ascending' | 'Descending'

Order Direction

Sort Direction <br />Default: Ascending

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

Container Status

The status of the container <br />Default: Active

Response

Returns a list of containers.

TotalCountinteger required

Total Count <br />The total number of containers available

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
}