> ## Documentation Index
> Fetch the complete documentation index at: https://api-doc.xmenu.it/llms.txt
> Use this file to discover all available pages before exploring further.

# Get product

> Returns details of a single product by its unique identifier.



## OpenAPI

````yaml openapi-en.json GET /menu/product
openapi: 3.1.0
info:
  title: xMenu API
  description: xMenu Public API - REST endpoints and webhook notifications
  version: 1.0.0
servers:
  - url: https://app.xmenu.it/api
    description: xMenu API Production
security: []
paths:
  /menu/product:
    get:
      tags:
        - Menu Consultation
      summary: Get product
      description: Returns details of a single product by its unique identifier.
      operationId: getProduct
      parameters:
        - name: uid
          in: query
          required: true
          schema:
            type: string
          description: Unique product identifier
      responses:
        '200':
          description: Product response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - apiKey: []
        - clientId: []
          clientSecret: []
        - oauth2: []
components:
  schemas:
    ProductResponse:
      type: object
      required:
        - success
      properties:
        success:
          type: boolean
          description: 'Operation result: `true` if successful, `false` if failed'
        product:
          $ref: '#/components/schemas/MenuProduct'
        error:
          type: string
          description: >-
            Error code if the operation failed. Possible values:

            - `PRODUCT_NOT_FOUND` = Requested product not found


            See [Error codes](/docs/en/overview/error-codes) for general error
            codes that may also occur.
        message:
          type: string
          description: Human-readable error description if the operation failed
    MenuProduct:
      type: object
      description: Menu product
      properties:
        uid:
          type: string
          description: Unique product identifier
        category_uid:
          type: string
          description: Parent category identifier
        name:
          type: string
          description: Product name
        ingredients:
          type: string
          description: Product description or ingredients
        price:
          type: number
          description: Base price
        prices_table:
          type: object
          description: >-
            Pricing table specific to location / delivery method, with the
            following structure:

            ```javascript

            {
               "": { // all locations
                  "0": price0, // pickup at restaurant
                  "1": price1, // home delivery
                  ... // prices for other delivery methods
               },
               "subrestaurantUid1": { // Location 1
                  "0": price0,
                  "1": price1,
                  ...
               },
               ...
            }

            ```


            **Delivery method codes:**

            - `"0"` = Pickup at restaurant

            - `"1"` = Home delivery

            - `"0t"` = Table ordering

            - `"0mt"` = Digital menu

            - `"20"` = Pickup at delivery point

            - `"0e-{id}"` = Event

            - `"dcf-{id}"` = Custom delivery method
          additionalProperties:
            type: object
            additionalProperties:
              type: number
        image:
          type: string
          description: Image URL
        allergens:
          type: array
          items:
            type: string
          description: |-
            List of allergens. Possible values:
            - `gluten` = 1 - Gluten
            - `crustaceans` = 2 - Crustaceans
            - `eggs` = 3 - Eggs
            - `fish` = 4 - Fish
            - `peanuts` = 5 - Peanuts
            - `soya` = 6 - Soy
            - `milk` = 7 - Milk
            - `nuts` = 8 - Tree nuts
            - `celery` = 9 - Celery
            - `mustard` = 10 - Mustard
            - `sesame` = 11 - Sesame
            - `sulphites` = 12 - Sulphites
            - `lupin` = 13 - Lupin
            - `molluscs` = 14 - Molluscs
            - `freezer` = Frozen and deep-frozen
        symbols:
          type: array
          items:
            type: string
          description: |-
            List of symbols. Possible values:
            - `new` = New
            - `bestseller` = Best seller
            - `vegan` = Vegan
            - `vegetarian` = Vegetarian
            - `spicy` = Spicy
            - `pizza` = Pizza
            - `burger` = Burger
            - `chips` = Chips
            - `icecream` = Ice cream
            - `sweets` = Desserts
            - `drink` = Drink
            - `freshfish` = Fresh fish
            - `cookedfish` = Cooked fish
        suggested:
          type: boolean
          description: >-
            Whether the product is marked as recommended (displays the 'Best
            choice' badge and highlights the product in the menu)
        price_sale_alert:
          type: boolean
          description: >-
            Whether the product is featured (displayed prominently when the user
            starts composing the cart)
        price_sale_badge:
          type: integer
          description: >-
            Promotional text badge shown on the product detail page when
            `price_sale_alert` is `true`. Possible values:

            - `0` = On Sale

            - `1` = Promo of the Day

            - `2` = How often do you get this chance?

            - `3` = But why miss it?

            - `4` = When will you get a chance like this again?

            - `5` = Promo of the Week

            - `6` = Promo of the Month

            - `7` = Unbelievable!

            - `8` = Black Friday special

            - `9` = Have you already tried it?
        checkout_selling:
          type: boolean
          description: Whether the product is proposed at checkout as cross-selling
        url:
          type: string
          description: Product page URL
        hidden:
          type: boolean
          description: Visibility status
        position:
          type: integer
          description: Display position
        subrestaurant_uids:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            List of subrestaurant UIDs where this product is available (null =
            available in all locations)
        ext_id:
          $ref: '#/components/schemas/ExtId'
        inherits_options:
          type: string
          enum:
            - sync
            - 'yes'
            - none
          description: >-
            Option inheritance mode from category:

            - `yes` = Full inheritance — product uses only the category options;
            the `options` field is absent in the response (use the get_category
            endpoint to retrieve the effective options)

            - `sync` = Partial inheritance — product shows both the category
            options and its own product-specific options; `options` contains all
            effective options

            - `none` = No inheritance — product has only its own specific
            options
        options:
          type: array
          description: Product-specific options
          items:
            $ref: '#/components/schemas/MenuOption'
    ExtId:
      type: string
      description: >-
        Available when authenticating via API Client: External ID passed during
        menu import
    MenuOption:
      type: object
      description: Menu product or category option
      properties:
        uid:
          type: string
          description: Unique option identifier
        name:
          type: string
          description: Option title
        short_name:
          type: string
          description: Abbreviated option title
        type:
          type: string
          enum:
            - single
            - multiple
          description: |-
            Selection type:
            - `single` = Single choice
            - `multiple` = Multiple choices allowed
        min_selectable:
          type: integer
          description: Minimum number of selectable values (only for type `multiple`)
        max_selectable:
          type: integer
          description: Maximum number of selectable values (only for type `multiple`)
        max_quantity:
          type: integer
          description: Maximum quantity per value selection (if >1)
        note:
          type: string
          description: Option-related notes
        hidden:
          type: boolean
          description: |-
            Visibility status:
            - `false` = Visible
            - `true` = Archived
        position:
          type: integer
          description: Display position (starts at 1)
        primary:
          type: boolean
          description: |-
            Primary option flag (only for type `single`):
            - `false` = Non-primary
            - `true` = Primary option
        first_default:
          type: boolean
          description: |-
            Default selection behavior (only for type `single`):
            - `false` = User must select
            - `true` = First value used as default
        show_caption:
          type: boolean
          description: |-
            Cart display setting (only for type `single`):
            - `false` = Hide in cart
            - `true` = Display in cart
        print_caption:
          type: boolean
          description: |-
            Print behavior:
            - `false` = Omit from order printing
            - `true` = Include in printing
        subrestaurant_uids:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            List of subrestaurant UIDs where this option is available (null =
            available in all locations)
        ext_id:
          $ref: '#/components/schemas/ExtId'
        option_values:
          type: array
          description: Available option values
          items:
            $ref: '#/components/schemas/MenuOptionValue'
    MenuOptionValue:
      type: object
      description: Menu option value with price modifier
      properties:
        uid:
          type: string
          description: Unique option value identifier
        name:
          type: string
          description: Option value name
        short_name:
          type: string
          description: Abbreviated option value name
        price_operator:
          type: string
          enum:
            - +
            - '-'
            - '*'
            - /
          description: |-
            Price modifier operator:
            - `+` = Addition
            - `-` = Subtraction
            - `*` = Multiplication
            - `/` = Division
        price_operand:
          type: number
          description: Price modification amount
        hidden:
          type: boolean
          description: |-
            Visibility status:
            - `false` = Visible
            - `true` = Archived
        position:
          type: integer
          description: Display position (starts at 1)
        checked_default:
          type: boolean
          description: |-
            Default selection state:
            - `false` = Not preselected
            - `true` = Preselected by default
        subrestaurant_uids:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            List of subrestaurant UIDs where this value is available (null =
            available in all locations)
        restrict_to_primary_value_uids:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            UIDs of primary option values for which this value is available:

            - `null` = No restriction (always available)

            - `[]` = Restriction active, but no primary values allowed (never
            available)

            - `["uid1", ...]` = Available only when one of these primary option
            values is selected
        ext_id:
          $ref: '#/components/schemas/ExtId'
  responses:
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                description: >-
                  Standard error format (when using API Key or Client ID/Secret
                  authentication)
                required:
                  - success
                  - error
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for errors
                  error:
                    type: string
                    enum:
                      - RESTAURANT_NOT_FOUND
                      - INVALID_KEY
                      - INVALID_AUTH
                    description: Error code
                  message:
                    type: string
                    description: Human-readable error description
              - type: object
                description: OAuth error format (when using Bearer token authentication)
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - invalid_token
                      - invalid_request
                    description: OAuth error code (RFC 6749)
                  error_description:
                    type: string
                    description: Human-readable error description
          examples:
            standard:
              summary: Standard error format (API Key / Client ID+Secret)
              value:
                success: false
                error: INVALID_KEY
                message: The provided API key is not valid
            oauth:
              summary: OAuth error format (Bearer token)
              value:
                error: invalid_token
                error_description: Access token is invalid or expired
    Forbidden:
      description: Authorization failed - insufficient permissions or access denied.
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                description: >-
                  Standard error format (when using API Key or Client ID/Secret
                  authentication)
                required:
                  - success
                  - error
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for errors
                  error:
                    type: string
                    enum:
                      - API_DISABLED
                      - INSUFFICIENT_SCOPE
                      - UNAUTHORIZED
                    description: Error code
                  message:
                    type: string
                    description: Human-readable error description
              - type: object
                description: OAuth error format (when using Bearer token authentication)
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - insufficient_scope
                      - invalid_request
                    description: OAuth error code (RFC 6749)
                  error_description:
                    type: string
                    description: Human-readable error description
          examples:
            standard:
              summary: Standard error format (API Key / Client ID+Secret)
              value:
                success: false
                error: API_DISABLED
                message: API access is not enabled for the restaurant
            oauth:
              summary: OAuth error format (Bearer token)
              value:
                error: insufficient_scope
                error_description: 'Missing required permissions: write:orders'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Restaurant API Key. Can be obtained from Tools > API Access in the xMenu
        dashboard.
    clientId:
      type: apiKey
      in: header
      name: X-Client-Id
      description: >-
        Client ID for API Client authentication (must be used together with
        Client Secret)
    clientSecret:
      type: apiKey
      in: header
      name: X-Client-Secret
      description: >-
        Client Secret for API Client authentication (must be used together with
        Client ID)
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://app.xmenu.it/oauth/token
          scopes: {}
      description: >-
        OAuth 2.0 authentication using client credentials flow. The access token
        must be included in the Authorization header as a Bearer token.

````