What Are the Commonly Used Keys in the OrderForm Dictionary?
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
The following table lists the common keys in the dictionary for an OrderForm, and includes a brief description of each key. Where monetary values are involved, the currency version of the dictionary key is shown.
Key |
Definition |
|---|---|
item._cy_iadjust_currentprice |
Contains the current price of the item. Whereas the _cy_iadjust_regularprice key contains the regular price of the item, this key reflects the regular price minus any promotional discounts. |
item._cy_iadjust_regularprice |
Contains the regular price of the item. The DefaultItemPriceCy pipeline component, in the Item Price stage, initializes this key to the value in the _product_list_price key. The RequiredItemPriceCy pipeline component makes sure that this key is initialized. Some promotional components use this key as the basis for price adjustments. For example, if an item is to be reduced by a particular percentage, that percentage is based on the value stored in the _cy_iadjust_regularprice key. |
item._cy_oadjust_adjustedprice |
Total cost of this item. This key contains the current price of the item times the quantity, minus discounts resulting from a promotion or sale. |
item._cy_tax_included |
Value that indicates how much tax is included in the cost of the item. |
item._cy_tax_total |
Total tax for the items of this stock-keeping unit (SKU) number. |
item._n_unadjusted |
Number of items of this SKU that have not participated in a promotional price reduction. |
item._product_* |
Contains information about items of a particular SKU. The key consists of the prefix _product_ followed by the name of the database table column from which the information was retrieved. |
item.cy_placed_price |
The price an item had when it was put in the basket. This key is used to look for price changes during a purchase. |
item.delete |
A flag that indicates that the item should be deleted from the order. This key is set by the QueryCatalogInfo component and used by the RequiredProdInfo component. |
item.discounts_applied |
A dictionary that contains the IDs of the discounts that apply to this item. Keys are the IDs; values are the date-time stamps of the discounts. This key is used by the OrderDiscount (PCR) pipeline component. |
item.list_price |
List price of the item. |
item.quantity |
Number of items of a particular SKU. |
order._Basket_Errors |
A SimpleList object in which pipeline components store basket error messages retrieved from the MessageManager object. |
order._cc_expmonth |
Month in which the user's credit card expires. .gif "Note") Note:
This key is provided for backward compatibility only. Use the PaymentMethodRouter instead.
|
order._cc_expyear |
Day on which the user's credit card expires. Note:
This key is provided for backward compatibility only. Use the PaymentMethodRouter instead.
|
order._cc_number |
Credit card number for the card used to finance this purchase. Note:
This key is provided for backward compatibility only. Use the PaymentMethodRouter instead.
|
order._cy_handling_total |
Total cost for handling the order. This value is initialized by the Handling stage components. Note that the equivalent of decimal type in COM is Currency, so that you must pass this value like strValue = CCur(5.0), otherwise an exception will be thrown. |
order._cy_oadjust_subtotal |
Subtotal of all the items in the items list. This value, which is initialized by the DefaultSubtotal component, represents a total of the item._cy_oadjust_adjustedprice keys for each item in the list. The item._cy_oadjust_adjustedprice key represents the total for a specific item (its quantity times its list price, minus promotional discounts). |
order._cy_shipping_total |
Total cost for shipping the items in the OrderForm. By default, this is the key initialized by every shipping component. |
order._cy_tax_included |
Value that indicates how much tax is included in the cost of the order. |
order._cy_tax_total |
Total tax for this order. This key is initialized by the Tax stage components. How this value is calculated depends on the Tax stage component used. |
order._cy_total_total |
Total cost of the order that includes the order subtotal, shipping, handling, and tax. This value is initialized by the DefaultTotalCy component, and is verified by the RequiredTotal component. |
order._payment_auth_code |
Payment authorization code for the order form. |
order._Purchase_Errors |
A SimpleList object in which components in the Order Processing pipeline (OPP) store purchase error messages that are retrieved from the MessageManager object. |
order._Verify_With |
A dictionary whose keys and values are tested against keys and values in the order form. |
order.cc_name |
Name that appears on the credit card used to finance the purchase. This key is initialized before the submission of the OrderForm object to the OPP. Note:
This key is provided for backward compatibility only. Use the PaymentMethodRouter instead.
|
order.cc_type |
Type of credit card submitted. Valid types are VISA, MC, AMEX, or Discover. The ValidateCCNumber component uses this type as the basis for performing routine validation on the credit card number. Note:
This key is provided for backward compatibility only. Use the PaymentMethodRouter instead.
|
order.order_id |
Unique identifier for this order. |
order.shipment._cy_tax_included |
Total tax for the shipment included in the cost. This is part of the multiple-shipment shipping architecture. |
order.shipment._cy_tax_total |
Total tax for the shipment. This is part of the multiple-shipment shipping architecture. |
order.shipments |
A SimpleList object of dictionaries, one dictionary per shipment. This is part of the multiple-shipment shipping architecture. |
order.shipments._cy_shipping_total |
The shipping totals for each shipment. This is part of the multiple-shipment shipping architecture. |
order.shopper_id |
Unique identifier for the user who submitted this order. This key is initialized before the submission of the order to the OPP. |