ShowClix API
Bundles ¶
Bundles ¶
POST /bundles
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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"
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 bundlePOST/bundles
Note: id should be omitted or null for this request
GET /bundles
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 bundlesGET/bundles
URI Parameters
- limit
int(optional)Specifies the maximum number of records to return. Must be between 0 and 100.
Default: 100
Examples:
Retrieves first 10 events
/api/bundles?limit=10- offset
int(optional)Specifies the number of records to skip before starting to return results.
Default: 0
Examples:
Retrieves events starting from 15
/api/bundles?offset=15- filter
string(optional)This parameter allows filtering price levels based on the following criteria. The format for the filter mask is:
?filter=foo=1,baz=2,...-
event_id(int, optional) - The ID of the event to retrieve associated data for. If not provided, data for all events will be returned. -
online_hide(bool, optional) - A flag to filter data hidden from online visibility. When set totrue, the response will include only items hidden from online visibility. -
box_office_hide(bool, optional) - A flag to filter data hidden from BoxOffice visibility. When set totrue, the response will include only items hidden from BoxOffice visibility.
-
Bundle ¶
GET /bundles/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
}
}
}PATCH /bundles/id
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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"
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 /bundles/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
}
}
}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 |
Event listings
Primary listing Note: If you want to set the primary listing for the event, use the Listings API instead of sending a PATCH request to the event.
The primary listing for an event is always listed under listing_settings
Events ¶
POST /events
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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"
}
},
"listing_settings": {
"background_image": {
"type": "string"
},
"header_image": {
"type": "string"
},
"accent_color": {
"type": "string"
},
"slug": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"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"
},
"listings": {
"type": "listings",
"relation": "has-many"
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"listing_settings": {
"background_image": {
"type": "string"
},
"header_image": {
"type": "string"
},
"accent_color": {
"type": "string"
},
"slug": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"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"
},
"listings": {
"type": "listings",
"relation": "has-many"
}
}
}
}Create a new eventPOST/events
Note: id should be omitted or null for this request
Event ¶
GET /events
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"listing_settings": {
"background_image": {
"type": "string"
},
"header_image": {
"type": "string"
},
"accent_color": {
"type": "string"
},
"slug": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"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"
},
"listings": {
"type": "listings",
"relation": "has-many"
}
}
}
]
}Get a collection of eventsGET/events
URI Parameters
- 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-
- include
string(optional)Related resources to include in the response (e.g.,
price_levels)- include_optional
array(optional)Optional attributes to include in the related resources (e.g.,
price_levels.price_breakdown)
Example:/events?include=price_levels&include_optional[]=price_levels.price_breakdown- limit
int(optional)Specifies the maximum number of records to return. 100 entries max.
Default: 100
Examples:
Retrieves first 10 events
/api/events?limit=10- offset
int(optional)Specifies the number of records to skip before starting to return results.
Default: 0
Examples:
Retrieves events starting from 15
/api/events?offset=15
Event ¶
GET /events/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"listing_settings": {
"background_image": {
"type": "string"
},
"header_image": {
"type": "string"
},
"accent_color": {
"type": "string"
},
"slug": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"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"
},
"listings": {
"type": "listings",
"relation": "has-many"
}
}
}
}Get an eventGET/events/{id}
URI Parameters
- id
string(required)Event ID
- include
string(optional)Related resources to include in the response (e.g.,
price_levels)- include_optional
array(optional)Optional attributes to include in the related resources (e.g.,
price_levels.price_breakdown)
Example:/events?include=price_levels&include_optional[]=price_levels.price_breakdown
PATCH /events/id
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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"
}
},
"listing_settings": {
"background_image": {
"type": "string"
},
"header_image": {
"type": "string"
},
"accent_color": {
"type": "string"
},
"slug": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"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"
},
"listings": {
"type": "listings",
"relation": "has-many"
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"listing_settings": {
"background_image": {
"type": "string"
},
"header_image": {
"type": "string"
},
"accent_color": {
"type": "string"
},
"slug": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"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"
},
"listings": {
"type": "listings",
"relation": "has-many"
}
}
}
}Update an eventPATCH/events/{id}
URI Parameters
- id
string(required)Event ID
- include
string(optional)Related resources to include in the response (e.g.,
price_levels)- include_optional
array(optional)Optional attributes to include in the related resources (e.g.,
price_levels.price_breakdown)
Example:/events?include=price_levels&include_optional[]=price_levels.price_breakdown
DELETE /events/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"listing_settings": {
"background_image": {
"type": "string"
},
"header_image": {
"type": "string"
},
"accent_color": {
"type": "string"
},
"slug": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"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"
},
"listings": {
"type": "listings",
"relation": "has-many"
}
}
}
}Delete an eventDELETE/events/{id}
URI Parameters
- id
string(required)Event ID
- include
string(optional)Related resources to include in the response (e.g.,
price_levels)- include_optional
array(optional)Optional attributes to include in the related resources (e.g.,
price_levels.price_breakdown)
Example:/events?include=price_levels&include_optional[]=price_levels.price_breakdown
GET /events/id/tags
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": null,
"type": "tags",
"attributes": {
"event_id": 1,
"tags": [
"sample",
"tags",
"for",
"event"
]
},
"relationships": [],
"dependents": []
}
}Seller ¶
PATCH /events/id/relationships/sellers
GET /events/id/seller
Venue ¶
PATCH /events/id/relationships/venues
GET /events/id/venue
Scheme ¶
PATCH /events/id/relationships/schemes
GET /events/id/scheme
Listings ¶
Get a collection of listings ¶
GET /events/event_id?include=listings
Requests
Headers
X-API-Token: (string)Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"id": "1",
"type": "events",
"attributes": {}
},
"included": [
{
"id": "1",
"type": "listing-settings",
"attributes": {
"seller_id": 1,
"primary_event_id": 1,
"config": "{}",
"name": "event name",
"listingType": 1,
"slug": "event-name-qwerty",
"active": true
},
"relationships": {
"seller": {
"links": {
"self": "/listing-settings/1/relationships/seller",
"related": "/listing-settings/1/seller"
}
},
"event": {
"links": {
"self": "/listing-settings/1/relationships/event",
"related": "/listing-settings/1/event"
}
}
},
"dependents": []
}
]
]
}Get all listings associated with an eventGET/events/{event_id}?include=listings
Fetch all listings associated with event
Response Attributes
| Property | Type | Notes |
|---|---|---|
success |
boolean |
Result status |
URI Parameters
- event_id
number(required)Event ID
Primary listing for the event ¶
POST /listings/listing_id/event-default
Requests
Headers
X-API-Token: (string)Responses
Headers
Content-Type: application/jsonBody
{
"success": true
}Set primary listing for the eventPOST/listings/{listing_id}/event-default
The listing will be set as primary for its associated event.
Response Attributes
| Property | Type | Notes |
|---|---|---|
success |
boolean |
Result status |
URI Parameters
- listing_id
number(required)Listing ID
Price Levels ¶
Price Levels ¶
POST /price_levels
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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"
}
},
"parent_id": {
"type": "integer"
},
"price_breakdown": {
"type": "object",
"optional": true,
"structure": {
"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"
}
}
}
}
},
"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"
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"parent_id": {
"type": "integer"
},
"price_breakdown": {
"type": "object",
"optional": true,
"structure": {
"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"
}
}
}
}
},
"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 levelPOST/price_levels
Note: id should be omitted or null for this request
GET /price_levels
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"parent_id": {
"type": "integer"
},
"price_breakdown": {
"type": "object",
"optional": true,
"structure": {
"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"
}
}
}
}
},
"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 levelsGET/price_levels
URI Parameters
- limit
int(optional)Specifies the maximum number of records to return. Must be between 0 and 100.
Default: 100
Examples:
Retrieves first 10 events
/api/price_levels?limit=10- offset
int(optional)Specifies the number of records to skip before starting to return results.
Default: 0
Examples:
Retrieves events starting from 15
/api/price_levels?offset=15- filter
string(optional)This parameter allows filtering price levels based on the following criteria. The format for the filter mask is:
?filter=foo=1,baz=2,...-
event_id(int, optional) - The ID of the event to retrieve price levels for. If not provided, all price levels for all events will be returned. -
parent_id(int, optional) - The ID of a price level to retrieve its children. -
hide_online(bool, optional) - A flag to filter price levels hidden from online sales. When set totrue, the response will include only price levels hidden from online sales. -
hide_box_office(bool, optional) - A flag to filter price levels hidden from BoxOffice sales. When set totrue, the response will include only price levels hidden from BoxOffice sales.
-
Price Level ¶
GET /price_levels/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"parent_id": {
"type": "integer"
},
"price_breakdown": {
"type": "object",
"optional": true,
"structure": {
"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"
}
}
}
}
},
"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 price levelGET/price_levels/{id}
Note: attributes with "optional": true will only be returned if they are set via the optional url parameter, e.g. /api/price_levels/{id}?optional[]=field
URI Parameters
- id
string(required)Price Level ID
PATCH /price_levels/id
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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"
}
},
"parent_id": {
"type": "integer"
},
"price_breakdown": {
"type": "object",
"optional": true,
"structure": {
"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"
}
}
}
}
},
"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"
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"parent_id": {
"type": "integer"
},
"price_breakdown": {
"type": "object",
"optional": true,
"structure": {
"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"
}
}
}
}
},
"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 /price_levels/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
},
"parent_id": {
"type": "integer"
},
"price_breakdown": {
"type": "object",
"optional": true,
"structure": {
"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"
}
}
}
}
},
"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"
}
}
}
}Scanner Statuses ¶
Scanner Statuses ¶
POST /scanner-statuses
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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": []
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 statusPOST/scanner-statuses
Note: id should be omitted or null for this request
GET /scanner-statuses
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 statusesGET/scanner-statuses
Scanner Status ¶
GET /scanner-statuses/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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": []
}
}PATCH /scanner-statuses/id
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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": []
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 statusPATCH/scanner-statuses/{id}
URI Parameters
- id
string(required)Scanner Status ID
DELETE /scanner-statuses/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 statusDELETE/scanner-statuses/{id}
URI Parameters
- id
string(required)Scanner Status ID
Venues ¶
Venues ¶
POST /venues
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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"
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 venuePOST/venues
Note: id should be omitted or null for this request
GET /venues
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 venuesGET/venues
Venue ¶
GET /venues/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
}
}
}PATCH /venues/id
Requests
Headers
Accept: application/vnd.api+jsonBody
{
"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"
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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 /venues/id
Requests
Headers
Accept: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+jsonBody
{
"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"
}
}
}
}Generated by aglio on 14 Feb 2025