How to use the Metapack Interface

Activating your build processes

You first need to ensure that the following processes are active in the Flow and Process builder in Salesforce:

  1. Create Consignment and Shipping Labels

  2. Create Consignment and Shipping Labels - Manual Launch

  3. Create Order Summary and Fulfillment Order

  4. Deallocate Consignment - Manual Launch

  5. Update Fulfillment Order Product.

Creating a Consignment

Proceed as follows.

  1. Create an order with all the required details, including Order Product and Order Delivery Group.

  2. Click Activate on the Order record page to initiate the order management flow:

  3. The order is generated and the following records are created automatically in Salesforce:

  4. Now that you have created a Fulfillment Order, this can be referred to on the order's Related list, e.g.



    If you wish to include return address details, tick the 'Include Return Address' checkbox on the Fulfillment Order object.

    If you wish to create a Return (as opposed to a Delivery), tick the 'Return Order' checkbox. The shipping address is mandatory for a return order, and the 'Delivery To Address' is the warehouse address.

  5. You can now change any details before connecting to the Metapack Shipping API. Once you have made all your changes, click Create Shipping Labels:



    For the use of Create Shipping Labels and Delete Consignment in the above screenshot, refer to Interacting with the Metapack Shipping API.

  6. The Consignment is created and the required details are captured from the Metapack Delivery Manager response, e.g. the Consignment code, Carrier name, etc.

    These details are held on the object Consignment – CAP_MP_Consignment__c.

Interacting with the Metapack Shipping API

Once an Order has been created, together with an associated Fulfillment Order record, you can use the following two buttons on the Fulfillment Order object record to return and remove Metapack Shipping API labels:

  • Create Shipping Labels - Sends the Fulfillment Order record and related Shipment records to the Metapack Shipping API. Also creates an attachment with the shipping labels on the related Consignment record (refer to Creating a Consignment).

    The following specific fields will need to be populated - otherwise, the process will fail. If these are not available, the process will automatically use the defaults in the custom metadata (refer to XML Response Attribute).

    • Consignment Level Details Flag

    • Consignment Value

    • Consignment Weight

    • Max Dimension

    • Order Number

    • Parcel Count

    • Recipient Address

    • Recipient Name

    • Sender Address

    • Sender Name


    You can also change the status on the Fulfillment Order record to ‘Despatched’ to generate the Shipping API labels.

  • Delete Consignment - Deallocates a Consignment record and deletes it from Metapack Delivery Manager. It also:

    • disassociates the Consignment record from the Shipment and removes the label from the consignment;

    • removes the Consignment code, order number and tracking details from the Consignment and Shipment records.


    It does not delete the Consignment record within Salesforce. Instead, it keeps it linked to the Fulfillment Order record with a ‘Deleted’ status.