RXrxfoodapp
shopping

Get shopping item suggestions for a patient

get/patients/{patient_id}/shopping/item_suggestions

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/patients/{patient_id}/shopping/item_suggestions
  • Auth
    HTTP bearer

Path parameters

patient_idinteger required

Query parameters

limitinteger

Number of suggestions to return (default 10, max 50).

force_rebuildboolean

Force regeneration of shopping list suggestions.

kind'standalone' | 'swap'

Filter the type of suggestions to return. Defaults to standalone. Set to swap to fetch replacement suggestions tied to active cart items.

collection_idinteger

Optional collection id to direct suggestions into when accepted.

collection_namestring

Optional collection name to direct suggestions into when accepted.

Response

successful operation

base_item_idinteger nullable
calculated_servingsnumber nullable
category_labelstring nullable
cost_per_unitnumber nullable
created_timestring date-time nullable
custom_itemboolean nullable
food_namestring required
food_name_aliasstring nullable
food_name_alias_translationsobject nullable
food_name_translationsobject nullable
food_photo_urlstring nullable
idinteger required
kind'standalone' | 'swap' required
net_serving_size_gnumber nullable
notestring nullable
origin_idstring nullable
origin_type'food' | 'meal_item' | 'meal_item_custom_addon' | 'recipe_ingredient' | 'llm_generated'
patient_idinteger nullable required
preparation_method'' | 'homemade' | 'restaurant' | 'cpg' | 'store_bought' | 'other'
reason_codestring nullable
reason_textstring nullable
serving_unit_amountnumber nullable
serving_unit_labelstring nullable
serving_unit_label_translationsobject nullable
servingsnumber nullable
status'suggested' | 'accepted' | 'dismissed' | 'expired'
tagsstring[] nullable
target_collection_idinteger nullable
target_collection_kind'cart' | 'saved'
updated_timestring date-time nullable

Changes

No recorded changes to this operation across all 19 revisions of this API.