get https://app.itsacheckmate.com/reporting/v1/dim_tickets?location_ids=4089&from_timestamp=2023-06-29 17:25:00&to_timestamp=2023-06-30 17:25:00
Contains information on tickets/orders received.
Log in to see full request history
Tickets API
The Tickets API returns detailed information about individual tickets and orders received. This data is essential for managing customer orders and analyzing sales performance.
Example Response
After a successful call, the API will return a response similar to the below structure.
[
{
"ticket_id": 321262762,
"location_id": 236291,
"order_number": "6C41D",
"order_source": "uber",
"alt_order_number": null,
"customer_name": "Wilmotlyn R.",
"quantity": 1.0,
"discount": 0.0,
"tax": 1.49,
"web_tax": 1.72,
"subtotal": 14.87,
"web_subtotal": 17.18,
"created_at": "2023-06-29T19:47:13.269Z",
"updated_at": "2023-06-29T19:47:15.718Z",
"closed_at": "2023-06-29T19:47:15.224Z",
"order_payload_id": 82329870,
"pos_id": 328003757,
"pos_check_id": "743305994",
"external_store_id": "4089"
}
]
Field Descriptions
| Field Name | Description |
|---|---|
ticket_id | Unique identifier for the ticket. |
location_id | Identifier for the restaurant location. |
order_number | Unique identifier for the order. |
order_source | Platform from which the order was received (e.g., Uber). |
alt_order_number | Alternative order number, if available. |
customer_name | Name of the customer placing the order. |
quantity | Total quantity of items in the order. |
discount | Discount applied to the order, if any. |
tax | Tax amount applied to the order. |
web_tax | Tax amount applied specifically to web orders. |
subtotal | Subtotal amount of the order, excluding tax. |
web_subtotal | Subtotal amount for web orders, excluding tax. |
created_at | Timestamp when the ticket was created. |
updated_at | Timestamp when the ticket was last updated. |
closed_at | Timestamp when the ticket was closed. |
order_payload_id | Identifier for the order payload. |
pos_id | Identifier for the point-of-sale (POS) system. |
pos_check_id | Identifier for the POS check. |
external_store_id | Identifier for the external store location. |
This API is invaluable for businesses needing to track detailed order information, assess customer engagement, and refine operational processes based on ticket data.
Responses