---
title: "Get Manifest Request Status"
method: GET
path: "/v4/manifests/manifestStatus/{manifestRequestId}"
tags: ["Manifests"]
---

# Get Manifest Request Status

`GET /v4/manifests/manifestStatus/{manifestRequestId}`

## Request

- Base URL: `https://api.proshipping.net`
- URL: `https://api.proshipping.net/v4/manifests/manifestStatus/{manifestRequestId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://authentication.proshipping.net/connect/token`

Retrieves the current status and details of a specific manifest request ID and, optionally, returns base64 encoded images and detailed manifest information.

## Path parameters

- `manifestRequestId` string, uuid, required

## Query parameters

- `manifestDetail` boolean

## Response `200`

The manifest request status is returned.

- ManifestRequestStatusResponse: Manifest Details Response
  - `FailedReason` ErrorResponse
    - `Message` string, required
    - `Errors` ErrorDetail[], required
      - `Message` string, nullable
      - `Cause` string, nullable
      - `ErrorCode` string, nullable: <br /><br />**E1000** - System error<br />**E1001** - Required field<br />**E1002** - Invalid field<br />**E1003** - Invalid action<br />**E1004** - Item not found<br />
  - `ManifestCount` integer: Total number of manifests created when the manifest request status is complete.
  - `ManifestRequestId` string, uuid: A unique identifier assigned by the system that specifies the manifest request.
  - `ManifestRequestStatus` string, nullable: Indicates the current status of the manifest request. <br /> <br />***Note**: By default, the status is set to Pending.*
  - `Manifests` ManifestResponse[], nullable: An array of manifest objects for the requested page only, matching the query criteria. Each object contains detailed information about individual manifests, such as associated shipments, dates, service, and others.
    - `ManifestImage` string, 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.
    - `ManifestNumber` string, required: A unique identifier for the manifest, allowing for easy tracking and reference of the manifest document within the PRO SHIPPING system.
    - `CarrierCode` string, required: The unique identifier of the carrier associated with the manifest. This confirms which shipping carrier's requirements the manifest adheres to.
    - `Service` string, 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.
    - `TotalWeight` number, 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.*
    - `TotalShipments` integer, required: The total number of shipments included in the manifest, providing a quick overview of how many shipments are being sent.
    - `TotalItems` integer, required: The total count of individual items (packages) within the shipments included in the manifest.
    - `ManifestDate` string, date, required: The date on which the manifest was created, offering a record of when the shipments were officially documented for shipping.
    - `CreatedDateUtc` string, 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.
    - `ShippingLocation` ManifestShippingLocation, required: The shipping location from which the shipments are being manifested, offering additional context about where the shipments originate.
      - `ShippingLocationId` string, uuid, required: A unique identifier assigned by the system (ShippingLocationId) for the shipping location from which the shipments are being manifested. This information is crucial for linking the manifest to the correct shipping point.
      - `LocationAlias` string, required: A unique user-defined identifier for the shipping location, providing a convenient way to identify it, for example, Home or Warehouse.
      - `LocationCountry` string, required: An abbreviation representing the country of the shipping location, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom, ensuring that users have clear geographical context for the shipments being manifested.
      - `LocationPostcode` string, nullable: The postal or ZIP code corresponding to the shipping location, used for sorting and identifying the geographical area of the despatch.
    - `ShippingAccount` ManifestShippingAccount, required: The shipping account associated with the shipments within the manifest.
      - `ShippingAccountId` string, uuid, required: A unique identifier for each shipping account, allowing for efficient reference and management of individual accounts within the system.
      - `AccountName` string, required: The official name of the shipping account as designated by the user or organisation, aiding in easy identification and reference of accounts.
      - `AccountAlias` string, required: A user-defined name for the shipping account, providing a convenient way to reference the account in a more memorable manner.
      - `AccountNumber` string, nullable: The number assigned to the shipping account by the carrier, typically used for tracking shipments and billing purposes.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: The manifest request was not found.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/proshipping/apis/pro-shipping-core-api.md) - [All operations](https://skmtc.dev/proshipping/apis/pro-shipping-core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/proshipping/apis/pro-shipping-core-api/revisions/565d8a8dc1dc?raw)