Transaction Report
POST https://recognition.services.tiliter.com/v1/15/recognition/{recognition_id}/transaction_events
Overview
The Create Transaction Event function allows your Device to report what the user purchased to the Tiliter Recognition API. This closes the loop on the transaction and records when the Device was actually used to complete a purchase.
Why Report Transactions?
Reporting transactions is essential because it:
- Closes the recognition loop — Links the initial product recognition to the actual purchase
- Eliminates irrelevant data — Removes incomplete transactions from your reports, giving you accurate insights
- Tracks all outcomes — Records successful purchases, cancellations, losses, and other transaction states
Important: Every recognition requires a transaction report. Even if no purchase occurs, you should report that outcome.
How to Use
When a customer interacts with your Device, send a transaction event to report the final outcome. This tells us whether the recognition led to a completed purchase, was cancelled, or resulted in a loss.
Request Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
recognition_id | uuid | Yes | The ID of the recognition event |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Yes | The transaction outcome (see allowed values below) |
time | date-time | Yes | When the transaction event occurred |
detail | string | No | Additional details about the transaction |
meta_data | object | No | Custom metadata object |
Transaction Type Values
Report one of these states to indicate what happened:
transaction_incomplete— The transaction started but wasn't finishedlabel_printed— A label was printed but purchase not yet completedloss_actioned— Loss or theft was detected and action was takenloss_acknowledged— Loss or theft was noted but no action takenpurchased— The product was successfully purchasedtransaction_cancelled— The transaction was cancelled by the user
Updated 20 days ago