Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Manifests

Manifest Shipments

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

Asyncboolean

Async <br />Set to true if you don't want to wait for the manifest response. You will get an OK response with no data and can retrieve the manifest at a later point using the API. <br />This will happen in the background, so the manifest won't be available immediately and there's some validation that will not happen (for example, if there are no shipments to manifest)

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

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