> ## 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 location basic info

> Fetches core storefront data for a location using either its slug or database ID.



## OpenAPI

````yaml https://api.craveup.com/swagger.json get /locations/{locationSlugOrId}
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/{locationSlugOrId}:
    get:
      tags:
        - Locations
      summary: Get location basic info
      description: >-
        Fetches core storefront data for a location using either its slug or
        database ID.
      parameters:
        - name: locationSlugOrId
          in: path
          required: true
          schema:
            type: string
          example: downtown-pizza
          description: >-
            Location slug (e.g. `downtown-pizza`) or the 24-character location
            ID (e.g. `6512c8c1f3d9a5aa9d02e2b1`).
      responses:
        '200':
          description: Location retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontLocationBasicInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/GenericError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    StorefrontLocationBasicInfo:
      type: object
      properties:
        id:
          type: string
          example: loc_456def
        restaurantSlug:
          type: string
          example: downtown-pizza
        restaurantDisplayName:
          type: string
          example: Downtown Pizza Co
        restaurantBio:
          type: string
          example: ''
          description: Marketing copy for the location. Empty string when not configured.
        coverPhoto:
          type: string
          example: ''
          description: >-
            Hero image URL for the location. Empty string when no image is
            stored.
        restaurantLogo:
          type: string
          example: ''
          description: Square logo URL for the location. Empty string when not configured.
        addressData:
          type: object
          properties:
            street:
              type: string
              nullable: true
              example: null
              description: Street line 1. May be null when the address is incomplete.
            streetOptional:
              type: string
              example: ''
              description: Additional address line. Empty string when unused.
            city:
              type: string
              nullable: true
              example: null
              description: City component. May be null or omitted.
            state:
              type: string
              nullable: true
              example: null
              description: State or region. May be null or omitted.
            zipCode:
              type: string
              nullable: true
              example: null
              description: Postal code. May be null or omitted.
            country:
              type: string
              nullable: true
              example: null
              description: Country name. May be null or omitted.
            lat:
              type: number
              nullable: true
              example: null
              description: Latitude of the location. Null when coordinates are not set.
            lng:
              type: number
              nullable: true
              example: null
              description: Longitude of the location. Null when coordinates are not set.
          additionalProperties: false
        addressString:
          type: string
          example: ''
          description: >-
            Human-readable address assembled from the address fields. Empty
            string when not available.
      required:
        - id
        - restaurantSlug
        - restaurantDisplayName
        - addressData
        - addressString
  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

````