Skip to main content
GET
/
foods
List foods
curl --request GET \
  --url https://api.salesive.com/api/v1/foods \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "List foods",
  "data": {
    "foods": [
      {
        "_id": "66a2a1c4e1b3a40012cd1001",
        "name": "Margherita Pizza",
        "description": "Tomato, mozzarella, basil",
        "price": 12.5,
        "promoPrice": null,
        "images": [
          "https://cdn.salesive.com/f/margherita.jpg"
        ],
        "video": null,
        "category": {
          "_id": "66a2a0aae1b3a40012cd0001",
          "name": "Pizzas",
          "slug": "pizzas"
        },
        "available": true,
        "listed": true,
        "addons": [
          {
            "name": "Extra cheese",
            "price": 2,
            "maxQuantity": 3,
            "available": true
          }
        ],
        "shop": "66a1eee0e1b3a40012ab0001",
        "createdAt": "2026-06-10T12:00:00.000Z",
        "updatedAt": "2026-06-21T09:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 34,
      "page": 1,
      "limit": 20,
      "pages": 2,
      "hasNext": true,
      "hasPrev": false,
      "nextPage": 2,
      "prevPage": null
    }
  }
}
Returns a paginated list of the store’s foods (the restaurant menu — the catalog equivalent for restaurant stores), newest first, with category populated. Supports filtering by category, availability and listed status. Requires the READ_INVENTORY scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

page
integer
default:1

Page number (1-based).

limit
integer
default:20

Items per page.

category
string

Filter by category ObjectId.

available
boolean

Filter by availability. Pass true or false.

listed
boolean

Filter by listed status. Pass true or false.

Response

List foods — success.

status
integer
required
Example:

200

success
boolean
required
Example:

true

message
string
required
Example:

"List foods"

data
object
required
Example:
{
"foods": [
{
"_id": "66a2a1c4e1b3a40012cd1001",
"name": "Margherita Pizza",
"description": "Tomato, mozzarella, basil",
"price": 12.5,
"promoPrice": null,
"images": ["https://cdn.salesive.com/f/margherita.jpg"],
"video": null,
"category": {
"_id": "66a2a0aae1b3a40012cd0001",
"name": "Pizzas",
"slug": "pizzas"
},
"available": true,
"listed": true,
"addons": [
{
"name": "Extra cheese",
"price": 2,
"maxQuantity": 3,
"available": true
}
],
"shop": "66a1eee0e1b3a40012ab0001",
"createdAt": "2026-06-10T12:00:00.000Z",
"updatedAt": "2026-06-21T09:00:00.000Z"
}
],
"pagination": {
"total": 34,
"page": 1,
"limit": 20,
"pages": 2,
"hasNext": true,
"hasPrev": false,
"nextPage": 2,
"prevPage": null
}
}