API reference · Schema
CatalogueItemUpsertV1
CatalogueItemUpsertV1contract catalogue.item.upsert.v1
Variant 1
- name_keystringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- categorystringrequiredmin length 1max length 100
- barcodestring | nullrequiredpattern ^[0-9A-Za-z-]{4,32}$
- mrp_minorinteger | nullrequired> 0≤ 9007199254740991
- currencystring | nullrequiredpattern ^[A-Z]{3}$
- activebooleanrequired
- variantsarray of objectrequiredmax items 50
- name_keystringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- barcodestring | nullrequiredpattern ^[0-9A-Za-z-]{4,32}$
- activebooleanrequired
- display_namestring | nulloptionalmin length 1max length 120
- descriptionstring | nulloptionalmin length 1max length 500
- option_groupsarray of objectrequiredmax items 20
- name_keystringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- min_selectintegerrequired≥ 0≤ 9007199254740991
- max_selectintegerrequired≥ 1≤ 9007199254740991
- requiredbooleanrequired
- optionsarray of objectrequiredmin items 1max items 50
Show fields of options
- name_keystringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- price_delta_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- currencystringrequiredpattern ^[A-Z]{3}$
- activebooleanrequired
- ingredient_deltasarray of objectrequiredmax items 50
- display_namestring | nulloptionalmin length 1max length 120
- descriptionstring | nulloptionalmin length 1max length 500
- display_namestring | nulloptionalmin length 1max length 120
- descriptionstring | nulloptionalmin length 1max length 500
- display_namestring | nulloptionalmin length 1max length 120
- descriptionstring | nulloptionalmin length 1max length 500
- dietenum (4) | nulloptional
vegnon_vegeggvegan - kindenum (2)required
dishcombo
kind = "sku"
- name_keystringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- categorystringrequiredmin length 1max length 100
- barcodestring | nullrequiredpattern ^[0-9A-Za-z-]{4,32}$
- mrp_minorinteger | nullrequired> 0≤ 9007199254740991
- currencystring | nullrequiredpattern ^[A-Z]{3}$
- activebooleanrequired
- variantsarray of objectrequiredmax items 50
- name_keystringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- barcodestring | nullrequiredpattern ^[0-9A-Za-z-]{4,32}$
- activebooleanrequired
- display_namestring | nulloptionalmin length 1max length 120
- descriptionstring | nulloptionalmin length 1max length 500
- option_groupsarray of objectrequiredmax items 20
- name_keystringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- min_selectintegerrequired≥ 0≤ 9007199254740991
- max_selectintegerrequired≥ 1≤ 9007199254740991
- requiredbooleanrequired
- optionsarray of objectrequiredmin items 1max items 50
Show fields of options
- name_keystringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- price_delta_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- currencystringrequiredpattern ^[A-Z]{3}$
- activebooleanrequired
- ingredient_deltasarray of objectrequiredmax items 50
- display_namestring | nulloptionalmin length 1max length 120
- descriptionstring | nulloptionalmin length 1max length 500
- display_namestring | nulloptionalmin length 1max length 120
- descriptionstring | nulloptionalmin length 1max length 500
- display_namestring | nulloptionalmin length 1max length 120
- descriptionstring | nulloptionalmin length 1max length 500
- dietenum (4) | nulloptional
vegnon_vegeggvegan - kindconst "sku"required