Create an add-on

post

https://sandbox.xola.com/api/experiences/{experienceId}/addOns

Create an add-on for a given experience.

To perform this action, you must be the account owner, or must be delegated with ROLE_CURATOR or ROLE_SELLER_ADMIN.

Path Params

experienceId

string

required

The Experience ID

Body Params

name

string

required

Title of the add-on.

price

float

Price per add-on. (required if object type is 'choice'.

desc

string

required

Short description of the add-on.

visibility

string

Defaults to public

One of public or hidden; the latter will only show the add-on in the back office

object

string

enum

required

Defaults to quantity

The type of addOn to create. Options include choices (a dropdown with multiple options), boolean (a checkbox) and quantity (a quantity widget). If choices is selected, an additional choices parameter must be supplied.

Allowed:

choices

array of objects

This is required if the object parameter is set to choices.

choices

isPickupLocation

boolean

Defaults to false

Indicate whether the AddOn is for specifying pickup locations. (Note this option is only available when using the choices object type.)

required

boolean

Defaults to false

Make the selection of this AddOn required. This is only supported for the quantity object type.

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

200200