API reference · Schema

CatalogueItemUpsertV1

CatalogueItemUpsertV1contract catalogue.item.upsert.v1

Variant 1

  • item_idUuid7required
  • name_keystringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  • categorystringrequired
    min length 1max length 100
  • brand_idUuid7 | nullrequired
  • barcodestring | nullrequired
    pattern ^[0-9A-Za-z-]{4,32}$
  • mrp_minorinteger | nullrequired
    > 0≤ 9007199254740991
  • currencystring | nullrequired
    pattern ^[A-Z]{3}$
  • activebooleanrequired
  • variantsarray of objectrequired
    max items 50
    • variant_idUuid7required
    • name_keystringrequired
      pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
    • barcodestring | nullrequired
      pattern ^[0-9A-Za-z-]{4,32}$
    • activebooleanrequired
    • display_namestring | nulloptional
      min length 1max length 120
    • descriptionstring | nulloptional
      min length 1max length 500
  • option_groupsarray of objectrequired
    max items 20
    • option_group_idUuid7required
    • name_keystringrequired
      pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
    • min_selectintegerrequired
      ≥ 0≤ 9007199254740991
    • max_selectintegerrequired
      ≥ 1≤ 9007199254740991
    • requiredbooleanrequired
    • optionsarray of objectrequired
      min items 1max items 50
      Show fields of options
      • option_idUuid7required
      • name_keystringrequired
        pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
      • price_delta_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • currencystringrequired
        pattern ^[A-Z]{3}$
      • activebooleanrequired
      • ingredient_deltasarray of objectrequired
        max items 50
        Show fields of ingredient_deltas
        • delta_idUuid7required
        • ingredient_idUuid7required
        • qty_milliintegerrequired
          ≥ -9007199254740991≤ 9007199254740991
        • unitstringrequired
          pattern ^[a-z][a-z_]{0,15}$
        • waste_pct_bpintegerrequired
          ≥ 0≤ 10000
      • display_namestring | nulloptional
        min length 1max length 120
      • descriptionstring | nulloptional
        min length 1max length 500
    • display_namestring | nulloptional
      min length 1max length 120
    • descriptionstring | nulloptional
      min length 1max length 500
  • display_namestring | nulloptional
    min length 1max length 120
  • descriptionstring | nulloptional
    min length 1max length 500
  • dietenum (4) | nulloptional
    vegnon_vegeggvegan
  • kindenum (2)required
    dishcombo
  • stock_ingredient_idUuid7 | nullrequired

kind = "sku"

  • item_idUuid7required
  • name_keystringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  • categorystringrequired
    min length 1max length 100
  • brand_idUuid7 | nullrequired
  • barcodestring | nullrequired
    pattern ^[0-9A-Za-z-]{4,32}$
  • mrp_minorinteger | nullrequired
    > 0≤ 9007199254740991
  • currencystring | nullrequired
    pattern ^[A-Z]{3}$
  • activebooleanrequired
  • variantsarray of objectrequired
    max items 50
    • variant_idUuid7required
    • name_keystringrequired
      pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
    • barcodestring | nullrequired
      pattern ^[0-9A-Za-z-]{4,32}$
    • activebooleanrequired
    • display_namestring | nulloptional
      min length 1max length 120
    • descriptionstring | nulloptional
      min length 1max length 500
  • option_groupsarray of objectrequired
    max items 20
    • option_group_idUuid7required
    • name_keystringrequired
      pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
    • min_selectintegerrequired
      ≥ 0≤ 9007199254740991
    • max_selectintegerrequired
      ≥ 1≤ 9007199254740991
    • requiredbooleanrequired
    • optionsarray of objectrequired
      min items 1max items 50
      Show fields of options
      • option_idUuid7required
      • name_keystringrequired
        pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
      • price_delta_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • currencystringrequired
        pattern ^[A-Z]{3}$
      • activebooleanrequired
      • ingredient_deltasarray of objectrequired
        max items 50
        Show fields of ingredient_deltas
        • delta_idUuid7required
        • ingredient_idUuid7required
        • qty_milliintegerrequired
          ≥ -9007199254740991≤ 9007199254740991
        • unitstringrequired
          pattern ^[a-z][a-z_]{0,15}$
        • waste_pct_bpintegerrequired
          ≥ 0≤ 10000
      • display_namestring | nulloptional
        min length 1max length 120
      • descriptionstring | nulloptional
        min length 1max length 500
    • display_namestring | nulloptional
      min length 1max length 120
    • descriptionstring | nulloptional
      min length 1max length 500
  • display_namestring | nulloptional
    min length 1max length 120
  • descriptionstring | nulloptional
    min length 1max length 500
  • dietenum (4) | nulloptional
    vegnon_vegeggvegan
  • kindconst "sku"required
  • stock_ingredient_idUuid7required