Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Manifests

Get Manifests

Provides list of manifests created in a given time period for a specific carrier.

get/v4/manifests/{carrierCode}

Path parameters

carrierCodestring required

Carrier Code

Query parameters

shippingLocationIdstring

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

containerIdstring

Container Id <br />SAPIENT Container Id (assigned by SAPIENT) or Alias (assigned by you) for the container. <br />Filter by container id

shippingAccountIdstring

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

dateFromstring date

Date From <br />Defaults to Today's date if not provided. <br />Format: YYYY-MM-DD

dateTostring date

Date To <br />Defaults to Today's date if not provided. <br />Format: YYYY-MM-DD

pageSizeinteger

The maximum number of records per page.

pageNumberinteger

The number of the requested page, starting at 1.

Response

Returns details of the manifests produced or an empty list if none were found.

TotalCountinteger required

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

Example response

{
  "Manifests": [
    {
      "ManifestNumber": "ISH2802532",
      "CarrierCode": "RM",
      "Service": "Mixed",
      "TotalWeight": 545.612,
      "TotalShipments": 562,
      "TotalItems": 562,
      "ManifestDate": "2024-07-16",
      "CreatedDateUtc": "2024-07-16T09:20:54.397Z",
      "ShippingLocation": {
        "LocationAlias": "Main Warehouse",
        "LocationCountry": "GB",
        "LocationPostcode": "TW20 0HJ"
      },
      "ShippingAccount": {
        "AccountName": "AB VideoGames",
        "AccountAlias": "Account 1",
        "AccountNumber": "0123456789"
      }
    }
  ],
  "TotalCount": 32
}