Create a manifest for future despatch

Add Ready to manifest consignments to a post-dated manifest and clear the consignments from your current transactional flow.

You might want to do this because you expect a large number of orders to go out on a particular day in the future, but you want to leave sufficient time to pack and process them beforehand.

SecurityBasicAuth
Request
Request Body schema: application/json
carrierCode
required
string

Carrier identifier.

shippingLocationCode
required
string

This is the code of the shipping location (warehouse) for which the manifest is to be created, so warehouses must be configured for your Metapack shipper account. Refer to API setup data.

manifestGroupCode
string

Manifest group codes are trailer identifiers that can be used across multiple carriers. You can assign a manifest group code to a consignment before manifesting to facilitate tracing it to a specific trailer.

transactionType
string
Default: "delivery"

Specify the transaction type. Select delivery for a consignment where the goods are being despatched from a warehouse to a consumer. Select pick-up for a return consignment where the goods are being picked up from the consumer and sent back to a warehouse.

Enum: "delivery" "pick-up"
object (ManifestAdditionalSettings)
despatchDate
string <date-time>

Enter the future despatch date.

specificDateOnly
boolean
Default: false

Set to true only if the consignments that are due to be despatched on the specified despatchDate are to be added to the manifest. Otherwise, set it to false.

Responses
201

Manifest created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/manifests
Request samples
application/json
{
  • "carrierCode": "string",
  • "shippingLocationCode": "string",
  • "manifestGroupCode": "string",
  • "transactionType": "delivery",
  • "additionalSettings": {
    },
  • "despatchDate": "2019-08-24T14:15:22Z",
  • "specificDateOnly": false
}
Response samples
application/json
{
  • "links": [
    ]
}