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

# Get store profile

> Returns the public profile of the store associated with the API key.  Use this to populate storefront headers, footers, and checkout pages with the store's name, logo, currency, and tax/delivery configuration.



## OpenAPI

````yaml /LeyyowPublicAPI(v2).yaml get /store
openapi: 3.0.3
info:
  title: Leyyow Public API
  version: 1.0.0 (v2)
  description: >-
    The Leyyow Public API lets you build custom storefronts on top of any Leyyow
    merchant store.


    ## Authentication


    Every request must carry a merchant API key as a Bearer token:


    ```

    Authorization: Bearer lyw_<your-secret-key>

    ```


    Keys are scoped to a single store.  All responses contain only data that
    belongs to the store that issued the key.


    ## Rate limits


    | Throttle group | Limit |

    |---|---|

    | Catalogue endpoints (per key) | 1 000 / hour |

    | Catalogue endpoints (per IP) | 200 / hour |

    | Order creation (per key) | 50 / hour |

    | Shipping quotes (per key) | 100 / hour |


    When a limit is exceeded the API returns HTTP 429 with a `Retry-After`
    header indicating how many seconds to wait.


    ## Store scoping


    The `X-Store-Id` header is ignored.  Store identity is derived entirely from
    the API key — there is no way to access a different store's data using the
    same key.
servers:
  - url: /api/public/v1
    description: Leyyow Public API v1
security: []
paths:
  /store:
    get:
      tags:
        - Store
      summary: Get store profile
      description: >-
        Returns the public profile of the store associated with the API key. 
        Use this to populate storefront headers, footers, and checkout pages
        with the store's name, logo, currency, and tax/delivery configuration.
      operationId: store_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicStore'
              examples:
                StoreProfile:
                  value:
                    uid: 018e1234-0000-7000-a000-000000000001
                    name: Remi's Boutique
                    slug: remis-boutique
                    logo: https://cdn.leyyow.com/stores/remis-boutique/logo.png
                    address: 14 Marina Street, Lagos Island, Lagos
                    country: NG
                    currency: NGN
                    support_email: hello@remisboutique.com
                    support_phone: '+2348012345678'
                    delivery_enabled: true
                    manual_delivery_enabled: true
                    express_delivery_enabled: false
                    tax_collection_enabled: true
                    tax_rate: '7.50'
                    add_tax_to_product_price: false
                    checkout_return_url: https://remisboutique.com/checkout/thank-you
                  summary: Store profile
          description: Store profile.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_Error'
              examples:
                InvalidKey:
                  value:
                    detail: Invalid or revoked API key.
                    error_code: AUTHENTICATION_FAILED
                  summary: Invalid key
          description: Authentication failed — key missing, invalid, or revoked.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_Error'
              examples:
                RateLimited:
                  value:
                    detail: Rate limit exceeded. Please retry in 120 seconds.
                    error_code: ENDPOINT_THROTTLED
                  summary: Rate limited
          description: >-
            Rate limit exceeded.  Retry after the number of seconds indicated in
            the `Retry-After` response header.


            | Throttle group | Limit |

            |---|---|

            | Catalogue endpoints — per API key | 1 000 / hour |

            | Catalogue endpoints — per IP address | 200 / hour |

            | Order creation — per API key | 50 / hour |

            | Shipping quotes — per API key | 100 / hour |
      security:
        - MerchantAPIKey: []
components:
  schemas:
    PublicStore:
      type: object
      properties:
        uid:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          readOnly: true
        slug:
          type: string
          readOnly: true
        logo:
          type: string
          format: uri
          readOnly: true
          nullable: true
        address:
          type: string
          readOnly: true
          nullable: true
        country:
          type: string
          readOnly: true
          nullable: true
        currency:
          type: string
          readOnly: true
          nullable: true
        support_email:
          type: string
          format: email
          readOnly: true
          nullable: true
        support_phone:
          type: string
          readOnly: true
          nullable: true
        delivery_enabled:
          type: boolean
          readOnly: true
          description: Enable courier/delivery services for this store
        manual_delivery_enabled:
          type: boolean
          readOnly: true
          description: Enable manual delivery options for this store
        express_delivery_enabled:
          type: boolean
          readOnly: true
          description: Enable express delivery options for this store
        tax_collection_enabled:
          type: boolean
          readOnly: true
          description: Enable VAT collection for orders placed in this store
        tax_rate:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,4})?$
          readOnly: true
          description: >-
            Tax rate applied when tax collection is enabled (e.g. 0.075 for
            7.5%)
        add_tax_to_product_price:
          type: boolean
          readOnly: true
          description: >-
            If enabled, tax is included in product prices. If disabled, tax is
            added at checkout.
        checkout_return_url:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: >-
            HTTPS URL customers are redirected to after Paystack checkout
            (public API).
      required:
        - add_tax_to_product_price
        - address
        - checkout_return_url
        - country
        - currency
        - delivery_enabled
        - express_delivery_enabled
        - logo
        - manual_delivery_enabled
        - name
        - slug
        - support_email
        - support_phone
        - tax_collection_enabled
        - tax_rate
        - uid
    _Error:
      type: object
      properties:
        detail:
          type: string
        error_code:
          type: string
      required:
        - detail
  securitySchemes:
    MerchantAPIKey:
      type: http
      scheme: bearer
      bearerFormat: lyw_<secret>
      description: >-
        Authenticate using a Leyyow merchant API key.


        Include the key in every request as a Bearer token:


        ```

        Authorization: Bearer lyw_<your-secret-key>

        ```


        Keys are scoped to a single store. All endpoints return data belonging
        to the store that issued the key — there is no `X-Store-Id` override.


        Keys are created in the Leyyow merchant dashboard under **Settings →
        Developer → API Keys**.

````