RXrxfoodapp
shopping

Accept the most recent shopping item suggestions into a collection

post/patients/{patient_id}/shopping/item_suggestions/apply

Request

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

Path parameters

patient_idinteger required

Query parameters

limitinteger

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

collection_idinteger

Optional collection id to accept the suggestions into.

collection_namestring

Optional collection name to accept the suggestions into.

force_rebuildboolean

Attempt regeneration if suggestions are insufficient.

Response

successful operation

added_by_user_idinteger nullable
archived_timestring date-time nullable
calculated_servingsnumber nullable
category_labelstring nullable
collection_idinteger required
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
global_orderinteger nullable
idinteger required
net_serving_size_gnumber nullable
notesstring nullable
origin_idstring nullable
origin_type'food' | 'meal_item' | 'meal_item_custom_addon' | 'recipe_ingredient' | 'llm_generated'
package_size_amountnumber nullable
package_size_unit_labelstring nullable
positioninteger nullable
preparation_method'' | 'homemade' | 'restaurant' | 'cpg' | 'store_bought' | 'other'
quantityinteger
serving_unit_amountnumber nullable
serving_unit_labelstring nullable
serving_unit_label_translationsobject nullable
servingsnumber nullable
status'active' | 'purchased' | 'dismissed' | 'expired'
tagsstring[] nullable
updated_timestring date-time nullable

Changes

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