GET /commerce/{accountId}/stores/{storeId}/menus

Returns the menus available for a specific store.

Path parameters

  • accountId string Required

    Default value is 668e4aa170efd23c474b2ad1.

  • storeId string Required

    The storeId here is the channelLinkId

    Default value is 67eec873bce11fefe906a2a8.

Query parameters

  • fulfillmentType string

    Possible values are; delivery | pickup | curbside | eatIn

    Default value is pickup.

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • menu string
    • menuId string
    • menuType integer

      Default value is 0.

    • nestedModifiers boolean

      Default value is true.

    • channelLinkId string
    • description string
    • currency integer

      Default value is 0.

    • menuTranslations object
    • productTags array[integer]

      Default value is 0.

    • descriptionTranslations object
    • availabilities array[object]
      Hide availabilities attributes Show availabilities attributes object
      • dayOfWeek integer

        Default value is 0.

      • startTime string
      • endTime string
    • categories array[object]
      Hide categories attributes Show categories attributes object
      • name string
      • description string
      • imageUrl string
      • menu string
      • account string
      • nameTranslations object
      • descriptionTranslations object
      • availabilities array
      • subProducts array[string]
    • products object
      Hide products attribute Show products attribute object
      • 62d7f77e64c95193cc29aa63 object
        Hide 62d7f77e64c95193cc29aa63 attributes Show 62d7f77e64c95193cc29aa63 attributes object
        • id string
        • plu string
        • name string
        • price integer

          Default value is 0.

        • productType integer

          Default value is 0.

        • max integer

          Default value is 0.

        • min integer

          Default value is 0.

        • multiply integer

          Default value is 0.

        • snoozed boolean

          Default value is true.

        • deliveryTax integer

          Default value is 0.

        • takeawayTax integer

          Default value is 0.

        • eatInTax integer

          Default value is 0.

        • description string
        • account string
        • referenceId string
        • location string
        • posProductCategoryId string
        • posProductId string
        • nameTranslations object
          Hide nameTranslations attributes Show nameTranslations attributes object
          • en string
          • es string
          • fr string
          • nl string
        • descriptionTranslations object
        • productTags array
        • subProducts array[string]
        • posCategoryIds array[string]
        • subProductSortOrder array
    • modifiers object
      Hide modifiers attribute Show modifiers attribute object
      • 62d7f77e64c95193cc29aa53 object
        Hide 62d7f77e64c95193cc29aa53 attributes Show 62d7f77e64c95193cc29aa53 attributes object
        • id string
        • plu string
        • name string
        • price integer

          Default value is 0.

        • productType integer

          Default value is 0.

        • max integer

          Default value is 0.

        • min integer

          Default value is 0.

        • multiply integer

          Default value is 0.

        • snoozed boolean

          Default value is true.

        • deliveryTax integer

          Default value is 0.

        • takeawayTax integer

          Default value is 0.

        • eatInTax integer

          Default value is 0.

        • description string
        • account string
        • location string
        • posProductCategoryId string
        • posProductId string
        • nameTranslations object
        • descriptionTranslations object
        • productTags array
        • subProducts array
        • posCategoryIds array[string]
        • subProductSortOrder array
    • modifierGroups object
      Hide modifierGroups attribute Show modifierGroups attribute object
      • 62d7f77e64c95193cc29aa64 object
        Hide 62d7f77e64c95193cc29aa64 attributes Show 62d7f77e64c95193cc29aa64 attributes object
        • id string
        • plu string
        • name string
        • productType integer

          Default value is 0.

        • max integer

          Default value is 0.

        • min integer

          Default value is 0.

        • multiply integer

          Default value is 0.

        • snoozed boolean

          Default value is true.

        • deliveryTax integer

          Default value is 0.

        • takeawayTax integer

          Default value is 0.

        • eatInTax integer

          Default value is 0.

        • description string
        • account string
        • location string
        • posProductCategoryId string
        • posProductId string
        • nameTranslations object
          Hide nameTranslations attributes Show nameTranslations attributes object
          • en string
          • es string
          • fr string
          • nl string
        • descriptionTranslations object
        • productTags array
        • subProducts array[string]
        • posCategoryIds array
        • subProductSortOrder array
    • bundles object
      Hide bundles attribute Show bundles attribute object
      • 62d7f77e64c95193cc29aa4d object
        Hide 62d7f77e64c95193cc29aa4d attributes Show 62d7f77e64c95193cc29aa4d attributes object
        • id string
        • plu string
        • name string
        • productType integer

          Default value is 0.

        • max integer

          Default value is 0.

        • min integer

          Default value is 0.

        • multiply integer

          Default value is 0.

        • snoozed boolean

          Default value is true.

        • deliveryTax integer

          Default value is 0.

        • takeawayTax integer

          Default value is 0.

        • eatInTax integer

          Default value is 0.

        • description string
        • account string
        • location string
        • posProductCategoryId string
        • posProductId string
        • nameTranslations object
        • descriptionTranslations object
        • productTags array
        • subProducts array[string]
        • posCategoryIds array
        • subProductSortOrder array
    • snoozedProducts object
  • 400 application/json

    400

  • 500 application/json

    Internal Server Error

GET /commerce/{accountId}/stores/{storeId}/menus
curl \
 --request GET 'https://api.staging.deliverect.com/commerce/{accountId}/stores/{storeId}/menus' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "menu": "Spring menu",
    "menuId": "62d7f77f64c95193cc29aa91",
    "bundles": {
      "62d7f77e64c95193cc29aa4d": {
        "id": "62d7f77e64c95193cc29aa4d",
        "max": 1,
        "min": 1,
        "plu": "BNDL-BRG",
        "name": "Burger Selection",
        "price": null,
        "account": "62d7f53b2f46fac3eedc7dea",
        "snoozed": false,
        "calories": null,
        "eatInTax": 9000,
        "location": "62d7f5ce2f46fac3eedca174",
        "multiMax": null,
        "multiply": 1,
        "isVariant": null,
        "packaging": null,
        "deliveryTax": 9000,
        "description": "",
        "productTags": [],
        "productType": 4,
        "referenceId": null,
        "subProducts": [
          "65ef3584327cc41b45ebfae6",
          "65ef3584327cc41b45ebfae7",
          "65ef3584327cc41b45ebfae8"
        ],
        "takeawayTax": 9000,
        "beverageInfo": null,
        "posProductId": "POS-ID-020",
        "posCategoryIds": [],
        "defaultQuantity": null,
        "nutritionalInfo": null,
        "nameTranslations": {},
        "supplementalInfo": null,
        "caloriesRangeHigh": null,
        "bottleDepositPrice": null,
        "subProductSortOrder": [],
        "posProductCategoryId": "",
        "descriptionTranslations": {}
      }
    },
    "currency": 1,
    "menuType": 0,
    "products": {
      "62d7f77e64c95193cc29aa63": {
        "id": "62d7f77e64c95193cc29aa63",
        "max": 0,
        "min": 0,
        "plu": "STK-01",
        "name": "Delicious Steak Frites",
        "price": 1500,
        "account": "62d7f53b2f46fac3eedc7dea",
        "snoozed": false,
        "calories": null,
        "eatInTax": 0,
        "location": "62d7f5ce2f46fac3eedca174",
        "multiMax": null,
        "multiply": 1,
        "isVariant": null,
        "packaging": null,
        "deliveryTax": 10000,
        "description": "Basic Example Product with - Modifier groups - min/max variables - default selection - translations",
        "productTags": [],
        "productType": 1,
        "referenceId": "STK-01",
        "subProducts": [
          "62d7f77e64c95193cc29aa64"
        ],
        "takeawayTax": 7300,
        "beverageInfo": null,
        "posProductId": "POS-ID-001",
        "posCategoryIds": [
          "STK"
        ],
        "defaultQuantity": null,
        "nutritionalInfo": null,
        "nameTranslations": {
          "en": "Delicious Steak Frites",
          "es": "Deliciosos Bistecs Fritos",
          "fr": "Steak Frites Délicieux",
          "nl": "Heerlijke Biefstuk Frites"
        },
        "supplementalInfo": null,
        "caloriesRangeHigh": null,
        "bottleDepositPrice": null,
        "subProductSortOrder": [],
        "posProductCategoryId": "",
        "descriptionTranslations": {}
      }
    },
    "modifiers": {
      "62d7f77e64c95193cc29aa53": {
        "id": "62d7f77e64c95193cc29aa53",
        "max": 0,
        "min": 0,
        "plu": "DRNK-01",
        "name": "Coca Cola",
        "price": 400,
        "account": "62d7f53b2f46fac3eedc7dea",
        "snoozed": false,
        "calories": null,
        "eatInTax": 9000,
        "location": "62d7f5ce2f46fac3eedca174",
        "multiMax": null,
        "multiply": 1,
        "isVariant": null,
        "packaging": null,
        "deliveryTax": 9000,
        "description": "Cola flavoured sugar and caffeine",
        "productTags": [],
        "productType": 1,
        "referenceId": null,
        "subProducts": [],
        "takeawayTax": 9000,
        "beverageInfo": null,
        "posProductId": "POS-ID-029",
        "posCategoryIds": [
          "DRK"
        ],
        "defaultQuantity": null,
        "nutritionalInfo": null,
        "nameTranslations": {},
        "supplementalInfo": null,
        "caloriesRangeHigh": null,
        "bottleDepositPrice": null,
        "subProductSortOrder": [],
        "posProductCategoryId": "",
        "descriptionTranslations": {}
      }
    },
    "categories": [
      {
        "id": null,
        "menu": "62d7f77f64c95193cc29aa91",
        "name": "Steak & Burgers",
        "account": "62d7f53b2f46fac3eedc7dea",
        "imageUrl": "https: //resizer.staging.deliverect.com/uia9zWj73e5qP3yQGd4sQrYWcjmQyo-XRJMg3LaMobg/rt:fill/g:ce/el:0/aHR0cHM6Ly9zdG9yYWdlLmdvb2dsZWFwaXMuY29tL2lrb25hLWJ1Y2tldC1zdGFnaW5nL2ltYWdlcy81ZmY2ZWUwODkzMjhjOGFlZmVlYWJlMzMvZ3JpbGwtNjIyYTJjNDhjNzE1YjQwM2IwZWI3MmJlLmpwZWc=.jpg",
        "description": "Something from the Grill",
        "subProducts": [
          "62d7f77e64c95193cc29aa63",
          "62d7f77e64c95193cc29aa4c",
          "62d7f77e64c95193cc29aa4f",
          "62d7f77e64c95193cc29aa4e",
          "62d7f77e64c95193cc29aa50"
        ],
        "availabilities": [],
        "nameTranslations": {},
        "descriptionTranslations": {}
      }
    ],
    "description": "Our menu of various product for a beautiful spring, enjoy! ",
    "productTags": [
      104,
      108,
      103,
      9,
      8,
      1101,
      1129,
      109,
      112
    ],
    "menuImageUrl": null,
    "channelLinkId": "65eee6a9984a1bc1b9637c59",
    "availabilities": [
      {
        "endTime": "22: 00",
        "dayOfWeek": 1,
        "startTime": "13: 00"
      },
      {
        "endTime": "22: 00",
        "dayOfWeek": 2,
        "startTime": "06: 00"
      },
      {
        "endTime": "22: 00",
        "dayOfWeek": 3,
        "startTime": "06: 00"
      },
      {
        "endTime": "22: 00",
        "dayOfWeek": 4,
        "startTime": "06: 00"
      },
      {
        "endTime": "18: 00",
        "dayOfWeek": 5,
        "startTime": "15: 00"
      },
      {
        "endTime": "22: 00",
        "dayOfWeek": 6,
        "startTime": "06: 00"
      },
      {
        "endTime": "22: 00",
        "dayOfWeek": 7,
        "startTime": "06: 00"
      }
    ],
    "modifierGroups": {
      "62d7f77e64c95193cc29aa64": {
        "id": "62d7f77e64c95193cc29aa64",
        "max": 1,
        "min": 1,
        "plu": "MOD-01",
        "name": "Cooking instructions",
        "price": null,
        "account": "62d7f53b2f46fac3eedc7dea",
        "snoozed": false,
        "calories": null,
        "eatInTax": 9000,
        "location": "62d7f5ce2f46fac3eedca174",
        "multiMax": null,
        "multiply": 1,
        "isVariant": null,
        "packaging": null,
        "deliveryTax": 9000,
        "description": "",
        "productTags": [],
        "productType": 3,
        "referenceId": null,
        "subProducts": [
          "62d7f77e64c95193cc29aa53"
        ],
        "takeawayTax": 9000,
        "beverageInfo": null,
        "posProductId": "POS-ID-002",
        "posCategoryIds": [],
        "defaultQuantity": null,
        "nutritionalInfo": null,
        "nameTranslations": {
          "en": "Cooking Instructions",
          "es": "Cocinado",
          "fr": "Cuisson",
          "nl": "Kook instructies"
        },
        "supplementalInfo": null,
        "caloriesRangeHigh": null,
        "bottleDepositPrice": null,
        "subProductSortOrder": [],
        "posProductCategoryId": "",
        "descriptionTranslations": {}
      }
    },
    "nestedModifiers": true,
    "snoozedProducts": {},
    "menuTranslations": {},
    "descriptionTranslations": {}
  }
]
Response examples (400)
{}
Response examples (500)
{}