PRproshipping
Manifests

Get Manifest Request Status

Retrieves the current status and details of a specific manifest request ID and, optionally, returns base64 encoded images and detailed manifest information.

get/v4/manifests/manifestStatus/{manifestRequestId}

Request

  • Base URL
    https://api.proshipping.net
  • URL
    https://api.proshipping.net/v4/manifests/manifestStatus/{manifestRequestId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authentication.proshipping.net/connect/token

Path parameters

manifestRequestIdstring uuid required

A unique identifier assigned by the system that specifies the manifest request.

Query parameters

manifestDetailboolean

Used to provide full details of the manifest. If set to true, a complete manifest details, including manifest image will be returned. If set to false, then only manifestRequestId, manifestStatus, and manifestCount are returned. <br /> <br />Note: By default, this field is set to false.

Response

The manifest request status is returned.

ManifestCountinteger

Total number of manifests created when the manifest request status is complete.

ManifestRequestIdstring uuid

A unique identifier assigned by the system that specifies the manifest request.

ManifestRequestStatusstring nullable

Indicates the current status of the manifest request. <br /> <br />Note: By default, the status is set to Pending.

Example response

{
  "Manifests": [
    {
      "ManifestImage": "jVBERw0KGgoAAAANSUhEUgAA.....A4QAAAXcCAYAAAB6Q0CbAAAAAXNSR0IArs4",
      "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"
      }
    }
  ]
}

Changes

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