OrderRequestV3AdditionalOptions Property

[This is preliminary documentation and is subject to change.]

A list of optional key value pairs for future or custom properties.

Namespace: Purolator.Webservice.Objects
Assembly: OLS.Webservice.Objects (in OLS.Webservice.Objects.dll) Version: 9.3.0.21647 (9.3.0.21647)

Syntax

C++

ASP.NET

Copy

public List<KeyValueStrings> AdditionalOptions { get; set; }

Public Property AdditionalOptions As List(Of KeyValueStrings)
	Get
	Set

public:
property List<KeyValueStrings^>^ AdditionalOptions {
	List<KeyValueStrings^>^ get ();
	void set (List<KeyValueStrings^>^ value);
}

Property Value

Type: ListKeyValueStrings

Remarks

The following options are entered in the AdditionalOptions fields.

Key = DeliverToPostOffice, Value = Post Office ID	Enter the Post Office ID retrieved from Canada Post to use Direct to Post Office.
Key = DeliverToText, Value = Text to be displayed on the label	For Ship to Store/DFPU, enter a name, phone number, and/or any text relating to pickup.
Key = ConsigneeAddress3, Value = Address Line 3	Add an Address3 field if necessary.
Key = GroupName, Value = Name of Group	Add a group name for use in grouping orders in closeouts.
Key = SMSNumber, Value = Phone Number	Add an SMS number for sending text messages if necessary.
Key = LTLPackageCount, Value = Count	Beginning in 2019, Canadian customs will require a package count for LTL shipments, even if the individual packages are not included in the request. Use the LTLPackageCount field to set the package count.
Key = LTLShipmentNumber, Value = LTL Shipment Number	LTL shipments can optionally be identified with an LTLShipmentNumber. If auto-consolidation is turned on, OLS will consolidate using the LTLShipmentNumber. Note that this value is ignored if auto-consolidation is turned off.
Key = LTLProNumber, Value = Pro number	All LTL Shipments can be identified with a Pro number. Normally, OLS will assign the Pro number, but a pro number sent here will be assigned to the LTL Shipment when auto-consolidated. Note that this value is ignored if auto-consolidation is turned off.
Key = PreventConsolidation, Value = true	Prevents OLS from automatically consolidating multiple LTL shipments going to the same location.
Key = Carrier,Value = Customer's Carrier	Some customers can designate a specific carrier for some orders.
StoreNumber	The store number for Ship to Store.
Key = ClearanceName, Value = Name.	The name of the person for whom the items are clearing.
Key = ClearanceCompany, Value = Company.	The company of the person for whom the items are clearing.
Key = ClearanceAddress1, Value = Address Line.	The first address line of the person for whom the items are clearing.
Key = ClearanceAddress2, Value = Address Line.	The second address line of the person for whom the items are clearing.
Key = ClearanceAddress3, Value = Address Line.	The third address line of the person for whom the items are clearing.
Key = ClearanceCity, Value = City.	The city of the person for whom the items are clearing.
Key = ClearanceProvince, Value = Province.	The province of the person for whom the items are clearing.
Key = ClearancePostalCode, Value = Canadian Postal Code.	The postal code of the person for whom the items are clearing.
Key = ClearanceCountry, Value = "CA".	The country of the person for whom the items are clearing (must be "CA").
Key = ClearancePhone, Value = Phone Number.	The phone number of the person for whom the items are clearing.
Key = ClearanceEmail, Value = Email Address.	The email address of the person for whom the items are clearing.
Key = ShipperClearanceName, Value = Name.	The name of the company for whom the items are clearing.
Key = ShipperClearanceCompany, Value = Company.	The company of the company for whom the items are clearing.
Key = ShipperClearanceAddress1, Value = Address Line.	The first address line of the company for whom the items are clearing.
Key = ShipperClearanceAddress2, Value = Address Line.	The second address line of the company for whom the items are clearing.
Key = ShipperClearanceAddress3, Value = Address Line.	The third address line of the company for whom the items are clearing.
Key = ShipperClearanceCity, Value = City.	The city of the company for whom the items are clearing.
Key = ShipperClearanceProvince, Value = Province.	The province of the company for whom the items are clearing.
Key = ShipperClearancePostalCode, Value = Canadian Postal Code.	The postal code of the company for whom the items are clearing.
Key = ShipperClearanceCountry, Value = "CA".	The country of the company for whom the items are clearing (must be "CA").
Key = ShipperClearancePhone, Value = Phone Number.	The phone number of the company for whom the items are clearing.
Key = ShipperClearanceEmail, Value = Email Address.	The email address of the company for whom the items are clearing.

Examples

Additional options are entered using one or more Key Value pairs. For example, to add 99 for MyValue

Copy

<AdditionalOptions>
    <KeyValueStrings>
        <Key>MyValue</Key>
        <Value>99</Value>
    </KeyValueStrings>
</AdditionalOptions>

Reference

OrderRequestV3 Class

Purolator.Webservice.Objects Namespace

OrderRequestV3AddLanguageSpecificTextSet("LST2C0E9597_0?cpp=::|nu=.");AdditionalOptions Property

Property Value

Reference

OrderRequestV3AdditionalOptions Property