Upsert category by generic key

put

https://api.tilby.com/v2/categories/{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.

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

code

string

length between 0 and 255

Category code must be unique

color

string

department10_id

integer

department2_id

integer

department3_id

integer

department4_id

integer

department5_id

integer

department6_id

integer

department7_id

integer

department8_id

integer

department9_id

integer

department_id

integer

display

boolean

Set to true if you want to show it in orders or in cash register

display_kiosk

boolean

Set to true if you want to show the category in the kiosk

display_slave_device

boolean

Defaults to true

Set to true if you want to show the category in the slave devices

display_website

boolean

Set to true if you want to show the category in the website

favorite

boolean

image_url

string

index

integer

Sorting index in visualization

long_description

string

long description

name

string

required

length between 0 and 255

Category name

printer_id

integer

short_description

string

length ≤ 255

short description

terminal_id

string

thumbnail

string

length between 0 and 255

need an url

uuid

variations

array of objects

variations

Responses

404

Category not found

Language

Credentials

Bearer

JWT

Response

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

application/json

200Returns the object data updated