---
title: "Manifest Shipments"
method: POST
path: "/v4/manifests/{carrierCode}"
tags: ["Manifests"]
---

# Manifest Shipments

`POST /v4/manifests/{carrierCode}`

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).

## Path parameters

- `carrierCode` string, required

## Request body

- ManifestRequest — Manifest Request
  - `ShippingLocationId` string, 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.*
  - `ContainerId` string, 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.*
  - `ShippingAccountId` string, 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.*
  - `ServiceCode` string, nullable — Service Code <br />Populate if want to manifest a specific service only. <br />*Not valid if you are manifesting by container.*
  - `Async` boolean — 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)

## Response `200`

The shipments have been manifested successfully and all created manifests returned.

- ManifestResponse[]
  - `ManifestImage` string, required — Manifest - Base 64 encoded PDF
  - `ManifestNumber` string, required — Manifest Number
  - `CarrierCode` string, required — Carrier Code <br />The carrier that this manifest is for.
  - `Service` string, required — Service <br />The service included in this Manifest. If more than one, Mixed will be returned.
  - `TotalWeight` number, 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.*
  - `TotalShipments` integer, required — Total Shipments <br />The total number of shipments included on this Manifest.
  - `TotalItems` integer, required — Total Items <br />The total number of items (packages) included on this Manifest.
  - `ManifestDate` string, date, required — Manifest Date <br />The date on the manifest.
  - `CreatedDateUtc` string, date-time, required — Created Date UTC <br />The date the manifest was originally created.
  - `ShippingLocation` ManifestShippingLocation, required — Shipping Location <br />The location that this manifest is for.
    - `ShippingLocationId` string, uuid, required — Shipping Location Id <br />The system identifier for this shipping location.
    - `LocationAlias` string, required — Shipping Location Alias <br />Your identifier for this shipping location.
    - `LocationCountry` string, required — Shipping Location Country Code <br />ISO Alpha-2 Country Code
    - `LocationPostcode` string, nullable — Shipping Location Postcode
  - `ShippingAccount` ManifestShippingAccount, required — Shipping Account <br />The account that this manifest is for.
    - `ShippingAccountId` string, uuid, required — Shipping Account Id <br />The system identifier for this shipping account.
    - `AccountName` string, required — Shipping Account Name
    - `AccountAlias` string, required — Shipping Account Alias <br />Your identifier for this shipping account.
    - `AccountNumber` string, nullable — Shipping Account Number <br />The carrier's account number for this account.

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)