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

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Listar customizações

> Obtém uma lista de todas as customizações disponíveis



## OpenAPI

````yaml get /{alias}/catalog/customizations
openapi: 3.0.0
info:
  title: Yampi API
  description: Documentação oficial da API da Yampi
  version: '2.0'
servers:
  - url: https://api.dooki.com.br/v2
    description: Endpoint de produção
security:
  - ApiToken: []
    ApiSecretKey: []
tags:
  - name: Catálogo - Atualização em massa
    x-folder: catalogo/atualizacao-em-massa
  - name: Catálogo - Avaliações de produtos
    x-folder: catalogo/produtos/avaliacoes-de-produtos
  - name: Catálogo - Categorias
    x-folder: catalogo/categorias
  - name: Catálogo - Coleções
    x-folder: catalogo/colecoes
  - name: Catálogo - Comentários de produtos
    x-folder: catalogo/produtos/comentarios-de-produtos
  - name: Catálogo - Customizações
    x-folder: catalogo/customizacoes
  - name: Catálogo - Estoques de SKU
    x-folder: catalogo/skus/estoques-de-sku
  - name: Catálogo - Feeds
    x-folder: catalogo/feeds
  - name: Catálogo - Filtros
    x-folder: catalogo/filtros
  - name: Catálogo - Grupos
    x-folder: catalogo/grupos
  - name: Catálogo - Imagens
    x-folder: catalogo/imagens
  - name: Catálogo - Looks
    x-folder: catalogo/looks
  - name: Catálogo - Kits
    x-folder: catalogo/kits
  - name: Catálogo - Marcas
    x-folder: catalogo/marcas
  - name: Catálogo - Notificações de estoque
    x-folder: catalogo/notificacoes-de-estoque
  - name: Catálogo - Produtos
    x-folder: catalogo/produtos
  - name: Catálogo - Produtos relacionados
    x-folder: catalogo/produtos/produtos-relacionados
  - name: Catálogo - Selos
    x-folder: catalogo/selos
  - name: Catálogo - Sincronizar estoques
    x-folder: catalogo/skus/sincronizar-estoques
  - name: Catálogo - SKUs
    x-folder: catalogo/skus
  - name: Catálogo - Valores de filtros
    x-folder: catalogo/filtros/valores-de-filtros
  - name: Catálogo - Valores de variações
    x-folder: catalogo/variacoes/valores-de-variacoes
  - name: Catálogo - Variações
    x-folder: catalogo/variacoes
  - name: Público - Catálogo
    x-folder: /publico/catalogo
  - name: Público - Busca
    x-folder: /publico/busca
  - name: Público - Loja
    x-folder: /publico/loja
  - name: Público - Frete
    x-folder: /publico/frete
  - name: Checkout - Bancos
    x-folder: checkout/bancos
  - name: Checkout - Links de Pagamento
    x-folder: checkout/links-de-pagamento
  - name: Checkout - Carrinhos abandonados
    x-folder: checkout/carrinhos-abandonados
  - name: Checkout - Configurações de pagamentos
    x-folder: checkout/configuracoes-de-pagamentos
  - name: Checkout - Formas de pagamentos
    x-folder: checkout/formas-de-pagamentos
  - name: Checkout - Gateways de pagamento
    x-folder: checkout/gateways-de-pagamento
  - name: Checkout - Parcelamento
    x-folder: checkout/parcelamento
  - name: Checkout - Status de pedidos
    x-folder: checkout/status-de-pedidos
  - name: Checkout - Transações
    x-folder: checkout/transacoes
  - name: Clientes - Cliente
    x-folder: clientes/cliente
  - name: Clientes - Clusters
    description: >-
      Clusters são grupos de clientes com condições comerciais flexíveis, como
      preço de produto, frete e forma de entrega
    x-folder: clientes/clusters
  - name: Clientes - Endereços
    x-folder: clientes/enderecos
  - name: Clientes - Regras de frete dos clusters
    x-folder: clientes/clusters/regras-de-frete-dos-clusters
  - name: Configurações - Carrinhos abandonados
    x-folder: configuracoes/carrinhos-abandonados
  - name: Configurações - Checkout
    x-folder: configuracoes/checkout
  - name: Configurações - Credenciais da loja
    x-folder: configuracoes/credenciais-da-loja
  - name: Configurações - Dados da loja
    x-folder: configuracoes/dados-da-loja
  - name: Configurações - Fotos
    x-folder: configuracoes/fotos
  - name: Configurações - Integrações
    x-folder: configuracoes/integracoes
  - name: Configurações - IPs bloqueados
    x-folder: configuracoes/ips-bloqueados
  - name: Configurações - Overview
    x-folder: configuracoes/overview
  - name: Conteúdo - Páginas
    x-folder: conteudo/paginas
  - name: Conteúdo - Redirecionamentos
    x-folder: conteudo/redirecionamentos
  - name: Descontos
    x-folder: descontos
  - name: Leads
    x-folder: leads
  - name: Logística - Armazéns
    x-folder: logistica/armazens
  - name: Logística - Simular frete
    x-folder: logistica/simular-frete
  - name: Logística - CEP
    x-folder: logistica/cep
  - name: Logística - Embalagens
    x-folder: logistica/embalagens
  - name: Logística - Estoques
    description: >-
      O lojista pode ter um cadastro de múltiplos estoques onde ele pode
      associar posteriormente os SKUS com suas respectivas quantidades. Um
      exemplo prático é permitir que ele consiga trabalhar com estoques de
      fornecedores externos com diferentes prazos de entrega.
    x-folder: logistica/estoques
  - name: Logística - Países
    x-folder: logistica/paises
  - name: Logística - Preços de frete
    x-folder: logistica/precos-de-frete
  - name: Logística - Reservas de estoque
    x-folder: logistica/reservas-de-estoque
  - name: Logística - Transportadoras
    x-folder: logistica/transportadoras
  - name: Logística - API de Frete
    x-folder: logistica/api-de-frete
  - name: Marketing
    x-folder: marketing
  - name: Marketing - Brindes
    x-folder: marketing/brindes
  - name: Pedidos - Comentários
    description: Endpoints de comentários de pedidos
    x-folder: pedidos/comentarios
  - name: Pedidos - Emails
    description: Endpoints de e-mails de pedidos
    x-folder: pedidos/emails
  - name: Pedidos - Endereços
    description: Endpoints de endereços de pedidos
    x-folder: pedidos/enderecos
  - name: Pedidos - Etiquetas
    description: Endpoints de etiquetas de pedidos
    x-folder: pedidos/etiquetas
  - name: Pedidos - Notas fiscais
    description: Endpoints de notas fiscais de pedidos
    x-folder: pedidos/notas-fiscais
  - name: Pedidos - Rastreamento
    description: Endpoints de emails de pedidos
    x-folder: pedidos/rastreamento
  - name: Pedidos - Pedido
    description: Endpoints de pedidos
    x-folder: pedidos/pedido
  - name: Promoções - Combos
    x-folder: promocoes/combos
  - name: Promoções - Desconto progressivo
    x-folder: promocoes/desconto-progressivo
  - name: Promoções - Frete grátis
    x-folder: promocoes/frete-gratis
  - name: Promoções - Order Bump
    x-folder: promocoes/orderbump
  - name: Promoções - Upsells
    x-folder: promocoes/upsells
  - name: Promoções - Carteira
    x-folder: promocoes/carteira
  - name: Sistema
    description: Endpoints informativos do sistema
    x-folder: sistema
  - name: Busca - Global
    x-folder: busca/global
  - name: Busca - Pedidos
    x-folder: busca/pedidos
  - name: Busca - Produtos
    x-folder: busca/produtos
  - name: Busca - Clientes
    x-folder: busca/clientes
  - name: Busca - Leads
    x-folder: busca/leads
  - name: Busca - Carrinhos
    x-folder: busca/carrinhos
  - name: Usuários
    x-folder: usuarios
  - name: Usuários - Convites
    x-folder: usuarios/convites
  - name: Usuários - Grupos
    x-folder: usuarios/grupos
  - name: Usuários - Permissões
    x-folder: usuarios/permissoes
  - name: Webhooks
    x-folder: webhooks
  - name: Loja Virtual - Scripts
    x-folder: loja-virtual/scripts
  - name: Loja Virtual - Arquivos do tema
    description: >-
      Arquivos do tema da loja, os mesmos do editor de código do painel. As
      edições ficam no tema em preview até a publicação. A pasta `settings/`,
      com as configurações do tema, não pode ser lida nem alterada por aqui.
      Exige loja com acesso ao editor de código e a permissão
      `manage_open_code`. Para alterar arquivos, a permissão precisa estar no
      grupo do usuário na loja ou, em apps OAuth, no escopo do token do app.
      Usuários internos sem grupo na loja só leem. Limite de 60 requisições por
      minuto por usuário.
    x-folder: loja-virtual/arquivos-do-tema
  - name: Modulo - Recurso
    description: Modulo - Recurso
  - name: Marketplaces - Atributos
    description: Marketplaces - Atributos
  - name: Marketplaces - Anúncios
    description: Marketplaces - Anúncios
  - name: Links de Pagamento
    description: Links de Pagamento
  - name: Checkout - Contas bancárias
    description: Checkout - Contas bancárias
  - name: Checkout - Vendedores
    description: Checkout - Vendedores
  - name: Configurações - E-mails
    description: Configurações - E-mails
  - name: Configurações - Loja
    description: Configurações - Loja
  - name: Marketplaces - Categorias
    description: Marketplaces - Categorias
  - name: Marketplaces - Contas
    description: Marketplaces - Contas
  - name: Marketplaces - Lista de erros
    description: Marketplaces - Lista de erros
  - name: Marketplaces
    description: Marketplaces
  - name: Métricas - Cashback
    description: Métricas - Cashback
  - name: Promoções - Cashbacks
    description: Promoções - Cashbacks
  - name: Promoções - Cashback
    description: Promoções - Cashback
  - name: Promoções - Cupons de desconto
    description: Promoções - Cupons de desconto
  - name: Promoções - Produtos
    description: Promoções - Produtos
  - name: Filas
    description: Filas
paths:
  /{alias}/catalog/customizations:
    get:
      tags:
        - Catálogo - Customizações
      summary: Listar customizações
      description: Obtém uma lista de todas as customizações disponíveis
      operationId: GetCatalogCustomizations
      parameters:
        - name: alias
          in: path
          description: Alias da loja
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Lista de customizações
          content:
            application/json:
              schema:
                allOf:
                  - properties:
                      data:
                        description: Lista de customizações da loja.
                        type: array
                        items:
                          allOf:
                            - $ref: '#/components/schemas/Customization'
                            - $ref: >-
                                #/components/schemas/CustomizationAdditionalResponse
                    type: object
                  - $ref: '#/components/schemas/SimplePaginatorWithMeta'
        '404':
          description: Nenhuma customização encontrada
components:
  schemas:
    Customization:
      title: Customização de um SKU
      description: Campo de personalização preenchido pelo cliente na compra de um produto.
      properties:
        id:
          description: ID do produto customizado
          type: integer
        name:
          description: Nome do campo de customização, exibido ao cliente.
          type: string
          example: Primeira Letra
        price:
          description: Preço do produto customizado
          type: number
        description:
          description: Texto de ajuda exibido junto ao campo de customização.
          type: string
          example: Descrição
        type:
          description: 'Tipo do campo de customização (ex.: `select` para lista de valores).'
          type: string
          example: select
        required:
          description: Indica se é obrigatório ou não
          type: boolean
          example: true
        allowed_values:
          description: Valores permitidos para o campo
          type: string
        max_chars:
          description: >-
            Há uma limitação de caracteres na customização. Exemplo: o número da
            camisa deve ter apenas 2 caracteres.
          type: integer
          example: 1
        products_ids:
          description: IDs dos produtos que possuem essa customização
          type: array
          items:
            type: integer
        values:
          description: >-
            Valores cadastrados para o cliente escolher, usados nos campos de
            seleção.
          type: array
          items:
            type: string
          example: '[''A'', ''B'', ''C'', ''D'']'
      type: object
    CustomizationAdditionalResponse:
      description: >-
        Recursos adicionais da customização, retornados sob demanda via
        parâmetro `include`.
      properties:
        total_products:
          description: Quantidade de produtos que usam esta customização.
          type: integer
        created_at:
          $ref: '#/components/schemas/BaseTimestamp'
        updated_at:
          $ref: '#/components/schemas/BaseTimestamp'
      type: object
    SimplePaginatorWithMeta:
      title: SimplePaginatorWithMeta
      description: Representa uma paginação com meta
      properties:
        meta:
          description: Metadados da resposta.
          properties:
            pagination:
              description: Dados de paginação do resultado.
              properties:
                total:
                  description: >-
                    Quantidade total de registros encontrados, considerando
                    todas as páginas.
                  type: integer
                  example: '10'
                count:
                  description: Quantidade de registros retornados na página atual.
                  type: integer
                  example: '30'
                per_page:
                  description: Quantidade máxima de registros por página.
                  type: integer
                  example: '10'
                current_page:
                  description: Número da página atual.
                  type: integer
                  example: '1'
                total_pages:
                  description: Quantidade total de páginas do resultado.
                  type: integer
                  example: '3'
                links:
                  description: Links de navegação entre as páginas do resultado.
                  properties:
                    previous:
                      description: >-
                        URL da página anterior, ausente quando a página atual é
                        a primeira.
                      type: string
                      example: ''
                    next:
                      description: >-
                        URL da próxima página, ausente quando a página atual é a
                        última.
                      type: string
                      example: ''
                  type: object
              type: object
          type: object
      type: object
    BaseTimestamp:
      description: >-
        Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário
        em que foi registrada.
      properties:
        date:
          description: Data e hora no formato YYYY-MM-DD H:MM:SS.
          type: string
          example: '2000-08-17 10:24:24'
        timezone_type:
          description: Número de representação do timezone.
          type: integer
          example: 3
        timezone:
          description: Fuso horário associado.
          type: string
          example: America/Sao_Paulo
      type: object
  securitySchemes:
    ApiToken:
      type: apiKey
      name: User-Token
      in: header
    ApiSecretKey:
      type: apiKey
      name: User-Secret-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.