Add a parcel to a consignment

Add a parcel to an existing consignment.

If the consignment has already been Allocated, the tracking code for the new parcel is generated automatically and returned in the response.

In addition, the weight and value of the new parcel are added to the weight and value of the consignment.

Note: You can also use this operation if the consignment lifecycle status is Unallocated, Printed, or Ready to manifest. Using this operation resets the status of a modified consignment from Printed or Ready to manifest back to Allocated until all labels are generated.

SecurityBasicAuth
Request
path Parameters
consignmentCode
required
string

Consignment identifier generated by Metapack.

Request Body schema: application/json
required
object (ParcelRequest)

Enter data about each parcel in the consignment.

Responses
201

Parcel added to consignment

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict - Parcel cannot be added because the consignment is in a consignment lifecycle status where it cannot be modified

500

Internal Server Error

post/consignments/{consignmentCode}/parcels
Request samples
application/json
{
  • "parcel": {
    }
}
Response samples
application/json
{
  • "parcel": {
    },
  • "links": [
    ]
}