Flag consignment manifest readiness

Flag a Printed consignment as Ready to manifest.

You can then use the Create a manifest for future despatch operation to add the consignment to a post-dated manifest, which will change the status to Manifested.

You can also reallocate or delete the consignment, or add parcels to it. Adding a parcel will change the status to Allocated. Modifying the consignment will require deleting its allocation, which will change the  status to Unallocated.

Alternatively, flag a Ready to manifest consignment as not manifest-ready, which changes the status back to Printed.

You can then reallocate or delete the consignment, or add parcels to it. Adding a parcel will change the status to Allocated. Modifying the consignment will require deleting its allocation, which will change the status to Unallocated.

SecurityBasicAuth
Request
path Parameters
consignmentCode
required
string

Consignment identifier generated by Metapack.

query Parameters
readyToShip
boolean

Set to true to flag a Printed consignment as Ready to manifest. Set to false to move a Ready to manifest consignment back to Printed if no longer manifest-ready.

Responses
204

Consignment status changed

400

Bad Request

401

Unauthorized

409

Conflict - There was a conflict in the change of the consignment lifecycle status

500

Internal Server Error

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