Sign in
Manifests

Manifest Shipments Async

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/async/{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.

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.

ManifestRequestIdstring nullable

The manifest request id

ManifestRequestStatus'Pending' | 'InProgress' | 'Complete' | 'Failed'

Changes

No recorded changes to this endpoint across all 1 revision of this API.