> ## 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.

# Ler loja



## OpenAPI

````yaml /api-reference/openapi.pt-BR.json get /storefronts/{storefrontID}
openapi: 3.1.0
info:
  title: Infi API
  version: 0.0.1
  description: >
    A API REST do Infi: catálogo, clientes, medição de uso, assinaturas,
    faturas,

    pagamentos e checkout.


    **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…`

    (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente.
    As

    rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no
    navegador

    de quem paga.


    **Idempotência.** Toda requisição que altera dados exige o header

    `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta
    original

    em vez de executar de novo.


    **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`,

    `"0.0001"`), nunca como número de ponto flutuante.


    **Erros.** O corpo traz `error_code` (estável, use para decidir), `message`

    (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de
    requisições

    e de idempotência vêm aninhados em `error`, com `code` e `request_id`.
servers:
  - url: https://api-sandbox.beinfi.com
    description: Sandbox
  - url: https://api.beinfi.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Catálogo
  - name: Clientes
  - name: Medição de uso
  - name: Assinaturas
  - name: Faturas
  - name: Pagamentos
  - name: Checkout
  - name: Cupons
  - name: Cobrança
  - name: Conta
  - name: Webhooks
  - name: Conta de teste
  - name: Rail
  - name: Lojas
paths:
  /storefronts/{storefrontID}:
    parameters:
      - name: storefrontID
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Lojas
      summary: Ler loja
      operationId: getStorefront
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Storefront'
          description: A loja.
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Storefront:
      type: object
      required:
        - id
        - slug
        - name
        - theme
        - status
        - fulfillmentMode
        - requireAddress
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
          description: O endereço público da loja.
        name:
          type: string
        description:
          type: string
          nullable: true
        logoUrl:
          type: string
          nullable: true
          description: >-
            Endereço da imagem do logo. `logoObjectKey` traz a chave
            correspondente.
        logoObjectKey:
          type: string
          nullable: true
          description: Chave da imagem do logo, de `POST /catalog/images/presign`.
        bannerUrl:
          type: string
          nullable: true
          description: Endereço da imagem do banner.
        bannerObjectKey:
          type: string
          nullable: true
          description: Chave da imagem do banner, de `POST /catalog/images/presign`.
        theme:
          $ref: '#/components/schemas/StorefrontTheme'
        status:
          type: string
          enum:
            - active
            - disabled
          description: '`active` (no ar) ou `disabled` (fora do ar).'
        fulfillmentMode:
          type: string
          enum:
            - pickup
            - shipping
            - both
          description: >-
            Como o comprador recebe: `pickup` (retirada), `shipping` (envio) ou
            `both`.
        pickupNote:
          type: string
          nullable: true
          description: Instruções de retirada mostradas ao comprador.
        shippingFlatAmount:
          type: string
          nullable: true
          description: >-
            Frete fixo, em texto decimal. `"0"` é grátis; `null` é combinado por
            fora.
        requireAddress:
          type: boolean
          description: Se o endereço é pedido mesmo na retirada.
        createdAt:
          type: string
          format: date-time
      description: Uma loja da sua conta.
    StorefrontTheme:
      type: object
      properties:
        accent:
          type: string
          enum:
            - purple
            - teal
            - amber
            - rose
            - blue
            - green
            - brown
            - slate
          description: Cor de destaque.
        mode:
          type: string
          enum:
            - light
            - dark
          description: Tema claro (`light`) ou escuro (`dark`).
        layout:
          type: string
          enum:
            - grid
            - list
          description: Produtos em grade (`grid`) ou em lista (`list`).
        whatsapp:
          type: string
          description: WhatsApp de contato exibido na loja.
        instagram:
          type: string
          description: Instagram exibido na loja.
      description: A aparência da loja, escolhida entre opções fixas.
    NotFoundError:
      type: object
      required:
        - message
        - error_code
        - tracer_id
        - resource
      properties:
        message:
          type: string
        error_code:
          $ref: '#/components/schemas/ErrorCode'
        tracer_id:
          type: string
        resource:
          type: string
    ErrorCode:
      type: string
      examples:
        - internal_error
        - validation_failed
        - bad_request
        - unauthorized
        - forbidden
        - not_found
        - conflict
        - rate_limited
      description: >-
        Código estável do erro. A lista não é fechada: além dos códigos
        genéricos, cada área tem os seus (`coupon_expired`,
        `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…).
        Um código que você não conhece deve ser tratado pelo status HTTP,
        mostrando `message`; não falhe ao ler a resposta.
  responses:
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
      description: Recurso não encontrado.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave secreta da conta: `Authorization: Bearer sk_test_…` ou
        `sk_live_…`. Use só no servidor.

````