HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceCustomer Help CenterLog In

Introduction

Experiences also known as "Listings" are the experiences and activities that the seller's business offers. The experiences end point is where you create & update experience, and it is where you update logistical information like trip schedules, pricing, and trip logistics like duration, capacity, and location.

AttributeTypeDefinition
addOnsarrayList of add-ons that are available for this experience. See add-ons.
arrivalOffsetintegerIndicates how many minutes prior to the event start travelers should arrive.
cancellationPolicystringConditions for booking cancellation.
categorystringCategory of this experience. See categories.
currencystringThree-letter ISO currency code in uppercase.
cutoffintegerNumber of minutes before the event start that a new order may be placed. Orders placed after the cutoff will be rejected.
demographicsarrayList of demographics that are available for this experience. See demographics.
descstringDetailed description of the experience.
durationintegerDuration of the experience in minutes.
earlyReturnbooleanIndicates whether releasing inventory due to early temination of trip is allowed.
excerptstringShort description of the experience. This is shown on the Xola checkout widget.
geoobjectObject containing lat and lng coordinates of where the experience will take place.
group.maxintegerMaximum quantity of guests per order.
group.minintegerMinimum quantity of guests per order.
group.outingMaxintegerMaximum quantity of guests per event.
group.outingMinintegerMinimum quantity of guests per event.
group.outinMinCutoffintegerIf the group.outingMin quantity has not been met for an event within this many minutes from event start, a warning message is sent to the seller.
includedstring[]List of things that are included as part of the experience.
mediasarrayList of media assets that help describe the experience. See medias.
namestringTitle of the experience.
notIncludedstring[]List of things that you should bring to get the most out of the experience.
otherstringA catch-all blurb for any other information guests should be aware of for the experience.
paymentMethodstringPayment method that is accepted during self checkout. Values may be cc or later. This attribute is not applicable for back office orders.
photoobjectA media object that is used for the experience's thumbnail photo.
pickupAddressstringAddress to which guests should arrive.
pickupGeoobjectObject containing lat and lng coordinates of the pickupAddress.
pricefloatBase price of the experience.
priceTypestringWhether the experience is priced per person or per outing. Values may be person or outing.
privatebooleanIf true, only one order is allowed per event (makes "per person" order behave like a "per outing" order from an availability perspective)
resourcesarrayList of inventory resources assigned to the experience. See resources.
schedulesarrayList of schedules configured for the experience. See schedules.
seller.idstringSeller who owns the experience.
updateddatetimeTimestamp at which the experience was last modified.
visiblebooleanDeprecated. Determines if the experience will be shown in the online checkout. Only applicable if old buttons are used.
waiverPreferenceobjectDigital waiver configuration for the experience. See waiver.
{
  "id": "567176edcf8b9c1d288b45b3",
  "object": "experience",
  "addOns": [
    {
      "id": "58c21a71332e756f2e8b4588",
      "desc": "A Go-Pro camera to record your trip.",
      "name": "Go-Pro",
      "price": 50,
      "visibility": "public"
    }
  ],
  "arrivalOffset": 15,
  "cancellationPolicy": "All sales are final unless cancellation protection is purchased.",
  "category": "Escape Room",
  "complete": true,
  "currency": "USD",
  "cutoff": 120,
  "demographics": [
    {
      "id": "57ccbeab6864eaa2768b459c",
      "object": "experience_demographic",
      "all": false,
      "caption": "18 and up",
      "code": "adults",
      "createdAt": "2017-07-29T09:06:40+00:00",
      "experience": {
        "id": "567176edcf8b9c1d288b45b3"
      },
      "label": "Adults",
      "labelCanonical": "adults",
      "name": "Adults",
      "overrideCaption": false,
      "parent": {
        "id": "597c4ff5c8f7b07d81544c67"
      },
      "seller": {
        "id": "55c2b026ad2171f0438b45e7"
      },
      "updatedAt": "2017-08-04T20:28:06+00:00",
      "updatedBy": {
        "id": "55c2b026ad2171f0438b45e7"
      }
    },
    {
      "id": "57ccbebae017981f6b8b463a",
      "object": "experience_demographic",
      "all": false,
      "caption": "12-17 (Minors must be accompanied by adults)",
      "code": "minors",
      "createdAt": "2017-07-29T09:06:40+00:00",
      "experience": {
        "id": "567176edcf8b9c1d288b45b3"
      },
      "label": "Minors",
      "labelCanonical": "minors",
      "name": "Minors",
      "overrideCaption": false,
      "parent": {
        "id": "597c4ff5c8f7b07d81544c68"
      },
      "seller": {
        "id": "55c2b026ad2171f0438b45e7"
      },
      "updatedAt": "2017-08-04T20:28:09+00:00",
      "updatedBy": {
        "id": "55c2b026ad2171f0438b45e7"
      }
    }
  ],
  "desc": "The hardest part of being an antiquities thief is finding a discreet buyer with deep pockets...",
  "duration": 75,
  "earlyReturn": false,
  "excerpt": "This room has a 4 person minimum.",
  "geo": {
    "lat": 29.742664339342,
    "lng": -95.403785705676
  },
  "group": {
    "max": 12,
    "min": 1,
    "outingMax": 12,
    "outingMin": 4,
    "outingMinCutoff": 3600
  },
  "included": ["Snacks", "Photo booth"],
  "medias": [
    {
      "id": "567176f985523e0a3f8b4592",
      "caption": null,
      "seq": 0,
      "size": null,
      "src": "http://xola.com/api/experiences/567176edcf8b9c1d288b45b3/medias/567176f985523e0a3f8b4592?size=medium",
      "title": null,
      "type": "photo"
    }
  ],
  "name": "The Heist",
  "notIncluded": ["Tips"],
  "other": "PARKING:\nWe’re in a very walkable neighborhood, and while we don’t have our own parking lot, there is plenty of free street parking.",
  "paymentMethod": "cc",
  "photo": {
    "caption": null,
    "id": "567176f985523e0a3f8b4592",
    "seq": null,
    "size": null,
    "src": "/uploads/images/experiences/567176edcf8b9c1d288b45b3/567176f985523e0a3f8b4592.png",
    "title": null,
    "type": "photo"
  },
  "pickupAddress": "1735 Westheimer Rd.\nHouston, TX 77098\n",
  "pickupGeo": {
    "lat": 29.742665426163,
    "lng": -95.403783917318
  },
  "price": 29,
  "priceType": "person",
  "private": false,
  "resources": [
    {
      "id": "567177379267057f368b45f9",
      "priority": null,
      "resource": {
        "id": "567177379267057f368b45f9",
        "capacity": 12,
        "count": 1,
        "name": "The Heist",
        "seller": "55c2b026ad2171f0438b45e7",
        "type": "equipment"
      }
    }
  ],
  "schedules": [
    {
      "id": "5a1ca038e017986c628b45a7",
      "days": [0, 1, 2, 3, 4, 5, 6],
      "departure": "fixed",
      "priceDelta": 0,
      "repeat": "weekly",
      "times": [1310, 1440, 1610, 1740],
      "type": "available"
    }
  ],
  "seller": {
    "id": "55c2b026ad2171f0438b45e7"
  },
  "updated": "2017-11-27T23:31:27+00:00",
  "visible": true,
  "waiverPreference": {
    "remoteID": "example",
    "url": "https://www.smartwaiver.com/v/example/"
  }
}