CLcloudkitchens
manager_menu_endpoints

Get the menus for a store

Rate limit: 8 requests per minute.

get/v1/menus

Request

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier

Response

The store's menu.

photosobject required
categoriesobject required
modifierGroupsobject required
menusobject
itemsobject

Example response

{
  "photos": {
    "c75d9460-5d48-423d-8d01-f825fd5b1672": {
      "id": "c75d9460-5d48-423d-8d01-f825fd5b1672",
      "fileName": "c75d9460-5d48-423d-8d01-f825fd5b1672.jpeg",
      "url": "https://example.com/photos/c75d9460-5d48-423d-8d01-f825fd5b1672.jpeg"
    }
  },
  "categories": {
    "b01485b0-034a-47c5-8a0a-0eeca08bf994": {
      "name": "Drinks",
      "description": "All drink items served up nice and fresh!",
      "id": "b01485b0-034a-47c5-8a0a-0eeca08bf994",
      "itemIds": [
        "fa4f0192-4c4e-4455-9db8-61d428c34969"
      ]
    }
  },
  "modifierGroups": {
    "f4c69056-3ae3-4517-9294-5ceec8df5f81": {
      "id": "f4c69056-3ae3-4517-9294-5ceec8df5f81",
      "name": "Add Straw",
      "minimumSelections": 0,
      "maximumSelections": 1,
      "defaultModifierSelectionData": {
        "defaultModifierSelections": [
          {
            "itemId": "6d53cf04-9d62-40f5-a8b3-706e3377668f",
            "selectionQuantity": 1
          }
        ]
      },
      "itemIds": [
        "6d53cf04-9d62-40f5-a8b3-706e3377668f"
      ],
      "type": "DEFAULT",
      "exposedThirdPartyInfos": [
        {
          "externalId": "ff6dd693-5e55-4a92-a359-ea61b23ed423",
          "externalServiceSlug": "3PD"
        }
      ]
    }
  },
  "menus": {
    "ff6dd693-5e55-4a92-a359-ea61b23ed423": {
      "id": "ff6dd693-5e55-4a92-a359-ea61b23ed423",
      "name": "Tasty BBQ",
      "categoryIds": [
        "b01485b0-034a-47c5-8a0a-0eeca08bf994"
      ],
      "fulfillmentModes": [
        "DELIVERY"
      ],
      "description": "Cooking up BBQ deliciousness from around the globe!",
      "hours": {
        "intervals": [
          {
            "day": "MONDAY",
            "fromHour": 7,
            "fromMinute": 30,
            "toHour": 22,
            "toMinute": 0
          }
        ]
      },
      "additionalCharges": [
        {
          "chargeType": "PACKAGING_CHARGE",
          "flatCharge": {
            "currencyCode": "USD",
            "amount": 1.5
          }
        }
      ]
    }
  },
  "items": {
    "fa4f0192-4c4e-4455-9db8-61d428c34969": {
      "id": "fa4f0192-4c4e-4455-9db8-61d428c34969",
      "name": "Canned Coke",
      "description": "Best soda pop ever made",
      "price": {
        "currencyCode": "USD",
        "amount": 7.65
      },
      "status": {
        "saleStatus": "FOR_SALE"
      },
      "modifierGroupIds": [
        "f4c69056-3ae3-4517-9294-5ceec8df5f81"
      ],
      "photoIds": [
        "c75d9460-5d48-423d-8d01-f825fd5b1672"
      ],
      "priceOverrides": [
        {
          "rules": [
            {
              "type": "FulfillmentModeOverrideRule",
              "fulfillmentMode": "PICK_UP"
            }
          ],
          "price": {
            "currencyCode": "USD",
            "amount": 7
          }
        }
      ],
      "skuDetails": {
        "skuSlug": "canned-coke-355ml",
        "skuId": "3bac7aed-c8c1-4bfa-a98a-350317e55072",
        "dietaryClassifications": [
          {
            "tag": "VEGAN"
          }
        ],
        "allergenClassifications": [
          {
            "tag": "GLUTEN",
            "containsAllergen": false
          },
          {
            "tag": "PEANUT",
            "containsAllergen": true
          }
        ],
        "storageRequirements": [
          {
            "tag": "COLD"
          },
          {
            "tag": "AVOID_SUNLIGHT"
          }
        ],
        "additives": [
          "flavor enhancers",
          "food coloring"
        ],
        "containsAlcohol": false,
        "nutritionalInfo": {
          "energyKcal": {
            "low": 1,
            "high": 100
          },
          "nutritionContent": {
            "servingSizeInGrams": 100,
            "servingSizeInMilliliters": 100,
            "fats": 100.2,
            "saturatedFats": 3.5,
            "monoUnsaturatedFats": "5.2,",
            "polyUnsaturatedFats": "1.3,",
            "carbohydrates": "3.2,",
            "sugar": "101,",
            "polyols": "1.1,",
            "starch": "1.2,",
            "protein": "1.3,",
            "salt": "1.4,",
            "sodium": "1.5,",
            "fibres": "1.6,",
            "vitaminC": "1.7,",
            "calcium": "1.8,",
            "magnesium": "1.9,",
            "chloride": "2.0,",
            "fluoride": "2.1,",
            "potassium": "2.2,",
            "caffeine": "2.3,",
            "energy": 2.4
          }
        },
        "servings": {
          "min": 1,
          "max": 2
        },
        "producerInformation": "The Coca-Cola Company",
        "distributorInformation": "The Coca-Cola Company",
        "countryOfOriginIso2": "US"
      },
      "additionalCharges": [
        {
          "chargeType": "PACKAGING_CHARGE",
          "percentageCharge": {
            "decimalValue": 0.015
          }
        }
      ],
      "tax": {
        "percentageValue": {
          "decimalValue": 0.513
        },
        "isValueAddedTax": true
      }
    },
    "6d53cf04-9d62-40f5-a8b3-706e3377668f": {
      "id": "6d53cf04-9d62-40f5-a8b3-706e3377668f",
      "name": "Paper straw",
      "description": "A paper straw",
      "price": {
        "currencyCode": "USD",
        "amount": 0.5
      },
      "status": {
        "saleStatus": "FOR_SALE"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.