Documentação

CLIENTES

Nesta seção você encontrará a descrição dos serviços que permitem obter informação de um cliente, tanto do MercadoLivre quanto da loja.

Indice

Info do Cliente Busca
INFO DO CLIENTE
GET  /v1/shops/{SHOP_ID}/clients/{CLIENT_ID} 

Mostrar exemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/clients/{client_id}?access_token={token}

Parâmetros

ParâmetroValoresExemplo
access_token Código de segurança Access_token=APP_USR-4X30-XXXXX-275bbb6c084d53b8f9fc691770fda9b2__C_I__-15XXXX24
SHOP_ID Id do usuário https://api.mercadoshops.com/v1/shops /15XXXXX24?acess_token=**************
CLIENT_ID Id do cliente https://api.mercadoshops.com/v1/shops /15XXXXX24/clients/9999999?acess_token=**************
{
id_unique
ID único do cliente, não repetido entre as lojas distintas
Tipo
NUMERICO
id
Id do cliente
Tipo
NUMERICO
store_id
Id da loja
Tipo
NUMERICO
name
Nome completo do cliente. Somente disponível quando status <> "hidden"
Tipo
STRING
meli_cust_id
ID do usuário no MercadoLivre do cliente. Somente disponível quando meli_client = true e status <> "hidden".
Tipo
NUMERICO
nickname
Apelido do cliente. Somente disponível quando meli_client = true e status <> "hidden".
Tipo
NUMERICO
type
Tipo de Cliente
Tipo
STRING
Valores Possíveis
contact
Cliente que só fez perguntas
buyer
Cliente que fez compras
mshops_client
Indica se é um cliente que teve alguma atividade por meio da loja (compras ou perguntas)
Tipo
BOOLEAN
Valores Possíveis
"true"
"false"
meli_client
Indica se é um cliente que teve alguma atividade por meio do MercadoLivre (compras ou perguntas)
Tipo
BOOLEAN
Valores Possíveis
"true"
"false"
status
Estado do cliente
Tipo
BOOLEAN
Valores Possíveis
hidden
Cliente que só teve interação por meio de perguntas pelo MercadoLivre
active
Cliente que fez compras na loja e/ou MercadoLivre, ou que fez perguntas a partir da loja
inactive
Cliente manualmente eliminado a partir do administrador de clientes
last_activity_date
Data da última atividade do cliente
Tipo
Date(ISO_8601)
unsubscribe_date
Data em que o cliente modificou o status = "inativo"
Tipo
Date(ISO_8601)
comments
Comentários inseridos a partir do administrador de clientes
Tipo
STRING
}
{
id_unique
9999999,
id
888888888,
store_id
159999999999,
name
"Carlos Perez",
meli_cust_id
5999999999,
nickname
null,
type
"contact",
mshops_client
false,
meli_client
true,
status
"hidden",
last_activity_date
null,
unsubscribe_date
null,
comments
null
}
ERROS :
403: Token Inválido o SHOP_ID incorreto
BUSCA DE CLIENTES
GET  /v1/shops/{SHOP_ID}/clients/search?query={palabra}&access_token={ACCESS_TOKEN} 

Mostrar exemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/clients/search?query={palabra}&access_token={token}

Parâmetros

ParâmetroValoresExemplo
access_token Código de segurança Access_token=APP_USR-4X30-XXXXX-275bbb6c084d53b8f9fc691770fda9b2__C_I__-15XXXX24
SHOP_ID Id do usuário https://api.mercadoshops.com/v1/shops /15XXXXX24?acess_token=**************
query Id do cliente https://api.mercadoshops.com/v1/shops /15XXXXX24/clients/search?query=carlos?acess_token=**************

PAGINAÇÃO E ORDENAÇÃO

NomeValoresExemplo
limit Limite de registros devolvidos limit=10
orders name_asc

Ordem por nome crescente

name_desc

Ordem por nome decrescente

id_desc

Ordem id Decrescente
orders=name_asc
{
seller_id
Id da loja
Tipo
NUMERICO
query
Palavra a procurar
Tipo
STRING
paging
{
Descrição
Resumo da paginação
Tipo
OBJECTO
total
Total de resultados devolvidos
Tipo
NUMERICO
offset
Offset aplicado
Tipo
NUMERICO
limit
Limite de resultados aplicado
Tipo
NUMERICO
},
{
purchases
{
Descrição
Informação sobre as compras feitas pelo cliente.
Tipo
OBJETO
quantity
Quantidade de compras feitas pelo cliente
Tipo
NUMERICO
},
phone
Telefone
Tipo
STRING
status
Estado cliente
Tipo
STRING
Valores Possíveis
"active"
"inactive"
"hidden"
nickname
Apelido. Para registros meli_client = true
Tipo
STRING
unsubscribe_date
Data Baixo
Tipo
Date(ISO_8601)
asked_questions
Número de perguntas
Tipo
NUMERICO
store_id
Id da loja
Tipo
NUMERICO
doc_type
Tipo de Documento
Tipo
STRING
last_activity_date
Data da última atividade
Tipo
Date(ISO_8601)
phone2
Telefone 2
Tipo
STRING
type
tipo de cliente
Tipo
STRING
Valores Possíveis
"buyer"
"contact"
mshops_client
Cliente de Mercadoshops
Tipo
STRING
Valores Possíveis
"true"
"false"
email2
Email 2
Tipo
STRING
id
ID do usuário
Tipo
NUMERICO
doc_number
Numero de documento
Tipo
STRING
meli_client
Cliente de MercadoLibre
Tipo
STRING
Valores Possíveis
"true"
"false"
name_for_sort
Sistema de nomes
Tipo
STRING
email
Email 2
Tipo
STRING
name
nome verdadeiro
Tipo
STRING
meli_cust_id
meli_cust_id
Tipo
NUMERICO
comments
avaliações
Tipo
STRING
},
orders
[],
filters
[
],
available_orders
[],
available_filters
[
],
}
{
seller_id
1999999999,
query
"Carlos",
paging
{
total
50,
offset
0,
limit
10,
},
results
[
{
purchases
{
quantity
0
},
phone
"19999999999",
status
"active",
nickname
"CAR99999999992",
unsubscribe_date
"2015-04-22T15:37:30.372-04:00",
asked_questions
1,
store_id
15999999999,
doc_type
"null",
last_activity_date
"2015-04-15T10:08:58.000-04:00",
phone2
null,
type
"buyer",
mshops_client
false,
email2
null,
id
29999999993,
doc_number
"null",
meli_client
true,
name_for_sort
"carlos perez",
email
"ccccc@hotcccc.com",
name
"carlos perez",
meli_cust_id
100000365,
comments
null,
},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
orders
[],
filters
[
],
available_orders
[],
available_filters
[
],
}
ERROS :
403: Token Invalido o SHOP_ID incorreto