{"sections":[],"html":""},{"_uid":"4e5e445b-0ed5-49e8-ba59-16bd46f7ab18","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"price","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" The cost of the product.","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Number (integer or decimal).","type":"text"},{"type":"hard_break"},{"text":"Example:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"&price=9.99","type":"text","marks":[{"type":"code"}]},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"Required.","type":"text","marks":[{"type":"textStyle","attrs":{"color":"inherit"}}]},{"type":"hard_break"},{"text":"Multi-currency:","type":"text","marks":[{"type":"bold"}]},{"text":" Optionally accepts a 3-character ISO currency code appended to the numeric portion. ","type":"text"},{"text":"More details here.","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.foxycart.com/v/2.0/multicurrency","uuid":null,"anchor":null,"target":null,"linktype":"url"}}]}]}]},"_editable":""},{"_uid":"ee749147-c26a-4fdb-b849-f94ab4707dfa","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"image","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" An image for the product, displayed in the cart.","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" A full URI to an image, starting with ","type":"text"},{"text":"http: or https:","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"or","type":"text","marks":[{"type":"italic"}]},{"text":" a relative path to the image from the store's domain (as configured in the store settings). ","type":"text"},{"text":"Limited to 500 characters in length.","type":"text","marks":[{"type":"italic"},{"type":"underline"}]},{"type":"hard_break"},{"text":"Examples:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"&image=http://example.com/path/to/image.jpg","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"&image=local/path/to/image.png","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" Images will ","type":"text"},{"text":"not","type":"text","marks":[{"type":"italic"}]},{"text":" be resized, but they will automatically be securely cached, so you don't need to worry about security warnings.","type":"text"}]}]},"_editable":""},{"_uid":"2e8e90cb-303b-47e5-898b-44595bf7d774","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"url","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" A URL for the product, displayed in the cart.","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" A full URL to the product page, starting with ","type":"text"},{"text":"http: or https:","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"or","type":"text","marks":[{"type":"italic"}]},{"text":" a relative path to the produt from the store's domain (as configured in the store settings). ","type":"text"},{"text":"Limited to 200 characters in length.","type":"text","marks":[{"type":"italic"},{"type":"underline"}]},{"type":"hard_break"},{"text":"Example:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"&url=http://example.com/path/to/product","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"&url=local/path/to/product","type":"text","marks":[{"type":"code"}]},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" The URL will only be applied if the ","type":"text"},{"text":"image","type":"text","marks":[{"type":"code"}]},{"text":" parameter is also present, and will be wrapped around the image in the cart.","type":"text"}]}]},"_editable":""},{"_uid":"107262ed-b77f-44db-b0fe-4feb3adc9474","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"code","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Item code. Can be used however you’d like (internal use, product SKU, etc.).","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Any characters. ","type":"text"},{"text":"Limited to 200 characters in length.","type":"text","marks":[{"type":"italic"},{"type":"underline"}]},{"type":"hard_break"},{"text":"Example:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"&code=ISBN 978-0-12-345678-9","type":"text","marks":[{"type":"code"}]},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"Required ","type":"text","marks":[{"type":"textStyle","attrs":{"color":"inherit"}}]},{"text":"if","type":"text","marks":[{"type":"italic"},{"type":"textStyle","attrs":{"color":"inherit"}}]},{"text":" using ","type":"text","marks":[{"type":"textStyle","attrs":{"color":"inherit"}}]},{"text":"Link and Form Validation","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.foxycart.com/v/2.0/hmac_validation","uuid":null,"anchor":null,"target":null,"linktype":"url"}},{"type":"textStyle","attrs":{"color":"inherit"}}]},{"text":".","type":"text","marks":[{"type":"textStyle","attrs":{"color":"inherit"}}]},{"text":" Not required otherwise.","type":"text"}]}]},"_editable":""},{"_uid":"dfbe5448-cefe-40a4-900d-64bd35f70e39","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"parent_code","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Parent item code. Used if this should be a child product in a bundle.","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Any characters. ","type":"text"},{"text":"Limited to 200 characters in length.","type":"text","marks":[{"type":"italic"},{"type":"underline"}]},{"type":"hard_break"},{"text":"Example:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"&parent_code=bundle7734","type":"text","marks":[{"type":"code"}]},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" There are some ","type":"text"},{"text":"special requirements","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.foxycart.com/v/2.0/hmac_validation#bundled_products","uuid":null,"anchor":null,"target":null,"linktype":"url"}}]},{"text":" for this field if using ","type":"text"},{"text":"Link and Form Validation","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.foxycart.com/v/2.0/hmac_validation","uuid":null,"anchor":null,"target":null,"linktype":"url"}}]},{"text":". If you set quantity_min=1, the child product will be locked to the parent product and won't be able to be deleted by itself or have it's quantity changed independently.","type":"text"}]}]},"_editable":""},{"_uid":"ae287026-3fe5-4fd0-bd1d-5c9559f93ce7","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"quantity","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Quantity of products. If left blank, it will default to 1.","type":"text"},{"type":"hard_break"},{"text":"Default:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Integer. Decimals are not supported.","type":"text"},{"type":"hard_break"},{"text":"Example:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"&quantity=3","type":"text","marks":[{"type":"code"}]},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" In forms it often makes sense to make the ","type":"text"},{"text":"quantity","type":"text","marks":[{"type":"code"}]},{"text":" input be an ","type":"text"},{"text":"input[type=text]","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"select","type":"text","marks":[{"type":"code"}]},{"text":" element to allow the customer to enter or choose their desired quantity.","type":"text"}]}]},"_editable":""},{"_uid":"cee0be2f-1853-4473-86aa-46f52e4eb07e","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"quantity_max","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Maximum quantity that should be allowed ","type":"text"},{"text":"per product, per cart","type":"text","marks":[{"type":"italic"}]},{"text":".","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Integer.","type":"text"},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" This attribute, like all others, relies on the products in the cart being ","type":"text"},{"text":"identical","type":"text","marks":[{"type":"italic"}]},{"text":". If another product is entered with any variation, it is considered a new product. ie. ","type":"text"},{"text":"quantity_max","type":"text","marks":[{"type":"code"}]},{"text":" cannot apply to groupings of multiple products. Also, this value ","type":"text"},{"text":"does not","type":"text","marks":[{"type":"italic"}]},{"text":" control inventory. The values are per cart/transaction/session.","type":"text"}]}]},"_editable":""},{"_uid":"d048c54b-6c2e-4193-b901-a7e5945f6416","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"quantity_min","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Minimum quantity that should be allowed ","type":"text"},{"text":"per product, per cart","type":"text","marks":[{"type":"italic"}]},{"text":".","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Integer.","type":"text"},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" This attribute, like all others, relies on the products in the cart being ","type":"text"},{"text":"identical","type":"text","marks":[{"type":"italic"}]},{"text":". If another product is entered with any variation, it is considered a new product. ie. ","type":"text"},{"text":"quantity_min","type":"text","marks":[{"type":"code"}]},{"text":" cannot apply to groupings of multiple products. Also, this value ","type":"text"},{"text":"does not","type":"text","marks":[{"type":"italic"}]},{"text":" control inventory. The values are per cart/transaction/session.","type":"text"}]}]},"_editable":""},{"_uid":"ef656342-928c-4608-8211-bb18058ff8e3","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"category","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Category identifier for the product.","type":"text"},{"type":"hard_break"},{"text":"Default:","type":"text","marks":[{"type":"bold"}]},{"text":" This will default to the default category if left blank.","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Any valid category code, as configured in the store's admin. Will error on an invalid code.","type":"text"}]}]},"_editable":""},{"_uid":"ef5cc8c2-9ce3-4525-9de5-d35f204d7305","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"expires","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Allows you to sell products which are only available for purchase before a certain date or for a limited time. You can pass in a number of minutes or a timestamp in the future at which point the product will be removed from the cart. An informational message will be displayed when the order contains a product which will expire within 15 minutes.","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" number, either in minutes or a timestamp based on FoxyCart server time (currently PST)","type":"text"},{"type":"hard_break"},{"text":"Example:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"&expires=15","type":"text","marks":[{"type":"code"}]},{"text":" (expires in 15 minutes) or ","type":"text"},{"text":"&expires=1593583199","type":"text","marks":[{"type":"code"}]},{"text":" (expires a second before midnight, June 30th 2020).","type":"text"},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" This parameter can be used when setting up subscriptions, but ","type":"text"},{"text":"is stripped from products","type":"text","marks":[{"type":"italic"}]},{"text":" when they are part of a subscription. In other words, once a product with an ","type":"text"},{"text":"expires","type":"text","marks":[{"type":"code"}]},{"text":" value is successfully paid for as part of a subscription, it will persist on that subscription indefinitely. You can find many tools online for creating timestamps which may be helpful here. If the checkout is submitted with an expired product, the customer will be shown an error and told that an expired product has been removed from the cart. After adding, an ","type":"text"},{"text":"expires","type":"text","marks":[{"type":"code"}]},{"text":" parameter is set against the product details in the cart JSON object representing the time that it will expire as an epoch timestamp (in seconds). Currently, using an expires value representing time in minutes will cause the same product to be treated as a unique in the cart. Specifying as a timestamp will keep them unified.","type":"text"}]}]},"_editable":""},{"_uid":"00cd038b-a738-47ba-b5cc-c75203bfb19a","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"shipto","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Allows you to specify specific ship-to address labels for each cart add.","type":"text"},{"type":"hard_break"},{"text":"Default:","type":"text","marks":[{"type":"bold"}]},{"text":" “me” (meaning, it defaults to the billing contact, and not a separate recipient).","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Any string. Products will be grouped by ","type":"text"},{"text":"shipto","type":"text","marks":[{"type":"code"}]},{"text":" value on checkout and in the cart display (if multi-ship is enabled).","type":"text"},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"Requires multiship to be enabled","type":"text","marks":[{"type":"textStyle","attrs":{"color":"inherit"}}]},{"text":" for the store.","type":"text"}]}]},"_editable":""},{"_uid":"435136e7-1baa-47f4-ab9b-d4b12bf36918","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" A unique ID per product in the cart, used to make “update” requests to existing products in the cart (as in a ","type":"text"},{"text":"JSONP request","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.foxycart.com/v/2.0/json","uuid":null,"anchor":null,"target":null,"linktype":"url"}}]},{"text":").","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Any valid ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" for a product ","type":"text"},{"text":"already in the cart","type":"text","marks":[{"type":"italic"}]},{"text":".","type":"text"},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" This value is set ","type":"text"},{"text":"by FoxyCart","type":"text","marks":[{"type":"italic"}]},{"text":", and may be different in different situations. You cannot rely on any product in the cart having the same ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" from one session to another.","type":"text"}]}]},"_editable":""},{"_uid":"ec83c05c-258c-4493-88d6-c0d882186784","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"1:","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"2:","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"3:","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"4:","type":"text","marks":[{"type":"code"}]},{"text":", etc…","type":"text"}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" Prefixing any product option with an integer will group that option with other similarly numbered options, allowing you to add multiple distinct products to the cart in one request.","type":"text"}]},{"type":"paragraph","content":[{"text":"Default:","type":"text","marks":[{"type":"bold"}]},{"text":" If no grouping prefix is added, the option will be assumed to be a ","type":"text"},{"text":"1:","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Integers from 1-999.","type":"text"}]},{"type":"paragraph","content":[{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"All product options must be prefixed","type":"text","marks":[{"type":"textStyle","attrs":{"color":"inherit"}}]},{"text":" in order for grouping to happen, and all required options are still required ","type":"text"},{"text":"per product","type":"text","marks":[{"type":"italic"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"bold"}]}]},{"type":"code_block","attrs":{"class":"code html4strict"},"content":[{"text":"","type":"text"}]}]},"_editable":""},{"_uid":"df8dda45-e0ad-4376-9ffa-44309fb4b1fa","name":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"CUSTOM Product Options","type":"text","marks":[{"type":"bold"},{"type":"textStyle","attrs":{"color":""}}]}]}]},"component":"parameter___item","description":{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"bold"}]},{"text":" ","type":"text"},{"text":"You may add any additional attributes to any product you’d like.","type":"text","marks":[{"type":"textStyle","attrs":{"color":"inherit"}}]},{"text":" For example, you can add ","type":"text"},{"text":"&color=green&size=XXL","type":"text","marks":[{"type":"code"}]},{"text":". If an attribute is passed in with a name not otherwise reserved, it will be added as a product option.","type":"text"},{"type":"hard_break"},{"text":"Accepts:","type":"text","marks":[{"type":"bold"}]},{"text":" Any characters. Custom name attribute limited to 100 characters and the value is limited to 1024 characters.","type":"text"},{"type":"hard_break"},{"text":"Notes:","type":"text","marks":[{"type":"bold"}]},{"text":" A single product can have a maximum of 100 custom product options","type":"text"}]}]},"_editable":""}],"component":"help_center_parameter","_editable":""},"slug":"product-parameters","full_slug":"help/parameters/product-parameters","sort_by_date":null,"position":-10,"tag_list":[],"is_startpage":false,"parent_id":5328381,"meta_data":null,"group_id":"a91be7ca-f28b-4a37-b23e-afc67ff7d2e0","first_published_at":"2024-04-05T20:33:39.892Z","release_id":null,"lang":"default","path":null,"alternates":[],"default_full_slug":null,"translated_slugs":null,"_stopResolving":true},"items":[],"component":"help___parameters","_editable":""}\" data-blok-id=\"8fa1409b-74ab-4205-b1cb-50b20927b499\" style=\"display: none\">"}

Need Help?

Standard Parameters

Need Help?