ShowClix API

API Endpoint

Bundles ¶

POST /bundles

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "bundles",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "active": {
        "type": "boolean"
      },
      "flex": {
        "type": "boolean"
      },
      "flex_minimum": {
        "type": "integer"
      },
      "flex_maximum": {
        "type": "integer"
      },
      "flex_itemize": {
        "type": "boolean"
      },
      "flex_percent_discount": {
        "type": "integer"
      },
      "flex_flat_discount": {
        "type": "float"
      },
      "settings": {
        "multiple_holders": {
          "type": "boolean"
        },
        "online_hide": {
          "type": "boolean"
        },
        "box_office_hide": {
          "type": "boolean"
        },
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        }
      },
      "price_levels": {
        "type": "collection"
      },
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "bos_service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "relationships": {
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bundles",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "active": {
        "type": "boolean"
      },
      "flex": {
        "type": "boolean"
      },
      "flex_minimum": {
        "type": "integer"
      },
      "flex_maximum": {
        "type": "integer"
      },
      "flex_itemize": {
        "type": "boolean"
      },
      "flex_percent_discount": {
        "type": "integer"
      },
      "flex_flat_discount": {
        "type": "float"
      },
      "settings": {
        "multiple_holders": {
          "type": "boolean"
        },
        "online_hide": {
          "type": "boolean"
        },
        "box_office_hide": {
          "type": "boolean"
        },
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        }
      },
      "price_levels": {
        "type": "collection"
      },
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "bos_service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "relationships": {
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Create a new bundle
POST`/bundles`

Note: id should be omitted or null for this request

GET /bundles

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "type": "bundles",
      "id": {
        "type": "integer"
      },
      "attributes": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "inventory": {
          "type": "integer"
        },
        "active": {
          "type": "boolean"
        },
        "flex": {
          "type": "boolean"
        },
        "flex_minimum": {
          "type": "integer"
        },
        "flex_maximum": {
          "type": "integer"
        },
        "flex_itemize": {
          "type": "boolean"
        },
        "flex_percent_discount": {
          "type": "integer"
        },
        "flex_flat_discount": {
          "type": "float"
        },
        "settings": {
          "multiple_holders": {
            "type": "boolean"
          },
          "online_hide": {
            "type": "boolean"
          },
          "box_office_hide": {
            "type": "boolean"
          },
          "transaction_limit": {
            "type": "integer"
          },
          "minimum_purchase_limit": {
            "type": "integer"
          }
        },
        "price_levels": {
          "type": "collection"
        },
        "price": {
          "meta-type": "currency",
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          }
        },
        "service_fee": {
          "meta-type": "currency",
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          }
        },
        "bos_service_fee": {
          "meta-type": "currency",
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          }
        },
        "box_office_price": {
          "meta-type": "currency",
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          }
        },
        "minimum_price": {
          "meta-type": "currency",
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          }
        }
      },
      "relationships": {
        "schedules": {
          "type": "price_level_schedules",
          "relation": "has_many"
        },
        "event": {
          "type": "events",
          "relation": "has_one"
        }
      }
    }
  ]
}

Get a collection of bundles
GET`/bundles`

Bundle ¶

GET /bundles/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bundles",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "active": {
        "type": "boolean"
      },
      "flex": {
        "type": "boolean"
      },
      "flex_minimum": {
        "type": "integer"
      },
      "flex_maximum": {
        "type": "integer"
      },
      "flex_itemize": {
        "type": "boolean"
      },
      "flex_percent_discount": {
        "type": "integer"
      },
      "flex_flat_discount": {
        "type": "float"
      },
      "settings": {
        "multiple_holders": {
          "type": "boolean"
        },
        "online_hide": {
          "type": "boolean"
        },
        "box_office_hide": {
          "type": "boolean"
        },
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        }
      },
      "price_levels": {
        "type": "collection"
      },
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "bos_service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "relationships": {
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Get an bundle
GET`/bundles/{id}`

URI Parameters

HideShow

id: string (required)
Bundle ID

PATCH /bundles/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "bundles",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "active": {
        "type": "boolean"
      },
      "flex": {
        "type": "boolean"
      },
      "flex_minimum": {
        "type": "integer"
      },
      "flex_maximum": {
        "type": "integer"
      },
      "flex_itemize": {
        "type": "boolean"
      },
      "flex_percent_discount": {
        "type": "integer"
      },
      "flex_flat_discount": {
        "type": "float"
      },
      "settings": {
        "multiple_holders": {
          "type": "boolean"
        },
        "online_hide": {
          "type": "boolean"
        },
        "box_office_hide": {
          "type": "boolean"
        },
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        }
      },
      "price_levels": {
        "type": "collection"
      },
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "bos_service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "relationships": {
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bundles",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "active": {
        "type": "boolean"
      },
      "flex": {
        "type": "boolean"
      },
      "flex_minimum": {
        "type": "integer"
      },
      "flex_maximum": {
        "type": "integer"
      },
      "flex_itemize": {
        "type": "boolean"
      },
      "flex_percent_discount": {
        "type": "integer"
      },
      "flex_flat_discount": {
        "type": "float"
      },
      "settings": {
        "multiple_holders": {
          "type": "boolean"
        },
        "online_hide": {
          "type": "boolean"
        },
        "box_office_hide": {
          "type": "boolean"
        },
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        }
      },
      "price_levels": {
        "type": "collection"
      },
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "bos_service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "relationships": {
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Update an bundle
PATCH`/bundles/{id}`

URI Parameters

HideShow

id: string (required)
Bundle ID

DELETE /bundles/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bundles",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "active": {
        "type": "boolean"
      },
      "flex": {
        "type": "boolean"
      },
      "flex_minimum": {
        "type": "integer"
      },
      "flex_maximum": {
        "type": "integer"
      },
      "flex_itemize": {
        "type": "boolean"
      },
      "flex_percent_discount": {
        "type": "integer"
      },
      "flex_flat_discount": {
        "type": "float"
      },
      "settings": {
        "multiple_holders": {
          "type": "boolean"
        },
        "online_hide": {
          "type": "boolean"
        },
        "box_office_hide": {
          "type": "boolean"
        },
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        }
      },
      "price_levels": {
        "type": "collection"
      },
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "bos_service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "relationships": {
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Delete an bundle
DELETE`/bundles/{id}`

URI Parameters

HideShow

id: string (required)
Bundle ID

Events ¶

Event Categories

Events can have up to three categories, and they are returned as an array of IDs when interacting with the api. Here is a list of categories and its related ID for reference:

ID	Category
26	Sports & Recreation
27	Team Sports (e.g., Basketball, Baseball, Soccer)
28	Individual Sports (e.g., Tennis, Golf, Swimming)
29	Fitness & Workouts
30	Outdoor Activities (e.g., Hiking, Cycling, Skiing)
31	Tournaments & Competitions
32	Music & Concerts
33	Rock & Alternative
34	Pop & Hip-Hop
35	Classical & Orchestral
36	Jazz & Blues
37	Electronic & Dance
38	Music Festivals
39	Country
40	Museums & Exhibits
41	Art Exhibitions
42	Crafts & Handmade
43	Garden
44	Science & Technology
45	Community & Social Events
46	Charity & Fundraisers
47	Community Gatherings
48	Literature & Book Events
49	Social Clubs & Meetups
50	Parades & Celebrations
51	Business & Networking
52	Conferences & Seminars
53	Workshops & Training
54	Professional Development
55	Entrepreneurship & Startups
56	Networking Events
57	Charity & Causes
58	Fundraising Galas
59	Volunteer Opportunities
60	Awareness Campaigns
61	Benefit Concerts
62	Charity Auctions
63	Education & Learning
64	Workshops & Classes
65	Academic Conferences
66	Guest Lectures
67	Educational Expos
68	Skill Development
69	Comedy & Entertainment
70	Stand-up Comedy Shows
71	Improv & Sketch Comedy
72	Comedy Festivals
73	Food & Drinks
74	Food Festivals
75	Wine & Beer Tasting
76	Restaurant Specials
77	Cooking Classes
78	Culinary Experiences
79	Festivals & Fairs
80	Seasonal Festivals (e.g., Fall Events, Christmas Markets)
81	Cultural Festivals
82	State or Country Fairs
83	Music Festivals
84	Art Fairs
85	Health & Wellness
86	Yoga & Meditation
87	Fitness Challenges
88	Wellness Retreats
89	Health Expos
90	Mental Health Workshops
91	Movies & Film Screenings
92	Film Festivals
93	Movie Premieres
94	Documentary Screenings
95	Classic Movie Nights
96	Family & Kids
97	Children’s Activities
98	Family Fun Days
99	Kids’ Theater & Shows
100	Parenting Workshops
101	Educational Events for Kids
102	Travel & Outdoor Adventures
103	Adventure Tours
104	Nature Walks & Hikes
105	Travel Exhibitions
106	Outdoor Workshops
107	Wildlife Exhibits
108	Zoo
109	Workshops & Conferences
110	Technology & Innovation
111	Art & Design Workshops
112	Personal Development
113	Science & Research Conferences
114	Pop Culture Conventions
115	Anime
116	Fandom
117	Gaming
118	TV Show
119	Performing Arts
120	Dance
121	Theater
122	Ballet
123	School

Events ¶

POST /events

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "events",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "short_name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "ticket_note": {
        "type": "string"
      },
      "start": {
        "type": "iso8601"
      },
      "end": {
        "type": "iso8601"
      },
      "sales_open": {
        "type": "iso8601"
      },
      "sales_close": {
        "type": "iso8601"
      },
      "created": {
        "type": "iso8601"
      },
      "inventory": {
        "type": "integer"
      },
      "categories": {
        "type": "array"
      },
      "image": {
        "type": "string"
      },
      "age_minimum": {
        "type": "string"
      },
      "donations": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        }
      },
      "custom_seller_fee": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        },
        "amount": {
          "type": "string"
        },
        "fee_type": {
          "type": "string",
          "enum": [
            "fixed-amount",
            "percentage"
          ]
        },
        "mode": {
          "type": "string",
          "enum": [
            "online",
            "box_office",
            "all"
          ]
        },
        "after_discount": {
          "type": "boolean"
        }
      },
      "status": {
        "type": "string",
        "enum": [
          "incomplete",
          "complete",
          "active"
        ]
      },
      "settings": {
        "transaction_timelimit": {
          "type": "integer"
        },
        "ticket_transaction_limit": {
          "type": "integer"
        },
        "manually_arrange_price_levels": {
          "type": "boolean"
        },
        "collect_name_per_ticket": {
          "type": "boolean"
        },
        "private": {
          "type": "boolean"
        },
        "force_show_on_seller_homepage": {
          "type": "boolean"
        },
        "no_index": {
          "type": "boolean"
        }
      },
      "behavior": {
        "registration": {
          "type": "boolean"
        },
        "series": {
          "type": "boolean"
        },
        "package": {
          "type": "boolean"
        },
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "seller": {
        "type": "sellers",
        "relation": "has-one"
      },
      "venue": {
        "type": "venues",
        "relation": "has-one"
      },
      "price_levels": {
        "type": "price_levels",
        "relation": "has-many"
      },
      "discount-levels": {
        "type": "discount-levels",
        "relation": "has-many"
      },
      "question_maps": {
        "type": "question_maps",
        "relation": "has-many"
      },
      "product_listings": {
        "type": "product_listings",
        "relation": "has-many"
      },
      "scheme": {
        "type": "schemes",
        "relation": "has-one"
      },
      "bundles": {
        "type": "bundles",
        "relation": "has-many"
      },
      "delivery_methods": {
        "type": "delivery-methods",
        "relation": "has-many"
      }
    }
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "events",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "short_name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "ticket_note": {
        "type": "string"
      },
      "start": {
        "type": "iso8601"
      },
      "end": {
        "type": "iso8601"
      },
      "sales_open": {
        "type": "iso8601"
      },
      "sales_close": {
        "type": "iso8601"
      },
      "created": {
        "type": "iso8601"
      },
      "inventory": {
        "type": "integer"
      },
      "categories": {
        "type": "array"
      },
      "image": {
        "type": "string"
      },
      "age_minimum": {
        "type": "string"
      },
      "donations": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        }
      },
      "custom_seller_fee": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        },
        "amount": {
          "type": "string"
        },
        "fee_type": {
          "type": "string",
          "enum": [
            "fixed-amount",
            "percentage"
          ]
        },
        "mode": {
          "type": "string",
          "enum": [
            "online",
            "box_office",
            "all"
          ]
        },
        "after_discount": {
          "type": "boolean"
        }
      },
      "status": {
        "type": "string",
        "enum": [
          "incomplete",
          "complete",
          "active"
        ]
      },
      "settings": {
        "transaction_timelimit": {
          "type": "integer"
        },
        "ticket_transaction_limit": {
          "type": "integer"
        },
        "manually_arrange_price_levels": {
          "type": "boolean"
        },
        "collect_name_per_ticket": {
          "type": "boolean"
        },
        "private": {
          "type": "boolean"
        },
        "force_show_on_seller_homepage": {
          "type": "boolean"
        },
        "no_index": {
          "type": "boolean"
        }
      },
      "behavior": {
        "registration": {
          "type": "boolean"
        },
        "series": {
          "type": "boolean"
        },
        "package": {
          "type": "boolean"
        },
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "seller": {
        "type": "sellers",
        "relation": "has-one"
      },
      "venue": {
        "type": "venues",
        "relation": "has-one"
      },
      "price_levels": {
        "type": "price_levels",
        "relation": "has-many"
      },
      "discount-levels": {
        "type": "discount-levels",
        "relation": "has-many"
      },
      "question_maps": {
        "type": "question_maps",
        "relation": "has-many"
      },
      "product_listings": {
        "type": "product_listings",
        "relation": "has-many"
      },
      "scheme": {
        "type": "schemes",
        "relation": "has-one"
      },
      "bundles": {
        "type": "bundles",
        "relation": "has-many"
      },
      "delivery_methods": {
        "type": "delivery-methods",
        "relation": "has-many"
      }
    }
  }
}

Create a new event
POST`/events`

Note: id should be omitted or null for this request

Event ¶

GET /events/filter

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "type": "events",
      "id": {
        "type": "string"
      },
      "attributes": {
        "name": {
          "type": "string"
        },
        "short_name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "ticket_note": {
          "type": "string"
        },
        "start": {
          "type": "iso8601"
        },
        "end": {
          "type": "iso8601"
        },
        "sales_open": {
          "type": "iso8601"
        },
        "sales_close": {
          "type": "iso8601"
        },
        "created": {
          "type": "iso8601"
        },
        "inventory": {
          "type": "integer"
        },
        "categories": {
          "type": "array"
        },
        "image": {
          "type": "string"
        },
        "age_minimum": {
          "type": "string"
        },
        "donations": {
          "name": {
            "type": "string"
          },
          "live": {
            "type": "boolean"
          }
        },
        "custom_seller_fee": {
          "name": {
            "type": "string"
          },
          "live": {
            "type": "boolean"
          },
          "amount": {
            "type": "string"
          },
          "fee_type": {
            "type": "string",
            "enum": [
              "fixed-amount",
              "percentage"
            ]
          },
          "mode": {
            "type": "string",
            "enum": [
              "online",
              "box_office",
              "all"
            ]
          },
          "after_discount": {
            "type": "boolean"
          }
        },
        "status": {
          "type": "string",
          "enum": [
            "incomplete",
            "complete",
            "active"
          ]
        },
        "settings": {
          "transaction_timelimit": {
            "type": "integer"
          },
          "ticket_transaction_limit": {
            "type": "integer"
          },
          "manually_arrange_price_levels": {
            "type": "boolean"
          },
          "collect_name_per_ticket": {
            "type": "boolean"
          },
          "private": {
            "type": "boolean"
          },
          "force_show_on_seller_homepage": {
            "type": "boolean"
          },
          "no_index": {
            "type": "boolean"
          }
        },
        "behavior": {
          "registration": {
            "type": "boolean"
          },
          "series": {
            "type": "boolean"
          },
          "package": {
            "type": "boolean"
          },
          "seated": {
            "type": "boolean"
          }
        }
      },
      "relationships": {
        "seller": {
          "type": "sellers",
          "relation": "has-one"
        },
        "venue": {
          "type": "venues",
          "relation": "has-one"
        },
        "price_levels": {
          "type": "price_levels",
          "relation": "has-many"
        },
        "discount-levels": {
          "type": "discount-levels",
          "relation": "has-many"
        },
        "question_maps": {
          "type": "question_maps",
          "relation": "has-many"
        },
        "product_listings": {
          "type": "product_listings",
          "relation": "has-many"
        },
        "scheme": {
          "type": "schemes",
          "relation": "has-one"
        },
        "bundles": {
          "type": "bundles",
          "relation": "has-many"
        },
        "delivery_methods": {
          "type": "delivery-methods",
          "relation": "has-many"
        }
      }
    }
  ]
}

Get a collection of events
GET`/events/{filter}`

URI Parameters

HideShow

filter

string (optional)

This parameter allows filtering events based on the following criteria. The mask is as follows: ?filter=foo=1,baz=2,...

seller (int, optional) - ID of the seller to retrieve events for. If not passed, the current (authenticated) seller ID will be used.
start (date, optional) - Limits events to those occurring on or after the specified start date.
end (date, optional) - Limits events to those occurring before the specified end date.
upcoming (bool, optional) - Limits events to future occurrences.
past (bool, optional) - Limits events to past occurrences.
short_name (string, optional) - Limits events to those with the specified short name.
series (int, optional) - ID of the parent event series.
state (string, optional) - Specifies the state of events to retrieve. Possible values are “live” (default), “pending”, “paused”, or “all”.

Examples:
Retrieves events starting from 2024-05-22 and belonging to seller 1
/api/events?filter=seller=1,start=2024-05-22

Retrieves past events that are in the paused state.
/api/events?filter=state=paused,past=true

Event ¶

GET /events/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "events",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "short_name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "ticket_note": {
        "type": "string"
      },
      "start": {
        "type": "iso8601"
      },
      "end": {
        "type": "iso8601"
      },
      "sales_open": {
        "type": "iso8601"
      },
      "sales_close": {
        "type": "iso8601"
      },
      "created": {
        "type": "iso8601"
      },
      "inventory": {
        "type": "integer"
      },
      "categories": {
        "type": "array"
      },
      "image": {
        "type": "string"
      },
      "age_minimum": {
        "type": "string"
      },
      "donations": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        }
      },
      "custom_seller_fee": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        },
        "amount": {
          "type": "string"
        },
        "fee_type": {
          "type": "string",
          "enum": [
            "fixed-amount",
            "percentage"
          ]
        },
        "mode": {
          "type": "string",
          "enum": [
            "online",
            "box_office",
            "all"
          ]
        },
        "after_discount": {
          "type": "boolean"
        }
      },
      "status": {
        "type": "string",
        "enum": [
          "incomplete",
          "complete",
          "active"
        ]
      },
      "settings": {
        "transaction_timelimit": {
          "type": "integer"
        },
        "ticket_transaction_limit": {
          "type": "integer"
        },
        "manually_arrange_price_levels": {
          "type": "boolean"
        },
        "collect_name_per_ticket": {
          "type": "boolean"
        },
        "private": {
          "type": "boolean"
        },
        "force_show_on_seller_homepage": {
          "type": "boolean"
        },
        "no_index": {
          "type": "boolean"
        }
      },
      "behavior": {
        "registration": {
          "type": "boolean"
        },
        "series": {
          "type": "boolean"
        },
        "package": {
          "type": "boolean"
        },
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "seller": {
        "type": "sellers",
        "relation": "has-one"
      },
      "venue": {
        "type": "venues",
        "relation": "has-one"
      },
      "price_levels": {
        "type": "price_levels",
        "relation": "has-many"
      },
      "discount-levels": {
        "type": "discount-levels",
        "relation": "has-many"
      },
      "question_maps": {
        "type": "question_maps",
        "relation": "has-many"
      },
      "product_listings": {
        "type": "product_listings",
        "relation": "has-many"
      },
      "scheme": {
        "type": "schemes",
        "relation": "has-one"
      },
      "bundles": {
        "type": "bundles",
        "relation": "has-many"
      },
      "delivery_methods": {
        "type": "delivery-methods",
        "relation": "has-many"
      }
    }
  }
}

Get an event
GET`/events/{id}`

URI Parameters

HideShow

id: string (required)
Event ID

PATCH /events/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "events",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "short_name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "ticket_note": {
        "type": "string"
      },
      "start": {
        "type": "iso8601"
      },
      "end": {
        "type": "iso8601"
      },
      "sales_open": {
        "type": "iso8601"
      },
      "sales_close": {
        "type": "iso8601"
      },
      "created": {
        "type": "iso8601"
      },
      "inventory": {
        "type": "integer"
      },
      "categories": {
        "type": "array"
      },
      "image": {
        "type": "string"
      },
      "age_minimum": {
        "type": "string"
      },
      "donations": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        }
      },
      "custom_seller_fee": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        },
        "amount": {
          "type": "string"
        },
        "fee_type": {
          "type": "string",
          "enum": [
            "fixed-amount",
            "percentage"
          ]
        },
        "mode": {
          "type": "string",
          "enum": [
            "online",
            "box_office",
            "all"
          ]
        },
        "after_discount": {
          "type": "boolean"
        }
      },
      "status": {
        "type": "string",
        "enum": [
          "incomplete",
          "complete",
          "active"
        ]
      },
      "settings": {
        "transaction_timelimit": {
          "type": "integer"
        },
        "ticket_transaction_limit": {
          "type": "integer"
        },
        "manually_arrange_price_levels": {
          "type": "boolean"
        },
        "collect_name_per_ticket": {
          "type": "boolean"
        },
        "private": {
          "type": "boolean"
        },
        "force_show_on_seller_homepage": {
          "type": "boolean"
        },
        "no_index": {
          "type": "boolean"
        }
      },
      "behavior": {
        "registration": {
          "type": "boolean"
        },
        "series": {
          "type": "boolean"
        },
        "package": {
          "type": "boolean"
        },
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "seller": {
        "type": "sellers",
        "relation": "has-one"
      },
      "venue": {
        "type": "venues",
        "relation": "has-one"
      },
      "price_levels": {
        "type": "price_levels",
        "relation": "has-many"
      },
      "discount-levels": {
        "type": "discount-levels",
        "relation": "has-many"
      },
      "question_maps": {
        "type": "question_maps",
        "relation": "has-many"
      },
      "product_listings": {
        "type": "product_listings",
        "relation": "has-many"
      },
      "scheme": {
        "type": "schemes",
        "relation": "has-one"
      },
      "bundles": {
        "type": "bundles",
        "relation": "has-many"
      },
      "delivery_methods": {
        "type": "delivery-methods",
        "relation": "has-many"
      }
    }
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "events",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "short_name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "ticket_note": {
        "type": "string"
      },
      "start": {
        "type": "iso8601"
      },
      "end": {
        "type": "iso8601"
      },
      "sales_open": {
        "type": "iso8601"
      },
      "sales_close": {
        "type": "iso8601"
      },
      "created": {
        "type": "iso8601"
      },
      "inventory": {
        "type": "integer"
      },
      "categories": {
        "type": "array"
      },
      "image": {
        "type": "string"
      },
      "age_minimum": {
        "type": "string"
      },
      "donations": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        }
      },
      "custom_seller_fee": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        },
        "amount": {
          "type": "string"
        },
        "fee_type": {
          "type": "string",
          "enum": [
            "fixed-amount",
            "percentage"
          ]
        },
        "mode": {
          "type": "string",
          "enum": [
            "online",
            "box_office",
            "all"
          ]
        },
        "after_discount": {
          "type": "boolean"
        }
      },
      "status": {
        "type": "string",
        "enum": [
          "incomplete",
          "complete",
          "active"
        ]
      },
      "settings": {
        "transaction_timelimit": {
          "type": "integer"
        },
        "ticket_transaction_limit": {
          "type": "integer"
        },
        "manually_arrange_price_levels": {
          "type": "boolean"
        },
        "collect_name_per_ticket": {
          "type": "boolean"
        },
        "private": {
          "type": "boolean"
        },
        "force_show_on_seller_homepage": {
          "type": "boolean"
        },
        "no_index": {
          "type": "boolean"
        }
      },
      "behavior": {
        "registration": {
          "type": "boolean"
        },
        "series": {
          "type": "boolean"
        },
        "package": {
          "type": "boolean"
        },
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "seller": {
        "type": "sellers",
        "relation": "has-one"
      },
      "venue": {
        "type": "venues",
        "relation": "has-one"
      },
      "price_levels": {
        "type": "price_levels",
        "relation": "has-many"
      },
      "discount-levels": {
        "type": "discount-levels",
        "relation": "has-many"
      },
      "question_maps": {
        "type": "question_maps",
        "relation": "has-many"
      },
      "product_listings": {
        "type": "product_listings",
        "relation": "has-many"
      },
      "scheme": {
        "type": "schemes",
        "relation": "has-one"
      },
      "bundles": {
        "type": "bundles",
        "relation": "has-many"
      },
      "delivery_methods": {
        "type": "delivery-methods",
        "relation": "has-many"
      }
    }
  }
}

Update an event
PATCH`/events/{id}`

URI Parameters

HideShow

id: string (required)
Event ID

DELETE /events/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "events",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "short_name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "ticket_note": {
        "type": "string"
      },
      "start": {
        "type": "iso8601"
      },
      "end": {
        "type": "iso8601"
      },
      "sales_open": {
        "type": "iso8601"
      },
      "sales_close": {
        "type": "iso8601"
      },
      "created": {
        "type": "iso8601"
      },
      "inventory": {
        "type": "integer"
      },
      "categories": {
        "type": "array"
      },
      "image": {
        "type": "string"
      },
      "age_minimum": {
        "type": "string"
      },
      "donations": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        }
      },
      "custom_seller_fee": {
        "name": {
          "type": "string"
        },
        "live": {
          "type": "boolean"
        },
        "amount": {
          "type": "string"
        },
        "fee_type": {
          "type": "string",
          "enum": [
            "fixed-amount",
            "percentage"
          ]
        },
        "mode": {
          "type": "string",
          "enum": [
            "online",
            "box_office",
            "all"
          ]
        },
        "after_discount": {
          "type": "boolean"
        }
      },
      "status": {
        "type": "string",
        "enum": [
          "incomplete",
          "complete",
          "active"
        ]
      },
      "settings": {
        "transaction_timelimit": {
          "type": "integer"
        },
        "ticket_transaction_limit": {
          "type": "integer"
        },
        "manually_arrange_price_levels": {
          "type": "boolean"
        },
        "collect_name_per_ticket": {
          "type": "boolean"
        },
        "private": {
          "type": "boolean"
        },
        "force_show_on_seller_homepage": {
          "type": "boolean"
        },
        "no_index": {
          "type": "boolean"
        }
      },
      "behavior": {
        "registration": {
          "type": "boolean"
        },
        "series": {
          "type": "boolean"
        },
        "package": {
          "type": "boolean"
        },
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "seller": {
        "type": "sellers",
        "relation": "has-one"
      },
      "venue": {
        "type": "venues",
        "relation": "has-one"
      },
      "price_levels": {
        "type": "price_levels",
        "relation": "has-many"
      },
      "discount-levels": {
        "type": "discount-levels",
        "relation": "has-many"
      },
      "question_maps": {
        "type": "question_maps",
        "relation": "has-many"
      },
      "product_listings": {
        "type": "product_listings",
        "relation": "has-many"
      },
      "scheme": {
        "type": "schemes",
        "relation": "has-one"
      },
      "bundles": {
        "type": "bundles",
        "relation": "has-many"
      },
      "delivery_methods": {
        "type": "delivery-methods",
        "relation": "has-many"
      }
    }
  }
}

Delete an event
DELETE`/events/{id}`

URI Parameters

HideShow

id: string (required)
Event ID

Seller ¶

PATCH /events/id/relationships/sellers

Update relation
PATCH`/events/{id}/relationships/sellers`

URI Parameters

HideShow

id: string (required)
Event ID

GET /events/id/seller

Get related seller
GET`/events/{id}/seller`

URI Parameters

HideShow

id: string (required)
Event ID

Venue ¶

PATCH /events/id/relationships/venues

Update relation
PATCH`/events/{id}/relationships/venues`

URI Parameters

HideShow

id: string (required)
Event ID

GET /events/id/venue

Get related venue
GET`/events/{id}/venue`

URI Parameters

HideShow

id: string (required)
Event ID

Scheme ¶

PATCH /events/id/relationships/schemes

Update relation
PATCH`/events/{id}/relationships/schemes`

URI Parameters

HideShow

id: string (required)
Event ID

GET /events/id/scheme

Get related scheme
GET`/events/{id}/scheme`

URI Parameters

HideShow

id: string (required)
Event ID

Price Levels ¶

POST /price_levels

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "price_levels",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "settings": {
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        },
        "hide_online": {
          "type": "boolean"
        },
        "hide_box_office": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "question_maps": {
        "type": "question_maps",
        "relation": "has_many"
      },
      "questions": {
        "type": "questions",
        "relation": "has_many"
      },
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "price_levels",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "settings": {
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        },
        "hide_online": {
          "type": "boolean"
        },
        "hide_box_office": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "question_maps": {
        "type": "question_maps",
        "relation": "has_many"
      },
      "questions": {
        "type": "questions",
        "relation": "has_many"
      },
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Create a new price level
POST`/price_levels`

Note: id should be omitted or null for this request

GET /price_levels

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "type": "price_levels",
      "id": {
        "type": "integer"
      },
      "attributes": {
        "price": {
          "meta-type": "currency",
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          }
        },
        "box_office_price": {
          "meta-type": "currency",
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          }
        },
        "minimum_price": {
          "meta-type": "currency",
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          }
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "inventory": {
          "type": "integer"
        },
        "settings": {
          "transaction_limit": {
            "type": "integer"
          },
          "minimum_purchase_limit": {
            "type": "integer"
          },
          "hide_online": {
            "type": "boolean"
          },
          "hide_box_office": {
            "type": "boolean"
          }
        }
      },
      "relationships": {
        "question_maps": {
          "type": "question_maps",
          "relation": "has_many"
        },
        "questions": {
          "type": "questions",
          "relation": "has_many"
        },
        "schedules": {
          "type": "price_level_schedules",
          "relation": "has_many"
        },
        "event": {
          "type": "events",
          "relation": "has_one"
        }
      }
    }
  ]
}

Get a collection of price levels
GET`/price_levels`

Price Level ¶

GET /price_levels/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "price_levels",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "settings": {
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        },
        "hide_online": {
          "type": "boolean"
        },
        "hide_box_office": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "question_maps": {
        "type": "question_maps",
        "relation": "has_many"
      },
      "questions": {
        "type": "questions",
        "relation": "has_many"
      },
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Get an price level
GET`/price_levels/{id}`

URI Parameters

HideShow

id: string (required)
Price Level ID

PATCH /price_levels/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "price_levels",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "settings": {
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        },
        "hide_online": {
          "type": "boolean"
        },
        "hide_box_office": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "question_maps": {
        "type": "question_maps",
        "relation": "has_many"
      },
      "questions": {
        "type": "questions",
        "relation": "has_many"
      },
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "price_levels",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "settings": {
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        },
        "hide_online": {
          "type": "boolean"
        },
        "hide_box_office": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "question_maps": {
        "type": "question_maps",
        "relation": "has_many"
      },
      "questions": {
        "type": "questions",
        "relation": "has_many"
      },
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Update an price level
PATCH`/price_levels/{id}`

URI Parameters

HideShow

id: string (required)
Price Level ID

DELETE /price_levels/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "price_levels",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "settings": {
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        },
        "hide_online": {
          "type": "boolean"
        },
        "hide_box_office": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "question_maps": {
        "type": "question_maps",
        "relation": "has_many"
      },
      "questions": {
        "type": "questions",
        "relation": "has_many"
      },
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}

Delete an price level
DELETE`/price_levels/{id}`

URI Parameters

HideShow

id: string (required)
Price Level ID

Scanner Statuses ¶

POST /scanner-statuses

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "scanner-statuses",
    "id": {
      "type": "string"
    },
    "attributes": {
      "active": {
        "type": "boolean",
        "validation": []
      },
      "battery_level": {
        "type": "string",
        "validation": []
      },
      "wifi_strength": {
        "type": "string",
        "validation": []
      },
      "mac_address": {
        "type": "string",
        "validation": []
      },
      "axess_version": {
        "type": "string",
        "validation": []
      },
      "device_identifier": {
        "type": "string",
        "validation": []
      },
      "display_name": {
        "type": "string",
        "validation": []
      },
      "active_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_date": {
        "type": "iso8601",
        "validation": []
      },
      "check_in_mode": {
        "type": "string",
        "enum": [
          "check-in",
          "check-out",
          "capture",
          "generate"
        ],
        "validation": []
      }
    },
    "relationships": []
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "scanner-statuses",
    "id": {
      "type": "string"
    },
    "attributes": {
      "active": {
        "type": "boolean",
        "validation": []
      },
      "battery_level": {
        "type": "string",
        "validation": []
      },
      "wifi_strength": {
        "type": "string",
        "validation": []
      },
      "mac_address": {
        "type": "string",
        "validation": []
      },
      "axess_version": {
        "type": "string",
        "validation": []
      },
      "device_identifier": {
        "type": "string",
        "validation": []
      },
      "display_name": {
        "type": "string",
        "validation": []
      },
      "active_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_date": {
        "type": "iso8601",
        "validation": []
      },
      "check_in_mode": {
        "type": "string",
        "enum": [
          "check-in",
          "check-out",
          "capture",
          "generate"
        ],
        "validation": []
      }
    },
    "relationships": []
  }
}

Create a new scanner status
POST`/scanner-statuses`

Note: id should be omitted or null for this request

GET /scanner-statuses

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "type": "scanner-statuses",
      "id": {
        "type": "string"
      },
      "attributes": {
        "active": {
          "type": "boolean",
          "validation": []
        },
        "battery_level": {
          "type": "string",
          "validation": []
        },
        "wifi_strength": {
          "type": "string",
          "validation": []
        },
        "mac_address": {
          "type": "string",
          "validation": []
        },
        "axess_version": {
          "type": "string",
          "validation": []
        },
        "device_identifier": {
          "type": "string",
          "validation": []
        },
        "display_name": {
          "type": "string",
          "validation": []
        },
        "active_user_name": {
          "type": "string",
          "validation": []
        },
        "last_sync_user_name": {
          "type": "string",
          "validation": []
        },
        "last_sync_date": {
          "type": "iso8601",
          "validation": []
        },
        "check_in_mode": {
          "type": "string",
          "enum": [
            "check-in",
            "check-out",
            "capture",
            "generate"
          ],
          "validation": []
        }
      },
      "relationships": []
    }
  ]
}

Get a collection of scanner statuses
GET`/scanner-statuses`

Scanner Status ¶

GET /scanner-statuses/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "scanner-statuses",
    "id": {
      "type": "string"
    },
    "attributes": {
      "active": {
        "type": "boolean",
        "validation": []
      },
      "battery_level": {
        "type": "string",
        "validation": []
      },
      "wifi_strength": {
        "type": "string",
        "validation": []
      },
      "mac_address": {
        "type": "string",
        "validation": []
      },
      "axess_version": {
        "type": "string",
        "validation": []
      },
      "device_identifier": {
        "type": "string",
        "validation": []
      },
      "display_name": {
        "type": "string",
        "validation": []
      },
      "active_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_date": {
        "type": "iso8601",
        "validation": []
      },
      "check_in_mode": {
        "type": "string",
        "enum": [
          "check-in",
          "check-out",
          "capture",
          "generate"
        ],
        "validation": []
      }
    },
    "relationships": []
  }
}

Get an scanner status
GET`/scanner-statuses/{id}`

URI Parameters

HideShow

id: string (required)
Scanner Status ID

PATCH /scanner-statuses/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "scanner-statuses",
    "id": {
      "type": "string"
    },
    "attributes": {
      "active": {
        "type": "boolean",
        "validation": []
      },
      "battery_level": {
        "type": "string",
        "validation": []
      },
      "wifi_strength": {
        "type": "string",
        "validation": []
      },
      "mac_address": {
        "type": "string",
        "validation": []
      },
      "axess_version": {
        "type": "string",
        "validation": []
      },
      "device_identifier": {
        "type": "string",
        "validation": []
      },
      "display_name": {
        "type": "string",
        "validation": []
      },
      "active_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_date": {
        "type": "iso8601",
        "validation": []
      },
      "check_in_mode": {
        "type": "string",
        "enum": [
          "check-in",
          "check-out",
          "capture",
          "generate"
        ],
        "validation": []
      }
    },
    "relationships": []
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "scanner-statuses",
    "id": {
      "type": "string"
    },
    "attributes": {
      "active": {
        "type": "boolean",
        "validation": []
      },
      "battery_level": {
        "type": "string",
        "validation": []
      },
      "wifi_strength": {
        "type": "string",
        "validation": []
      },
      "mac_address": {
        "type": "string",
        "validation": []
      },
      "axess_version": {
        "type": "string",
        "validation": []
      },
      "device_identifier": {
        "type": "string",
        "validation": []
      },
      "display_name": {
        "type": "string",
        "validation": []
      },
      "active_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_date": {
        "type": "iso8601",
        "validation": []
      },
      "check_in_mode": {
        "type": "string",
        "enum": [
          "check-in",
          "check-out",
          "capture",
          "generate"
        ],
        "validation": []
      }
    },
    "relationships": []
  }
}

Update an scanner status
PATCH`/scanner-statuses/{id}`

URI Parameters

HideShow

id: string (required)
Scanner Status ID

DELETE /scanner-statuses/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "scanner-statuses",
    "id": {
      "type": "string"
    },
    "attributes": {
      "active": {
        "type": "boolean",
        "validation": []
      },
      "battery_level": {
        "type": "string",
        "validation": []
      },
      "wifi_strength": {
        "type": "string",
        "validation": []
      },
      "mac_address": {
        "type": "string",
        "validation": []
      },
      "axess_version": {
        "type": "string",
        "validation": []
      },
      "device_identifier": {
        "type": "string",
        "validation": []
      },
      "display_name": {
        "type": "string",
        "validation": []
      },
      "active_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_user_name": {
        "type": "string",
        "validation": []
      },
      "last_sync_date": {
        "type": "iso8601",
        "validation": []
      },
      "check_in_mode": {
        "type": "string",
        "enum": [
          "check-in",
          "check-out",
          "capture",
          "generate"
        ],
        "validation": []
      }
    },
    "relationships": []
  }
}

Delete an scanner status
DELETE`/scanner-statuses/{id}`

URI Parameters

HideShow

id: string (required)
Scanner Status ID

Venues ¶

POST /venues

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "venues",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "capacity": {
        "type": "integer"
      },
      "description": {
        "type": "string"
      },
      "address": {
        "lines": {
          "type": "collection"
        },
        "city": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "country": {
          "type": "string"
        }
      },
      "latitude": {
        "type": "float"
      },
      "longitude": {
        "type": "float"
      },
      "timezone": {
        "offset": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "behavior": {
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "sellers": {
        "type": "sellers",
        "relation": "has-many"
      },
      "events": {
        "type": "events",
        "relation": "has-many"
      }
    }
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "venues",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "capacity": {
        "type": "integer"
      },
      "description": {
        "type": "string"
      },
      "address": {
        "lines": {
          "type": "collection"
        },
        "city": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "country": {
          "type": "string"
        }
      },
      "latitude": {
        "type": "float"
      },
      "longitude": {
        "type": "float"
      },
      "timezone": {
        "offset": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "behavior": {
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "sellers": {
        "type": "sellers",
        "relation": "has-many"
      },
      "events": {
        "type": "events",
        "relation": "has-many"
      }
    }
  }
}

Create a new venue
POST`/venues`

Note: id should be omitted or null for this request

GET /venues

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "type": "venues",
      "id": {
        "type": "string"
      },
      "attributes": {
        "name": {
          "type": "string"
        },
        "capacity": {
          "type": "integer"
        },
        "description": {
          "type": "string"
        },
        "address": {
          "lines": {
            "type": "collection"
          },
          "city": {
            "type": "string"
          },
          "region": {
            "type": "string"
          },
          "postal_code": {
            "type": "string"
          },
          "country": {
            "type": "string"
          }
        },
        "latitude": {
          "type": "float"
        },
        "longitude": {
          "type": "float"
        },
        "timezone": {
          "offset": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "behavior": {
          "seated": {
            "type": "boolean"
          }
        }
      },
      "relationships": {
        "sellers": {
          "type": "sellers",
          "relation": "has-many"
        },
        "events": {
          "type": "events",
          "relation": "has-many"
        }
      }
    }
  ]
}

Get a collection of venues
GET`/venues`

Venue ¶

GET /venues/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "venues",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "capacity": {
        "type": "integer"
      },
      "description": {
        "type": "string"
      },
      "address": {
        "lines": {
          "type": "collection"
        },
        "city": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "country": {
          "type": "string"
        }
      },
      "latitude": {
        "type": "float"
      },
      "longitude": {
        "type": "float"
      },
      "timezone": {
        "offset": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "behavior": {
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "sellers": {
        "type": "sellers",
        "relation": "has-many"
      },
      "events": {
        "type": "events",
        "relation": "has-many"
      }
    }
  }
}

Get an venue
GET`/venues/{id}`

URI Parameters

HideShow

id: string (required)
Venue ID

PATCH /venues/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Body

{
  "data": {
    "type": "venues",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "capacity": {
        "type": "integer"
      },
      "description": {
        "type": "string"
      },
      "address": {
        "lines": {
          "type": "collection"
        },
        "city": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "country": {
          "type": "string"
        }
      },
      "latitude": {
        "type": "float"
      },
      "longitude": {
        "type": "float"
      },
      "timezone": {
        "offset": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "behavior": {
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "sellers": {
        "type": "sellers",
        "relation": "has-many"
      },
      "events": {
        "type": "events",
        "relation": "has-many"
      }
    }
  }
}

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "venues",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "capacity": {
        "type": "integer"
      },
      "description": {
        "type": "string"
      },
      "address": {
        "lines": {
          "type": "collection"
        },
        "city": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "country": {
          "type": "string"
        }
      },
      "latitude": {
        "type": "float"
      },
      "longitude": {
        "type": "float"
      },
      "timezone": {
        "offset": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "behavior": {
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "sellers": {
        "type": "sellers",
        "relation": "has-many"
      },
      "events": {
        "type": "events",
        "relation": "has-many"
      }
    }
  }
}

Update an venue
PATCH`/venues/{id}`

URI Parameters

HideShow

id: string (required)
Venue ID

DELETE /venues/id

Requestsexample 1

Headers

Accept: application/vnd.api+json

Responses200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "venues",
    "id": {
      "type": "string"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "capacity": {
        "type": "integer"
      },
      "description": {
        "type": "string"
      },
      "address": {
        "lines": {
          "type": "collection"
        },
        "city": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "country": {
          "type": "string"
        }
      },
      "latitude": {
        "type": "float"
      },
      "longitude": {
        "type": "float"
      },
      "timezone": {
        "offset": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "behavior": {
        "seated": {
          "type": "boolean"
        }
      }
    },
    "relationships": {
      "sellers": {
        "type": "sellers",
        "relation": "has-many"
      },
      "events": {
        "type": "events",
        "relation": "has-many"
      }
    }
  }
}

Delete an venue
DELETE`/venues/{id}`

URI Parameters

HideShow

id: string (required)
Venue ID

Generated by aglio on 07 May 2024

API Endpoint

Bundles ¶

Bundles ¶

Headers

Body

Headers

Body

Create a new bundlePOST/bundles

Headers

Headers

Body

Get a collection of bundlesGET/bundles

Bundle ¶

Headers

Headers

Body

Get an bundleGET/bundles/{id}

Headers

Body

Headers

Body

Update an bundlePATCH/bundles/{id}

Headers

Headers

Body

Delete an bundleDELETE/bundles/{id}

Events ¶

Event Categories ¶

Events ¶

Headers

Body

Headers

Body

Create a new eventPOST/events

Event ¶

Headers

Headers

Body

Get a collection of eventsGET/events/{filter}

Event ¶

Headers

Headers

Body

Get an eventGET/events/{id}

Headers

Body

Headers

Body

Update an eventPATCH/events/{id}

Headers

Headers

Body

Delete an eventDELETE/events/{id}

Seller ¶

Update relationPATCH/events/{id}/relationships/sellers

Get related sellerGET/events/{id}/seller

Venue ¶

Update relationPATCH/events/{id}/relationships/venues

Get related venueGET/events/{id}/venue

Scheme ¶

Update relationPATCH/events/{id}/relationships/schemes

Get related schemeGET/events/{id}/scheme

Price Levels ¶

Price Levels ¶

Headers

Body

Headers

Body

Create a new price levelPOST/price_levels

Headers

Headers

Body

Get a collection of price levelsGET/price_levels

Price Level ¶

Headers

Headers

Body

Get an price levelGET/price_levels/{id}

Headers

Body

Create a new bundle
POST`/bundles`

Get a collection of bundles
GET`/bundles`

Get an bundle
GET`/bundles/{id}`

Update an bundle
PATCH`/bundles/{id}`

Delete an bundle
DELETE`/bundles/{id}`

Event Categories

Create a new event
POST`/events`

Get a collection of events
GET`/events/{filter}`

Get an event
GET`/events/{id}`

Update an event
PATCH`/events/{id}`

Delete an event
DELETE`/events/{id}`

Update relation
PATCH`/events/{id}/relationships/sellers`

Get related seller
GET`/events/{id}/seller`

Update relation
PATCH`/events/{id}/relationships/venues`

Get related venue
GET`/events/{id}/venue`

Update relation
PATCH`/events/{id}/relationships/schemes`

Get related scheme
GET`/events/{id}/scheme`

Create a new price level
POST`/price_levels`

Get a collection of price levels
GET`/price_levels`

Get an price level
GET`/price_levels/{id}`

Update an price level
PATCH`/price_levels/{id}`

Delete an price level
DELETE`/price_levels/{id}`

Create a new scanner status
POST`/scanner-statuses`

Get a collection of scanner statuses
GET`/scanner-statuses`

Get an scanner status
GET`/scanner-statuses/{id}`

Update an scanner status
PATCH`/scanner-statuses/{id}`

Delete an scanner status
DELETE`/scanner-statuses/{id}`

Create a new venue
POST`/venues`

Get a collection of venues
GET`/venues`

Get an venue
GET`/venues/{id}`

Update an venue
PATCH`/venues/{id}`

Delete an venue
DELETE`/venues/{id}`