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

These docs are for v2017-01-01. Click to read the latest docs for v2021-03-10.

The Xola API

Quick Start
Terminology
Payment Methods
Booking Sources
Metadata

Experiences (Listings)

Introduction
List categoriesget
List all experiencesget
Retrieve an experienceget
Update an experienceput
Remove an experiencedelete
Medias
Attachments
Add-Ons
Demographics
Resources
- Assign an inventory item to an experiencepost
- Un-assign inventory item from the experiencedelete
Review Preferences
Schedules
Terms & Conditions

Availability

Introduction
Experience availabilityget
Batch availbilityget
Event capacityget

Buttons

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

Coupons

Introduction
List all couponsget
Retrieve a couponget
Create a couponpost
Delete a coupondelete
Codes

Drafts

Introduction
List all draftsget

Events (Trips)

Introduction
List all eventsget
Retrieve an eventget
Create an eventpost
Update an eventput
Guides
Notes
- Add a trip notepost
- Update a trip noteput

Demographics

Introduction
List all Demographicsget
Create a new Global Demographicpost
Update a demographicget
Remove a demographicget

Gifts

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

Jobs

Introduction
List all Jobsget

Languages

Introduction
List supported languagespost

Orders (Bookings)

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

Purchases

Introduction
List all purchasesget
Retrieve a Purchaseget

Transactions

Introduction
List Transactionsget
Retrieve a Transansactionget

Users

Introduction
Affiliates
Blackout Schedules
Payment Methods
Preferences
Review Preferences
Terms & Conditions

Webhooks

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

Powered by

The Xola API

Quick Start
Terminology
Payment Methods
Booking Sources
Metadata

Experiences (Listings)

Introduction
List categoriesget
List all experiencesget
Retrieve an experienceget
Update an experienceput
Remove an experiencedelete
Medias
Attachments
Add-Ons
Demographics
Resources
- Assign an inventory item to an experiencepost
- Un-assign inventory item from the experiencedelete
Review Preferences
Schedules
Terms & Conditions

Availability

Introduction
Experience availabilityget
Batch availbilityget
Event capacityget

Buttons

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

Coupons

Introduction
List all couponsget
Retrieve a couponget
Create a couponpost
Delete a coupondelete
Codes

Drafts

Introduction
List all draftsget

Events (Trips)

Introduction
List all eventsget
Retrieve an eventget
Create an eventpost
Update an eventput
Guides
Notes
- Add a trip notepost
- Update a trip noteput

Demographics

Introduction
List all Demographicsget
Create a new Global Demographicpost
Update a demographicget
Remove a demographicget

Gifts

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

Jobs

Introduction
List all Jobsget

Languages

Introduction
List supported languagespost

Orders (Bookings)

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

Purchases

Introduction
List all purchasesget
Retrieve a Purchaseget

Transactions

Introduction
List Transactionsget
Retrieve a Transansactionget

Users

Introduction
Affiliates
Blackout Schedules
Payment Methods
Preferences
Review Preferences
Terms & Conditions

Webhooks

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

Powered by

Introduction

A purchase in Xola represents either a booking (order) or a gift.