Personas Interesadas

El recurso /vis/users/$USER_ID/leads/seller permite al vendedor obtener datos de contacto de los compradores interesados en sus publicaciones. Para recibir notificaciones sobre los clientes interesados, debes suscribirte al tópico VIS Leads, y después de recibir la notificación consultar el recurso de /leads.

Consultar interesados en los ítems del vendedor

Ahora, el vendedor puede consultar todos los datos de contacto de los interesados, con la posibilidad de paginarlos mediante el parámetro offset, que indica la posición del primer elemento a traer, y el parámetro limit, que señala la cantidad máxima de elementos a obtener. Además, los datos pueden ser filtrados por un período de tiempo específico, usando los parámetros date_from y date_to. Para una búsqueda más específica, se puede utilizar el parámetro contac_types, que representa el tipo de contacto a retornar.

Llamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/vis/users/$USER_ID/leads/buyers?offset=$OFFSET&limit=$LIMIT&date_from=$DATE_FROM&date_to=$DATE_TO&contact_types=$CONTACT_TYPES

Ejemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/vis/users/806525693/leads/buyers?offset=0&limit=10&dateFrom=2023-06-15&dateTo=2023-06-22&contact_types=true&contac_types=credit,question,whatsapp

Valores de entrada

Campos de la respuesta

• results: contiene listado de resultados.
• results.id: identificador del comprador.
• results.item_id: identificador del ítem.
• results.name: nombre del comprador. Solo si el acceso es público.
• results.email: email del comprador. Solo si el acceso es público.
• results.phone: número de identificación del comprador. Solo si el acceso es público.
• results.identification_number: teléfono del comprador. Solo si el acceso es público.
• results.identification_type: tipo de identificación del comprador. Solo si el acceso es público.
• results.leads: contiene listado de leads generados por el comprador.
• leads.id: identificador del lead.
• leads.external_id: identificador externo del lead.
• leads.contact_type: tipo de lead.
• leads.item_id: identificador del ítem.
• leads.created_at: fecha de creación del lead.
• leads.status: estado del lead.
• paging: contiene información del paginado.
• paging.offset: posición del primer elemento a retornar.
• paging.limit: cantidad de elementos máximos por página.
• paging.total: cantidad de elementos totales.
• date_from: fecha inicial de resultados.
• date_to: fecha final de resultados.

Tipos de Leads Disponibles (contact_types)

• whatsapp: un comprador apreta el botón de WhatsApp.
• question: un comprador hace una pregunta.
• call: un comprador apreta el botón de llamar.
• credit: simulación de crédito.

Respuesta:

{
    "results": [
        {
            "id": 2678328,
            "item_id": "MLA1430828018",
            "name": "John Doe",
            "email": "jhon@example.com",
            "phone": "+5491198765432",
            "leads": [
                {
                    "id": "6b4aebf8-5570-47b8-9224-c1c177621575",
                    "contact_type": "question",
                    "created_at": "2024-05-14T14:15:39Z",
                    "external_id": "12776297658",
                    "item_id": "MLA1430828018",
                    "buyer_id": 2678328,
                    "status": "active"
                }
            ]
        }
    ],
    "paging": {
        "offset": 0,
        "limit": 10,
        "total": 1
    },
    "date_from": "2024-05-14",
    "date_to": "2024-05-24"
}

Posibles errores

Errores en la búsqueda de interesados.

Obtener detalle de un lead

Cuando Mercado Libre notifica de la creación de un nuevo lead relacionado a los interesados, lo hace mencionando el ID en el mensaje, para obtener el detalle debes usar dicho identificador en el recurso /vis/leads/$LEAD_ID. El cual te proporcionará el detalle correspondiente.

Llamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/vis/leads/$LEAD_ID

Ejemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/vis/leads/3f2dedf2-dfbd-4981-a726-40b13aa172ff

Valores de entrada

Campos de la respuesta

• id: identificador del lead.
• contact_type: tipo de lead.
• item_id: identificador del ítem.
• created_at: fecha de creación del lead.
• external_id: identificador externo del lead.
• status: estado del lead.
• buyer_id: identificador del comprador.
• name: nombre del comprador. Solo si el acceso es público.
• email: email del comprador. Solo si el acceso es público.
• phone: teléfono del comprador. Solo si el acceso es público.

Respuesta: HTTP 200

{
    "id": "44115522",
    "item_id": "MLB4037459422",
    "created_at": "2024-02-14T00:00:00Z",
    "contact_type": "whatsapp",
    "external_id": "13864821",
    "status": "active",
    "buyer_id": 1091441589,
    "name": "Test Test",
    "email": "john@example.com",
    "phone": "+55 01 1111-1111"
}

Posibles errores

Errores en la búsqueda del detalle de un lead.