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

# List storefronts



## OpenAPI

````yaml /api-reference/openapi.en.json get /storefronts
openapi: 3.1.0
info:
  title: Infi API
  version: 0.0.1
  description: >
    The Infi REST API: catalog, customers, usage metering, subscriptions,

    invoices, payments and checkout.


    **Authentication.** Send your secret key as `Authorization: Bearer
    sk_test_…`

    (sandbox) or `sk_live_…` (production). The key prefix selects the
    environment.

    Checkout routes (`/pay/*`) and `/public/*` take no key: they run in the

    payer's browser.


    **Idempotency.** Every request that changes data requires an

    `Idempotency-Key` header. A retry with the same key returns the original

    response instead of running again.


    **Amounts.** Money and quantities travel as decimal strings (`"150.00"`,

    `"0.0001"`), never as floating-point numbers.


    **Errors.** The body carries `error_code` (stable, branch on it), `message`

    (for humans) and `tracer_id` (send it to support). Rate-limit and
    idempotency

    errors are nested under `error`, with `code` and `request_id`.
servers:
  - url: https://api-sandbox.beinfi.com
    description: Sandbox
  - url: https://api.beinfi.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Catalog
  - name: Customers
  - name: Metering
  - name: Subscriptions
  - name: Invoices
  - name: Payments
  - name: Checkout
  - name: Coupons
  - name: Billing
  - name: Account
  - name: Webhooks
  - name: Test account
  - name: Rail
  - name: Storefronts
paths:
  /storefronts:
    get:
      tags:
        - Storefronts
      summary: List storefronts
      operationId: listStorefronts
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                required:
                  - storefronts
                properties:
                  storefronts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Storefront'
          description: Your account's storefronts.
components:
  schemas:
    Storefront:
      type: object
      required:
        - id
        - slug
        - name
        - theme
        - status
        - fulfillmentMode
        - requireAddress
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
          description: The shop's public address.
        name:
          type: string
        description:
          type: string
          nullable: true
        logoUrl:
          type: string
          nullable: true
          description: Logo image address. `logoObjectKey` carries the matching key.
        logoObjectKey:
          type: string
          nullable: true
          description: Logo image key, from `POST /catalog/images/presign`.
        bannerUrl:
          type: string
          nullable: true
          description: Banner image address.
        bannerObjectKey:
          type: string
          nullable: true
          description: Banner image key, from `POST /catalog/images/presign`.
        theme:
          $ref: '#/components/schemas/StorefrontTheme'
        status:
          type: string
          enum:
            - active
            - disabled
          description: '`active` (live) or `disabled` (offline).'
        fulfillmentMode:
          type: string
          enum:
            - pickup
            - shipping
            - both
          description: 'How the buyer receives: `pickup`, `shipping` or `both`.'
        pickupNote:
          type: string
          nullable: true
          description: Pickup instructions shown to the buyer.
        shippingFlatAmount:
          type: string
          nullable: true
          description: >-
            Flat shipping, as a decimal string. `"0"` is free; `null` means
            arranged separately.
        requireAddress:
          type: boolean
          description: Whether an address is collected even for pickup.
        createdAt:
          type: string
          format: date-time
      description: A storefront in your account.
    StorefrontTheme:
      type: object
      properties:
        accent:
          type: string
          enum:
            - purple
            - teal
            - amber
            - rose
            - blue
            - green
            - brown
            - slate
          description: Accent colour.
        mode:
          type: string
          enum:
            - light
            - dark
          description: Light (`light`) or dark (`dark`) theme.
        layout:
          type: string
          enum:
            - grid
            - list
          description: Products as a grid (`grid`) or a list (`list`).
        whatsapp:
          type: string
          description: Contact WhatsApp shown on the shop.
        instagram:
          type: string
          description: Instagram shown on the shop.
      description: The shop's look, chosen from a fixed set of options.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your account's secret key: `Authorization: Bearer sk_test_…` or
        `sk_live_…`. Server-side only.

````