v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Manifests

Get Manifest Request Status

Provides base64 encoded image and details for a specific manifest request id.

get/v4/manifests/manifestStatus/{manifestRequestId}

Path parameters

manifestRequestIdstring uuid required

ManifestRequestId <br /> This is a system Guid

Query parameters

manifestDetailboolean

Manifest Detail <br /> Populate this and set to True to return full manifest details including manifest images. <br /> If set to "False" or not provided, then only manifestId, manifestStatus and manifestCount will be returned in the success response.

Response

The manifest request status is returned.

ManifestCountinteger

0 (Default value) <br />This will represent the total number of manifests that got created when ManifestRequestStatus is complete

ManifestRequestIdstring uuid

the Manifest Request Id

ManifestRequestStatusstring nullable

This is the status of manifest request (Default 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"
      }
    }
  ]
}