Consignment lifecycle

Learn about the consignment lifecycle used by the Shipping API.

Lifecycle flow

The consignment lifecycle works as follows.

consignment-lifecycle

info

For information about shipping workflows, see Supported workflows.

Lifecycle statuses

Consignment lifecycle statuses are as follows.

Status	Description	Next possible status(es)
`UNALLOCATED`	The consignment is not yet allocated to a carrier service. Adding a parcel to a consignment with status `UNALLOCATED` will not change the status to another status. A consignment must be in status `UNALLOCATED` before it can be modified. If the status is `ALLOCATED` or a later status, delete the allocation of the consignment before modifying it. The consignment can be subsequently reallocated. However, adding or removing parcels or parcel items to or from a consignment does not require the consignment to be in status `UNALLOCATED`.	`ALLOCATED`
`ALLOCATED`	The consignment is allocated to the optimal carrier service associated with your Metapack shipper account. It is possible to generate paperwork for the consignment or a parcel in the consignment. If you have a single-parcel consignment and print its label, the consignment will move from `ALLOCATED` status to `PRINTED` or `READY TO MANIFEST` (whichever is applicable). However, if you have a multi-parcel consignment and print the label for a specific parcel in the consignment, the consignment will remain in `ALLOCATED` status until labels for all of the parcels in the consignment are printed when the status of the consignment will change to `PRINTED` or `READY TO MANIFEST` (whichever is applicable). Adding a parcel to a consignment with status `ALLOCATED` will not change the status to another status. Deleting the allocation of a consignment will the change status from `ALLOCATED` back to `UNALLOCATED`.	`READY TO MANIFEST` `PRINTED` `UNALLOCATED`
`PRINTED`	If the `PRINTED` status is activated for your Metapack shipper account, the consignment moves automatically to `PRINTED` as soon as its labels are generated (printed). The consignment will not be manifested immediately after the labels are generated. This allows you to control when the consignment moves to `READY TO MANIFEST`. Adding a parcel to a consignment with status `PRINTED` will change the status back to `ALLOCATED` until all labels are generated. However, removing a parcel from a consignment does not change the status of the consignment from `PRINTED` to another status. To change the status to `READY TO MANIFEST`, flag the consignment as manifest-ready. Generating paperwork for any parcel in a consignment will not change the status from `PRINTED` to another status. Deleting the allocation of a consignment will the change status from `ALLOCATED` back to `UNALLOCATED`. This status applies only to the Ship and hold and Pre-ship picking optimisation workflows and related sub-workflows, such as Store the paperwork and print later. If you want to make use of this status, you must request Metapack to activate it for your Metapack shipper account.	`READY TO MANIFEST` `ALLOCATED` `UNALLOCATED`
`READY TO MANIFEST`	The consignment is ready to be shipped. It is still possible to generate paperwork for the consignment or a parcel in the consignment. However, this is the last status where you can add or remove parcels or parcel items. Adding a consignment with status `READY TO MANIFEST` to a manifest will change the status to `MANIFESTED`. Adding a parcel to a consignment with status `READY TO MANIFEST` will change the status back to `ALLOCATED` until all labels are generated. However, removing a parcel from a consignment does not change the status of the consignment from `READY TO MANIFEST` to another status. Generating paperwork for any parcel in a consignment will not change the status from `READY TO MANIFEST` to another status. Flagging the consignment as not (or no longer) manifest-ready will change the status from `READY TO MANIFEST` to `PRINTED`. Deleting the allocation of a consignment with status `READY TO MANIFEST` will change the status back to `UNALLOCATED`.	`MANIFESTED` `ALLOCATED` `PRINTED` `UNALLOCATED`
`MANIFESTED`	The consignment has been added to a manifest transmitted to the selected carrier, and the carrier will collect it from the shipping location (warehouse) unless advised otherwise. After a consignment moves to this status, it cannot move back to an earlier status.	`TRACKING`
`TRACKING`	The consignment is being transported by the carrier and is being tracked. Although this status occurs inside the Metapack Platform, it depends on carrier input.	`COMPLETED`
`COMPLETED`	The consignment has reached its final destination and a recipient has acknowledged delivery. Although this status occurs inside the Metapack Platform, it depends on carrier input.

Irrespective of the shipping workflow used, a consignment in the Metapack Platform can move over and back between some statuses. For example, a consignment in status ALLOCATED, PRINTED, or READY TO MANIFEST can move back to UNALLOCATED.

Note

Adding or removing parcel items does not change the status of a consignment.