Sign in
Manifests

Manifest Shipments

Declare what shipments are ready for dispatch and will be handed over to the carrier. A manifest is a document that summarises the details of the shipments being handed over to the carrier, such as items, weight, and destination information. With this endpoint, you can compile and submit these details for processing, helping to streamline shipping logistics and ensure compliance with carrier requirements. <br /> <br />You can manifest the shipments using any of the following parameters: <br /> <br />• Shipping location <br />• Shipping account <br />• Shipment status (Picked) <br />• Service code <br />• Container <br /> <br />Note: If none of the aforementioned parameters are used, then all the shipments in the LabelPrinted and Picked status will be manifested, excluding the future shipments or the shipments assigned to a container, respectively.

post/v4/manifests/{carrierCode}

Path parameters

carrierCodestring required

A unique identifier representing the shipping carrier with which the shipments are associated. This code is alphanumeric and helps specify which carrier's requirements and formats are being followed when creating the manifest.

Request body

ShippingLocationIdstring nullable

A unique identifier assigned by the system (ShippingLocationId) or by you (LocationAlias) for the shipping location from which the shipments are being manifested. This information is crucial for linking the manifest to the correct shipping point.

ContainerIdstring nullable

The identifier for the container that holds the shipments being manifested. This field is necessary when shipments grouped together in a container are being manifested. <br /> <br />Note: This information is only required if you want to manifest a container. If provided, make sure to enter the Shipping Location, as all other values are not applicable for this field. Prior to manifesting a container, ensure that you have created one and added the desired shipments to it.

Status'Picked'

Specifies the status of the shipments being manifested. The manifest can only be created for shipments with the Picked status, indicating that they are ready to be despatched. If this status is not specified, then all the shipments in either LabelPrinted or Picked status will be manifested. <br /> <br />Note: This information is not valid when manifesting shipments by container.

ShippingAccountIdstring nullable

A unique identifier assigned by the PRO SHIPPING system for the shipping account associated with the shipments. This information is important for billing and tracking purposes, connecting the manifest to the correct account. If needed, provide this information if you want to manifest shipments by a specific shipping account only. <br /> <br />Note: This information is not valid when manifesting shipments by container.

ServiceCodestring nullable

The code representing the carrier's shipping service selected for the shipments. If needed, provide the desired service code if you want to manifest shipments by a specific service only. <br /> <br />Note: This information is not valid when manifesting shipments by container.

Asyncboolean

A boolean value indicating whether you want to execute the manifest request asynchronously. If set to true, the API will respond immediately with an OK status. The manifest will be processed in the background, allowing you to retrieve the manifest once the processing is complete.

Example request

{
  "ShippingLocationId": "D94E8CFD-604B-4B87-83E9-3F20CAF02837",
  "ShippingAccountId": "88470398-A520-4069-BDF9-69D11D48831A",
  "ServiceCode": "EXPRESS"
}

Response

The shipments have been manifested successfully and all created manifests 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.