Consolidate a parcel with an outer consignment

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.

Note: You can use this operation if the consignment lifecycle status of each consignment is Unallocated, Allocated, Printed, or Ready to manifest. Using the operation does not change the status of a modified consignment.

SecurityBasicAuth
Request
path Parameters
consignmentCode
required
string

Consignment identifier of the inner consignment that you want to consolidate with the outer consignment.

parcelCode
required
string

Parcel identifier of the parcel in the inner consignment that you want to consolidate with the outer consignment.

Request Body schema: application/json
containerConsignmentCode
string

The consignment code of the outer consignment with which you want to link an inner consignment.

containerParcelCode
string

The parcel code of the parcel in the outer consignment with which you want to link an inner consignment parcel.

Responses
200

Consignment is successfully consolidated with the outer consignment

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict - Consignment cannot be consolidated because the consignment is in a consignment lifecycle status where it cannot be modified

500

Internal Server Error

post/consignments/{consignmentCode}/parcels/{parcelCode}/consolidate
Request samples
application/json
{
  • "containerConsignmentCode": "string",
  • "containerParcelCode": "string"
}
Response samples
application/json
{
  • "errorCode": "string",
  • "message": "string",
  • "systemMessage": "string",
  • "traceID": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}