GuidesAPI ReferenceCustomer Help Center
HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceCustomer Help CenterLog In
API Reference
  1. Experiences

Create an Experience

post
https://sandbox.xola.com/api/experiences

Creates a new experience.

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

Body Params
seller
object
required

Seller ID that owns this experience.

string

Category for this experience.

string
required

Title of this experience.

string
required

Short caption describing this experience. Should be no more than a couple sentences.

string
required

Extended description of this experience.

float
required

Base price for this experience. This maybe be per person or per outing depending on the priceType.

string
Defaults to person

Whether the price for this experience is per person or per outing.

int32
required

Duration (in minuted) for which inventory is blocked. This is not shown to consumers.

demographics
array of objects
required

List of seller demographics to associate with this experience. Any seller demographics that are marked as all will automatically be associated.

demographics*
int32

Duration (in minutes) as shown to consumers. This does not have an effect on inventory, unlike duration.

schedules
array of objects

List of schedules that determine the availability of this experience.

schedules
included
array of strings

List of things that are included as part of the experience.

included
notInluded
array of strings

List of things that you should bring with you for the experience.

notInluded
string
Defaults to cc

Payment method during consumer checkout. Can be cc (credit card required) or later (no payment required).

boolean
Defaults to false

Whether releasing inventory due to early termination of event is permitted.

string

HTML markup of footer in automated emails. This will override the account level emailFooter.

boolean
Defaults to true

(deprecated) Whether this experience appears in consumer checkout. This is deprecated in favor of buttons.

geo
object

Geographical coordinates indicating the location of this experience. An map with this location will be included in automated emails.

string

Address where travelers will be picked up. Use questionnaires if you have multiple pickup locations.

pickupGeo
object

Geographical coordinates of the pickup address.

downDeposit
object

Rules for calculating partial deposit payment amount.

int32

Prevents orders being placed too close to the arrival time. For example, specify 1440 (minutes) to prevent orders being placed less than a day prior to arrival. This setting is only applicable for consumer checkout and is ignored for backoffice orders.

int32

Overrides the cutoff if at least one confirmed order is present for the arrival time.

futureCutoff
object

Prevents orders being placed too far in advance.

int32

How far in advance (in minutes) of the scheduled time should consumers arrive.

boolean
Defaults to false

Whether only one order is allowed per arrival time slot.

group
object
addOns
array of objects

Additional items that can be sold with this experience.

addOns
string

Cancellation policy for this experience. This text is included in automated emails.

string

Other considerations for this experience. This text is included in automated emails.

terms
object

Terms and conditions for this experience.

reviewPreference
object

Preferences for review reminder emails sent to consumers.

Updated less than a minute ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here!
Updated less than a minute ago