Fulfillment - Manual da API
  1. Gerenciamento
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. Gerenciamento

Coleção de Clientes

Developing
GET
/api/v1/customers

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Responses

🟢200OK
application/json
Body

Example
{
    "success": true,
    "message": "Coleção de parceiros recuperada com sucesso",
    "search_query": "",
    "filters": [],
    "pagination": {
        "page": 1,
        "per_page": 15,
        "last_page": 1,
        "has_prev_page": false,
        "has_next_page": false,
        "records": {
            "from": 1,
            "to": 3,
            "total": 3
        }
    },
    "data": [
        {
            "id": "01k0fr725xt9enkgp163mdwtxx",
            "name": "Empresa Lucro Real S/A",
            "email": "financeiro@lucroreal.com.br",
            "type": "consumidor_final",
            "is_active": true,
            "tax_regime": "lucro_real",
            "document": "98.765.432/0001-10",
            "ie": "9876543210",
            "rg": null,
            "phone": null,
            "created_at": "2025-07-18T21:49:30.000000Z",
            "updated_at": "2025-07-18T21:49:30.000000Z",
            "deleted_at": null
        },
        {
            "id": "01k0fd8ebhxep94x6hbkjqhpsc",
            "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",
            "rg": "null",
            "phone": null,
            "created_at": "2025-07-18T18:38:01.000000Z",
            "updated_at": "2025-07-18T21:09:01.000000Z",
            "deleted_at": null
        },
        {
            "id": "01k0fr7awbfxf7538780qbkdzn",
            "name": "Maria Oliveira",
            "email": "maria.oliveira@email.com",
            "type": "consumidor_final",
            "is_active": true,
            "tax_regime": "pessoa_fisica",
            "document": "987.654.321-00",
            "ie": null,
            "rg": "12.345.678-9",
            "phone": null,
            "created_at": "2025-07-18T21:49:39.000000Z",
            "updated_at": "2025-07-18T21:49:39.000000Z",
            "deleted_at": null
        }
    ]
}
Previous
👔 Clientes & Parceiros
Next
Novo cliente
Built with