Consolidate a parcel with an outer consignment

You can create a relationship between two consignments by associating a parcel in an “inner” (child) consignment with a parcel in an “outer” (parent) consignment, which facilitates parent-child tracking. Cartonisation refers to the division of an "outer" or "parent" consignment, such as a pallet, into "inner" or "child" consignments ("cartons"), which are then linked to the parent for tracking purposes. Cartonisation allows labels and manifests to be generated for two independent legs of a journey, for separate carriers that have no relationship, and for the consignments to be tracked over both legs.

Consolidate parcel request

You need the following to make a consolidate parcel request.

Parameter Value Description
status UNALLOCATED or
ALLOCATED or
PRINTED or
READY TO MANIFEST		 The consignment lifecycle status.
consignmentCode

The consignment identifier of the inner consignment that contains a parcel that you want to link with a parcel in the outer consignment.

This is generated by Metapack when a consignment is created.
parcelCode The parcel identifier (barcode) of the parcel in the inner consignment that you want to link with a parcel in the outer consignment.

Using the Consolidate a parcel with an outer consignment operation, enter the following information:

  • The consignmentCode of the relevant inner consignment
  • The parcelCode of the parcel in the inner consignment that you want to link to a parcel in an outer consignment
  • The containerConsignmentCode , which is the consignment identifier of the relevant outer consignment
  • The containerParcelCode , which is the parcel identifier of the parcel in the outer consignment that you want to link to the parcel in the inner consignment

Example request

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

{
   "containerConsignmentCode":"string",
   "containerParcelCode":"string"
}

Consolidate parcel response

200 (OK)

The status of both consignments is not affected.

Related tasks