Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Manifests

Manifest Shipments Async

By manifesting shipments you declare what shipments are ready for dispatch and will be handed over to the carrier. <br />The API allows you to manifest via the below methods (parameters): <br /> <br />- shipping location <br />- shipping account <br />- shipment status (picked) <br />- service code <br />- container <br /> <br />Note: If no parameters are set, all shipments in the LabelPrinted or Picked status will be manifested (excluding future dated shipments or shipments assigned to a container). <br /> <br />The API response contains a manifest image which should be printed and handed over to the driver (if required).

post/v4/manifests/async/{carrierCode}

Path parameters

carrierCodestring required

Carrier Code

Request body

ShippingLocationIdstring nullable

Shipping Location Identifier <br />SAPIENT Shipping Location Id (assigned by SAPIENT) or Alias (assigned by you) that we are manifesting. <br />
<br />Required if you have more than one shipping location.

ContainerIdstring nullable

Container Id <br />Populate if you want to manifest a container. <br />You must have created the container and added the shipments to manifest to it first. <br />If this is populated, no other values other than the Shipping Location can be populated.

Status'Picked'

Shipment Status <br /> <br />Manifest only the shipments with the status of: <br />Picked <br /> <br />Otherwise all shipments in a Label Printed or Picked status will be manifested. <br />Not valid if you are manifesting by container.

ShippingAccountIdstring nullable

Shipping Account Identifier <br />SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you) that you want to manifest. <br />Populate if want to manifest a specific shipping account only. <br />Not valid if you are manifesting by container.

ServiceCodestring nullable

Service Code <br />Populate if want to manifest a specific service only. <br />Not valid if you are manifesting 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'