Manifesting overview

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.

Rhe term “manifesting” refers to collating, formatting and transmitting shipment data to carriers. It is the final step of many Shipments 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 an error is returned.

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.

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.

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 the Shipments platform 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.

Manifest shipment example

The example shows a successful request to manifest shipment sp_00673267200365953327505217421312.

Manifest shipment request

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

Manifest shipment response

  {
  "results": [
    {
      "reference": "ma_00673536672211162995858760007680",
      "carrier": {
        "reference": "XPDI",
        "name": "XPD International",
        "service_reference": "XPDISU",
        "service_name": "XPD International Supreme"
      },
      "message": "Shipment sp_00673267200365953327505217421312 manifested with XDP Worldwide successfully",
      "state": "manifested",
      "shipment_count": 1,
      "_links": [
        {
          "href": "https://beta.sorted.com/pro/shipments/sp_00673267200365953327505217421312",
          "rel": "shipment",
          "reference": "sp_00673267200365953327505217421312",
          "type": "shipment"
        }
      ]
    }
  ]
}

Next steps