Update an unallocated consignment

Update an Unallocated consignment. For example, change the order details or shipping rules of a consignment.

Prerequisite: If a consignment is Allocated, use Delete consignment allocation before using this operation.

Note: You must resubmit the mandatory information of the consignment in addition to any other consignment data that you have added or modified.

SecurityBasicAuth
Request
path Parameters
consignmentCode
required
string

Consignment identifier generated by Metapack.

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

One or more items going from the same origin to the same destination being despatched on the same date using the same carrier service.

object (ShippingRules)

For each consignment, you have the option to define specific allocation parameters for that consignment, or you can reuse a predefined allocation rule that you created previously.

Responses
200

Consignment updated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict - Consignment cannot be modified because it is not in the correct consignment lifecycle status

500

Internal Server Error

put/consignments/{consignmentCode}
Request samples
application/json
{
  • "consignment": {
    },
  • "shippingRules": {
    }
}
Response samples
application/json
{
  • "consignment": {
    },
  • "links": [
    ]
}