Skip to main content

scanned_product

A product was consumed at a scan: a drink voucher, a parking entry.

One per product on the scan, on the ticket's barcode.

Sent withplatform keys (see write keys)
Modestrict: exactly the declared fields; an undeclared key, a wrong type or a missing required key quarantines the event
Version1 (_schema_version on the stored row)
Stateactive
Required fieldsproduct_id, event_id
Revenuenone: the revenue block is refused. Money-like names allowed in features: scan_amount
Identity evidencenone
Before consentno

Fields​

The activity's own fields, sent as features. Identifier and attribute fields are moved out of features by the processor; see identifiers and attributes.

FieldTypeRequiredWhat happens to itMeaning
event_idstringyesstays in featuresThe Eventix event the activity is about. Copied to the stream's _event_id column, so filters on an event are fast; it must be a plain string.
gatestringno, may be nullstays in featuresWhere the scan happened: the scanner or gate id.
order_ticket_idstringno, may be nullstays in featuresThe ticket within the order: the id of the ticket line, not the barcode.
origin_typestringno, may be nullstays in featuresWhat the product scan was made on: the ticket, or a product bought separately.
product_idstringyesstays in featuresThe product (merchandise, a drink, a parking place) as the ticketing system knows it.
scan_amountintegernostays in featuresHow many units the scan consumed (a multi-entry ticket, a product with a quantity).
scan_numberintegernostays in featuresThe sequence number of this scan on the ticket.

Example​

One activity in a batch to POST /v1/activities, with debug so the answer says what the processor made of it. The envelope page explains every top-level field.

{
"batch": [
{
"activity_id": "0192f1a4-2467-779a-8000-246779a00000",
"activity": "scanned_product",
"ts": "2026-10-17T20:00:00+02:00",
"owner_ref": "own:own_01M4XX0033FV7QXDRB5BQBRPGR",
"identifiers": [
{
"type": "barcode",
"value": "TK-4471",
"role": "holder",
"namespace": "weeztix"
}
],
"features": {
"event_id": "3a114ef5-6105-48fd-aafc-0ae609d0536c",
"gate": "north-1",
"order_ticket_id": "5e6f7a8b-0000-4000-8000-000000000004",
"origin_type": "ticket",
"product_id": "prd_01M4XVBYC3FGXCPFRZEPGV20RZ",
"scan_amount": 1,
"scan_number": 1
}
}
],
"debug": true
}

Try it​

Sends this request from your browser. The key and the endpoint are kept in this browser only.

Versions​

VersionModeKey classesChange
1 (current)strictplatformfirst version

A published version never changes; a change is a new version, and every stored row says which version it was checked against.