less than a minute read • Updated 9 minutes ago

Cart variables reference

Reference for the Twig and JavaScript variables available on the cart template, including cart data and cart configuration.

The variables available on the cart template, exposed to Twig and to JavaScript in the FC.json object. Access array items in a loop, like {% for item in items %}{{ item.name }}{% endfor %}.

Cart

Variable	Description
`cart_cancel_and_continue_link`	URL for continuing back to the store from the cart.
`cart_config_hash`	Used to validate the locale storage version of FC.json.config is up to date.
`cart_is_fullpage`	true or false depending if the cart is the full page cart or not
`context`	Either cart, checkout or receipt. Used for configuring various display and functionality concerns. cart represents both Sidecart and full page cart versions.
`coupons`<br>`coupons.{coupon_code}`<br>`coupons.{coupon_code}.amount`<br>`coupons.{coupon_code}.id`<br>`coupons.{coupon_code}.is_applied`<br>`coupons.{coupon_code}.is_taxable`<br>`coupons.{coupon_code}.name`	Coupons associated with this cart. The {coupon_code} is the code value used by the customer to add the coupon. If the cart has shared coupon codes (the “Shared Codes Allowed?” checkbox is checked), the value becomes a nested array under that same {coupon_code} key — see the example below the table.
`custom_fields`<br>`custom_fields.{name}`<br>`custom_fields.{name}.is_hidden`<br>`custom_fields.{name}.value`	The custom fields associated with this transaction. The is_hidden bit will be true if the custom fields were passed in via the h: prefix. The {name} is the value of the name assigned to this custom field.
`expires_in`	The time in seconds until the first product in the cart expires
`future_coupons`<br>`future_coupons.{coupon_code}`<br>`future_coupons.{coupon_code}.amount`<br>`future_coupons.{coupon_code}.id`<br>`future_coupons.{coupon_code}.is_applied`<br>`future_coupons.{coupon_code}.name`	Same as coupons above, but for products with a start date or next transaction date in the future.
`future_subscription_totals_by_date`<br>`future_subscription_totals_by_date.total`<br>`future_subscription_totals_by_date.total_item_price`<br>`future_subscription_totals_by_date.total_shipping`<br>`future_subscription_totals_by_date.total_tax`<br>`future_subscription_totals_by_date.total_weight`	The totals for subscription products with a start date or next transaction date in the future are grouped together here for the cart display.
`gift_cards`<br>`gift_cards.{gift_card_code}`<br>`gift_cards.{gift_card_code}.amount`<br>`gift_cards.{gift_card_code}.id`<br>`gift_cards.{gift_card_code}.code_id`<br>`gift_cards.{gift_card_code}.is_applied`<br>`gift_cards.{gift_card_code}.name`<br>`gift_cards.{gift_card_code}.current_balance`	Gift cards associated with this cart. The {gift_card_code} is the code value used by the customer to add the gift card. Note: The current_balance attribute will not factor in the discount that could apply from the cart or checkout. On the web receipt, current_balance will take into account the discount from that transaction, and any other uses of the gift card since then (if the receipt is being revisited). The email receipt will be the current balance of the gift card at the time the transaction was completed.
`has_eligible_coupons`	If the cart contains products which can have a coupon applied to them.
`has_future_products`	If the cart contains products with a start date or a next transaction in the future (a “future product”).
`has_future_shipping`	If the cart contains future products from categories which support shipping.
`has_live_rate_shippable_products`	If the cart contains products from categories which support live shipping rates.
`has_location_dependant_taxes`	If the cart contains products from categories which have taxes based on the customer’s location. This is used for handling third party payment options such as PayPal Express and Amazon FPS.
`has_multiship`	If the store has multiship turned on.
`has_product_images`	If any of the products in the cart took advantage of the image option.
`has_shippable_products`	If the cart contains products from categories which support shipping.
`has_subscriptions`	If the cart contains subscription products.
`has_taxes`	If the cart contains products from categories which have taxes applied to them.
`is_future_shipping_only`	If all of the products in the cart are future products, this tells the system the shipping calculations will only be for future products.
`is_new_subscription`	If the cart contains a new subscription
`is_subscription_cancel`	If this transaction is for canceling an existing active subscription.
`is_subscription_modification`	If this transaction is currently modifying an existing active subscription. This will usually mean there are products in the cart which will charge in the future.
`is_updateinfo`	If cart=updateinfo.
`item_count`	The sum total of all the product quantities in the cart.
`items[]`	An array of all the products in the cart.
`items[].alt_name`	Used in the alt attribute of the product link.
`items[].base_price`	Product price before product option modifiers.
`items[].category`	Product category code.
`items[].code`	Product code or sku.
`items[].parent_code`	Parent product code or sku.
`items[].delivery_type`	The delivery type of this product.
`items[].downloadable_id`	If this product is a downloadable, this is the downloadable id for it.
`items[].expires`	The timestamp for when this product expires.
`items[].height`	Reserved for future use.
`items[].id`	Unique internal id for this product.
`items[].image`	The image url for this product.
`items[].is_parent`	If this product is a parent product or not
`items[].item_number`	Used for organizing item display and managing the product update process.
`items[].length`	Reserved for future use.
`items[].multiship`	The multiship group number used for organizing products into shipments.
`items[].name`	The product name.
`items[].options[]`	Array or product options for this product.
`items[].options[].class`	The option name stripped of anything but letters, numbers, dashes and underscores so it can be used as a html class attribute.
`items[].options[].name`	The product option name.
`items[].options[].value`	The product option value.
`items[].price`	The price extension of these products (price_each * quantity)
`items[].price_each`	The actual price of an individual product after product option modifiers.
`items[].quantity`	The quantity of this product in the cart.
`items[].quantity_max`	The maximum quantity allowed in the cart for this product.
`items[].quantity_min`	The minimum quantity allowed in the cart for this product.
`items[].shipto`	The shipto name of this product used for multiship.
`items[].sub_enddate`	The end date of this subscription product.
`items[].sub_frequency`	The frequency of this subscription product.
`items[].sub_nextdate`	The next date this subscription product will process.
`items[].sub_startdate`	The start date of this subscription product.
`items[].url`	The url of this product.
`items[].weight`	The weight extension of the this product (weight_each * quantity)
`items[].weight_each`	The weight of an individual product.
`items[].width`	Reserved for future use.
`language`	The English name for the language of the cart as set by the template set (like english, french, german etc). Can be blank if using the default template set.
`language_iso_code`	The 2 character ISO code for the language of the cart as set by the template set (like en, fr, de etc). Can be blank if using the default template set.
`loading_coupons`<br>`loading_quantity`<br>`loading_shipping_results`<br>`loading_taxes`	Used for determining if a loading animation should currently be displayed.
`locale_code`	The locale code for this cart such as en_US
`locale_info`	This includes all of the data output by PHP’s localeconv() including currency symbols, decimal point character, and thousands separator.
`messages`	Used for displaying error, warning, and information messages in the cart.
`messages.errors[]`	An array of error messages.
`messages.errors[].context`	The context of this error message which often relates to a form input.
`messages.errors[].message`	The content of the error message. Often times this will be blank as the error message is directly part of the template as a language string.
`messages.info[]`	An array of informational messages.
`messages.info[].context`	The context of this informational message.
`messages.info[].message`	The content of the informational message.
`messages.warnings[]`	An array of warning messages.
`messages.warnings[].context`	The context of this warning message.
`messages.warnings[].message`	The content of this warning message.
`multiship_data`	(Currently empty for the cart, may be added in the future)
`payment_info_required`	True if payment information is required for this transaction (order total > 0 for an order and not doing a subscription cancel).
`session_id`	The session id of this cart.
`session_name`	The name of the FoxyCart session.
`shipping_address`	Container for the shipping address information.
`shipping_address.address1`	Address 1
`shipping_address.address2`	Address 2
`shipping_address.address_name`	The address name of this address (used mainly for multiship)
`shipping_address.city`	City
`shipping_address.city_option_selected`	The city, region put togther as a string used in the select option.
`shipping_address.city_options`	Array of options returned from the postal code lookup.
`shipping_address.city_options.city`	City
`shipping_address.city_options.region`	Region (such as state or province)
`shipping_address.company`	Company
`shipping_address.country`	Two character country code
`shipping_address.country_name`	Country name
`shipping_address.first_name`	First Name
`shipping_address.last_name`	Last Name
`shipping_address.phone`	Phone
`shipping_address.postal_code`	Postal code
`shipping_address.prefix`	Prefix (used for multiship)
`shipping_address.region`	State or Province code
`shipping_address.region_label`	Label for this region (such as state or province)
`shipping_address.region_name`	State or province name.
`shipping_address.shipping_results[]`	A result of calculating live shipping rates.
`shipping_address.shipping_results[].method`	This shipping method (USPS, UPS, FedEx, etc).
`shipping_address.shipping_results[].price`	The quoted price for this shipping service.
`shipping_address.shipping_results[].service_id`	The service id used by this shipping method for this service.
`shipping_address.shipping_results[].service_name`	The name of this shipping service.
`shipping_address.shipping_service_description`	The description of this shipping service.
`shipping_address.shipping_service_id`	The shipping service id the service the customer selected.
`shipping_address.taxes[]`	An array of taxes associated with this shipping address.
`shipping_address.taxes[].amount`	Amount of this tax.
`shipping_address.taxes[].applies_to_handling`	Whether or not this tax applies to handling fees.
`shipping_address.taxes[].applies_to_shipping`	Whether or not this tax applies to shipping costs.
`shipping_address.taxes[].default_amount`	The default amount before being applied to a specific location.
`shipping_address.taxes[].is_error`	If this tax has an error.
`shipping_address.taxes[].is_live`	If this tax is live.
`shipping_address.taxes[].name`	The name of this tax.
`shipping_address.taxes[].rate`	The tax rate.
`shipping_address.taxes[].tax_id`	The internal id of this tax.
`shipping_address.total_future_shipping`	The total amount of future shipping costs for the products being sent to this address.
`shipping_address.total_shipping`	The total shipping costs for the products being sent to this address.
`shipping_address.total_tax`	The total tax for the products being sent to this address.
`shipping_address.type`	The type for this address (either billing or shipping)
`shipping_and_handling_label`	The label describing the shipping applied to this order.
`show_address_entry`	Used to determine if the cart address entry form should be displayed.
`show_amazon_fps_payment_option`	Used for determining if the amazon payment button should be shown. It will not be shown if there are subscriptions in the cart.
`show_coupon_input_button`	Used for determining if the coupon input button should be shown.
`show_multiship_details`	Used to toggle the multiship details.
`show_paypal_express_payment_option`	Used for determining if the Paypal payment button should be shown.
`show_shipping_tbd`	Used for determining if live shipping rates haven’t yet been calculated so a “TBD” indicator is displayed instead.
`store_id`	The FoxyCart store id for this store.
`template_set`	The code for the cart’s current template set
`total_discount`	The total coupon discount applied to this transaction.
`total_future_item_price`	The total price of the future items in the cart.
`total_future_shipping`	The total amount of the shipping costs assigned to future products in the cart.
`total_future_weight_shippable`	The total weight of the future shipable products in the cart.
`total_item_price`	The total price of the items in the cart.
`total_order`	The order total
`total_shipping`	The shipping total
`total_tax`	The tax total
`total_weight`	The total product weight.
`total_weight_shippable`	The total weight of the shippable products in the cart.
`transaction_id`	The FoxyCart transaction id for the contents of the cart.

Shared coupon codes example

If a coupon code is shared between multiple coupons, the value becomes a nested array under that same code, rather than a single object:

"coupons": {
    "code1a": {
        "amount": -1,
        "id": "4704984",
        "is_applied": true,
        "is_taxable": false,
        "name": "Coupon 2"
    },
    "code2a": [
        {
            "amount": -1,
            "id": "4704985",
            "is_applied": true,
            "is_taxable": false,
            "name": "Coupon 1"
        },
        {
            "amount": -1,
            "id": "4704988",
            "is_applied": true,
            "is_taxable": false,
            "name": "Coupon 2"
        }
    ]
}

Cart Config (FC.json.config)

Variable	Description
`cache_path`	Path used for caching images in the FoxyCart system.
`cart_config_hash`	Used to validate the locale storage version of FC.json.config is up to date.
`cdn_base_path`	The base path of your store’s files served via the CDN.
`cdn_static_path`	The base path of static files served via the CDN.
`css_file`	The full path to the versioned store-specific stylesheet served by the CDN.
`currency_format`	The currency format configured for your store and use for twig money formatting.
`lang`	All language strings in FoxyCart are completely customizable. We start with a base language configuration and then you can customize them individually from there.
`lang.{code}`<br>`lang.{code}…`	You can view all language strings used on the cart by viewing FC.json.config.lang in your browser’s web console.
`locations`	A complete listing of all valid country codes and state/provinces within those countries used by our find-as-you type auto complete (FoxyComplete) country and region lookup system.
`locations.{country_code}`<br>`locations.{country_code}…`	Locations are grouped by their 2 character ISO country code.
`locations.{country_code}.active`	If this country is actively being used by the FoxyComplete system.
`locations.{country_code}.alt`	Alternative spellings or local spellings of this location name.
`locations.{country_code}.boost`	Used to give certain spellings a boost over others.
`locations.{country_code}.cc2`	ISO 3166-1 alpha-2 code for this country.
`locations.{country_code}.cc3`	ISO 3166-1 alpha-3 code for this country.
`locations.{country_code}.ccnum`	ISO 3166-1 numeric code for this country.
`locations.{country_code}.cn`	Country name (currently in english).
`locations.{country_code}.pc`	Postal Code format details.
`locations.{country_code}.pc.int`	If the postal code is numeric only.
`locations.{country_code}.pc.lang`	The language key string for the description of this postal code.
`locations.{country_code}.pc.regex`	The regex pattern this postal code fits in for validation purposes.
`locations.{country_code}.pc.req`	Whether or not the postal code is required.
`locations.{country_code}.pc.search`	Whether or not this country supports a postal-code based search.
`locations.{country_code}.r`	Region details for this country.
`locations.{country_code}.r.lang`	The language key string for name of this country’s regions such as “state.”
`locations.{country_code}.r.options.{region code}`	Region information organized by two character ISO code.
`locations.{country_code}.r.options.{region code}.active`	If this region is actively being used by the FoxyComplete system.
`locations.{country_code}.r.options.{region code}.alt`	Alternative spellings or local spellings of this region name.
`locations.{country_code}.r.options.{region code}.boost`	Used to give certain spellings a boost over others.
`locations.{country_code}.r.options.{region code}.c`	ISO 3166-1 alpha-2 code for this country.
`locations.{country_code}.r.options.{region code}.n`	Region name (currently in english).
`locations.{country_code}.r.options.{region code}.req`	If regions are required for this country.
`locations_billing`	Locations used for billing address information only (see locations)
`locations_shipping`	Locations used for shipping address information only (see locations)
`paypal_checkout_button_url`	Locale specific PayPal payment button URL.
`post_url`	URL for posting cart and checkout forms.
`store_domain`	This FoxyCart stores FoxyCart store domain (the example part of example.foxycart.com).
`store_logo_url`	Your store logo url as configured in the FoxyCart admin.
`store_name`	Your FoxyCart store name as configured in the FoxyCart admin.
`store_url`	Your store’s website URL as configured in the FoxyCart admin.
`template_config`	All of the settings configured in the FoxyCart admin under the configuration menu will be available here for you to use within your twig template customizations.
`template_config.analytics_config`	(UNDER CONSTRUCTION): A place to automatically configure your analytics tools.
`template_config.analytics_config.google_analytics`	Configuration settings for your Google Analytics account.
`template_config.analytics_config.google_analytics.account_id`	Your Google Analytics account id
`template_config.analytics_config.google_analytics.account_key`	Your Google Analytics account key
`template_config.analytics_config.google_analytics.usage`	Configuration for how this setting is being used.
`template_config.analytics_config.segment_io`	Configuration settings for your Segment.io account.
`template_config.analytics_config.segment_io.account_key`	Your Segment.io account key
`template_config.analytics_config.segment_io.usage`	Configuration for how this setting is being used.
`template_config.analytics_config.usage`	Configuration for how this setting is being used.
`template_config.cart_display_config`	Settings for controlling the display details of your cart.
`template_config.cart_display_config.show_product_category`	Whether or not to show the product category code in the line item details.
`template_config.cart_display_config.show_product_code`	Whether or not to show the product code in the line item details.
`template_config.cart_display_config.show_product_options`	Whether or not to show the product options in the line item details.
`template_config.cart_display_config.show_product_weight`	Whether or not to show the product weight in the line item details.
`template_config.cart_display_config.usage`	Whether or not the cart display config has been set or if defaults are in use.
`template_config.checkout_type`	Either default_account, default_guest, guest_only, or account_only for determining if your checkout will accept guest checkouts or required named accounts and which one will be the default action.
`template_config.colors`	This configuration allows you to specify the main colors of your website and our system will adjust the CSS using SASS as needed to incorporate your colors into our template designs.
`template_config.colors.primary`<br>`colors.secondary`<br>`colors.tertiary`	The primary, secondary, and tertiary colors for your website.
`template_config.colors.usage`	Whether or not this configuration setting is being used.
`template_config.csc_requirements`	Settings for how you’d like to require the Card Security Code (CSC) for your website. Values include all_cards, sso_only (Single Sign On only), new_cards_only (do not require for saved cards).
`template_config.custom_checkout_field_requirements`	Configuration for displaying and requiring various checkout fields and features.
`template_config.custom_checkout_field_requirements.billing_address1`<br>`template_config.custom_checkout_field_requirements.billing_address2`<br>`template_config.custom_checkout_field_requirements.billing_city`<br>`template_config.custom_checkout_field_requirements.billing_company`<br>`template_config.custom_checkout_field_requirements.billing_country`<br>`template_config.custom_checkout_field_requirements.billing_first_name`<br>`template_config.custom_checkout_field_requirements.billing_last_name`<br>`template_config.custom_checkout_field_requirements.billing_phone`<br>`template_config.custom_checkout_field_requirements.billing_postal_code`<br>`template_config.custom_checkout_field_requirements.billing_region`	These can be set to either hidden, required, optional, or default (in the case of billing_region)
`template_config.custom_checkout_field_requirements.cart_controls`	Whether or not to allow cart controls on the checkout page.
`template_config.custom_checkout_field_requirements.coupon_entry`	Whether or not to allow the coupon entry form on the checkout page.
`template_config.custom_config`	This is where you can put your own custom configuration values for your twig templates. This might be helpful if you want to hard code your templates with some logic and change the display outcome by just adjusting the values here.
`template_config.custom_script_values`	Used for setting custom JavaScript or CSS elements to be used in the default template.
`template_config.custom_script_values.footer`	If you have custom JavaScript you’d like to add above the </body> tag for your cart, checkout and receipt templates, put that here. You can use it for conversion tracking scripts by checking the first_receipt_display variable. Full twig syntax is supported here.
`template_config.custom_script_values.header`	If you have custom CSS (or JavaScript, though the footer is a better place for that) you’d like to add to the <head> tag for your cart, checkout and receipt templates, put that here. Full twig syntax is supported here.
`template_config.custom_script_values.checkout_fields`	If you to add custom fields to your store’s checkout template, add HTML here. These will be inside the <form> tag on the checkout page and will submit with the rest of the checkout form and be recorded as custom fields on the transaction. Full twig syntax is supported here.
`template_config.debug`	Turn this on to see debugging output in your web browser’s console log.
`template_config.debug.usage`	How this setting is currently being used.
`template_config.foxycomplete`	Our country and region auto completion system which lets users find locations as they type instead of having to select from a huge list of options.
`template_config.foxycomplete.combobox_close`	The icon used for closing the location combo box.
`template_config.foxycomplete.combobox_open`	The icon used for opening the location combo box.
`template_config.foxycomplete.show_combobox`	Whether or not to show the location combo box.
`template_config.foxycomplete.show_flags`	Whether or not to show the country flags.
`template_config.foxycomplete.usage`	Configure how this feature is being used.
`template_config.newsletter_subscribe`	This allows you to easily add a “Subscribe Me” checkbox to your checkout template so you can use that value as a custom field in the transaction datafeed later.
`template_config.newsletter_subscribe.usage`	How this setting is configured.
`template_config.ssl_receipt`	If you require the receipt page to be loaded over HTTPS, turn this feature on.
`template_config.supported_payment_cards`	An array of the accepted payment cards by your store such as Visa, MasterCard, etc. This will control which card logos are shown on the checkout page.
`template_config.tos_checkbox_settings`	Use this setting to easily add a terms of service checkbox to your checkout page.
`template_config.tos_checkbox_settings.initial_state`	Whether or not the terms of service checkbox is checked by default.
`template_config.tos_checkbox_settings.url`	The URL to your terms of service document.
`template_config.tos_checkbox_settings.usage`	How this setting is configured (none, required or optional).
`template_config.use_checkout_confirmation_window`	(UNDER CONSTRUCTION) A popup window for customers to confirm their order before submitting it.
`template_config.use_checkout_confirmation_window.usage`	Configure how this feature is being used.
`weight_uom`	The unit of measure used for calculating shipping weights.
`with_controls`	Whether or not the current display output includes cart controls such as quantity and coupon entry fields.

Need Help?

Did this article answer your questions? Need help with anything? Please click below to contact us.

In This Article

Need Help?

Cart variables reference

Cart

Shared coupon codes example

Cart Config (FC.json.config)

Need Help?