Add a product to a parcel
A change to an order might require you to add a product (item) to a parcel in a consignment that is allocated but 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
.
Note
Adding dangerous goods to a consignment after it has been allocated might break the rules of the selected carrier or carrier service and cause delivery problems.
Add parcel product request
You need the following to make an add parcel product request.
Parameter | Value | Description |
---|---|---|
status |
UNALLOCATED orALLOCATED orPRINTED orREADY 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 Add a product to a parcel operation, enter the following information:
-
The
consignmentCode
of the relevant consignment -
The
parcelCode
of the parcel that you want to modify - Product details
Example request
POST /shipping/v1/consignments/{consignmentCode}/parcels{parcelCode}/items HTTP/1.1
Host: api.metapack.com
API-Key: Basic Base64-encoded <username>:<password>
Content-Type: application/json
{
"item": {
"itemRef": "prod1",
"harmonisedCode": "1",
"countryOfOrigin": "GBR",
"fabricContent": "1",
"description": "prod1",
"itemType": "1",
"quantity": 1,
"value": {
"amount": 10
},
"exportReferenceNumber": "12",
"exportLicenseNumber": "23",
"batteryChemCode": "34",
"weight": {
"value": 1
},
"dangerousGoods": {
"unId": "11",
"shippingName": "ship",
"productClass": "dangerous",
"packagingGroup": "12",
"measurementUnit": "12",
"packagingInstructions": "instruction",
"packagingInstructionSection": "22222",
"quantity": 1,
"packageType": "bag",
"amount": 1,
"regulationAuthority": "ra",
"regulationLevelCode": "1",
"transportationMeans": "12",
"reportableQuantity": true,
"radioActive": false,
"subRiskClass": "22",
"technicalName": "222",
"additionalInfo": "22222",
"overPack": "1111"
}
}
}
Add parcel product response
200
(OK)
The status
of the consignment is not affected.
If you want to verify that a product has been added to 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 theitems
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 theitems
array of the response to determine if the product is present.