Tickets Methods
Methods
Lookup Tickets
Retrieves the tickets for the specified locations filtered by given query.
POST /pos/v2/lookup/tickets
Note: This feature currently is available only for SkyTab POS, all the rest POS systems are not supported.
Examples of Responses with different properties
Example 1 Some properties are present in filter
Request Body (required)
Content-Type: application/json
{
"filter": {
"refs": [
{
"locationId": 0,
"posRef": "string"
}
]
},
"properties": [
{
"name": "type"
},
{
"name": "posRef"
},
{
"name": "locationId"
}
]
}
Response 200
{
"results": [
{
"type": "sale",
"posRef": "string",
"locationId": "string"
}
]
}
Example 2 All properties are present in filter
Request Body (required)
Content-Type: application/json
{
"filter": {
"refs": [
{
"locationId": 0,
"posRef": "string"
}
]
},
"properties": [
{
"name": "posRef"
},
{
"name": "type"
},
{
"name": "voidReason"
},
{
"name": "customerName"
},
{
"name": "customerRef"
},
{
"name": "orderTypename"
},
{
"name": "orderNumber"
},
{
"name": "revenueCenterName"
},
{
"name": "tableName"
},
{
"name": "guestCount"
},
{
"name": "totalItems"
},
{
"name": "totalSurcharges"
},
{
"name": "totalTax"
},
{
"name": "totalGrand"
},
{
"name": "totalTips"
},
{
"name": "totalDiscounts"
},
{
"name": "totalGratuities"
},
{
"name": "metadata",
"properties": [
{
"name": "string"
},
{
"value": "string"
},
{
"type": "STRING"
}
]
},
{
"name": "openedAt"
},
{
"name": "openedByEmployee"
},
{
"name": "openedByEmployeeRef"
},
{
"name": "closedAt"
},
{
"name": "closedByEmployee"
},
{
"name": "closedByEmployeeRef"
},
{
"name": "locationId"
},
{
"name": "orderTypeRef"
},
{
"name": "tableRef"
},
{
"name": "displayTaxTotal"
},
{
"name": "onlineOrderAppRef"
},
{
"name": "onlineOrderAppKey"
},
{
"name": "saleTicketParentRef"
},
{
"name": "splitTicketParentRef"
},
{
"name": "combinedTicketParentRef"
},
{
"name": "ticketItems",
"properties": [
{
"name": "posRef"
},
{
"name": "type"
},
{
"name": "voidReason"
},
{
"name": "name"
},
{
"name": "itemRef"
},
{
"name": "revenueClassRef"
},
{
"name": "isNonSalesRevenue"
},
{
"name": "departmentName"
},
{
"name": "quantity"
},
{
"name": "unitPrice"
},
{
"name": "itemAmount"
},
{
"name": "modifierAmount"
},
{
"name": "discountAmount"
},
{
"name": "price"
},
{
"name": "tax"
},
{
"name": "addedAt"
},
{
"name": "displayPrice"
},
{
"name": "specialRequests"
},
{
"name": "kitchenSentAt"
},
{
"name": "isOnHold"
},
{
"name": "departmentRef"
},
{
"name": "item",
"properties": [
{
"name": "posRef"
},
{
"name": "name"
},
{
"name": "price"
},
{
"name": "isOpenItem"
}
]
},
{
"name": "ticketItemModifiers",
"properties": [
{
"name": "posRef"
},
{
"voidReason": "type"
},
{
"name": "name"
},
{
"name": "resourceType"
},
{
"name": "itemRef"
},
{
"name": "revenueClassRef"
},
{
"name": "isNonSalesRevenue"
},
{
"name": "modifierRef"
},
{
"name": "quantity"
},
{
"name": "unitPrice"
},
{
"name": "price"
},
{
"name": "addedAt"
},
{
"name": "specialRequests"
}
]
},
{
"name": "ticketItemDiscounts",
"properties": [
{
"name": "posRef"
},
{
"name": "name"
},
{
"name": "amount"
},
{
"name": "addedAt"
}
]
},
{
"name": "ticketItemTaxes",
"properties": [
{
"name": "taxRef"
},
{
"name": "name"
},
{
"name": "amount"
},
{
"name": "isFlat"
},
{
"name": "rate"
},
{
"name": "isHidden"
}
]
}
]
},
{
"name": "ticketDiscounts",
"properties": [
{
"name": "posRef"
},
{
"name": "name"
},
{
"name": "amount"
},
{
"name": "addedAt"
}
]
},
{
"name": "ticketPayments",
"properties": [
{
"name": "posRef"
},
{
"name": "type"
},
{
"name": "tenderName"
},
{
"name": "cardType"
},
{
"name": "amount"
},
{
"name": "tipAmount"
},
{
"name": "total"
},
{
"name": "addedAt"
}
]
},
{
"name": "ticketSurcharges",
"properties": [
{
"name": "posRef"
},
{
"name": "name"
},
{
"name": "surchargeAmount"
},
{
"name": "discountAmount"
},
{
"name": "price"
},
{
"name": "tax"
},
{
"name": "addedAt"
},
{
"name": "ticketDiscounts",
"properties": [
{
"name": "posRef"
},
{
"name": "name"
},
{
"name": "amount"
},
{
"name": "addedAt"
}
]
}
]
},
{
"name": "ticketGratuities",
"properties": [
{
"name": "posRef"
},
{
"name": "name"
},
{
"name": "amount"
},
{
"name": "price"
},
{
"name": "type"
},
{
"name": "addedAt"
}
]
},
{
"name": "ticketTaxes",
"properties": [
{
"name": "taxRef"
},
{
"name": "amount"
}
]
}
]
}
Response 200
Returns a collection of Ticket objects
{
"results": [
{
"posRef": "string",
"type": "sale",
"voidReason": "string",
"customerName": "string",
"customerRef": "string",
"orderTypeName": "string",
"orderNumber": "string",
"revenueCenterName": "string",
"tableName": "string",
"guestCount": 0,
"totalItems": 0,
"totalSurcharges": 0,
"totalTax": 0,
"totalGrand": 0,
"totalTips": 0,
"totalDiscounts": 0,
"totalGratuities": 0,
"metadata": [
{
"name": "string",
"value": "string",
"type": "STRING"
}
],
"openedAt": "2025-06-04T12:38:47.664Z",
"openedByEmployee": "string",
"openedByEmployeeRef": "string",
"closedAt": "2025-06-04T12:38:47.664Z",
"closedByEmployee": "string",
"closedByEmployeeRef": "string",
"locationId": 0,
"orderTypeRef": "string",
"tableRef": "string",
"displayTaxTotal": 0,
"onlineOrderAppRef": "string",
"onlineOrderAppKey": "string",
"saleTicketParentRef": "string",
"splitTicketParentRef": "string",
"combinedTicketParentRef": "string",
"ticketItems": [
{
"posRef": "string",
"type": "sale",
"voidReason": "string",
"name": "string",
"itemRef": "string",
"revenueClassRef": "string",
"isNonSalesRevenue": true,
"departmentName": "string",
"quantity": 0,
"unitPrice": 0,
"itemAmount": 0,
"modifierAmount": 0,
"discountAmount": 0,
"price": 0,
"tax": 0,
"addedAt": "2025-06-04T12:38:47.666Z",
"upc": "string",
"displayPrice": "string",
"specialRequests": [
"string"
],
"kitchenSentAt": "string",
"isOnHold": true,
"departmentRef": "string",
"item": {
"posRef": "string",
"name": "string",
"price": 0,
"isOpenItem": true
},
"ticketItemModifiers": [
{
"posRef": "string",
"type": "sale",
"voidReason": "string",
"name": "string",
"resourceType": "item",
"itemRef": "string",
"revenueClassRef": "string",
"isNonSalesRevenue": true,
"modifierRef": "string",
"quantity": 0,
"unitPrice": 0,
"price": 0,
"addedAt": "2025-06-04T12:38:47.666Z",
"specialRequests": [
"string"
]
}
],
"ticketItemDiscounts": [
{
"posRef": "string",
"name": "string",
"amount": 0,
"addedAt": "2025-06-04T12:38:47.666Z"
}
],
"ticketItemTaxes": [
{
"taxRef": "string",
"name": "string",
"amount": 0,
"isFlat": true,
"rate": 0,
"isHidden": true
}
]
}
],
"ticketDiscounts": [
{
"posRef": "string",
"name": "string",
"amount": 0,
"addedAt": "2025-06-04T12:38:47.666Z"
}
],
"ticketPayments": [
{
"posRef": "string",
"type": "string",
"tenderName": "string",
"cardType": "string",
"amount": 0,
"tipAmount": 0,
"total": 0,
"addedAt": "2025-06-04T12:38:47.666Z"
}
],
"ticketSurcharges": [
{
"posRef": "string",
"name": "string",
"surchargeAmount": 0,
"discountAmount": 0,
"price": 0,
"tax": 0,
"addedAt": "2025-06-04T12:38:47.666Z",
"ticketDiscounts": [
{
"posRef": "string",
"name": "string",
"amount": 0,
"addedAt": "2025-06-04T12:38:47.666Z"
}
]
}
],
"ticketGratuities": [
{
"posRef": "string",
"name": "string",
"amount": 0,
"price": 0,
"type": "auto",
"addedAt": "2025-06-04T12:38:47.666Z"
}
],
"ticketTaxes": [
{
"taxRef": "string",
"amount": 0
}
]
}
],
"meta": {}
}
Response 400
If already associated with another partner identifier or partner identifier already associated with another rid
{
"message": "string",
"success": false
}
Response 401
Client is not authorized to access this resource
{
"message": "string",
"success": false
}
Response 5XX
Returns in the unexpected case
{
"message": "string",
"success": false
}
Models
- Ticket V2
- TicketSurcharge
- TicketPayment
- TicketDiscount
- TicketGratuity
- TicketTax
- TicketItem V2
- TicketItemModifier V2
- TicketMetadata
Important: This endpoint returns only the historical tickets.
Retrieve Tickets
Retrieve a specific location tickets for a given time frame.
GET /pos/v2/{locationId}/tickets
Query Parameters
| Name | Type | Description |
|---|---|---|
| metadata | array | Set of additional metadata properties to retrieve defined as an array. |
| filter | object | Set of search parameters. They can be defined as a URI parameters or JSON object |
| filter.dateTimeFrom | string | date from in ISO 8601 format, e.g., 2007-03-01T00:00:00Z |
| filter.dateTimeTo | string | date to in ISO 8601 format, e.g., 2007-03-01T23:59:59Z |
Response 200
Returns a collection of Ticket objects
{
"results": [
{
"posRef": "string",
"type": "sale",
"voidReason": "string",
"customerName": "string",
"customerRef": "string",
"orderTypeName": "string",
"orderNumber": "string",
"revenueCenterName": "string",
"tableName": "string",
"guestCount": 0,
"totalItems": 0,
"totalSurcharges": 0,
"totalTax": 0,
"totalGrand": 0,
"totalTips": 0,
"totalDiscounts": 0,
"totalGratuities": 0,
"metadata": [
{
"name": "string",
"value": "string",
"type": "STRING"
}
],
"openedAt": "2025-06-04T12:38:47.727Z",
"openedByEmployee": "string",
"openedByEmployeeRef": "string",
"closedAt": "2025-06-04T12:38:47.727Z",
"closedByEmployee": "string",
"closedByEmployeeRef": "string",
"ticketItems": [
{
"posRef": "string",
"type": "sale",
"voidReason": "string",
"name": "string",
"itemRef": "string",
"revenueClassRef": "string",
"isNonSalesRevenue": true,
"departmentName": "string",
"quantity": 0,
"unitPrice": 0,
"itemAmount": 0,
"modifierAmount": 0,
"discountAmount": 0,
"price": 0,
"tax": 0,
"addedAt": "2025-06-04T12:38:47.727Z",
"upc": "string",
"ticketItemModifiers": [
{
"posRef": "string",
"type": "sale",
"voidReason": "string",
"name": "string",
"resourceType": "item",
"itemRef": "string",
"revenueClassRef": "string",
"isNonSalesRevenue": true,
"modifierRef": "string",
"quantity": 0,
"unitPrice": 0,
"price": 0,
"addedAt": "2025-06-04T12:38:47.727Z"
}
],
"ticketItemDiscounts": [
{
"posRef": "string",
"name": "string",
"amount": 0,
"addedAt": "2025-06-04T12:38:47.727Z"
}
],
"ticketItemTaxes": [
{
"taxRef": "string",
"name": "string",
"amount": 0,
"isFlat": true,
"rate": 0,
"isHidden": true
}
]
}
],
"ticketDiscounts": [
{
"posRef": "string",
"name": "string",
"amount": 0,
"addedAt": "2025-06-04T12:38:47.727Z"
}
],
"ticketPayments": [
{
"posRef": "string",
"type": "string",
"tenderName": "string",
"cardType": "string",
"amount": 0,
"tipAmount": 0,
"total": 0,
"addedAt": "2025-06-04T12:38:47.727Z"
}
],
"ticketSurcharges": [
{
"posRef": "string",
"name": "string",
"surchargeAmount": 0,
"discountAmount": 0,
"price": 0,
"tax": 0,
"addedAt": "2025-06-04T12:38:47.727Z",
"ticketDiscounts": [
{
"posRef": "string",
"name": "string",
"amount": 0,
"addedAt": "2025-06-04T12:38:47.727Z"
}
]
}
],
"ticketGratuities": [
{
"posRef": "string",
"name": "string",
"amount": 0,
"price": 0,
"type": "auto",
"addedAt": "2025-06-04T12:38:47.727Z"
}
],
"ticketTaxes": [
{
"taxRef": "string",
"amount": 0
}
]
}
],
"meta": {}
}
Models