Mercately Retailers API (1.0.0)

Download OpenAPI specification:Download

Introduction

La plataforma para desarrolladores de Mercately, está creada para ayudar a todos nuestros clientes y empoderarlos para que crezcan mejor. Nuestras API están diseñadas para permitir que los equipos de cualquier forma o tamaño construyan integraciones y aprovechar al máximo Mercately. Todas las API de Mercately se construyen usando convenciones REST y están diseñadas para tener una estructura de URL predecible. U tilizan muchas funciones HTTP estándar, incluidos métodos (POST, GET, PUT, DELETE) y códigos de respuesta de error.

Agents

En Mercately, los agentes son conocidos como las personas que están en tu equipo de trabajo. Los agentes pueden estar atados a varios otros objetos como conversaciones, notas, tratos del embudo u órdenes. Este endpoint te devolverá datos necesarios del agente a ser usados en otros endpoints.

Agents

Obtén los datos de tus agentes

Securityapi-key
Responses
200

OK

400

Unauthorized

get/retailers/api/v1/agents
Request samples
Response samples
application/json
{
  • "agents": [
    ]
}

Customers

En Mercately, todo contacto proveniente de conversaciones, compras o creados directamente se clasifica como cliente. Este endpoint proporciona y permite la actualización de datos del cliente.

Customers

Obtén los datos de todos tus clientes

Securityapi-key
Request
query Parameters
page
number

busca la pagina específica de clientes

start_date
string <date>

Fecha inicial de búsqueda en formato YYYY-MM-DD

end_date
string <date>

Fecha final de búsqueda en formato YYYY-MM-DD

Responses
200

OK

400

Unauthorized

get/retailers/api/v1/customers
Request samples
Response samples
application/json
{
  • "results": 1,
  • "total_pages": 1,
  • "customers": [
    ]
}

Create Customers

Crea un nuevo cliente

Securityapi-key
Request
Request Body schema: application/json
first_name
string
last_name
string
email
string
phone
string
id_type
string
Enum: "cedula" "pasaporte" "ruc" "rut" "otro"
id_number
string
address
string
city
string
state
string
zip_code
string
notes
string
agent_id
integer
Array of objects
Array of objects
creation_date
string <date>
Responses
200

OK

400

Unauthorized

post/retailers/api/v1/customers
Request samples
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "id_type": "cedula",
  • "id_number": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip_code": "string",
  • "notes": "string",
  • "agent_id": 0,
  • "tags": [
    ],
  • "custom_fields": [
    ],
  • "creation_date": "2019-08-24"
}
Response samples
application/json
{
  • "message": "Customer created successfully",
  • "customer": {
    }
}

Customer/:id

Obtén los datos de un cliente en especifico buscado por ID

Securityapi-key
Responses
200

OK

400

Unauthorized

404

Not found

get/retailers/api/v1/customers/:id
Request samples
Response samples
application/json
{
  • "message": "Customer found successfully",
  • "customer": {
    }
}

Customer/:email

Obtén los datos de un cliente en especifico buscado por email

Securityapi-key
Responses
200

OK

400

Unauthorized

404

Not found

get/retailers/api/v1/customers/:email
Request samples
Response samples
application/json
{
  • "message": "Customer found successfully",
  • "customer": {
    }
}

Customer/:phone

Obtén los datos de un cliente en especifico buscado por phone

Securityapi-key
Responses
200

OK

400

Unauthorized

404

Not found

get/retailers/api/v1/customers/:phone
Request samples
Response samples
application/json
{
  • "message": "Customer found successfully",
  • "customer": {
    }
}

Update Customer by email, id or phone

Actualiza un nuevo customer buscado por email, id o phone. Puedes realizar la busqueda igual que los métodos get

Securityapi-key
Request
Request Body schema: application/json
first_name
string
last_name
string
email
string
phone
string
id_type
string
Enum: "cedula" "pasaporte" "ruc" "rut" "otro"
id_number
string
address
string
city
string
state
string
zip_code
string
notes
string
agent_id
integer
Array of objects
Array of objects
creation_date
string <date>
Responses
200

OK

400

Unauthorized

put/retailers/api/v1/customers/:phone
Request samples
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "id_type": "cedula",
  • "id_number": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip_code": "string",
  • "notes": "string",
  • "agent_id": 0,
  • "tags": [
    ],
  • "custom_fields": [
    ],
  • "creation_date": "2019-08-24"
}
Response samples
application/json
{
  • "message": "Customer updated successfully",
  • "customer": {
    }
}

Messenger

En Mercately, una vez vinculado con Messenger, este api permite realizar múltiples operaciones para acceder a las conversaciones de Messenger.

Messenger conversations

Obtén los clients que te han escrito por messenger

Securityapi-key
Request
Request Body schema: application/json
page
number
results_per_page
number
unassigned
boolean
Responses
200

OK

400

Unauthorized

get/retailers/api/v1/messenger_conversations
Request samples
application/json
{
  • "page": 0,
  • "results_per_page": 0,
  • "unassigned": true
}
Response samples
application/json
{
  • "results": 155,
  • "total_pages": 2,
  • "messenger_conversations": [
    ]
}

WhatsApp

En Mercately, una vez vinculado con WhatsApp, este api permite realizar múltiples operaciones para acceder a las conversaciones de WhatsApp y enviar mensajes.

Whatsapp conversations

Obtén los clients que te han escrito por whatsapp

Securityapi-key
Request
Request Body schema: application/json
page
number
results_per_page
number
unassigned
boolean
Responses
200

OK

400

Unauthorized

get/retailers/api/v1/whatsapp_conversations
Request samples
application/json
{
  • "page": 0,
  • "results_per_page": 0,
  • "unassigned": true
}
Response samples
application/json
{
  • "results": 155,
  • "total_pages": 2,
  • "messenger_conversations": [
    ]
}

WhatsApp Business Api Templates

Obtén los templates/plantillas creadas en WhatsApp Business API

Securityapi-key
Request
Request Body schema: application/json
object (WhatsApp Business Api templates)
Responses
200

OK

400

Unauthorized

get/retailers/api/v1/whatsapp_templates
Request samples
application/json
{ }
Response samples
application/json
{
  • "templates": [
    ]
}

Send WhatsApp Message for WhatsApp Business API

Para enviar un mensaje de WhatsApp cuando se tiene una conexión oficial al API de WhatsApp, sólo se requieren los parámetros phone_number, internal_id y template_params; los demás son opcionales. Si se tiene una conexión vía QR, por favor revisa la sección de envío de mensajes vía QR.

Securityapi-key
Request
Request Body schema: application/json
phone_number
string
internal_id
string
template_params
Array of strings
media_url
string
first_name
string
last_name
string
email
string
address
string
city
string
state
string
zip_code
string
notes
string
agent_id
number
Array of objects
Array of objects
Responses
200

OK

400

Unauthorized

post/retailers/api/v1/whatsapp/send_notification_by_id
Request samples
application/json
{
  • "phone_number": "string",
  • "internal_id": "string",
  • "template_params": [
    ],
  • "media_url": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip_code": "string",
  • "notes": "string",
  • "agent_id": 0,
  • "tags": [
    ],
  • "custom_fields": [
    ]
}
Response samples
application/json
{
  • "message": "Ok",
  • "info": {
    }
}

Send WhatsApp Message for WhatsApp Business QR

Enviar un mensaje de WhatsApp cuando tienes una conexión oficial por QR. Los únicos parametros requeridos son phone_number y message, el resto de parámetros son opcionales.

Securityapi-key
Request
Request Body schema: application/json
phone_number
string
message
string
media_url
string
first_name
string
last_name
string
email
string
address
string
city
string
state
string
zip_code
string
notes
string
agent_id
number
Array of objects
Array of objects
Responses
200

OK

400

Unauthorized

post/retailers/api/v1/whatsapp/send_message
Request samples
application/json
{
  • "phone_number": "string",
  • "message": "string",
  • "media_url": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip_code": "string",
  • "notes": "string",
  • "agent_id": 0,
  • "tags": [
    ],
  • "custom_fields": [
    ]
}
Response samples
application/json
{
  • "message": "Ok",
  • "info": {
    }
}

Customer events

Create Customer Event

Crea un nuevo evento para el cliente

Securityapi-key
Request
Request Body schema: application/json
category
string
subcategory
string
type_event
string
action
string
source
string
url_spec
string
created_at
string
Responses
201

CREATED

401

Unauthorized

post/retailers/api/v1/customers/:id/events
Request samples
application/json
{
  • "category": "string",
  • "subcategory": "string",
  • "type_event": "string",
  • "action": "string",
  • "source": "string",
  • "url_spec": "string",
  • "created_at": "string"
}
Response samples
application/json
{
  • "message": "Customer event created successfully"
}