Introduction
This API contains SimpraPos data. For example, menu items, condiments or taxes.
Authentication
To use the API for property level, a property extension must be created from within the SimpraPos Backoffice. The access key in the extension settings is expected to be added as token in the API requests headers. All endpoints need token in headers.
Environments
| Environment | API URL | Documentation URL |
|---|---|---|
| Production | https://api.simpra.app |
https://developers.simpra.app/ |
| Uat | https://api-uat.simpra.app |
https://developers.simpra.app/uat |
| Qa | https://api-qa.simpra.app |
https://developers.simpra.app/qa |
For example returns menu items request on production environment:
GET https://api.simpra.app/menu_items
HEADERS Simpra-Access-Token: token
Checks
Get Checks
HTTP Request
GET /checks
Scope
Property
Query Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| page | 1 | ||
| per_page | 50 | ||
| business_date | Example 2019-01-21 |
||
| business_date_since | Example 2019-01-21 |
||
| business_date_until | Example 2019-01-21 |
||
| status | open, closed, cancel, draft, new or merged |
||
| sort_by | desc |
asc, desc |
|
| updated_at | 0 | This value when zero returns all checks. Format unix time. | |
| closed_at_since | 0 | This value when zero returns all checks. Format unix time. | |
| closed_at_until | 0 | This value when zero returns all checks. Format unix time. | |
| revenue_center_id | |||
| table_id |
JSON response body:
{
"meta": {
"has_next_page": true,
"current_page": 1,
"per_page_count": 50,
"total_count": 1251,
"total_page": 26
},
"checks": [
{
"alias": null,
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"created_at": 1549914523,
"updated_at": 1549939599,
"closed_at": 1549939599,
"business_date": "2019-02-11",
"female_cover": 3,
"male_cover": 2,
"child_cover": 0,
"note": null,
"sequence": 933,
"status": "closed",
"delivery_status": "delivered",
"sequential_id": 424933,
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"revenue_center": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "GardenBro"
},
"shift_id": "b7fff683-2436-41e7-8961-2ca983cc0c33",
"employee": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"first_name": "Big",
"last_name": "Bro",
"phone_number": "123456789"
},
"table": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Bro 1#"
},
"sales_channel": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "POS"
},
"customer": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"first_name": "Big",
"last_name": "Brother",
"email": "big@brothers.com",
"phone_number": "123456789"
},
"delivery": {
"address": "BigBrother No.10",
"address_id": "ff1b69b1-a7de-4a74-8483-28a539ab8d70",
"recipient": null,
"payment_names": "Cash"
},
"extras": {
"portal_plus_invoice_int_id": 9643,
"portal_plus_tckn_or_vkn": "48342912",
"portal_plus_customer_name": "Brother A.Ş.",
"portal_plus_customer_email": "",
"portal_plus_customer_tax_office": "Esentepe",
"portal_plus_customer_address": "Haberler sok. No:12",
"portal_plus_notes": "",
"portal_plus_type": "einvoice"
},
"check_service_charge": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"service_charge_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"amount": "10.5",
"tax": {
"id": "228923c8-fa07-4b77-94ca-372310cd3a3f",
"rate": 18,
"name": "Servis Ücreti"
}
},
"summary": {
"original_items_amount": "2118.64",
"original_taxes_amount": "381.36",
"complimentaries_amount": "0.0",
"discounts_amount": "600.0",
"taxes_amount": "411.86",
"service_charge_amount": "800.0",
"paid_amount": "2700.0",
"unpaid_amount": "0.0",
"paid_service_charge_amount": "0.0",
"total_amount": "2700.0",
"base_amount": "2500.0",
"offer_amount": "4.21"
},
"check_discounts": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"source": "system",
"value": "600",
"discount_amount": "10800",
"discount_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "TL İndirimi",
"type": "amount",
"annotation": "test annotation indirim"
}
],
"check_payments": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"payment_type_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"paid_amount": "700.0",
"device": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "The Great Book Pro"
},
"extras": {
"registry_no": "BB6644400",
"receipt_no": "4",
"z_no": 124
}
}
],
"check_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"parent_check_item_id": null,
"reason_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"status": "ordered",
"payment_status": "paid",
"complimentary": false,
"unit_type": "item",
"quantity": "1.0",
"notes": ["Life"],
"is_combo": false,
"summary": {
"discount_amount": "24.0",
"tax_amount": "11.59322034",
"total_amount": "76.0",
"original_amount": "100.0",
"original_tax_amount": "15.25423729"
},
"tax": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"rate": 18,
"name": "İçecek"
},
"item": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Short",
"type": "MenuItem",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
}
],
"check_offers": [
{
"id": "79ae7c2b-4356-4923-8eed-5515efac8e91",
"offer_id": "d94906e1-2260-4a37-afba-1fe5051b5cc9",
"name": "Happy Hour-1",
"value": "4.21"
}
]
}
]
}
Get Check
HTTP Request
GET /checks/:id
JSON response body:
{
"alias": null,
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"created_at": 1549914523,
"updated_at": 1549939599,
"closed_at": 1549939599,
"business_date": "2019-02-11",
"female_cover": 3,
"male_cover": 2,
"child_cover": 0,
"note": null,
"sequence": 933,
"status": "closed",
"delivery_status": "on_delivery",
"sequential_id": 424933,
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"revenue_center": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "GardenBro"
},
"shift_id": "b7fff683-2436-41e7-8961-2ca983cc0c33",
"employee": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"first_name": "Big",
"last_name": "Bro",
"phone_number": "123456789"
},
"table": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Bro 1#"
},
"sales_channel": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "POS"
},
"customer": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"first_name": "Big",
"last_name": "Brother",
"email": "big@brothers.com",
"phone_number": "123456789"
},
"delivery": {
"address": "BigBrother No.10",
"address_id": "ff1b69b1-a7de-4a74-8483-28a539ab8d70",
"recipient": null,
"payment_names": "Cash"
},
"check_service_charge": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"amount": "10.5",
"tax": {
"id": "228923c8-fa07-4b77-94ca-372310cd3a3f",
"rate": 18,
"name": "Servis Ücreti"
},
},
"summary": {
"original_items_amount": "2118.64",
"original_taxes_amount": "381.36",
"complimentaries_amount": "0.0",
"discounts_amount": "600.0",
"taxes_amount": "411.86",
"service_charge_amount": "800.0",
"paid_amount": "2700.0",
"unpaid_amount": "0.0",
"paid_service_charge_amount": "0.0",
"total_amount": "2700.0",
"base_amount": "2500.0",
"offer_amount": "4.21"
},
"check_discounts": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"source": "system",
"value": "600",
"discount_amount": "10800",
"name": "TL İndirimi",
"type": "amount",
"annotation": "test annotation indirim"
}
],
"check_payments": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"payment_type_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"paid_amount": "700.0",
"device": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "The Great Book Pro"
},
"extras": null
}
],
"check_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"parent_check_item_id": null,
"reason_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"status": "ordered",
"payment_status": "paid",
"complimentary": false,
"unit_type": "item",
"quantity": "1.0",
"notes": [
"Life"
],
"is_combo": false,
"summary": {
"discount_amount": "24.0",
"tax_amount": "11.59322034",
"total_amount": "76.0",
"original_amount": "100.0",
"original_tax_amount": "15.25423729"
},
"tax": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"rate": 18,
"name": "İçecek"
},
"item": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Short",
"type": "MenuItem",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
}
],
"check_offers": [
{
"id": "79ae7c2b-4356-4923-8eed-5515efac8e91",
"offer_id": "d94906e1-2260-4a37-afba-1fe5051b5cc9",
"name": "Happy Hour-1",
"value": "4.21"
}
]
}
Checks - Create
Create Check
Configuration
Check create operation need some configuration on BackOffice. Always should be selected revenue center, sales channel and employee on extension settings.
HTTP Request
POST /apps/api/v1/checks
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| menu_items[] | contains order items | REQUIRED | |
| menu_items[].id | ordered menu item id | ||
| menu_items[].quantity | 1 | ordered menu item quantity | |
| menu_items[].name | ordered menu item name for custom menu item | ||
| menu_items[].unit_amount | ordered menu item amount for custom menu item | ||
| menu_items[].notes[] | ordered item notes | ||
| menu_items[].condiments[] | ordered condiments | ||
| menu_items[].condiments[].id | condiment id | REQUIRED | |
| menu_items[].combo_items[] | ordered combo items | ||
| menu_items[].combo_items[].id | menu item id | REQUIRED | |
| menu_items[].combo_items[].combo_group_item_id | combo group item id | REQUIRED | |
| discounts[] | discounts on check | ||
| discounts[].amount | discount amount | REQUIRED | |
| table_id | creates check on table | ||
| revenue_center_id | creates check on revenue_center | ||
| sales_channel_id | creates check on sales_channel | ||
| note | add note to check | ||
| alias_name | check name | ||
| female_cover | female cover on check | ||
| male_cover | male cover on check | ||
| child_cover | child cover on check | ||
| customer | add customer to check | ||
| customer.phone_number | customer phone number | REQUIRED | |
| customer.first_name | customer first name | ||
| customer.last_name | customer last name | ||
| customer.email | customer email | ||
| customer.gender | gender info(female or male) |
||
| delivery | delivery information for takeaway | ||
| delivery.address | delivery address | REQUIRED | |
| delivery.note | delivery note | ||
| extras[] | check custom attributes | ||
| extras[].key | check custom attribute key | ||
| extras[].value | check custom attribute value |
Create with Menu Item
- Required
menu_items[].id.
JSON request body:
{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 2,
"notes": ["hot"]
}
]
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with Condiments
- Required
menu_items[].condiments[].id.
JSON request body:
{
"menu_items": [
{
"id": "316441fb-9643-4857-855b-cc56a9d0b1ae",
"quantity": 2,
"condiments": [
{
"id": "19f7b0f5-fa49-4918-98c4-142ad2a14730"
}
]
}
]
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with Combo
JSON request body:
{
"menu_items": [
{
"id": "6fdbd6b4-d459-427a-8c83-0df669322715",
"combo_items": [
{
"id": "3213d733-5311-440b-ad41-92640a7250ff",
"combo_group_item_id": "4d0a869e-7bee-4c58-ae25-6d3bf20622f8"
}
]
}
]
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with Override Price
- Required
menu_items[].id. - Required
menu_items[].unit_amount.
JSON request body:
{
"menu_items": [
{
"id": "6fdbd6b4-d459-427a-8c83-0df669322715",
"quantity": 1,
"unit_amount": 20
}
]
}
Create with Custom Menu Items
- Tax and menu item group are needed on extension settings.
- Required
menu_items[].name. - Required
menu_items[].unit_amount.
JSON request body:
{
"menu_items": [
{
"name": "TeaWithCoffee",
"quantity": 2,
"unit_amount": 10
}
]
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with Discounts
- Required
discounts[].amount.
JSON request body:
{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 2
}
],
"discounts": [
{
"amount": 10
}
]
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with Customer
- Required
customer.phone_number. - Creates new customer in enterprise when phone number not using.
JSON request body:
{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 2
}
],
"customer": {
"phone_number": "319003205832",
"first_name": "Big",
"last_name": "BigBrother",
"email": "big@brother.com",
"gender": "female"
}
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with Delivery
- Revenue center type should be
takeawayon extension settings.
JSON request body:
{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 2
}
],
"delivery": {
"address": "BigBrother No.10",
"note": "Life is short"
}
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with Extras
JSON request body:
{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 1
}
],
"extras": [
{
"key": "iwallet_card_number",
"value": "1234567890"
},
{
"key": "iwallet_reference_number",
"value": "1234567890"
}
]
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with All Possibilities
JSON request body:
{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 2,
"notes": ["hot"],
"condiments": [
{
"id": "19f7b0f5-fa49-4918-98c4-142ad2a14730"
}
]
},
{
"name": "TeaWithCoffee",
"unit_amount": 10,
"quantity": 2
}
],
"discounts": [
{
"amount": 10
}
],
"customer": {
"phone_number": "319003205832",
"first_name": "Big",
"last_name": "BigBrother",
"email": "big@brother.com",
"gender": "female"
},
"note": "fast",
"table": "249934c8-892e-40ac-aced-ee6338d14388",
"alias_name": "Brothers",
"female_cover": 2,
"male_cover": 2,
"child_cover": 4,
"delivery": {
"address": "BigBrother No.10",
"note": "Life is short"
},
"extras": [
{
"key": "iwallet_card_number",
"value": "1234567890"
},
{
"key": "iwallet_reference_number",
"value": "1234567890"
}
]
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Create with Revenue Center
JSON request body:
{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 1
}
],
"revenue_center_id": "2291e5ec-b0d7-4b98-a273-c644c6f6e756"
}
JSON response body:
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}
Checks - Create Item
Check item status values are: new, hold ordered, cancelled, returned, waste, void, transaction_cancelled.
Create Check Item
HTTP Request
POST /apps/api/v1/checks/:check_id/check_items
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| menu_items[] | contains order items | REQUIRED | |
| menu_items[].id | ordered menu item id | ||
| menu_items[].quantity | 1 | ordered menu item quantity | |
| menu_items[].name | ordered menu item name for custom menu item | ||
| menu_items[].unit_amount | ordered menu item amount for custom menu item | ||
| menu_items[].notes[] | ordered item notes | ||
| menu_items[].condiments[] | ordered condiments | ||
| menu_items[].condiments[].id | condiment id | REQUIRED | |
| menu_items[].combo_items[] | ordered combo items | ||
| menu_items[].combo_items[].id | menu item id | REQUIRED | |
| menu_items[].combo_items[].combo_group_item_id | combo group item id | REQUIRED |
Create check item with Menu Item
- Required
menu_items[].id.
JSON request body:
{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 2,
"notes": ["hot"]
}
]
}
JSON response body:
{
"check_item_ids": ["c2cb6f75-88c1-4ab6-99af-a9d6b7822993"]
}
Create check item with Condiments
- Required
menu_items[].condiments[].id.
JSON request body:
{
"menu_items": [
{
"id": "316441fb-9643-4857-855b-cc56a9d0b1ae",
"quantity": 2,
"condiments": [
{
"id": "19f7b0f5-fa49-4918-98c4-142ad2a14730"
}
]
}
]
}
JSON response body:
{
"check_item_ids": ["c2cb6f75-88c1-4ab6-99af-a9d6b7822993"]
}
Create check item with Combo
JSON request body:
{
"menu_items": [
{
"id": "6fdbd6b4-d459-427a-8c83-0df669322715",
"combo_items": [
{
"id": "3213d733-5311-440b-ad41-92640a7250ff",
"combo_group_item_id": "4d0a869e-7bee-4c58-ae25-6d3bf20622f8"
}
]
}
]
}
JSON response body:
{
"check_item_ids": ["c2cb6f75-88c1-4ab6-99af-a9d6b7822993"]
}
Create check item with Custom Menu Items
- Tax and menu item group are needed on extension settings.
- Required
menu_items[].name. - Required
menu_items[].unit_amount.
JSON request body:
{
"menu_items": [
{
"name": "TeaWithCoffee",
"quantity": 2,
"unit_amount": 10
}
]
}
JSON response body:
{
"check_item_ids": ["c2cb6f75-88c1-4ab6-99af-a9d6b7822993"]
}
Checks - Add Payment
Add Payment to Check
HTTP Request
POST /apps/api/v1/checks/:check_id/check_payments
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| payments[] | REQUIRED | ||
| payments[].amount | payment amount | ||
| payments[].items[] | include ids of check items |
Add payment with only amount
- Required
amount.
JSON request body:
{
"payments": [
{
"amount": 20
}
]
}
JSON response body:
204 No Content
Add payment for item
- Required
itemsandamount.
JSON request body:
{
"payments": [
{
"amount": 10,
"items": ["c2cb6f75-88c1-4ab6-99af-a9d6b7822993"]
}
]
}
JSON response body:
204 No Content
Add payment with payment id
- Required
payment_idandamount.
JSON request body:
{
"payments": [
{
"amount": 10,
"payment_id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993"
}
]
}
JSON response body:
204 No Content
Checks - Cancel Item
Cancel Check Item
HTTP Request
POST /apps/api/v1/checks/:id/check_items/:check_item_id/cancel
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| reason_id | Cancel reason id. If reason_id is not sent, the reason defined in the system is used. |
JSON request body:
{
"reason_id": "090de589-398d-4446-b853-ba1ad989dae2"
}
JSON response body:
204 No Content
Checks - Add Discount
Add Discount to Check
HTTP Request
POST /apps/api/v1/checks/:check_id/check_discounts
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| discount_id | discount id | ||
| amount | discount amount | REQUIRED |
Add discount without specific discount
JSON request body:
{
"amount": 10
}
JSON response body:
{
"check_discount_id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993"
}
Add discount with specific discount
- Required
discount_id.
JSON request body:
{
"discount_id": "316441fb-9643-4857-855b-cc56a9d0b1ae",
"amount": 10
}
JSON response body:
{
"check_discount_id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993"
}
Checks - Remove Discount
Remove Check Discount
You can remove discount from check with check discount id.
HTTP Request
DELETE /apps/api/v1/checks/:id/check_discounts/:check_discount_id
JSON response body:
204 No Content
Checks - Add Service Charge
Add Service Charge to Check
HTTP Request
POST /apps/api/v1/checks/:check_id/check_service_charges
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| service_charge_id | service charge id | REQUIRED | |
| amount | service charge amount | REQUIRED |
Add service charge
- Required
service_charge_id.
If the type of the service charge is cover, the defined value of the service charge is applied. So there is no need to send the amount.
JSON request body:
{
"service_charge_id": "316441fb-9643-4857-855b-cc56a9d0b1ae",
"amount": 10
}
JSON response body:
{
"check_service_charge_id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993"
}
Checks - Remove Service Charge
Remove Check Service Charge
You can remove service charge from check with check service charge id.
HTTP Request
DELETE /apps/api/v1/checks/:id/check_service_charges/:check_service_charge_id
JSON response body:
204 No Content
Checks - Unlock
Unlock Check
You can unlock the locked check.
HTTP Request
POST /apps/api/v1/checks/:check_id/unlock
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| message | integrator service message |
JSON request body:
{
"message": "TEST"
}
JSON response body:
{
"success": true
}
Checks - Change Delivery Status
Change Delivery Status
You can change check delivery status. Initial status is deliverable if check revenue center type take away status will be set preparing.
Changeable status updates
- preparing, on_delivery, delivered --> deliverable
- deliverable, on_delivery --> preparing
- preparing, delivered --> on_delivery
- on_delivery, cancelled --> delivered
- deliverable, preparing, on_delivery, delivered --> cancelled
HTTP Request
POST /apps/api/v1/checks/:check_id/change_delivery_status
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| delivery_status | status; deliverable, preparing, on_delivery, delivered, cancelled |
JSON request body:
{
"delivery_status": "delivered"
}
JSON response body:
{
"success": true
}
Check Activities
Get Check Activities
HTTP Request
GET /check_activities
Scope
Property, Enterprise
Query Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| page | 1 | ||
| per_page | 50 | ||
| created_date | Example 2019-01-21 |
JSON response body:
{
"meta": {
"has_next_page": true,
"current_page": 1,
"per_page_count": 50,
"total_count": 75,
"total_page": 2
},
"check_activities": [
{
"check_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"device_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"revenue_center_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"activity_type": "CheckMove",
"created_at": 1549914523,
"extra_payload": {
"revenue_center_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"table_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
},
}
]
}
Checks - Add Service Message
Add Service Message To Check
You can add integrator service message to the locked check.
HTTP Request
POST /apps/api/v1/checks/:check_id/add_service_message
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| message | integrator service message | REQUIRED |
JSON request body:
{
"message": "TEST"
}
JSON response body:
{
"success": true
}
Sales Channels
Get Sales Channels
HTTP Request
GET /sales_channels
Scope
Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| property_ids | Simpra Access Token must be enterprise level token to use this parameter. If it is nil or empty, all properties data will be returned. |
JSON response body:
{
"meta": {
"total_count": 4,
"current_page": 1,
"per_page_count": 50,
"total_page": 1,
"has_next_page": false
},
"sales_channels": [
{
"id": "8ac1bd71-0fe1-4f6f-9689-c27b4267999e",
"type": "web",
"updated_at": 1656924185,
"property_id": "01e2f599-35ec-4df9-a07b-630bd0501cae",
"name": "MyString"
},
{
"id": "c0cd868c-c5f9-42fb-87b4-b2be1436f6f4",
"type": "web",
"updated_at": 1656924187,
"property_id": "01e2f599-35ec-4df9-a07b-630bd0501cae",
"name": "MyString"
},
{
"id": "c64f70d8-9ba7-4d10-a8e0-9a14d4b0d9f9",
"type": "web",
"updated_at": 1656924372,
"property_id": "01e2f599-35ec-4df9-a07b-630bd0501cae",
"name": "Last SalesChannel"
},
{
"id": "3c4d7ba4-ae64-4e5e-8b17-306601f1bf8d",
"type": "web",
"updated_at": 1655108694,
"property_id": "01e2f599-35ec-4df9-a07b-630bd0501cae",
"name": "MyString"
}
]
}
Revenue Centers
Get Revenue Centers
HTTP Request
GET /revenue_centers
Scope
Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 |
JSON response body:
{
"meta": {
"total_count": 2,
"current_page": 1,
"per_page_count": 50,
"total_page": 1,
"has_next_page": false
},
"revenue_centers": [
{
"id": "caa58fa7-db16-4905-8bcc-933236dd39d7",
"active": true,
"type": "fast_transaction",
"updated_at": 1655108795,
"metafields": [],
"translations": [
{
"name": "RVC-3",
"locale": "en"
}
],
"property_id": "01e2f599-35ec-4df9-a07b-630bd0501cae",
"sales_channel_id": "ecea73e4-0134-4486-97d6-7e93e6602345"
},
{
"id": "452c7105-e331-4d49-8391-88e28b14fa43",
"active": true,
"type": "fast_transaction",
"updated_at": 1657003969,
"metafields": [],
"translations": [
{
"name": "RVC-2",
"locale": "en"
}
],
"property_id": "01e2f599-35ec-4df9-a07b-630bd0501cae",
"sales_channel_id": "c04908f2-32df-4a0d-b616-a8fd4f2b8886"
}
]
}
Tables
Get Tables
HTTP Request
GET /tables
Scope
Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| status | ||
| revenue_center_id |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 50,
"total_count": 2,
"total_page": 1
},
"tables": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "A4",
"active": false,
"capacity": 10,
"plan": { "top": 0, "left": 0, "width": 0, "height": 0, "round": false },
"updated_at": 1561568523,
"revenue_center_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"section_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "A6",
"active": true,
"capacity": 20,
"plan": { "top": 0, "left": 0, "width": 0, "height": 0, "round": false },
"updated_at": 1561568523,
"revenue_center_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"section_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
]
}
Sections
Get Sections
HTTP Request
GET /sections
Scope
Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| revenue_center_id |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 50,
"total_count": 2,
"total_page": 1
},
"sections": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Bahçe",
"locale": "tr"
}
],
"active": false,
"grid_size_x": 5,
"grid_size_y": 8,
"revenue_center_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Terrace",
"locale": "en"
}
],
"active": true,
"grid_size_x": 8,
"grid_size_y": 13,
"revenue_center_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
]
}
Section Things
Get Section Things
HTTP Request
GET /section_things
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| section_id |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 50,
"total_count": 2,
"total_page": 1
},
"section_things": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"plan": { "top": 0, "left": 0, "width": 0, "height": 0, "round": false },
"thing_translations": [
{
"name": "Dolap",
"locale": "tr"
}
],
"created_at": 1561568523,
"updated_at": 1561568523,
"section_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"thing_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"plan": { "top": 0, "left": 0, "width": 0, "height": 0, "round": false },
"thing_translations": [
{
"name": "Door",
"locale": "en"
}
],
"created_at": 1561568523,
"updated_at": 1561568523,
"section_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"thing_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
]
}
Employees
Get Employees
HTTP Request
GET /employees
Scope
Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 |
JSON response body:
{
"meta": {
"total_count": 2,
"current_page": 1,
"per_page_count": 50,
"total_page": 1,
"has_next_page": false
},
"employees": [
{
"id": "c05d87c0-9f00-47e1-b0c5-b7e9d9e0d410",
"first_name": "Celine",
"last_name": "Moen",
"phone_number": "4014870032",
"registration_no": "115623",
"property_id": "01e2f599-35ec-4df9-a07b-630bd0501cae",
"metafields": [
{
"id": "65c4a8df-96cb-4f70-9c13-a8f65e2e2116",
"key": "tckn",
"value": "11111111111",
"value_type": "string",
"updated_at": 1656490113
}
]
},
{
"id": "c05d87c0-9f00-47e1-b0c5-b7e9d9e0d410",
"first_name": "Celine",
"last_name": "Moen",
"phone_number": "4014870032",
"registration_no": "115624",
"property_id": "01e2f599-35ec-4df9-a07b-630bd0501cae",
"metafields": [
{
"id": "65c4a8df-96cb-4f70-9c13-a8f65e2e2116",
"key": "tckn",
"value": "11111111111",
"value_type": "string",
"updated_at": 1656490113
}
]
}
]
}
Devices
Get Devices
GET /devices
Scope
Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 |
JSON response body:
{
"meta": {
"total_count": 1,
"current_page": 1,
"per_page_count": 50,
"total_page": 1,
"has_next_page": false
},
"devices": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Water",
"identifier": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1638952128,
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
]
}
Discounts
Get Discounts
HTTP Request
GET /discounts
Scope
Property
JSON response body:
{
"discounts": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"is_fixed": true,
"type": "percentage",
"value": "10.0",
"translations": [
{
"name": "10% Discount",
"locale": "en"
}
]
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"is_fixed": true,
"type": "amount",
"value": "5.0",
"translations": [
{
"name": "5 TL İndirim",
"locale": "tr"
}
],
"metafields": [
{
"id": "65c4a8df-96cb-4f70-9c13-a8f65e2e2116",
"key": "tckn",
"value": "11111111111",
"value_type": "string",
"updated_at": 1656490113
}
]
}
]
}
Service Charges
Get Service Charges
HTTP Request
GET /service_charges
Scope
Property
JSON response body:
{
"service_charges": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"is_fixed": true,
"default": false,
"tax_id": "9376db51-66b0-4290-91ba-d962d6a36b08",
"value": "10.0",
"type": "percentage",
"metafields": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"key": "UberEats",
"value": false,
"value_type": "boolean",
"updated_at": 1562576660
}
],
"translations": [
{
"name": "10% Service Charge",
"locale": "en"
},
{
"name": "10% Servis Ücreti",
"locale": "tr"
},
{
"name": "10% Service Charge",
"locale": "ar"
},
{
"name": "10% Service Charge",
"locale": "hu"
}
]
}
]
}
Taxes
Get Taxes
HTTP Request
GET /taxes
Scope
Enterprise
JSON response body:
{
"taxes": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"rate": 18,
"active": true,
"updated_at": 1558505446,
"translations": [
{
"name": "Food",
"locale": "en"
},
]
}
]
}
Menu Item Definitions
Get Menu Item Definitions
HTTP Request
GET /menu_item_definitions
Scope
Enterprise, Property
Query Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| page | 1 | ||
| per_page | 50 | ||
| updated_at | 0 | This value when zero returns all menu items. Format unix time. | |
| status | Value when active returns only active menu items else all. |
||
| target_id | Revenue Center ID | REQUIRED |
Response
JSON response body:
{
"meta": {
"total_count": 70,
"current_page": 1,
"per_page_count": 50,
"total_page": 2,
"has_next_page": true
},
"menu_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": false,
"updated_at": 1661169533,
"receipe_menu_item": true,
"combo": false,
"unit_type": "item",
"barcodes": [],
"menu_item_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Cola",
"locale": "tr"
},
{
"name": "Coke",
"locale": "hu"
},
{
"name": "Coke",
"locale": "en"
},
{
"name": "Coke",
"locale": "ar"
}
],
"item_definitions": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": "3.0",
"active": false,
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"tax_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_type": "MenuItem",
"target_type": "RevenueCenter",
"updated_at": 1652418857,
"order": 1,
"translations": [
{
"name": "Coke",
"locale": "ar"
},
{
"name": "Coke",
"locale": "en"
},
{
"name": "Cola",
"locale": "tr"
},
{
"name": "Coke",
"locale": "hu"
}
],
"stock": {
"amount": null,
"cost": null
}
}
],
"condiment_groups": [],
"metafields": [],
"report_tags": []
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": false,
"updated_at": 1661169543,
"receipe_menu_item": true,
"combo": false,
"unit_type": "item",
"barcodes": [],
"menu_item_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Cola Light",
"locale": "tr"
},
{
"name": "Light Coke",
"locale": "hu"
},
{
"name": "Light Coke",
"locale": "en"
},
{
"name": "Light Coke",
"locale": "ar"
}
],
"item_definitions": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": "3.0",
"active": false,
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"tax_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_type": "MenuItem",
"target_type": "RevenueCenter",
"updated_at": 1652418858,
"order": 2,
"translations": [
{
"name": "Light Coke",
"locale": "ar"
},
{
"name": "Light Coke",
"locale": "en"
},
{
"name": "Cola Light",
"locale": "tr"
},
{
"name": "Light Coke",
"locale": "hu"
}
],
"stock": {
"amount": null,
"cost": null
}
}
],
"condiment_groups": [],
"metafields": [],
"report_tags": []
}
]
}
Menu Items
Get Menu Items [Deprecated]
Deprecated
Use V2 Menu Items
HTTP Request
GET /menu_items
Scope
Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| updated_at | 0 | This value when zero returns all menu items. Format unix time. |
| status | Value when active returns only active menu items else all. |
Response
| Field | Valid Values |
|---|---|
| metafields[].value_type | string or boolean |
JSON response body:
{
"meta": {
"has_next_page": true,
"current_page": 1,
"per_page_count": 50,
"total_count": 160,
"total_page": 4
},
"menu_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"updated_at": 1555503616,
"receipe_menu_item": true,
"unit_type": "item",
"barcodes": [
"64466446"
],
"menu_item_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Su",
"locale": "tr"
}
],
"item_definitions": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": "0.0",
"active": true,
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"tax_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_type": "MenuItem",
"target_type": "RevenueCenter",
"updated_at": 1548077548,
"translations": [
{
"name": "Su",
"locale": "tr"
}
]
}
],
"metafields": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"key": "UberEats",
"value": false,
"value_type": "boolean",
"updated_at": 1562576660
}
],
"condiment_groups": [
{
"required": true,
"min_count": null,
"max_count": null,
"multiple": false,
"condiment_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"menu_item_condiment_group_mapping_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1555503616,
"translations": [
{
"name": "Su",
"locale": "tr"
}
],
"condiments": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1552372866,
"translations": [
{
"name": "Chillers",
"locale": "tr"
}
],
"item_definitions": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"price": "8.5",
"tax_id": null,
"target_type": "RevenueCenter",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_type": "Condiment",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1562316986,
"translations": [
{
"name": "Chillers",
"locale": "tr"
}
]
}
]
}
]
}
}
}
]
}
Create Menu Items
HTTP Request
POST apps/api/v1/menu_items
Scope
Enterprise
Need enterprise token
Body Parameters
| Field | Default | Required |
|---|---|---|
| name | REQUIRED when translations empty | |
| price | REQUIRED | |
| tax_id | REQUIRED | |
| menu_item_group_id | REQUIRED | |
| quantity | ||
| barcodes | [] | |
| translations | [] | |
| receipe_menu_item | true | |
| property_ids | all properties | |
| report_tag_ids | [] |
JSON request body:
{
"property_ids": ["6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"],
"name": "Yeni Ürün - API",
"price": 20,
"tax_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"menu_item_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"barcodes": ["1234509876"],
"quantity": 10,
"receipe_menu_item": true,
"translations": [
{ "locale": "en", "text": "New Item - API" },
{ "locale": "hu", "text": "Új elem – API" }
],
"report_tag_ids": ["6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"]
}
Success JSON response body:
{
"menu_item": {
"id": "9e5d9974-42a6-4a92-a97e-e8a98412e5a4"
}
}
Missing tax_id JSON response body:
{
"data": null,
"errors": [
{
"message": "Tax not found!"
}
]
}
Update Menu Items
HTTP Request
PATCH apps/api/v1/menu_items/:id
Scope
Enterprise
Need enterprise token
Body Parameters
| Field | Default | Required |
|---|---|---|
| name | ||
| price | ||
| tax_id | ||
| menu_item_group_id | ||
| barcodes | ||
| translations | ||
| receipe_menu_item | ||
| property_ids | all properties | |
| report_tag_ids | [] |
JSON request body:
{
"price": 200
}
Success JSON response body:
{
"menu_item": {
"id": "9e5d9974-42a6-4a92-a97e-e8a98412e5a4"
}
}
invalid tax_id JSON response body:
{
"data": null,
"errors": [
{
"message": "Tax not found!"
}
]
}
Upsert Menu Items
HTTP Request
POST apps/api/v1/menu_items/upsert
Scope
Enterprise
Need enterprise token
Body Parameters
| Field | Default | Required | Description |
|---|---|---|---|
| sku | REQUIRED | ||
| name | REQUIRED | ||
| unit_type | REQUIRED | ||
| price | REQUIRED | ||
| tax_id | REQUIRED | ||
| menu_item_group_id | REQUIRED | ||
| price_list_id | |||
| barcodes | [] | ||
| translations | [] | ||
| receipe_menu_item | |||
| report_tag_ids | [] | ||
| target_ids | [] | REQUIRED | valid resource ids: enterprise, property or revenue center |
| size_option_id | filtered size option items like target_ids |
JSON request body:
{
"target_ids": ["b9b9f8e1-0917-4c1b-956b-beb2df82d920"],
"size_option_id": "b9b9f8e1-0917-4c1b-956b-beb2df82d920",
"items": [
{
"sku": "123",
"name": "Ergonomic Iron Table",
"price": 9.99,
"unit_type": "item",
"barcodes": [],
"active": true,
"receipe_menu_item": true,
"price_list_id": "08691350-7690-453a-9f82-5a98e3e2d6bb",
"report_tag_ids": ["51f0daa9-a7be-47d0-9b72-4e2cba44e633"],
"tax_id": "f1ab3238-ea9b-40fc-94d3-db6d95055f77",
"menu_item_group_id": "ce03194f-2298-4d6e-9f2c-568b1535809a",
"translations": [
{ "locale": "tr", "text": "Miss Dean Pfeffer" },
{ "locale": "en", "text": "Samantha Schowalter" }
]
},
{
"sku": "123456",
"name": "Drew Witting",
"price": 22.2,
"unit_type": "item",
"barcodes": ["7166272885"],
"active": true,
"receipe_menu_item": false,
"tax_id": "f1ab3238-ea9b-40fc-94d3-db6d95055f77",
"price_list_id": "08691350-7690-453a-9f82-5a98e3e2d6bb",
"menu_item_group_id": "ce03194f-2298-4d6e-9f2c-568b1535809a",
"report_tag_ids": ["51f0daa9-a7be-47d0-9b72-4e2cba44e633"],
"translations": [
{ "locale": "tr", "text": "Deanne Johns" },
{ "locale": "en", "text": "Calvin Bernhard" }
]
}
]
}
Success JSON response body:
{
"success": true, "import_id": "51f0daa9-a7be-47d0-9b72-4e2cba44e633"
}
Remove Menu Item Report Tags
HTTP Request
DELETE apps/api/v1/menu_items/:id/report_tags
Scope
Enterprise
JSON request body:
{
"report_tag_ids": ["6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"]
}
V2 Menu Items
Get V2 Menu Items
HTTP Request
GET /v2/menu_items
Scope
Enterprise, Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| updated_at | 0 | This value when zero returns all menu items. Format unix time. |
| status | Value when active returns only active menu items else all. |
|
| property_ids | Simpra Access Token must be enterprise level token to use this parameter. If it is nil or empty, all properties data will be returned. | |
| sku |
Response
| Field | Valid Values |
|---|---|
| metafields[].value_type | string or boolean |
JSON response body:
{
"meta": {
"has_next_page": true,
"current_page": 1,
"per_page_count": 50,
"total_count": 160,
"total_page": 4
},
"menu_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"sku": "123456",
"active": true,
"updated_at": 1555503616,
"receipe_menu_item": true,
"unit_type": "item",
"barcodes": ["64466446"],
"menu_item_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Su",
"locale": "tr"
}
],
"metafields": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"key": "UberEats",
"value": false,
"value_type": "boolean",
"updated_at": 1562576660
}
],
"condiment_groups": [
{
"required": true,
"min_count": null,
"max_count": null,
"multiple": false,
"condiment_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"menu_item_condiment_group_mapping_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1555503616,
"translations": [
{
"name": "Su",
"locale": "tr"
}
]
}
],
"item_image": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Su",
"raw_url_path": "https://..",
"small_image_url": "https://..",
"thumbnail_image_url": "https://..",
"medium_image_url": "https://..",
"large_image_url": "https://.."
}
}
]
}
Get V2 Menu Item
HTTP Request
GET /v2/menu_items
Scope
Enterprise, Property
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"sku": "123456",
"active": true,
"updated_at": 1555503616,
"receipe_menu_item": true,
"unit_type": "item",
"barcodes": ["64466446"],
"menu_item_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Su",
"locale": "tr"
}
],
"metafields": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"key": "UberEats",
"value": false,
"value_type": "boolean",
"updated_at": 1562576660
}
],
"condiment_groups": [
{
"required": true,
"min_count": null,
"max_count": null,
"multiple": false,
"condiment_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"menu_item_condiment_group_mapping_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1555503616,
"translations": [
{
"name": "Su",
"locale": "tr"
}
]
}
],
"item_image": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Su",
"raw_url_path": "https://..",
"small_image_url": "https://..",
"thumbnail_image_url": "https://..",
"medium_image_url": "https://..",
"large_image_url": "https://.."
}
}
Item Definitions
Get Item Definitions
HTTP Request
GET /item_definitions
Scope
Enterprise, Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| updated_at | 0 | This value when zero returns all menu items. Format unix time. |
| status | Value when active returns only active menu items else all. |
|
| source_type | Valid values Condiment or MenuItem |
|
| source_id | Condiment ID or Menu Item ID | |
| target_id | Revenue Center ID | |
| property_ids | Simpra Access Token must be enterprise level token to use this parameter. If it is nil or empty, all properties data will be returned. |
Response
| Field | Description |
|---|---|
| item_definitions[].source_id | menu_item_id or condiment_id |
| item_definitions[].target_id | revenue_center_id, property_id or enterprise_id |
JSON response body:
{
"meta": {
"has_next_page": true,
"current_page": 1,
"per_page_count": 50,
"total_count": 160,
"total_page": 4
},
"item_definitions": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": "8.0",
"active": true,
"is_size_option": false,
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"tax_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price_list_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_type": "MenuItem",
"target_type": "RevenueCenter",
"updated_at": 1638952128,
"order": 1,
"translations": [
{
"name": "Water",
"locale": "en"
}
]
}
]
}
Update Item Definitions
HTTP Request
PATCH /item_definitions/:id
Scope
Enterprise, Property
Update just price: JSON request body:
{
"price": 10
}
Update all fields: JSON request body:
{
"price": 10,
"name": "BigBrother",
"active": false,
"order": 1,
"price_list_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"size_option_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"locale": "tr", "text": "Büyük",
"locale": "en", "text": "Big"
}
]
}
JSON response body:
{
"item_definition": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
}
Custom Menu Items
Get Custom Menu Items
HTTP Request
GET /custom_menu_items
Scope
Property, Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| updated_at | 0 | This value when zero returns all menu items. Format unix time. |
| status | Parameter when active returns only active menu items else all. |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 50,
"total_count": 5,
"total_page": 1
},
"custom_menu_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"updated_at": 1549434910,
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"menu_item_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"item_definitions": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": 3,
"active": true,
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"tax_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_type": "CustomMenuItem",
"target_type": "RevenueCenter",
"updated_at": 1559588716,
"translations": [
{
"name": "Water",
"locale": "tr"
}
]
}
]
}
]
}
Menu Item Groups
Get Menu Item Groups
HTTP Request
GET /menu_item_groups
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| updated_at | 0 | This value when zero returns all menu item groups. Format unix time. |
JSON response body:
{
"menu_item_groups": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"updated_at": 1547314596,
"parent_mig_id": null,
"translations": [
{
"name": "Drinks",
"locale": "en"
}
]
}
]
}
Condiments
Get Condiments
HTTP Request
GET /condiments
Scope
Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| status | Value when active returns only active condiments else all. |
|
| updated_at | 0 | This value when zero returns all condiments. Format unix time. |
JSON response body:
{
"condiments": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"updated_at": 1554739398,
"condiment_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Acılı",
"locale": "tr"
}
],
"item_definitions": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"price": "0.0",
"tax_id": "",
"target_type": "Property",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source_type": "Condiment",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1559588604,
"translations": [
{
"name": "Acılı",
"locale": "tr"
}
]
}
]
}
]
}
V2 Condiments
Get Condiments
HTTP Request
GET /v2/condiments
Scope
Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| status | Value when active returns only active condiments else all. |
|
| updated_at | 0 | This value when zero returns all condiments. Format unix time. |
JSON response body:
{
"meta": {
"has_next_page": true,
"current_page": 1,
"per_page_count": 50,
"total_count": 160,
"total_page": 4
},
"condiments": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"order": 1,
"updated_at": 1554739398,
"condiment_group_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Acılı",
"locale": "tr"
}
]
}
]
}
Condiment Groups
Get Condiment Groups
HTTP Request
GET /condiment_groups
Scope
Enterprise
Query Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| page | 1 | ||
| per_page | 50 |
JSON response body:
{
"meta": {
"has_next_page": true,
"current_page": 1,
"per_page_count": 50,
"total_count": 1251,
"total_page": 26
},
"condiment_groups": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"multiple": true,
"updated_at": 1549461152,
"translations": [
{
"name": "Türk Kahvesi",
"locale": "tr"
}
]
}
]
}
ComboMenus
Get ComboMenus
HTTP Request
GET /combo_menus
Scope
Property, Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| updated_at | 0 | This value when zero returns all ComboMenus. Format unix time. |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 50,
"total_count": 1,
"total_page": 1
},
"combo_menus": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"price_view_format": null,
"menu_item_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1587035272,
"combo_groups": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"required": false,
"active": true,
"number_of_choices": 1,
"order": 1,
"translations": [
{
"name": "Soups",
"locale": "en"
}
],
"combo_group_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"default_choice": false,
"price": 10,
"item_definition_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"print_class_id": null,
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_type": "RevenueCenter"
}
]
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"required": false,
"active": true,
"number_of_choices": 1,
"order": 1,
"translations": [
{
"name": "Desserts",
"locale": "en"
}
],
"combo_group_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"default_choice": false,
"price": 0,
"item_definition_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"print_class_id": null,
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_type": "RevenueCenter"
}
]
}
]
}
]
}
Report Tags
Get Report Tags
HTTP Request
GET /report_tags
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| status | Value when active returns only active report tags else all. |
JSON response body:
{
"report_tags": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"parent_report_tag_id": null,
"translations": [
{
"name": "Yiyecek",
"locale": "tr"
},
{
"name": "Food",
"locale": "en"
}
]
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"parent_report_tag_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Ana Yemek",
"locale": "tr"
}
]
}
]
}
Add Report Tag
HTTP Request
POST /apps/api/v1/report_tags
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| translations[].locale | translations locale | REQUIRED | |
| translations[].text | translations text | REQUIRED | |
| parent_report_tag_id | report tag parent report tag id |
JSON request body:
{
"parent_report_tag_id": "9cca3055-8064-4ce6-925e-3acbaf9f133a",
"translations":
[
{
"locale": "tr",
"text": "Rosalia Pollich"
},
{
"locale": "en",
"text": "Christian Yundt V"
},
{
"locale": "hu",
"text": "Casey Will"
},
{
"locale": "ru",
"text": "Louie Bauch"
}
]
}
JSON response body:
{
"report_tag":
{
"id": "7f7fa5f3-9050-485d-bbc3-5f06908f7aad"
}
}
Update Report Tag
HTTP Request
PATCH /apps/api/v1/report_tags/:id
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| translations[].locale | translations locale | ||
| translations[].text | translations text | ||
| parent_report_tag_id | report tag parent report tag id |
JSON request body:
{
"parent_report_tag_id": "9cca3055-8064-4ce6-925e-3acbaf9f133a",
"translations":
[
{
"locale": "tr",
"text": "Rosalia Pollich"
},
{
"locale": "en",
"text": "Christian Yundt V"
},
{
"locale": "hu",
"text": "Casey Will"
},
{
"locale": "ru",
"text": "Louie Bauch"
}
]
}
JSON response body:
{
"report_tag":
{
"id": "7f7fa5f3-9050-485d-bbc3-5f06908f7aad"
}
}
Payment Types
Get Payment Types
HTTP Request
GET /payment_types
Scope
Property, Enterprise
JSON response body:
{
"payment_types": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"active": true,
"type": "payment",
"payment_group": "cash",
"updated_at": 1542812075,
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Nakit",
"locale": "tr"
},
{
"name": "Cash",
"locale": "en"
}
],
"metafields": [
{
"id": "65c4a8df-96cb-4f70-9c13-a8f65e2e2116",
"key": "tckn",
"value": "11111111111",
"value_type": "string",
"updated_at": 1656490113
}
]
}
]
}
Price Lists
Get Price Lists
GET /price_lists
Scope
Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 |
JSON response
{
"meta": {
"total_count": 1,
"current_page": 1,
"per_page_count": 50,
"total_page": 1,
"has_next_page": false
},
"price_lists": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price List 1",
"currency_setting_id": "5b1c4be7-1458-4e3c-9b3e-ae2fa08303c5",
"target_id": "5b1c4be7-1453-4r3c-9b6e-ae2fa08953c5",
"target_type": "Enterprise",
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price List 2",
"currency_setting_id": "5b1c4be7-1458-4e3c-9b3e-ae2fa08303c5",
"target_id": "5b1c4be7-1453-4r3c-9b6e-ae2fa08953c5",
"target_type": "Enterprise",
}
]
}
Get Price List
HTTP Request
GET /price_lists/:id
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price List 1",
"currency_setting_id": "5b1c4be7-1458-4e3c-9b3e-ae2fa08303c5",
"target_id": "5b1c4be7-1453-4r3c-9b6e-ae2fa08953c5",
"target_type": "Enterprise",
"price_list_source_items": [
{
"price": 100.0,
"source_type": "MenuItem",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
},
{
"price": 100.0,
"source_type": "MenuItem",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
]
}
Create Price List
HTTP Request
POST /apps/api/v1/price_lists
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| name | price list name | REQUIRED | |
| currency_setting_id | if this field given price will set as currency price | ||
| target_type | Enterprise or Property |
||
| target_id | price list target id | ||
| items[] | contains price list items | REQUIRED | |
| items[].source_id | price list item id | REQUIRED | |
| items[].price | price list item price | REQUIRED |
JSON request body:
{
"name": "Price List 1",
"currency_setting_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_type": "Property",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"items": [
{
"source_id": "090de589-398d-4446-b853-ba1ad989dae2",
"price": 10.00
},
{
"source_id": "090de589-398d-4446-b853-ba1ad989dae3",
"price": 20.00
}
]
}
JSON response body:
{
"price_list": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"name": "Price List 1"
}
}
Create Price List with Sku
HTTP Request
POST /apps/api/v1/price_lists_with_sku
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| name | price list name | REQUIRED | |
| currency_setting_id | if this field given price will change as currency price | ||
| target_type | Enterprise or Property |
||
| target_id | price list target id | ||
| items[] | contains price list items | REQUIRED | |
| items[].sku | price list item sku | REQUIRED | |
| items[].price | price list item price | REQUIRED |
JSON request body:
{
"name": "Price List 1",
"currency_setting_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"items": [
{
"sku": "123456789",
"price": 10.00
},
{
"sku": "987654321",
"price": 20.00
}
]
}
JSON response body:
{
"price_list": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"name": "Price List 1"
}
}
Update Price List
HTTP Request
PATCH /apps/api/v1/price_lists/:id
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| name | price list name | ||
| currency_setting_id | price list currency setting |
JSON request body:
{
"name": "Price List 1",
"currency_setting_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
JSON response body:
{
"price_list": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993"
}
}
Delete Price List
HTTP Request
DELETE /apps/api/v1/price_lists/:id
JSON response body:
204 No Content
Update Price List Items
HTTP Request
PATCH /apps/api/v1/price_list/:id/items
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| items[] | contains price list items | REQUIRED | |
| items[].source_id | price list item id | REQUIRED | |
| items[].price | price list item price | REQUIRED |
JSON request body:
{
"items": [
{
"source_id": "090de589-398d-4446-b853-ba1ad989dae2",
"price": 10.00
},
{
"source_id": "090de589-398d-4446-b853-ba1ad989dae3",
"price": 20.00
},
{
"source_id": "090de589-398d-4446-b853-ba1ad989dae4",
"price": 30.00
}
]
}
JSON response body:
200 OK
Update Price List Items with Sku
HTTP Request
PATCH /apps/api/v1/price_list_with_sku/:id/items
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| items[] | contains price list items | REQUIRED | |
| items[].sku | price list item sku | REQUIRED | |
| items[].price | price list item price | REQUIRED |
JSON request body:
{
"items": [
{
"sku": "090de589",
"price": 10.00
},
{
"sku": "ba1ad989dae3",
"price": 20.00
},
{
"sku": "398d",
"price": 30.00
}
]
}
JSON response body:
200 OK
Delete Price List Items
HTTP Request
DELETE /apps/api/v1/price_list/:id/items
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| source_ids[] | price list items source ids | REQUIRED |
JSON request body:
{
"source_ids": [
"090de589-398d-4446-b853-ba1ad989dae2",
"090de589-398d-4446-b853-ba1ad989dae3"
]
}
JSON response body:
204 No Content
Delete Price List Items with Sku
HTTP Request
DELETE /apps/api/v1/price_list_with_sku/:id/items
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| sku[] | price list items sku | REQUIRED |
JSON request body:
{
"sku": ["398d", "4446"]
}
JSON response body:
204 No Content
Scheduled Jobs
Get Scheduled Jobs
GET /scheduled_jobs
Scope
Enterprise, Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 |
JSON response
{
"meta": {
"total_count": 1,
"current_page": 1,
"per_page_count": 50,
"total_page": 1,
"has_next_page": false
},
"scheduled_jobs": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"source": "backoffice",
"status": "waiting",
"name": "John Doe",
"owner_type": "User",
"owner_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_type": "Enterprise",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price_list_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
]
}
Get Scheduled Job
HTTP Request
GET /scheduled_jobs/:id
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "John Doe",
"owner_type": "User",
"owner_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_type": "Enterprise",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"data": "---\n-
:item_definition_id: 6f6fc0e2-0839-4e2c-bcd9-dcc58be299af\n :active: true\n :price: 11.0\n-
:item_definition_id: 6f6fc0e2-0839-4e2c-bcd9-dcc58be299af\n :active: true\n :price: 11.0\n-
:item_definition_id: 6f6fc0e2-0839-4e2c-bcd9-dcc58be299af\n :active: true\n :price: 11.0\n-
:item_definition_id: 6f6fc0e2-0839-4e2c-bcd9-dcc58be299af\n :active: true\n :price: 11.0\n-",
"success_item_ids": [
"6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
],
"fail_item_ids": [
"6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
],
}
Create Scheduled Job
HTTP Request
POST /apps/api/v1/price_list_wizard
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| price_list_id | if price list has currency setting price will set as currency price | REQUIRED | |
| name | price list wizard name | REQUIRED | |
| perform_at | Example 2022-08-26T03:00:00.000+03:00 |
REQUIRED | |
| items[] | REQUIRED | ||
| items[].source_id | menu_item_id or condiment_id |
REQUIRED | |
| items[].price | Must be number and greater than zero | REQUIRED |
JSON request body:
{
"price_list_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price list wizard name",
"perform_at": "2022-08-26T03:00:00.000+03:00",
"items": [
{
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": 11.0
},
{
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": 11.0
}
]
}
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price list wizard name",
"perform_at": "2022-08-26T03:00:00.000+03:00"
}
Create Scheduled Job with Sku
HTTP Request
POST /apps/api/v1/price_list_wizard_with_sku
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| price_list_id | if price list has currency setting price will set as currency price | REQUIRED | |
| name | price list wizard name | REQUIRED | |
| perform_at | Example 2022-08-26T03:00:00.000+03:00 |
REQUIRED | |
| items[] | REQUIRED | ||
| items[].sku | menu item sku | REQUIRED | |
| items[].price | Must be number and greater than zero | REQUIRED |
JSON request body:
{
"price_list_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price list wizard name",
"perform_at": "2022-08-26T03:00:00.000+03:00",
"items": [
{
"sku": "123456789",
"price": "10.00"
},
{
"sku": "987654321",
"price": "20.00"
}
]
}
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price list wizard name",
"perform_at": "2022-08-26T03:00:00.000+03:00"
}
Update Scheduled Job
HTTP Request
PATCH /apps/api/v1/price_list_wizard/:id
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| price_list_id | if price list has currency setting price will set as currency price | REQUIRED | |
| name | price list wizard name | ||
| perform_at | Example 2022-08-26T03:00:00.000+03:00 |
||
| items[] | |||
| items[].source_id | menu_item_id or condiment_id |
||
| items[].price | Must be number and greater than zero |
JSON request body:
{
"price_list_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price list wizard name",
"perform_at": "2022-08-26T03:00:00.000+03:00",
"items": [
{
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": 11.0
},
{
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"price": 11.0
}
]
}
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price list wizard name",
"perform_at": "2022-08-26T03:00:00.000+03:00"
}
Update Scheduled Job with Sku
HTTP Request
PATCH /apps/api/v1/price_list_wizard_with_sku/:id
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| price_list_id | if price list has currency setting price will set as currency price | REQUIRED | |
| name | price list wizard name | ||
| perform_at | Example 2022-08-26T03:00:00.000+03:00 |
||
| items[] | |||
| items[].sku | menu item sku | ||
| items[].price | Must be number and greater than zero |
JSON request body:
{
"price_list_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price list wizard name",
"perform_at": "2022-08-26T03:00:00.000+03:00",
"items": [
{
"sku": "123456789",
"price": "10.00"
},
{
"sku": "987654321",
"price": "20.00"
}
]
}
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Price list wizard name",
"perform_at": "2022-08-26T03:00:00.000+03:00"
}
Shifts
Get Shifts
HTTP Request
GET /shifts
Scope
Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 10 | |
| device_id | ||
| business_date | Example 2019-01-21 |
|
| business_date_since | Example 2019-01-21 |
|
| business_date_until | Example 2019-01-21 |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 10,
"total_count": 1,
"total_page": 1
},
"shifts": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"sequence": 18,
"closing_note": "",
"status": "closed",
"business_date": "2020-07-03",
"created_by_employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"closed_by_employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"device_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"details": {
"end_date": "2020-07-03T15:15:53Z",
"start_date": "2020-07-03T13:20:14Z",
"start_cash": 12.5,
"cash_sales": 273.5,
"incoming": 7,
"outgoing": -4,
"end_cash": 291,
"amount_need_to_be": 289,
"difference_amount": 2
},
"payment_types": [
{
"tender_media_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Kredi Kartı",
"amount": 2
}
],
"cash_trackings": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": -4,
"currency_code": "TRY",
"description": "Çıkar",
"created_at": 1593775836,
"created_date": "2020-01-21"
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": 2,
"currency_code": "TRY",
"description": "Çıkart",
"created_at": 1593775826,
"created_date": "2020-01-21"
},
{
"id": "afb98ac1-8c11-48d3-800e-3c6d2b70bc45",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": 5,
"currency_code": "TRY",
"description": "test",
"created_at": 1593775711,
"created_date": "2020-01-21"
}
],
"started_cash_amounts": [
{
"amount": 64,
"currency_code": "USD"
}
],
"ended_cash_amounts": [
{
"amount": 64,
"currency_code": "USD"
}
]
}
]
}
Get Shift
HTTP Request
GET /shifts/:id
Scope
Property
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"sequence": 18,
"closing_note": "",
"status": "closed",
"business_date": "2020-07-03",
"created_by_employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"closed_by_employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"device_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"details": {
"end_date": "2020-07-03T15:15:53Z",
"start_date": "2020-07-03T13:20:14Z",
"start_cash": 12.5,
"cash_sales": 273.5,
"incoming": 7,
"outgoing": -4,
"end_cash": 291,
"amount_need_to_be": 289,
"difference_amount": 2
},
"payment_types": [
{
"tender_media_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Kredi Kartı",
"amount": 2
}
],
"cash_trackings": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": -4,
"currency_code": "TRY",
"description": "Çıkar",
"created_at": 1593775836,
"created_date": "2020-01-21"
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": 2,
"currency_code": "TRY",
"description": "Çıkart",
"created_at": 1593775826,
"created_date": "2020-01-21"
},
{
"id": "afb98ac1-8c11-48d3-800e-3c6d2b70bc45",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": 5,
"currency_code": "TRY",
"description": "test",
"created_at": 1593775711,
"created_date": "2020-01-21"
}
],
"started_cash_amounts": [
{
"amount": 64,
"currency_code": "USD"
}
],
"ended_cash_amounts": [
{
"amount": 64,
"currency_code": "USD"
}
]
}
Cash Trackings
Get Cash Trackings
HTTP Request
GET /cash_trackings
Scope
Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 10 | |
| created_date | Example 2019-01-21 |
|
| created_date_since | Example 2019-01-21 |
|
| created_date_until | Example 2019-01-21 |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 10,
"total_count": 1,
"total_page": 1
},
"cash_trackings": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": -4,
"currency_code": "TRY",
"description": "Çıkar",
"created_at": 1593775836,
"created_date": "2020-01-21"
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": 2,
"currency_code": "TRY",
"description": "Çıkart",
"created_at": 1593775836,
"created_date": "2020-01-21"
},
{
"id": "afb98ac1-8c11-48d3-800e-3c6d2b70bc45",
"shift_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": 5,
"currency_code": "TRY",
"description": "test",
"created_at": 1593775836,
"created_date": "2020-01-21"
}
]
}
Reason Payments
Get Reason Payments
HTTP Request
GET /reason_payments
Scope
Property, Enterprise
JSON response body:
{
"reason_payments": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1561789824,
"business_date": "2019-06-29",
"quantity": 1,
"total_amount": 15.9,
"employee_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"item_definition_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"reason_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"tender_media_id": null
}
]
}
Reasons
Reason kind values are: returned, cancelled, waste, refund, complimentary.
Get Reasons
HTTP Request
GET /reasons
Scope
Property, Enterprise
JSON response body:
{
"reasons": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1561568523,
"kind": "cancelled",
"active": true,
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Kasa Değişikliği",
"locale": "tr"
}
]
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"updated_at": 1561789408,
"kind": "waste",
"active": true,
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "Yere düştü",
"locale": "tr"
}
]
}
]
}
Properties
Get Properties
HTTP Request
GET /properties
Scope
Enterprise
Query Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| created_date_since | Example 2019-01-21 |
||
| created_date_until | Example 2019-01-21 |
||
| only_dealer | false | When true returns only dealer properties. |
JSON response body:
{
"properties": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"enterprise_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"enterprise_name": "BigBigBrother",
"name": "BigBrother",
"updated_at": 1561489865,
"created_at": 1561489865,
"default_language": "en",
"available_languages": [
"en"
],
"dealers": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Big Dealer"
}
],
"metafields": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"key": "UberEats",
"value": false,
"value_type": "boolean",
"updated_at": 1562576660
}
],
}
]
}
Currencies
Get Currencies
HTTP Request
GET /currencies
Scope
Property and Enterprise
JSON response body:
{
"currencies": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"iso_code": "EUR",
"last_sync_at": 1577397627,
"rate": 5.88,
"target_type": "Enterprise",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"iso_code": "USD",
"last_sync_at": 1577397628,
"rate": 5.89,
"target_type": "Property",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
]
}
Customers
Get Customers
HTTP Request
GET /customers
Scope
Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 100 | |
| only_active | false | Only active customers return |
| updated_at | 0 | This value when zero returns all customers. Format unix time. |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 100,
"total_count": 2,
"total_page": 1
},
"customers": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"first_name": "Big",
"last_name": "Brother",
"phone_number": "905555555555",
"email": "big@brother.com.tr",
"gender": "male",
"enterprise_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"created_at": 1582874207,
"updated_at": 1582874207,
"account_detail": {
"checks_count": 254,
"checks_paid_amount": 3453.25,
"total_current_account": 342.9,
"paid_current_account": 203,
"remaining_current_account": 139.9
},
"tags": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
],
"external_id": "dcc58be299af",
"metafields": [
{
"id": "65c4a8df-96cb-4f70-9c13-a8f65e2e2116",
"key": "tckn",
"value": "11111111111",
"value_type": "string",
"updated_at": 1656490113
}
]
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"first_name": "Big",
"last_name": "Brother",
"phone_number": "905555555555",
"email": "big@brother.com.tr",
"gender": "female",
"enterprise_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"created_at": 1587375290,
"updated_at": 1587375290,
"account_detail": {
"checks_count": 5,
"checks_paid_amount": 31.7,
"total_current_account": 0,
"paid_current_account": 0,
"remaining_current_account": 0
},
"tags": [],
"external_id": "6f6fc0e2",
"metafields": [
{
"clientCode": "21"
}
]
}
]
}
Add Customer
HTTP Request
POST /apps/api/v1/customers
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| phone_number | customer phone_number | REQUIRED | |
| customer email | |||
| first_name | customer first name | ||
| last_name | customer last name | ||
| gender | customer gender | ||
| external_id | customer external id | ||
| customer_address.address | customer adress | REQUIRED | |
| customer_address.label | customer adress label | ||
| customer_address.property_id | customer adress | ||
| customer_invoice.name | customer invoice name | REQUIRED | |
| customer_invoice.company | customer invoice company | REQUIRED | |
| customer_invoice.tax_admin | customer invoice tax admin | REQUIRED | |
| customer_invoice.tckn_or_vkn | customer invoice tckn or vkn | REQUIRED | |
| customer_invoice.company | customer invoice company | REQUIRED | |
| customer_invoice.address | customer invoice address | ||
| customer_invoice.email | customer invoice email | ||
| customer_invoice.description | customer invoice description |
JSON request body:
{
"email": "hildred@muller.co",
"first_name": "Noriko",
"last_name": "Ebert",
"phone_number": "1569714718",
"gender": 1,
"external_id": "6f6fc0e2",
"customer_address":
{
"address": "81412 Hane Trace",
"label": "West Wadeville",
"property_id": "ea6750f3-6f72-4f19-8564-5c73db0153d0"
},
"customer_invoice":
{
"company": "Rippin and Sons",
"tax_admin": "Bobby Abshire",
"tckn_or_vkn": "4799967681",
"name": "Ms. Ignacia Ziemann",
"address": "Apt. 545 2122 Ruecker Pines, Jerdeview, VA 68855-0750",
"email": "gavin@gottlieb.biz",
"description": "Perferendis sed non. Dignissimos non ipsa. Et quos velit."
}
}
JSON response body:
{
"customer":
{
"id": "a1e1cce8-5cc6-4fbb-aec0-5539962db183",
"name": "Noriko Ebert"
}
}
Update Customer
HTTP Request
PATCH /apps/api/v1/customers/:id
Scope
Enterprise
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| phone_number | customer phone_number | REQUIRED | |
| customer email | |||
| first_name | customer first name | ||
| last_name | customer last name | ||
| gender | customer gender | ||
| external_id | customer external id |
JSON request body:
{
"email": "hildred@muller.co",
"first_name": "Noriko",
"last_name": "Ebert",
"phone_number": "1569714718",
"gender": 1,
"external_id": "6f6fc0e2"
}
JSON response body:
{
"customer":
{
"id": "a1e1cce8-5cc6-4fbb-aec0-5539962db183",
"name": "Noriko Ebert"
}
}
Tags
Get Tags
HTTP Request
GET /tags
Scope
Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| type | "item_definition | item_definition or customer |
| active | true |
JSON response body:
{ "tags": [ { "id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af", "updated_at": 1646826803, "translations": [ { "locale": "en", "name": "Best Products" }, { "locale": "tr", "name": "Çok Satanlar" } ] } ] }
Imports
Get Imports
HTTP Request
GET /imports/:id
Scope
Property, Enterprise
Query Parameters
| Parameter | Default | Description |
|---|
JSON response body:
{
"status": "finished",
"message": null
}
Opera Checks
Index
HTTP Request
GET /apps/api/v1/opera_checks
Scope
Property
JSON response body:
{
"checks": [
{
"CheckPaymentId": "b8109714-c42f-4f33-abe1-add43aa79984",
"Data": {
"Room": null,
"GuestName": null,
"GuestNumber": 1,
"CheckNumber": 1,
"Waiter": "RW1wbG95ZWUtZmE0ZGQzMTctZjJmZi00OTU4LWFiM2ItZTgzNGE3YmQ5NjQ2",
"Location": 0,
"Period": 1,
"GuestIndex": 1,
"Date": 1665649715,
"Payment": 41,
"PrePay": 0.0,
"ServiceCharge": 0.0,
"TaxItemizer": 0,
"SelectedAmount": 0.0,
"CilentId": 0,
"CheckTotal": 0.0,
"SelectedItemIds": [
"Q2hlY2tJdGVtLThlMmRjNzVhLWFiNDQtNDNjMS04ZjYzLWNkMDBlZWRmMDdhZg==",
"Q2hlY2tJdGVtLTNhZjZjMDQzLTZkZmYtNGEzMi1iYjIzLTJjYzNhMjJhMDhiNg==",
"Q2hlY2tJdGVtLTYxYjkyMDc1LTc4NTQtNDQ4OS1hYzZjLTNmN2Y3ZjFkYjQxMA=="
],
"Items": [
{
"Quantity": 1.0,
"Original_Amount": 9.84236453,
"Discount_Amount": 0.0,
"Tax_Id": "VGF4LTQwMmQ0OTE5LThlYTgtNGYyNi04NDhkLTViMjVmN2U1YWE2NA==",
"Item_Ids": [
"Q2hlY2tJdGVtLThlMmRjNzVhLWFiNDQtNDNjMS04ZjYzLWNkMDBlZWRmMDdhZg=="
],
"Condiments": []
},
{
"Quantity": 1.0,
"Original_Amount": 2.95566502,
"Discount_Amount": 0.0,
"Tax_Id": "VGF4LTUyMTM0YzMyLWMxY2EtNDI2Yy04ZGVmLTJlZmQ1YzhmYzUxNQ==",
"Item_Ids": [
"Q2hlY2tJdGVtLTNhZjZjMDQzLTZkZmYtNGEzMi1iYjIzLTJjYzNhMjJhMDhiNg=="
],
"Condiments": [
{
"Quantity": 1.0,
"Original_Amount": 2.95566502,
"Discount_Amount": 0.0,
"Tax_Id": "VGF4LTk0ZmQ1ZmU5LThmZDgtNDI3OS05NjdiLTMxZWVkMDk3MjI0NQ==",
"Item_Ids": [
"Q2hlY2tJdGVtLTUwYzhkMGI1LWMzYTgtNGU0YS1iODIxLWY4MWIzMTBkZTExOA=="
]
}
]
}
],
"Taxes": [
{
"id": "VGF4LTNkNjI4MWM5LTk3ZDYtNDBjMS05ZmQ4LWY0YjY0YzJmNzAzOA==",
"name": "MyString",
"rate": 1.5,
"external_id": 1
},
{
"id": "VGF4LTQwMmQ0OTE5LThlYTgtNGYyNi04NDhkLTViMjVmN2U1YWE2NA==",
"name": "MyString",
"rate": 1.5,
"external_id": 2
},
{
"id": "VGF4LWM1MGZkNTA0LTU3OGMtNDA0Ni1hMmIxLTkzZjE0NGNiYmI3ZA==",
"name": "MyString",
"rate": 1.5,
"external_id": 3
},
{
"id": "VGF4LTUyMTM0YzMyLWMxY2EtNDI2Yy04ZGVmLTJlZmQ1YzhmYzUxNQ==",
"name": "MyString",
"rate": 1.5,
"external_id": 4
}
]
}
}
]
}
Mark As Sent Opera Pms Check
HTTP Request
PATCH /apps/api/v1/checks/:check_payment_id/mark_as_sent_opera_pms
Scope
Property
JSON response body:
{
"success": true
}
Checks - Add Portal Plus Invoice Id
Add Portal Plus Invoice Id to Check
HTTP Request
POST /apps/api/v1/checks/:id/add_portal_plus_invoice_id
Scope
Property
Body Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| invoice_id | Portal Plus invoice id | REQUIRED |
JSON response body:
{
"success": true
}
Current Accounts
Get Current Accounts
HTTP Request
GET /current_accounts/:customer_id
Scope
Enterprise
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | |
| per_page | 50 | |
| updated_at | 0 | This value when zero returns all current accounts. Format unix time. |
| only_paid | false | Only paid current accounts |
| created_date_since | Example 2020-04-23 |
|
| created_date_until | Example 2020-08-30 |
JSON response body:
{
"meta": {
"has_next_page": false,
"current_page": 1,
"per_page_count": 50,
"total_count": 2,
"total_page": 1
},
"account_payments": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": 68.5,
"paid": false,
"check_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"created_at": 1590140253,
"transactions": []
},
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"amount": 23.4,
"paid": false,
"check_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"created_at": 1582880910,
"transactions": [
{
"amount": 2,
"discount_amount": 5,
"detail": null,
"payment_type": "cash",
"created_at": 1582881311
},
{
"amount": 1,
"discount_amount": 0,
"detail": null,
"payment_type": "cash",
"created_at": 1582881474
},
{
"amount": 1,
"discount_amount": 0,
"detail": null,
"payment_type": "cash",
"created_at": 1582882207
},
{
"amount": 1,
"discount_amount": 0,
"detail": null,
"payment_type": "cash",
"created_at": 1582882696
},
{
"amount": 1,
"discount_amount": 0,
"detail": null,
"payment_type": "cash",
"created_at": 1582882933
},
{
"amount": 1,
"discount_amount": 0,
"detail": null,
"payment_type": "cash",
"created_at": 1582883134
},
{
"amount": 2,
"discount_amount": 0,
"detail": null,
"payment_type": "cash",
"created_at": 1582883160
},
{
"amount": 1,
"discount_amount": 0,
"detail": null,
"payment_type": "cash",
"created_at": 1582883168
}
]
}
]
}
Z Reports
Get Z Reports
HTTP Request
GET /z_reports
Scope
Property
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| z_no | ||
| fiscal_number | ||
| z_date | Example: 2019-02-24 |
|
| z_date_since | Example: 2019-02-24 |
|
| z_date_until | Example: 2019-02-24 |
JSON response body:
{
"z_reports": [
{
"id": "bfbd5ad1-166b-4313-9305-f7dbeb4a3c46",
"cash_amount": 144.38,
"credit_amount": 0,
"cumulative_amount": 1380.34,
"cumulative_tax_vat": 154.35,
"daily_total_amount": 14.38,
"daily_total_vat": 1.49,
"fiscal_number": "JA10024024",
"number_of_customer_receipt": 4,
"number_of_error_correction": 0,
"number_of_fiscal_receipt": 0,
"number_of_non_fiscal_receipt": 0,
"number_of_percent_decrease": 0,
"number_of_percent_increase": 0,
"number_of_sales_canceled_receipt": 0,
"number_of_sales_invoice": 0,
"vats": [
{
"tax_vat": 13.38,
"tax_rate": 0,
"tax_amount": 13.38
}
],
"z_datetime": "2019-02-24T13:39:09Z",
"z_number": "521",
"property_id": "3bd8b714-45c5-427d-8a24-29562759d116"
}
]
}
Accounting API
Get Property
HTTP Request
GET /properties/:id
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"enterprise_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "BigBrother",
"updated_at": 1561489865,
"deleted_at": null,
"created_at": 1555938631,
"default_language": "tr",
"available_languages": [
"tr"
],
"first_payment_date": 1562074436,
"last_payment_date": 1562074482,
"cards_count": 0,
"interval_count": 1,
"plan": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "BigBrother Price",
"locale": "en"
}
]
}
}
Get Enterprise
HTTP Request
GET /enterprises/:id
JSON response body:
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "BigBrother",
"cards_count": 0,
"trial_ends_at": 1562007660,
"created_at": 1548758257,
"updated_at": 1562051178,
"deleted_at": null,
"first_payment_date": 1558943022,
"last_payment_date": 1559285536,
"interval_count": 1,
"properties": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "BigBrother Barcelona",
"default_language": "en",
"dealers": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Big Dealer"
}
],
"created_at": 1559051299,
"deleted_at": null
}
],
"plan": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"translations": [
{
"name": "BigBrother Plan",
"locale": "en"
}
]
}
}
Get Enterprises
HTTP Request
GET /enterprises
Scope
Global
Query Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| created_date_since | Example 2019-01-21 |
||
| created_date_until | Example 2019-01-21 |
JSON response body:
{
"enterprises": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "BigBrother",
"cards_count": 0,
"trial_ends_at": 1562007660,
"dealers": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Big Dealer"
}
],
"created_at": 1548758257,
"updated_at": 1562051178,
"deleted_at": null,
"properties": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "BigBrother Barcelona",
"default_language": "en",
"dealers": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Big Dealer"
}
],
"created_at": 1559051299,
"deleted_at": null
}
]
}
]
}
Get Payment
HTTP Request
GET /payments/:id
Scope
Global
JSON response body:
{
"payment_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"transaction_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_type": "Enterprise",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"plan_type": "lite",
"amount": 99,
"currency_code": "TRY",
"licenses_count": 1,
"tax_rate": 18,
"payment_type": "Credit Card",
"status": "Paid",
"payment_error": null,
"created_at": 1562918440,
"target_invoice_attributes": {
"email": "bigbrother@barcelona.com",
"address": "Barcelona/Spain",
"tax_office": "Barcelona",
"tckn_or_vkn": "10577420736",
"company_title": "Bigbrother"
},
"portal_plus_response": {
"InvoiceNo": "SEP1023111156465",
"InvoiceIntId": 432734,
"ExternalTrackNo": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"SendInvoiceResult": null
},
"licenses": [
{
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_name": "iPad",
"target_platform": "ios",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"discount_amount": 0,
"original_price": 99,
"paid_price": 99,
"tax_amount": 15.1,
"unit_price": 83.9,
"created_at": 1562907640,
"activation_at": 1562907640,
"license_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"key": "F5E05535",
"interval_count": 1,
"date_of_renewal": 1586390400,
"expires_at": 1586379600
}
]
}
Get Payments
HTTP Request
GET /payments
Scope
Global
Query Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| status | Available statuses: pending, paid, unpaid |
||
| only_dealer | false | When true returns only dealer payments. |
|
| created_date_since | Example 2019-01-21 |
||
| created_date_until | Example 2019-01-21 |
JSON response body:
{
"payments": [
{
"payment_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"transaction_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_type": "Enterprise",
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"plan_type": "lite",
"amount": 99,
"currency_code": "TRY",
"licenses_count": 1,
"tax_rate": 18,
"payment_type": "Credit Card",
"status": "Paid",
"payment_error": null,
"created_at": 1562918440,
"target_invoice_attributes": {
"email": "bigbrother@barcelona.com",
"address": "Barcelona/Spain",
"tax_office": "Barcelona",
"tckn_or_vkn": "10577420736",
"company_title": "Bigbrother"
},
"portal_plus_response": {
"InvoiceNo": "SEP1023111156465",
"InvoiceIntId": 432734,
"ExternalTrackNo": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"SendInvoiceResult": null
},
"licenses": [
{
"target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"target_name": "iPad",
"target_platform": "ios",
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"discount_amount": 0,
"original_price": 99,
"paid_price": 99,
"tax_amount": 15.1,
"unit_price": 83.9,
"created_at": 1562907640,
"activation_at": 1562907640,
"license_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"key": "F5E05535",
"interval_count": 1,
"date_of_renewal": "2019-08-12",
"expires_at": 1586379600
}
]
}
]
}
Get Future Payments
HTTP Request
GET /future_payments
Scope
Global
Query Parameters
| Parameter | Default | Description | Required |
|---|---|---|---|
| date_of_renewal_since | Example 2019-01-21 |
||
| date_of_renewal_until | Example 2019-01-21 |
||
| only_has_payments | false | true or false |
JSON response body:
{
"future_payments": [
{
"owner_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"owner_type": "Enterprise",
"date_of_renewal": 1562976000,
"licenses_count": 1,
"owner_name": "BigBrother",
"currency_code": "TRY",
"amount": 40,
"licenses": [
{
"platform": "android",
"name": "samsung SM-T700",
"type": "device"
}
]
},
{
"owner_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"owner_type": "Property",
"date_of_renewal": 1564358400,
"licenses_count": 2,
"owner_name": "BigBrother Barcelona",
"currency_code": "TRY",
"amount": 200,
"licenses": [
{
"platform": "android",
"name": "samsung SM-T700",
"type": "device"
},
{
"platform": "WizloOrder",
"name": "Wizlo",
"type": "extension"
}
]
}
]
}
Get Dealers
HTTP Request
GET /dealers
Scope
Global
JSON response body:
{
"dealers": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "BigBorther",
"created_at": 1560411878,
"updated_at": 1560411878
}
]
}
Daily Totals
Get Daily Totals
HTTP Request
GET /daily_totals
Scope
Property, Enterprise
Query Parameters
| Parameter | Default | Description | Reqired |
|---|---|---|---|
| business_date | Example 2023-05-24 |
REQUIRED | |
| serial_number |
JSON response body:
[
{
"property_id": "c9bc56b8-d768-4fa4-9458-3b39c1bc1630",
"shift_id": null,
"ext_no": null,
"terminal_no": "F67472FC-75F4-4D33-80DF-C50AEB27A230",
"business_date": "2023-02-08T00:00:00Z",
"number_of_document": 3,
"number_of_non_financial_transactions": 6,
"cash_amount": 0,
"credit_card_amount": 0,
"food_card_amount": 183.16,
"daily_total": 416.16,
"daily_tax_total": 56.4,
"taxes": [
{
"rate": 18.0,
"amount": 55.04,
"total": 10
},
{
"rate": 1.0,
"amount": 0.42,
"total": 4
},
{
"rate": 8.0,
"amount": 0.94,
"total": 1
}
]
},
{
"property_id": "c9bc56b8-d768-4fa4-9458-3b39c1bc1630",
"shift_id": null,
"ext_no": null,
"terminal_no": "F67472FC-75F4-4D33-80DF-C50AEB27AD30",
"business_date": "2023-02-08T00:00:00Z",
"number_of_document": 0,
"number_of_non_financial_transactions": 2,
"cash_amount": 0,
"credit_card_amount": 0,
"food_card_amount": 22.68,
"daily_total": 22.68,
"daily_tax_total": 2.03,
"taxes": [
{
"rate": 1.0,
"amount": 0.1,
"total": 1
},
{
"rate": 18.0,
"amount": 1.93,
"total": 1
}
]
}
]
V2 Daily Totals
Get V2 Daily Totals
HTTP Request
GET /v2/daily_totals
Scope
Property, Enterprise
Query Parameters
| Parameter | Default | Description | Reqired |
|---|---|---|---|
| page | 1 | ||
| per_page | 50 | ||
| business_date | Example 2023-05-24 |
REQUIRED |
JSON response body:
[
{
"property_id": "c9bc56b8-d768-4fa4-9458-3b39c1bc1630",
"shift_id": null,
"ext_no": null,
"terminal_no": "F67472FC-75F4-4D33-80DF-C50AEB27A230",
"business_date": "2023-02-08T00:00:00Z",
"number_of_document": 3,
"number_of_non_financial_transactions": 6,
"cash_amount": 0,
"credit_card_amount": 0,
"food_card_amount": 183.16,
"daily_total": 416.16,
"daily_tax_total": 56.4,
"cancelled_total": 2.0,
"cancelled_cash":100.0,
"cancelled_credit_card":20.0,
"cancelled_food_card":0.0,
"cancelled_count":2,
"taxes": [
{
"rate": 18.0,
"amount": 55.04,
"total": 10,
"cancelled_tax_amount": 50.0,
"cancelled_tax_total": 23.64
},
{
"rate": 1.0,
"amount": 0.42,
"total": 4,
"cancelled_tax_amount": 80.0,
"cancelled_tax_total": 14.64
},
{
"rate": 8.0,
"amount": 0.94,
"total": 1,
"cancelled_tax_amount": 260.0,
"cancelled_tax_total": 40.00
}
]
},
{
"property_id": "c9bc56b8-d768-4fa4-9458-3b39c1bc1630",
"shift_id": null,
"ext_no": null,
"terminal_no": "F67472FC-75F4-4D33-80DF-C50AEB27AD30",
"business_date": "2023-02-08T00:00:00Z",
"number_of_document": 0,
"number_of_non_financial_transactions": 2,
"cash_amount": 0,
"credit_card_amount": 0,
"food_card_amount": 22.68,
"daily_total": 22.68,
"daily_tax_total": 2.03,
"cancelled_total": 14.0,
"cancelled_cash":160.0,
"cancelled_credit_card":100.0,
"cancelled_food_card":0.0,
"cancelled_count":2,
"taxes": [
{
"rate": 1.0,
"amount": 0.1,
"total": 1,
"cancelled_tax_amount": 260.0,
"cancelled_tax_total": 23.64
},
{
"rate": 18.0,
"amount": 1.93,
"total": 1,
"cancelled_tax_amount": 100.0,
"cancelled_tax_total": 50.0
}
]
}
]
Errors
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 404 | Not Found -- Route not found. |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
Messages for HTTP Status Code 400
{
"message": "There was a problem parsing the JSON. Please check that it is formed correctly",
"code": 1000
}
{
"message": "per_page must not be negative",
"code": 1001
}
{
"message": "page must not be negative",
"code": 1002
}
Messages for HTTP Status 401
{
"message": "Missing access token",
"code": 3000
}
{
"message": "Permission denied",
"code": 3001
}
Messages for HTTP Status 404
{
"message": "Route not found",
"code": 2000
}
{
"message": "Property not found",
"code": 2001
}
{
"message": "Enterprise not found",
"code": 2002
}
{
"message": "field_name is required field.",
"code": 1005
}
Messages for HTTP Status 500
{
"message": "An unexpected error occurred",
"code": 0
}
Changelog
24 April 2025
- Add GET
/v2/menu_items/:idendpoint.
27 November 2024
- Add
extra_field_mappingsfor get/tender_medias,/discountsand/customers
1 November 2024
- Add
annotationfield tocheck_discountin get/checksendpoint - Add
check_offersfield to get/checksendpoint
16 January 2024
- Add Enterprise scope to
/payment_types,/reasons,/reason_payments,/combo_menusand/custom_menu_itemsendpoints.
01 November 2023
- Add
typeandpayment_groupto GET/payment_typesendpoint
18 October 2023
- Add
section_idto GET/tablesendpoint - Add
translationsto GET/sectionsendpoint - Add GET
/section_thingsendpoint
28 September 2023
- Add
cancelled_cashto GET/v2/daily_totalsendpoint - Add
cancelled_credit_cardto GET/v2/daily_totalsendpoint - Add
cancelled_food_cardto GET/v2/daily_totalsendpoint - Add
cancelled_countto GET/v2/daily_totalsendpoint
27 September 2023
- Add
planto GET/tablesendpoint - Add GET
/sectionsendpoint
15 September 2023
- Add
cancelled_totalto GET/v2/daily_totalsendpoint
27 July 2023
- Add
target_idandtarget_typeto GET/price_listsand GET/price_lists/:idendpoint
14 July 2023
- Added check item values.
- Added reason kind values.
16 June 2023
- Set DEPRECATED GET
/menu_itemsendpoint.
16 May 2023
- Added GET
/check_activitiesendpoint.
15 May 2023
- Add GET
/daily_totalsendpoint
12 April 2023
- Added
source_idfield to GET/item_definitionsendpoint.
11 April 2023
- Added
extrasfield to POST/apps/api/v1/checksendpoint.
23 February 2023
- Added POST
/apps/api/v1/checks/:id/unlockendpoint. - Added POST
/apps/api/v1/checks/:id/add_service_messageendpoint.
23 December 2022
- Add condiments detail to GET
/apps/api/v1/opera_checks
30 November 2022
- Added GET
/imports/:idendpoint.
24 November 2022
- Added
skuquery param to GETv2/menu_items
10 November 2022
- Added
registration_nofield to GET/employees
03 November 2022
- Add DELETE
/apps/api/v1/price_list_with_sku/:id/itemsendpoint. - Add PATCH
/apps/api/v1/price_list_with_sku/:id/itemsendpoint. - Add
started_cash_amountsandended_cash_amountsfields to GET/shiftsand GET/shifts/:id
19 October 2022
- [Property Token] Added POST
/apps/api/v1/checks/:id/add_portal_plus_invoice_idendpoint.
13 October 2022
- Added
CheckIdfield to GET/apps/api/v1/opera_checks - [Property Token] Added GET
/apps/api/v1/opera_checksendpoint. - [Property Token] Added GET
/apps/api/v1/checks/:id/mark_as_sent_opera_pmsendpoint.
11 October 2022
- Add
capacityfield to GET/tablesendpoint.
26 September 2022
- [Enterprise Token] Added POST
/apps/api/v1/price_lists_with_skuendpoint. - [Enterprise Token] Added POST
/apps/api/v1/price_list_wizard_with_skuendpoint. - [Enterprise Token] Added PATCH
/apps/api/v1/price_list_wizard_with_sku/:idendpoint.
23 September 2022
- [Enterprise Token] Added POST
/apps/api/v1/menu_items/upsertendpoint. - Add
currency_setting_idfield to POST/apps/api/v1/price_listsendpoint. - Add
currency_setting_idfield to PATCH/apps/api/v1/price_listsendpoint.
22 September 2022
- Add
shift_idfield to GET/checks - Add
shift_idfield to GET/checks/:id
21 September 2022
- Add
external_idfield to POST/apps/api/v1/customers - Add
external_idfield to PATCH/apps/api/v1/customers/:id - Add
currency_setting_idfield to GETprice_lists - Add
currency_setting_idfield to GETprice_lists/:id
20 September 2022
- Add
external_idfield to GET/customers
08 September 2022
- Added
report_tag_idsfield to POST/apps/api/v1/menu_items. - Added
report_tag_idsfield to PATCH/apps/api/v1/menu_items/{id}. - [Enterprise Token] Added DELETE
/apps/api/v1/menu_items/{id}/report_tags.
07 September 2022
- [Enterprise Token] Added GET
/tagsendpoint. - Added
tagsfield to GET/customerendpoint response.
02 September 2022
- Added
skufield to GET/v2/menu_itemsendpoint response.
01 September 2022
- Added
source,statusandprice_list_idfields to GET/scheduled_jobsendpoint response.
26 August 2022
- [Enterprise Token] Added PATCH
/apps/api/v1/price_list_wizard/:idendpoint.
25 August 2022
- [Enterprise Token] Added POST
/apps/api/v1/price_list_wizardendpoint.
15 August 2022
- [Enterprise Token] Added GET
/report_tagsendpoint.
12 August 2022
- [Enterprise Token] Added PATCH
/apps/api/v1/report_tags/:idendpoint. - [Enterprise Token] Added POST
/apps/api/v1/report_tagsendpoint.
10 August 2022
- [Enterprise Token] Added POST
/apps/api/v1/customersendpoint. - [Enterprise Token] Added PATCH
/apps/api/v1/customers/:idendpoint.
08 July 2022
- Added GET
/scheduled_jobsand/scheduled_jobs/:idendpoints. - Added GET
/price_listsand/price_lists/:idendpoints.
07 Jul 2022
- [Enterprise Token] Added GET
/revenue_centersendpoint. - [Enterprise Token] Added GET
/sales_channelsendpoint. - [Enterprise Token] Added GET
/propertiesendpoint. - Added
meta(pagination) to GET/revenue_centersendpoint. - Added
meta(pagination) to GET/sales_channelsendpoint.
08 Apr 2022
- [Enterprise Token] Added PATCH
/apps/api/v1/menu_items/:idendpoint.
05 Apr 2022
- [Enterprise Token] Added POST
/apps/api/v1/menu_itemsendpoint.
11 Feb 2022
- [Accounting API] Added
activation_atto/paymentsendpoint response.
25 Jan 2022
- Added
is_size_optionto GET/item_definitionsendpoint.
10 Jan 2022
- Added
meta(pagination) to GET/condiment_groupsendpoint.
07 Jan 2022
- Added GET
/v2/condimentsendpoint. - Added
orderfield to GET/item_definitionsendpoint response.
06 Jan 2022
- Added
closed_at_sinceandclosed_at_untilquery params to GET/checks - Added
closed_atfield to GET/checksand GET/checks/:idendpoint response.
28 Dec 2021
- Added GET
/v2/menu_itemsendpoint. - Added GET
/item_definitionsendpoint.
03 Dec 2021
- Added
devicefield for check payments to GET/checksendpoint response.
09 Nov 2021
- Added
metafieldsto GET/propertiesendpoint response. - Added
metafieldsto GET/service_chargesendpoint response. - Added new example create check for override price.
26 Oct 2021
- Added
extrasfield to GET/checksendpoint response.
02 Apr 2021
- Added
phone_numberfield to GET/employeesendpoint response. - Added
phone_numberfield to GET/checksemployee response.
28 Dec 2020
- Added
metafieldsfield to GET/revenue_centersendpoint response.
10 Nov 2020
- Added
updated_atfilter toGET /checks. - The maximum number of records per page has been updated to
500.
21 Oct 2020
- Added GET
/cash_trackingsendpoint.
12 Oct 2020
- Added GET
/shiftsand GET/shifts/:idendpoints.
25 Aug 2020
- Added GET
/customersand GET/current_accounts/:customer_idendpoints.
19 Aug 2020
- Added
payment_statusfield to GET/checkscheck_items response.
29 Jul 2020
- Added
payment_idparam to /apps/api/v1/checks/:check_id/check_payments` endpoint.
22 Jul 2020
- Added POST
/apps/api/v1/checks/:check_id/check_paymentsendpoint.
21 Jul 2020
- [Accounting API] Added
only_has_paymentsquery param to/future_payments
03 Jul 2020
- Added
table_idto GET/checksquery parameters.
28 Apr 2020
- Added
combo_itemsto POST/checksparameters.
20 Apr 2020
- Added GET
/combo_menusendpoint.
10 Apr 2020
- [Accounting API] Added
interval_countfield to/paymentsendpoint.
03 Apr 2020
- [Accounting API] Added
expires_atfield to/paymentsendpoint.
18 Mar 2020
- Added GET
/employeesendpoint.
17 Mar 2020
- [Accounting API] Added GET
/payments/:idendpoint.
14 Feb 2020
- [Accounting API] Added
only_dealerto GET/propertiesquery parameters. - [Accounting API] Added
statusto GET/paymentsquery parameters.
23 Jan 2020
- [Accounting API] Added
only_dealerto GET/paymentsquery parameters. - [Accounting API] Added
dealersfor properties to GET/enterprisesresponse. - [Accounting API] Added
enterprise_namefor properties to GET/propertiesresponse.
17 Jan 2020
- [Accounting API] Changed
duration_in_monthstointerval_count.
12 Jan 2020
- [Accounting API] Added
created_date_sinceandcreated_date_untiltoGET /properties. - [Accounting API] Added
created_date_sinceandcreated_date_untiltoGET /enterprises. - [Accounting API] Added
created_date_sinceandcreated_date_untiltoGET /payments. - [Accounting API] Added
date_of_renewal_sinceanddate_of_renewal_untiltoGET /future_payments.
30 Dec 2019
- Added
z_date_sinceandz_date_untiltoGET /z_reportsquery parameters. - Added
revenue_center_idandsales_channel_idtoPOST /checksparameters.
27 Dec 2019
- Added
GET /sales_channelsendpoint. - Added
GET /currenciesendpoint. - [Accounting API] Removed
currency_idfield from/future_payments. - [Accounting API] Added
property_idfield to/paymentslicenses.
20 Dec 2019
- Added
GET /tablesendpoint.
07 Nov 2019
- Added tax to
GET /checkscheck service charge response.
05 Nov 2019
- Added
barcodestoGET /menu_itemsresponse.
21 Oct 2019
- Added
metafieldstoGET /menu_itemsresponse. - Added
business_date_since,business_date_untilandstatustoGET /checksquery parameters. - Added
discount_idandservice_charge_idtoGET /checksresponse. - Added
updated_atfilter toGET /condiments.
16 Oct 2019
- Added
sequencetoPOST /checksresponse.
25 Sep 2019
- Added
updated_attoGET /menu_itemsresponse. - Added
idtoGET /custom_menu_itemsitem definitions response.
12 Sep 2019
- [Accounting API] Added
plan_typetoGET /paymentsresponse.
10 Sep 2019
- Returns all extra payment information on
GET /checks. - [Accounting API] Added
transaction_idfield toGET /paymentsresponse.
23 Aug 2019
- [Accounting API] Added
licensesfield toGET /future_paymentsresponse.
07 Aug 2019
- Added
metatoGET /checksresponse for pagination. - Added new endpoints:
GET /discountsandGET /service_charges. - Added Errors section.
- Added Changelog section.
- [Accounting API] Fixed
first_payment_dateandlast_payment_datevalues. - [Accounting API] Updated
GET /dealers,GET /propertiesandGET /enterprisesendpoints.