Manifests

Print Manifest

Retrieves the base64 encoded printable version of a specified manifest for a particular carrier. With this endpoint, you can obtain a formatted document of the manifest that can be printed for shipping purposes, such as for inclusion in shipment packages or for compliance with logistics requirements.

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

Path parameters

carrierCodestring required

A unique identifier for the shipping carrier associated with the manifest being requested. This code is alphanumeric and helps specify which carrier's manifest document should be retrieved, ensuring that you access the correct format and details related to that specific carrier's services.

manifestNumberstring required

A unique identifier for the manifest that you want to retrieve for printing. This number allows the API to locate and return the specific manifest document requested by you, ensuring that you receive the correct information for your shipping needs.

Response

The manifest, including the PDF, is returned.

ManifestImagestring required

The generated manifest document returned as a Base64-encoded PDF. This image represents the finalised version of the shipping manifest based on the submitted details.

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

{
  "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 endpoint across all 1 revision of this API.