API reference · Schema

V1CaresListings

V1CaresListingscontract v1.cares.listings
  • itemsarray of objectrequired
    • listing_idUuid7required
    • outlet_idUuid7required
    • kindenum (2)required
      donationoffer
    • statusenum (4)required
      publishedallocatedclosedwithdrawn
    • recipient_idUuid7 | nullrequired
    • pickup_fromIsoDatetimerequired
    • pickup_toIsoDatetimerequired
    • pickup_onstring (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])))$
    • published_byUuid7required
    • published_atIsoDatetimerequired
    • linesarray of objectrequired
      • line_idUuid7required
      • line_nointegerrequired
        ≥ 1≤ 9007199254740991
      • food_kindenum (3)required
        cookedrawpackaged
      • item_idUuid7 | nullrequired
      • ingredient_idUuid7 | nullrequired
      • batch_idUuid7 | nullrequired
      • qty_milliintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • unitstringrequired
        pattern ^[a-z][a-z_]{0,15}$
      • expires_onstring (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])))$
      • unit_price_minorinteger | nullrequired
        ≥ -9007199254740991≤ 9007199254740991
      • currencystring | nullrequired
        pattern ^[A-Z]{3}$
    • handoversarray of objectrequired
      • handover_idUuid7required
      • allocation_idUuid7 | nullrequired
      • statusenum (2)required
        recordedvoided
      • handed_atIsoDatetimerequired
      • recorded_byUuid7required
      • voided_byUuid7 | nullrequired
      • void_reason_codestring | nullrequired
        pattern ^[a-z][a-z0-9_]{0,63}$
      • linesarray of objectrequired
        Show fields of lines
        • listing_line_idUuid7required
        • qty_milliintegerrequired
          ≥ -9007199254740991≤ 9007199254740991
  • next_cursorUuid7 | nullrequired
  • labelsobjectrequired
    • dataconst "Measured on synthetic data"required
    • recipientsconst "to simulated recipients"required
  • note_keyconst "cares.note.check_local_rules"required

Used by