Values Commonly Used in the OrderForm Object

  • Article

The following table lists the typical keys in the OrderForm object, and includes a brief description of each key. Where monetary values are involved, the currency version of the dictionary key is shown. For more information about naming conventions and currency data, see Currency Overview.

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 DefaultItemPrice component, in the Item Price stage, initializes this key to the value in the _product_list_price key. The RequiredItemPrice component ensures 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 given 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 number (SKU).
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 given SKU. The key is initialized by the QueryProdInfoADO component. 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 placed in the basket. This key is used to check for price changes during a purchase.
item.delete A flag indicating 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 containing 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 object.
item.list_price List price of the item.
item.quantity Number of items of a given SKU.
order._Basket_Errors A SimpleList object in which components in the OPP store basket error messages retrieved from the MessageManager object.
order._cc_expmonth Month in which the provided credit card expires.
order._cc_expyear Day on which the provided credit card expires.
order._cc_number Credit card number for the card used to finance this purchase. By default, the SaveReceipt component, which persists other information in the OrderForm object, does not save credit card numbers.
order._cy_handling_total Total cost for handling the order. This value is initialized by the Handling stage components (TableHandlingADO, FixedHandling).
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 given item (its quantity times its list price, minus promotional discounts).
order._cy_shipping_total Total cost for shipping the items in the OrderForm object. 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, including the order subtotal, shipping, handling, and tax. This value is initialized by the DefaultTotal 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 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 prior to the submission of the OrderForm object to the OPP.
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.
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 individual 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 prior to the submission of the order to the OPP.

The following table lists the name/value pairs of an OrderForm object and the OPP components that read from or write to the specified pair. Where monetary values are involved, the currency version of the dictionary key is shown. In the case where there are components that use only the non-currency version of the key, both forms are shown. For more information about the naming convention and currency data, see Currency Overview.

Key Read By Written By
item._cy_iadjust_currentprice Not applicable Not applicable
item._cy_iadjust_regularprice Not applicable Not applicable
item._cy_oadjust_adjustedprice Not applicable Not applicable
item._cy_tax_included Not applicable Not applicable
item._cy_tax_total Not applicable Not applicable
item._iadjust_currentprice DbOrderPromoADO, ItemPromo, RequiredItemAdjustPrice, RequiredOrderAdjustPrice ItemPromo, RequiredItemAdjustPrice, SaleAdjust
item._iadjust_regularprice ItemPromo, RequiredItemAdjustPrice, RequiredItemPrice DefaultItemPrice
item._inventory_backorder Not applicable FlagInventory, LocalInventory
item._n_unadjusted DbOrderPromoADO, RequiredOrderInit RequiredOrderInit
item._oadjust_adjustedprice RequiredOrderAdjustPrice, SimpleCanadaTax, SimpleJapanTax, SimpleUSTax, SimpleVATTax DbOrderPromoADO, DefaultOrderSubtotal, RequiredOrderAdjustPrice, RequiredOrderInit
item._oadjust_discount Not applicable RequiredOrderAdjustPrice
item._product_* QueryProdInfoADO Not applicable
item._product_gst SimpleCanadaTax Not applicable
item._product_in_stock FlagInventory Not applicable
item._product_jpn_tax_included SimpleJapanTax Not applicable
item._product_jpn_tax_rate SimpleJapanTax Not applicable
item._product_list_price DefaultItemPrice Not applicable
item._product_local_inventory LocalInventory Not applicable
item._product_pst SimpleCanadaTax Not applicable
item._product_sale_end SaleAdjust Not applicable
item._product_sale_price SaleAdjust Not applicable
item._product_sale_start SaleAdjust Not applicable
item._product_tax_rate SimpleVATTax Not applicable
item._tax_included Not applicable SimpleCanadaTax, SimpleJapanTax, SimpleUSTax, SimpleVATTax
item._tax_total Not applicable SimpleCanadaTax, SimpleJapanTax, SimpleUSTax, SimpleVATTax
item._tax_vat_item Not applicable SimpleVATTax
item.cy_placed_price RequiredItemAdjustPrice RequiredItemAdjustPrice
item.delete RequiredProdInfo, QueryProdInfoADO Not applicable
item.discounts_applied Not applicable Not applicable
item.list_price Not applicable Not applicable
item.quantity DbOrderPromoADO, FlagInventory, LocalInventory, ReduceLocalInventory, RequiredItemAdjustPrice, RequiredOrderInit RequiredOrderInit
item.sku LocalInventory, QueryProdInfoADO, ReduceLocalInventory Not applicable
order._Basket_Errors Not applicable RequiredProdInfo
order._cc_expmonth ValidateCCNumber Not applicable
order._cc_expyear ValidateCCNumber Not applicable
order._cc_number ValidateCCNumber Not applicable
order._cy_handling_total Not applicable Not applicable
order._cy_oadjust_subtotal Not applicable Not applicable
order._cy_shipping_total Not applicable Not applicable
order._cy_total_total Not applicable DefaultTotal, RequiredOrderInit
order._handling_total RequiredHandling, DefaultTotal RequiredOrderInit, DefaultHandling, FixedHandling, LinearHandling, TableHandlingADO
order._oadjust_subtotal RequiredOrderSubtotal, DefaultTotal DefaultOrderSubtotal, RequiredOrderInit
order._payment_auth_code RequiredPayment DefaultPayment, RequiredOrderInit
order._Purchase_Errors Not applicable FlagInventory, LocalInventory, RequiredHandling, RequiredItemAdjustPrice, RequiredOrderCheck, RequiredPayment, RequiredShipping, RequiredTotal, ValidateCCNumber
order._shipping_total RequiredShipping, DefaultTotal DefaultShipping, FixedShipping, LinearShipping, RequiredOrderInit, TableShippingADO
order._shopper_* Not applicable DefaultShopperInfo, QueryProdInfoADO
order._tax_included Not applicable DefaultTax, RequiredOrderInit, SimpleCanadaTax, SimpleJapanTax, SimpleUSTax, SimpleVATTax
order._tax_total DefaultTotal DefaultTax, RequiredOrderInit, SimpleCanadaTax, SimpleJapanTax, SimpleUSTax, SimpleVATTax
order._tax_total_gst Not applicable SimpleCanadaTax
order._tax_total_pst Not applicable SimpleCanadaTax
order._Verify_With RequiredTotal Not applicable
order.bill_to_* Not applicable Not applicable
order.cc_name Not applicable Not applicable
order.cc_type ValidateCCNumber Not applicable
order.date_changed Not applicable Not applicable
order.items Not applicable Not applicable
order.order_id Not applicable RequiredOrderInit
order.ship_to_city Not applicable Not applicable
order.ship_to_country SimpleCanadaTax, SimpleJapanTax, SimpleVATTax Not applicable
order.ship_to_state SimpleCanadaTax, SimpleUSTax Not applicable
order.ship_to_street Not applicable Not applicable
order.ship_to_zip TableShippingADO, TableHandlingADO Not applicable
order.shipment._cy_tax_included Not applicable Not applicable
order.shipment._cy_tax_total Not applicable Not applicable
order.shipments Not applicable Not applicable
order.shipments._cy_shipping_total Not applicable Not applicable
order.shipping_method TableShippingADO, TableHandlingADO Not applicable
order.shopper_id Not applicable Not applicable

Copyright © 2005 Microsoft Corporation.
All rights reserved.