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

# Storefront settings

> Retrieve the storefront settings payload used to configure the web components and checkout, including the store name, logo, available markets and the market resolved for the current request.



## OpenAPI

````yaml /api-reference/openapi.json get /settings
openapi: 3.0.0
info:
  title: Marzipan API
  version: 1.0.0
servers:
  - url: https://api.marzipan.co/v1
security:
  - tenantAuth: []
tags:
  - name: Account
    description: >-
      Account management endpoints including registration, login, and user
      details
  - name: Carts
    description: Shopping cart management endpoints
  - name: Products
    description: Product catalog and search endpoints
  - name: Subscriptions
    description: Subscription management and renewal endpoints
  - name: CMS
    description: Content management system endpoints
  - name: Messaging
    description: Message and communication endpoints
  - name: Search
    description: Search functionality endpoints
  - name: Settings
    description: >-
      Storefront settings and market detection used to configure the web
      components and checkout.
  - name: Analytics
    description: Storefront visit and attribution tracking.
  - name: Rewards
    description: >-
      Loyalty and rewards programme endpoints for the authenticated customer,
      covering points balance, tier status, perks, exclusive products and
      transaction history.
  - name: Forms
    description: Render and submit dynamic storefront forms defined in the CMS.
  - name: Events
    description: >-
      Check event availability, browse occurrences and recurring dates, generate
      ticket QR codes, and manage event waitlists (join, leave, check status,
      and claim promoted spots).
paths:
  /settings:
    get:
      tags:
        - Settings
      summary: Storefront settings
      description: >-
        Retrieve the storefront settings payload used to configure the web
        components and checkout, including the store name, logo, available
        markets and the market resolved for the current request.
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontSettings'
              example:
                name: Marzipan Bakery
                storeUrl: https://shop.marzipan.co
                logo: https://cdn.marzipan.co/media/logo.png
                defaultCurrency: GBP
                markets:
                  - id: 9b1c2d3e-4f5a-6b7c-8d9e-0a1b2c3d4e5f
                    name: United Kingdom
                    currencyCode: GBP
                    currencySymbol: £
                    isPrimary: true
                  - id: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
                    name: Eurozone
                    currencyCode: EUR
                    currencySymbol: €
                    isPrimary: false
                currentMarket:
                  id: 9b1c2d3e-4f5a-6b7c-8d9e-0a1b2c3d4e5f
                  name: United Kingdom
                  currencyCode: GBP
                  currencySymbol: £
                  isPrimary: true
components:
  schemas:
    StorefrontSettings:
      type: object
      description: >-
        Storefront configuration payload used to initialise web components and
        checkout.
      properties:
        name:
          type: string
          description: The store / tenant name.
        storeUrl:
          type: string
        logo:
          type: string
          nullable: true
          description: Absolute URL to the store logo, or null if none is set.
        defaultCurrency:
          type: string
        markets:
          type: array
          description: Active markets that allow currency switching, primary first.
          items:
            $ref: '#/components/schemas/Market'
        currentMarket:
          allOf:
            - $ref: '#/components/schemas/Market'
          nullable: true
          description: >-
            The market resolved for the current request via geo-detection.
            Omitted when no market could be resolved.
    Market:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        currencyCode:
          type: string
        currencySymbol:
          type: string
        isPrimary:
          type: boolean
  securitySchemes:
    tenantAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your API token.
      bearerFormat: JWT

````