> ## 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 Pedidos retornados pela busca > lista pedidos retornados pela busca ## OpenAPI ````yaml get /{alias}/search/orders 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/orders: get: tags: - Busca - Pedidos summary: Listar Pedidos retornados pela busca description: lista pedidos retornados pela busca operationId: GetSearchOrders parameters: - name: alias in: path description: Alias da loja required: true schema: type: string - $ref: '#/components/parameters/OrderSearchCriteria' responses: '200': description: Lista de pedidos através da busca content: application/json: schema: properties: data: type: object allOf: - $ref: '#/components/schemas/Order' - $ref: '#/components/schemas/OrderAdditionalResponse' type: object '400': description: Requisição inválida '404': description: URL inválida components: parameters: OrderSearchCriteria: name: filters in: query description: Filtros de pedidos style: form explode: false schema: $ref: '#/components/schemas/OrderSearchCriteria' schemas: Order: title: Pedido description: Representa um pedido properties: delivered: description: Indica se o pedido já foi entregue ao cliente. type: boolean track_url: description: URL de rastreamento da entrega gerada pela transportadora. type: string track_code: description: Código de rastreamento da entrega gerado pela transportadora. type: string authorized: description: >- Indica se o pagamento do pedido foi autorizado pela adquirente/gateway. type: boolean customer_id: description: ID do cliente type: integer promocode_id: description: ID do cupom de desconto aplicado ao pedido, quando houver. type: integer marketplace_id: description: >- ID do marketplace de origem do pedido, quando a venda vem de um marketplace. type: integer marketplace_account_id: description: ID da conta do marketplace vinculada ao pedido. type: integer has_recomm: description: >- Indica se o pedido teve origem no clique em um produto sugerido pelo e-mail de recomendação. type: boolean number: description: Número do pedido type: number marketplace_partner_id: description: >- ID do parceiro/afiliado do marketplace associado ao pedido, quando aplicável. type: integer marketplace_sale_number: description: >- Número único da venda no marketplace de origem (usado quando não há `number` local do pedido). 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: description: ID da cotação de frete utilizada no pedido. type: integer days_delivery: description: Dias para entrega type: integer utm_source: description: >- Origem da campanha de marketing (parâmetro UTM `utm_source`) que originou o pedido. type: string utm_campaign: description: >- Nome da campanha de marketing (parâmetro UTM `utm_campaign`) que originou o pedido. type: string utm_term: description: Termo de busca (parâmetro UTM `utm_term`) que originou o pedido. type: string utm_content: description: >- Conteúdo do anúncio/link (parâmetro UTM `utm_content`) que originou o pedido. type: string utm_medium: description: >- Meio/canal de marketing (parâmetro UTM `utm_medium`) que originou o pedido. type: string ip: description: Endereço IP do comprador no momento da criação do pedido. 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: description: Transações de pagamento associadas ao pedido. properties: data: description: Lista das transações de pagamento do pedido. type: object allOf: - $ref: '#/components/schemas/Transaction' - $ref: '#/components/schemas/TransactionAdditionalResponse' type: object type: object OrderAdditionalResponse: title: '' description: >- Recursos adicionais do pedido, retornados sob demanda via parâmetro `include`. properties: date_delivery: $ref: '#/components/schemas/BaseTimestamp' whatsapp: description: Mensagens configuradas para WhatsApp relacionadas ao pedido properties: data: description: >- Dados dos links de mensagens pré-configuradas do WhatsApp para o pedido. 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: description: Endereço de retirada do pedido, quando aplicável. 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: description: Dados do status atual do pedido. 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: description: Dados do pagamento via Pix associado ao pedido. properties: data: description: Informações da cobrança Pix gerada para o pedido. 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: description: Cupom de desconto aplicado ao pedido. properties: data: $ref: '#/components/schemas/OrderPromocode' type: object statuses: description: Histórico de status do pedido properties: data: description: Histórico de status pelos quais o pedido passou. 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: description: >- Lista de serviços externos vinculados ao pedido (ex.: integrações de logística). type: array items: type: object type: object customer: description: Cliente que realizou o pedido. properties: data: $ref: '#/components/schemas/Customer' type: object type: object OrderSearchCriteria: title: Filtros de Pedidos description: Mapeia os filtros disponíveis para pesquisa de pedidos. properties: freebie_id: description: Brindes associados ao pedido. type: array items: type: integer example: '?freebie_id[]=45' order_bump_id: description: Order Bumps adicionados ao pedido. type: array items: type: integer example: '?order_bump_id[]=8' cashback: description: Filtra pedidos por status de cashback. type: array items: type: string enum: - accumulated_cashback - used_cashback example: '?cashback[]=used_cashback' upsell_id: description: Upsells adquiridos após o checkout. type: array items: type: integer example: '?upsell_id[]=22' woocommerce: description: Filtra pedidos sincronizados ou não com WooCommerce. type: array items: type: string enum: - sent - not_sent example: '?woocommerce[]=not_sent' utm_source: description: Origem da campanha de marketing (UTM Source). type: array items: type: string example: '?utm_source[]=google' shopify_id: description: Busca pedido pelo ID do pedido na Shopify. type: integer example: '?shopify_id=987654321' utm_campaign: description: Nome da campanha de marketing (UTM Campaign). type: array items: type: string example: '?utm_campaign[]=black_friday' customer_document: description: Documento do cliente associado ao pedido (CPF ou CNPJ). type: string example: '?customer_document=12345678900' type: object x-folder: pedidos 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 description: >- Tentativa de pagamento processada pela adquirente/gateway para um carrinho ou pedido. properties: id: description: Identificador único da transação. type: integer customer_id: description: ID do cliente que fez o pagamento. type: integer payment_id: description: ID do meio de pagamento usado na transação. type: integer affiliation_id: description: >- ID da afiliação de pagamento (adquirente/gateway) que processou a transação. type: integer marketplace_id: description: ID do marketplace de origem da transação, quando aplicável. type: integer marketplace_account_id: description: ID da conta do marketplace usada na transação, quando aplicável. type: integer authorized: description: Indica se a transação foi autorizada pela adquirente/gateway. type: boolean captured: description: Indica se a transação foi capturada (pagamento efetivado). type: boolean cancelled: description: Indica se a transação foi cancelada. type: boolean can_be_captured: description: >- Indica se a transação pode ser capturada: exige transação autorizada, não cancelada, ainda não paga e meio de pagamento diferente de carteira digital e de Pix parcelado. type: boolean can_be_cancelled: description: >- Indica se a transação pode ser cancelada: exige transação não cancelada e meio de pagamento diferente de carteira digital e de Pix parcelado. type: boolean gateway_transaction_id: description: ID da transação no gateway de pagamento. type: integer gateway_order_id: description: ID do pedido correspondente no gateway de pagamento. type: integer gateway_authorization_code: description: Código de autorização devolvido pela adquirente/gateway. type: string gateway_billet_id: description: >- ID do boleto no gateway de pagamento, quando o meio de pagamento for boleto. type: integer amount: description: Valor total da transação, em reais. type: number format: float buyer_amount: description: >- Valor total cobrado do comprador, em reais, incluindo os juros do parcelamento. type: number format: float installment_value: description: >- Valor de cada parcela da transação, em reais; zero quando não há parcelamento. type: number format: float buyer_installment_value: description: >- Valor de cada parcela cobrada do comprador, em reais; zero quando não há parcelamento. type: number format: float installments: description: Número de parcelas da transação. type: integer installment_formated: description: >- Parcelamento formatado no padrão `3x de R$ 300,00`, com o número de parcelas e o valor total da transação. type: string buyer_installment_formated: description: >- Parcelamento formatado no padrão `3x de R$ 300,00`, com o número de parcelas e o valor total cobrado do comprador. type: string status: description: >- Status da transação (`waiting_payment`, `authorized`, `paid`, `refused`, `cancelled` ou `handling_products`). type: string error_message: description: >- Mensagem de erro devolvida pela adquirente/gateway quando a transação não é aprovada. type: string bank_name: description: >- Nome do banco usado no pagamento; preenchido apenas em pagamentos por depósito. type: string bank_alias: description: >- Alias do banco usado no pagamento, derivado do nome; preenchido apenas em pagamentos por depósito. type: string truncated_card: description: >- Número parcial do cartão usado no pagamento, sem os dígitos sensíveis. type: string holder_name: description: >- Nome do titular do cartão ou do meio de pagamento usado na transação. type: string holder_document: description: >- Documento (CPF/CNPJ) do titular do cartão ou do meio de pagamento usado na transação. type: string billet_url: description: >- URL do boleto gerado para a transação, quando o meio de pagamento for boleto. type: string billet_barcode: description: Código de barras do boleto gerado para a transação. type: string billet_date: description: Data de vencimento do boleto gerado para a transação. type: string billet_our_number: description: Nosso número do boleto, identificador atribuído pelo banco emissor. type: string billet_document_number: description: >- Número do documento do boleto, usado pelo banco emissor para identificar a cobrança. type: string billet_whatsapp_link: description: >- Link do WhatsApp com a mensagem de cobrança do boleto pronta para envio ao cliente. type: string antifraud_sale_id: description: ID da análise da transação no serviço de antifraude. type: integer antifraud_status: description: Status devolvido pelo serviço de antifraude para a transação. type: string antifraud_score: description: Pontuação de risco atribuída pelo serviço de antifraude à transação. type: string sent_to_antifraud: description: Indica se a transação foi enviada para análise de antifraude. type: string total_logs: description: Quantidade de registros de log da transação. type: integer error_code: description: >- Código do erro devolvido pela adquirente/gateway quando a transação não é aprovada. 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: Dados adicionais da transação description: >- Dados retornados junto da transação por meio de includes; `payment` e `metadata` vêm por padrão. 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 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 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' Customer: title: Customer description: Representa um cliente properties: id: description: Identificador único do cliente. type: integer merchant_id: description: ID da loja à qual o cliente pertence. type: integer marketplace_id: description: >- ID do marketplace de origem do cliente, quando o cadastro vem de um marketplace. type: integer active: description: Indica se o cliente está ativo. type: boolean type: description: >- Tipo de pessoa do cliente: `f` para pessoa física, `j` para pessoa jurídica. type: string cluster_id: description: >- ID do cluster (grupo de clientes) ao qual o cliente está vinculado, quando houver. type: integer name: description: Nome do cliente. type: string first_name: description: Primeiro nome do cliente, derivado de `name`. type: string last_name: description: Sobrenome do cliente, derivado de `name`. type: string generic_name: description: >- Nome de exibição do cliente: o `name` para pessoa física e a `razao_social` para pessoa jurídica. type: string cpf: description: CPF do cliente, para pessoa física. type: string spreadsheet: description: >- Dados do cliente desnormalizados para exportação em planilha, retornados sob demanda via `include`. properties: data: description: Conjunto de dados do cliente usados na exportação em planilha. properties: brands: description: >- Marcas dos produtos comprados pelo cliente no último pedido, separadas por vírgula. type: string city: description: Cidade do endereço do cliente. type: string purchased_brands: description: >- Marcas dos produtos comprados pelo cliente no último pedido, separadas por vírgula. type: string last_order_date: description: Data do último pedido do cliente. properties: date: description: Data e hora do último pedido do cliente. type: string format: date-time timezone: description: Fuso horário da data do último pedido. type: string timezone_type: description: >- Tipo de representação do fuso horário (padrão interno de data do PHP). type: integer type: object last_order_value: description: Valor total do último pedido do cliente, em reais. type: string purchased_categories: description: >- Categorias dos produtos comprados pelo cliente no último pedido, separadas por vírgula. type: string number: description: Número do endereço do cliente. type: string uf: description: Unidade federativa (estado) do endereço do cliente. type: string phone: description: Telefone do cliente, com DDD e formatado. type: string example: (16) 98187-5668 street: description: Nome da rua do endereço do cliente. type: string phone_number: description: Número do telefone do cliente, sem o DDD. type: string example: '981875668' categories: description: >- Categorias dos produtos comprados pelo cliente no último pedido, separadas por vírgula. type: string neighborhood: description: Bairro do endereço do cliente. type: string complement: description: Complemento do endereço do cliente. type: string phone_code: description: DDD do telefone do cliente. type: string example: '16' type: object type: object phone: description: Dados de telefone do cliente. properties: area_code: description: Código de área (DDD) do telefone. type: string full_number: description: Número completo do telefone, com DDD e sem formatação. type: string number: description: Número do telefone, sem o DDD. type: string formated_number: description: Número do telefone formatado para exibição. type: string whatsapp_link: description: Link para iniciar uma conversa no WhatsApp com o cliente. type: string format: uri type: object razao_social: description: Razão social do cliente, para pessoa jurídica. type: string cnpj: description: CNPJ do cliente, para pessoa jurídica. type: string state_registration: description: Inscrição estadual do cliente, para pessoa jurídica. type: string email: description: E-mail do cliente. type: string format: email password: description: >- Senha de acesso do cliente. Enviada apenas na criação ou atualização, nunca retornada. type: string writeOnly: true birthday: description: Data de nascimento do cliente. type: string format: date newsletter: description: Indica se o cliente aceitou receber a newsletter da loja. type: boolean whatsapp: description: Indica se o cliente aceitou receber mensagens no WhatsApp. type: boolean social_driver: description: >- Provedor de login social usado no cadastro do cliente (ex.: Google, Facebook), quando aplicável. type: string social_id: description: >- Identificador do cliente no provedor de login social, quando o cadastro veio de login social. type: integer ip: description: Endereço IP do cliente no momento do cadastro. type: string readOnly: true token: description: >- Token único do cliente, usado para autenticá-lo em ações como login automático. type: string utm_source: description: >- Origem da campanha de marketing (parâmetro UTM `utm_source`) que originou o cadastro do cliente. type: string utm_campaign: description: >- Nome da campanha de marketing (parâmetro UTM `utm_campaign`) que originou o cadastro do cliente. type: string notes: description: Observações internas sobre o cliente. type: string login_url: description: >- URL de login automático do cliente na loja, gerada a partir do seu `token`. type: string format: uri anonymized: description: >- Indica se os dados do cliente foram anonimizados por solicitação de exclusão (LGPD). type: boolean type: object 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 ````