Get menu tree details

gethttps://core-api.ancon.io/api/v1/Tenants/{tenantId}/MenuTrees/{menuTreeId}

View .md OpenAPI

Authorization

Access-Tokenheaderrequired
Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

tenantIdstring (uuid)required
menuTreeIdstring (uuid)required

Header parameters

correlationIdstring
Correlation Id for the request

Responses

200OKapplication/json

idstring (uuid)
namestring | null
isMandatoryboolean
menuTreeItemsarray<object | object> | null
outletSharesarray<object> | null
3 fields in outletShares
- idstring (uuid)
- namestring | null
- productShareTypeinteger (int32)
  Allowed values: 0, 1.

400Bad Requestapplication/json

messagestring | null
errorCodestring (uuid)
additionalDataany | null

401Unauthorizedapplication/json

messagestring | null

404Not Foundapplication/json

messagestring | null
errorCodestring (uuid)

Request

curl -X GET "https://core-api.ancon.io/api/v1/Tenants/{tenantId}/MenuTrees/{menuTreeId}" \
  -H "Access-Token: $ANCON_TOKEN"

Response

{
  "id": "36632d35-66e0-4713-8f0a-ae5d07f75ae9",
  "name": "Example menu tree",
  "isMandatory": true,
  "menuTreeItems": [
    {
      "name": "Favorites",
      "id": "031bb689-c68e-4f09-8ed1-791a9e8422d9",
      "menuTreeItemType": 2,
      "menuTreeBranchId": null,
      "backgroundColor": null,
      "sortOrder": 0
    },
    {
      "name": "Food",
      "id": "3c8aaaf1-7531-48cd-b631-341a9b5b16b9",
      "menuTreeItemType": 0,
      "menuTreeBranchId": null,
      "backgroundColor": null,
      "sortOrder": 1
    },
    {
      "name": "Drinks",
      "id": "c1fc870e-d34a-4a3b-b676-16706f8358ac",
      "menuTreeItemType": 0,
      "menuTreeBranchId": null,
      "backgroundColor": null,
      "sortOrder": 2
    },
    {
      "productId": "c553a6ba-060a-4905-8bbc-59d353e4e636",
      "productName": "Coca cola",
      "productDescription": null,
      "id": "b9da79d6-1aa9-4abd-87ad-7c4359320b7e",
      "menuTreeItemType": 1,
      "menuTreeBranchId": "031bb689-c68e-4f09-8ed1-791a9e8422d9",
      "backgroundColor": "#ECB82A",
      "sortOrder": 0
    },
    {
      "productId": "6bc20a5e-25a2-4b71-994c-117be4394daa",
      "productName": "Hamburger",
      "productDescription": null,
      "id": "99a6b020-1ffc-4bff-8a3b-c718b52946ce",
      "menuTreeItemType": 1,
      "menuTreeBranchId": "3c8aaaf1-7531-48cd-b631-341a9b5b16b9",
      "backgroundColor": "#ECB82A",
      "sortOrder": 0
    },
    {
      "productId": "7cfe3f38-0b60-4fec-b69e-8af66a24dc5c",
      "productName": "Pizza",
      "productDescription": null,
      "id": "f5695baf-aff6-40f7-b0c4-f5ada5695f1d",
      "menuTreeItemType": 1,
      "menuTreeBranchId": "3c8aaaf1-7531-48cd-b631-341a9b5b16b9",
      "backgroundColor": "#ECB82A",
      "sortOrder": 1
    },
    {
      "productId": "9901bbc4-510c-4ae2-907a-c046340ffd2a",
      "productName": "Coca cola",
      "productDescription": null,
      "id": "f1d2b4a5-1fc7-48e6-b1ee-ba9aea01dd2b",
      "menuTreeItemType": 1,
      "menuTreeBranchId": "c1fc870e-d34a-4a3b-b676-16706f8358ac",
      "backgroundColor": "#ECB82A",
      "sortOrder": 0
    },
    {
      "productId": "ebd3800f-a92c-44fb-a8cc-c3e7a4ae0b3a",
      "productName": "Fanta",
      "productDescription": null,
      "id": "d40b9f08-2468-4f8f-8d5a-400cf8867b1b",
      "menuTreeItemType": 1,
      "menuTreeBranchId": "c1fc870e-d34a-4a3b-b676-16706f8358ac",
      "backgroundColor": "#ECB82A",
      "sortOrder": 1
    },
    {
      "productId": "a747214a-817a-410c-846e-1dd22be66cf8",
      "productName": "Sprite",
      "productDescription": null,
      "id": "94320285-d8a5-4ff8-bbc7-f0db6256ecfe",
      "menuTreeItemType": 1,
      "menuTreeBranchId": "c1fc870e-d34a-4a3b-b676-16706f8358ac",
      "backgroundColor": "#ECB82A",
      "sortOrder": 2
    }
  ],
  "outletShares": [
    {
      "id": "442da7eb-aefe-49ae-aa78-507b89929916",
      "name": "Outlet 1",
      "productShareType": 0
    }
  ]
}

#Authorization

#Path parameters

#Header parameters

#Responses

Authorization

Path parameters

Header parameters

Responses