Create Product

post

https://recognition.services.tiliter.com/v1/15/products/{product_id}

The Create Product function is how each product is initially created and registered with the Tiliter Recognition API. Upon creation, it must be issued values of all of the fields that make up a product. The other Product functions will do anything meaningful without first creating a product.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

product_id

string

required

length between 1 and 50

Body Params

recognition_enabled

boolean

Defaults to true

If true(default), this product will be recognised, set to false to have the product ignored

product_id

string

required

length between 1 and 50

A unique identifier for the object

product_name

string

required

length between 1 and 40

The formal name of a Retailer Product. This will be included in the recognition response, and in reporting. It should be a human-friendly name and it is recommended to use the same wording in existing catalogues and marketing material.

product_description

string

length ≤ 500

A description of the product which may be used in the recognition response and/or to assist mapping.

archetype_id

uuid

A unique identifier assigned to each Tiliter Archetype. It serves as a mapping key between Tiliter Archetypes and Products.

lookup_code

string

length ≤ 20

An alternative to the product ID field. Can correspond to a PLU (product lookup code) or UPC (universal product code).

department

string

enum

required

An enumeration.

Allowed:

required_attributes

array of objects

Use this field to specify essential attributes always present on a Retailer Product. For instance, if peanuts must be in a paper bag and cannot be sold loose, set the in_paper_bag attribute as required. The Tiliter Recognition API will only return peanuts if a paper bag is detected.

optional_attributes

array of objects

Use this field to specify optional attributes that may be present on a Retailer Product. For instance, if bananas may be organic or not organic, set the specialty label as an optional attribute. That way, the Tiliter Recognition API will know that bananas can be sold in both ways and provide responses accordingly.

sale_method

Specifies the Retailer Product's selling method, either by weight or by quantity. Examples include selling bananas by weight and passionfruit by quantity.

image_url

uri

length between 1 and 2083

The URL of an image representing the Retailer Product. This optional field specifies a secure HTTPS link to a product image, The image MIME type much be one of the following: image/jpeg, image/png, image/bmp, image/webp, or image/tiff.

Responses

429

Request Throttled - reduce request rate and retry

200Successful Response

400bad_request

409already_exists

422Validation Error