Banner
Home Version 6.x Documentation Payment Gateways, Order Forms & Checkout Tokens for emailPlates and Manager side HTML templates

Tokens for emailPlates and Manager side HTML templates

Print

These tokens allow the store owner to setup the confirmation emails and manager side parsed templates in a highly flexible way using individual order information.

The left side ( of the  <<>> demarker ) is available for use in emailPlates (templates for emails sent to the customer and admin) and within the parsed HTML based templates in the store manager areas such as the ones for packing slips and invoices.

The right side ( of the  <<>> demarker ) is only available after the gateway modules start to process the order after successful payment has been received. The orderLoggingHash can be used or changed using codehooks in the processing subroutine of the payment gateway ( gatewayname_order-lib.pl ) and/or within the order logging subroutine ( agora_order_lib.pl ).

When tokens are to be replaced in invoice and packing slip templates the orderLoggingHash will be used along with another hash starting with $in{hash-key-name-here} depending upon the subroutine ( in either the Order_Manager-ext_lib.pl or Order_Manager_custom-ext_lib.pl files ) to replace the tokens. If nothing exists in the hash variable, it will blank out the token.

The tokens in the very bottom section are valid only for emailPlates used at the time of initial order processing.

 

[[year]] <<>> $orderLoggingHash{'year'}
[[day]] <<>> $orderLoggingHash{'day'}
[[month]] <<>> $orderLoggingHash{'month'}
[[orderDate]] <<>> $orderLoggingHash{'orderDate'}
[[invoiceNumber]] <<>> $orderLoggingHash{'invoiceNumber'}
[[customerNumber]] <<>> $orderLoggingHash{'customerNumber'}
[[orderStatus]] <<>> $orderLoggingHash{'orderStatus'}
[[shiptrackingID]] <<>> $orderLoggingHash{'shiptrackingID'}
[[firstName]] <<>> $orderLoggingHash{'firstName'}
[[lastName]] <<>> $orderLoggingHash{'lastName'}
[[fullName]] <<>> $orderLoggingHash{'fullName'}
[[companyName]] <<>> $orderLoggingHash{'companyName'}
[[customerPhone]] <<>> $orderLoggingHash{'customerPhone'}
[[faxNumber]] <<>> $orderLoggingHash{'faxNumber'}
[[emailAddress]] <<>> $orderLoggingHash{'emailAddress'}
[[orderFromAddress]] <<>> $orderLoggingHash{'orderFromAddress'}
[[customerAddress2]] <<>> $orderLoggingHash{'customerAddress2'}
[[customerAddress3]] <<>> $orderLoggingHash{'customerAddress3'}
[[orderFromCity]] <<>> $orderLoggingHash{'orderFromCity'}
[[orderFromState]] <<>> $orderLoggingHash{'orderFromState'}
[[orderFromPostal]] <<>> $orderLoggingHash{'orderFromPostal'}
[[orderFromCountry]] <<>> $orderLoggingHash{'orderFromCountry'}
[[shipToName]] <<>> $orderLoggingHash{'shipToName'}
[[shipToCompany]] <<>> $orderLoggingHash{'shipToCompany'}
[[shipToAddress]] <<>> $orderLoggingHash{'shipToAddress'}
[[shipToAddress2]] <<>> $orderLoggingHash{'shipToAddress2'}
[[shipToAddress3]] <<>> $orderLoggingHash{'shipToAddress3'}
[[shipToCity]] <<>> $orderLoggingHash{'shipToCity'}
[[shipToState]] <<>> $orderLoggingHash{'shipToState'}
[[shipToPostal]] <<>> $orderLoggingHash{'shipToPostal'}
[[shipToCountry]] <<>> $orderLoggingHash{'shipToCountry'}
[[shipToResidential]] <<>> $orderLoggingHash{'shiptoResidential'}
[[shipToInsured]] <<>> $orderLoggingHash{'insureShipment'}
[[shipMethod]] <<>> $orderLoggingHash{'shipMethod'}
[[shippingTotal]] <<>> $orderLoggingHash{'shippingTotal'}
[[salesTax]] <<>> $orderLoggingHash{'salesTax'}
[[tax1]] <<>> $orderLoggingHash{'tax1'}
[[tax2]] <<>> $orderLoggingHash{'tax2'}
[[tax3]] <<>> $orderLoggingHash{'tax3'}
[[discounts]] <<>> $orderLoggingHash{'discounts'}
[[subTotal]] <<>> $orderLoggingHash{'subTotal'}
[[orderTotal]] <<>> $orderLoggingHash{'orderTotal'}
[[user1]] <<>> $orderLoggingHash{'user1'}
[[user2]] <<>> $orderLoggingHash{'user2'}
[[user3]] <<>> $orderLoggingHash{'user3'}
[[user4]] <<>> $orderLoggingHash{'user4'}
[[user5]] <<>> $orderLoggingHash{'user5'}
[[buysafecost]] <<>> $orderLoggingHash{'buySafe'}
[[adminMessages]] <<>> $orderLoggingHash{'adminMessages'}
[[GatewayUsed]] <<>> $orderLoggingHash{'GatewayUsed'}
[[shippingMessages]] <<>> $orderLoggingHash{'shippingMessages'}
[[money_symbol]] <<>> $sc_money_symbol
[[xcomments]] <<>> $orderLoggingHash{'xcomments'}
[[termsOfService]] <<>> $orderLoggingHash{'termsOfService'}
[[discountCode]] <<>> $orderLoggingHash{'discountCode'}
[[user6]] <<>> $orderLoggingHash{'user6'}
[[user7]] <<>> $orderLoggingHash{'user7'}
[[user8]] <<>> $orderLoggingHash{'user8'}
[[user9]] <<>> $orderLoggingHash{'user9'}
[[user10]] <<>> $orderLoggingHash{'user10'}
[[order_payment_type_user1]] <<>> $orderLoggingHash{'order_payment_type_user1'}
[[order_payment_type_user2]] <<>> $orderLoggingHash{'order_payment_type_user2'}
[[GiftCard_number]] <<>> $orderLoggingHash{'GiftCard_number'}
[[GiftCard_amount_used]] <<>> $orderLoggingHash{'GiftCard_amount_used'}
[[customer_order_notes1]] <<>> $orderLoggingHash{'customer_order_notes1'}
[[customer_order_notes2]] <<>> $orderLoggingHash{'customer_order_notes2'}
[[customer_order_notes3]] <<>> $orderLoggingHash{'customer_order_notes3'}
[[customer_order_notesDLtext]] <<>> $orderLoggingHash{'customer_order_notesDLtext'}
[[customer_order_notesDLhtml]] <<>> $orderLoggingHash{'customer_order_notesDLhtml'}
[[mailinglist_subscribe]] <<>> $orderLoggingHash{'mailinglist_subscribe'}
[[wishlist_subscribe]] <<>> $orderLoggingHash{'wishlist_subscribe'}
[[insurance_cost]] <<>> $orderLoggingHash{'insurance_cost'}
[[trade_in_allowance]] <<>> $orderLoggingHash{'trade_in_allowance'}
[[rma_number]] <<>> $orderLoggingHash{'rma_number'}
[[customer_contact_notes1]] <<>> $orderLoggingHash{'customer_contact_notes1'}
[[customer_contact_notes2]] <<>> $orderLoggingHash{'customer_contact_notes2'}
[[account_number]] <<>> $orderLoggingHash{'account_number'}
[[sales_rep]] <<>> $orderLoggingHash{'sales_rep'}
[[how_did_you_find_us]] <<>> $orderLoggingHash{'how_did_you_find_us'}
[[suggestion_box]] <<>> $orderLoggingHash{'suggestion_box'}
[[preferrred_shipping_date]] <<>> $orderLoggingHash{'preferrred_shipping_date'}
[[ship_order_items_as_available]] <<>> $orderLoggingHash{'ship_order_items_as_available'}
[[netProfit]] <<>> $orderLoggingHash{'netProfit'}
[[affiliateID]] <<>> $orderLoggingHash{'affiliateID'}
[[affiliateMisc]] <<>> $orderLoggingHash{'affiliateMisc'}
[[member]] <<>> $orderLoggingHash{'member'}
[[pricingLevel]] <<>> $orderLoggingHash{'pricingLevel'}
[[nl]] <<>> \n


at time of order only - for email templates
[[cart_contents_text]] <<>> $text_of_cart
[[cart_contents_html]] <<>> $html_of_cart
[[cart_contents_html_header]] <<>> $html_of_cart_header
[[xcomments_html]] <<>> $xcomments_html

Last Updated on Sunday, 24 June 2012 03:20  
Banner

 

Copyright © 2001 - 2013 K-Factor Technologies, Inc.



Site Meter

a href=