Differences

This shows you the differences between two versions of the page.

--- v:0.7.1:cheat_sheet [2011/05/26 09:15] – external edit 127.0.0.1
+++ v:0.7.1:cheat_sheet [2017/06/27 18:52] (current) – [Subscription Product Options] marija
@@ Line 18: / Line 18: @@
   : **Description:** An image for the product, displayed in the cart.
   : **Accepts:** A full URI to an image, starting with ''http://'' or ''https://'', //or// a relative path to the image from the store's domain (as configured in the store settings).
-  : **Example:** ''&image=http://example.com/path/to/image.jpg'', ''&images=local/path/to/image.png''
+  : **Example:** ''&image=http://example.com/path/to/image.jpg'', ''&image=local/path/to/image.png''
   : **Notes:** Images will //not// be resized, but they will automatically be securely cached, so you don't need to worry about security warnings.
+  ; ''url''
+  : **Description:** A URL for the product, displayed in the cart.
+  : **Accepts:** A full URL to the product page, starting with ''http://'' or ''https://'', //or// a relative path to the produt from the store's domain (as configured in the store settings).
+  : **Example:** ''&url=http://example.com/path/to/product'', ''&url=local/path/to/product''
+  : **Notes:** The URL will only be applied if the ''image'' parameter is also present, and will be wrapped around the image in the cart.
   ; ''code''
   : **Description:** Item code. Can be used however you’d like (internal use, product SKU, etc.).
@@ Line 46: / Line 51: @@
   : **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.
+  : **Notes:**  <wrap round important>Supports up to a maximum of three decimal places.</wrap>
   ; ''shipto''
   : **Description:** Allows you to specify specific ship-to address labels for each cart add.
@@ Line 71: / Line 77: @@
   ; 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.
 ==== 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.
@@ Line 145: / Line 152: @@
   ; ''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.).
-  : **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.
     * ''YYYYMMDD'' = Example: ''20070131'' = January, 31 2007.
     * ''DD'' = Example: ''10'' = will run on the 10th of this month or the 10th of next month if today's date is after the 10th.
     * ''D'' = Same as ''DD''.
-  : **Notes:** Subscription start and end dates are not currently tied to a store's timezone settings. Test your start and end dates thoroughly or ask in the forum if you have questions about them.
+  : **Notes:**
+    * Subscription start and end dates are not currently tied to a store's timezone settings. Test your start and end dates thoroughly or ask in the forum if you have questions about them.
+    * The day of the ''sub_startdate'' will generally be used for all subsequent billing attempts when used with a monthly frequency, but in cases where the date doesn't exist in a month, it will be moved //ahead// for that month. So if you have a subscription with a start date on Jan-31, it will run on the Feb-28, Mar-31, Apr-30, and etc.
   ; ''sub_enddate''
   : **Description:** The date a subscription should //end//.
@@ Line 163: / Line 173: @@
   : **Accepts:** ''true''
   : **Notes:** <wrap round important>Requires a ''sub_token'' to function.</wrap> Otherwise there will not be any subscription to cancel.
 ==== 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''
   : **Modifies:** Price
@@ Line 182: / Line 191: @@
   : **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.
@@ Line 188: / Line 196: @@
 Transaction Options are not product-specific. Instead, they impact the entire cart or session.
   ; ''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:**
     * ''add'': The default cart action. If you don't include a cart input, ''add'' is assumed.
@@ Line 221: / Line 229: @@
   ; ''fc_auth_token''
   : **Description:** Used with [[.:advanced:sso|Single Sign-On (SSO)]] to allow a customer to proceed through to the checkout.
 ===== 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.

Differences

Page Tools

Site Tools

User Tools