Basic Shipping

This is the simplest workflow, where packing and manifesting take place on the same day.

Consignments are marked as 'Ready to Manifest' automatically in Delivery Manager and the basic assumption is that the date on which labels are printed is also the despatch date.

You typically create and allocate consignments when the order is being packed, with the labels and customs documents being generated by the same call that performs the allocation (despatchConsignmentWithBookingCode). The paperwork is made available at the pack bench. However, refer also to Store the Paperwork and Print Later.

The workflow is as follows:

  1. despatchConsignmentWithBookingCode - Creates a consignment, and, if it is successfully allocated, generates the associated labels and customs documents. The consignment is left at the status of 'Ready to Manifest'.


    It is assumed that the numbers of parcels, and their weights, dimensions, etc., are known at the point that the API call is made.

    This topic makes the assumption that the workflow is set up to move automatically to 'Ready to manifest' (rather than 'Printed') after label printing. Refer to How do I Print and Manifest separately?.


    If a consignment cannot be allocated, you can troubleshoot the results using debugConsignmentWhyNotWithBookingCode.

  2. appendParcelsToConsignment - Allows you to add one or more parcels to an existing consignment if required. It will generate the tracking codes for the new parcels, if necessary, and adjust the consignment weight and value accordingly.

  3. createPaperworkForConsignments, createPaperworkForParcel or createPaperworkForCarton - Allows you to print customs documents to PDF if the usual printing method is ZPL, and also to reprint both labels and customs documents where necessary.

  4. deallocate and then deleteConsignment - Voids any unwanted consignments and labels.


    Parcels that have been manifested cannot be voided.

  5. createManifest - Creates a manifest for a given carrier, warehouse and transaction type, and then sends the manifest to the carrier automatically.


    You can also control your own manifesting using the Delivery Manager GUI (refer to Generating a Delivery Manifest and Generating a bulk Delivery Manifest).

    Although we recommend that you control your own manifesting, we may nevertheless be able to implement auto-manifesting on your behalf, and vary it according to carrier. If you would like to discuss this option, please contact Metapack support.