HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceCustomer Help CenterLog In
API Reference

Introduction

Orders represent bookings that are made on a seller's account. The API end points available for orders allow you to create, update, and cancel bookings for individual experiences, individual packages, or a combination of one or more of both.

Beginning in version 2017-09-28, an order is no longer limited to just one experience, but rather capable of containing multiple items -- each item representing a single experience.

Order Source

The source of an order determines how Xola will treat the order.

  • office: Use this when creating an order with authorized credentials. Xola will treat the order as though it came from the backoffice. When authenticated, immediate payment is optional and several experience restrictions may be bypassed.
  • checkout: Use this when creating an order anonymously. Xola will treat the order as though it came from the consumer checkout. When anonymous, payment is mandated unless the experience configuration explicitly allows for non-payment.

Order Statuses

Every order has an integer status atttribute which describes the state of the booking. The general principle with statuses are:

  • Status < 200 indicates a reserved but unconfirmed booking
  • Status >= 200 & < 300 indicates a reserved and confirmed booking
  • Status >= 300 indicates an unreserved booking
CodeDescription
100A pending booking. The traveler's card has not been charged yet, and the booking will not be counted as a part of trip till it is accepted.
101A booking in a pending state due to a minimum configured on the listing. Once the trip meets the minimum, the status of this order will automatically change to 200.
103An order in a hold status.
200A confirmed/accepted booking
201A confirmed booking for which only a deposit has been collected (deprecated)
202An confirmed booking which has not been charged
203An accepted booking, but with the "Pay Later" payment method
700Booking has been canceled.