| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| v:0.7.1:cheat_sheet [2011/07/01 04:08] – [Standard Product Options] adam | v:0.7.1:cheat_sheet [2017/06/27 18:52] (current) – [Subscription Product Options] marija |
|---|
| : **Description:** Product's per-product weight, used for shipping rate requests. | : **Description:** Product's per-product weight, used for shipping rate requests. |
| : **Default:** If left blank, it will inherit this value from the product’s category. If no category selected, will default to the default category's specified weight. | : **Default:** If left blank, it will inherit this value from the product’s category. If no category selected, will default to the default category's specified weight. |
| | : **Notes:** <wrap round important>Supports up to a maximum of three decimal places.</wrap> |
| ; ''shipto'' | ; ''shipto'' |
| : **Description:** Allows you to specify specific ship-to address labels for each cart add. | : **Description:** Allows you to specify specific ship-to address labels for each cart add. |
| ; CUSTOM Product Options | ; CUSTOM Product Options |
| : **Description:** <wrap round tip>You may add any additional attributes to any product you’d like.</wrap> For example, you can add ''&color=green&size=XXL''. If an attribute is passed in with a name not otherwise reserved, it will be added as a product option. | : **Description:** <wrap round tip>You may add any additional attributes to any product you’d like.</wrap> For example, you can add ''&color=green&size=XXL''. If an attribute is passed in with a name not otherwise reserved, it will be added as a product option. |
| | |
| | |
| ==== Product Discounting Options ==== | ==== Product Discounting Options ==== |
| Please see [[.:coupons_and_discounts|Coupons and Discounts]] for a complete discussion of how discounts are applied. The following is for reference only. | Please see [[.:coupons_and_discounts|Coupons and Discounts]] for a complete discussion of how discounts are applied. The following is for reference only. |
| ; ''sub_startdate'' | ; ''sub_startdate'' |
| : **Description:** Subscription start date. Useful if you'd like to offer a free trial period, or to force subscriptions to process on specific dates (the 1st, 15th, 18th, etc.). | : **Description:** Subscription start date. Useful if you'd like to offer a free trial period, or to force subscriptions to process on specific dates (the 1st, 15th, 18th, etc.). |
| : **Default:** "Today", or "immediately". | : **Default:** If this value is left empty, the subscription will start on the date of the transaction. |
| : **Accepts:** You can pass through a full date in the ''YYYYMMDD'' format or just pass in the day of this month in the ''DD'' or ''D'' format. If you pass through a day that has already past, it will start on that day next month. | : **Accepts:** You can pass through a full date in the ''YYYYMMDD'' format or just pass in the day of this month in the ''DD'' or ''D'' format. If you pass through a day that has already past, it will start on that day next month. |
| * ''YYYYMMDD'' = Example: ''20070131'' = January, 31 2007. | * ''YYYYMMDD'' = Example: ''20070131'' = January, 31 2007. |
| |
| ==== Product Option Modifiers ==== | ==== Product Option Modifiers ==== |
| Product option modifiers allow you to modify the ''price'', ''weight'', ''code'', or ''category'' when another option is set. Modifiers are placed inside curly brackets (''{}'') at the end of your product option, and can add to (''+''), subtract from (''-''), or set ('':'') new values to the modified option. <wrap round tip>Multiple modifiers can be chained together</wrap> with the "pipe" symbol (''|''), like ''value="S{p+1.50|w-1|c:01a|y:teeny_category}"''. When using [[advanced:hmac_validation|cart validation]] it is recommended to set your initial values high then modify //down//, rather than the other way around. See the [[advanced:hmac_validation|validation docs]] for explanation. | Product option modifiers allow you to modify the ''price'', ''weight'', ''code'', or ''category'' when another option is set. Modifiers are placed inside curly brackets (''{}'') at the end of your product option, and can add to (''+''), subtract from (''-''), or set ('':'') new values to the modified option. <wrap round tip>Multiple modifiers can be chained together</wrap> with the "pipe" symbol (''|''), like ''value="S{p+1.50|w-1|c:01a|y:teeny_category}"''. When using [[advanced:hmac_validation|cart validation]] it is recommended to set your initial values high then modify //down//, rather than the other way around. See the [[advanced:hmac_validation|validation docs]] for explanation. Note: if you're working with a product code modifier, be sure your code input comes before your product option that modifies it. |
| ; ''p'' | ; ''p'' |
| : **Modifies:** Price | : **Modifies:** Price |
| : **Setting:** ''&category=foo&size=Small{y:bar}'' would yield a ''category'' of ''bar'' | : **Setting:** ''&category=foo&size=Small{y:bar}'' would yield a ''category'' of ''bar'' |
| : **Notes:** This can be especially handy in donation forms that allow both single and recurring donations. | : **Notes:** This can be especially handy in donation forms that allow both single and recurring donations. |
| |
| |
| |
| Transaction Options are not product-specific. Instead, they impact the entire cart or session. | Transaction Options are not product-specific. Instead, they impact the entire cart or session. |
| ; ''cart'' | ; ''cart'' |
| : **Description:** The ''cart'' parameter allows for various behaviors to be performed when the cart is requested. | : **Description:** The ''cart'' parameter allows for various behaviors to be performed when the cart is requested. Note, these parameters are added after the cart page, like so: /cart?cart=view |
| : **Accepts:** | : **Accepts:** |
| * ''add'': The default cart action. If you don't include a cart input, ''add'' is assumed. | * ''add'': The default cart action. If you don't include a cart input, ''add'' is assumed. |
| ; ''fc_auth_token'' | ; ''fc_auth_token'' |
| : **Description:** Used with [[.:advanced:sso|Single Sign-On (SSO)]] to allow a customer to proceed through to the checkout. | : **Description:** Used with [[.:advanced:sso|Single Sign-On (SSO)]] to allow a customer to proceed through to the checkout. |
| |
| ===== Customer Information Pre-Population ===== | ===== Customer Information Pre-Population ===== |
| If you're considering [[.:checkout#pre-populating_the_checkout_with_customer_information|pre-populating customer info on the checkout]] you should probably look at using [[.:advanced:api|the API]] and [[.:advanced:sso|Single Sign-On (SSO)]] as well, as those two methods will provide more power and flexibility. All of the following values are //optional//, and can be passed in individually. | If you're considering [[.:checkout#pre-populating_the_checkout_with_customer_information|pre-populating customer info on the checkout]] you should probably look at using [[.:advanced:api|the API]] and [[.:advanced:sso|Single Sign-On (SSO)]] as well, as those two methods will provide more power and flexibility. All of the following values are //optional//, and can be passed in individually. |
