Sign in
Manifests

Get Manifests

Retrieves a list of manifests created with a specific carrier. With this endpoint, you can filter manifests based on various criteria, such as shipping locations, accounts, and date ranges, enabling efficient tracking and management of shipment manifests.

get/v4/manifests/{carrierCode}

Path parameters

carrierCodestring required

A unique identifier representing the shipping carrier for which the manifests are being queried. This code is alphanumeric and helps specify which carrier's manifests the request pertains to, ensuring that you retrieve relevant data.

Query parameters

shippingLocationIdstring

A unique identifier assigned by the system (ShippingLocationId) or by you (LocationAlias) for the shipping location from which the shipments are being manifested. This information is crucial for linking the manifest to the correct shipping point.

containerIdstring

An identifier assigned by the PRO SHIPPING system or by you (alias) for the shipping container associated with the shipment, important for managing cargo and logistics at scale.

shippingAccountIdstring

A unique identifier assigned by the PRO SHIPPING system (ShippingAccountId) or by you (AccountAlias) for the shipping account associated with the shipments. This information is important for billing and tracking purposes, connecting the manifest to the correct account. If needed, provide this information if you want to get the manifests by a specific shipping account only.

dateFromstring date

A timestamp indicating the start date for filtering manifests in the query. This allows you to retrieve manifests created after this specified date, providing a way to narrow down the results based on a specified start date. <br /> <br />Note: The date must be in the YYYY-MM-DD format. By default, this date is set to current (today's) date.

dateTostring date

A timestamp indicating the end date for filtering manifests in the query. This provides a cutoff date for the results, allowing you to view manifests generated up to this date. <br /> <br />Note: The date must be in the YYYY-MM-DD format. By default, this date is set to current (today's) date.

pageSizeinteger

An integer specifying the maximum number of manifests to return per page in the API's response. This parameter helps control the volume of data returned, enhancing performance and user experience. <br /> <br />Note: By default, this field is set to 100.

pageNumberinteger

An integer indicating which page of results to retrieve, allowing for pagination of larger datasets. In this field, you can specify the page number to access specific segments of the total manifest records. <br /> <br />Note: By default, this field is set to 1.

Response

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

TotalCountinteger required

An integer representing the total number of manifests that match the specified query criteria.

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
}

Changes

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