Manifests

Get Manifest Details

Retrieves detailed information about a specific shipping manifest associated with a particular carrier. This endpoint provides you with comprehensive data about the shipments included in the manifest, allowing for easier tracking and management of the shipments being delivered.

get/v4/manifests/{carrierCode}/{manifestNumber}/shipments

Request

Base URL
https://api.proshipping.net
URL
https://api.proshipping.net/v4/manifests/{carrierCode}/{manifestNumber}/shipments
Auth
OAuth 2
Client credentials
Token URL: https://authentication.proshipping.net/connect/token

Path parameters

carrierCodestring required

A unique identifier for the shipping carrier associated with the manifest for which details are being requested. This code is alphanumeric and helps ensure that the API accurately references the correct carrier's manifest data.

manifestNumberstring required

A unique identifier for the manifest whose details are being requested. This number allows the API to get the specific information related to that manifest, providing you with accurate data relevant to your shipments.

Response

The manifest, including the shipments manifested, is returned.

ManifestNumberstring required

A unique identifier for the manifest, allowing for easy tracking and reference of the manifest document within the PRO SHIPPING system.

CarrierCodestring required

The unique identifier of the carrier associated with the manifest. This confirms which shipping carrier's requirements the manifest adheres to.

Servicestring required

The shipping service selected for the manifest. If there are multiple services involved, the response will return a mixed designation, categorising the services used.

TotalWeightnumber double required

The total weight of all shipments included in the manifest, typically representing the combined weight of the packages being shipped.

WeightUnitOfMeasure'KG' | 'Grams' required

The unit of measurement for the weight provided, such as TotalWeight, indicating whether the weight is specified in kilograms (KG) or grams (G), ensuring clarity for shipping calculations. <br /> <br />Note: By default, this field is set to KG.

TotalShipmentsinteger required

The total number of shipments included in the manifest, providing a quick overview of how many shipments are being sent.

TotalItemsinteger required

The total count of individual items (packages) within the shipments included in the manifest.

ManifestDatestring date required

The date on which the manifest was created, offering a record of when the shipments were officially documented for shipping.

CreatedDateUtcstring date-time required

A timestamp indicating when the manifest was created, formatted in Coordinated Universal Time (UTC), providing a standard reference for the creation of the document.

Example response

{
  "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"
  },
  "Shipments": [
    {
      "TrackingNumber": "TT000860906GB",
      "BarcodeNumber": "4C0069786000000014AC0",
      "Reference1": "OrderRef56"
    }
  ]
}

Changes

No recorded changes to this operation across all 5 revisions of this API.