iVendNextDevelopers Request a sandbox

POS Terminal

A till device at a store, with its hardware and its cash drawers.

Area: Till sales · Why it is here: contract label_layout · Fields: 11

Read and write it

Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.

Read a list (only name unless you ask for fields):

curl -s "https://⟨site⟩/api/resource/POS%20Terminal?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one:

curl -s "https://⟨site⟩/api/resource/POS%20Terminal/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one (the required fields first), if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/POS%20Terminal" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"company": …, "store": …}'

Change one with PUT /api/resource/POS%20Terminal/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.

Fields

Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.

Field Field name Type Required Read-only Hidden Links to
Company company Link yes Company
Store store Link yes Warehouse
Hardware ID hardware_id Data yes
Customer Display Hardware ID customer_display_hardware_id Data yes
Has multiple cash drawers has_multiple_cash_drawers Check
Has Cash Drawer (added by iVendNext) custom_has_cash_drawer Check
Network Printer (added by iVendNext) custom_network_printer Link Network Printer Settings
Has Customer Display has_customer_display Check
Call Number Prefix (added by iVendNext) custom_mpos_call_prefix Data
Label Printer (added by iVendNext) custom_mpos_label_printer Data
Network Label Printer (added by iVendNext) custom_mpos_network_label_printer Link Network Printer Settings

All record types · What you can use

This record type in the kit