API Reference

Create Selection Report

post
https://recognition.services.tiliter.com/v1/15/recognition//selection_report

The Create Selection Report function sends the user's selected product to the Tiliter Recognition API. This information helps determine if a product was potentially chosen incorrectly (such as a potato instead of an avocado), which is returned as an indicator in the response to a Selection Report. Reports are necessary for each recognition, including cases where no selection was made.

Path Params
uuid
required
Body Params
string
enum
required

The method by which the product was selected. Automatic refers to the item being added to the cart automatically by the software. Manual refers to where the shopper selects it on screen. Recognition unused covers cases where the cart is abandoned or nothing is selected.

Allowed:
string
required

The unique identifier assigned to the product that was selected by the user. It corresponds to the product ID associated with the selected item, which may either align with the products in the recognition, or differ from them. Used to identify fraud.

sale_info

Describes how the selected product is sold - by weight or quantity.

string
length between 1 and 50

Used to report the retailer's internal ID of the transaction to the Tiliter Recognition API. This can be used to enhance the flexibility of reporting by allowing the joining of Tiliter reporting with retailer reporting.

string
length between 1 and 50

Identifier for the line item in the transaction if available

date-time
required

The data and time at which the product was selected by the user.

Responses

429

Request Throttled - reduce request rate and retry

Updated 5 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago