Manifesting Shipments

  • Ship
  • api
  • manifesting

Once you've created a shipment and allocated it to a carrier service, you're ready to manifest it. This section explains how to use the Manifest Shipment endpoint.

Manifesting Overview

In the context of Ship, the term "manifesting" refers to collating, formatting and transmitting shipment data to carriers. It is the final step of many Ship workflows.

You can only manifest shipments that are in a state of allocated, manifest_failed, or ready_to_ship. If you attempt to manifest a shipment that is not in one of these states then Ship returns an error.

Caution

Every successful request to a manifest endpoint transmits data to a carrier. Therefore, Sorted strongly advise that you time your manifest requests to align with carrier collection times.

Manifesting a shipment changes its state to manifested. At this point the carrier is aware of the shipment, and will collect it unless otherwise advised. In order to prevent the shipment being shipped, you would need to cancel it.

Note

For more information on cancelling see the Cancelling Shipments page.

Once a shipment is manifested you should also look to print labels for the shipment, if you have not already done so. See the Getting Shipment Labels page for an explanation of how to retrieve package labels.

Note

To check a particular shipment's manifest status, make a Get Shipment call. The shipment's state field indicates whether the shipment is manifesting or manifested.

Manifesting a Shipment

The Manifest Shipment endpoint enables you to manifest an individual shipment. To call Manifest Shipment, send a PUT request to https://api.sorted.com/pro/shipments/{reference}/manifest, where {reference} is the unique reference for the shipment you want to manifest.

Once Ship has received the request, it attempts to manifest the specified shipment and returns a manifest_result containing the following information:

  • A unique reference for the manifest item.
  • Details of the carrier and service that the shipment was manifested with.
  • A message providing details of the result.
  • The current state of the shipment as a result of the manifest operation. Ordinarily, this would be manifesting.
  • A link to the generated manifest.
Note

For full reference information on the Manifest Shipment endpoint, see the Ship API reference.

Manifest Shipment Example

The example shows a successful request to manifest shipment sp_00673267200365953327505217421312.

`PUT https://api.sorted.com/pro/shipments/sp_00673267200365953327505217421312/manifest`

Next Steps