Lista os clientes

GET

/api/v2/clients

• Servidor do ambiente de produção
• Servidor do ambiente de testes

Retorna uma lista de clientes. Caso seja informado o parâmetro “email”, então apenas o cliente com esse email será retornado

Authorizations

• Token
• X-Shop-Host

Parameters

Query Parameters

email

deprecated

string format: email

Retorna somente o cliente com o email informado

page

integer

Número da página

per_page

integer

Registros por página

min_updated_at

string format: date-time

Filtra os clientes pela menor data de atualização

max_updated_at

string format: date-time

Filtra os clientes pela maior data de atualização

birthday_start

string format: date-time

Data de inicío da filtragem de clientes pela data de aniversário

birthday_end

string format: date-time

Data final da filtragem de clientes pela data de aniversário

has_phone

string

Filtra os clientes que possuem telefone

has_first_name

string

Filtra os clientes que possuem first name

user_id

integer

Filtra os clientes por vendedor

term

string

Filtra os clientes que possuem o termo em alguns dos campos

sort

string

Allowed values: name birthdate

Ordena o resultado da busca de clientes conforme a opção escolhida

Responses

200

Quando os clientes são encontrados

Array<object>

Client

Modelo que representa um cliente na API

object

id

integer

first_name

string

last_name

string

email

string format: email

gender

string

phone_area

string

/[0-9]+/

phone

string

/[0-9]+/

document_type

string

Allowed values: CPF CNPJ

document_number

Número de documento cadastrado pelo cliente

string

cpf

string

/[0-9]+/

cnpj

string

/[0-9]+/

ie

string

tags

string

lists

Array<string>

facebook_uid

string

liked_facebook_page

boolean

updated_at

string format: date-time

birthdate

string format: date

recent_address

Array<object>

object

id

string

first_name

string

last_name

string

company_name

string

street_name

string

street_number

string

neighborhood

string

complement

string

reference

string

city

string

state

string

zip

string

first_phone_area

string

first_phone

string

second_phone_area

string

second_phone

string

email

string

documents

object

cpf

string

cnpj

string

auth_token

string

last_confirmed_order_at

string format: date-time

received_orders_count

integer

confirmed_orders_count

integer

canceled_orders_count

integer

renew_password

boolean