Tonic CheckIn API (1.0)

Download OpenAPI specification:Download

Tonic CheckIn API

API to allow clients to checkin

Check In

header Parameters

authorization

required

string

Contains bearer followed by bearer token

Request Body schema: application/json

required	Array of objects
async	boolean Whether to be proccessed on queue or not. Note when using async you will not recieve a confirmation of ticket being chacked in.

Responses

Request samples

Payload

Content type

application/json

{"tickets": [{"ticket_id": "627e095671209038d339a182.627cb97471209027347177dc.2",
"device_name": "Sweden",
"time": "2022-11-11 10:00:00",
"source": "designmynight-ticket-scanner"
},
{"ticket_id": "627e095671209038d339a182.627cb97471209027347177dc.1",
"device_name": "Another",
"time": "2023-11-11 10:00:00",
"source": "designmynight-ticket-scanner"
}
],
"async": false
}

Response samples

Content type

application/json

Example

Successful check in

{"check_ins": [[{"_id": "627e095671209038d339a184",
"result": "success",
"ticket": {"_id": "627e095671209038d339a184",
"reference": "DMN-7930721728-176",
"guest_name": "Adina Macovei",
"guest_email": "adina.macovei@theaccessgroup.com",
"checked_in": {"date": "2023-11-11 10:00:00.000000",
"timezone_type": 3,
"timezone": "Europe/London"
},
"checked_in_by": "5cac72c02cfe5f6cd1437823",
"check_in_device_name": "Another",
"check_in_source": "designmynight-ticket-scanner"
}
},
{"_id": "627e095671209038d339a185",
"result": "success",
"ticket": {"_id": "627e095671209038d339a185",
"reference": "DMN-7930721728-177",
"guest_name": "Adina Macovei",
"guest_email": "adina.macovei@theaccessgroup.com",
"checked_in": {"date": "2022-11-11 10:00:00.000000",
"timezone_type": 3,
"timezone": "Europe/London"
},
"checked_in_by": "5cac72c02cfe5f6cd1437823",
"check_in_device_name": "Sweden",
"check_in_source": "designmynight-ticket-scanner"
}
}
]
]
}

Check Out

header Parameters

authorization

required

string

Contains bearer followed by bearer token

Request Body schema: application/json

required	Array of objects
async	boolean

Responses

Request samples

Payload

Content type

application/json

{"tickets": [{"ticket_id": "627e095671209038d339a182.627cb97471209027347177dc.2",
"device_name": "Sweden",
"time": "2022-11-11 10:00:00",
"source": "designmynight-ticket-scanner"
},
{"ticket_id": "627e095671209038d339a182.627cb97471209027347177dc.1",
"device_name": "Another",
"time": "2023-11-11 10:00:00",
"source": "designmynight-ticket-scanner"
}
],
"async": false
}

Response samples

Content type

application/json

{"check_outs": [[{"_id": "63f49900880ea0322d362f62",
"reference": 984,
"checked_in": null
}
]
]
}

Get Event Occurrences

path Parameters

event

required

string

Example: 60001c4569308525d873cbd7

Event ID

query Parameters

item_date_from required	string <date> 2023-01-21 Event Date From
item_date_to required	string <date> Example: item_date_to=2023-04-21 Event Date To

header Parameters

authorization

required

string

Contains bearer followed by bearer token

Responses

Response samples

Content type

application/json

{"data": [{"occurrence_date": "string",
"occurrence_start": "string",
"occurrence_end": "string",
"on_sale": true,
"is_cancelled": true,
"nice_date": "string",
"max_total_tickets": 0,
"total_sales_tickets": 0,
"sold_out": true
}
],
"responseTime": "string"
}

Update Purchase

Update details of the purchase

path Parameters

purchase_id

required

string

ID of the purchase.

Request Body schema: application/json

comments

string

Responses

Request samples

Payload

Content type

application/json

{"comments": "string"
}

Response samples

Content type

application/json

{"data": {"_id": "63e5021d71b7bd01533704c1",
"created_date": "2023-02-09 14:24:29",
"last_updated": "2023-04-18 11:24:41",
"purchase_id": 8872358517,
"user_id": "614afd255390f807265d7662",
"total_cost": 143.1,
"items": [{"_id": "63e5021d71b7bd01533704c6",
"name": "test final ticket list and daily sales",
"sub_type": "63e501a871b7bd000963c86e",
"sub_type_name": "test another ticket",
"multi_day_ticket": false,
"quantity": 3,
"unit_price": 45,
"admin_fee": 2.7,
"admin_fee_source": "Region",
"admin_fee_absorbed": 0,
"dmn_commission": 0,
"dmn_commission_amount_source": "Default",
"dmn_commission_percentage_source": "Default",
"ticket_list": [{"_id": "63e5021d71b7bd01533704c3",
"reference": 875,
"checked_in": null
},
{"_id": "63e5021d71b7bd01533704c4",
"reference": 876,
"checked_in": null
},
{"_id": "63e5021d71b7bd01533704c5",
"reference": 877,
"checked_in": null
}
],
"purchase_item_type": "ticket",
"currency": "GBP"
}
],
"payments": [{"processor": "STRIPE",
"vendor_name": "wflmedialtd",
"status": "OK",
"payment_for": "purchase",
"description": "3 x test another ticket on 09/02/2023",
"statement_descriptor_suffix": "testfinalticketli",
"amount": 143.1,
"currency": "GBP",
"payment_method_id": "pm_1MZb3GDK5dphsmtEeeBalntq",
"payment_intent_id": "pi_3MZb3HDK5dphsmtE0zbDzEpK",
"payment_intent_secret": "pi_3MZb3HDK5dphsmtE0zbDzEpK_secret_I3hywSUgt7YXNjJLQuebR50cC",
"_id": "63e5022b4b7030069f43bf06",
"payment_ref": "ch_3MZb3HDK5dphsmtE0lCv3lde",
"refundable_amount": 143.1,
"address": [ ],
"cardholder_name": null,
"card_type": "visa",
"card_funding": "credit",
"card_country": "US",
"card_suffix": "4242"
}
],
"source": "designmynight",
"status": "complete",
"currency": "GBP",
"item_id": "63e501fd71b7bd0010365069",
"item_date": "2023-02-09 00:00:00",
"tracking_id": "63e5021d71b7bd01533704c7",
"reservation_details": {"reservation_start_time": "2023-02-09 14:24:29",
"reservation_end_time": "2023-02-09 14:32:29"
},
"redeem_points_cash": 0,
"token": "ldx6y4wja9vgyel3joa",
"email": "adina.macovei@theaccessgroup.com",
"phone": "1244546459",
"address": {"first_name": "Adina",
"last_name": "Macovei"
},
"completed_date": "2023-02-09 14:24:46",
"finalised": {"$date": {"$numberLong": "1675952690000"
}
},
"emails_sent": {"confirmation": "2023-02-09T14:24:54+00:00"
},
"bank_transfer_record": {"_id": {"$oid": "63eb19060a62646108221216"
},
"credit_date": {"$date": {"$numberLong": "1676419200000"
}
},
"invoice_frequency": "standard"
},
"comments": null,
"item": {"_id": "63e501fd71b7bd0010365069",
"created_date": "2023-02-09 14:23:57",
"last_updated": "2023-02-10 02:00:17",
"created_by": "614afd255390f807265d7662",
"path": "/be-at-one-test-venue/test-final-ticket-list-and-daily-sales",
"title": "test final ticket list and daily sales",
"slug": "test-final-ticket-list-and-daily-sales",
"content": "<p>test final ticket sales and daily sales</p>",
"venue": "58f75ec87c75752a813dc8c2",
"venue_group_restricts_download_reports": false,
"list_on_designmynight": true,
"send_products_email": true,
"no_cross_promotion": true,
"reviews_enabled": true,
"reviews_still_display": false,
"refunds_enabled": true,
"sales_approved": false,
"payments_blocked": false,
"self_check_in": false,
"send_activation_link_immediately": false,
"is_online_event": false,
"include_url_on_confimation_email": false,
"minimum_age": "Over 18",
"date": "2023-02-09 00:00:00",
"start_time": "19:00",
"end_time": "22:00",
"venue_dbp": false,
"is_cancelled": false,
"promoter_or_hiring_venue": false,
"cheapest_available_ticket_price": 45,
"most_expensive_available_ticket_price": 45,
"status": "public",
"region": "512b1ebad5d190d2978c277e",
"last_edited": {"user_id": {"$oid": "614afd255390f807265d7662"
},
"user_email": "adina.macovei@theaccessgroup.com",
"user_name": "Adina Macovei",
"date": {"$date": {"$numberLong": "1675952637356"
}
}
},
"type": "event",
"show_waiting_list": false,
"enable_zapier_integration": false,
"waiting_list_lead_photo_enabled": false,
"use_venue_photos": false,
"photos": [ ],
"sell_until": 0,
"notification_email": "adina.macovei@theaccessgroup.com",
"payment_notification_email": "adina.macovei@theaccessgroup.com",
"daily_sales_report_recipient": "adina.macovei@theaccessgroup.com",
"accept_reps": false,
"accept_all_reps": false,
"corporate_card_fee_disabled": true,
"marketing_opt_in_default": false,
"comments_required": false,
"send_payment_email": true,
"phone_number_mandatroy": false,
"ticket_types": [{"created_date": "2023-02-09 14:23:57",
"status": "public",
"id": "63e501a871b7bd000963c86e",
"deleted": false,
"price": 45,
"admin_fee_absorbed": 0,
"delivery_required": false,
"ticket_type": "test another ticket",
"max_ticket_sales": 110,
"fixed_ticket_quantities_per_purchase": [ ],
"custom_ticket_labels": [ ],
"date_restriction": null
}
],
"require_named_tickets": false,
"require_email_tickets": false,
"require_guest_phone": false,
"is_reservation_enabled": true,
"reservation_duration_in_seconds": 480,
"display_vat": false,
"ticket_type_vat_rate": "uk_standard",
"product_type_vat_rate": "uk_standard",
"tickets_available_at_door": false,
"require_time_slot_selection": false,
"hide_sold_out_tickets": false,
"skip_sold_out_dates": false,
"hide_urgency_message": false,
"require_tickets_printed": false,
"terms_and_conditions": "<p>1. The ticket holder voluntarily assumes all risks and danger incidental to the event for which the ticket is issued, whether occurring prior, during or after the event. The ticket holder voluntarily agrees that the management, venue, event participants, DesignMyNight (WFL Media Ltd) and all of their respective agents, officers, directors, owners and employers are expressly released by the ticket holder from any claims arising from such causes. \n2. Tickets are issued subject to the rules and regulations of the venue.\n3. Please check your tickets, as mistakes cannot always be rectified.\n4. Occasionally, events are cancelled or postponed by the promoter, team, performer or venue for a variety of reasons. If the event is cancelled, please contact us for information on receiving a refund from the responsible party. If the event was moved or rescheduled, the venue or promoter may set refund limitations. It is your responsibility to ascertain the date and time of any rearranged event.\n5. The venue reserves the right to refuse admission and may on occasion have to conduct security searches to ensure the safety of the patrons.\n6. Every effort to admit latecomers will be made at a suitable break in the event, but admission cannot always be guaranteed.\n7. We regret that tickets cannot be exchanged or refunded after purchase.\n8. Tickets are sold subject to the venue or promoter's right to alter or vary the programme due to events or circumstances beyond its control without being obliged to refund monies or exchange tickets.\n9. If this ticket is re-sold or transferred for profit or commercial gain by anyone other than the promoter, venue management, DesignMyNight or one of their authorised sub-agents, it will become voidable and the holder may be\nrefused entry to or ejected from the venue.\n10. The venue may operate a No Smoking Policy.\n11. The promoter, venue management and DesignMyNight accept no responsibility for any personal property.\n12. The event listed on the purchased ticket is strictly for ticket holders who are over 18 years of age. Identification may be required.</p>",
"hide_sell_until": false,
"apply_sell_until_to_tickets": false,
"disable_credit_cards": false,
"type_of_event": [{"_id": "58108737e947445532913e15",
"label": "Activity"
}
],
"customer_contact_email": "adina.macovei@theaccessgroup.com",
"organiser_name": "test",
"summary_box_enabled": true,
"vat_number": false,
"vat_company": false,
"bank_details": "slmAnj524cEvaEb4Y5o8QrjEKsVOaXB7I8A82tpG1Xw=:IJWHRTj9Cww9EiA+5uTANVuJ+aC0911ZsL381ivckRA=:AZDtl6mWeenPVum8P4Kehw==:EW5lCHYFyhJQmylRsLyUdIsOU+fOxcHQjz+Eoi2ZOxG+iLOiCt3XyGFKmZwYeTNis5UPkQjyFL1z6pmCduF8HExcfxX/geQtUWRn8bQMXTxOCKOpg0h2r/zXB8/SPvgGy8r4w5mGqsrCQEXJTl9t3Q==",
"vat_on_commission": false,
"reclaim_booking_fees": true,
"currency": "GBP",
"timezone": "Europe/London",
"country_code": "GBR",
"use_short_barcode": true,
"food_available": false,
"use_venue_food_menu": false,
"send_daily_sales_report": true,
"disable_ticket_confirmation_emails": false,
"disable_attendee_list_emails": false,
"use_partner_ticket_codes": false,
"final_occurrence": "2023-02-09 19:00:00",
"next_date": null,
"is_sold_out": true,
"occurrences": [{"sent_ticket_list": true
}
],
"daily_sales_report_last_sent": {"$date": {"$numberLong": "1675988696000"
}
},
"prev_date": "2023-02-09 19:00:00",
"custom_venue": null,
"recurrence": null,
"management_comments": [ ],
"checkout_questions": [ ]
},
"checkout_questions": [ ],
"refund_request": [ ]
},
"responseTime": "2023-04-18T11:24:41+01:00"
}