GET Customer Favorite Items

​

Returns the customer's saved favorite items — fully configured products, including their chosen modifier groups — ready to be added straight back into a cart.

Pass venue_id to have each item priced and stock-checked for one store. Without it, availability flags come back as false and prices as zero, so always send it when showing favorites for a specific store.

Items the customer is no longer eligible to see, for example behind a secret menu, are silently dropped rather than erroring.

Query Parameters

  • Venue to price and stock-check the favorites against. Strongly recommended.

Headers

  • Type of content accepted by the API (application/json in most cases)

  • Application key for specific client app

  • Version of the API to be used

  • Authorization header

  • Unique request identifier

Responses

  • application/json
  • Missing or invalid customer token.

Request Example for get/customer-accounts/favorite-items
curl 'https://api-public-demo.menu.app/api/customer-accounts/favorite-items?venue_id=3540' \
  --header 'Accept: application/json' \
  --header 'Application: application-key' \
  --header 'API-VERSION: ' \
  --header 'X-Request-ID: c10b4a70-6274-490d-80a0-03e7bb826937'
{
  "status": "OK",
  "code": 200,
  "data": {
    "customer_account_favorite_items": [
      {
        "id": "289013d8-ce7b-424e-8f5f-2be2ece9c7a4",
        "name": "Cheeseburger",
        "favorite_item_id": 55,
        "quantity": 1,
        "in_stock": true,
        "show_in_menu": true,
        "out_of_stock_until": null,
        "price": 950,
        "menu_id": "9b1f2c3d-4e5a-6b7c-8d9e-0f1a2b3c4d5e",
        "category_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "modifier_code": null,
        "swapped_product": null,
        "product_groups": []
      }
    ]
  }
}