Retail Transaction Schema

Solink tags video to retail transactions based on a unique place and time pairing. Time is absolute and must adhere to the convention defined here.

Required Object Fields

Field	Type	Description
`dataType`	String	Must be set to "retail" to specify which data type the current event is.
`schemaVersion`	String	Must be set to "1" to specify which version of the schema is being used for this event (e.g. "1", "2", etc).
`startTime`	Number \| String	Start time of the transaction in either Unix time format milliseconds or ISO-8601 compliant format.
`endTime`	Number \| String	End time of the transaction in either Unix time format milliseconds or ISO-8601 compliant format.
`locationId`	String	Unique location identifier within the customer's set of locations.
`dataSourceId`	String	A unique identifier representing the source of the transaction data, typically a point-of-sale (POS) register, kiosk, or fuel pump within the retail environment. This ID helps differentiate where each transaction originated within the store.
`transactionId`	String	Unique id which identifies the transaction in the originating POS software.
`status`	String	Describes the type of transaction. For example: "SALE" or "VOID".
`items`	Array	The list of items, actions or events processed in the transaction.

Optional Object Fields

Field	Type	Description
`employeeId`	String	Unique employee id to identify the employee processing the transaction.
`employeeName`	String	The name of the employee processing the transaction.
`customerId`	String	The unique id to identify the customer being served.

Required Item Object Fields

Field	Type	Description
`time`	Number \| String	Start time of the transaction in either Unix time format milliseconds or ISO-8601 compliant format.
`quantity`	Number	Quantity of the item.
`description`	String	Description of the item.
`unitPrice`	Number	Per unit price of the item.
`type`	String	May be one of the following allowed values: "SALE": Item sold at list price. "MODIFIER": Item modified with/without corresponding price modifications. "SALE_OVERRIDE": Item sale price was overridden by the employee. Final override price is recorded in unitPrice "OVERRIDE_MODIFIER": Override item modified with/without corresponding price modifications "DISCOUNT": A discount was applied to the transaction. "DISCOUNT_MODIFIER": The discount was modified with/without corresponding price modifications. "RETURN": Item was returned. "RETURN_MODIFIER": Returned item modified with/without corresponding price modifications. "RETURN_DISCOUNT": Returned item discount. "RETURN_DISCOUNT_MODIFIER": Returned item discount modifier. "PAYMENT": Payment applied to the transaction "REFUND": Refund payment previously applied to the transaction "CHANGE_DUE": Change due to the customer for a cash payment tendered > transaction total "TAX": Tax to be applied to the transaction "REFUND_TAX ": Refund tax previously applied to the transaction "OTHER_CHARGES": Other charges associated with the transaction "REFUND_OTHER_CHARGES": Refund other charges previously applied to the transaction "GRATUITY": Gratuity offered by the customer "VOID": Item entry voided. "VOID_MODIFIER": Item modifier entry voided/cancelled. "VOID_DISCOUNT": Item discount entry voided/cancelled. "VOID_RETURN": Item returned entry voided/cancelled "VOID_PAYMENT": Payment entry voided/cancelled "VOID_CHANGE_DUE": Change due entry voided/cancelled "VOID_REFUND": Refund payment voided/cancelled

Optional Item Object Fields

Field	Type	Description
`cardNumberLast4`	String	For credit/debit/gift card payment/refund/void. Last four digits of the card number.
`sku`	String	SKU or other unique item identifier.

JSON Example

{
  "dataType": "retail",
  "schemaVersion": "1",
  "startTime": 1557943653649,
  "endTime": 1557943678649,
  "locationId": "123",
  "registerId": "1",
  "transactionId": "93688",
  "employeeId": "27",
  "employeeName": "MICHELLE",
  "status": "SALE",
  "customerId": "",

  "items": [
    {
      "type": "sale",
      "quantity": 1.0,
      "description": "767062 - 1L COLA",
      "unitPrice": 2.29,
      "time": 1555898203000
    },
    {
      "type": "tax",
      "description": "PST",
      "unitPrice": 0.32,
      "time": 1557943678649
    },
    {
      "type": "payment",
      "description": "Credit",
      "unitPrice": 2.61,
      "cardNumberLast4": "1234"
    },
    {
      "type": "change due",
      "description": "Change",
      "unitPrice": 0.0,
      "time": 1557943678649
    }
  ]
}