Library Developer Home FD1 Client Protocol Home Conceptual Overview Using GET/POST Protocol Definition Authentication Authorisation Firehoses Examples General curl websocat Major APIs / Endpoints Endpoint Overview Accounts Customers Fetch Data Departments Devices Locations Products Sales Session Less Common Endpoints User Interface Worked Examples Temperature Monitor Custom Report Instore Customer Display External Customer Display Cross Domain Reporting Advanced Integration FieldpineDevices External Website Schema Definitions custdisp.sale.* device.bluetooth.announcement device.scale.reading firehose.status sale.create sale.read Diagnostic Schema tufe.error tusp.entry

custdisp.sale.* Schema

These messages are sent from a live checkout to a customer display which has opened a firehose to receive Customer Display messages.

The "sc" field contains a range of possible values, and shows what changed and why you received this packet. Regardless of the reason in "sc", the contents are all the same

cust.sale.lines. [ add | edit | delete | status ] A saleline has been added, edited, deleted. Or this is a periodic status message
cust.sale.payments. [ add | edit | delete | status ] A payment has been added, edited, deleted. Or this is a periodic status message
cust.sale. [ add | edit | delete | status ] Something about the sale generally has been added, edited, deleted. Or this is a periodic status message
cust.sale.NNN. [ add | edit | delete | status ] A unique field has has been added, edited, deleted, status. But the name is unavailable. You should not see these messages.

Field	Description
salephyskey	Unique key identifying this sale. This key is like a UUID and is not really intended for customers to see. It does uniquely identify this exact sale over all checkouts.
source{}	A subobject identifying where this message originated. These are mostly technical identifiers.
datetimelocal	Time on the local PC. This value "stops" when the sale is completed and becomes the sale completion time.
saletotal	Current total of the sale.
lines[]	Array of items being purchased
payments[]	Array of payments recorded against this sale.

The lines array contains objects with this structure

Field	Description
seqnce	Integer giving the line position. This value is allocated when the item is first added, and remains constant even if previous items are removed from the sale
pid
qty
totalprice
product{}
product.description
product.sku

Example

{
    "sc": "custdisp.sale.lines.add",
    "v": {
        "salephyskey": "KAKSKSKSKSKSKSKSKSKSKSBDE",
        "source": {
            "faid": 3283,
            "plevel": 2502,
            ...
        },
        "datetimelocal": "2025-01-03 14:23:30",
        "saletotal": 97.5,
        "lines": [
            {
                "seqnce": 1,
                "pid": 82931,
                "qty": 1,
                "totalprice": 95.5,
                "product": {
                    "description": "Gold leaf locket",
                    "sku": "AAAGL23"
                }
            }
        ]
    }
}