Get a menu tree

GET

https://api.storyous.com/menu/{merchantId}

Endpoint that allows to read all levels of a menu.

The menu provide ETag header in response which can (and should) be used for the following requests in the If-None-Match header. When the menu hasn't been modified, 304 http status with no content is responded.

There will be a rate-limit mechanism penalising requests without If-None-Match header in the future.

Recomendation: Use placeId and integrationId query parameters to get already filtered tree of products and categories relevant for the place and the integration.

passing categoryId, depth, or includeRemoved returns 400 Bad request

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.storyous.com/menu/5837801c78c5400e00e57dc2?placeId=&integrationId=%27customdelivery%27&categoryId=null&depth=-1' \
--header 'If-None-Match;' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "menuId": "507f191e810c19729de860ea",
  "items": [
    {
      "categoryId": "cat:starters",
      "name": "Coffee",
      "posName": "Coffee",
      "color": "#34495E",
      "icon": "25",
      "items": [
        {
          "productId": "p:3r3rr3",
          "decodedId": 14,
          "type": "default",
          "name": "Mojito",
          "marketingName": null,
          "ean": null,
          "measure": "pcs",
          "isPriceVariable": true,
          "description": null,
          "imageUrl": null,
          "labels": [
            "label"
          ],
          "placeValues": [
            {
              "priceLevels": {
                "defatult": {
                  "price": 100
                }
              },
              "integationData": [
                {
                  "integrationId": "customDelivery",
                  "enabled": false,
                  "externalId": null
                }
              ],
              "vatRate": 0.12,
              "vatId": 46,
              "takeawayVatRate": null,
              "takeawayVatId": null,
              "transitionVatRate": null,
              "transitionVatId": null,
              "transitionTakeawayVatRate": null,
              "transitionTakeawayVatId": null,
              "showInPos": true,
              "favouriteOrder": 7,
              "printerIds": [
                "5dea5f419e01235ywegweggw"
              ],
              "printAttributes": [],
              "maxPercentageDiscount": null,
              "additionCategoryIds": [
                "40"
              ],
              "_removed": false
            }
          ]
        }
      ],
      "_removed": true
    }
  ],
  "virtualProducts": [
    {
      "productId": "p:1241rwq",
      "type": "advancedLoyaltyPrepayment",
      "name": "Advanced Loyalty",
      "measure": "pcs",
      "vatRate": 0.12,
      "vatId": 100,
      "transitionVatId": null,
      "takeawayVatId": null,
      "transitionVatRate": null,
      "takeawayVatRate": null,
      "transitionTakeawayVatRate": null,
      "transitionTakeawayVatId": null
    }
  ],
  "additionCategories": [
    {
      "additionCategoryId": "ac:sauces",
      "placeId": "507f1f77bcf86cd799439011",
      "title": "Pribory",
      "min": 1,
      "max": 2,
      "additions": [
        {
          "additionId": "100",
          "productId": "p:1241rwq",
          "decodedId": 100,
          "title": "Mám vlastní",
          "vatRate": 0,
          "vatId": 106,
          "takeawayVatRate": 0,
          "takeawayVatId": 3,
          "transitionVatRate": null,
          "transitionVatId": null,
          "transitionTakeawayVatRate": null,
          "transitionTakeawayVatId": null,
          "measure": "pcs",
          "additionPrice": 0,
          "subtractionPrice": 0
        }
      ],
      "showInPOS": true,
      "integrationData": [
        {
          "integrationId": "customdelivery",
          "enabled": true,
          "externalId": null
        }
      ]
    }
  ],
  "currencyCode": "CZK",
  "_version": 17938356,
  "_lastModifiedAt": "2026-07-17T08:18:48.118Z"
}

Menu API

Get time-based menu