> ## Documentation Index > Fetch the complete documentation index at: https://docs.maple.inc/llms.txt > Use this file to discover all available pages before exploring further. # Get location menu > The location's current published menu: categories, items, and variations (prices in integer minor units), shared modifier groups, and tax/fee/discount definitions. Every object echoes the `externalId` you published it under. Requires `menus:read` and an active connection to the location. ## OpenAPI ````yaml /openapi/developer-api.json get /locations/{locationId}/menu openapi: 3.1.0 info: title: Maple Developer API version: 0.0.1 description: >- Public API for POS and platform partners to integrate with Maple: granted locations and connections, the order loop (validation, notification, accept/deny, status updates), payment-link visibility, menu publishing, and HMAC-signed webhooks. Authenticate every request with a Bearer API key (`mpk_test_…` / `mpk_live_…`). The credential determines the environment: test-mode credentials only see test data, live-mode credentials only see live data. servers: - url: https://api.maple.inc/v1 description: Production - url: https://api.staging.maple.inc/v1 description: Sandbox (development and testing) security: [] tags: - name: General description: Service status and credential introspection. - name: Locations description: The restaurant locations your app has been granted access to. - name: Connections description: Become (or stop being) a granted location’s order receiver. - name: Menu description: Publish and read a connected location’s menu. - name: Orders description: 'The order loop: read orders, submit validation results, and decide orders.' - name: Webhooks description: Event-type catalog, subscriptions, the event ledger, and replay. paths: /locations/{locationId}/menu: get: tags: - Menu summary: Get location menu description: >- The location's current published menu: categories, items, and variations (prices in integer minor units), shared modifier groups, and tax/fee/discount definitions. Every object echoes the `externalId` you published it under. Requires `menus:read` and an active connection to the location. operationId: developer-api.getLocationMenu parameters: - name: locationId in: path schema: type: string required: true responses: '200': description: Success content: application/json: schema: type: object properties: catalogId: type: string storePublicId: type: string versionId: type: string currency: type: string locale: type: string timezone: type: string currencies: type: array items: type: object properties: currency: type: string exponent: type: integer cashRoundingMinor: type: integer roundingMode: type: string enum: - half_up - half_even - half_down - up - down - ceiling - floor required: - currency additionalProperties: false taxCategories: type: array items: type: object properties: id: type: string externalId: type: string name: type: string required: - name additionalProperties: false taxRates: type: array items: type: object properties: id: type: string externalId: type: string name: type: string taxCategoryId: type: string method: type: string enum: - percentage - flat - bracket percentage: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - '-Infinity' - type: string enum: - Infinity - '-Infinity' - NaN flatAmount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false brackets: type: array items: type: object properties: from: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false to: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false tax: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false required: - from - tax additionalProperties: false base: type: string enum: - price - price_plus_prior_taxes - weight - volume - quantity - alcohol_content inclusion: type: string enum: - exclusive - inclusive - context_resolved compoundOnTaxRateIds: type: array items: type: string tenderExemptions: type: array items: type: string enum: - ebt - snap - wic condition: type: object properties: minPrice: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false maxPrice: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false jurisdiction: type: string attributes: type: array items: type: object properties: key: type: string value: type: string required: - key - value additionalProperties: false additionalProperties: false hiddenFromCustomer: type: boolean required: - name additionalProperties: false fees: type: array items: type: object properties: id: type: string externalId: type: string name: type: string feeType: type: string enum: - delivery - service_charge - bag - bottle_deposit - crv - small_order - processing_pass_through - deposit - security_hold - no_show_fee - cancellation_fee - auto_gratuity - non_cash_adjustment - other calculation: type: object properties: base: type: string enum: - flat - per_unit - percentage_of_line - percentage_of_subtotal - post_discount - post_tax_total amount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false percentage: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - '-Infinity' - type: string enum: - Infinity - '-Infinity' - NaN eligibleProductSetId: type: string excludedProductSetIds: type: array items: type: string required: - base additionalProperties: false taxCategoryId: type: string refundable: type: boolean autoApply: type: object properties: byGuestCountGte: type: integer byFulfillmentMode: type: array items: type: string enum: - dine_in - takeout - delivery - pickup - curbside - shipping additionalProperties: false containers: type: array items: type: object properties: containerSizeMl: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - '-Infinity' - type: string enum: - Infinity - '-Infinity' - NaN amount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false required: - amount additionalProperties: false required: - name - feeType - calculation additionalProperties: false productSets: type: array items: type: object properties: id: type: string externalId: type: string name: type: string itemIdsAny: type: array items: type: string itemIdsAll: type: array items: type: string allProducts: type: boolean quantityExact: type: integer quantityMin: type: integer quantityMax: type: integer additionalProperties: false discounts: type: array items: type: object properties: id: type: string externalId: type: string name: type: string benefitType: type: string enum: - percentage - amount - set_price - free_item - bxgy - free_fee amount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false percentage: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - '-Infinity' - type: string enum: - Infinity - '-Infinity' - NaN maximumAmount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false benefitTargetProductSetId: type: string lineSelection: type: string enum: - least_expensive - most_expensive bxgy: type: object properties: buyProductSetId: type: string buyQuantity: type: integer getProductSetId: type: string getQuantity: type: integer getBenefit: type: string enum: - free - percentage - set_price - amount getBenefitAmount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false getBenefitPercentage: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - '-Infinity' - type: string enum: - Infinity - '-Infinity' - NaN customerChoosesReward: type: boolean excludeStrategy: type: string enum: - least_expensive - most_expensive required: - buyProductSetId - buyQuantity - getProductSetId - getQuantity - getBenefit additionalProperties: false freeFeeTargets: type: array items: type: string enum: - delivery - service_charge - bag - bottle_deposit - crv - small_order - processing_pass_through - deposit - security_hold - no_show_fee - cancellation_fee - auto_gratuity - non_cash_adjustment - other modifiesTaxBasis: type: boolean required: - name - benefitType additionalProperties: false promotions: type: array items: type: object properties: id: type: string externalId: type: string name: type: string discountId: type: string applicationMode: type: string enum: - automatic - coupon - manual eligibility: type: object properties: minimumOrderSubtotal: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false matchProductSetId: type: string excludeProductSetId: type: string additionalProperties: false availability: type: object properties: windows: type: array items: type: object properties: dayOfWeek: type: integer startTime: type: string endTime: type: string required: - dayOfWeek - startTime - endTime additionalProperties: false required: - windows additionalProperties: false validFrom: type: string validUntil: type: string stacking: type: object properties: mode: type: string enum: - exclusive - additive - best_of - ordered priority: type: integer required: - mode additionalProperties: false redemption: type: object properties: maxUsesTotal: type: integer maxUsesPerCustomer: type: integer additionalProperties: false required: - name - discountId additionalProperties: false coupons: type: array items: type: object properties: id: type: string externalId: type: string code: type: string promotionId: type: string maxRedemptions: type: integer perCustomerLimit: type: integer expiresAt: type: string required: - code - promotionId additionalProperties: false modifierGroups: type: array items: $ref: '#/components/schemas/Suspend_' categories: type: array items: type: object properties: id: type: string externalId: type: string name: type: string availability: type: object properties: windows: type: array items: type: object properties: dayOfWeek: type: integer startTime: type: string endTime: type: string required: - dayOfWeek - startTime - endTime additionalProperties: false required: - windows additionalProperties: false items: type: array items: type: object properties: id: type: string externalId: type: string name: type: string description: type: string variations: type: array items: type: object properties: id: type: string externalId: type: string name: type: string price: type: object properties: amount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false priceType: type: string enum: - fixed - variable - per_unit - bulk taxInclusive: type: boolean currencyPrices: type: array items: type: object properties: amount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false taxInclusive: type: boolean required: - amount additionalProperties: false openBounds: type: object properties: min: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false max: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false presets: type: array items: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false additionalProperties: false bulkTiers: type: array items: type: object properties: minQuantity: type: integer unitPrice: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false required: - minQuantity - unitPrice additionalProperties: false measurementUnit: type: object properties: unit: type: string precision: type: integer required: - unit additionalProperties: false compareAtAmount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false additionalProperties: false sku: type: string barcodes: type: array items: type: string modifierGroups: type: array items: anyOf: - type: object properties: groupId: type: string minSelections: type: integer maxSelections: type: integer minUniqueSelections: type: integer maxUniqueSelections: type: integer freeSelectionCount: type: integer chargeKeptDefaults: type: boolean allowedQuantities: type: array items: type: integer optionDefaults: type: array items: type: object properties: optionId: type: string defaultQuantity: type: integer required: - optionId - defaultQuantity additionalProperties: false externalId: not: {} name: not: {} options: not: {} required: - groupId additionalProperties: false - $ref: '#/components/schemas/Suspend_' dietaryLabels: type: array items: type: string allergens: type: array items: type: string calorieCount: type: integer stockStatus: type: string enum: - in_stock - out_of_stock - low_stock required: - externalId - name - price additionalProperties: false modifierGroups: type: array items: anyOf: - type: object properties: groupId: type: string minSelections: type: integer maxSelections: type: integer minUniqueSelections: type: integer maxUniqueSelections: type: integer freeSelectionCount: type: integer chargeKeptDefaults: type: boolean allowedQuantities: type: array items: type: integer optionDefaults: type: array items: type: object properties: optionId: type: string defaultQuantity: type: integer required: - optionId - defaultQuantity additionalProperties: false externalId: not: {} name: not: {} options: not: {} required: - groupId additionalProperties: false - $ref: '#/components/schemas/Suspend_' taxCategoryId: type: string taxRateIds: type: array items: type: string feeIds: type: array items: type: string dietaryLabels: type: array items: type: string allergens: type: array items: type: string calorieCount: type: integer availability: type: object properties: windows: type: array items: type: object properties: dayOfWeek: type: integer startTime: type: string endTime: type: string required: - dayOfWeek - startTime - endTime additionalProperties: false required: - windows additionalProperties: false stockStatus: type: string enum: - in_stock - out_of_stock - low_stock required: - externalId - name - variations additionalProperties: false required: - externalId - name - items additionalProperties: false required: - catalogId - storePublicId - versionId - currency - currencies - taxCategories - taxRates - fees - productSets - discounts - promotions - coupons - modifierGroups - categories additionalProperties: false '401': description: DeveloperApiUnauthorized content: application/json: schema: $ref: '#/components/schemas/DeveloperApiUnauthorized' '403': description: DeveloperApiForbidden content: application/json: schema: $ref: '#/components/schemas/DeveloperApiForbidden' '404': description: DeveloperApiNotFound content: application/json: schema: $ref: '#/components/schemas/DeveloperApiNotFound' security: - bearer: [] components: schemas: Suspend_: type: object properties: id: type: string externalId: type: string name: type: string inputType: type: string enum: - options - text minSelections: type: integer maxSelections: type: integer minUniqueSelections: type: integer maxUniqueSelections: type: integer freeSelectionCount: type: integer chargeKeptDefaults: type: boolean allowedQuantities: type: array items: type: integer options: type: array items: type: object properties: id: type: string externalId: type: string name: type: string price: type: object properties: amount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false priceType: type: string enum: - fixed - variable - per_unit - bulk taxInclusive: type: boolean currencyPrices: type: array items: type: object properties: amount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false taxInclusive: type: boolean required: - amount additionalProperties: false openBounds: type: object properties: min: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false max: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false presets: type: array items: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false additionalProperties: false bulkTiers: type: array items: type: object properties: minQuantity: type: integer unitPrice: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false required: - minQuantity - unitPrice additionalProperties: false measurementUnit: type: object properties: unit: type: string precision: type: integer required: - unit additionalProperties: false compareAtAmount: type: object properties: amountMinor: type: integer currency: type: string required: - amountMinor - currency additionalProperties: false additionalProperties: false defaultQuantity: type: integer minQuantity: type: integer maxQuantity: type: integer taxCategoryId: type: string taxRateIds: type: array items: type: string dietaryLabels: type: array items: type: string allergens: type: array items: type: string stockStatus: type: string enum: - in_stock - out_of_stock - low_stock modifierGroups: type: array items: anyOf: - type: object properties: groupId: type: string minSelections: type: integer maxSelections: type: integer minUniqueSelections: type: integer maxUniqueSelections: type: integer freeSelectionCount: type: integer chargeKeptDefaults: type: boolean allowedQuantities: type: array items: type: integer optionDefaults: type: array items: type: object properties: optionId: type: string defaultQuantity: type: integer required: - optionId - defaultQuantity additionalProperties: false externalId: not: {} name: not: {} options: not: {} required: - groupId additionalProperties: false - $ref: '#/components/schemas/Suspend_' required: - externalId - name additionalProperties: false textMaxLength: type: integer groupId: not: {} required: - externalId - name - minSelections - maxSelections additionalProperties: false DeveloperApiUnauthorized: type: object properties: _tag: type: string enum: - DeveloperApiUnauthorized message: type: string required: - _tag - message additionalProperties: false DeveloperApiForbidden: type: object properties: _tag: type: string enum: - DeveloperApiForbidden code: type: string enum: - insufficient_scope - wrong_environment message: type: string required: - _tag - code - message additionalProperties: false DeveloperApiNotFound: type: object properties: _tag: type: string enum: - DeveloperApiNotFound message: type: string required: - _tag - message additionalProperties: false securitySchemes: bearer: type: http scheme: bearer description: >- API key — `mpk_test_…` for the sandbox, `mpk_live_…` for production. Issued by Maple during partner onboarding. ````