HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceHelp CenterLog In

Introduction

Resources, also known as inventory are fixed resources that can be utilized across multiple experiences. When associated with experiences, Xola will automatically limit schedule availability for those experiences based on resource utilization.

📘

Paid Feature

You must have the inventory feature turned on for this API endpoint to work.

There are two concepts key in inventory items:

  • Capacity: The number of seats/spots in each piece of equipment. For example, if you have a 20-seater bus, this would refer to how many seats you have on the bus.
  • Count: The count refers to how many units of equipment you have. In our bus example, the capacity is 20 seats but if we only have 1 bus the count is 1.
{
  "id": "50be7451986ae56247000036",
  "capacity": 20,
  "count": 1,
  "name": "Bus",
  "seller": "4f104661536e86b23d000000",
  "type": "equipment"
}

Attribute

Type

Definition

capacity

integer

Number of seats available per unit of the resource.

count

integer

Number of units available of the resource (capacity multiplier).

name

string

Name of the resource.

seller

string

Seller who owns the resource.

type

string

Always equipment.