API Playground - add_additional_product

add_additional_product


Use this function to add a new additional product to your Planyo site. (click for full documentation)

name

Name of the new product

site_id

ID of the site to which the product should be added (use only for metasite API keys

price

Product price (0 if free)

max_quantity

Max. quantity of the product (either absolutely or for each person -- depending on the value of is_per_person)

description

Product description

is_per_person

Set to true or person if the product should be reservable for each person, adult if it's reserved for each adult in the party, child if for each child in the party, or false (or skip the parameter) if the product is reserved for the entire party (per reservation)

is_recurring

Set to true if this is a daily recurring product

is_reserved_by_customer

Set to true if the product should be reservable by the customer in the second step of the reservation form. Set to false if the customer cannot decide whether the product is added to their reservation or not

is_default

Set to true if the product should be selected by default

priority

Priority group (0-20). Products are grouped by priority group and then sorted by name. Priority groups can have labels.

currency

3-letter (ISO 4217) currency code e.g. EUR, USD, CHF, GBP etc. If not specified, the currency of the site will be used.

tax_rate

Tax rate (in percent)

extra_field

Label for the UI option 'Ask customer for extra information regarding this item'. Skip this parameter if you don't want to ask the customer for extra info regarding the product

custom

A custom value assigned to this product. E.g. your organization product number, or tax id.

compatible_resource_ids

This optional argument lets you specify a comma-separated resource IDs the product is compatible with. By default (if not specified), the product will be compatible with all resources.

language

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key

your API key - Click here to get your key
* - påkrevd felt