Detalhes

Descrição dos campos

Campo	Requerido	Único	Tipo do campo	Max Caracteres	Descrição
id		✅	Int4		ID do cliente
uuid		✅	Varchar	36	UUID do cliente
reference_code			Varchar	64	Código de referência do cliente no ERP
email	✅	✅	Varchar	255	E-mail do cliente
document			Varchar	15	Documento do cliente (CPF)
name			Varchar	255	Nome do cliente
birthdate			Date		Data de Nascimento
gender			Int		Feminino (1) Masculino (2) Outros (3) Prefiro não dizer (4)
blocked			Boolean	1	Indica se o cliente está bloqueado default = false
newsletter			Int4		Indica se o cliente quer receber newsletter (1 = SIM, 2 = NÃO, 0 = NÃO)
group			Int4		ID do grupo do cliente
zipcode			Varchar	9	CEP
address			Varchar	100	Endereço
number			Varchar	100	Número
neighborhood			Varchar	100	Bairro
complement			Varchar	100	Complemento
city			Varchar	100	Cidade
state			Varchar	2	Estado
phone1			Varchar	20	Telefone
phone2			Varchar	20	Telefone 2
reference			Varchar	255	Ponto de Referencia
receiver			Varchar	100	Destinatário
city_id			Varchar	50	ID da cidade
code_ibge			Varchar	50	Código do IBGE da cidade
limit_credit			Numeric	10,2	Limite de Crédito
balance_of_credit			Numeric	10,2	Saldo de Crédito
corporate_name			Varchar	120	Razão Social
corporate_document			Numeric	20	CNPJ
inscricao_estadual_isento			Boolean	1	Inscrição Estadual Isento
inscricao_estadual			Varchar	25	Inscrição Estadual
fancy_name			Varchar	255	Nome Fantasia
gdpr_agreement			Boolean	1	Acordo GDPR
extra_data			Text		Campo extra

Filtros via Query Parameters

Parameter	Description
id	ID do cliente
reference_code	Código de referência no ERP
group	Filtro por ID do grupo do cliente
newsletter	Filtro pelo campo newsletter
add_date__lte	Filtro por data de criação menor ou igual - YYYY-MM-DD H:M:S
add_date__gte	Filtro por data de criação maior ou igual - YYYY-MM-DD H:M:S
change_date__lte	Filtro por data de alteração menor ou igual - YYYY-MM-DD H:M:S
change_date__gte	Filtro por data de alteração maior ou igual - YYYY-MM-DD H:M:S
uuid	Filtro por uuid do cliente
email	Filtro por E-mail do cliente
orders__isnull	Filtro cliente com pedidos, (0) = com pedido, (1) = sem pedido

Exemplos

using RestSharp;
var client = new RestClient("https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/");

var request = new RestRequest("/customers/");
request.Method = Method.GET;
request.AddHeader("Authorization", "Token " + API_KEY);

var response = client.Execute(request);

curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/customers/"
  -H "Authorization: Token API_KEY"

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/customers/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()

O comando acima retornar um JSON conforme estrutura abaixo:

{
   "id":138468,
   "reference_code":null,
   "email":"[email protected]",
   "document":null,
   "corporate_document":null,
   "name":"Nome do cliente",
   "corporate_name":null,
   "inscricao_estadual_isento":false,
   "inscricao_estadual":null,
   "fancy_name":null,
   "birthdate":null,
   "gender":null,
   "blocked":false,
   "newsletter":0,
   "gdpr_agreement":true,
   "receiver":"Nome do cliente",
   "zipcode":null,
   "address":null,
   "number":null,
   "neighborhood":null,
   "complement":null,
   "city":null,
   "state":null,
   "phone1":null,
   "phone2":null,
   "reference":null,
   "city_id":null,
   "code_ibge":null,
   "add_date":"2022-08-16T21:39:49.815105",
   "change_date":"2022-08-16T21:39:49.815135",
   "limit_credit":null,
   "balance_of_credit":null,
   "group":null,
   "extra_data": null
}