Remove a parcel from a consignment

You can remove a parcel from a consignment that is not yet manifested.

Unlike other operations that modify a consignment, parcel operations can be used on a consignment both before and after its status changes to ALLOCATED. However, a consignment cannot be modified in any way after its status changes to MANIFESTED.

Remove parcel request

You need the following to make a remove parcel request.

Parameter Value Description
status UNALLOCATED or
ALLOCATED or
PRINTED or
READY TO MANIFEST		 The consignment lifecycle status.
consignmentCode The consignment identifier generated by Metapack when a consignment is created.
parcelCode The barcode of the parcel.

Using the Remove a parcel from a consignment operation, enter the following information:

  • The consignmentCode of the relevant consignment
  • The parcelCode of the parcel that you want to remove

Example request

Copy
Copied
DELETE /shipping/v1/consignments/{consignmentCode}/parcels/{parcelCode} HTTP/1.1
Host: api.metapack.com
API-Key: Basic Base64-encoded <username>:<password>
Content-Type: application/json

Remove parcel response

204 (No Content)

The status of the consignment is not affected.

If you want to verify that a parcel has been removed from a consignment, you can do either of the following:

  • Use the Search for consignments operation with the query parameter parcelCode={parcelCode} to determine if the specified parcel and consignment are still linked.
  • Use the Get a consignment operation with the consignmentCode and view the parcels listed in the parcels array of the response to determine if the parcel is still part of the specified consignment.

Related tasks