> ## 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. # Criar cliente > Cria um novo cliente ## OpenAPI ````yaml post /{alias}/customers 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}/customers: post: tags: - Clientes - Cliente summary: Criar cliente description: Cria um novo cliente operationId: PostCustomers parameters: - name: alias in: path description: Alias da loja required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerRequest' responses: '200': description: Cliente criado com sucesso content: application/json: schema: properties: data: type: array items: $ref: '#/components/schemas/Customer' type: object '400': description: Requisição inválida components: schemas: CustomerRequest: title: Criação de cliente description: Representa os dados necessários para criar ou atualizar um cliente required: - active - type - email - cnpj - cpf - homephone properties: marketplace_id: description: ID do marketplace type: integer nullable: true cluster_id: description: ID do cluster type: integer nullable: true active: description: Status do cliente type: boolean type: description: Tipo de cliente (f para físico, j para jurídico) type: string enum: - f - j name: description: Nome do cliente type: string razao_social: description: Razão social type: string nullable: true cpf: description: CPF do cliente type: string cnpj: description: CNPJ do cliente type: string nullable: true email: description: E-mail do cliente type: string homephone: description: Telefone residencial type: string birthday: description: >- Esse campo somente se torna obrigatório caso haja configuração da regra no checkout. Data de aniversário do cliente. type: string format: date-time example: '2000-06-01' ip: description: IP do cliente type: string utm_source: description: Fonte UTM type: string utm_campaign: description: Campanha UTM type: string notes: description: Notas sobre o cliente type: string type: object 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 securitySchemes: ApiToken: type: apiKey name: User-Token in: header ApiSecretKey: type: apiKey name: User-Secret-Key in: header ````