Custom Template Tag Specification: Shopping Cart Tags

Screen: ShopSite > Merchandising > Custom Templates

Custom Template Tag Specification

Shopping Cart Tags

These tags are organized by the pages in which they typically would be used. Some tags are shown on multiple pages.

Special Shopping Cart Tags

These tags can be used on any shopping cart page.

[-- STORE.SC_YourShoppingCart --]: Text field: Your Shopping Cart
[-- SC_JavaScript Extras --]: The JavaScript required on shopping cart pages
[-- ShopSiteMessages --]: Displays any (error) messages to the shopper.
[-- SC_FORM --]: The opening <FORM> tag and a few hidden values for the shopping cart. This tag MUST precede most of the other SC_ tags.
[-- IP_ADDR --]: The IP address of the shopper
[-- SC_USE_SECURITY --]: Returns checked if the shopping cart is set to use a secure URL. This can be used in conjunction with the [-- STORE.Secure_Image_URL --] and [-- STORE.SC_Secure_Image_URL --] tags to avoid mixing secure and insecure links in a page.
[-- STORE.Secure_Image_URL --]: Returns the ShopSite Images secure URL (configured in Preferences > Hosting Service). This can be used to access images from secure pages such as a Shopping Cart.
[-- STORE.SC_Secure_Image_URL --]: Returns the Secure Store URL (configured in Preferences > Hosting Service). This can be used to access images from secure pages such as a Shopping Cart.
[-- IF Cart_Image --]: Returns true if the merchant has selected to display product images in the Shopping Cart.
[-- IF ShopSiteSecurityImage --]: True if ShopSite is configured to display the Highest Security image.
[-- ShopSiteSecurityImage --]: Returns the HTML code to display the Highest Security image on the page.

Colors and Background

[--STORE.SC_BackgroundColor--]: Shopping cart background color
[--STORE.SC_TextColor--]: Shopping cart text color
[--STORE.SC_LinkColor--]: Shopping cart link color
[--STORE.SC_VisitedLinkColor--]: Shopping cart visited link color
[--STORE.SC_ActiveLinkColor--]: Shopping cart active link color
[--STORE.SC_BackgroundImage--]: Shopping cart background image
[--STORE.SC_ShadeColor--]: Shopping cart table shade color

Shopping Cart Page

These tags are used on the first shopping cart page.

Defines

[-- DEFINE ShoppingCart --]: The beginning of the HTML for the shopping cart template
[-- END_DEFINE ShoppingCart --]: The end of the HTML for the shopping cart template

Google Checkout pre-cart screen

[-- IF Google_Checkout --]: This IF tag checks to see if you're on the Google Checkout pre-cart screen. The pre-cart screen is generated from the Shopping Cart definition, but will not display shipping, tax, or billing options. Using the [-- IF Google_Checkout --] tag allows designers to include unique information on the pre-cart screen.

Header and Footer

[-- ShoppingCartHeader --]: Text at the top of the Shopping Cart Screen
[-- ShoppingCartFooter --]: Text at the bottom of the Shopping Cart Screen

Customer Registration

[-- SC_Registration --]: Links to register or sign in. (Also IF)
[-- SignedIn? --]: True if the customer is signed in
[-- SC_Must_Register --]: True if the customer must be registered to check out
[-- RegisteredName --]: Customer's name if signed in

Table of Products Ordered

[-- SC_ShowBasket --]: The "Show me my basket every time I order something" checkbox.
[-- SC_Remove_Button --]: True if the merchant wants "Remove" buttons for each product
[-- SC_Cart --]: The table showing the products ordered and the order subtotal
[-- SC_Cart delete quantity image name sku price total --]: The table showing the products ordered and the order subtotal, with the fields in the order specified.

Tax and Shipping

[-- SC_Tax_Shipping --]: The form fields for tax and shipping
[-- SC_Tax_Shipping Button --]: The form fields for tax and shipping, plus a "Tax/Shipping" button to recalculate
[-- BUTTON TaxShipping --]: Tax/Shipping button

Coupons

[-- SC_Coupon --]: The form field for the customer to enter a coupon name/number. (Also IF)
[-- SC_Coupon_Button --]: True if the merchant wants the "Apply Coupon" button
[-- STORE.CouponCaption --]: Text field: Coupon Code:
[-- STORE.EnterCoupon --]: Text field: If you have a coupon, enter the code and press recalculate
[-- BUTTON ApplyCoupon --]: "Apply Coupon" button

Gift Certificates

[-- SC_GiftCert --]: The form field for the customer to enter a gift certificate number and PIN. (Also IF)
[-- SC_GiftCert_Button --]: True if the merchant wants the "Redeem Certificate" button
[-- STORE.GiftCertCaption --]: Text field: Gift Certificate:
[-- STORE.EnterGiftCert --]: Text field: If you have a gift certificate, enter the code and PIN then press recalculate
[-- GiftCert_Redeem --]: Store text: Redeem Certificate
[-- STORE.GiftCert_Recalculate --]: Store text: Recalculate
[-- BUTTON ApplyGiftCert --]: "Redeem Certificate" button

Reward Program

[-- SC_REWARD_PROGRAM --]: Table displaying customer's current reward program status. Can be used with an IF to determine if the table should be displayed.

Surcharges

[-- SC_Surcharge --]: The form fields for surcharges

Totals

[-- SC_Totals --]: Displays product subtotal, shipping charges, tax charges, and the order total
[-- STORE.SC_AnyChanges --]: Text field: Any changes above should be verified by pressing 'Recalculate' before clicking on 'Checkout'.

Ordering Instructions

[-- SC_OrderingInstructions --]: Ordering instructions heading and text box (Also IF)
[-- SC_OrderingInstructions {rows columns} --]: The ordering instructions text and box with specified box dimensions

Payment

[-- SC_PaymentSelection --]: The form fields for selecting payment type

Global Cross-sell

Use these tags to control how to display the Global Cross-sell product table on the Shopping Cart screen. See the DEFINE GLOBAL_CROSS_SELL section for tags used for the individual products.

[-- IF Global_Cross_Sell --]

True if Global Cross-sell is turned on.

[-- STORE.GlobalCrossSellHeader --]

The header text for the global cross-sell table.

[-- LOOP GLOBAL_Cross_Sell {columns} --]

Begin displaying global cross-sell products. Optionally, define the number of products to diplay on each row.

[-- GLOBAL_CROSS_SELL --]

Use between [-- LOOP --] and [-- END_LOOP --] tags to indicate where to insert the individual products. The following example would display all the Global Cross-sell products on the same row:

<table class="gcs">
  <tr>
[-- LOOP GLOBAL_Cross_Sell --]
    <td class="gcs_product">[-- GLOBAL_CROSS_SELL --]</td>
[-- END_LOOP GLOBAL_Cross_Sell --]
  </tr>
</table>

If your store was configured to show four Global Cross-sell products, the result might look something like this:

Product 1

Product 2

Product 3

Product 4

[-- END_LOOP Global_Cross_Sell --]

End displaying global cross-sell products.

Product Cross-sell

Use these tags to control how to display the Product Cross-sell product table on the Shopping Cart screen. See the DEFINE CART_CROSS_SELL section for tags used for the individual products.

[-- IF Cart_Cross_Sell --]

True if Cart Cross-sell is turned on.

[-- STORE.CartCrossSellHeader --]

The header text for the cart cross-sell table.

[-- LOOP CART_Cross_Sell {columns} --]

Begin displaying cross-sell products specific to the contents of the cart. Optionally, define the number of products to diplay on each row.

[-- CART_CROSS_SELL --]

Use between [-- LOOP --] and [-- END_LOOP --] tags to indicate where to insert the individual products. The following example would display all the Cart Cross-sell products on the separate rows:

<table class="pcs">
[-- LOOP CART_Cross_Sell --]
  <tr>
    <td class="pcs_product">[-- CART_CROSS_SELL --]</td>
  </tr>
[-- END_LOOP CART_Cross_Sell --]
</table>

If your store was configured to show four Cart Cross-sell products, the result might look something like this:

Product 1

Product 2

Product 3

Product 4

[-- END_LOOP Cart_Cross_Sell --]

End displaying cart cross-sell products.

Buttons

[-- BUTTON Recalculate --]: The "Recalculate" button
[-- BUTTON Update --]: The "Update" button
[-- BUTTON EmptyCart --]: The "Empty Cart" button
[-- BUTTON ContinueShopping --]: The "Continue Shopping" button
[-- BUTTON Checkout --]: The "Checkout" button

Billing/Shipping Page

These tags are used on the shipping page.

Defines

[-- DEFINE Shipping --]: The beginning of the HTML for the shipping template
[-- END_DEFINE Shipping --]: The end of the HTML for the shipping template

Header and Footer

[-- ShippingHeader --]: Text at the top of the Shipping Screen
[-- ShippingFooter --]: Text at the bottom of the Shipping Screen
[-- STORE.Ship_Checkout --]: Text field: Checkout

Table of Products Ordered

[-- SC_Cart --]: The table showing the products ordered and the order subtotal
[-- SC_Cart quantity name sku price total --]: The table showing the products ordered and the order subtotal, with the fields in the order specified.

Totals

[-- SC_Totals --]: Displays product subtotal, shipping charges, tax charges, and the order total

Comments

[-- SC_Comments {rows columns} --]: Customer comments heading and text box with specified dimensions (Also IF)

Billing and Shipping Address

[-- SC_Address --]: Billing and shipping address forms, horizontal arrangement
[-- SC_Address Vertical --]: Billing and shipping address forms, vertical arrangement
[-- SC_Address Right--]: Billing and shipping address forms, field labels on right

E-Mail List

[-- Email_List --]: Text and checkbox for "add to e-mail list" (Also IF)

Payment

[-- SC_Payment --]: Form for entering payment information

Custom Checkout Fields

[-- CustomHTML --]: True if Custom Checkout Fields are enabled
[-- Ship_CustomHTML n --]: Insert the Custom Checkout Field where n is 1 to 5

Security

[-- IF SecurityImage --]: True if security images are enabled
[-- ShipSecurityImage --]: Includes the security image feature on the payment page.

Buttons

[-- BUTTON SubmitOrder --]: The "Submit This Order" button, or the "Confirm" button if confirmation page is enabled
[-- BUTTON ReturnToCart --]: The "Return to Cart" button

Confirmation Tags

These tags are used on the optional confirmation page.

Defines

[-- DEFINE Confirmation --]: The beginning of the HTML for the confirmation template
[-- END_DEFINE Confirmation --]: The end of the HTML for the confirmation template

Header and Footer

[-- ConfirmationHeader --]: Text at the top of the Confirmation Screen
[-- ConfirmationFooter --]: Text at the bottom of the Confirmation Screen

Table of Products Ordered

[-- SC_Cart --]: The table showing the products ordered and the order subtotal
[-- SC_Cart quantity name sku price total --]: The table showing the products ordered and the order subtotal, with the fields in the order specified.

Totals

[-- SC_Totals --]: Displays product subtotal, shipping charges, tax charges, and the order total

Ordering Instructions

[-- IF SC_OrderingInstructions_Text --]: True if customer entered any text in the Ordering Instructions box
[-- SC_OrderingInstructions --]: Ordering instructions text entered by customer

Custom Checkout Fields

[-- CustomHTML_Values --]: Display Custom Checkout Fields and values. (Also IF)

E-Mail List

[-- Email_List --]: Display the text of the e-mail signup

Comments

[-- SC_Comments --]: Customer comments text and box (Also IF)
[-- SC_Comments_Text --]: True if comments entered by customer

Billing and Shipping Address

[-- SC_Address --]: Display the billing and shipping addresses

Payment

[-- SC_Payment --]: Display the payment information

Buttons

[-- BUTTON Confirmation --]: The "Submit This Order" button
[-- BUTTON MakeChanges --]: The "Make Changes" button

Thank You Tags

These tags are used on the Thank You page.

Defines

[-- DEFINE ThankYou --]: The beginning of the HTML for the thank you template
[-- END_DEFINE ThankYou --]: The end of the HTML for the thank you template

Header and Footer

[-- ThankYouHeader --]: Text at the top of the Thank You Screen
[-- ThankYouFooter --]: Text at the bottom of the Thank You Screen
[-- STORE.SC_ThankYou --]: Text field: Thank you!
[-- STORE.SC_YourReceipt --]: Text field: Here is a copy of your receipt.
[-- STORE.SC_OrderNumber --]: Text field: Order Number
[-- SC.ThankYouBusiness --]: Text field: Thank you for your business!
[-- ThankYouOrderNumber --]: The order number
[-- ThankYouReturnStore --]: "Return to Store" button or text

Table of Products Ordered

[-- SC_Cart --]: The table showing the products ordered and the order subtotal
[-- SC_Cart quantity name sku price total --]: The table showing the products ordered and the order subtotal, with the fields in the order specified.

Totals

[-- SC_Totals --]: Displays product subtotal, shipping charges, tax charges, and the order total

Ordering Instructions

[-- IF SC_OrderingInstructions_Text --]: True if customer entered any text in the Ordering Instructions box
[-- SC_OrderingInstructions --]: Ordering instructions text entered by customer

Custom Checkout Fields

[-- CustomHTML_Values --]: Display Custom Checkout Fields and values. (Also IF)

Comments

[-- SC_Comments --]: Customer comments text and box (Also IF)
[-- SC_Comments_Text --]: True if comments entered by customer

Thank You E-Mail Tags

These tags are used on the e-mail receipt.

Defines

[-- DEFINE ThankYou_Email --]: The beginning of the HTML for the thank you e-mail
[-- END_DEFINE ThankYou_Email --]: The end of the HTML for the thank you e-mail

Header and Footer

[-- ThankYouHeader --]: Text at the top of the Thank You Screen
[-- ReceiptFooter --]: Text at the bottom of the e-mail receipt
[-- STORE.SC_ThankYou --]: Text field: Thank you!
[-- ThankYouReturnStore --]: "Return to Store" button or text
[-- ThankYouOrderNumber --]: The order number

Table of Products Ordered

[-- SC_Cart --]: The table showing the products ordered and the order subtotal
[-- SC_Cart quantity name sku price total --]: The table showing the products ordered and the order subtotal, with the fields in the order specified.

Totals

[-- SC_Totals --]: Displays product subtotal, shipping charges, tax charges, and the order total

Payment

[-- SC_Payment --]: Display the payment information

Ordering Instructions

[-- IF SC_OrderingInstructions_Text --]: True if customer entered any text in the Ordering Instructions box
[-- SC_OrderingInstructions --]: Ordering instructions text entered by customer

Custom Checkout Fields

[-- CustomHTML_Values --]: Display Custom Checkout Fields and values. (Also IF)

Comments

[-- SC_Comments --]: Customer comments text and box (Also IF)
[-- SC_Comments_Text --]: True if comments entered by customer

Billing and Shipping Address

[-- SC_Address --]: Display the billing and shipping addresses

Cross-sell Defines

The appearance of Global and Product Cross-sell products in the Shopping Cart are controlled by the definitions below. Cross-sell products should usually be kept minimal to avoid interfering with the primary function of the Shopping Cart.

Note:

Do not use forms in Cross-sell product definitions. Cross-sell products are likely to be displayed within the Shopping Cart form, and use of form tags within the cross-sell product could prematurely end the Shopping Cart form, potentially disabling the checkout process.

Defines

[-- DEFINE GLOBAL_CROSS_SELL --]: The beginning of the HTML for the global cross-sell product.
[-- END_DEFINE GLOBAL_CROSS_SELL --]: The end of the HTML for the global cross-sell product.

[-- DEFINE CART_CROSS_SELL --]: The beginning of the HTML for the cart product cross-sell product.
[-- END_DEFINE CART_CROSS_SELL --]: The end of the HTML for the cart product cross-sell product.

Links

[-- IF CROSS_SELL_LINK --]

True if cross-sell products should include links to product information pages.

[-- CROSS_SELL_LINK --]

The URL for links to Cross-sell product pages, as determined by the Cross-sell link destination setting in the back office. This can be used in an anchor tag such as:

<a class="gcs_link" href="[-- CROSS_SELL_LINK --]" title="[-- PRODUCT.Name --]">

Product Tags

You can use tags from the PRODUCT definition within a cross-sell definition. The following PRODUCT tags should usually be included in the cross-sell definition:

[-- PRODUCT.Name --]

The product name.

[-- PRODUCT.Price --]

The price of the product. Note that this value is formatted according to the store currency setting and includes the currency symbol.

[-- PRODUCT.Graphic --]

Returns a full <img src> tag for the product graphic with all the formatting information, including size and alt values. Use the REMOVE_HTML attribute if you want to customize the <img> tag, as described for the PAGE.GRAPHIC tag.

[-- PRODUCT.AddToCartURL --]

The following is an example of a product Add To Cart link that you could use in a Cross-sell definition. Remember not to use a form-based Add To Cart link in Cross-sell definitions.

[-- IF AddImage? --]
  <td class="pcs_product_add_to_cart"><a class="pcs_addtocart_button"
  href="[-- PRODUCT.AddToCartURL --]"><img class="pcs_addtocart_button"
  alt="Add to Cart" [-- AddImage --] border="0"></a></td>
[-- ELSE --]
  <td class="pcs_product_add_to_cart"><a class="pcs_addtocart_button"
  href="[-- PRODUCT.AddToCartURL --]">[-- AddText --]</a></td>
[-- END_IF --]

ShopSite Help and Resource Center
Last updated: November 10, 2007
Give Feedback