Documentação

ADMINISTRAÇÃO DA LOJA

Nesta seção você encontrará a descrição dos serviços que permitem obter informação de uma loja de MercadoShops e administrar a sua estrutura.

Além disso, você encontrará a informação necessária para usar a API de métricas.

Indice

Info da loja Metricas Listar tracking_codes por usuário Obter um tracking_code por id Criar um tracking_code Modificar um tracking_code Eliminar um tracking_code

Info da loja

GET  /v1/shops/{SHOP_ID}?access_token={ACCESS_TOKEN} 
Obtenha a informação de uma loja no MercadoShops

Mostrar exemplo  
https://api.mercadoshops.com/v1/shops/{SHOP_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=**************
id
ID do usuário
Tipo
NUMERICO
status
Estado da loja
Tipo
STRING
Valores
active
Ativo
close
Fechado
locale
Idioma _ Código País
Tipo
STRING
Para obter a lista de códigos de países habilitados use este recurso:
https://api.mercadolibre.com/XXXX
shop_name
Nome da Loja
Tipo
STRING
email
E-mail de contato da loja
Tipo
STRING
plan
Tipo de plano contratado no MercadoShops
Tipo
STRING
admin_url
URL de administração da Loja
Tipo
STRING
url
URL da Loja
Tipo
STRING
has_logo
Tem logo
Tipo
BOOLEAN (true / false)
address
{
Descrição
Direção
Tipo
Objeto
country
Código do País
Tipo
STRING
Para obter a lista de códigos de países habilitados use este recurso:
https://api.mercadolibre.com/countries/
state
Código do estado/cidade do País
Tipo
STRING
Para obter a lista de códigos de estados/cidades de cada país use este recurso:
https://api.mercadolibre.com/countries/{CODIGO_PAIS}
zip
CEP
Tipo
STRING
address
Endereço
Tipo
STRING
phone
Telefone
Tipo
STRING
}
{
id
199999924,
status
active,
locale
pt_AR,
shop_name
"mercadoshops_demo",
email
"demo_demo@mercadoshops.com",
plan
"professional_plus",
admin_url
"http://admin.mercadoshops_demo.com.ar",
url
" http://mercadoshops_demo.com.ar ",
has_logo
true,
address
{
country
"AR",
state
"AR-B",
city
"Olivos",
zip
null,
address
"MI callle 1000 Dto 1",
phone
"+54911000099999"
}
}
ERROS :
403: Token Inválido ou SHOP_ID incorreto

Ferramentas da loja

Essa API permite administrar todos os códigos de rastreamento e ferramentas configurados na loja.

Indice:

Listar tracking_codes por usuário Obter um tracking_code por id Criar um tracking_code Modificar um tracking_code Eliminar um tracking_code

Ações

LISTAR TRACKING_CODES POR USUÁRIO

Retorna uma lista de todos os tracking_code ativos associados ao usuário, opcionalmente filtrada por event e/ou provider.

GET  /shops/{SHOP_ID}/metrics?event=$event&provider=$provider 

Mostrar exemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/ metrics?event={event}&provider={provider}&access_token={token} 

Parametros

ParâmetroValoresExemplo
access_token Código de segurança Access_token=APP_USR-4X30-XXXXX-275bbb6c084d53b8f9fc691770fda9b2__C_I__-15XXXX24
SHOP_ID Id da loja https://api.mercadoshops.com/v1/shops/{SHOP_ID}/ metrics?acess_token=**************
Event (opcional) NAVIGATION
BUY_BUTTON
CONTACT_BUTTON
PAY_BUTTON
CONGRAT_PAGE
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/ metrics?event=NAVIGATION&acess_token=**************
Provider (opcional) G_ANALYTICS
G_ADWORDS
M_CLICS
EBIT_SURVEY
EBIT_STAMP
FB_AD
OTHER
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/ metrics?provider=FB_AD&acess_token=**************
HTTP STATUS 200 OK
{
id
Id do código de rastreamento / ferramenta
Tipo
NUMERICO
shop_id
ID da loja
Tipo
NUMERICO
name
Nome que descreve o código de rastreamento
Tipo
STRING
code
Snippet HTML que incluirá na loja
Tipo
STRING
options
Mapa de opções, específico para o 'provider'
Tipo
STRING (JSON)
provider
Provedor do código de rastreamento / ferramenta
Tipo
STRING
Valores
G_ANALYTICS
G_ADWORDS
M_CLICS
EBIT_SURVEY
EBIT_STAMP
FB_AD
OTHER
event
Evento antes o qual é inserido o código de rastreamento / ferramenta dentro da loja.
Tipo
STRING
Valores
NAVIGATION: O código é inserido em todas as páginas da loja.
BUY_BUTTON: O código é inserido cada vez que o usuário adiciona um produto ao carrinho.
CONTACT_BUTTON: O código é inserido na página de contato da loja.
PAY_BUTTON: O código é inserido ao começar o processo de checkout.
CONGRAT_PAGE: O código é inserido na página de finalização da compra.
status
Estado de ativação
Tipo
STRING
Valores posibles
ACTIVE
INACTIVE
}
{
id
3***51,
shop_id
15****4,
name
Test API2,
code
"",
options
"",
provider
"OTHER",
event
"NAVIGATION",
status
"ACTIVE"
}
ERROS :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}
OBTER UM TRACKING_CODE POR ID

Retorna o código de rastreamento / ferramenta identificado por ID.

GET  /shops/{shop_id}/metrics/{id} 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/metrics?{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 da loja https://api.mercadoshops.com/v1/shops /15XXXXX24/
ID ID do código de rastreamento / ferramenta de busca https://api.mercadoshops.com/v1/shops /15XXXXX24/metrics/11111111?acess_token=**************
Retorna o tracking_code identificado por id.
HTTP STATUS 200 OK
{
id
3***9,
shop_id
15*****4,
name
"Test API",
code
"<!-- Begin test Embed Code --><!-- End testEmbed Code -->",
options
{
},
provider
"OTHER",
event
"NAVIGATION",
status
"ACTIVE"
}
ERROS :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}
CRIAR UM TRACKING_CODE

Cria um código de rastreamento / ferramenta e devolve o objeto criado.

POST  HEADER: Content-Type: application/json
     /v1/shops/{shop_id}/metrics 

Mostrar exemplo 
https://api.mercadoshops.com/v1/shops/{shop_id}/metrics?access_token={token}
Retorna o tracking_code identificado por id.
HTTP STATUS 201 CREATED
{
shop_id
1******24,
name
"Test API",
code
"<!-- Begin test Embed Code --><!-- End testEmbed Code -->",
options
{
},
provider
"OTHER",
event
"NAVIGATION",
status
"ACTIVE"
}
ERROS :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}
MODIFICAR UM TRACKING_CODE

Modifica um código de rastreamento / ferramenta e devolve o objeto modificado.

PUT  HEADER :  Content-Type: application/json                      
     /shops/{shop_id}/metrics/{id} 

Mostrar exemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/metrics?{id}&access_token={token}

Para modificar uma característica do tracking criado deve-se fazer um PUT para a url indicada com um JSON que inclua a característica e o seu novo valor
Exemplo de JSON de mudança de característica [name]:
{name: "Test API2 - CHANGED"}

Retorna o tracking_code modificado por id.
HTTP STATUS 200 OK
{
name
"Test API2 - CHANGED",
}
ERROS :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}
404 Not found: {"error": "Tracking code not found"} 
ELIMINAR UM TRACKING_CODE

Elimina um código de rastreamento / ferramenta

DELETE  /shops/{shop_id}/metrics/{id} 

Mostrar exemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/metrics?{id}&access_token={token}
HTTP STATUS 204 NO CONTENT
ERROS :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}