Create an Experience

post

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

Create and configure a new bookable experience.

To perform this action, you must be the account owner, or be assigned the ROLE_CURATOR or ROLE_SELLER_ADMIN role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

seller

object

required

Seller that owns this experience.

category

string

Category for this experience.

priceSchemes

array of objects

required

List of possible prices for this experience.

priceSchemes*

name

string

required

Title of this experience.

excerpt

string

required

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

desc

string

required

Extended description of this experience.

duration

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*

eventDuration

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

paymentMethod

string

Defaults to cc

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

earlyReturn

boolean

Defaults to false

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

emailFooter

string

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

visible

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.

priceType

string

Defaults to person

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

pickupAddress

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.

cutoff

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.

alternateCutoff

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.

arrivalOffset

int32

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

private

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

cancellationPolicy

string

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

other

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.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!