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

# Listar Resultados mais recentes retornados pela busca

> lista as entradas mais recentes retornados pela busca



## OpenAPI

````yaml get /{alias}/search/global
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: 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: 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: Logística - Frete Público
    description: Logística - Frete Público
  - 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}/search/global:
    get:
      tags:
        - Busca - Global
      summary: Listar Resultados mais recentes retornados pela busca
      description: lista as entradas mais recentes retornados pela busca
      operationId: GetSearchGlobal
      parameters:
        - name: alias
          in: path
          description: Alias da loja
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Lista de entradas retornados pela busca
          content:
            application/json:
              schema:
                properties:
                  data:
                    description: Estrutura global.
                    properties:
                      products:
                        $ref: '#/components/schemas/ProductLabel'
                      customers:
                        description: Lista de clientes retornados pela busca.
                        type: object
                        allOf:
                          - $ref: '#/components/schemas/Customer'
                          - $ref: '#/components/schemas/CustomerAdditionalResponse'
                      orders:
                        description: Lista de pedidos retornados pela busca.
                        type: object
                        allOf:
                          - $ref: '#/components/schemas/Order'
                          - $ref: '#/components/schemas/OrderAdditionalResponse'
                    type: object
                type: object
        '400':
          description: Requisição inválida
        '404':
          description: URL inválida
components:
  schemas:
    ProductLabel:
      description: Título e ID de um produto para exibição em listagens simples.
      properties:
        id:
          type: integer
        name:
          type: string
      type: object
    Customer:
      title: Customer
      description: Representa um cliente
      properties:
        id:
          type: integer
        merchant_id:
          type: integer
        marketplace_id:
          type: integer
        active:
          type: boolean
        type:
          type: string
        cluster_id:
          type: integer
        name:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        generic_name:
          type: string
        cpf:
          type: string
        spreadsheet:
          properties:
            data:
              properties:
                brands:
                  type: string
                city:
                  type: string
                purchased_brands:
                  type: string
                last_order_date:
                  properties:
                    date:
                      type: string
                      format: date-time
                    timezone_type:
                      type: integer
                    timezone:
                      type: string
                  type: object
                last_order_value:
                  type: string
                purchased_categories:
                  type: string
                number:
                  type: string
                uf:
                  type: string
                phone:
                  type: string
                  example: (16) 98187-5668
                street:
                  type: string
                phone_number:
                  type: string
                  example: '981875668'
                categories:
                  type: string
                neighborhood:
                  type: string
                complement:
                  type: string
                phone_code:
                  type: string
                  example: '16'
              type: object
          type: object
        phone:
          properties:
            area_code:
              description: Código de área do telefone
              type: string
            full_number:
              description: Número do telefone
              type: string
            number:
              description: Número do telefone
              type: string
            formated_number:
              description: Número do telefone formatado
              type: string
            whatsapp_link:
              type: string
              format: uri
          type: object
        razao_social:
          type: string
        cnpj:
          type: string
        state_registration:
          type: string
        email:
          type: string
          format: email
        password:
          type: string
          writeOnly: true
        birthday:
          type: string
          format: date
        newsletter:
          type: boolean
        whatsapp:
          type: boolean
        social_driver:
          type: string
        social_id:
          type: integer
        ip:
          type: string
          readOnly: true
        token:
          type: string
        utm_source:
          type: string
        utm_campaign:
          type: string
        notes:
          type: string
        login_url:
          type: string
          format: uri
        anonymized:
          type: boolean
      type: object
    CustomerAdditionalResponse:
      title: ''
      description: ''
      properties:
        deletion_request:
          properties:
            data:
              properties:
                pending_confirmation:
                  type: boolean
                scheduled_date:
                  type: string
                  format: date
              type: object
          type: object
        addresses:
          properties:
            data:
              type: array
              items:
                properties:
                  receiver:
                    type: string
                  city:
                    type: string
                  full_address:
                    type: string
                  zip_code:
                    type: string
                  number:
                    type: string
                  uf:
                    type: string
                  street:
                    type: string
                  id:
                    type: integer
                  neighborhood:
                    type: string
                  customer_id:
                    type: integer
                  complement:
                    type: string
                  created_at:
                    $ref: '#/components/schemas/BaseTimestamp'
                  updated_at:
                    $ref: '#/components/schemas/BaseTimestamp'
                type: object
          type: object
        created_at:
          $ref: '#/components/schemas/BaseTimestamp'
        updated_at:
          $ref: '#/components/schemas/BaseTimestamp'
      type: object
    Order:
      title: Pedido
      description: Representa um pedido
      properties:
        delivered:
          type: boolean
        track_url:
          type: string
        track_code:
          type: string
        authorized:
          type: boolean
        customer_id:
          description: ID do cliente
          type: integer
        promocode_id:
          type: integer
        marketplace_id:
          type: integer
        marketplace_account_id:
          type: integer
        has_recomm:
          type: boolean
        number:
          description: Número do pedido
          type: number
        marketplace_partner_id:
          type: integer
        marketplace_sale_number:
          type: number
        value_total:
          description: Valor total do pedido
          type: number
          format: float
        value_products:
          description: Valor dos produtos
          type: number
          format: float
        value_discount:
          description: Valor do desconto
          type: number
          format: float
        value_shipment:
          description: Valor do frete
          type: number
          format: float
        value_tax:
          description: Valor do imposto
          type: number
          format: float
        shipment_service:
          description: Método de entrega
          type: string
        shipment_quote_id:
          type: integer
        days_delivery:
          description: Dias para entrega
          type: integer
        utm_source:
          type: string
        utm_campaign:
          type: string
        utm_term:
          type: string
        utm_content:
          type: string
        utm_medium:
          type: string
        ip:
          type: string
          format: ip
          readOnly: true
        items:
          description: Itens do pedido
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
        address:
          description: Endereço de entrega
          type: array
          items:
            $ref: '#/components/schemas/OrderAddress'
        transactions:
          properties:
            data:
              type: object
              allOf:
                - $ref: '#/components/schemas/Transaction'
                - $ref: '#/components/schemas/TransactionAdditionalResponse'
          type: object
      type: object
    OrderAdditionalResponse:
      title: ''
      description: ''
      properties:
        date_delivery:
          $ref: '#/components/schemas/BaseTimestamp'
        whatsapp:
          description: Mensagens configuradas para WhatsApp relacionadas ao pedido
          properties:
            data:
              properties:
                billet:
                  description: Mensagem de boleto via WhatsApp
                  properties:
                    link:
                      description: Link do WhatsApp com mensagem pré-configurada
                      type: string
                      format: uri
                    message:
                      description: Conteúdo da mensagem do boleto
                      type: string
                  type: object
                order_shipped:
                  description: Mensagem de pedido enviado
                  type: string
                  nullable: true
                abandoned_cart:
                  description: Mensagem de carrinho abandonado
                  type: string
                  nullable: true
                pix:
                  description: Mensagem de Pix
                  type: string
                  nullable: true
                payment_link:
                  description: Mensagem de link de pagamento
                  type: string
                  nullable: true
              type: object
          type: object
        pickup_address:
          properties:
            data:
              $ref: '#/components/schemas/Pickup'
          type: object
        metadata:
          description: Metadados adicionais
          properties:
            data:
              description: Lista de metadados
              type: array
              items:
                properties:
                  key:
                    description: Chave do metadado
                    type: string
                    example: discount_highlight
                  value:
                    description: Valor do metadado
                    type: string
                    example: pix
                type: object
          type: object
        status:
          description: Status atual do pedido
          properties:
            data:
              properties:
                id:
                  description: ID do status
                  type: integer
                name:
                  description: Nome do status
                  type: string
                alias:
                  description: Alias identificador do status
                  type: string
                description:
                  description: Descrição detalhada do status
                  type: string
              type: object
          type: object
        pix:
          properties:
            data:
              properties:
                pix_qr_code:
                  description: Código QR do Pix
                  type: string
                pix_expiration_date:
                  description: Data e hora de expiração do Pix
                  type: string
                  format: date-time
              type: object
          type: object
        promocode:
          properties:
            data:
              $ref: '#/components/schemas/OrderPromocode'
          type: object
        statuses:
          description: Histórico de status do pedido
          properties:
            data:
              type: array
              items:
                properties:
                  id:
                    description: ID do status
                    type: integer
                  name:
                    description: Nome do status
                    type: string
                  alias:
                    description: Alias do status
                    type: string
                  description:
                    description: Descrição do status
                    type: string
                  details:
                    description: Detalhes adicionais do status
                    type: string
                    nullable: true
                  created_at:
                    $ref: '#/components/schemas/BaseTimestamp'
                  updated_at:
                    $ref: '#/components/schemas/BaseTimestamp'
                type: object
          type: object
        payments:
          description: Lista de meios de pagamento disponíveis ou utilizados
          type: array
          items:
            properties:
              icon_url:
                description: URL do ícone do meio de pagamento
                type: string
                format: uri
              name:
                description: Nome do meio de pagamento
                type: string
              alias:
                description: Alias identificador do meio de pagamento
                type: string
            type: object
        services:
          description: Serviços vinculados ao pedido
          properties:
            data:
              type: array
              items:
                type: object
          type: object
        customer:
          properties:
            data:
              $ref: '#/components/schemas/Customer'
          type: object
      type: object
    BaseTimestamp:
      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
    OrderItem:
      description: Item do pedido
      properties:
        id:
          description: ID do item no pedido
          type: integer
        product_id:
          description: ID do produto
          type: integer
        sku_id:
          description: ID do SKU
          type: integer
        item_sku:
          description: Código do SKU
          type: string
        quantity:
          description: Quantidade adquirida
          type: integer
        price:
          description: Preço do item
          type: number
          format: float
        price_cost:
          description: Custo do item
          type: number
          format: float
        shipment_cost:
          description: Custo de envio do item
          type: number
          format: float
        gift:
          description: Indica se é um item presente
          type: boolean
        gift_value:
          description: Valor do item presente
          type: number
          format: float
        has_recomm:
          description: Indica se possui recomendação
          type: integer
        is_digital:
          description: Indica se é um item digital
          type: boolean
        freebie_id:
          description: ID de item brinde (se aplicável)
          type: integer
          nullable: true
        bundle_id:
          description: ID do bundle (se aplicável)
          type: integer
          nullable: true
        bundle_name:
          description: Nome do bundle (se aplicável)
          type: string
          nullable: true
      type: object
    OrderAddress:
      title: Endereço do pedido
      properties:
        id:
          type: integer
          readOnly: true
        order_id:
          type: integer
          readOnly: true
        address_name:
          type: string
        street:
          description: Rua
          type: string
        number:
          description: Número
          type: integer
        complement:
          description: Complemento
          type: string
        reference:
          description: Referencia
          type: string
        neighborhood:
          description: Bairro
          type: string
        receiver:
          description: Nome do recebedor
          type: string
        zipcode:
          description: CEP
          type: integer
        zip_code:
          description: CEP
          type: integer
        full_address:
          type: string
        city:
          description: Cidade
          type: string
        uf:
          description: Estado
          type: string
        country:
          description: País
          type: string
      type: object
    Transaction:
      title: Transações financeiras de um pedido
      properties:
        id:
          type: integer
        customer_id:
          description: ID do cliente
          type: integer
        payment_id:
          description: ID do pagamento
          type: integer
        affiliation_id:
          description: ID da afiliação
          type: integer
        marketplace_id:
          type: integer
        marketplace_account_id:
          type: integer
        authorized:
          type: boolean
        captured:
          type: boolean
        cancelled:
          type: boolean
        can_be_captured:
          type: boolean
        can_be_cancelled:
          type: boolean
        gateway_transaction_id:
          description: ID da transação no gateway
          type: integer
        gateway_order_id:
          type: integer
        gateway_authorization_code:
          type: string
        gateway_billet_id:
          type: integer
        amount:
          description: Valor
          type: number
          format: float
        buyer_amount:
          description: Valor
          type: number
          format: float
        installment_value:
          description: Valor
          type: number
          format: float
        buyer_installment_value:
          description: Valor
          type: number
          format: float
        installments:
          description: Número de parcelas
          type: integer
        installment_formated:
          description: Status da transação
          type: string
        buyer_installment_formated:
          description: Status da transação
          type: string
        status:
          description: Status da transação
          type: string
        error_message:
          type: string
        bank_name:
          type: string
        bank_alias:
          type: string
        truncated_card:
          type: string
        holder_name:
          description: Nome do titular
          type: string
        holder_document:
          description: Documento do titular
          type: string
        billet_url:
          type: string
        billet_barcode:
          type: string
        billet_date:
          type: string
        billet_our_number:
          type: string
        billet_document_number:
          type: string
        billet_whatsapp_link:
          type: string
        antifraud_sale_id:
          type: integer
        antifraud_status:
          type: string
        antifraud_score:
          type: string
        sent_to_antifraud:
          type: string
        total_logs:
          type: integer
        error_code:
          type: integer
        created_at:
          $ref: '#/components/schemas/BaseTimestamp'
        updated_at:
          $ref: '#/components/schemas/BaseTimestamp'
        capture_date:
          $ref: '#/components/schemas/BaseTimestamp'
        authorized_at:
          $ref: '#/components/schemas/BaseTimestamp'
        captured_at:
          $ref: '#/components/schemas/BaseTimestamp'
        cancelled_at:
          $ref: '#/components/schemas/BaseTimestamp'
      type: object
    TransactionAdditionalResponse:
      title: ''
      description: ''
      properties:
        payment:
          description: Informações sobre o meio de pagamento
          properties:
            data:
              description: Detalhes do pagamento
              properties:
                id:
                  description: ID do meio de pagamento
                  type: integer
                alias:
                  description: Alias do meio de pagamento
                  type: string
                name:
                  description: Nome do meio de pagamento
                  type: string
                has_config:
                  description: Indica se há configuração disponível
                  type: boolean
                active_config:
                  description: Indica se a configuração está ativa
                  type: boolean
                is_credit_card:
                  description: Indica se é um cartão de crédito
                  type: boolean
                is_deposit:
                  description: Indica se é um pagamento por depósito
                  type: boolean
                is_billet:
                  description: Indica se é um boleto bancário
                  type: boolean
                is_pix:
                  description: Indica se é um pagamento via Pix
                  type: boolean
                is_pix_in_installments:
                  description: Indica se o Pix permite parcelamento
                  type: boolean
                is_wallet:
                  description: Indica se é um pagamento via carteira digital
                  type: boolean
                icon_url:
                  description: URL do ícone do meio de pagamento
                  type: string
                  format: uri
              type: object
          type: object
        metadata:
          description: Lista de metadados
          type: array
          items:
            properties:
              key:
                description: Chave do metadado
                type: string
                example: discount_highlight
              value:
                description: Valor do metadado
                type: string
                example: pix
            type: object
      type: object
    Pickup:
      title: Endereço de retirada
      properties:
        id:
          description: ID do endereço de retirada
          type: integer
        order_id:
          description: ID do pedido relacionado
          type: integer
        country:
          description: País
          type: string
        uf:
          description: Estado (sigla)
          type: string
        city:
          description: Cidade
          type: string
        neighborhood:
          description: Bairro
          type: string
        street:
          description: Nome da rua
          type: string
        number:
          description: Número do endereço
          type: string
        zipcode:
          description: CEP
          type: string
        full_address:
          description: Endereço completo
          type: string
        complement:
          description: Complemento
          type: string
          nullable: true
        pickup_time_type:
          description: Tipo de horário de retirada
          type: string
        pickup_time:
          description: Horário de retirada
          type: integer
        only_weekdays:
          description: Indica se a retirada é apenas em dias úteis (1 = sim, 0 = não)
          type: integer
        local_description:
          description: Descrição do local de retirada
          type: string
      type: object
    OrderPromocode:
      description: Representa os clientes que usaram um cupom
      type: object
      allOf:
        - $ref: '#/components/schemas/Promocode'
        - $ref: '#/components/schemas/PromocodeAdditionalResponse'
    Promocode:
      title: Código Promocional
      description: Representa um código promocional
      properties:
        id:
          type: integer
        code:
          type: string
          example: TEST
        description:
          type: string
          example: ''
        customer_id:
          type: integer
        active:
          type: boolean
        expired:
          type: boolean
        discount_type:
          type: string
          enum:
            - p
            - v
        for_the_price_of:
          type: boolean
        cart_default:
          type: boolean
        type_increment_value:
          type: string
          example: ''
        value:
          type: number
          format: float
          example: 10
        price_products:
          type: number
          format: float
        percent_products:
          type: number
          format: float
        quantity:
          type: integer
          example: '100000'
        total_customers_used:
          type: integer
          example: '22'
        product_quantity:
          type: integer
        product_max_quantity:
          type: integer
        used:
          type: integer
          example: 22
        items_count:
          type: integer
        min_value:
          type: number
          format: float
          example: 99.99
        use_percent:
          type: number
          format: float
          example: 0.02
        shipment_percent:
          type: number
          format: float
        accumulate:
          type: boolean
        once_per_customer:
          type: boolean
        abandoned_cart:
          type: boolean
        newsletter:
          type: boolean
        payments_ids:
          example: '[1, 2, 3, 4]'
        free_shipment:
          type: boolean
        ignore_promotion_products:
          type: boolean
      type: object
    PromocodeAdditionalResponse:
      properties:
        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
  securitySchemes:
    ApiToken:
      type: apiKey
      name: User-Token
      in: header
    ApiSecretKey:
      type: apiKey
      name: User-Secret-Key
      in: header

````