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

# Ordenar ou atualizar banner

> Atualiza a ordem dos banners ou as informações de um banner específico



## OpenAPI

````yaml put /{alias}/marketing/banners/{id}
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}/marketing/banners/{id}:
    put:
      tags:
        - Marketing
      summary: Ordenar ou atualizar banner
      description: Atualiza a ordem dos banners ou as informações de um banner específico
      operationId: PutMarketingBannersId
      parameters:
        - name: alias
          in: path
          description: Alias da loja
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: ID do banner
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/BannerSorting'
                - $ref: '#/components/schemas/BannerRequest'
      responses:
        '200':
          description: Operação realizada com sucesso
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Banner'
                  - $ref: '#/components/schemas/BannerAdditionalResponse'
        '400':
          description: Dados inválidos fornecidos
        '404':
          description: Banner não encontrado
        '422':
          description: >-
            Dados inválidos. Pode ocorrer quando campos obrigatórios estão
            ausentes, o formato é incorreto, ou quando o valor enviado resulta
            em uma string vazia após sanitização e normalização.
components:
  schemas:
    BannerSorting:
      title: Requisição de Ordenação de Banners
      description: Representa o corpo de uma requisiçao para criar ordenação de banners
      required:
        - sorting
      properties:
        sorting:
          description: Lista de grupos de ordenação
          type: array
          items:
            required:
              - group
              - resource_id
              - orders
            properties:
              group:
                description: |2-

                   *       collections,
                   *       categories,
                   *       promotions,
                   *       home
                type: string
                enum:
                  - collections
                  - categories
                  - promotions
                  - home
                example: categories
              resource_id:
                description: ID do recurso a ser ordenado
                type: integer
                example: ''
              orders:
                description: Ordem dos IDs dos banners
                type: array
                items:
                  type: integer
                example: '[1234, 123, 12334]'
            type: object
      type: object
    BannerRequest:
      title: Criação de banner
      description: Representa os dados necessários para criar ou atualizar um banner
      properties:
        active:
          description: Indica se o banner está ativo
          type: boolean
        home:
          description: Indica se o banner aparece na home
          type: boolean
        name:
          description: Nome do banner. O valor é sanitizado e normalizado automaticamente.
          type: string
        link:
          description: Link do banner
          type: string
        image_url:
          description: URL da imagem do banner
          type: string
        start_at:
          description: Data e hora de início
          type: string
          format: date-time
          example: '2025-06-01 00:00:00'
        end_at:
          description: Data e hora de término
          type: string
          format: date-time
          example: '2025-08-10 00:00:00'
        categories_ids:
          description: IDs das categorias
          type: array
          items:
            type: integer
          example: '[1,2,3]'
        collections_ids:
          description: IDs das coleções
          type: array
          items:
            type: integer
          example: '[1,2,3]'
        promotions_ids:
          description: IDs das promoções
          type: array
          items:
            type: integer
          example: '[1,2,3]'
      type: object
    Banner:
      title: Banner
      description: Representa um banner
      properties:
        id:
          description: ID do banner.
          type: integer
        product_id:
          description: >-
            ID do produto vinculado ao banner, exigido quando `type` for
            `product`.
          type: integer
        active:
          description: Indica se o banner está ativo.
          type: boolean
        type:
          description: >-
            Tipo do banner: `image` (banner de imagem) ou `product` (banner
            vinculado a um produto).
          type: string
        name:
          description: Nome de identificação do banner.
          type: string
        slug:
          description: Slug do banner, gerado a partir do nome.
          type: string
        link:
          description: URL de destino ao clicar no banner.
          type: string
        expired:
          description: Indica se a data de término de exibição do banner já passou.
          type: boolean
        image_url:
          description: URL da imagem do banner exibida em desktop.
          type: string
        mobile_image_url:
          description: URL da imagem do banner exibida em dispositivos móveis.
          type: string
        home:
          description: Indica se o banner é exibido na página inicial da loja.
          type: boolean
        stopwatch:
          description: >-
            Tipo da contagem regressiva exibida no banner: `daily` (reinicia
            todo dia) ou `expiration_date` (conta até a data de término).
          type: string
      type: object
    BannerAdditionalResponse:
      title: ''
      description: >-
        Recursos adicionais do banner, retornados sob demanda via parâmetro
        `include`.
      properties:
        stopwatch_expires_in:
          $ref: '#/components/schemas/BaseTimestamp'
        start_at:
          $ref: '#/components/schemas/BaseTimestamp'
        end_at:
          $ref: '#/components/schemas/BaseTimestamp'
        created_at:
          $ref: '#/components/schemas/BaseTimestamp'
        updated_at:
          $ref: '#/components/schemas/BaseTimestamp'
      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.