Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Manifests

Print Manifest

Provides base64 encoded image and details for a specific manifest.

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

Path parameters

carrierCodestring required

Carrier Code

manifestNumberstring required

Manifest Number

Response

The manifest, including the PDF, is returned.

ManifestImagestring required

Manifest - Base 64 encoded PDF

ManifestNumberstring required

Manifest Number

CarrierCodestring required

Carrier Code <br />The carrier that this manifest is for.

Servicestring required

Service <br />The service included in this Manifest. If more than one, Mixed will be returned.

TotalWeightnumber double required

Total Weight <br />Sum of the weight of all shipments included on the Manifest.

WeightUnitOfMeasure'KG' | 'Grams' required

The unit of measure used for all weight values in the shipment, expressed in grams and kilograms, for example, DeclaredWeight, ItemWeight. This is crucial for accurately describing shipment weight. <br /> <br />Note: By default, this field is set to KG.

TotalShipmentsinteger required

Total Shipments <br />The total number of shipments included on this Manifest.

TotalItemsinteger required

Total Items <br />The total number of items (packages) included on this Manifest.

ManifestDatestring date required

Manifest Date <br />The date on the manifest.

CreatedDateUtcstring date-time required

Created Date UTC <br />The date the manifest was originally created.

Example response

{
  "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"
  }
}