1. Metapack
  2. Shipping
  3. SOAP Shipping API
  4. Consignment Service

Consignment Service Methods

The methods in this service allow you to manage your consignments and to print off the requisite paperwork following allocation. They are as follows:

  • addConsignmentsToGroup - This method assigns a manifest group code to an array of consignments in readiness for manifesting.

  • addInnerToOuter - This method allows you to establish a relationship between two consignments, by associating a parcel in an inner (child) consignment with a parcel in an outer (parent) consignment. This facilitates parent-child tracking (refer to Cartonisation (parent-child)).

  • appendParcelsToConsignment - This method allows you to add one or more parcels to an existing consignment.

  • createConsignments - This method allows you to create one or more consignments without allocating them (if, for example, you are shipping to store and first need to create the parent pallet).

  • createPaperworkForCarton - This method creates the labels and customs documents for a particular carton ID within an allocated consignment (assuming that your OMS or WMS operates on carton values, as opposed to consignment codes).

  • createPaperworkForConsignments - This method creates the labels and customs documents for one or more allocated consignments.

  • createPaperworkForParcel - This method creates the labels and customs documents for a parcel within a consignment.

  • deleteConsignment - This method allows you to remove unwanted consignments, provided that they are unallocated.

  • deleteParcelFromConsignment - This method allows you to remove a parcel from an existing, multi-parcel consignment by specifying its sequence number in the Parcels Array.

  • deleteParcelFromConsignmentWithCartonId - This method allows you to remove a parcel from an existing, multi-parcel consignment by specifying its carton ID.

  • markCartonReadyToManifest - For those sellers whose OMS or WMS operates on carton values, this method allows you to flag a 'Printed' carton as 'Ready to Manifest'. The method assumes that your workflow moves to 'Printed' after label printing (instead of 'Ready to manifest' - refer to How do I Print and Manifest separately?).

  • markConsignmentsAsReadyToManifest - This method allows you to flag an array of 'Printed' consignments as 'Ready to Manifest'. The method assumes that your workflow moves to 'Printed' after label printing (instead of 'Ready to manifest' - refer to How do I Print and Manifest separately?).

  • packProductsToParcel - This method allows you to add a Products Array to an existing parcel within a consignment.

  • removeConsignmentsFromGroup - This method removes a manifest group code from an array of consignments.

  • removeInnerFromOuter - This method allows you to unlink an inner (child) consignment from its outer (parent) consignment, so that you can then, if required, link it to a different outer consignment (an inner consignment can have only one outer consignment).

  • scanCartonToManifestGroup - This method allows you to assign a new manifest group code to an existing carton (assuming that your OMS or WMS operates on carton values, as opposed to consignment codes).

  • scanOrderToManifestGroup - This method allows you to assign a new manifest group code to the consignment(s) associated with an existing order number, in readiness for manifesting.

  • unpackProductsFromParcel - This method allows you to remove a Products Array from an existing parcel within a consignment.

  • update - This method allows you to update specific numeric and text properties for an existing, unallocated consignment, provided that it is defined at a consignment, rather than a parcel, level. You can do this without having to redefine the entire consignment (as you do with updateConsignments).

  • updateConsignments - This method is used to update one or more existing, unallocated consignments.