# Devices

This endpoint returns information about the business configured devices.

# The Device Object

# Sample

{
  "app_version": "5.0.27.sandbox",
  "branch": {
    "accepts_reservations": true,
    "address": null,
    "created_at": "2022-02-14 09:29:27",
    "deleted_at": null,
    "id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
    "inventory_end_of_day_time": "06:00",
    "latitude": "30.033333",
    "longitude": "31.233334",
    "name": "Branch 1",
    "name_localized": "branch1",
    "opening_from": "01:00",
    "opening_to": "22:00",
    "phone": null,
    "receipt_footer": "Thank you",
    "receipt_header": "Welcome",
    "receives_online_orders": true,
    "reference": "B01",
    "reservation_duration": 30,
    "reservation_times": null,
    "settings": {
      "branch_tax_number": "12345",
      "branch_tax_registration_name": "tax-reg-name"
    },
    "type": 1,
    "updated_at": "2022-05-18 22:00:11"
  },
  "build": "240",
  "code": "*****",
  "created_at": "2022-02-14 09:29:27",
  "deleted_at": null,
  "first_activation_at": null,
  "group": null,
  "id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
  "in_use": true,
  "is_blocked": false,
  "is_online_receiver": true,
  "last_order_at": null,
  "last_seen_at": "2022-05-18 14:52:47",
  "last_sync_at": "2022-05-17 23:42:18",
  "latitude": null,
  "local_settings": {
    "peripherals": {
      "cashiers": [],
      "displays": [],
      "finger_print_scanners": [],
      "kdses": [],
      "notifiers": [],
      "payment_terminals": [],
      "printers": [],
      "scales": []
    },
    "tables_configs": [
      {
        "table_id": "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
        "x_coordinate": 23,
        "y_coordinate": 2
      },
      {
        "table_id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
        "x_coordinate": 21,
        "y_coordinate": 12
      }
    ]
  },
  "longitude": null,
  "model": "iPad12,1",
  "name": "Cashier 1",
  "reference": "C01",
  "settings": {
    "ahead_order_reminder_in_minutes": 0,
    "auto_accept_and_send_online_orders_to_kitchen": true,
    "cashier_assigned_tables": [
      "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
      "95ed1bc6-766d-4d68-b369-2d82faf2ea07"
    ],
    "cashier_reset_order_number_at": 1000,
    "cashier_start_order_number_at": 100,
    "default_order_tags": [],
    "end_of_day_report_email": "jack@Ristecho.com",
    "kitchen_print_language": "3",
    "print_online_order_when_received": true,
    "shift_report_email": "jack@Ristecho.com",
    "till_report_email": "jack@Ristecho.com"
  },
  "system_version": "iOS 15.1",
  "tags": [
    {
      "created_at": "2022-05-19 12:16:02",
      "deleted_at": null,
      "id": "965608a2-eeff-4952-b4b0-7a1bb5e47bcf",
      "name": "Cashier_device",
      "name_localized": null,
      "pivot": {
        "device_id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
        "tag_id": "965608a2-eeff-4952-b4b0-7a1bb5e47bcf"
      },
      "type": 8,
      "updated_at": "2022-05-19 12:16:02"
    }
  ],
  "type": 1,
  "updated_at": "2022-05-19 12:15:16"
}

# Attributes

Field	Type	Rule	Description
`id`	`string`		Unique identifier for the device.
`name*`	`string`	`updatable`	Name of the device.
`code`	`string`		Code of the device used for activation inside a branch.
`in_use`	`boolean`		Defines if the device is used (has been activated) or not
`reference*`	`string`		Unique user friendly device reference.
`branch`	`object`	`includable`	The Branch attached to the device.
`type`	`integer`		The Device Type.
`latitude`	`double`	`nullable`	The latitude of the device.
`longitude`	`double`	`nullable`	The longitude of the device.
`group`	`string`	`nullable` `includable`	The menu group attached to the device
`is_blocked`	`boolean`		True if the device is blocked
`local_settings`	`object`		The device local settings
`tags`	`array`	`includable`	The device tags
`model`	`string`	`nullable`	The device Model
`build`	`integer`	`nullable`	The application build.
`app_version`	`string`	`nullable`	The application version.
`system_version`	`string`	`nullable`	The device system version.
`settings`	`object`	`nullable`	The device settings
`is_online_receiver`	`boolean`		True if the device is set to receive online orders
`last_sync_at`	`string`		date and time of the last time the device has been synced
`last_seen_at`	`string`		date and time of the last time the device has been seen online
`last_order_at`	`string`		date and time of the last order received by the device
`created_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was created.
`updated_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was updated.
`deleted_at`	`string`	`nullable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was deleted.

# Device Types

Type	Description
`1`	Cashier.
`2`	KDS.
`4`	Notifier.
`5`	Display.
`6`	Sub Cashier.
`7`	Ristecho One Cashier.

# List Devices

GET /devices

# Scope

general.read

# Filters

name
code
type
model
group_id
tags_id
is_online_receiver
in_use
is_online
branch_id
reference
updated_after
is_deleted
created_on
updated_on
deleted_on

# Response

{
  "data": [
    {
      "tags": [
        {
          "id": "965608a2-eeff-4952-b4b0-7a1bb5e47bcf",
          "type": 8,
          "name": "Cashier_device",
          "name_localized": null,
          "created_at": "2022-05-19 12:16:02",
          "updated_at": "2022-05-19 12:16:02",
          "deleted_at": null,
          "pivot": {
            "device_id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
            "tag_id": "965608a2-eeff-4952-b4b0-7a1bb5e47bcf"
          }
        }
      ],
      "branch": {
        "id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
        "name": "Branch 1",
        "name_localized": "branch1",
        "reference": "B01",
        "type": 1,
        "latitude": "30.033333",
        "longitude": "31.233334",
        "phone": null,
        "opening_from": "01:00",
        "opening_to": "22:00",
        "inventory_end_of_day_time": "06:00",
        "receipt_header": "Welcome",
        "receipt_footer": "Thank you",
        "settings": {
          "branch_tax_number": "12345",
          "branch_tax_registration_name": "tax-reg-name"
        },
        "created_at": "2022-02-14 09:29:27",
        "updated_at": "2022-05-18 22:00:11",
        "deleted_at": null,
        "receives_online_orders": true,
        "accepts_reservations": true,
        "reservation_duration": 30,
        "reservation_times": null,
        "address": null
      },
      "group": null,
      "in_use": true,
      "code": "*****",
      "id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
      "name": "Cashier 1",
      "reference": "C01",
      "type": 1,
      "latitude": null,
      "longitude": null,
      "model": "iPad12,1",
      "build": "240",
      "app_version": "5.0.27.sandbox",
      "system_version": "iOS 15.1",
      "settings": {
        "till_report_email": "jack@Ristecho.com",
        "default_order_tags": [],
        "shift_report_email": "jack@Ristecho.com",
        "kitchen_print_language": "3",
        "cashier_assigned_tables": [
          "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
          "95ed1bc6-766d-4d68-b369-2d82faf2ea07"
        ],
        "end_of_day_report_email": "jack@Ristecho.com",
        "cashier_reset_order_number_at": 1000,
        "cashier_start_order_number_at": 100,
        "ahead_order_reminder_in_minutes": 0,
        "print_online_order_when_received": true,
        "auto_accept_and_send_online_orders_to_kitchen": true
      },
      "local_settings": {
        "peripherals": {
          "kdses": [],
          "scales": [],
          "cashiers": [],
          "displays": [],
          "printers": [],
          "notifiers": [],
          "payment_terminals": [],
          "finger_print_scanners": []
        },
        "tables_configs": [
          {
            "table_id": "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
            "x_coordinate": 23,
            "y_coordinate": 2
          },
          {
            "table_id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
            "x_coordinate": 21,
            "y_coordinate": 12
          },
          {
            "table_id": "95ed1bc6-8d62-46eb-98ae-9ce4050ae8d9",
            "x_coordinate": 13,
            "y_coordinate": 2
          },
          {
            "table_id": "95ed1bc6-766d-4d68-b369-2d82faf2ea07",
            "x_coordinate": 24,
            "y_coordinate": 5
          },
          {
            "table_id": "95ed1b7d-6411-4332-b14e-da966f3dc65b",
            "x_coordinate": 0,
            "y_coordinate": 10
          },
          {
            "table_id": "95ed1bc6-815f-4c1d-b123-fe737be77224",
            "x_coordinate": 4,
            "y_coordinate": 2
          },
          {
            "table_id": "95ed1b7d-59f1-4c4b-97d1-b694f1d2a2aa",
            "x_coordinate": 10,
            "y_coordinate": 11
          },
          {
            "table_id": "95ed1b7d-146f-4ef3-a54f-9c4d83510c4e",
            "x_coordinate": 11,
            "y_coordinate": 2
          }
        ]
      },
      "is_online_receiver": true,
      "first_activation_at": null,
      "last_sync_at": "2022-05-17 23:42:18",
      "last_seen_at": "2022-05-18 14:52:47",
      "last_order_at": null,
      "created_at": "2022-02-14 09:29:27",
      "updated_at": "2022-05-19 12:15:16",
      "deleted_at": null,
      "is_blocked": false
    }
  ]
}

# Get Device

GET /devices/{deviceId}

# Scope

general.read

# Response

{
  "data": {
    "tags": [
      {
        "id": "965608a2-eeff-4952-b4b0-7a1bb5e47bcf",
        "type": 8,
        "name": "Cashier_device",
        "name_localized": null,
        "created_at": "2022-05-19 12:16:02",
        "updated_at": "2022-05-19 12:16:02",
        "deleted_at": null,
        "pivot": {
          "device_id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
          "tag_id": "965608a2-eeff-4952-b4b0-7a1bb5e47bcf"
        }
      }
    ],
    "branch": {
      "id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
      "name": "Branch 1",
      "name_localized": "branch1",
      "reference": "B01",
      "type": 1,
      "latitude": "30.033333",
      "longitude": "31.233334",
      "phone": null,
      "opening_from": "01:00",
      "opening_to": "22:00",
      "inventory_end_of_day_time": "06:00",
      "receipt_header": "Welcome",
      "receipt_footer": "Thank you",
      "settings": {
        "branch_tax_number": "12345",
        "branch_tax_registration_name": "tax-reg-name"
      },
      "created_at": "2022-02-14 09:29:27",
      "updated_at": "2022-05-18 22:00:11",
      "deleted_at": null,
      "receives_online_orders": true,
      "accepts_reservations": true,
      "reservation_duration": 30,
      "reservation_times": null,
      "address": null
    },
    "group": null,
    "in_use": true,
    "code": "*****",
    "id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
    "name": "Cashier 1",
    "reference": "C01",
    "type": 1,
    "latitude": null,
    "longitude": null,
    "model": "iPad12,1",
    "build": "240",
    "app_version": "5.0.27.sandbox",
    "system_version": "iOS 15.1",
    "settings": {
      "till_report_email": "jack@Ristecho.com",
      "default_order_tags": [],
      "shift_report_email": "jack@Ristecho.com",
      "kitchen_print_language": "3",
      "cashier_assigned_tables": [
        "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
        "95ed1bc6-766d-4d68-b369-2d82faf2ea07"
      ],
      "end_of_day_report_email": "jack@Ristecho.com",
      "cashier_reset_order_number_at": 1000,
      "cashier_start_order_number_at": 100,
      "ahead_order_reminder_in_minutes": 0,
      "print_online_order_when_received": true,
      "auto_accept_and_send_online_orders_to_kitchen": true
    },
    "local_settings": {
      "peripherals": {
        "kdses": [],
        "scales": [],
        "cashiers": [],
        "displays": [],
        "printers": [],
        "notifiers": [],
        "payment_terminals": [],
        "finger_print_scanners": []
      },
      "tables_configs": [
        {
          "table_id": "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
          "x_coordinate": 23,
          "y_coordinate": 2
        },
        {
          "table_id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
          "x_coordinate": 21,
          "y_coordinate": 12
        }
      ]
    },
    "is_online_receiver": true,
    "first_activation_at": null,
    "last_sync_at": "2022-05-17 23:42:18",
    "last_seen_at": "2022-05-18 14:52:47",
    "last_order_at": null,
    "created_at": "2022-02-14 09:29:27",
    "updated_at": "2022-05-19 12:15:16",
    "deleted_at": null,
    "is_blocked": false
  }
}

# Update Device

PUT /devices/{deviceId}

# Scope

admin.write

# Request

{
    "name": "B01 C01",
    "is_online_receiver": false,
    "reference": "device03",
    "branch_id": "8d82ff0c"
}

# Response

{
  "data": {
    "tags": [
      {
        "id": "965608a2-eeff-4952-b4b0-7a1bb5e47bcf",
        "type": 8,
        "name": "Cashier_device",
        "name_localized": null,
        "created_at": "2022-05-19 12:16:02",
        "updated_at": "2022-05-19 12:16:02",
        "deleted_at": null,
        "pivot": {
          "device_id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
          "tag_id": "965608a2-eeff-4952-b4b0-7a1bb5e47bcf"
        }
      }
    ],
    "branch": {
      "id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
      "name": "Branch 1",
      "name_localized": "branch1",
      "reference": "B01",
      "type": 1,
      "latitude": "30.033333",
      "longitude": "31.233334",
      "phone": null,
      "opening_from": "01:00",
      "opening_to": "22:00",
      "inventory_end_of_day_time": "06:00",
      "receipt_header": "Welcome",
      "receipt_footer": "Thank you",
      "settings": {
        "branch_tax_number": "12345",
        "branch_tax_registration_name": "tax-reg-name"
      },
      "created_at": "2022-02-14 09:29:27",
      "updated_at": "2022-05-18 22:00:11",
      "deleted_at": null,
      "receives_online_orders": true,
      "accepts_reservations": true,
      "reservation_duration": 30,
      "reservation_times": null,
      "address": null
    },
    "group": null,
    "in_use": true,
    "code": "*****",
    "id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
    "name": "Cashier 1",
    "reference": "C01",
    "type": 1,
    "latitude": null,
    "longitude": null,
    "model": "iPad12,1",
    "build": "240",
    "app_version": "5.0.27.sandbox",
    "system_version": "iOS 15.1",
    "settings": {
      "till_report_email": "jack@Ristecho.com",
      "default_order_tags": [],
      "shift_report_email": "jack@Ristecho.com",
      "kitchen_print_language": "3",
      "cashier_assigned_tables": [
        "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
        "95ed1bc6-766d-4d68-b369-2d82faf2ea07"
      ],
      "end_of_day_report_email": "jack@Ristecho.com",
      "cashier_reset_order_number_at": 1000,
      "cashier_start_order_number_at": 100,
      "ahead_order_reminder_in_minutes": 0,
      "print_online_order_when_received": true,
      "auto_accept_and_send_online_orders_to_kitchen": true
    },
    "local_settings": {
      "peripherals": {
        "kdses": [],
        "scales": [],
        "cashiers": [],
        "displays": [],
        "printers": [],
        "notifiers": [],
        "payment_terminals": [],
        "finger_print_scanners": []
      },
      "tables_configs": [
        {
          "table_id": "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
          "x_coordinate": 23,
          "y_coordinate": 2
        },
        {
          "table_id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
          "x_coordinate": 21,
          "y_coordinate": 12
        }
      ]
    },
    "is_online_receiver": true,
    "first_activation_at": null,
    "last_sync_at": "2022-05-17 23:42:18",
    "last_seen_at": "2022-05-18 14:52:47",
    "last_order_at": null,
    "created_at": "2022-02-14 09:29:27",
    "updated_at": "2022-05-19 12:15:16",
    "deleted_at": null,
    "is_blocked": false
  }
}

# Delete Device

DELETE /devices/{deviceId}

# Scope

admin.write

The API will respond with 200 indicating that the device has been deleted.

← Delivery Zones Discounts →