Jump to Content

Guides API Reference Customer Help Center

Home Guides Recipes API Reference Changelog

Guides API Reference Customer Help Center Log In

API Reference

The Xola API

Quick Start
Payment Methods
Booking Sources
Metadata
Query Language

Experiences

Introduction
List categoriesget
Create an Experiencepost
Retrieve an experienceget
Update an Experiencepost
Remove an experiencedel
List experiencesget
Add-Ons
Attachments
Media
Review Preferences
Schedules
Terms & Conditions

Packages

Introduction
Create a packagepost
Retrieve a packageget
Update a packageput
Delete a packagedel
List all packagesget
Media

Forms

Introduction
Create a formpost
Retrieve a formget
Update a formput
List all formsget
Delete a formdel
Retrieve the form for an orderget

Demographics

Introduction
Create a seller demographicpost
Create an experience demographicpost
Retrieve a demographicget
Update a seller demographicput
Update an experience demographicput
Delete a seller demographicdel
Delete an experience demographicdel
List all demographicsget

Resources (Inventory)

Introduction
Create a resourcepost
Retrieve a resourceget
Assign a resource to an experiencepost
Un-assign a resource from an experiencedel
Update a resourceput
Delete a resourcedel

Availability

Introduction
Experience availabilityget
Batch availbilityget

Buttons

Introduction
Create a buttonpost
Retrieve a buttonget
Update a buttonput
Archive a buttondel
List all buttonsget

Coupons

Introduction
Create a couponpost
Retrieve a couponget
Update a couponput
Delete a coupondel
List all couponsget
Coupon Codes

Affiliates

Introduction
Create an affiliatepost
Retrieve an affiliateget
Update an affiliateput
Remove an affiliatedel
List all affiliatesget
Pay an affiliatepost
Collect payment from an affiliatepost

Orders (Bookings)

Introduction
Prepare an orderpost
Create a new Orderpost
Retrieve an orderget
List all ordersget
Adjustments
Guest Data
Tags
- Add a tagpost
- Remove a tagdel

Gifts

Introduction
Create a Giftpost
Retrieve a Giftget
List all Giftsget
Decrease Balancepost
Increase Balancepost
Add Fundspost
Refund Paymentpost

Transactions

Introduction
Retrieve a Transansactionget
List Transactionsget

Guides

Create a guidepost
Retrieve a guideget
Update a guideput
Delete a guidedel
List all guidesget

Events

Introduction
Create an eventpost
Retrieve an eventget
Update an eventput
List all eventsget
Guides
- Assign a guide to an eventpost
- Remove a guide from an eventdel
Notes
- Create an event notepost
- Update an event noteput

Users

Introduction
Credit Cards
Preferences

Account Settings

Blackout Schedules
Payment Methods
Review Preferences
Terms & Conditions

Languages

Introduction
List supported languagespost

Webhooks

Introduction
List Webhooksget
Retrieve a Webhookget
Subscribe to a webhookpost
Unsubscribe from a webhookdel

Xola App Store

Plugins
Installations
- Retrieve an Installationget

Powered by

Coupons

List all coupons

get

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

Returns a list of your coupons

Query Params

seller

string

Seller that owns the coupon.

experience

string

Experience for which the coupon is going to be applied. Required if not authenticated.

code

string

Coupon code to search by. Required if not authenticated.

source

string

Defaults to xola

Coupon source. Possible values are xola or gift.

arrival

date

Coupon restrictions must allow this arrival date.

arrivalTime

int32

Coupon restrictions must allow this arrival time.

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