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.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Query Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.storyous.com/menu/5837801c78c5400e00e57dc2?placeId=&integrationId='\''customdelivery'\''&categoryId=null&depth=-1&includeRemoved='\''false'\''' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "menuId": "merchantId1",
  "items": [
    {
      "categoryId": "a67896",
      "name": "Main courses",
      "posName": "Main courses",
      "color": "#rrggbb",
      "icon": "course",
      "items": []
    },
    {
      "productId": "p:3c2RnNzAw",
      "decodedId": 3,
      "type": "default",
      "name": "Cucumber",
      "marketingName": null,
      "ean": null,
      "measure": "pcs",
      "isPriceVariable": false,
      "description": null,
      "imageUrl": null,
      "labels": [],
      "placeValues": {
        "priceLevels": {
          "default": {
            "price": 100
          }
        },
        "integrationData": [
          {
            "integrationId": "externalPos",
            "enabled": true,
            "externalId": "6216278311079"
          }
        ],
        "vatRate": 0.15,
        "vatId": 2,
        "takeawayVatRate": null,
        "takeawayVatId": null,
        "showInPos": true,
        "printerIds": []
      }
    },
    {
      "productId": "p:pamY4YThv",
      "decodedId": 25,
      "type": "default",
      "name": "Ham and eggs",
      "marketingName": "Delicious ham and eggs",
      "ean": null,
      "measure": "pcs",
      "variablePrice": true,
      "imageUrl": null,
      "labels": [
        "food"
      ],
      "placesValues": {
        "placeId1": {
          "isPriceVariable": true,
          "priceLevels": {
            "null": {
              "price": 15
            },
            "gardenLevel": {
              "price": 12
            }
          },
          "vatRate": 0.15,
          "showInPos": true,
          "printerIds": [],
          "additionCategoryIds": [
            "5"
          ],
          "_removed": false
        }
      },
      "placeValues": {
        "placeId": "placeId1",
        "isPriceVariable": true,
        "priceLevels": {
          "null": {
            "price": 15
          },
          "gardenLevel": {
            "price": 12
          }
        },
        "vatRate": 0.15,
        "showInPos": true,
        "printerIds": [
          "584c296e26d5560e00bca240",
          "587cbb21923d5f0e00a23048"
        ],
        "printAttributes": [
          {
            "printerId": "584c296e26d5560e00bca240",
            "attributes": [
              "highlighted"
            ]
          }
        ],
        "additionCategoryIds": [
          "5"
        ],
        "_removed": false
      },
      "_removed": false
    }
  ],
  "additionCategories": [
    {
      "additionCategoryId": "5",
      "placeId": "5dea5ec89e01eb0015219139",
      "title": "Pizza extras",
      "min": null,
      "max": 10,
      "additions": [
        {
          "additionId": "39",
          "productId": "p:8cWNoMWpw",
          "decodedId": 8,
          "type": "default",
          "title": "Olivy",
          "vatRate": 0.21,
          "vatId": 1,
          "takeawayVatRate": 0.15,
          "takeawayVatId": 2,
          "measure": "pcs",
          "additionPrice": 0,
          "subtractionPrice": 0
        },
        {
          "additionId": "40",
          "productId": "p:8cWNoMWpw",
          "decodedId": 8,
          "type": "default",
          "title": "Vejce",
          "vatRate": 0.21,
          "vatId": 1,
          "takeawayVatRate": null,
          "takeawayVatId": null,
          "measure": "pcs",
          "additionPrice": 0,
          "subtractionPrice": 0
        }
      ]
    }
  ],
  "_version": 1,
  "_lastModifiedAt": "2016-06-19T10:32:01Z"
}

Menu API

Get time-based menu