KnowledgeCenter/AmeriCommerce/Theming & Site Design

What Merge Codes are available?

Support Agent
posted this on September 01, 2012 03:07

 
 

Types of Merge Codes

  • There are normal merges that just replace the data like##PRODUCTNAME##. If it is a page with a product on it, that merge will get replaced by the product's name.
  • There are conditional merges that allow you to optionally place content on the page, like ##IF[StoreID=1]## True Content ##ELSE## False Content ##ENDIF##
  • There are merges that do something special like ##SEARCHBOX##. This will evaluate to a search box with a submit button next to it.
  • There are merges that have settings like ##EXTERNALCONTENT[http://www.google.com]##. The settings can give it more information and allow it to be customized.
  • There are control merges that evaluate to an actual control on the page. This is another way to reference snapins and put them where you want to see them. These look like $$PRODUCTNAME$$
  • Shared Content Merges, defined in the Site Explorer, can be used just like a pre-defined merge code. Typically they are used to share text across on multiple storefronts while keeping a single instance for easy updating.

Search

Expand All | Collapse All

General Use Website Merges

  • ##SESSIONADCODE## - Displays the adcode from the visiting session. This merge code is available throughout every page in the system, not for emails.
  • ##SESSIONAFFILIATECODE## - Displays the affilate code from the visiting session. This merge code is available throughout every page in the system, not for emails.
  • ##SESSIONCUSTOMERTYPE## - Displays the customer type set on the visiting session. This merge code is available throughout every page in the system, not for emails.
  • ##SESSIONCUSTOMERTYPEID## - Displays the customer type ID set on the visiting session. This merge code is available throughout every page in the system, not for emails.
  • ##SESSIONSOURCE## - Displays the visitor source (Google, Bing, Yahoo, PPC, etc.) where a customer came to the site from. This merge code is available throughout every page in the system, not for emails.
  • ##SESSIONSOURCEGROUP## - Displays the visitor source group (unknown spider, search engine in the case of referring domain, etc.) This merge code is available throughout every page in the system, not for emails.
  • ##CATEGORYDROPDOWN[catID=447~451,width=100px,defaulttext=Select...]## - A dropdown list of the categories and it's subcategories, when you select one it navigates to that page.
    • catID: the id of the category to show, it will show all subcategories of that category in it
    • defaulttext: the text to show in the dropdown when nothing is selected
    • width: the width of the combo box on the page
  • ##MANUFACTURERDROPDOWN[width=100px,defaulttext=Select...]## - A dropdown list of store manufacturers, when you select one it navigates to that page.
    • defaulttext: the text to show in the dropdown when nothing is selected
    • width: the width of the combo box on the page
  • ##LOGINLOGOUTLINK## - A login/logout merge that will flip flop between login and logout based on the customer's login status.
  • ##LOGINLOGOUTLINK[loginpage=login2.aspx,redirect=default.aspx,registerurl=register.aspx]##, optional parameters
    • loginpage - tells which login page to use (login.aspx or login2.aspx or other)
    • redirect - tells it where you want it to go once the user is logged in
    • registerurl - tells it where to go if they need to register for an account
  • ##LOGINMESSAGE[message=You are now logged in!]## - Only shows up when the user is logged in, gives them a welcome message, helps show they are logged in
  • ##LOGINMESSAGE[message=Welcome ##CUSTOMERFIRSTNAME##!]## - Notice this is a merge within a merge. To get a comma, use the character entity code for it: #44 (without the space after the ",").
  • ##CUSTOMERLOGIN[Width=123,Class=XYZ,ButtonImage=/images/btnLogin.gif]## - Allows you to position the login form anywhere in your site.
  • ##EMAILPAGELINK## - Allows you to send the current URL to a friend or coworker, it just sends a URL of the page by email using the standard email client at this time.
  • ##EXTERNALCONTENT[http://www.externalurl.com/filename.htm]## - Will pull the content from an external source and put it right there on the page!
    • ##EXTERNALCONTENT[/page.html]## - References the external file relatively with a leading "/"
  • ##CUSTOMFORM[/store/pg/3-test.aspx,100]## - This will pull an html form into an iFrame and pull in the url
    • URL can be external (http://www.google.com/registration.html ) or internal (/store/pg/3-test.aspx). It just reads the content of the form into an iframe.
    • The 2nd value will override the height of the iframe.
  • ##BINGCASHBACK## - Put this merge on the order confirmation page in a custom html snapin to submit your order to Bing Cash Back for processing, insert your Bing Cash Back ID under store settings
  • ##QUICKADDTOCART## - This puts a text box where when an item number is entered into it, it will add that item number and a quantity of 1 to the cart. Does not work if the product has variants or personalization.
  • ##SEARCHBOX## - Evaluates to a search box control with a submit button next to it
    • ##SEARCHBOX[catID=15|16|17]## - Optionally show a category dropdown containing the categories listed to limit the search to those categories. List must be a pipe (|) delimited list of category IDs. Category IDs can be found on the category list page.
    • ##SEARCHBOX[autocomplete=true]## - Turns on auto completion and will search the catalog for whatever is typed and show a dropdown of options.
  • ##SHOPCARTLINE## - Shows a 1 line shopping cart that is just a count of products in the cart and the price, its a link that goes to the cart
    • Example: 4 item(s) - $454
  • ##CARTITEMSCOUNT## - Shows just the number of items in the cart.
  • ##CARTSUBTOTAL## - Shows the subtotal for the cart
  • ##CARTSHIPPING## - shows the shipping amount for the cart if a shipping method has been selected.
  • ##TRIM[200]## Content ##ENDTRIM## - Trims content to a specified number of characters.
  • ##PRICEOF[ID=10]## - Displays the price of the product with the indicated ID.
  • ##QUANTITYPRICEGRIDOF## or ##QUANTITYPRICEGRIDOF[1234]## - Displays the advance pricing of the current product or of the product belonging to the passed in ID.
  • ##PAYPALEXPRESSCHECKOUT[size=small]## - Displays the PayPal Express Checkout button. Size of this button can be either small or large.
  • ##GOOGLECHECKOUT[size=small,bg=white,variant=text]## - Displays the Google Checkout button. Size can be "small," "medium," or "large," background color can be "white" or "transparent," variant can be either "text" or "no-text."
  • $$AMAZONCHECKOUTBUTTON$$ - displays the checkout by amazon button on the shopping cart page.
  • ##PAGETITLE## - Title of web page as seen in titlebar
  • ##IPADDRESS## - Displays the current browser's IP
  • ##MAPPRICELINK## - Displays the MAP pricing message as a link that opens a popup window
  • ##HIDEBYID## - Prevents an element from rendering.
  • ##CURRENTDATE[]##- Displays Text Formated Curent Date ##CURRENTDATE[]## "8/30/2010" ; ##CURRENTDATE[yyyy]## "2010" ;##CURRENTDATE[yyyy/MM/dd]## "2010/08/30"
  • ##QUERYSTRING[name]##- Displays the value from the querystring and put it in place of this merge.
    • Example: The ##QUERYSTRING[qty]## merge ran against a url of myurl.com/page.html?id=5&qty=6 will display a 6 in place of the merge
  • ##IMAGERESIZER[]## - Uses the Image Resizer to render an image url for the given image. Accepts paramerters: path, lr, bw, w, bh, & h
    • Example: ##IMAGERESIZER[path=##ITEMPHOTOURL##,bw=50,lr=t]## - This uses the product photo url as the image path, sets the max width to 50 and locks the ratio (size proportionally)
    • TIP: this needs to be used within html as it simply creates a url. e.g. <img src="##IMAGERESIZER[path=##ITEMPHOTOURL##,bw=50,lr=t]##">
  • ##ITEMPHOTOURLCSV## - Returns a CSV of all product photos
  • ##ACCEPTEDCREDITCARDLOGOS## Will display logos for the store accepted credit cards.
  • ##ROOTCATID## - Renders the store root category id

Social Networking Merges

  • ##SOCIALBOOKMARKS##
NOTE: In order for the Facebook merges to work correctly in IE you need to add xmlns:og="http://opengraphprotocol.org/schema/" xmlns:fb="http://www.facebook.com/2008/fbml" to the HTML tag attributes in the Global Settings page of your theme.
  • ##FACEBOOKLIKEBUTTON## - Creates a like button that will “Like” current page that the merge is placed on
  • ##FACEBOOKLIKEBUTTON[specific url]##
  • ##FACEBOOKLIKEBUTTONWITHCOUNT##
  • ##FACEBOOKLIKEBUTTONWITHCOUNT[specific url]##
  • ##FACEBOOKLIKEBUTTONWITHCOUNTBOX##
  • ##FACEBOOKLIKEBUTTONWITHCOUNTBOX[specific url]##
  • ##FACEBOOKLIKEURL[http://some.url]## - Creates a like button that will “Like” the given URL (defaults to the current URL)
  • ##F>ACEBOOKJS##-will include Facebook’s javascript
  • ##FACEBOOKLIKEBOX[ ]##
  • ##FACEBOOKCOMMENTS##
    • Used in conjuction with the "Facebook Application ID" setting on the Advanced tab of the Theme Manager.
      • By default the merge will use AmeriCommerce's appId which means you will not be able to moderate your own comments. We strongly encourage you to enter your own appId so that you will have control over your Facebook comments. The appId is also appended to the Facebook Javascript includes and will be used anywhere that it is needed once it is set.
    • Documentation about the comments box and the options it supports are located here: http://developers.facebook.com/docs/reference/plugins/comments
    • The xid for the Facebook comments tag is a unique identifier that it uses to store the comments for a given page or item. If you wanted the comments to be shared across a category you could provide the category ID. If you wanted them for a particular product you could use a product id or an item number. Note: The default value for a URL is not a valid xid value, if you plan to use a URL, it has to be encoded.
      • An example of a good xid value might be something like this (using nested merges): ##FACEBOOKCOMMENTS[xid=catid_##CATID##]##
    • We support all of the same options.
      • To put width=”325” in the fb:comments tag, then use ##FACEBOOKCOMMENTS[width=325]##
      • To use additional options, i.e. numposts=”2” width=”425” then use ##FACEBOOKCOMMENTS[numposts=2,width=425]##

Affiliate Based Merges.

Typically used in affiliate emails sent from the affiliate system.
  • ##AFFILIATENAME## - Name of the affiliate
  • ##AFFILIATEEMAIL## - Email address of the affiliate
  • ##AFFILIATECENTERLINK## - URL to the affiliate system for affiliates to login
  • ##AFFILIATELOGIN## - Login id for the affiliate account
  • ##AFFILIATEPASSWORD## - Password for the affiliate account
  • ##AFFILIATELINK## - Link the affiliate uses to send people to your site

Subscription Based Merge Codes

These work in emails that have subscription context.
  • ##SUBSCRIPTIONID## - Displays ID of the subscription
  • ##SUBSCRIPTIONNEXTDATE## - Displays the subscription's next due date.
  • ##SUBSCRIPTIONFREQUENCY## - Displays the frequency. (number value)
  • ##SUBSCRIPTIONFREQUENCYTYPE## - Displays the frequency type. (days, weeks, months)

Cart Based Merge Codes work in emails that have cart context.

  • ##CARTITEMS## - Displays the contents of the cart.
  • ##CARTITEMSHTML## - Displays the contents of the cart in HTML format.
  • ##CARTLINK## - Gives a link to an exiting cart.
  • ##CARTTYPE## - Displays the cart type.
  • ##CARTNAME## - Displays the cart name.
  • ##CARTID## - Displays the cart ID
  • $$ITEMPRICEDOLLARS$$
  • $$ITEMPRICECENTS$$
  • $$ITEMTOTALDOLLARS$$
  • $$ITEMTOTALCENTS$$
  • $$SUBTOTALDOLLARS$$
  • $$SUBTOTALCENTS$$
  • $$SHIPPINGTOTALDOLLARS$$
  • $$SHIPPINGTOTALCENTS$$
  • $$HANDLINGTOTALDOLLARS$$
  • $$HANDLINGTOTALCENTS$$
  • $$DISCOUNTTOTALDOLLARS$$
  • $$DISCOUNTTOTALCENTS$$
  • $$TAXTOTALDOLLARS$$
  • $$TAXTOTALCENTS$$
  • $$TOTALDOLLARS$$
  • $$TOTALCENTS$$
[New style classes: cartDollars – style all dollar amounts in cartcartCents – style all cent amounts in cart lblProductPriceDollars lblProductPriceCents lblProductTotalDollars lblProductTotalCents lblSubTotalCartDollars lblSubTotalCartCents lblShippingTotalDollars lblShippingTotalCents lblHandlingTotalDollars lblHandlingTotalCents lblDiscountTotalDollars lblDiscountTotalCents lblTaxTotalDollars lblTaxTotalCents lblTotalDollars lblTotalCents]

Order Based Merge Codes

These work on screens and emails that have order information accessible such as order alert emails, order confirmations, order specific tracking scripts, etc .
  • GOOGLE SPECIFIC TRACKING MERGE CODES (details: http://www.americommerce.com/kb/?f=126)
    • ##ADDITEM## (legacy)
    • ##ADDITEMASYNC##
    • ##GOOGLECONVERSIONTRACKINGASYNC##
    • ##GOOGLECONVERSIONTRACKING## (legacy)
  • ORDER SCREENS/PAGE SPECIFIC MERGES
    • ##ORDERDISCOUNTEDSUBTOTAL## - Subtotal minus applied discounts
    • ##ORDERPUBLICCOMMENTS##
    • ##ORDERSHIPPINGADDRESS##
    • ##ORDERSHIPPINGADDRESSHTML##
    • ##ORDERSHIPPINGNAME##
    • ##ORDERSUBTOTAL##
    • ##ORDERSHIPPING##
    • ##ORDERTAX##
    • ##ORDERTOTAL##
    • ##ORDERDATE#
    • ##ORDERID##
    • ##PAYMENTDECLINEDREASON## - Displays any response from the payment gateway as the declined reason.
    • Share-A-Sale Merges
      • ##ORDERITEMLISTURLENCODED## - lists the item numbers on an order (comma separated and url encoded)
      • ##ORDERPRICELISTURLENCODED## - lists the item prices on an order (comma separated and url encoded)
      • ##ORDERQUANTITYLISTURLENCODED## - lists the item quantities on an order (comma separated and url encoded)
      • ##ORDERBASEPRICELISTURLENCODED##
    • Channel Intelligence order confirmation scripts and Nextag ROI tracking scripts.[more info]
      • ##ORDERITEMLISTQUOTED## - Generates a list of all items (by SKU/Item Number) on the order enclosed in single quotes and separated by a comma.
        Example: ‘fasfsdasdfdsfdsfds’,’ITEMNR123123’,’ItemNr21231231’
      • ##ORDERITEMLISTQUOTEDWITHQTY## - Generates a list of all items (by SKU/Item Number) on the order with the corresponding quantity enclosed in single quotes and separated by a comma.
        Example: ‘fasfsdasdfdsfdsfds 13’,’ITEMNR123123 2’,’ItemNr21231231 1’
      • ##ORDERITEMLISTQUOTEDWITHPRICE## - Generates a list of all items (by SKU/Item Number) on the order with the corresponding price enclosed in single quotes and separated by a comma.
        Example: ‘fasfsdasdfdsfdsfds 2295.0000’,’ITEMNR123123 5.0000’,’ItemNr21231231 4.0000’
      • ##ORDERITEMLISTPIPESEPARATED## - Generates a list of all items (by SKU/Item Number) on the order separated by the character |
        Example: fasfsdasdfdsfdsfds|ITEMNR123123|ItemNr21231231
      • ##ORDERQUANTITYLISTPIPESEPARATED## - Generates a list of all the item quantities on the order separated by the character |
        Example: 13|2|1
      • ##ORDERCATEGORYLISTPIPESEPARATED## - Generates a list of the primary category for each line item on the order separated by the character |
        Example: Electronics|Action|Comedy
      • ##ORDERQUANTITYLISTQUOTED## - Generates a list of the quantities of all items on the order enclosed in single quotes and separated by a comma.
        Example: ?B!F ?(B13’,’2’,’1’
      • ##ORDERPRICELISTQUOTED## - Generates a list of the prices of all items on the order enclosed in single quotes and separated by a comma (rounds to 2 decimal places).
        Example: ‘2295.00’,’5.00’,’4.00’
    • WebTrends Ad Director Beacon Tracking.[more info]
      • ##ORDERITEMLISTWEBTRENDS## - Populates the tracking script with order item information.
      • ##PARTIALSHIPPINGINFO## - Textual shipping information
      • ##PARTIALSHIPPINGINFOHTML## - Table based html of the shipping info
      • ##PARTIALSHIPPINGINFO##
      • ##PARTIALSHIPPINGINFOHTML##
  • ORDER EMAIL ONLY MERGES
    • ##BILLNAME##
    • ##BILLCOMPANY##
    • ##BILLLINE1##
    • ##BILLLINE2##
    • ##BILLLINE3##
    • ##BILLCITYSTATEPOSTAL##
    • ##BILLCOUNTRY##
    • ##BILLPHONE##
    • ##BILLCOMMENTS##
    • ##SHIPNAME##
    • ##SHIPCOMPANY##
    • ##SHIPLINE1##
    • ##SHIPLINE2##
    • ##SHIPLINE3##
    • ##SHIPCITYSTATEPOSTAL##
    • ##SHIPCOUNTRY##
    • ##SHIPPHONE##
    • ##SHIPCOMMENTS##
    • ##ACCOUNTLINKS##
    • ##ADMINORDERLINK## - Link directly to the order in the admin console
    • ##AVSCODE##
    • ##DISCOUNTTOTAL## - The amount of the discount as a negative number
    • ##DISCOUNTSTRING## - The discount rule name(s) that are applied to the order
    • ##HANDLING##
    • ##HTMLORDERITEMS## - Items in the order, displayed in a table
    • ##MANUFACTURERINVOICENUMBER## - Displays the manufacturer invoice number assigned to the order.
    • ##ORDERDATE## - Date the order was placed
    • ##ORDERID## - ID of the order
    • ##ORDERITEMS## - Items in the order
    • ##RMAORDERITEMS## - Text based only to display RMA items in the order
    • ##ORDERPAYMENTLINK## - Order payment link generated on the order edit page to send a payment link to the customer.
    • ##ORDERSTATUS## - Current status of the order
    • ##PAYMENTMETHOD## - Payment method used
    • ##PAYMENTMETHODWITHAMOUNTS## - will render not just the payment method names, but the amount of each payment method in parenthesis.
      • Example: Credit Card (50.00), Gift Certificate (25.00)
    • ##PAYMENTSTATUS## - Current status of the payment
    • ##SHIPDATE## - This is the date that the order status is changed to shipped.
    • ##SHIPPING## - Shipping amount on order
    • ##SHIPPINGMETHOD##
    • ##SHIPPINGNOTICE## - Displays information about shipping restrictions, call for shipping, etc.
    • ##SPECIALINSTRUCTIONS##
    • ##SUBTOTAL## - Subtotal for the order
    • ##TAX##
    • ##TRACKINGCODE##
    • ##TRACKINGURL##
    • ##TOTAL##
    • ##PUBLICORDERCOMMENTS##
    • ##ORDERINSTRUCTIONS##
    • ##ISGIFT##
    • ##GIFTMESSAGE##
    • ##ADDITIONALFEES##
    • ##ADDITIONALFEESDESCRIPTION##
    • ##INFOITEMS## - An item added to the cart that is visible to the store owner but not the customer i.e.: "This order came from my blue email template"
    • ##INFOITEMSHTML## - HTML version of the above merge
    • ##ORDERCUSTOMFIELD[FieldName]##
  • The following merges must be used between 2 HTML comments:
    <!--ORDERITEMLAYOUTSTART-->
    insert merges and html here to be repeated for each item
    <!--ORDERITEMLAYOUTEND-->
    • ##ITEMNAME##
    • ##ITEMID##
    • ##ITEMNR##
    • ##ITEMMFG##
    • ##ITEMMFGPARTNR##
    • ##QTY##
    • ##ITEMDESC##
    • ##ITEMPRICE##
    • ##ITEMTOTAL##
    • ##ITEMURL##
    • ##ITEMFULLURL## - fully qualified url with domain name attached and current rewritten path
    • ##ITEMRAWURL## - fully qualified url with domain name attached but the raw path with ?ID
    • ##ITEMIMAGEURL##
    • ##SHIPPINGCLASSIFICATIONCODE##- displays the product shipping classification code if set on the product
    • ##ETADATE##- displays the ETA date specified on a given product. requires "Show ETA Date" checked in the theme settings.
    • ##TIMEFRAME##- displays the "usually ships in" text specified in product statuses.
    • All product merges technically can be accessed here as well, but if you delete the product they will no longer render, such as for older orders.
  • GIFT CERTIFICATE MERGES [more info]
    • ##GIFTCERTIFICATEDELIVERYAREA## - Outputs the Gift Certificate code, amount, and expiration date if applicable
    • ##GIFTCERTIFICATEDELIVERYAREAHTML## - Outputs the Gift Certificate code, amount, and expiration date if applicable using HTML line breaks
    • ##GIFTCERTIFICATETOEMAIL## - Obtained from the optional personalization fields on the Gift Certificate eProduct or on the Gift Certificate Edit screen.
    • ##GIFTCERTIFICATETONAME## - Obtained from the optional personalization fields on the Gift Certificate eProduct or on the Gift Certificate Edit screen.
    • ##GIFTCERTIFICATECODESCSV## - Lists all gift certificate codes in a comma separated format. Can be used to send multiple codes to a customer via an email template.
  • SUBSCRIPTION MERGES
    • ##SUBSCRIPTIONID##
    • ##SUBSCRIPTIONTYPE##-None, EntireOrder, SubscriptionProductsOnly
    • ##ORIGINALORDERDATE##
    • ##SUBSCRIPTIONNAME##-OrderID: XXXX for EntireOrder type, ItemName for SubscriptionProductsOnly
    • ##NEXTDUEDATE##
    • ##PAYMENTMETHOD##-the Customer Payment Method used for a renewal. CardType: xxxx-0000 exp: 11/2011
    • ##LASTPAYMENTSTATUS##-Success/Declined, last time the subscription renewal was attempted.
    • ##ISENABLED##-Enabled/Disabled
    • ##ISACTIVE##-Active/Inactive (same as is enabled, different wording)
    • ##TOGGLEENABLED##-Enable/Disable - Opposite of current status as an action word. Can be passed via QueryString along with SubscriptionID to MyAccount to swap status.
  • QUOTE SPECIFIC MERGES
    (These are extensions of the existing similar merges.  For Order we added a merge of quoted ItemIDs on the order.  The cart merges are new and work on any pagetype for the active cart but behave the same way the order merges do, ItemID list, Price list and Quantity list.)
    • ##ORDERITEMIDLISTQUOTED##
    • ##CARTITEMIDLISTQUOTED##
    • ##CARTPRICELISTQUOTED##
    • ##CARTQUANTITYLISTQUOTED##
  • EPRODUCT SPECIFIC MERGES
    • ##EPRODUCTS##- Creates the link to the eProduct. Text Only.
    • ##EPRODUCTSHTML##- Creates the link to the eProduct. Clickable. Use in HTML format e-mails only.
  • [Conditional Merges] (else is optional)
    • ##IF[OrderIsGift]## content ##ELSE## content ##ENDIF## (else if optional)

Receipt Page Control Based Merges

These are used on the order reciept page in the custom layout editor.
  • Receipt Page Layout Area
    • $$TOPSNAPINAREA$$
    • $$BOTTOMSNAPINAREA$$
    • $$LOGO$$
    • $$STORENAME$$
    • $$STOREADDRESS$$
    • $$STOREPHONE$$
    • $$ORDERNUMBER$$
    • $$ORDERDATE$$
    • $$TOPSNAPINAREA$$
    • $$PAYMENTSTATUS$$
    • $$PAYMENTMETHOD$$
    • $$BILLINGADDRESS$$
    • $$SHIPPINGADDRESS$$
    • $$ORDERSHIPPINGMETHOD$$
    • $$ORDERSHIPPINGNOTICE$$
    • $$CUSTOMFIELDS$$
    • $$SPECIALINSTRUCTIONS$$
    • $$PUBLICCOMMENTSHEADER$$
    • $$PUBLICCOMMENTS$$
    • $$ORDERINSTRUCTIONSHEADER$$
    • $$ORDERINSTRUCTIONS$$
    • $$ORDERITEMS$$
    • $$ORDERSUBTOTAL$$
    • $$ORDERSHIPPINGAMT$$
    • $$ORDERHANDLINGAMT$$
    • $$ORDERDISCOUNTDESC$$
    • $$ORDERDISCOUNTAMT$$
    • $$ORDERTAXAMT$$
    • $$ORDERADDITIONALFEEDESC$$
    • $$ORDERADDITIONALFEEAMT$$
    • $$ORDERTOTAL$$
    • $$INVOICEGIFTMESSAGEHEADER$$
    • $$INVOICEGIFTMESSAGELABEL$$
    • $$GIFTMESSAGE$$
    • $$RMAREASON$$ - Dropdown of reasons defined in the RMAReasonCSV store text field, comma separated list
    • $$RMAREASONLABEL$$ - Label for the dropdown editor, defaults to  "Reason for return:"
  • Receipt Item Layout Area
    • $$ITEMNUMBER$$
    • $$ITEMNAME$$
    • $$VARIATIONINFO$$
    • $$CUSTOMIZATIONINFO$$
    • $$ITEMQTY$$
    • $$ITEMPRICE$$
    • $$ITEMTOTAL$$

Search Page Merge Codes.

  • $$CMSPAGELINK$$ - Page Title linked to page
  • $$CMSRELEVANCE$$ - Matching score like the product scores
  • $$CMSDESCRIPTION$$ - Page Description
  • $$CMSPAGETITLE$$ - Page Title (unlinked)
  • $$CMSPAGEURL$$ - Page URL
  • $$CMSSUMMARY$$ - The first 200 characters of the page Content
  • $$CMSCONTENT$$ - The page Content
  • $$CMSCONTENTNOHTML$$ - The page Content stripped of HTML

Widget Specific merge codes.

  • RSS Feed
    • $$ITEMDATE$$ - publication date
    • $$ITEMLINK$$ - URL to original item
    • $$ITEMTITLE$$ - title
    • $$ITEMSUMMARY$$ - first 200 characters of item text
    • $$ITEMFULLTEXT$$ - full item text, stripped of HTML
    • $$ITEMFULLHTML$$ - full item text, HTML formatting preserved

Customer Based Merges - Email Templates.

  • ##BILLADDRESS## - Customer's billing address
  • ##HTMLBILLADDRESS## - Customer's billing address in an HTML format
  • ##CAMPAIGNCODE## - The campaign or AdCode the customer came to the site on
  • ##CUSTOMEREMAIL## - Email address of the customer
  • ##CUSTOMERFIRSTNAME##
  • ##CUSTOMERLASTNAME##
  • ##CUSTOMERTITLE##
  • ##CUSTOMERCOMPANY##
  • ##PPCKEYWORD## - Pay per click keyword the customer came to the site under
  • ##SEARCHPHRASE## - Search phrase the customer came to the site under
  • ##SHIPADDRESS## - Customer's shipping address
  • ##HTMLSHIPADDRESS## - Customer's shipping address in an HTML format
  • ##SOURCE## - The source (Organic, PPC, etc.) a customer came to the site from
  • ##CUSTOMERCUSTOMFIELD[FieldName]## - The value of a custom field for Customers
  • ##SALESPERSONUSERID##
  • ##SALESPERSONUSERNAME##
  • ##SALESPERSONFIRST##
  • ##SALESPERSONLAST##
  • ##SALESPERSONEMAIL##
  • ##SALESPERSONEXTENSION##
  • ##SALESPERSONPHONE##
  • ##SALESPERSONALTPHONE##
  • ##SALESPERSONFAX##
  • ##SALESPERSONEMAILNODOMAIN##
  • ##ACTIVEREWARDPOINTS##
  • ##PENDINGREWARDPOINTS##
  • ##ACTIVEREWARDPOINTSSINCELASTEMAILNOTIFICATION##
  • ##REWARDPOINTSLABEL##
  • ##IF[CustomerAdCode=XYZ]## content ##ELSE## content ##ENDIF## - The adcode stored on the customer record directly. (BLANK or = checks are supported)
  • ##IF[CustomerAffiliateCode=XYZ]## content ##ELSE## content ##ENDIF## - The affiliate stored on the customer record directly. (BLANK or = checks are supported)
  • ##IF[CustomerIsAffiliate]## content ##ELSE## content ##ENDIF##
  • ##IF[CustomerType=Wholesale]## content ##ELSE## content ##ENDIF##
  • ##IF[CustomerIsNew]## content ##ELSE## content ##ENDIF##
  • ##IF[CustomerHasNoAccount]## content ##ELSE## content ##ENDIF##
  • ##IF[CustomerStoreID=123]## content ##ELSE## content ##ENDIF##
  • ##IF[TRACKINGCODEEXISTS]## content ##ELSE## content ##ENDIF##

    [USSAGE NOTE FOR THE FOLLOWING MERGE CODES {CUSTOMERORDERTOTAL, CUSTOMERORDERTOTALPAID, CUSTOMERORDERTOTAL , CUSTOMERORDERTOTALPAID} ONLY] :

    These work in spots were all customer merges work where a customer has context, like order emails and myaccount page.  Will not work on general locations like the home page.

  • ##CUSTOMERORDERTOTAL##
  • ##CUSTOMERORDERTOTALPAID##
  • ##CUSTOMERORDERTOTAL ## - Total of all orders that are not of a cancelled or declined order status
  • ##CUSTOMERORDERTOTALPAID ## -Total of all orders that are not of a cancelled or declined order status for which complete payment has been received (approved)

Customer Based Merge Codes - My account page.

  • $$CUSTOMERORDERTOTAL$$
  • $$CUSTOMERORDERBALANCE$$
  • $$CUSTOMERAMOUNTDUEPERCENT$$ - renders out a prestyled “progress bar”
  • $$CUSTOMERAMOUNTPAIDPERCENT$$ - same
  • $$CUSTOMERORDERCOUNT$$
  • $$CUSTOMERORDERITEMCOUNT$$
  • $$CUSTOMERREGISTERDATE$$

Drop Shipper/Warehouse Specific Merges

  • ##WAREHOUSENAME## - The name of the warehouse or drop shipper
  • ##WAREHOUSEACCOUNT## - The account number set for the warehouse or drop shipper
  • ##WAREHOUSEADDRESS## - The street address, city, state, and zip for the drop shipper or warehouse
  • ##WAREHOUSEORDERITEMS## - Lists the items that come from the current warehouse in an order (used for the texted based email format)
  • ##HTMLWAREHOUSEORDERITEMS## - Lists the items that come from the current warehouse in an order (used for the html based email format)
  • ##WAREHOUSESUBTOTAL## - Displays the subtotal of the items in an order from the current warehouse
  • ##WAREHOUSETOTAL## - Displays the total of the items (after adding shipping) in an order from the current warehouse

Site Specific Merges

These are used site-wide and pertain to the specific store the customer is on.
  • ##DOMAINNAME## - URL of your storefront
  • ##SSLDOMAINNAME## - Secure URL of your storefront
  • ##STOREADDRESSCITY##
  • ##STOREADDRESSCOUNTRY##
  • ##STOREADDRESSPOSTALCODE##
  • ##STOREADDRESSSTATE##
  • ##STOREADDRESSLINE1##
  • ##STOREADDRESSLINE2##
  • ##STOREEMAIL##
  • ##STOREFAX##
  • ##STOREPHONE##
  • ##STORENAME##
  • ##STOREMETADESC##
  • ##STOREMETAKEYWORDS##

Product Details Control Based Merges

Used on the product details custom layout editor.
  • $$PHOTO$$ - Thumbnail area
  • $$MFGNAME$$ - Name of Manufacturer
  • $$MFGLOGO$$ - Logo of Manufacturer
  • $$PRODUCTNAME$$
  • $$ITEMNR$$ - Item Number
  • $$AVAILABILITY$$
  • $$RETAIL$$
  • $$WASPRICE$$
  • $$PRICE$$
  • $$YOUSAVE$$
  • $$MAPPRICINGLINK$$
  • $$DISCOUNTLIST$$
  • $$VARIATIONS$$
  • $$PERSONALIZATION$$
  • $$UPDATELINK$$
  • $$STOCKLABEL$$
  • $$STOCKQUANTITY$$
  • $$QUANTITY$$
  • $$QUANTITYLABEL$$
  • $$ADDTOCART$$
  • $$ADDTOWISHLIST$$
  • $$BULLETS$$
  • $$QUANTITYDISCOUNTS$$
  • $$VARIANTMATRIXHELPTEXT$$
  • $$VARIANTMATRIX$$
  • $$VARIANTMATRIXADDTOCART$$
  • $$DETAILS$$ - All of the descriptions, including the Tabs if enabled
  • $$RELATEDITEMS$$ - The related items control can be moved around for display, can also use the related items snapins for this
  • $$PRODUCTGROUPDISPLAY$$ - Used for product groups, parent child display, kitting, etc. An alternative display of price/qty
  • $$SOCIALBOOKMARKS$$ - Displays social bookmarking engine links
  • $$SHIPPINGESTIMATIONLINK$$ - Estimates shipping right from the product page
  • $$CATEGORYTRAIL$$ - Displays the Category Path of the product
  • $$TOPSNAPINAREA$$ - Displays the Snap-Ins for the (TOP OF PAGE) Snap-In Section
  • $$TOPPRODUCTSPECIFICSNAPINAREA$$ - Displays Product Specific (TOP OF PAGE) Snap-Ins from the Product Details Page
  • $$BOTTOMSNAPINAREA$$ - Displays the Snap-Ins for the (BOTTOM OF PAGE) Snap-In Section
  • $$BOTTOMPRODUCTSPECIFICSNAPINAREA$$ - Displays Product Specific (BOTTOM OF PAGE) Snap-Ins from the Product Details Page
  • $$ETADATE$$ - Displays the Estimated Time to Deliver Date
  • $$ETADATELABEL$$
  • $$REVIEWCOUNTLINK$$ - Displays a link to view the product reviews for the currently displayed product.
  • $$WRITEREVIEWLINK$$ - Displays a link to a page where the customer can write a product review for the currently displayed product.
  • $$AVERAGEREVIEWRATINGSTARS$$ - Displays the average "star" rating rating calculated as the sum of ratings divided by the count of product reviews that have been submitted and approved for the product.
  • ##YOUSAVEAMOUNT## - Shows difference between Retail and Base Price as Dollar Amount
  • ##YOUSAVEPERCENT## - Shows difference between Retail and Base Price as Percentage Amount
  • ##YOUSAVELABEL## - Label for You Save merge. Default: "You Save:"
  • ##CUSTOMERTYPEPRICE[]## - product merge, where the setting is the CustomerType name.  It displays the product's customer type pricing as a currency amount without a label.  If there is no matching customer type price for the product, the product's main price is displayed.  Example: ##CUSTOMERTYPEPRICE[Wholesale]##

Product Based Merges

These can be used on the product details page custom layout editor or in the HTML of a product-type widget
  • ##ITEMID##
  • ##ITEMURL##
  • ##ITEMFULLURL## - fully qualified url with domain name attached and current rewritten path
  • ##ITEMRAWURL## - fully qualified url with domain name attached but the raw path with ?ID
  • ##ITEMTHUMBNAILURL##
  • ##ITEMPHOTOURL##
  • ##ADDTOCARTURL##
  • ##CATID## - Primary category ID, does not include subcategories the product belongs to
  • All Category ## Merges - Processes category merges using the primary category of the product
  • ##MFGID##
  • All Manufacturer ## Merges - Processes category merges using the primary category of the product
  • ##MFGPARTNUMBER##
  • ##ITEMNAME## or ##PRODUCTNAME##
  • ##ITEMNR##
  • ##PRICE##
  • ##RAWPRICE## - renders an undecorated price without commas or currency symbols
  • ##RETAIL##
  • ##WASPRICE##
  • ##COST##
  • ##ATTRIBUTEDETAILS## - A formatted output of all attribute groups, their values and their attribute names
    • ##ATTRIBUTEDETAILS[groupid=4,hidelabel=true,link=true,showall=true]##
      • showall - shows all 3 values, attribute group, attribute and attribute value.
      • groupid- allows only a specific attribute group to be specified
      • hidelabel: hides the label of the attribute, it is visible by default
      • link: will create a hyperlink for the item and point it to an attribute listing page with other products that have the same attribute as the one selected.
  • ##PRODUCTSTATUS## - product status like In Stock, Discontinued, etc.
  • ##GTIN## - global trade item number, used for google feeds and barcodes
  • ##QUANTITYONHAND## - in stock quantity on hand.
  • ##TIMEFRAME##- displays the "usually ships in" text specified in product statuses.
  • ##ITEMWEIGHT##
  • ##ITEMWEIGHT[decimalplaces=?## - ? represents the number of decimal places to use.
  • ##LASTITEMNR## - item number history field
  • ##TELLAFRIEND## - Displays the Tell A Friend link that will open in a Highslide popup.
  • ##LONGDESCRIPTIONNAME1##
  • ##LONGDESCRIPTIONNAME2##
  • ##LONGDESCRIPTIONNAME3##
  • ##LONGDESCRIPTIONNAME4##
  • ##LONGDESCRIPTIONNAME5##
  • ##LONGDESCRIPTION1##
  • ##LONGDESCRIPTION2##
  • ##LONGDESCRIPTION3##
  • ##LONGDESCRIPTION4##
  • ##LONGDESCRIPTION5##
  • ##MULTIPLESOFQUANT## - set via store text to display a message about the product using the "multiples of quantity" setting
    • Products can have "Multiples of Quantity". If this is any number other than 1, quantities of any product added to or updated in the cart are rounded up to the next nearest multiple of this value. For instance, if this value is 5 and 2 are added, the quantity is adjusted to 5. If 6 are added, the quantity is adjusted to 10.
  • ##MINQUANT##
  • ##MAXQUANT##
  • ##SHORTDESCRIPTION##
  • ##BULLETS##
  • ##ETADATE##- displays the ETA date specified on a given product. requires "Show ETA Date" checked in the theme settings.
  • ##AVAILABILITY## - do not use. depreciated in favor of ##PRODUCTSTATUS##
  • ##PRODUCTCUSTOMFIELD[FieldName]##
  • $$REWARDPOINTSEARNED$$ to product details page. Allows customer to show the points earned for the current product being viewed. Includes variant drop down support
  • Set Item By ID merges:Allows you to process product based merges based on an item in the cart. Product based merges placed here will be evaluated based on the item specified above.
    • ##SETITEMBYID[123]##
    • ##SETITEMBYITEMNUMBER[123]##
    • ##SETITEMBYCARTINDEX[0]##-the valid numbers are 0 – (n-1), where n is the number of items in the cart.
    • Example:
      ##SETITEMBYID[123]##
      ##ITEMNAME## is the best product.
      ##ENDSETITEM##

Conditional Product Merges

  • ##IF[StoreID=1]## sample text ##ELSE## sample test ##ENDIF## (else is optional) - Used to differentiate text in product descriptions and other fields on a per store basis.
    • ##IF[StoreID=1]## This text and html will show up on store 1 ##ENDIF##
    • ##IF[StoreID!=1]## This text will show up on all stores BUT store 1 ##ENDIF##
  • ##IF[LoggedIn]## content ##ELSE## content ##ENDIF##
  • ##IF[SessionCustomerType=XYZ]## content ##ELSE## content ##ENDIF##
  • ##IF[SessionCustomerTypeID=123]## content ##ELSE## content ##ENDIF##
  • ##IF[SessionCustomerIsNew]## content ##ELSE## content ##ENDIF##
  • ##IF[SessionCustomerAdCode=XYZ]## content ##ELSE## content ##ENDIF## - The adcode stored on the current session. (BLANK or = checks are supported)
  • ##IF[SessionCustomerAffiliateCode=XYZ]## content ##ELSE## content ##ENDIF## - The affiliate code stored on the current session. (BLANK or = checks are supported)
  • ##IF[SessionCustomerIsAffiliate]## content ##ELSE## content ##ENDIF##
  • ##IF[IsMicroStore]## content ##ELSE## content ##ENDIF##
  • ##IF[IsNotMicroStore]## content ##ELSE## content ##ENDIF##
  • ##IF[CartIsEmpty]## content ##ELSE## content ##ENDIF##
  • ##IF[ITEMIDEXISTS=1234]## content ##ELSE## content ##ENDIF##
  • ##IF[UseMapPricing]## content ##ELSE## content ##ENDIF## *
  • *The indicated merges accept Summary String settings for length and "more info" indicator. It also strips all HTML code from the field. For example, to limit the Long Description 1 field to 100 characters followed by "...", use:##LONGDESCRIPTION1[100,...]##

Shopping Cart Page Control Merges

  • $$CUSTOMMESSAGE$$ - Simple message for visitors to your cart page, store text so you can put it in multiple languages.

Catalog Control Merges

Used on the catalog page custom layout editor.
  • Catalog: Catalog Page Layout Area
    • $$TOPSNAPINAREA$$
    • $$PRODUCTLIST$$
    • $$TOPPAGEADDTOCARTBUTTON$$
    • $$BOTTOMPAGEADDTOCARTBUTTON$$
    • $$PRODUCTCOUNTTOP$$
    • $$PRODUCTLISTPAGENAVIGATIONTOP$$
    • $$PRODUCTCOUNTBOTTOM$$
    • $$PRODUCTLISTPAGENAVIGATIONBOTTOM$$
  • Catalog: Product List Layout Area
    • $$CATEGORYTRAIL$$
    • $$QUANTITYBOX$$
    • $$PRICE$$
    • $$MANUFACTURERLINK$$
    • $$PRODUCTLINK$$

Manufacturer Based Merge Codes

Used on the Catalog page custom layout editor.
  • Manufacturer: Manufacturer Page Layout Area
    • $$MANUFACTURERNAME$$
    • $$MANUFACTURERDESCRIPTION$$
    • $$TOPMANUFACTURERSPECIFICSNAPINAREA$$
    • $$TOPSNAPINAREA$$
    • $$SORTBYDROPDOWN$$
    • $$SHOWBYPAGESIZE$$
    • $$PRODUCTLIST$$
    • $$BOTTOMMANUFACTURERSPECIFICSNAPINAREA$$
    • $$BOTTOMSNAPINAREA$$
    • $$PRODUCTCOUNTTOP$$
    • $$PRODUCTLISTPAGENAVIGATIONTOP$$
    • $$PRODUCTCOUNTBOTTOM$$
    • $$PRODUCTLISTPAGENAVIGATIONBOTTOM$$
    • $$NUMBERPERPAGEDROPDOWNLABEL$$
  • Manufacturer: Product List Layout Area
    • Same as Category: Product List Layout Area Below

Manufacturer Merges Codes

Used on the manufacturer page in page titles and meta tags
  • ##MFGNAME##
  • ##MFGMETADESC##
  • ##MFGKEYWORDS##
  • ##MFGPAGETITLE##
  • ##MFGDESC##
  • ##MFGLOGO##
  • ##MFGURL##
  • ##MFGFULLURL## - fully qualified url with domain name attached and current rewritten path
  • ##MFGRAWURL## - fully qualified url with domain name attached but the raw path with ?ID
  • ##MFGLOGONAME##

Category Control Merges

Used on the category page custom layout editor
  • Category: Category Page Layout Area
    • $$CATEGORYTRAIL$$
    • $$CATEGORYNAME$$
    • $$TOPSNAPINAREA$$
    • $$CATEGORYHEADER$$
    • $$TOPCATEGORYSPECIFICSNAPINAREA$$
    • $$TOPATTRIBUTESPECIFICSNAPINAREA$$
    • $$CATEGORYIMAGE$$
    • $$EXTERNALCONTENTAREA$$
    • $$CHILDCATEGORYLIST$$
    • $$SORTBYDROPDOWN$$
    • $$PRODUCTLIST$$
    • $$CATEGORYFOOTER$$
    • $$BOTTOMATTRIBUTESPECIFICSNAPINAREA$$
    • $$BOTTOMCATEGORYSPECIFICSNAPINAREA$$
    • $$BOTTOMSNAPINAREA$$
    • $$PRODUCTCOUNTTOP$$
    • $$PRODUCTLISTPAGENAVIGATIONTOP$$
    • $$PRODUCTCOUNTBOTTOM$$
    • $$PRODUCTLISTPAGENAVIGATIONBOTTOM$$
    • $$SHOWBYPAGESIZE$$
    • $$NUMBERPERPAGEDROPDOWNLABEL$$
  • Category: Child Category Layout Area
    • $$CATEGORYLINK$$
    • $$CATEGORYTHUMBNAIL$$
    • $$CATEGORYSHORTDESCRIPTION$$
  • Category: Product List Layout Area
    • $$PRODUCTTHUMBNAIL$$
    • $$MANUFACTURERLINK$$
    • $$MANUFACTURERNAME$$
    • $$PRODUCTLINK$$
    • $$ITEMNUMBER$$
    • $$SHORTDESCRIPTION$$
    • $$LONGDESCRIPTION$$
    • $$MOREINFOLINK$$
    • $$DISCOUNTLIST$$
    • $$PRODUCTFLAGS$$
    • $$AVAILABILITY$$
    • $$RETAILPRICE$$
    • $$WASPRICE$$
    • $$PRICE$$
    • $$MAPPRICINGLINK$$
    • $$QUANTITYBOX$$
    • $$ADDTOCARTBUTTON$$
    • $$SEEOPTIONSLINK$$
    • $$AVERAGEREVIEWRATINGSTARS$$ - Displays the average "star" rating rating calculated as the sum of ratings divided by the count of product reviews that have been submitted and approved for the product.

Category Merges

Used on the category page in page titles and meta tags
  • ##CATNAME##
  • ##CATMETADESC##
  • ##CATKEYWORDS##
  • ##CATPAGETITLE##
  • ##CATSHORTDESC##
  • ##CATURL##
  • ##CATFULLURL## - fully qualified url with domain name attached and current rewritten path
  • ##CATRAWURL## - fully qualified url with domain name attached but the raw path with ?ID
  • ##CATICON## - Displays the Category Icon path.
  • ##CATTHUMB## - Displays the Category Thumbnail path.
  • ##ROOTCATNAME## - The top most category in the tree of the selected category you are currently on. Dvds > Action > Mel Gibson...Dvds is the root, no matter where in the tree you are at.
  • ##ROOTCATMETADESC##
  • ##ROOTKEYWORDS##
  • ##ROOTCATPAGETITLE##
  • ##ROOTCATSHORTDESC##
  • ##ROOTCATURL##
  • ##ROOTCATFULLURL## - fully qualified url with domain name attached and current rewritten path
  • ##ROOTCATRAWURL## - fully qualified url with domain name attached but the raw path with ?ID
  • ##ROOTCATICON## - Displays the root category's Category Icon path no matter where in the tree you are at.
  • ##ROOTCATTHUMB## - Displays the root category's Category Thumbnail path no matter where in the tree you are at.
  • ##REVIEWCOUNT## - Displays the number of product reviews that have been submitted and approved for the product.
  • ##AVERAGERATING## - Displays the average rating calculated as the sum of ratings divided by the count of product reviews that have been submitted and approved for the product.

Attribute Merges

Used on the attribute page in page titles and meta tags
  • ##ATTRIBUTENAME##
  • ##ATTRIBUTEURL##
  • ##ATTRIBUTEFULLURL## - fully qualified url with domain name attached and current rewritten path
  • ##ATTRIBUTERAWURL## - fully qualified url with domain name attached but the raw path with ?ID
  • ##ATTRIBUTEGROUPNAME##

Content Page Merges

Used on content pages in page titles and meta tags
  • ##CONTENTPAGENAME##
  • ##CONTENTPAGEURL##
  • ##CONTENTPAGEFULLURL## - fully qualified url with domain name attached and current rewritten path
  • ##CONTENTPAGERAWURL## - fully qualified url with domain name attached but the raw path with ?ID
  • ##CONTENTPAGEDESC##
  • ##CONTENTPAGEKEYWORDS##
  • ##SHAREDCONTENT[nameofsharedcontentmerge]## - Adds a shared content page to a content page.

Cart Email Merges

Used in abandoned cart emails
  • ##CARTITEMS##s - A list of items in a customer's cart in text format.
  • ##CARTITEMSHTML## - HTML version

Theme Merges

Site level theme merges, not available in emails.
  • ##THEMEPAGEWIDTH## - Layout width from the theme for the entire wrapping area of the site
  • ##THEMELEFTCOLUMNWIDTH## - Layout width from the theme for the bounding area of the left column
  • ##THEMERIGHTCOLUMNWIDTH## - Layout width from the theme for the bounding area of the right column
  • ##THEMEMAINCONTENTWIDTH## - Layout width from the theme for the bounding area of the content area

Site Template Override Merges

Advanced Only!When using custom site layout of your entire template, place these merges within your HTML to put the AmeriCommerce generated content within the theme.
  • $$HEADER$$ - The header of your site, typically above the top navigation, tied to the 'Page Header' area of the AmeriCommerce theme system.
  • $$TOPNAVIGATION$$ - Typically below the header, can contain snapins including dropdown menus or link groups.
  • $$MAINCONTENT$$ - The content area of your site, changes by page type.
  • $$LEFTCOLUMN$$ - Left column of your site, usually contains link groups and other snapins, tied to the "Left Column" area of the AmeriCommerce theme system.
  • $$FOOTER$$ - Footer of your site, usually contains link groups and other snapins, tied to the "Page Footer" area of the AmeriCommerce theme system.
  • $$RIGHTCOLUMN$$ - Right column of your site, usually contains link groups and other snapins, tied to the "Right Column" area of the AmeriCommerce theme system.

Generic Variables

Use is page specific, a variable set on one page can only be referenced on the same page
  • ##SET[YourVariableName=Value]## - Create a variable with the assigned value
  • ##SHOW[YourVariableName]## - This displays the value assigned to the variable
  • ##GENERICVARIABLES## - For testing purposes, you can output all of your generic variables
  • ##IF[YourVariableName=Value]## Show if True ##ELSE## Show if False ##ENDIF##

Scheduled Exports

  • ##EXPORTNAME## - Name assigned to the scheduled export.
  • ##TIMESTAMP## - Can accept parameters like ##TIMESTAMP[yyyyMMdd]## to change the format of the timestamp.

Microstore Merges

These only work on pages and only if you're using microstores
  • ##MSNAME## - Microstore's name
  • ##MSCOLOR1##
  • ##MSCOLOR2##
  • ##MSCUSTOM1##
  • ##MSCUSTOM2##
  • ##MSCUSTOM3##
  • ##MSCUSTOM4##
  • ##MSCUSTOM5##
  • ##MSCUSTOM6##
  • ##MSCUSTOM7##
  • ##MSCUSTOM8##
  • ##MSLOGO## - Microstore's logo
  • ##MSSHORTNAME##

User Merges

  • ##USERID##
  • ##USERNAME##
  • ##USERFIRST##
  • ##USERLAST##
  • ##USEREMAIL##
  • ##USEREMAILNODOMAIN##
  • ##USEREXTENSION##
  • ##USERPHONE##
  • ##USERALTPHONE##
  • ##USERFAX##

Shopping Cart Merges

Only visible the first time the cart is viewed after adding an item. Used in the <ac:layoutarea id="LastItemAdded"> section
  • ##ITEMNAME##
  • ##ITEMID##
  • ##PRICE##
  • ##COST##
  • ##QUANTITY##
  • ##ITEMNR##
  • ##MANUFACTURERITEMNR##
  • ##ITEMTHUMBNAILURL##
  • ##ITEMTHUMBNAIL##
  • ##ITEMURL##
  • ##VARIATIONS##
  • ##PERSONALIZATIONS##

Blog Roll Page/Widget Control Merges

  • $$BLOGIMAGE$$
  • $$ATOMFEEDLINK$$
  • $$RSSFEEDLINK$$
  • $$GROUP$$
  • $$POST$$
  • $$POSTS$
  • $$TEASERTITLE$$
  • $$TEASERDESCRIPTION$$
  • $$TEASERIMAGE$$
  • $$TITLE$$
  • $$AUTHOR$$
  • $$AUTHORURL$$
  • $$AUTHORLINK$$
  • $$AUTHORIMAGE$$
  • $$IMAGE$$
  • $$CONTENT$$
  • $$COMMENTS$$
  • $$COMMENTCOUNTANCHORLINK$$
  • $$COMMENTCOUNTLINK$$
  • $$COMMENTCOUNT$$

Blog Roll Page Control Merges (all of the above, plus):

  • $$BLOGROLLPAGING$$

Blog Post Page Control Merges:

  • $$TEASERTITLE$$
  • $$TEASERDESCRIPTION$$
  • $$TEASERIMAGE$$
  • $$TITLE$$
  • $$AUTHOR$$
  • $$AUTHORBIO$$
  • $$AUTHORURL$$
  • $$AUTHORLINK$$
  • $$AUTHORIMAGE$$
  • $$IMAGE$$
  • $$CONTENT$$
  • $$COMMENTS$$
  • $$COMMENTCOUNTANCHORLINK$$
  • $$COMMENTCOUNTLINK$$
  • $$COMMENTCOUNT$$
  • $$COMMENTLINK$$
  • $$POSTCATEGORIESLABEL$$
  • $$POSTCATEGORIES$$
  • $$POSTTAGS$$
  • $$BLOGDESCRIPTION$$
  • $$BLOGTAGLINE$$
  • $$BLOGNAME$$
  • $$BLOGLINK$$
  • $$BLOGIMAGE$$
  • $$BLOGIMAGELINK$$
  • $$VIEWPOST$$
  • $$POSTDATE$$
  • $$POSTTIME$$
  • $$POSTDATETIME$$
  • $$POSTDATEWITHCLASSES$$
  • $$HIDECOMMENTS$$
  • $$COMMENTSHEADER$$
  • $$ADDACOMMENTHEADER$$
  • $$ADDACOMMENTLINK$$
  • $$ADDACOMMENTANCHORLINK$$
  • $$HIDEADDCOMMENTBOX$$
  • $$NEWCOMMENTTEXT$$
  • $$POSTCOMMENTBUTTON$$
  • $$COMMENTSSORTBY$$
  • $$COMMENTSSORTBYTEXT$$
  • $$COMMENTPOSTCOUNT$$
  • $$COMMENTPAGESIZE$$
  • $$COMMENTPAGESIZESHOWLABEL$$
  • $$COMMENTSPERPAGELABEL$$
  • $$POSTNEWCOMMENTPROFILEIMAGE$$
  • $$POSTNEWCOMMENTPROFILENAME$$
  • $$POSTNEWCOMMENTPROFILEPOSTCOUNT$$
  • $$POSTASDROPDOWN$$
  • $$POSTAS$$
  • $$COMMENTSERRORTEXT$$
  • $$COMMENTMODERATIONMESSAGE$$
  • $$DISPLAYNAMETEXT$$
  • $$DISPLAYNAMETEXTBOX$$
  • $$PROFILEIMAGE$$
  • $$COMMENTTEXT$$
  • $$COMMENTDATE$$
  • $$PROFILENAME$$
  • $$COMMENTANCHOR$$
  • $$PROFILECOMMENTCOUNT$$
  • $$COMMENTPAGING$$
  • $$VIEWCOMMENTLINK$$
  • $$ADMINCOMMENTLABEL$$
  • $$AUTHORCOMMENTLABEL$$
  • $$ADMINCOMMENTCSSCLASS$$
  • $$AUTHORCOMMENTCSSCLASS$$

Blog Entity Merges

  • ##BLOGID##
  • ##BLOGDESCRIPTION##
  • ##BLOGNAME##
  • ##BLOGTAGLINE##
  • ##BLOGURLSLUG##
  • ##BLOGMETADESCRIPTION##
  • ##BLOGMETAKEYWORDS##
  • ##BLOGURL##

Blog Post Entity Merges

  • ##BLOGPOSTTITLE##
  • ##BLOGPOSTDESC##
  • ##BLOGPOSTKEYWORDS##
  • ##BLOGPOSTURL##
  • ##BLOGPOSTIMAGEURL##
  • ##BLOGPOSTFULLURL##
  • ##BLOGPOSTRAWURL##

Profile Entity Merges

  • ##PROFILEID##
  • ##PROFILEDISPLAYNAME##
  • ##PROFILEREALNAME##
  • ##PROFILEEMAIL##
  • ##PROFILEABOUT##
  • ##PROFILECUSTOMURL##
  • ##PROFILEIMAGE##
  • ##PROFILETYPE##
  • ##PROFILETYPE##
  • ##PROFILEUSERNAME##
  • ##PROFILEENTERDATE##
  • ##PROFILETITLE##
  • ##PROFILECOMPANY##

Profile Post Entity Merges

  • ##PROFILEPOSTLINK##
  • ##PROFILEPOSTADMINLINK##
  • ##PROFILEPOSTBODY##
  • ##PROFILEPOSTTYPE##
  • ##PROFILEPOSTSTOREPAGETYPE##
  • ##PROFILEPOSTAPPROVALSTATUS##

Expand All | Collapse All

 

Comments

User photo
Jason
IFC

##RESETPASSWORDURL## 

November 08, 2012 14:40
User photo
Jason
IFC

Please list all conditions able to be used with conditional merges:
##IF[StoreID=1]## True Content ##ELSE## False Content ##ENDIF##

November 13, 2012 11:23
User photo
Michal Robin
AmeriCommerce

Jason,

The conditional mergecodes listed are the only ones available for performing logic.

November 13, 2012 16:54
User photo
Jason
IFC

Missing 
$$ROOTCATEGORYIMAGE$$
$$SUBCATEGORIES$$
$$CATPRODUCTCOUNT$$ 

January 10, 2013 13:33
User photo
Paul Component Engineering
Paul Component Engineering

The new design of this page with the collapsing sections makes it hard to find merge codes by using CMD+F.

April 18, 2013 10:30
User photo
Blake Petersen
Meyer

Paul, click "Expand All" and you're good to go.

May 14, 2013 12:56
User photo
Agnes Doue
Isis Augusta Inc.

" ##LOGINMESSAGE[message=Welcome ##CUSTOMERFIRSTNAME##!]## - Notice this is a merge within a merge. To get a comma, use the character entity code for it: #44 (without the space after the ","). "

I have tried this, and I get "#44" rather than "," in my display. Please explain a little more.

Thanks. --Aggie

July 07, 2013 05:27
User photo
Blake Petersen
Meyer

Hi Aggie,
"#44" needs to be wrapped in "&" and ";" in order to be recognized as an entity code. So if you use "&#44;" instead of "#44", you should be good to go. You can see additional entity codes at http://www.w3schools.com/tags/ref_entities.asp

-Blake

July 07, 2013 16:30
User photo
Ryan Olson
AmeriCommerce

You can also get more control over what you show with the 

##IF[LoggedIn]##

Put content here, ##CUSTOMERFIRSTNAME##, and here.

##ENDIF##

 

Conditional Merge.

July 07, 2013 19:27
User photo
Agnes Doue
Isis Augusta Inc.

Blake thank you a lot for the &; wrapper (worked fine) and the link (W3 schools tab is usually open in my browser).

Ryan, thank you. I have that If statement working. However, I don't know how to get rid of the comma when a customer is not logged in, i.e., I need an ELSE statement... I can't figure out what "language" this is in to look up how to code it, nor do I know what the condition would be labeled (NotLoggedIn, LogggedOut, etc.) Will you help?

Thanks, Aggie

July 10, 2013 09:16
User photo
AmeriCommerce Developer
AmeriCommerce

You can do 

##IF[LoggedIn]## Something ##ELSE## Something else ##ENDIF##

 

These are called conditional merges and actually are covered in this article.

 

What exactly are you trying to do? It sounds like you could just put the comma inside the conditional too.

July 10, 2013 10:02
User photo
Agnes Doue
Isis Augusta Inc.

I tried both of these two:

1.

      ##IF[LoggedIn]##
      <li>Welcome&#44; ##CUSTOMERFIRSTNAME##</li>
      ##ENDIF##

2.

      ##IF[LoggedIn]##
      <li>Welcome&#44; ##CUSTOMERFIRSTNAME##</li>
      ##ELSE##
      <li>Welcome</li>
      ##ENDIF##

Either way, what I see when logged out is "Welcome," and when logged in, "Welcome, Lou" ... Ideas? Thanks.

July 11, 2013 05:25
User photo
AmeriCommerce Developer
AmeriCommerce

Hi Agnes,

What you have looks correct. I think you are probably logged into the admin. If that is the case the LoggedIn condition is considered true no matter what.

Try viewing it in a different browser where you aren't logged in to the admin or in an Incognito/Private window.

 

Ryan

July 11, 2013 11:18
User photo
Agnes Doue
Isis Augusta Inc.

OMG Thank you! I would never have guessed.  --Aggie

July 11, 2013 11:35
User photo
Justin Murphy
SavvyBoater

Is anyone familiar with a way to display the levels of sub-categories individually? For example, if I have...

Movies > DVDs > Drama > New Releases

...I understand that I can display the entire navigation using $$CATEGORYTRAIL$$.

However, I would like to modify the way this is displayed, so that it shows like this:

Movies
DVDs
Drama
New Releases

I imagine it would look like something this:

##SUBCATEGORYLEVEL1##
##SUBCATEGORYLEVEL2##
##SUBCATEGORYLEVEL3##
##SUBCATEGORYLEVEL4##

Do this mystery merge code exist, or is there another way to accomplish this?

Thank you!

Justin

December 27, 2013 12:41
User photo
Blake Petersen
Meyer

You can take the markup derived from the $$CATEGORYTRAIL$$ and use CSS and/or Javascript to style it to your liking. Examples: 

CSS and jQuery: http://jsfiddle.net/BlakePetersen/c2sF4/

All jQuery: http://jsfiddle.net/BlakePetersen/c2sF4/1/

December 27, 2013 13:03
User photo
Justin Murphy
SavvyBoater

Hi, Blake. Thank you for your wonderful input. I have two questions:

*Question One

I have the ">" character where you put "&nbsp;" and I am having trouble modifying your script to remove the ">".

I tried this...

$(".ProductDetailsCategoryTrail").each(function () {
$(this).children('a').css('display','block');
$(this).html($(this).html().replace(/ > /g, ''));
});

But I could not get it to perform the way I want it to.

*Question Two:

We currently utilize the $$CATEGORYTRAIL$$ at the top of our page. I am inquiring about this for a secondary usage towards the middle of the page. This is part of the reason why I was initially hoping to find a merge code that lets me break the trail apart, so that there would be no conflicting scripts on the page. Do you know of a way that I can tell the script to ignore the top merge code and apply only to the one below?

Thanks,

Justin

 

 

December 27, 2013 13:59
User photo
AmeriCommerce Developer
AmeriCommerce

The ">" character is store text. The key is "Catalog_BreadcrumbSeperator_string".

You could achieve what you want without javascript simply by making the store text value a break. "<br>"

December 27, 2013 14:01
User photo
Justin Murphy
SavvyBoater

That's a good idea, but that would still not solve my problem I listed in Question Two:

I want to reference the $$CATEGORYTRAIL$$ in multiple places on the page. I want the first one to be the standard version (Movies > DVDs > Drama > New Releases) and the second to be modified version:

Movies
DVDs
Drama
New Releases

Let me know if you have any questions.

Thanks,

Justin

December 27, 2013 14:10
User photo
AmeriCommerce Developer
AmeriCommerce

oops. Didn't see that part. In that case you would need to use the javascript Blake provided. 

This line should work in place of the original:

$(this).html($(this).html().replace(/&gt;/g, ''));
December 27, 2013 14:17
User photo
Blake Petersen
Meyer

Hi Justin,

This should get you where you need to be -- http://jsfiddle.net/BlakePetersen/c2sF4/2/. Let me know if you have any questions on what's going on and I'd be happy to explain.

Regarding the reasoning as to why $(this).html($(this).html().replace(/ > /g, '')); failed, the value to be replaced ('/ > /' in this case) is expected to be an html entity expressed in regex (or '/&gt;/'). Also, adding the g after the 2nd slash applies this globally, so it will replace all instances of that regex value within scope. If you kept it off, it would just replace the first item and call it quits.

Hope this helps!

-Blake

December 27, 2013 14:57
User photo
Justin Murphy
SavvyBoater

Hi Blake & AC Dev -

That did the trick! Thank you very much for all of your great input.

You both definitely went above and beyond what I was expecting. Blake, thank you for walking me through those scripts. It was a very good learning experience for me and is much appreciated.

Regards, 

Justin

December 27, 2013 15:27