Delete a consignment
if an order is cancelled before the corresponding consignment is manifested, you might want to delete the consignment.
The status of the consignment affects how the delete operation works. If the status is UNALLOCATED, the operation simply deletes the consignment. However, if the status is ALLOCATED or PRINTED or READY TO MANIFEST, the operation first deallocates the consignment and then deletes it.
Delete a consignment request
You need the following to make a delete consignment request.
| Parameter |
Value |
Description |
|---|---|---|
status |
UNALLOCATED orALLOCATED orPRINTED orREADY TO MANIFEST |
The consignment lifecycle status. |
consignmentCode |
The consignment identifier generated by Metapack when a consignment is created. |
Using the Delete a consignment operation, enter the consignmentCode of the consignment.
Delete a consignment response
204 (No Content)
You can use the Get a consignment operation with the consignmentCode to verify that the consignment has been deleted. The operation should return a 404 (Not Found) error.