Custom Configurations

The following configurations have been defined for the MAO/MAWM Metapack component:

Table 2. MAO/MAWM Custom Configurations

Key

Value

Description

RateShopShipVias

String (i.e. GRND, 2DAY, 1DAY)

A list of the Ship Vias that can trigger the Rate Shop call to Metapack.

Void

Boolean

Set to ‘1’ to enable the Void screens in MAO.

Version

String

Metapack version.

Timeout

Numeric

The timeout value in milliseconds.

RateEndpoint

String

Endpoint to call when the Rate Shop call is triggered.

ShipEndpoint

String

Endpoint to call when the Shipping call is triggered.

PrintEndpoint

String

Endpoint to call when the Print call is triggered.

VoidEndpoint

String

Endpoint to call when the Void call is triggered.

ManifestEndpoint

String

Endpoint to call when the Manifest call is triggered.

CodFlag

Boolean (i.e. 'false')

Value to pass in the call to Metapack for the CODFlag field.

CodAmount

String (i.e. '0')

Value to pass in the call to Metapack for the CODAmount field.

ConsignmentLevelDetailsFlag

Boolean (i.e. 'false')

Value to pass in the call to Metapack for the consignmentLevelDetailsFlag field.

RecipientNotificationType

String (i.e. 'N')

Value to pass in the call to Metapack for the recipientNotificationType field.

SenderNotificationType

String (i.e. 'N')

Value to pass in the call to Metapack for the senderNotificationType field.

TransactionType

String (i.e. 'Delivery')

Value to pass in the call to Metapack for the transactionType field.

CompanyName

String

Value to pass in the call to Metapack for the companyName field.

ShippingLabelType

String (i.e. 'ShippingLabel')

The type of shipping document requested from Metapack during the Print call for the shipping label.

ShippingLabelFormat

String (i.e. 'ZPL' for MAWM or 'PDF' for MAO)

The format of the shipping document requested from Metapack during the Print call for the shipping label.

ShippingLabelDimension

String (i.e. '6x4')

The dimensions of the shipping document requested from Metapack during the Print call for the shipping label.

ShippingLabelDpi

String (i.e. '300')

The DPI of the shipping document requested from Metapack during the Print call for the shipping label.

CustomsFormType (MAWM only)

String (i.e. 'Customs Form')

The type of shipping document requested from Metapack during the Print call for the customs form.

CustomsFormFormat (MAWM only)

String (i.e. 'ZPL' for an MAWM shipping label, 'PDF' for an MAWM customs form)

The format of the shipping document requested from Metapack during the Print call for the customs form.

CustomsFormDimension (MAWM only)

String (i.e. '6x4')

The dimensions of the shipping document requested from Metapack during the Print call for the customs form.

CustomsFormDpi (MAWM only)

String (i.e. '300')

The DPI of the shipping document requested from Metapack during the Print call for the customs form.

WildCardCollectionDate

Y = ‘*’ is inserted into the ‘Collection Date’ section of the booking code. Mandatory for Click and Collect orders.

N = rateShopRequest/shipment /shipDate is used to populate the ‘Collection Date’ section of the booking code.

Defines if a wild card is used as the collection date part of the booking code.

PickUpStartTimeSource

D = The 'From' time is populated from the DefaultPickUpStartTime parameter below.

A = The 'From' time is populated with a wild card ‘*’, which means any time.

Defines how the ‘From’ time component of the ‘Collection Window’ section of the booking code is populated.

DefaultPickUpStartTime

Values are populated in the format HH:MM.

If the PickUpStartTimeSource parameter above is set to ‘D’, then the value populated in this parameter is used as the ‘From time’ in the Collection Window section of the booking code.

PickUpEndTimeSource

D = The 'To' time is populated from the DefaultPickUpEndTime parameter below.

A = The 'To' time is populated with a wild card ‘*’, which means any time.

Defines how the ‘To’ time component of the ‘Collection Window’ section of the booking code is populated.

DefaultPickUpEndTime

Values are populated in the format HH:MM.

If the PickUpEndTimeSource parameter above is set to ‘D’, then the value populated in this parameter is used as the ‘To time’ in the Collection Window section of the booking code.

WildCardDeliveryDate

Y = ‘*’ is inserted into the ‘Delivery Date’ section of the booking code. Mandatory for Click and Collect orders.

N = rateShopRequest/shipment /requiredDate is used to populate the ‘Delivery Date’ section of the booking code.

Defines if a wild card is used for the delivery date part of the booking code.

DeliveryStartTimeSource

D = The 'From' time is populated from the DefaultDeliveryStartTime parameter below.

A = The 'From' time is populated with a wild card ‘*’, which means any time.

Defines how the ‘From’ time component of the ‘Delivery Window’ section of the booking code is populated.

DefaultDeliveryStartTime

Values are populated in the format HH:MM.

If the DeliveryStartTimeSource parameter above is set to ‘D’, then the value populated in this parameter is used as the ‘From time’ in the Delivery Window section of the booking code.

DeliveryEndTimeSource

D = The 'To' time is populated from the DefaultDeliveryEndTime parameter below.

A = The 'To' time is populated with a wild card ‘*’, which means any time.

Defines how the ‘To’ time component of the ‘Delivery Window’ section of the booking code is populated.

DefaultDeliveryEndTime

Values are populated in the format HH:MM.

If the DeliveryEndTimeSource parameter above is set to ‘D’, then the value populated in this parameter is used as the ‘To time’ in the Delivery Window section of the booking code.

IncludeSymbol

Y = ‘@’ used in the booking code (when the carrier 'service group' is bridged).

N = ‘@’ not used in the booking code.

Defines if ‘@’ is used at the beginning of the booking code. This can be chosen by the client when the Metapack integration is configured.