Remove products from a parcel

Removing products from parcels in unmanifested consignments

A change to an order might require removing all units of a product from a parcel in a consignment that is not yet manifested.

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

Remove parcel product request

You need the following to make a remove parcel product 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.
itemRef The internal identifier used by the shipping location (warehouse) for the product item, such as the stock-keeping unit (SKU).

Using the Remove products from a parcel operation, complete the following steps:

  1. Enter the following information:
    • The consignmentCode of the relevant consignment
    • The parcelCode of the parcel that you want to modify
    • The itemRef of the product/item that you want to remove from the parcel
  2. Optional: Use the quantityToDelete query parameter to specify the number of items (with the specified itemRef ) that you want to remove.
info

The quantityToDelete parameter defaults to 1 if you do not specify a quantity.

Example request

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

Remove parcel product response

204 (No Content)

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

  • Use the Search for consignments operation with the query parameter parcelCode={parcelCode} and view the products in the items array of the response to determine if the product is present.
  • Use the Get a consignment operation with the consignmentCode and view the products in the items array of the response to determine if the product is present.

Related tasks