Product Parameters

cart

Description: The cart parameter allows for various behaviors to be performed when the cart is requested. Note, the cart parameter is separate from the /cart portion of the cart URL. Within an add to cart link it should be separate like /cart?cart=view, or specified as a hidden input in an add to cart form.
Accepts:

• add: The default cart action. If you don't include a cart input, add is assumed.

• view: Displays the cart (if output=html) or returns the cart (if output=json) without adding any products to the cart. Custom session values can be added on a cart=viewrequest.

• checkout: Redirects to the checkout page immediately. Any “add to cart” requests are processed first, so you can add a product to the cart and go immediately to the checkout.

• checkout: With fc_payment_method=paypal_ec Redirects to PayPal Express Checkout with reference transactions immediately. Any “add to cart” requests are processed first, so you can add a product to the cart and go immediately to the checkout.

• checkout_paypal_express: Redirects to PayPal for the legacy Express Checkoutimmediately. Any “add to cart” requests are processed first, so you can add a product to the cart and go immediately to the checkout.

• updateinfo: Redirects to the checkout page with the updateinfo flag set, allowing the customer to update their billing information without actually buying anything. This will empty the customer's cart. More info about the ''updateinfo'' functionality.

• empty: Deprecated. Will be removed in a future release. Use the empty parameter instead.

  Default: view

h:…
(CUSTOM Session Values)

Description: “Session values”, as the name suggests, are added to the customer's session, and are not tied to products. Values stored in session values are available in the JSON, as well as the XML datafeed upon a successful transaction.
Accepts: Any h:name=value pair. The h: prefix on the name makes it a session value as opposed to a custom product option.
Notes: Session values are useful for synching custom fields between FoxyCart and your own system, or using information from an external system to manipulate FoxyCart. For example, you could pass in a customer ID value that would sync back to your own database. Or a referrer or affiliate ID could be added to the session and then processed via the XML datafeed upon a completed transaction. Maximum length for the value is 700 characters.

empty

Description: This will clear the contents of the cart. If products are added in the same request, the cart will be emptied and then the products will be added.
Accepts:

• true: Empties the cart, including all custom session values, coupons, customer address and prepopulation values, shipping selections, etc.

• reset: Does all of the above but also resets the cookie. The use case for this is uncommon, so in general you should use the true instead of the reset value.

coupon

Description: Adds one or more coupon codes directly to the cart.
Accepts: Any valid coupon codes, separated by a comma.
Notes: If an invalid code is added, or a code is re-added, an error may display on the cart. As with all coupon codes, once a code is added it will remain for the life of the session or until removed. This can be useful if you want to have a link with a coupon code that doesn't actually add a product to the cart but instead redirects to a order page or the website's homepage. Check the redirect option below for more.
Notes: If you're using the link and form validation, do not sign the couponvalue.

redirect

Description: Immediately redirects the user to a page on cart load, such as &redirect=index.html.
Accepts: path/to/file.ext
Notes: For security reasons, the path must be at the store's domain (as entered in the store's FoxyCart settings). ie. You cannot redirect to example.org/path/to/file.ext if your store's domain in FoxyCart is example.com. Additionally, you may need to URL encode any ? and & symbols in a redirection path.

locale

Experimental Functionality: This feature will be further tested and documented. Please refer to FoxyCart's multicurrency documentation for more info.
Description: Sets the currency for the cart. Converts any existing items in the cart from the current currency (the store's default) to the newly specified currency.
Accepts: FoxyCart will attempt to match a locale in the following order. If no locale is matched, it will continue to the next option and attempt a match there.

1. A full locale code in the format of 2 character language code, followed by an underscore and a two character territory, such as en_US (US, English) or es_MX(Mexico, Spanish).

2. A value prefixed by the h:lang value: Whatever you pass through as the locale value will be prefixed with the value currently set in h:lang, concatenated with an underscore. So if you have set h:lang=es and pass through locale=MX, the session will attempt to set the locale to es_MX.

3. A value prefixed by en_: If the above don't match, the locale value will be prefixed with en_ in an attempt to match a valid locale.

4. Case-insensitive locale match

template_set

Description: Used to specify a specific template set to apply to this cart session
Accepts: Any valid template set code
Notes: If a template set is applied which changes the locale of the cart session, any existing products will be removed from the cart. Products added in the same request will be added normally.

output

Description: Specify the output format for the cart request.
Accepts:

• html

• json (will load the JSON cart object)

Default: html

callback

Description: Used to make an output=json request return a JSONP (instead of JSON) response. This will typically be used with a javascript library like jQuery.

fc_auth_token

Description: Used with Single Sign-On (SSO) to allow a customer to proceed through to the checkout.

h:shipto_residential

Description: Since shipping rates can be returned from the cart (where the company address field isn't entered), and since the difference between residential and commercial shipping rates can be important, you can set this to true or false to override the setting from the shipping section of the FoxyCart admin.
Accepts: true or false
Default: n/a. Shipping rates are determined in the shipping settings in the FoxyCart admin.

h:bypass_maintenance_mode

Description: You can set this to true to override the maintenance mode for your store (and view the checkout normally).
Accepts: true
Default: false

utm_source, utm_medium, utm_campaign, utm_term, utm_content, _ke

Description: URL parameters for Google Analytics custom campaigns and Klayvio. When specified as part of an add to cart, they'll be included in the next page load of either the cart or the checkout.
Notes: These values should not be encrypted when using link/form encryption, and they must be passed as URL parameters - passing them within the hash is not supported. The values are not stored in the session at all - they're just used on the resulting page load of the add to cart action.