Clientes

 Includes disponíveis: addresses, stats, clusters
Listar clientes
GET https://api.dooki.com.br/v2/{alias}/customers
Request
{
    "marketplace_id": null,
    "cluster_id": null,
    "active": true,
    "type": "f",
    "name": "John Snow",
    "razao_social": null,
    "cpf": "00000000000",
    "cnpj": null,
    "email": "[email protected]",
    "password": "123456",
    "password_confirmation": "123456",
    "homephone": "00000000000",
    "ip": "127.0.0.1",
    "utm_source": "Google",
    "utm_campaign": "Adwords",
    "notes": "He is a nice customer."
}
Response
{
    "data": [
        {
            "id": 57906,
            "marketplace_id": null,
            "cluster_id": null,
            "active": true,
            "type": "f",
            "name": "John Snow",
            "razao_social": null,
            "first_name": "John",
            "last_name": "Snow",
            "email": "[email protected]",
            "cnpj": null,
            "cpf": "000.000.000.00",
            "phone": {
                "area_code": "11",
                "number": "0000000000",
                "formated_number": "(11) 00000-0000"
            },
            "utm_source": null,
            "utm_campaign": null,
            "ip": "000.000.000.00",
            "notes": "He is a nice customer."
            "stats": {
                "data": {
                    "total_orders": 1,
                    "last_sale_at": {
                        "date": "2017-11-03 00:55:07.000000",
                        "timezone_type": 3,
                        "timezone": "America/Sao_Paulo"
                    },
                    "last_sale_amount": 243.92,
                    "last_formated_sale_amount": "R$ 243,92"
                }
            },
            "addresses": {
                "data": [
                    {
                        "id": 55934,
                        "receiver": "John Snow",
                        "zip_code": "00000000",
                        "street": "Street Name",
                        "number": "00",
                        "neighborhood": "Neighborhood",
                        "complement": "Complement",
                        "city": "City",
                        "uf": "SP",
                        "full_address": "Street Name, 00 - Complement"
                    }
                ]
            }
        },
    ]
}
Criar cliente
POST https://api.dooki.com.br/v2/{alias}/customers
Parâmetro
Tipo
Obrigatório
Descrição
active
boolean
Sim
Status do cliente
marketplace_id
int
Não
ID do marketplace
cluster_id
int
Não
ID do cluster
type
string
Sim
Tipo da pessoa. Valores aceitos: f (pessoa física) e j (pessoa jurídica)
name
string
Não
Nome do cliente
razao_social
string
Não
Razão Social do cliente, caso seja pessoa jurídica
email
string
Sim
E-mail do cliente
cnpj
string
Sim (caso seja pessoa jurídica)
CNPJ do cliente
cpf
string
Sim (caso seja pessoa física)
CPF do cliente
homephone
string
Sim
Telefone ou celular do cliente
password
string
Sim
Senha de acesso do cliente
password_confirmation
string
Sim
Confirmação da senha
ip
string
Não
IP do cliente
utm_source
string
Não
Origem de acesso do cliente
utm_campaign
string
Não
Campanha de origem de acesso
notes
string
Não
Anotações sobre o cliente.
Filtros
Parâmetro
Tipo
Descrição
state_uf
array
Retornar clientes de determinados estados.
buy_product_id
array
Clientes que compraram determinados produtos.
q
string
Busca por nome, e-mail, razão social, cpf ou cnpj.
Visualizar cliente
GET https://api.dooki.com.br/v2/{alias}/customers/{id}
Atualizar cliente
PUT https://api.dooki.com.br/v2/{alias}/customers/{id}
Excluir cliente
DELETE https://api.dooki.com.br/v2/{alias}/customers/{id}
Listar filtros de busca dos clientes
GET https://api.dooki.com.br/v2/{alias}/customers/filters
Listar carrinhos abandonados de um cliente
GET https://api.dooki.com.br/v2/{alias}/customers/{id}/carts
Exportar clientes
GET https://api.dooki.com.br/v2/{alias}/customers/export
Dica: os filtros de busca também estão disponíveis no endpoint de exportação.
O sistema enviará para o usuário um e-mail com o link para download da planilha com os registros.
Exportar clientes para um determinado serviço
GET https://api.dooki.com.br/v2/{alias}/customers/export/{service}
Serviços disponíveis: mailchimp, mailee e rdstation
Parâmetro
Descrição
queue_id
ID da fila que está processando a exportação.
total
Número de registros a serem exportados.
Response ao exportar os clientes
{
    "queue_id": 53,
    "total": 133,
}
Filtros personalizados para clientes
Esse tipo de filtro não utiliza a sintaxe global. Neste caso, o parâmetro é passado individualmente via query string na URL.
Parâmetro
Tipo
Descrição
state_uf
string
UF do estado do cliente. Exemplo: SP, MG, RJ...
total_orders
int
Número de pedidos.
q
string
Busca pelo nome ou e-mail do cliente.
Exemplo:
GET https://api.dooki.com.br/v2/{alias}/customers?state_uf=SP
Endereços
Listar endereços de um cliente
GET https://api.dooki.com.br/v2/{alias}/customers/{customerId}/addresses
Request
{
    "receiver": "John Snowww",
    "zip_code": "00000000",
    "street": "Street Name",
    "number": "00",
    "neighborhood": "Neighborhood",
    "complement": "Complement",
    "city": "City",
    "uf": "SP"
}
Response
{
    "data": {
        "id": 55936,
        "receiver": "John Snowww",
        "zip_code": "00000000",
        "street": "Street Name",
        "number": "00",
        "neighborhood": "Neighborhood",
        "complement": null,
        "city": "City",
        "uf": "SP",
        "full_address": "Street Name, 00 - Neighborhood"
    }
}
Criar endereço
POST https://api.dooki.com.br/v2/{alias}/customers/{customerId}/addresses
Parâmetro
Tipo
Obrigatório
Descrição
receiver
string
Sim
Nome de quem receberá a entrega.
zip_code
string
Sim
CEP do endereço.
street
string
Sim
Nome da rua do endereço.
number
string
Sim
Número do endereço.
neighborhood
string
Sim
Bairro do endereço.
complement
string
Não
Complemento do endereço.
city
string
Sim
Nome da cidade.
uf
string
Sim
UF do estado.
Visualizar endereço
GET https://api.dooki.com.br/v2/{alias}/customers/{customerId}/addresses/{id}
Atualizar endereço
PUT https://api.dooki.com.br/v2/{alias}/customers/{customerId}/addresses/{id}
Excluir valor de filtro
DELETE https://api.dooki.com.br/v2/{alias}/customers/{customerId}/addresses/{id}
Clusters
Clusters são grupos de clientes com condições comerciais flexíveis, como preço de produto, frete e forma de entrega.
Listar clusters
GET https://api.dooki.com.br/v2/{alias}/customers/clusters
Request
{
    "name": "Sócios",  
    "active": true,
    "person_type": "f",
    "attach_on_signup": true,
    "min_order_value": "200",
    "base_price_percent": "17",
    "payments_ids": [1,2,3],
    "carriers_ids": [1,5,8], 
    "shipping_rules" : [
        {
            "country": "BR",
            "zipcode_min": 14940000,
            "zipcode_max": 15000000,
            "min_order_value": "300",
            "shipment_discount_percent": "13"
        }
    ]
​
}
Response
{
    "data": {
        "id": 9,
        "name": "Sócios",
        "active": true,
        "attach_on_signup": null,
        "person_type": "f",
        "min_order_value": "200",
        "base_price_percent": "17",
    }
}
Criar cluster
 Includes disponíveis: payments, carriers
POST https://api.dooki.com.br/v2/{alias}/customers/clusters
Parâmetro
Tipo
Obrigatório
Descrição
name
string
Sim
Nome do cluster.
active
boolean
Não
Status do cluster.
person_type
string
Sim
Tipo de pessoa ('f' para física e 'j' para jurídica).
attach_on_signup
boolean
Não
Associar automaticamente um cliente ao cluster.
min_order_value
float
Sim
Valor mínimo para compra
base_price_percent
float
Sim
Valor base de desconto.
shipping_rules
array
Não
Regras de entrega.
country
string
Sim
Código do país seguindo a padronização (ISO 3166-2).
zipcode_min
string
Sim
área minima do CEP para aplicar a regra.
zipcode_max
string
Sim
área máxima do CEP para aplicar a regra.
min_order_value
string
Sim
Valor mínimo para compra.
shipment_discount_percent
string
Sim
Valor base de desconto para entrega.
payments_ids
array
Não
IDS das formas de pagamento que serão aplicados os descontos.
carriers_ids
array
Não
IDS das formas de entregas que serão aplicados ao grupo de clientes.
Visualizar cluster
GET https://api.dooki.com.br/v2/{alias}/customers/clusters/{id}
Atualizar cluster
PUT https://api.dooki.com.br/v2/{alias}/customers/clusters/{id}
Visualizar cliente associados a um cluster
GET https://api.dooki.com.br/v2/{alias}/customers/clusters/{id}/customers
Associar cliente a um cluster
PUT https://api.dooki.com.br/v2/{alias}/customers/clusters/{id}/customers
Remover um cliente de um cluster
DELETE https://api.dooki.com.br/v2/{alias}/customers/clusters/{id}/customers
Você deverá enviar um json com os IDS dos clientes que deseja associar ou excluir.
Incluir ou excluir clientes de uma categoria
{
    "customers_ids": [1, 2, 3, 4, 5]
}
Regras de frete dos clusters
Listar regras de frete
GET https://api.dooki.com.br/v2/{alias}/customers/clusters/{cluster_id}/shipping-rules
Request
{
    "cluster_id": 9,
    "country": "BR",
    "zipcode_min": 14940000,
    "zipcode_max": 15000000,
    "min_order_value": "300",
    "shipment_percent": "13"
}
Response
{
    "data": {
        "id": 2,
        "cluster_id": 9,
        "country": "BR",
        "zipcode_min": 14940000,
        "zipcode_max": 15000000,
        "min_order_value": "300.00",
        "shipment_percent": 13,
    }
}
Criar regra de frete
POST https://api.dooki.com.br/v2/{alias}/customers/clusters/{cluster_id}/shipping-rules
Parâmetro
Tipo
Obrigatório
Descrição
cluster_id
int
Sim
Id do cluster.
country
string
Sim
Código do país seguindo a padronização (ISO 3166-2).
zipcode_min
string
Sim
área minima do CEP para aplicar a regra.
zipcode_max
string
Sim
área máxima do CEP para aplicar a regra.
min_order_value
float
Sim
Valor mínimo para compra.
shipment_percent
string
Sim
Valor base de desconto para entrega.
Visualizar regra de frete
GET https://api.dooki.com.br/v2/{alias}/customers/clusters/{cluster_id}/shipping-rules/{id}
Atualizar regra de frete
PUT https://api.dooki.com.br/v2/{alias}/customers/clusters/{cluster_id}/shipping-rules/{id}
Referência da API - Previous
Leads
Next - Referência da API
Buscas
Last updated 2 years ago
Parâmetro	Tipo	Obrigatório	Descrição
active	boolean	Sim	Status do cliente
marketplace_id	int	Não	ID do marketplace
cluster_id	int	Não	ID do cluster
type	string	Sim	Tipo da pessoa. Valores aceitos: `f` (pessoa física) e `j` (pessoa jurídica)
name	string	Não	Nome do cliente
razao_social	string	Não	Razão Social do cliente, caso seja pessoa jurídica
email	string	Sim	E-mail do cliente
cnpj	string	Sim (caso seja pessoa jurídica)	CNPJ do cliente
cpf	string	Sim (caso seja pessoa física)	CPF do cliente
homephone	string	Sim	Telefone ou celular do cliente
password	string	Sim	Senha de acesso do cliente
password_confirmation	string	Sim	Confirmação da senha
ip	string	Não	IP do cliente
utm_source	string	Não	Origem de acesso do cliente
utm_campaign	string	Não	Campanha de origem de acesso
notes	string	Não	Anotações sobre o cliente.
Parâmetro	Descrição
queue_id	ID da fila que está processando a exportação.
total	Número de registros a serem exportados.