Update selected properties of an unallocated consignment

You can modify selected properties of an unallocated consignment. These are classed as non-parcel changes.

Any non-parcel changes to a consignment should be completed before it is allocated. If the status of a consignment is ALLOCATED or PRINTED or READY TO MANIFEST, the allocation of the consignment must first be deleted before the consignment can be modified.

A consignment cannot be modified in any way after its status changes to MANIFESTED.

Update consignment selected properties request

You need the following to make an update consignment selected properties request.

Parameter Value Description
status UNALLOCATED The consignment lifecycle status.
consignmentCode The consignment identifier generated by Metapack when a consignment is created.

Using the Update selected properties of an unallocated consignment operation, complete the following steps:

  1. Enter the consignmentCode of the consignment.
  2. Change the desired consignment property.
info

Currently, manifestGroupCode is the only property of a consignment that can be modified by this operation. The parameter is used to group consignments in a manifest.

Example request

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

{
    "manifestGroupCode": "ABCD"
}

Update consignment selected properties response

200 (OK)

Significant parameters in a successful response are as follows.

Parameter Value Description
status UNALLOCATED You can reallocate or delete the consignment, or add parcels to it.

Related tasks