Update an add-on

put

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

Updates the specified add-on. Any attributes not provided are left unchanged.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

experienceId

string

required

The Experience ID

addOnId

string

required

The Add-On ID

Body Params

name

string

Title of the add-on.

price

float

Price per add-on (when object type is quantity or boolean).

desc

string

Short description of the add-on.

visibility

string

Whether the add-on is visible to online checkout customers or if it is restricted to back office orders. Either public, or private.

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

Loading…

Response

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

text/plain

200200