Ticket Groups / Show - Removed
Ticket Groups / Index and Ticket Groups / Show are deprecated.
Use Listings / Index and Listings / Show instead.
Starting January 31, 2023 we will be redirecting requests to Listings but the response payload is different so it is recommended you update your applications accordingly.
Long Description
Display details for a single ticket group.
Each Ticket Group includes an available_ticket_count
property, which indicates how many tickets are currently available to sell.
Request Parameters
Name | Description | Type | Presence | Location | Other |
---|---|---|---|---|---|
ticket_group_id | The id of the individual ticket group. | Integer | Required | URI | |
ticket_list | Whether or not to include a ticket_list array with details of the individual tickets in the group | Boolean | Optional | Query |
Response Properties
Property | Details | Type | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | The unique ID of this ticket group. | Integer | ||||||||||||||||||||||||
type | Either event or parking to indicate which type of ticket this is. parking tickets do not include admission to the event but are great add-on item to suggest to a visitor purchasing event tickets | String | ||||||||||||||||||||||||
section | Indicates where seats are located. | String | ||||||||||||||||||||||||
row | String | |||||||||||||||||||||||||
available_quantity | This is how many total tickets are available from this ticket group. | Integer | ||||||||||||||||||||||||
splits | An array of the quantities that may be purchased from this ticket group. Orders for quantities that are not in this array may be rejected. If you are building a <select> element for the user to choose the quantity they wish to buy you should populate the <option> s with these values. | Array | ||||||||||||||||||||||||
wholesale_price | This is your cost for each ticket from this ticket group. When you submit an order the price you submit must be at least this much or the order will error. If you need to sell tickets below your cost you should use the discount parameter when placing your order. | Float | ||||||||||||||||||||||||
retail_price | This is wholesale_price with any inventory rules applied. you are not required to charge your customer this amount. If you wish to handle retail price calculation on your side you may. | Float | ||||||||||||||||||||||||
expected_delivery_type | This explains how it is expected that the ticket will be delivered to the Client. See the table below for more details. | String | ||||||||||||||||||||||||
format | Indicator of the format of the ticket, which also generally dictates how the tickets will be delivered to your customer.
| String | ||||||||||||||||||||||||
in_hand and in_hand_date |
If | Boolean Date | ||||||||||||||||||||||||
instant_delivery | A boolean value that indicates whether or not you can expect these tickets to be available to your Client within a few minutes of placing the order. Only Ticket Groups with an expected_delivery_type of FILE_DOWNLOAD can be Instant Delivery. | Boolean | ||||||||||||||||||||||||
public_notes | These notes should be displayed to the Client before purchasing and may include important details that may influence the buying decision. | String|null | ||||||||||||||||||||||||
featured | A boolean property used to indicate if a ticket group is considered to be “featured” based upon rules you provide. | Boolean | ||||||||||||||||||||||||
wheelchair | A boolean property used to indicate if the tickets are marked as intended to be used by wheelchair or otherwise handicapped patrons. | Boolean | ||||||||||||||||||||||||
view_type | One of: Full , Obstructed , Possibly Obstructed , or Partially Obstructed | String |
Response Properties You Should Ignore
These properties may be either deprecated or for internal use only and can generally be ignored.
Name | Description | Type | Notes |
---|---|---|---|
evopay_discount | Deprecated | Float | Deprecated |
evopay_discount_price | Deprecated | Float | Deprecated |
broadcast | Indicates if the ticket group should be broadcast | Boolean | Internal Use Only |
freshness | Used to indicate the last time this ticket group was updated | String | Deprecated |
ticket_costs | An array of the costs of each ticket in the group | Array | Deprecated |
ticket_states | Describes the various states and quantities within a ticket group | Object | Internal Use Only |
ticket_list | Contains information about the individual tickets within a ticket group | Array of Objects | Internal Use Only |
ticket_purchase_order_ids | Contains information about the purchase order for the individual tickets within a ticket group | Array | Internal Use Only |
signature | Unique string identifying this ticket group | String | Internal Use Only |
office | The office which is selling these tickets | Object | Deprecated |
ticket_hold_ids | An array of the hold IDs if any tickets form the group are currently held | Array | Deprecated |
eticket | Indicates if the tickets are in an electronic format such as PDF or a QR Code | Boolean | Deprecated |
quantity | The total number of tickets. See available_quantity to know how many may be purchased | Integer | Internal Use Only |
exchange_notes | Notes that are only shown to the B2B marketplace | String|null | Internal Use Only |
private_notes | Private notes that are only shown to the owner of the ticket group | String|null | Internal Use Only |
Examples
Request | Response |
---|---|
/v9/ticket_groups/26294236?ticket_list=true | |
{ "total_entries":25, "ticket_groups":[ { "evopay_discount":0.0, "face_value":null, "row":"TROPHY CLUB", "type":"event", "wheelchair":false, "broadcast":"t", "private_notes":null, "eticket":true, "instant_delivery":true, "freshness":"> 240 mins", "featured":false, "section":"TROPHY CLUB", "ticket_costs":[ "NULL", "NULL" ], "exchange_notes":null, "ticket_states":{ "available":2 }, "url":"/ticket_groups/26294236", "format":null, "ticket_list":[ { "purchase_order_id":0, "hold_until":"UL", "state":"available", "cost":null, "hold_id":0, "spec":null, "id":197963079, "seat":0, "eticket_id": 3124 }, { "purchase_order_id":0, "hold_until":"UL", "state":"available", "cost":null, "hold_id":0, "spec":null, "id":197963077, "seat":0, "eticket_id": null } ], "event":{ "occurs_at":"2013-07-08T08:00:00Z", "url":"/events/304289", "name":"US Senior Open Golf", "id":304289 }, "ticket_purchase_order_ids":[ "NULL", "NULL" ], "updated_at":"2013-01-09T18:29:10Z", "created_at":"2012-10-19T05:30:16Z", "in_hand":true, "wholesale_price":29.0, "signature":"c07fa6aaf213d8c484f7bf4d2a60ab89", "splits":[ 2 ], "office":{ "brokerage":{ "url":"/brokerages/507", "abbreviation":"Red Zone", "name":"Red Zone Tickets", "id":507 }, "url":"/offices/134", "name":"Main Office", "id":134 }, "view_type":null, "seats":[ ], "ticket_hold_ids":[ "NULL", "NULL" ], "quantity":2, "id":26294236, "evopay_discount_price":29.0, "retail_price":49.0, "public_notes":null, "in_hand_on":null }, { "evopay_discount":0.0, "face_value":null, "row":"GROUNDS", "type":"event", "wheelchair":false, "broadcast":"t", "private_notes":null, "eticket":false, "freshness":"> 240 mins", "featured":false, "section":"GROUNDS", "ticket_costs":[ "NULL", "NULL" ], "exchange_notes":null, "ticket_states":{ "available":2 }, "url":"/ticket_groups/26294237", "format":null, "ticket_list":[ { "purchase_order_id":0, "hold_until":"UL", "state":"available", "cost":null, "hold_id":0, "spec":null, "id":197963094, "seat":0, "eticket_id": 1234 }, { "purchase_order_id":0, "hold_until":"UL", "state":"available", "cost":null, "hold_id":0, "spec":null, "id":197963093, "seat":0, "eticket_id": null } ], "event":{ "occurs_at":"2013-07-08T08:00:00Z", "url":"/events/304289", "name":"US Senior Open Golf", "id":304289 }, "ticket_purchase_order_ids":[ "NULL", "NULL" ], "updated_at":"2013-01-09T18:29:10Z", "created_at":"2012-10-19T05:30:14Z", "in_hand":true, "wholesale_price":13.0, "signature":"5c09bdc07c69ac0f11c687648518f714", "splits":[ 2 ], "office":{ "brokerage":{ "url":"/brokerages/507", "abbreviation":"Red Zone", "name":"Red Zone Tickets", "id":507 }, "url":"/offices/134", "name":"Main Office", "id":134 }, "view_type":null, "seats":[ ], "ticket_hold_ids":[ "NULL", "NULL" ], "quantity":2, "id":26294237, "evopay_discount_price":13.0, "retail_price":33.0, "public_notes":null, "in_hand_on":null } ] } |