Create Check
Production
https://api.simpra.app
Production
https://api.simpra.app
POST
https://api.simpra.app
Last modified:2026-07-30 09:23:14
menu_items[].id.menu_items[].condiments[].id.menu_items[].id.menu_items[].unit_amount.menu_items[].name.menu_items[].unit_amount.discounts[].amount.customer.phone_number.takeaway on extension settings.| 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 |
Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.simpra.app/apps/api/v1/checks' \
--header 'Simpra-Access-Token: <api-key>' \
--header 'Content-Type: application\json' \
--data-raw '{
"menu_items": [
{
"id": "090de589-398d-4446-b853-ba1ad989dae2",
"quantity": 1,
"notes": [
"hot"
],
"condiments": [
{
"id": "19f7b0f5-fa49-4918-98c4-142ad2a14730"
}
],
"combo_items": [
{
"id": "3213d733-5311-440b-ad41-92640a7250ff",
"combo_group_item_id": "4d0a869e-7bee-4c58-ae25-6d3bf20622f8"
}
],
"unit_amount": 10,
"name": "TeaWithCoffee"
}
],
"discounts": [
{
"amount": 10
}
],
"customer": {
"phone_number": "319003205832",
"first_name": "Big",
"last_name": "BigBrother",
"email": "big@brother.com",
"gender": "female"
},
"delivery": {
"address": "BigBrother No.10",
"note": "Life is short"
},
"extras": [
{
"key": "iwallet_card_number",
"value": "1234567890"
}
],
"note": "fast",
"table": "249934c8-892e-40ac-aced-ee6338d14388",
"alias_name": "Brothers",
"female_cover": 2,
"male_cover": 2,
"child_cover": 4,
"revenue_center_id": "2291e5ec-b0d7-4b98-a273-c644c6f6e756"
}'Response Response Example
{
"check": {
"id": "c2cb6f75-88c1-4ab6-99af-a9d6b7822993",
"sequence": 111
}
}Modified at 2026-07-30 09:23:14