Upsert item by generic key

put

https://api.tilby.com/v2/items/{key_identifier}/{key_value}

This Api works as un upsert. If the key_identifier's value used to search is not present, a creation will be made. Otherwise an update will be performed with the key requested. Please consider that the key already present in database can not be updated with this Api.
Attention: the uuid in this case will be autogenerated by BE.
Attention: If you use the sku as a key, uuid in the body will be ignored and will be preserved the uuid in the database.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key_identifier

string

enum

required

key that you want to use to update. This key must be the same in the payload request.

Allowed:

key_value

string

required

value of key that you want to use to update. This key must be the same in the payload request.

Body Params

Object data that need to be updated

allergens

array of objects

allergens

alternative_descriptions

array of objects

alternative_descriptions

alternative_names

array of objects

alternative_names

auto_unload

boolean

barcodes

array of objects

barcodes

bom_components

array of objects

bom_components

brand

string

length between 0 and 255

category_code

string

assign to this item the category with this code. If no category is found, a new one will be created. This will override category_id;

category_id

integer

must be a valid category_id. Check /categories to get the right category

channels

array of objects

channels

checkout_mark

boolean

code

string

length between 0 and 255

color

string

combinations

array of objects

combinations

components

array of objects

components

cost

number

≥ 0

created_at

date-time

it set by default from api, but it can be overwrited

default_supplier_id

integer

must be a valid category_id. Check /suppliers to get the right supplier

deleted_at

date-time

if it is not null item is deleted

department10_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department10_id

integer

department_id for corresponded pricelist

department2_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department2_id

integer

department_id for corresponded pricelist

department3_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department3_id

integer

department_id for corresponded pricelist

department4_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department4_id

integer

department_id for corresponded pricelist

department5_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department5_id

integer

department_id for corresponded pricelist

department6_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department6_id

integer

department_id for corresponded pricelist

department7_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department7_id

integer

department_id for corresponded pricelist

department8_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department8_id

integer

department_id for corresponded pricelist

department9_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department9_id

integer

department_id for corresponded pricelist

department_code

string

assign to this item the department with this code. If no department is found, a new one will be created with vat_id of 0 (N4). This will override department_id

department_id

integer

department_id for corresponded pricelist

description

string

length between 0 and 255

favorite

boolean

icon

string

length between 0 and 255

images

array of objects

for each updates, all images items are deleted and recreated. So you do not need set the id

images

index

integer

is_frozen

boolean

Defaults to false

is_group_item

boolean

Set true if the item is used to compose quick menus

keyboard_code

string

length between 0 and 25

manual_production

boolean

name

string

required

length between 0 and 255

The item name

not_discountable

boolean

Set true make the item not discountable in cash register

on_sale

boolean

Set true to show it in orders or cash register

option1_value

string

length between 0 and 255

option2_value

string

length between 0 and 255

option3_value

string

length between 0 and 255

option4_value

string

length between 0 and 255

order_name

string

length between 0 and 20

price1

number

required

≥ 0

price10

number

≥ 0

price2

number

≥ 0

price3

number

≥ 0

price4

number

≥ 0

price5

number

≥ 0

price6

number

≥ 0

price7

number

≥ 0

price8

number

≥ 0

price9

number

≥ 0

printers

array

printers

quantity_alert

number

request_weighing

boolean

Defaults to false

season

string

length between 0 and 255

sku

string | null

if it is set it Must be unique. CASE CHAIN STORE: If it is not null, this field is used as primary key in the chain store and it will be added/modified/deleted automatically in all chain's stores.

split_group_components

boolean

Set true if the item variations with a linked item should be inserted as a stand-alone item

stock_type

string

thumbnail

string

length between 0 and 255

time_required

number

in minutes

unit

string

length between 0 and 10

updated_at

date-time

it set by default from api, but it can be overwrited

uuid

string

must be unique

variations

array of objects

variations

vat_perc

number

0 to 30

weight

number

≥ 0

Responses

404

Item not found

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json