Add Ticket Endpoint
An existing Tixstock broker creates a listing on a reseller website, or the Reseller wishes to upload the Broker’s inventory to Tixstock. The Add Ticket Endpoint should be used to create the listings on Tixstock.
Endpoint URL
https://api.tixstock.com/v1/tickets/add/{external_id}
Authorisation
| Authorisation |
Description |
| Bearer Token |
A valid bearer token must be provided within the header parameters for the API request. To generate an access token, please see your API settings from within the Tixstock Reseller Admin Area. |
Please see 'Authentication - Bearer Tokens' for further information
Request Data
The supplied data must adhere to the following ruleset:
The Resellers listing ID (external ID) is required to save the listing and should be passed in the URL. The external ID must be unique. If a listing has already been added to the system with the same ID, an error will be outputted.
| Parameter |
Description |
|
broker_id
*
|
A valid Broker ID must be supplied by the Reseller matching the supplied ID provided with the Broker authentication webhook. The Tixstock Brokers team must be active for Tixstock to process the listing..
Type: String
|
|
event_id
*
|
A valid Event ID must be supplied
Type: String |
|
ticket
*
|
|
general_admission
*
|
Whether the listing is General Admission (GA).
Type: Boolean |
|
type
*
|
Paper, eTicket, Mobile, Members / Season Card
Type: String |
|
split_type
*
|
No Preferences, All Together, Avoid Leaving One Ticket, Sell In Multiples
Type: String |
|
eticket
|
Type: Array
Required: Yes, if ticket type is eTicket or Mobile.
|
|
upload_later
*
|
Type: Boolean
Required: Yes, if the ticket type is eTicket or Mobile
|
|
files
*
|
Type: Array
Required: Yes, Upload later is false, and ticket type is eTicket.
|
|
row
|
Type: String
|
|
seat
|
Type: Integer
|
|
file
*
|
Type: Base64 encoded PDF
Required
|
|
|
|
allow_last_minute_sales
*
|
Whether the listing support last minute sales.
Type: Boolean
|
|
|
number_of_tickets_for_sale
*
|
|
quantity
*
|
The number of available tickets for sale.
Type: Integer
|
|
split_quantity
*
|
Must be set to 0 if split type is either: No Preferences, All Together, Avoid Leaving One Ticket
If split type is set to ‘Sell In Multiples’, the split quantity must equal or be less than the Quantity and greater than 0. This must be divisible by the quantity set.
Type: Integer
|
|
display_quantity
*
|
The display quantity for the listing.
Must equal or be less than the quantity and greater than 0.
Type: Integer
|
|
|
price
*
|
|
currency
*
|
The proceed price currency in ISO-4217 format for the listing.
Supported listing currencies: GBP,EUR,USD
Type: String
|
|
amount
*
|
Type: Two place decimal
Min 0.01
Max: 999999.99
|
|
|
face_value
*
|
|
currency
*
|
The face value currency in ISO-4217 format for the listing.
Supported listing currencies: GBP,EUR,USD
Type: String
|
|
amount
*
|
Type: Two place decimal
Min 0.01
Max: 999999.99
|
|
|
display_price
*
|
|
currency
*
|
The display price currency in ISO-4217 format for the listing.
This is the currency that the listing is being sold in on the resellers exchange. This must match the correct event currency assigned to the resellers event.
Type: String
|
|
amount
*
|
Type: Two place decimal
Min 0.01
Max: 999999.99
|
|
|
seat_details
*
|
The listings seat details are required if General Admission is set to false.
It is required that the ‘category’ and ‘section’ matches the venue details assigned to the resellers event.
|
|
category
*
|
The seating category name for the listing.
Type: String
|
|
section
|
The seating section name for the listing.
Type: String
|
|
row
|
The seating row for the listing.
Type: String
|
|
first_seat
|
The first seat number for the listing.
Type: String
|
|
|
restrictions_benefits
*
|
|
|
delivery
*
|
|
shipped_date_or_date_in_hand
|
Type: Date in ISO-8601 UTC Format
Example: 2020-03-10
The date must be within 10 days of the event date for Paper and Members / Season Card Ticket Types.
For eTicket and Mobile Ticket Types the date must be on or before the event date.
If the date isn't supplied Tixstock will default it to the event date.
|
|
type
*
|
Allowed values:
- UPS
- SHIPPING
- BARCODE
- PDF
- LMS
- FEDEX
- STH
- ROYALMAIL
- DEUTSCHEPOST
- WILLCALL
- FLASHSEAT
- MOBILETRANSFER
- MOBILE
- LOCALDELIVERY
-
If the Ticket Type is eTicket the Delivery should set to PDF.
|
|
hand_delivered
*
|
Type: Boolean
|
|
|
push_to_all
|
If value 1 then listing will also push to other resellers of this broker
Type: Boolean (0 or 1) |
API Response:
Please note, the example shown below displays no base64 PDF file and venue details empty. This data would be returned in a real api response.
{
"data": {
"id": "9211231",
"broker_id": "123123",
"ticket": {
"general_admission": "true",
"type": "eTicket",
"allow_last_minute_sales": "true",
"split_type": "No Preferences",
"etickets": [
{
"row": "B",
"seat": "11",
"file": "base64 encoded pdf"
}
],
"upload_later": "false"
},
"number_of_tickets_for_sale": {
"quantity_available": 1,
"quantity_sold": 0,
"display_quantity": 1,
"split_quantity": 0
},
"seat_details": {
"category": "Stalls",
"section": "Stalls",
"row": "B",
"first_seat": "11"
},
"face_value": {
"currency": "USD",
"amount": "205.00"
},
"display_price": {
"currency": "EUR",
"price": "215.00"
},
"proceed_price": {
"currency": "GBP",
"amount": "185.00"
},
"restrictions_benefits": {
"options": [
"18's only"
],
"other": "Other Restriction"
},
"delivery": {
"type": "UPS",
"hand_delivered": "true",
"shipped_date_or_date_in_hand": "2020-03-10"
},
"event": {
"id": "4739302",
"name": "Jimmy Carr Dorking",
"currency": "GBP",
"commission_percentage_fee": "10.00",
"description": "Jimmy Carr Dorking",
"datetime": "2020-06-27T13:46:40+0000",
"status": "Active",
"map_url": "https://upload.wikimedia.org/wikipedia/commons/8/81/AngelStadiumSchematic.svg",
"venue": {
"name": "Dorking Halls",
"address_line_1": "",
"address_line_2": "",
"city": "Dorking",
"state": "SRY",
"postcode": "RH4 1SG",
"country_code": "GB"
},
"use_tixstock_venue_details": "false",
"venue_details": [],
"performers": [
{
"id": "10040",
"name": "Jimmy Carr"
}
]
},
"published_date": "2020-03-10T11:25:04+0000",
"proof_of_purchase": "",
"published": "true"
},
"meta": {
"mode": "Production",
"type": "ticket.create",
"listing_id": "9211231",
"broker_id": "123123",
"event_id": "9123123",
"request_id": "01e3231szsjkw3vtvmrwvaext6"
},
"message": "Ticket(s) successfully added."
}
