> ## Documentation Index
> Fetch the complete documentation index at: https://docs.craveup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a product with modifier tree

> Fetches product details and its modifier configuration for building a product detail page.



## OpenAPI

````yaml https://api.craveup.com/swagger.json get /locations/{locationId}/products/{productId}
openapi: 3.0.0
info:
  title: Crave API v2.0
  version: 2.0.0
  description: >

    ## 🔑 Generate an API Key

    Every request to the Storefront API must include an API key.


    1. Sign in to the [Crave Business Manager](https://partners.craveup.com).

    2. Open **Settings → Developer → API Keys**.

    3. Click **Generate Key**, give it a descriptive name (for example,
    `storefront-sdk-staging`), and confirm.

    4. Copy the key immediately—once you leave the page it cannot be viewed
    again.


    Add the key to each request header:


    ```http

    GET /merchant/crave-collective

    Host: api.craveup.com

    X-API-Key: <your-api-key>

    ```


    ### Best practices

    - Store keys in environment variables or a secrets manager; never commit
    them to source control.

    - Use separate keys for staging and production so they can be rotated
    independently.

    - If a key is exposed, revoke it from the dashboard and generate a fresh one
    right away.
  contact:
    name: Crave Support
    email: support@craveup.com
servers:
  - url: https://api.craveup.com/api/v1
    description: Production Storefront API
  - url: https://dev-api-43233223.craveup.com/api/v1
    description: Staging Storefront API
security:
  - ApiKeyAuth: []
tags:
  - name: Merchants
    description: Retrieve merchant metadata and enabled storefront locations.
  - name: Locations
    description: Access individual location information and configuration.
  - name: Ordering Sessions
    description: Create or resume ordering sessions and carts for a location.
  - name: Menus
    description: Fetch menu bundles, categories, and popular products for a location.
  - name: Products
    description: Request detailed storefront product data including modifiers.
  - name: Carts
    description: Manage cart state, totals, and cross-sell recommendations.
  - name: Customers
    description: Handle storefront customer authentication, profiles, and sessions.
paths:
  /locations/{locationId}/products/{productId}:
    get:
      tags:
        - Products
      summary: Get a product with modifier tree
      description: >-
        Fetches product details and its modifier configuration for building a
        product detail page.
      parameters:
        - name: locationId
          in: path
          required: true
          schema:
            type: string
          example: loc_456def
        - name: productId
          in: path
          required: true
          schema:
            type: string
          example: prod_margherita
      responses:
        '200':
          description: Product retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: prod_bbq_chicken
                  name:
                    type: string
                    example: BBQ Chicken Pizza
                  description:
                    type: string
                    nullable: true
                  availability:
                    type: string
                    example: AVAILABLE
                  images:
                    type: array
                    items:
                      type: string
                  price:
                    type: string
                    example: '21.00'
                  displayPrice:
                    type: string
                    example: $21.00
                  currency:
                    type: string
                    example: usd
                  locationId:
                    type: string
                    example: loc_456def
                  modifierIds:
                    type: array
                    items:
                      type: string
                  modifiers:
                    type: array
                    items:
                      $ref: '#/components/schemas/StorefrontModifierGroup'
                required:
                  - id
                  - name
                  - price
                  - displayPrice
                  - currency
                  - availability
                  - locationId
              examples:
                default:
                  summary: Storefront product with modifiers
                  value:
                    id: prod_margherita
                    name: Margherita Pizza
                    description: Tomato, basil, mozzarella.
                    availability: AVAILABLE
                    images:
                      - https://cdn.craveup.com/products/margherita.png
                    price: '1800'
                    displayPrice: $18.00
                    currency: usd
                    locationId: loc_456def
                    modifierIds:
                      - mod_group_sauces
                    modifiers:
                      - id: mod_group_sauces
                        name: Sauce Selection
                        description: null
                        rule:
                          min: 0
                          max: 2
                        items:
                          - id: mod_item_bbq
                            name: BBQ Sauce
                            price: '0.50'
                            maxQuantity: 2
                            childGroups: []
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/GenericError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    StorefrontModifierGroup:
      type: object
      properties:
        id:
          type: string
          example: mod_group_sauces
        name:
          type: string
          example: Sauce Selection
        description:
          type: string
          nullable: true
        imageUrl:
          type: string
          nullable: true
        rule:
          type: object
          properties:
            min:
              type: integer
              example: 0
            max:
              type: integer
              example: 2
        items:
          type: array
          items:
            $ref: '#/components/schemas/StorefrontModifierItem'
      required:
        - id
        - name
        - rule
        - items
    StorefrontModifierItem:
      type: object
      properties:
        id:
          type: string
          example: mod_item_bbq
        name:
          type: string
          example: BBQ Sauce
        price:
          type: string
          example: '0.50'
        maxQuantity:
          type: integer
          example: 2
        childGroups:
          type: array
          items:
            $ref: '#/components/schemas/StorefrontModifierChildLink'
      required:
        - id
        - name
        - price
        - maxQuantity
        - childGroups
    StorefrontModifierChildLink:
      type: object
      properties:
        groupId:
          type: string
          example: mod_group_extras
        applyPerParentQuantity:
          type: boolean
          nullable: true
          example: false
        overrides:
          type: object
          nullable: true
          properties:
            min:
              type: integer
              nullable: true
              example: 1
            max:
              type: integer
              nullable: true
              example: 3
        circular:
          type: boolean
          nullable: true
          example: false
        group:
          allOf:
            - $ref: '#/components/schemas/StorefrontModifierGroup'
          nullable: true
  responses:
    Unauthorized:
      description: Unauthorized - API key is missing or invalid.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Unauthorized access
              code:
                type: string
                example: UNAUTHORIZED
    NotFound:
      description: Not Found - The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Requested resource not found
              code:
                type: string
                example: NOT_FOUND
    GenericError:
      description: Generic Error - An unexpected error occurred.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: An unexpected error occurred
              code:
                type: string
                example: GENERIC_ERROR
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key required to authenticate requests

````