API reference · Schema

CatalogueDealUpsertV1

CatalogueDealUpsertV1contract catalogue.deal.upsert.v1
  • deal_idUuid7required
  • name_keystringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  • ruleone of 3required

    kind = "percent_off"

    • kindconst "percent_off"required
    • bpintegerrequired
      ≥ 1≤ 10000
    • item_idsarray of Uuid7required
      max items 200

    kind = "amount_off"

    • kindconst "amount_off"required
    • amount_minorintegerrequired
      > 0≤ 9007199254740991
    • item_idsarray of Uuid7required
      max items 200

    kind = "buy_x_get_y"

    • kindconst "buy_x_get_y"required
    • buy_qtyintegerrequired
      ≥ 1≤ 100
    • get_qtyintegerrequired
      ≥ 1≤ 100
    • item_idsarray of Uuid7required
      min items 1max items 200
  • windowsarray of objectrequired
    max items 20
    • daysarray of integerrequired
      min items 1max items 7
    • fromstringrequired
      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    • tostringrequired
      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  • outlet_idsarray of Uuid7required
    max items 100
  • valid_fromstring (date)required
    pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
  • valid_tostring (date) | nullrequired
    pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
  • activebooleanrequired