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

# List Checkout Fields

> Lista os campos personalizados que a loja pede uma vez por pedido, como nickname ou ID no jogo.
<Note>Os valores coletados vão no objeto `fields` de `POST /webstore/checkout`, usando o `name` de cada campo como chave. Campos personalizados **por produto** não vêm aqui. Eles chegam no array `fields` de cada item em `GET /webstore/package` e vão no `options` do respectivo item do carrinho.</Note>



## OpenAPI

````yaml /openapi/storefront-store.yaml get /webstore/checkout_fields
openapi: 3.1.0
info:
  title: CentralCart Storefront API (Loja)
  version: 1.0.0
  description: >-
    Dados públicos de identidade e configuração da loja. Nenhum destes endpoints
    exige autenticação. A loja é resolvida pelo header `x-store-domain`.
servers:
  - url: https://api.centralcart.io/v1
    description: Produção
security: []
paths:
  /webstore/checkout_fields:
    get:
      tags:
        - Loja
      summary: List Checkout Fields
      description: >-
        Lista os campos personalizados que a loja pede uma vez por pedido, como
        nickname ou ID no jogo.

        <Note>Os valores coletados vão no objeto `fields` de `POST
        /webstore/checkout`, usando o `name` de cada campo como chave. Campos
        personalizados **por produto** não vêm aqui. Eles chegam no array
        `fields` de cada item em `GET /webstore/package` e vão no `options` do
        respectivo item do carrinho.</Note>
      operationId: listWebstoreCheckoutFields
      parameters:
        - $ref: '#/components/parameters/StoreDomain'
      responses:
        '200':
          description: Campos de checkout da loja
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: number
                    store_id:
                      type: number
                    name:
                      type: string
                      description: >-
                        Chave do campo. Use como chave dentro de `fields` no
                        checkout.
                    display:
                      type: string
                      description: Rótulo já capitalizado, pronto para exibição.
                    bracket_display:
                      type: string
                      description: >-
                        Forma do campo entre chaves, como aparece nos comandos e
                        templates (ex: `{nickname}`).
                    description:
                      type: string
                      description: Texto de ajuda exibido abaixo do campo.
                    type:
                      type: string
                      description: Tipo do campo. `SELECT` traz as opções em `options`.
                      enum:
                        - TEXT
                        - NUMBER
                        - SELECT
                        - ROBLOX
                    required:
                      type: boolean
                    regex:
                      type: string
                      nullable: true
                      description: Expressão regular de validação, quando definida.
                    applies_to:
                      type: array
                      description: >-
                        IDs dos produtos aos quais o campo se aplica. Vazio
                        significa todos.
                      items:
                        type: number
                    created_at:
                      type: string
                    updated_at:
                      type: string
              example:
                - id: 1
                  store_id: 1
                  name: nickname
                  display: Nickname
                  bracket_display: '{nickname}'
                  description: Seu nickname no servidor
                  type: TEXT
                  required: true
                  regex: null
                  applies_to: []
                  created_at: '2024-03-03T23:43:12.000-03:00'
                  updated_at: '2024-03-03T23:43:12.000-03:00'
        '404':
          $ref: '#/components/responses/StoreNotFound'
      security: []
components:
  parameters:
    StoreDomain:
      name: x-store-domain
      in: header
      required: true
      description: 'Domínio da sua loja (ex: sualoja.centralcart.ai)'
      schema:
        type: string
  responses:
    StoreNotFound:
      description: Loja não encontrada para o `x-store-domain` informado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            errors:
              - message: Store not found.
  schemas:
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              ref:
                type: string

````