Create a consignment

Create a consignment without allocating it.

Alternatively, you can create it and use shipping rules to allocate it to the optimal carrier service associated with your Metapack shipper account.

Shipping rules enable you to search for an optimal subscribed carrier service by using acceptable and unacceptable collection and delivery days and date and time slots, carrier services, delivery location, and other filtering options.

Prerequisites: The sender of a consignment is a warehouse (shipping location), so warehouses must be configured for your Metapack shipper account. If you want to use shipping rules for allocation, carriers and carrier services must be configured for your account. Refer to API setup data.

Note: If a suitable subscribed carrier service is not found for the consignment, it will still be created but will remain Unallocated.

SecurityBasicAuth
Request
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
201

Consignment created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

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