Menu

API reference

Munim Cares (business)

A business's own surplus listings, simulated recipients, hand-overs and shared surplus offers. Offer money is recorded, never processed.

get

/v1/cares/profile

The business's Munim Cares setup: availability, operator enablement, profile and outlet cities

operationId getCaresProfile

Auth

Member token+Tenant header

Response 200

V1CaresProfilecontract v1.cares.profile
  • availablebooleanrequired
  • enabledbooleanrequired
  • profileobject | nullrequired
    • statusenum (2)required
      activepaused
    • public_namestringrequired
      min length 1max length 200
    • b2b_enabledbooleanrequired
  • outletsarray of objectrequired
    • outlet_idUuid7required
    • city_codestringrequired
      max length 40pattern ^[a-z][a-z0-9_]*$
    • lat_e6integerrequired
      ≥ -90000000≤ 90000000
    • lng_e6integerrequired
      ≥ -180000000≤ 180000000
    • pickup_fromstringrequired
      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    • pickup_tostringrequired
      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    • activebooleanrequired
  • labelsobjectrequired
    • dataconst "Measured on synthetic data"required
    • recipientsconst "to simulated recipients"required
  • note_keyconst "cares.note.check_local_rules"required

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/profile

cares.profile.set.v1 — opt in or pause, name the business, set each outlet's city, location and pickup hours

operationId setCaresProfile

Auth

Member token+Tenant header

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.profile.set.v1"required
  • payloadCaresProfileSetV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/v1/cares/recipients

Simulated recipients in the outlet's city

operationId listCaresRecipients

Auth

Member token+Tenant header

Parameters

  • outletin querystringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response 200

V1CaresRecipientscontract v1.cares.recipients
  • itemsarray of objectrequired
    • recipient_idUuid7required
    • city_codestringrequired
      max length 40pattern ^[a-z][a-z0-9_]*$
    • namestringrequired
      min length 1max length 200
    • kindenum (2)required
      ngofood_bank
    • simulatedconst truerequired
    • accepts_cookedbooleanrequired
    • accepts_rawbooleanrequired
    • accepts_packagedbooleanrequired
    • capacity_kg_per_dayintegerrequired
      ≥ 0≤ 9007199254740991
    • capacity_portions_per_dayintegerrequired
      ≥ 0≤ 9007199254740991
    • receiving_fromstringrequired
      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    • receiving_tostringrequired
      pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    • lat_e6integerrequired
      ≥ -90000000≤ 90000000
    • lng_e6integerrequired
      ≥ -180000000≤ 180000000
  • labelsobjectrequired
    • dataconst "Measured on synthetic data"required
    • recipientsconst "to simulated recipients"required
  • note_keyconst "cares.note.check_local_rules"required

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/v1/cares/listings

Surplus listings and their hand-overs, newest first

operationId listCaresListings

Auth

Member token+Tenant header

Parameters

  • outletin querystringoptional
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
  • kindin queryenum (2)optional
    donationoffer
  • statusin queryenum (4)optional
    publishedallocatedclosedwithdrawn
  • cursorin querystringoptional
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
  • limitin queryintegeroptional

Response 200

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

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/listings

cares.listing.publish.v1 — publish a donation or an offer (owner or judge; intel may draft it, cooked lines only by the owner's own command)

operationId publishCaresListing

Auth

Member token+Tenant header

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.listing.publish.v1"required
  • payloadCaresListingPublishV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/v1/cares/listings/{id}

One listing with its lines and hand-overs

operationId getCaresListing

Auth

Member token+Tenant header

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response 200

V1CaresListingcontract v1.cares.listing
  • 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
      • listing_line_idUuid7required
      • qty_milliintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
  • labelsobjectrequired
    • dataconst "Measured on synthetic data"required
    • recipientsconst "to simulated recipients"required
  • note_keyconst "cares.note.check_local_rules"required

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/listings/{id}:withdraw

cares.listing.withdraw.v1 — withdraw a published listing (not after an offer is allocated)

operationId withdrawCaresListing

Auth

Member token+Tenant header

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.listing.withdraw.v1"required
  • payloadCaresListingWithdrawV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/handovers

cares.handover.record.v1 — record what was handed over; core derives the stock movements

operationId recordCaresHandover

Auth

Member token+Tenant header

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.handover.record.v1"required
  • payloadCaresHandoverRecordV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/handovers/{id}:void

cares.handover.void.v1 — void a recorded hand-over with a reason; stock comes back (not after the buyer received)

operationId voidCaresHandover

Auth

Member token+Tenant header

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.handover.void.v1"required
  • payloadCaresHandoverVoidV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/v1/cares/market

Other businesses' shared surplus offers in the caller's cities (needs B2B on)

operationId listCaresMarket

Auth

Member token+Tenant header

Parameters

  • listingin querystringoptional
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response 200

V1CaresMarketcontract v1.cares.market
  • itemsarray of objectrequired
    • offer_tenant_idUuid7required
    • listing_idUuid7required
    • business_namestringrequired
      min length 1max length 200
    • outlet_namestringrequired
      min length 1max length 200
    • city_codestringrequired
      max length 40pattern ^[a-z][a-z0-9_]*$
    • 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])))$
    • linesarray of objectrequired
      • offer_line_idUuid7required
      • food_kindenum (3)required
        cookedrawpackaged
      • labelstringrequired
      • 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_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • currencystringrequired
        pattern ^[A-Z]{3}$
  • labelsobjectrequired
    • dataconst "Measured on synthetic data"required
    • recipientsconst "to simulated recipients"required
  • note_keyconst "cares.note.check_local_rules"required
  • money_labelconst "Recorded, never processed"required

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/v1/cares/claims

The buyer's own claims with their outcome

operationId listCaresClaims

Auth

Member token+Tenant header

Parameters

  • outletin querystringoptional
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response 200

V1CaresClaimscontract v1.cares.claims
  • itemsarray of objectrequired
    • claim_idUuid7required
    • outlet_idUuid7required
    • offer_tenant_idUuid7required
    • offer_listing_idUuid7required
    • allocation_idUuid7 | nullrequired
    • statusenum (4)required
      requestedcancelledclosedreceived
    • total_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • currencystringrequired
      pattern ^[A-Z]{3}$
    • created_byUuid7required
    • created_atIsoDatetimerequired
    • linesarray of objectrequired
      • offer_line_idUuid7required
      • ingredient_idUuid7required
      • qty_milliintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • unitstringrequired
        pattern ^[a-z][a-z_]{0,15}$
      • unit_price_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • 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])))$
      • received_qty_milliinteger | nullrequired
        ≥ -9007199254740991≤ 9007199254740991
    • outcomeobjectrequired
      • verdictenum (3)required
        accepteddeclinednone
      • allocation_idUuid7 | nullrequired
      • decided_atIsoDatetime | nullrequired
      • linesarray of objectrequired
        Show fields of lines
        • offer_line_idUuid7required
        • handed_qty_milliintegerrequired
          ≥ -9007199254740991≤ 9007199254740991
  • labelsobjectrequired
    • dataconst "Measured on synthetic data"required
    • recipientsconst "to simulated recipients"required
  • note_keyconst "cares.note.check_local_rules"required
  • money_labelconst "Recorded, never processed"required

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/claims

cares.claim.create.v1 — claim every line of an offer at the offered quantity (all-or-nothing); the price is recorded, never processed

operationId createCaresClaim

Auth

Member token+Tenant header

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.claim.create.v1"required
  • payloadCaresClaimCreateV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/claims/{id}:cancel

cares.claim.cancel.v1 — cancel a claim before any verdict

operationId cancelCaresClaim

Auth

Member token+Tenant header

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.claim.cancel.v1"required
  • payloadCaresClaimCancelV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/claims/{id}:close

cares.claim.close.v1 — close a claim whose outcome is declined

operationId closeCaresClaim

Auth

Member token+Tenant header

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.claim.close.v1"required
  • payloadCaresClaimCloseV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/claims/{id}:receive

cares.claim.receive.v1 — receive an accepted, handed-over claim into stock

operationId receiveCaresClaim

Auth

Member token+Tenant header

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.claim.receive.v1"required
  • payloadCaresClaimReceiveV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/v1/cares/listings/{id}/claims

Claims on the caller's own offer

operationId listCaresInboundClaims

Auth

Member token+Tenant header

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response 200

V1CaresInboundClaimscontract v1.cares.inbound-claims
  • itemsarray of objectrequired
    • claim_tenant_idUuid7required
    • claim_idUuid7required
    • buyer_public_namestringrequired
      min length 1max length 200
    • statusenum (4)required
      requestedcancelledclosedreceived
    • created_atIsoDatetimerequired
    • linesarray of objectrequired
      • offer_line_idUuid7required
      • qty_milliintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • unit_price_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
  • labelsobjectrequired
    • dataconst "Measured on synthetic data"required
    • recipientsconst "to simulated recipients"required
  • note_keyconst "cares.note.check_local_rules"required
  • money_labelconst "Recorded, never processed"required

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/cares/listings/{id}:decide

cares.claim.decide.v1 — accept or decline one claim on the caller's offer (one accepted claim per offer)

operationId decideCaresClaim

Auth

Member token+Tenant header

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "cares.claim.decide.v1"required
  • payloadCaresClaimDecideV1required

Response 200

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.