Terminals
Register the registers, tablets and kiosks that connect to a POS.
A terminal belongs to a business unit (buId) and a store (storeId). Every POS connection and QR redemption session is tied to one terminal.
Create a terminal
curl -X POST "$MNS_API/terminal/create" \
-H "Content-Type: application/json" \
-d '{
"name": "Front counter 1",
"buId": 1,
"storeId": 12,
"os": "iPadOS",
"billingSoftwareName": "Square",
"channel": "in-store",
"terminalActiveStatus": "Y",
"activeStatus": "Y"
}'name is required. Store the returned data.id: it is the terminal_id used everywhere else.
{ "success": true, "data": { "id": 31, "name": "Front counter 1", "buId": 1, "storeId": 12 } }Fields
| Field | Type | Notes |
|---|---|---|
name | string | Required, up to 45 characters. |
buId | integer | Business unit that owns the terminal. |
storeId | integer | Store where the terminal is installed. |
os | string | Operating system of the device. |
billingSoftwareName | string | POS or billing software in use. |
printerMake | string | Receipt printer manufacturer. |
printerName | string | Receipt printer model. |
channel | string | Sales channel label. |
terminalActiveStatus | string | Y or N. |
activeStatus | string | Y or N. |
licId | integer | Licence record, if any. |
List, read, update and delete
| Action | Request |
|---|---|
Active terminals of a business, newest first, with store_name | GET /terminal/list/all/{buId} |
| One terminal | GET /terminal/{terminalId} |
| Update (partial body) | PUT /terminal/{terminalId} |
| Delete | DELETE /terminal/{terminalId} |
Deleting a terminal does not disconnect its POS. Disconnect Square or Lightspeed first.