Salesforce Docs Portal

POS Register Feed

Update multiple existing POS registers using a feed file through CMS. The register feed updates existing registers only and does not create new registers.

Format

The feed formats are CSV (comma-separated), TSV (tab-separated), and PSV (pipe separated).

Types

Delta Feed - This is an incremental feed

Set Up

Prerequisites

  • The POS registers you want to update must already exist in the system. The register feed does not create new registers.
  • If you've yet to set up an Adyen and Point of Sale account, please ensure your StoreIDs are the same for both accounts.
  • If your Point of Sale account is already live but have yet to set up Adyen, please ensure your Adyen's StoreID is the same as your Point of Sale StoreID.
  • If your Adyen account is already live but have yet to set up Point of Sale, please ensure your Point of Sale StoreID is the same as Adyen's StoreID.

Steps

The file can be uploaded from the feed section of CMS.

  1. Go to Feeds > Manual Upload > Stores > POS Register.
  2. Upload the file.
Important
Important All feed files should be saved in a UTF-8 (not to be confused with UTF-8 with BOM) format else you receive an error during upload.

Content

Field Name Mandatory Description Max Size Data Type Example Data
DeviceType Yes The device type of the POS register. 128 String iPad, iPhone, iPod, etc.
InstallationID Yes The installation ID of the POS register. 128 String 13080334-a0be-4b24-8198-529f952dfc0a
IPAddress Yes The IP address local to the store network. 128 String 192.168.0.10
IsBlockedRegister Yes A flag to block the POS register. 0/1 Boolean 0 (active), 1 (blocked)
IsSpareRegister Yes A flag to mark the POS register as a spare one. 0/1 Boolean 0 (in use), 1 (spare)
StoreAssociateID Yes The store associate ID. 128 Number 2036, 10001, etc.
StoreID Yes The store ID. 128 String 1001, Store001, etc.
StoreRegisterID Yes A friendly name local to the store. 128 String Register #1, Register #2, 1, 2, 3, etc.
CardReaderConnectionType No The card reader connection to the POS Register. 128 String ANY, NONE, BTLE (for Bluetooth), USB, IP (for IP address)
CardReaderIPAddress No The card reader's IP address; local to the store network. 128 String ANY, NONE, IP (for IP address)
CardReaderModel No The card reader model. 128 String ANY, NONE, Specific Model (e.g., Verifone MX915, Adyen, V400m etc.)
CardReaderSerialNumber No The card reader serial number. 128 String ANY, NONE, Serial Number (e.g., V03JKJ83KR840)
CashDrawerConnectionType No The cash drawer connection medium. 128 String ANY, NONE, USB, URL_VIA_QR_CODE, BTLE (for Bluetooth), EXTERNAL_PERIPHERAL (if linked to external drawer)
CashDrawerModel No The cash drawer model. 128 String ANY, NONE, Specific Model (e.g., Star mC Print3), EXTERNAL_PERIPHERAL (if linked to external drawer)
CashDrawerSerialNumber No The associated cash drawer's serial number. 128 String ANY, NONE, Serial Number (e.g., 4JHKJKJLK435453), EXTERNAL_PERIPHERAL (if linked to external drawer)
ReceiptPrinterConnectionType No The receipt printer's connection type. 128 String ANY, NONE, BTLE (for Bluetooth), USB, IP (for IP address)
ReceiptPrinterIPAddress No The receipt printer's IP address. 128 String ANY, NONE, IP (for IP address)
ReceiptPrinterModel No The receipt printer model. 128 String ANY, NONE, AirPrint, Star mPOP (BT: mpop), Start MC Print3 (USB:mC-Print3), Star TSP650II, Epson (TM-m30, TM-m30II, TM-m30II-H, TM-P80, TM-T88IV, TM-T88V, TM-T88VI),
ReceiptPrinterSerialNumber No The receipt print's serial number. 128 String ANY, NONE, Serial Number (e.g., V03JKJ83KR840)
ScannerConnectionType No The scanner connection medium to the POS Register. 128 String ANY, NONE, BTLE (for Bluetooth), USB
ScannerModel No The scanner model. 128 String ANY, NONE, Specific Model (e.g., S740, Zebra DS9208)
ScannerSerialNumber No The associated scanner's serial number. 128 String ANY, NONE, Serial Number (e.g., Z5932HDLSE)
TillManagement No The till management status. 128 Enum MANUAL, AUTO, NONE (e.g., AUTO)
CashDrawerMode No The cash drawer mode. 128 Enum EXTERNAL_CASH_DRAWER, CONNECTED_CASH_DRAWER, URL_VIA_QR_CODE (e.g., EXTERNAL_CASH_DRAWER)
Note
Note
  • Any: If a field has "ANY" then that means the POS register can be associated with any value. For example, "ANY" for CashDrawerModel indicates the POS register can have any cash drawer.
  • None: The field is not applicable.
  • In the initial file upload, the required Target Fields (denoted by an asterisk) must be mapped so they can be available as columns. However, they don’t need to have values and just need to line up with the schema.
Example
Example

Example feeds: PosRegisterFeed.tsv