Fulfillment - Manual da API
  1. Clientes
Fulfillment - Manual da API
  • 🚀 Introdução
  • 🔒 Autenticação
  • 🚦 Rate Limiting
  • 🛟 Suporte
  • Autenticação
    • Autenticação
    • Sessão do usuário
    • Refresh Token
    • Finalizar Sessão
  • Produtos
    • 📦 Conceitos de Produtos
    • Gerenciamento
      • Coleção de produtos
      • Criar um novo produto
      • Detalhes do produto
      • Estoque do Produto
      • Modificar Produto
      • Excluir Produto
    • Controle
      • Controle de Temperatura
      • Controle de Estoque
      • Data de validade & Lote
    • Códigos fiscais
      • Códigos fiscais do produto
      • Adicionar um código fiscal no produto
      • Detalhes do código fiscal do produto
      • Modificar código fiscal do produto
      • Excluir código fiscal do produto
  • Tipos de Operações
    • ♻️ Tipos de Operação
    • 📦 Entrada de Mercadoria
    • Tipos de Operações
    • Tipo de Operação
  • Clientes
    • 👔 Clientes & Parceiros
    • Gerenciamento
      • Coleção de Clientes
        GET
      • Novo cliente
        POST
      • Detalhes
        GET
      • Modificar
        PUT
      • Excluir
        DELETE
    • Endereços
      • Endereços
        GET
      • Adicionar Endereço
        POST
      • Detalhes do Endereço
        GET
      • Modificar Endereço
        PUT
  • Pedidos
    • 🛒 Pedidos Fulfillment
    • Gerenciamento
      • Pedidos
      • Novo Pedido
      • Detalhes do Pedido
      • Confirmar Pedido
      • Update Order
    • Workflows
      • Situação atual de um pedido
      • Fluxos de execução disponíveis
      • Avançar Workflow
      • Cancelar Pedido / Workflow
    • Itens do Pedido
      • Gerenciamento
        • Itens do Pedido
        • Adicionar Item
        • Detalhes do Item
        • Modificar Item
        • Excluir Item
      • Rastreamento
        • Rastreamentos
        • Adicionar Rastreamento
        • Detalhes do Rastreamento
        • Excluir Rastreamento
    • Agendamento
      • Agendamento
      • Slots Disponíveis
      • Reservar Slots
      • Cancelar Agendamento
      • Confirmar Agendamento
    • Identificação de Produtos
      • Etiquetas
      • Gerar Etiquetas
      • Confirmar impressão
    • Documentos Fiscais
      • Documentos Fiscais
      • Documento Fiscal
      • Detalhes do Documento
      • Excluir Documento
    • Documentos para Impressão
      • Documentos
      • Adicionar Documento
      • Detalhes do Documento
      • Pré-visualização
      • Excluir Documento
  • Configurações
    • Webhooks
      • Webhooks
      • Webhook
      • Webhook
      • Webhook
      • Webhook
      • Histórico
      • Estatísticas
      • Teste
      • Eventos Disponíveis
    • Integrações
      • Faturador - Bling
        • Integrações
        • Criar Integração
        • Detalhes da Integração
        • Cancelar Integração
        • Status da Integração
        • Logs
        • Auth Link
    • Enumeração
      • Enumeração
      • Tipos disponíveis
    • Token de API
      • Token de API
      • Criar um novo Token
  • Fiscal
    • Pedidos aguardando nota fiscal
    • Totais - aguardando nota fiscal
  • Locais de Estoque
    • Localizações Exclusivas
    • Ocupação das Localizações
    • Detalhes de uma Localização
    • Produtos de uma Localização
  • Inventário
    • Resumo Geral do Estoque
    • Inventário Detalhado
    • Produtos com Estoque Baixo
    • Consulta Detalhada de Estoque
  1. Clientes

👔 Clientes & Parceiros

Visão Geral#

A API de Clientes permite o cadastro e gerenciamento de diferentes tipos de parceiros comerciais, oferecendo flexibilidade para atender às necessidades operacionais do seu negócio.

Tipos de Clientes Suportados#

🛒 Consumidor Final#

Destinado ao cadastro de clientes pessoa física ou jurídica que adquirem produtos para consumo próprio. Ideal para vendas diretas ao consumidor final.

🏢 Revendedor#

Para cadastro de empresas parceiras que revendem seus produtos. Permite controle específico de regimes tributários e configurações comerciais diferenciadas.

🚛 Transportadoras#

Empresas responsáveis pela logística e entrega dos produtos. Essencial para o controle da cadeia de distribuição e rastreamento de entregas.

Características Principais#

Informações Básicas#

Identificação: Nome, e-mail, tipo de cliente
Documentação: CPF/CNPJ e Inscrição Estadual
Configurações: Status ativo/inativo, regime tributário
Contato: Telefone para comunicação

Sistema de Endereços#

Cada cliente pode possuir múltiplos endereços cadastrados, permitindo:
Tipos de endereço: Entrega, cobrança, retirada
Múltiplas localizações: Diferentes pontos de entrega ou filiais
Endereço padrão: Definição de endereço principal para operações
Dados completos: Logradouro, número, complemento, bairro, cidade, estado, CEP e país
Identificação: Rótulos personalizados para facilitar a identificação

Exemplo na API#

{
    "id": "01k0q2493a4q9m5h68rq9xgawy",
    "name": "Empresa Simples Ltda",
    "email": "contato@empresasimples.com.br",
    "type": "consumidor_final",
    "is_active": true,
    "tax_regime": "simples_nacional",
    "document": "12.345.678/0001-01",
    "ie": "1234567890",
    "phone": '1122449955',
    "created_at": "2025-07-21T17:57:26.000000Z",
    "updated_at": "2025-07-21T17:57:26.000000Z",
    "deleted_at": null,
    "addresses": []
}
Previous
Tipo de Operação
Next
Coleção de Clientes
Built with