Versions Compared

Version Old Version 56 New Version Current
Changes made by

Chris Torigian

Chris Torigian

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Notes

AdvertisingSource

Specifies the advertising source associated with the customer's visit or order. This can be used for tracking marketing campaigns or referrals.

AutoOrderSchedule

Allows you to pre-select a customer-selectable auto-order schedule, enabling recurring shipping options from your site.

Quantity

The quantity of the item to add to the cart. This parameter is typically paired with the ADD parameter (e.g., ADD=ItemID&Quantity=5).

CustomField1

Up to 50 characters maximum.

CustomField2

Up to 50 characters maximum.

CustomField3

Up to 50 characters maximum.

CustomField4

Up to 50 characters maximum.

CustomField5

Up to 50 characters maximum.

CustomField6

Up to 50 characters maximum.

CustomField7

Up to 50 characters maximum.

OptionName#

Used in pairs with OptionValue# to pass item options. For example, to pass two options, you would use OptionName1, OptionValue1, OptionName2, and OptionValue2.

OptionValue#

The value corresponding to the OptionName#.

VariationName#

Similar to OptionName# and OptionValue#, these parameters are used in pairs with VariationValue# to pass item variation values.

VariationValue#

The value corresponding to the VariationName#.

ShippingCheapestMethod

When present, UltraCart will automatically select the cheapest available shipping method for the order.

ShippingMethod

Used to force a specific shipping method. The value should be the exact name of the shipping method. For example, to force "INTL FLAT" shipping, use &ShippingMethod=INTL%20FLAT.

SinglePageCheckout

Set to true to force the cart into single-page checkout. (Note: This cannot be reverted to multi-page checkout within the same session by setting it to false.)

ImmediateFinalize

Attempts to immediately finalize the order. Only use this if you are providing all necessary billing, shipping, credit card information, and the cheapest shipping method parameters simultaneously.

ImmediateThirdPartyHandoff

Attempts to immediately hand off the browser to a third-party payment processor (e.g., http://CCBill.com ).

PayPalExpressCheckout

Pass true to initiate a PayPal Express Checkout session.

UpsellPathCode

Specifies a particular upsell path that should be displayed to the customer during the checkout process.

ADD_<item id>

Adds a specified quantity of an item to the cart. For example, an input field named ADD_BONES with a value of 10 would add 10 units of the item with ID "BONES" to the cart.

REMOVE_<item id>

Removes the specified item ID from the cart if it exists. For example, an input field named REMOVE_SHIRT would remove the item with ID "SHIRT".

Export to Sheets

Billing Information Parameters

Parameter

Description

BillingFirstName

The customer's billing first name.

BillingLastName

The customer's billing last name.

BillingCompany

The customer's billing company name.

BillingAddress1

The first line of the customer's billing address.

BillingAddress2

The second line of the customer's billing address.

BillingCity

The customer's billing city.

BillingState

The customer's billing state or province.

BillingPostalCode

The customer's billing postal code or zip code.

BillingCountry

The customer's billing country.

BillingDayPhone

The customer's billing daytime phone number.

BillingEveningPhone

The customer's billing evening phone number.

Email

The customer's primary email address.

CCEmail

An optional secondary email address for sending copies of order notifications.

...

Shipping Information Parameters

Parameter

Description

ShippingFirstName

The customer's shipping first name.

ShippingLastName

The customer's shipping last name.

ShippingCompany

The customer's shipping company name.

ShippingAddress1

The first line of the customer's shipping address.

ShippingAddress2

The second line of the customer's shipping address.

ShippingCity

The customer's shipping city.

ShippingState

The customer's shipping state or province.

ShippingPostalCode

The customer's shipping postal code or zip code.

ShippingCountry

The customer's shipping country.

ShippingDayPhone

The customer's shipping daytime phone number.

ShippingResidentialAddress

Accepts Yes or No to indicate if the shipping address is residential.

Export to Sheets

Address Copying Logic Parameters

...

Parameter

Notes

BillingSameAsShipping

Copies the shipping address details to the billing address fields, overwriting any existing billing information. This parameter does not consider other billing-related parameters.

DefaultBillingSameAsShipping

Copies the shipping address details to the billing address fields, overwriting existing billing information, unless BillingDifferent=true is also present.

DefaultShippingSameAsBilling

Copies the billing address details to the shipping address fields, overwriting existing shipping information, unless ShippingDifferent=true is also present.

BillingDifferent

This parameter acts as a cancel action for DefaultBillingSameAsShipping. If true, it prevents DefaultBillingSameAsShipping from copying the shipping address to billing. It has no effect on its own.

ShippingDifferent

This parameter acts as a cancel action for DefaultShippingSameAsBilling. If true, it prevents DefaultShippingSameAsBilling from copying the billing address to shipping. It has no effect on its own.

Export to Sheets

Credit Card Information Parameters

Panel
panelIconId1f6d1
panelIcon:octagonal_sign:
panelIconText🛑
bgColor#FFBDAD

Warning: Directly passing raw credit card numbers and CVV2 codes is not recommended due to PCI compliance requirements. UltraCart strongly recommends using Hosted Fields for secure collection of sensitive payment information.

Parameter

Notes

CreditCardType

The type of credit card (e.g., "Visa", "Mastercard", "American Express", "Discover").

CreditCardNumberToken

Replaces CreditCardNumber. Use this parameter when integrating with UltraCart's Hosted Fields solution for secure card number tokenization. See the Hosted Fields documentation for details.

CreditCardExpMonth

The two-digit expiration month of the credit card (e.g., "01" for January, "12" for December).

CreditCardExpYear

The four-digit expiration year of the credit card (e.g., "2025").

CreditCardCVV2Token

Replaces CreditCardNumberCvv2. Use this parameter when integrating with UltraCart's Hosted Fields solution for secure CVV2 tokenization. See the Hosted Fields documentation for details.

PaymentType

Accepts "Credit Card", "Check", or "eCheck".

...