Documentação do Mercado Livre

Confira todas as informações necessárias sobre as APIs Mercado Livre.
circulos azuis em degrade

Documentação do

Última atualização em 14/03/2023

Gerenciamento de Perguntas e Contatos

Toda vez que os usuários fazem uma busca nos anúncios classificados (imóveis, automóveis e serviços), eles podem contatar o proprietário do anúncio por meio de um formulário exibido na publicação (perguntas e respostas) podem ver o telefone do proprietário (ver telefone) e entrar em contato pelo WhatsApp. No caso da pergunta, quando ela é feita, é direcionada automaticamente à caixa de entrada de mensagens, dentro da conta do cliente no Mercado Livre. É muito importante que a sua integração leia as perguntas, e também permita que os usuários consigam respondê-las pelo seu sistema. Para saber como trabalhar com perguntas e respostas (leads), consulte nosso guia de Gerenciamento de perguntas e respostas. Aqui tem todo o conteúdo necessário para você realizar a integração de leads do Mercado Livre. Além deste guia mencionado acima, você pode fazer consultar dados sobre perguntas e fazer um registro de quantos cliques tiveram as opções Ver telefone e Whatsapp . Estes métodos são detalhados mais abaixo. Lembre-se que os anúncios possuem um botão “Ligar” (somente no mobile) e o comprador aciona este botão, é gerada uma nova pergunta, na mesma API de perguntas e respostas.

Descrição de parâmetros

Tipo Parâmetro Descrição
Integer {userId} ID de usuário.
Integer {itemId} ID do anúncio.
Date {dateFrom} Data, no formato ISO, que define o início da consulta.
Date {dateTo} Data, no formato ISO, que define o final da consulta.
Integer {limit} Opcional. Quantidade máxima de anúncios a devolver.
Integer {offset} Opcional. Paginação.
Integer {last} Opcional. Denota quantas horas/dias a amostra abrangerá.
String {unit} Unidade de consulta, valores possíveis: [“dia”, “hora”].
Date {ending} Opcional. Data, em formato ISO, estabelecendo o tempo de finalização da amostra; por padrão, deve ser a data e a hora atuais.
String {order} Opcional. Classifica os resultados por data: [“desc”, “asc”] (por padrão, “asc”).


Total de perguntas

Você pode acessar o total de perguntas que um anúncio teve, ou o total de perguntas recebidas por um vendedor em todos os seus anúncios, em um intervalo de tempo.


Por anúncios

curl -X GET https://api.mercadolibre.com/items/$ITEM_ID/contacts/questions?date_from=$DATE_FROM&date_to=$DATE_TO


Por usuário

curl -X GET https://api.mercadolibre.com/users/$USER_ID/contacts/questions?date_from=$DATE_FROM&date_to=$DATE_TO

Exemplo:

curl -X GET https://api.mercadolibre.com/items/MLV421672596/contacts/questions?date_from=2014-08-01T00:00:00.000-03:00&date_to=2014-08-02T23:59:59.999

Resposta:

{
    "date_from": "2014-08-01T00:00:00.000-03:00",
    "date_to": "2014-08-02T23:59:59.999",
    "item_id": "MLV421672596",
    "total": 9
}

Perguntas por data

Este recurso permite acessar as perguntas sobre um determinado anúncio ou vendedor durante um intervalo de tempo especificado. Além disso, você obtém detalhes sobre contatos feitos em modo convidado (usuários que não fizeram login ou não são cadastrados), em intervalos de tempo, por hora ou por dia.


Por anúncio

curl -X GET https://api.mercadolibre.com/items/$ITEM_ID/contacts/questions/time_window?last=$LAST&unit=$UNIT

Caso você precise concatenar anúncios, faça o seguinte:

curl -X GET https://api.mercadolibre.com/items/$ITEM_ID/contacts/questions/time_window?ids=$ID1,ID2&last=$LAST&unit=$UNIT&ending=$ENDING_DATE


Por usuário

curl -X GET https://api.mercadolibre.com/users/$USER_ID/contacts/questions/time_window?last=$LAST&unit=$UNIT

Exemplo:

curl -X GET https://api.mercadolibre.com/items/MLA510272257/contacts/questions/time_window?last=2&unit=hour

Resposta:

{
    "item_id": "MLA510272257",
    "total": 0,
    "date_from": "2014-08-06T12:00:00Z",
    "date_to": "2014-08-06T14:00:00Z",
    "last": 2,
    "unit": "hour",
    "results": [
        {
            "date": "2014-08-06T12:00:00Z",
            "total": 0
        },
        {
            "date": "2014-08-06T13:00:00Z",
            "total": 0
        }
    ]
}

Total de telefones de contato

Você pode acessar o total de cliques da opção Ver telefone de um anúncio, ou para cada um dos anúncios de um usuário, em intervalos de tempo.


Por anúncio

curl -X GET https://api.mercadolibre.com/items/$ITEM_ID/contacts/phone_views?date_from=$DATE_FROM&date_to=$DATE_TO


Por usuário

curl -X GET https://api.mercadolibre.com/users/$USER_ID/contacts/phone_views?date_from=$DATE_FROM&date_to=$DATE_TO

Exemplo:

curl -X GET https://api.mercadolibre.com/users/52366166/contacts/phone_views?date_from=2014-05-28T00:00:00.000-03:00&date_to=2014-05-29T23:59:59.999

Resposta:

{
    "date_from": "2014-05-28T00:00:00.000-03:00",
    "date_to": "2014-05-29T23:59:59.999",
    "total": 71,
    "user_id": "52366166"
}


Telefones de contato por data

Você pode acessar o total de cliques da opção Ver telefone de um anúncio, ou para cada um dos anúncios de um usuário, durante um determinado intervalo de tempo. Além de fornecer o total de visitas, as informações são listadas e agrupadas por intervalos de tempo.


Por anúncio

curl -X GET https://api.mercadolibre.com/items/$ITEM_ID/contacts/phone_views/time_window?last=$LAST&unit=$UNIT

Caso você precise concatenar anúncios, faça o seguinte:

curl -X GET https://api.mercadolibre.com/items/contacts/phone_views/time_window?ids=$ID1,ID2&last=$LAST&unit=$UNIT&ending=$ENDING_DATE


Por usuário

curl -X GET https://api.mercadolibre.com/users/$USER_ID/contacts/phone_views/time_window?last=$LAST&unit=$UNIT

Exemplo:

curl -X GET https://api.mercadolibre.com/items/contacts/phone_views/time_window?ids=MLA510272257,MLA489747739&last=2&unit=hour&ending=2014-05-28T00:00:00.000-03:00

Resposta:

[
      {
          "item_id": "MLA510272257",
          "total": 0,
          "date_from": "2014-05-28T02:00:00Z",
          "date_to": "2014-05-28T04:00:00Z",
          "last": 2,
          "unit": "hour",
          "results": [
              {
                  "date": "2014-05-28T02:00:00Z",
                  "total": 0
              },
              {
                  "date": "2014-05-28T03:00:00Z",
                  "total": 0
              }
          ]
      },
      {
          "item_id": "MLA489747739",
          "total": 0,
          "date_from": "2014-05-28T02:00:00Z",
          "date_to": "2014-05-28T04:00:00Z",
          "last": 2,
          "unit": "hour",
          "results": [
              {
                  "date": "2014-05-28T02:00:00Z",
                  "total": 0
              },
              {
                  "date": "2014-05-28T03:00:00Z",
                  "total": 0
              }
          ]
      }
  ]
Estrutura Errores 400:

Resposta:

{
 "code":"bad_request",
 "message":"error decoding 'user_id'. It must be string or number"
}

Cliques no botão de Whatsapp

Pode-se acessar o número total de vezes que a opção WhatsApp foi clicada para uma publicação ou para cada artigo por um usuário em intervalos de datas.


Por publicação

Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'  https://api.mercadolibre.com/items/$ITEM_ID/contacts/whatsapp?date_from=$DATE_FROM&date_to=$DATE_TO

Exemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'  https://api.mercadolibre.com/items/MLA1116194549/contacts/whatsapp?date_from=2014-05-28T00:00:00.000-03:00&date_to=2014-05-29T23:59:59.999

Resposta:

{
    "total": 3,
    "date_from": "2022-10-14T17:01:00Z",
    "date_to": "2022-10-29T17:01:00Z",
    "item_id": "MLA1116194549"
}


Por usuário

Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'  https://api.mercadolibre.com/users/$USER_ID/contacts/phone_views?date_from=$DATE_FROM&date_to=$DATE_TO

Exemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'  https://api.mercadolibre.com/users/127232529/contacts/phone_views?date_from=2014-05-28T00:00:00.000-03:00&date_to=2014-05-29T23:59:59.999

Resposta:

{
    "total": 174,
    "date_from": "2022-10-14T17:01:00Z",
    "date_to": "2022-10-29T17:01:00Z",
    "user_id": "127232529"
}


Cliques em botão de WhatsApp com data

Pode-se acessar o número total de vezes que o botão WhatsApp foi clicado para uma publicação ou para cada anúncio de um usuário durante um determinado período de tempo. Além de entregar o total de cliques, as informações são detalhadas e agrupadas por intervalo de tempo.


Por publicação

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/items/$ITEM_ID/contacts/whatsapp/time_window?unit=$UNIT&last=$LAST

Se precisar consultar várias publicações:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/items/contacts/whatsapp/time_window?ids=$IDS&unit=$UNIT&last=$LAST&ending=$ENDING

Parâmetros

ids: requerido. Indica os IDs dos itens quando a busca é feita por múltiplas publicações, eles são separados por vírgulas.

last: obrigatório.Indica quantas horas/dias atrás irá conter a mostra.

unit: obrigatório.Indica quantas horas/dias atrás irá conter a mostra. requerido. Unidade de consulta, valores possíveis: [“day”, “hour”].

ending: opcional. Data, em formato ISO, que estabelece o tempo de conclusão da mostra; por padrão é a data e hora atual.


Por usuário

Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/$USER_ID/contacts/whatsapp/time_window?unit=$UNIT&last=$LAST

Exemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/127232529/contacts/whatsapp/time_window?unit=$UNIT&last=$LAST

Resposta:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
 {
    "total": 31,
    "last": "3",
    "unit": "day",
    "date_from": "2022-10-26T04:00:00Z",
    "date_to": "2022-10-29T04:00:00Z",
    "user_id": "127232529",
    "results": [
        {
            "date": "2022-10-26T04:00:00Z",
            "total": 7
        },
        {
            "date": "2022-10-27T04:00:00Z",
            "total": 16
        },
        {
            "date": "2022-10-28T04:00:00Z",
            "total": 8
        }
    ]
}

Visitas por publicação

Para consultar as visitas por anúncio, utilize o artigo sobre o Recurso Visits.


Próximo:
Recebimento de notificações.