Data Feed
Use the Data Feed editor to enable the POS to send real-time data to third-party applications that are operating on a site's local network.
Examples of third-party applications include: order confirmation boards, beverage dispensers, production management, and video surveillance applications.
For each data feed, define the connection details, the triggering events, the order data filters, and the fields to include/exclude.
Create Data Feed
→ →
To create a data feed:
From the Data Feed homepage, select Create Data Feed.
From the left pane, select a page and define the respective settings.
The following introduces the pages of the Data Feed editor:
Section
Description
Define general settings about the data feed, including IP address and port number.
Specify the availability of the data feed at company sites.
Identify events that trigger data feed output (for example, order_paid and order_save).
Define filters to specify the order objects, and their attributes, to include/exclude from data feeds.
General
→ →
From the General page of the Data Feed editor, define the following:
Setting | Description |
|---|---|
Name | Data feed name. |
Description | Data feed description. |
Connection Type | This field is read-only. TCP Socket is the only supported connection type. |
IP Address | IP address for data feed. |
Port Number | Port number for data feed |
Integrator | Select the integrator for data feed. |
Log Every Request |
|
Availability
→ →
From the Availability page of the Data Feed editor, toggle Active to Yes if the data feed is currently active and available.
Orders
→ →
The Orders page of the Data Feed editor includes the following sections:
Order Triggers
Order Filters
Response
From the Order Triggers section, identify the events that trigger the data feed output:
From the upper-right of the Order Triggers section, select Add Trigger.
From the Add Trigger window, select the events that trigger the data feed output.
From the Order Filters section, define the filters that specify the order objects, and their respective attributes, to include in the data feed:
From the Order Filters section, select Create Filter.
From the Create Filter window, configure conditions for the selected filter type.
From the Response section, configure the following data feed response settings:
Setting | Description |
|---|---|
Include Everything |
|
Custom Filter | From the Include field, define the order objects, and their respective attributes, to include in the data feed. From the Exclude field, define the order objects, and their respective attributes, to exclude from the data feed. |