Shipping Interface (MAO and MAWM)

A new interface has been developed to integrate with Metapack Delivery Manager for the Shipping service.

This interface is invoked every time a package is submitted for shipping. It calls Metapack Delivery Manager to create a Consignment.

The Metapack API used to create a Consignment is createAndAllocateConsignmentsWithBookingCode.

Note

The appendParcelsToConsignment API call is out of scope.

The Shipping API creates and allocates a consignment to a carrier service: it does not return the shipping label in the response. The Print API needs to be called for the shipping label to be returned.

Below is the list of fields included in the response from Metapack for a Create Consignment transaction:

Table 5. Shipping Response

Node	Data Type	Description	MAO/MAWM Parcel Component Update
`createAndAllocateConsignmentsWithBookingCodeReturn`
`Consignment`	Consignment	The Consignment that has been despatched.
`createAndAllocateConsignmentsWithBookingCodeReturn.consignment`
`consignmentCode`	String	The unique number of the Metapack Consignment ('DMC…') generated by Delivery Manager.	`ShipResponse /completedShipments /shipmentId`
`carrierCode`	String	The code of the allocated carrier. This is populated by Delivery Manager.	`ShipResponse /completedShipments /carrierCode`
`carrierServiceCode`	String	The code of the allocated carrier service. This is populated by Delivery Manager.	`ShipResponse /completedShipments /serviceType`
`createAndAllocateConsignmentsWithBookingCodeReturn.consignment.parcel`
`number`	Integer	Parcel number within the Consignment.	`ShipResponse /completedShipments /shipmentId`
`trackingCode`	String	The tracking code of the parcel.	`ShipResponse /completedShipments /completedPackages /trackingNumber`
`trackingURL`	String	The URL (if there is one) on the carrier's tracking site.	N/A