Mercately Retailers API (1.0.0)

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.

Download OpenAPI description

index.json

index.yaml

Overview

URL http://mercately.com/

E-mail soporte@mercately.com

License MIT

Servers

Production server

https://app.mercately.com/

Shops API Production server

https://mercately.shop/

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.

Operations

Customers

En Mercately, todo contacto proveniente de conversaciones, compras o creados directamente se clasifica como cliente.

Operations

Customers

Request

Obtén los datos de un cliente en especifico

Query

pagenumber

busca la pagina específica de clientes

start_datestring(date)

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

end_datestring(date)

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

id_typeany

especifica el tipo de documento a buscar

Enum"cedula""pasaporte""ruc""rut""otro"

id_numberstring

Número de documento a buscar

platformstring

Plataforma de interacción

Enum"whatsapp""messenger""instagram"

order_by_last_interactionstring

Ordena los clientes por la última interacción segun la plataforma

Enum"asc""desc"

curl -i -X GET \
  'https://app.mercately.com/retailers/api/v1/customers?end_date=2019-08-24&id_number=string&id_type=cedula&order_by_last_interaction=asc&page=0&platform=whatsapp&start_date=2019-08-24' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

string

Response

application/json

{
  "results": 1,
  "total_pages": 1,
  "customers": [
    { … }
  ]
}

Create Customers

Request

Crea un nuevo cliente

Bodyapplication/json

first_namestring

last_namestring

emailstring

phonestring

id_typestring

Enum"cedula""pasaporte""ruc""rut""otro"

id_numberstring

customer_addresses_attributesArray of objects

notesstring

agent_idinteger

tagsArray of objects

custom_fieldsArray of objects

outbound_statusstring

Enum"error""submitted""enqueued""sent""delivered""read"

campaign_idinteger

campaign_urlstring

error_messagestring

creation_datestring(date)

sent_atstring(date)

delivered_atstring(date)

read_atstring(date)

last_chat_interactionstring(date)

curl -i -X POST \
  https://app.mercately.com/retailers/api/v1/customers \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "id_type": "cedula",
    "id_number": "string",
    "customer_addresses_attributes": [
      {
        "address": "string",
        "city": "string",
        "state": "string",
        "zip_code": "string",
        "country_id": 0,
        "latitude": "string",
        "longitude": "string",
        "description": "string",
        "main": true
      }
    ],
    "notes": "string",
    "agent_id": 0,
    "tags": [
      {
        "name": "string",
        "value": true
      }
    ],
    "custom_fields": [
      {
        "field_name": "string",
        "field_content": "string"
      }
    ],
    "outbound_status": "error",
    "campaign_id": 0,
    "campaign_url": "string",
    "error_message": "string",
    "creation_date": "2019-08-24",
    "sent_at": "2019-08-24",
    "delivered_at": "2019-08-24",
    "read_at": "2019-08-24",
    "last_chat_interaction": "2019-08-24"
  }'

Responses

Bodyapplication/json

messagestring

Example: "Customer created successfully"

customerobject(customer)

Response

application/json

{
  "message": "Customer created successfully",
  "customer": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "id_type": "cedula",
    "id_number": "string",
    "customer_addresses_attributes": [ … ],
    "notes": "string",
    "agent_id": 0,
    "tags": [ … ],
    "custom_fields": [ … ],
    "outbound_status": "error",
    "campaign_id": 0,
    "campaign_url": "string",
    "error_message": "string",
    "creation_date": "2019-08-24",
    "sent_at": "2019-08-24",
    "delivered_at": "2019-08-24",
    "read_at": "2019-08-24",
    "last_chat_interaction": "2019-08-24"
  }
}

Customer/:id

Request

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

curl -i -X GET \
  https://app.mercately.com/retailers/api/v1/customers/:id \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

first_namestring

last_namestring

emailstring

phonestring

id_typestring

Enum"cedula""pasaporte""ruc""rut""otro"

id_numberstring

customer_addresses_attributesArray of objects

notesstring

agent_idinteger

tagsArray of objects

custom_fieldsArray of objects

outbound_statusstring

Enum"error""submitted""enqueued""sent""delivered""read"

campaign_idinteger

campaign_urlstring

error_messagestring

creation_datestring(date)

sent_atstring(date)

delivered_atstring(date)

read_atstring(date)

last_chat_interactionstring(date)

Response

application/json

{
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "id_type": "cedula",
  "id_number": "string",
  "customer_addresses_attributes": [
    { … }
  ],
  "notes": "string",
  "agent_id": 0,
  "tags": [
    { … }
  ],
  "custom_fields": [
    { … }
  ],
  "outbound_status": "error",
  "campaign_id": 0,
  "campaign_url": "string",
  "error_message": "string",
  "creation_date": "2019-08-24",
  "sent_at": "2019-08-24",
  "delivered_at": "2019-08-24",
  "read_at": "2019-08-24",
  "last_chat_interaction": "2019-08-24"
}

Customer/:email

Request

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

curl -i -X GET \
  https://app.mercately.com/retailers/api/v1/customers/:email \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

messagestring

Example: "Customer found successfully"

customerobject(customer)

Response

application/json

{
  "message": "Customer found successfully",
  "customer": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "id_type": "cedula",
    "id_number": "string",
    "customer_addresses_attributes": [ … ],
    "notes": "string",
    "agent_id": 0,
    "tags": [ … ],
    "custom_fields": [ … ],
    "outbound_status": "error",
    "campaign_id": 0,
    "campaign_url": "string",
    "error_message": "string",
    "creation_date": "2019-08-24",
    "sent_at": "2019-08-24",
    "delivered_at": "2019-08-24",
    "read_at": "2019-08-24",
    "last_chat_interaction": "2019-08-24"
  }
}

Customer/:phone

Request

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

curl -i -X GET \
  https://app.mercately.com/retailers/api/v1/customers/:phone \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

messagestring

Example: "Customer found successfully"

customerobject(customer)

Response

application/json

{
  "message": "Customer found successfully",
  "customer": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "id_type": "cedula",
    "id_number": "string",
    "customer_addresses_attributes": [ … ],
    "notes": "string",
    "agent_id": 0,
    "tags": [ … ],
    "custom_fields": [ … ],
    "outbound_status": "error",
    "campaign_id": 0,
    "campaign_url": "string",
    "error_message": "string",
    "creation_date": "2019-08-24",
    "sent_at": "2019-08-24",
    "delivered_at": "2019-08-24",
    "read_at": "2019-08-24",
    "last_chat_interaction": "2019-08-24"
  }
}

Update Customer by email, id or phone

Request

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

Bodyapplication/json

first_namestring

last_namestring

emailstring

phonestring

id_typestring

Enum"cedula""pasaporte""ruc""rut""otro"

id_numberstring

customer_addresses_attributesArray of objects

notesstring

agent_idinteger

tagsArray of objects

custom_fieldsArray of objects

outbound_statusstring

Enum"error""submitted""enqueued""sent""delivered""read"

campaign_idinteger

campaign_urlstring

error_messagestring

creation_datestring(date)

sent_atstring(date)

delivered_atstring(date)

read_atstring(date)

last_chat_interactionstring(date)

curl -i -X PUT \
  https://app.mercately.com/retailers/api/v1/customers/:phone \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "id_type": "cedula",
    "id_number": "string",
    "customer_addresses_attributes": [
      {
        "address": "string",
        "city": "string",
        "state": "string",
        "zip_code": "string",
        "country_id": 0,
        "latitude": "string",
        "longitude": "string",
        "description": "string",
        "main": true
      }
    ],
    "notes": "string",
    "agent_id": 0,
    "tags": [
      {
        "name": "string",
        "value": true
      }
    ],
    "custom_fields": [
      {
        "field_name": "string",
        "field_content": "string"
      }
    ],
    "outbound_status": "error",
    "campaign_id": 0,
    "campaign_url": "string",
    "error_message": "string",
    "creation_date": "2019-08-24",
    "sent_at": "2019-08-24",
    "delivered_at": "2019-08-24",
    "read_at": "2019-08-24",
    "last_chat_interaction": "2019-08-24"
  }'

Responses

Bodyapplication/json

messagestring

Example: "Customer updated successfully"

customerobject(customer)

Response

application/json

{
  "message": "Customer updated successfully",
  "customer": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "id_type": "cedula",
    "id_number": "string",
    "customer_addresses_attributes": [ … ],
    "notes": "string",
    "agent_id": 0,
    "tags": [ … ],
    "custom_fields": [ … ],
    "outbound_status": "error",
    "campaign_id": 0,
    "campaign_url": "string",
    "error_message": "string",
    "creation_date": "2019-08-24",
    "sent_at": "2019-08-24",
    "delivered_at": "2019-08-24",
    "read_at": "2019-08-24",
    "last_chat_interaction": "2019-08-24"
  }
}

Customer/:id/whatsapp_conversations

Request

Obtén la conversación de Whatsapp del cliente por ID

Query

pagenumber

Busca la página específica de conversaciónes

results_per_pagenumber

Selecciona el número de mensajes que serán visualizados por página

curl -i -X GET \
  'https://app.mercately.com/retailers/api/v1/customers/:id/whatsapp_conversations?page=0&results_per_page=0' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

whatsapp_conversationsArray of objects(Customer)

total_pagesinteger

Example: 1

Response

application/json

{
  "whatsapp_conversations": [
    { … }
  ],
  "total_pages": 1
}

Customer/:phone/whatsapp_conversations

Request

Obtén la conversación de Whatsapp del cliente por número de teléfono

Query

pagenumber

Busca la página específica de conversaciónes

results_per_pagenumber

Selecciona el número de mensajes que serán visualizados por página

curl -i -X GET \
  'https://app.mercately.com/retailers/api/v1/customers/:phone/whatsapp_conversations?page=0&results_per_page=0' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

whatsapp_conversationsArray of objects(Customer)

total_pagesinteger

Example: 1

Response

application/json

{
  "whatsapp_conversations": [
    { … }
  ],
  "total_pages": 1
}

Customer/:id/messenger_conversations

Request

Obtén la conversación de Messenger del cliente

Query

pagenumber

Busca la página específica de conversaciónes

results_per_pagenumber

Selecciona el número de mensajes que serán visualizados por página

curl -i -X GET \
  'https://app.mercately.com/retailers/api/v1/customers/:id/messenger_conversations?page=0&results_per_page=0' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

messenger_conversationsArray of objects(messenger_message)

total_pagesinteger

Example: 1

Response

application/json

{
  "messenger_conversations": [
    { … }
  ],
  "total_pages": 1
}

Customer/:id/instagram_conversations

Request

Obtén la conversación de Instagram del cliente

Query

pagenumber

Busca la página específica de conversaciónes

results_per_pagenumber

Selecciona el número de mensajes que serán visualizados por página

curl -i -X GET \
  'https://app.mercately.com/retailers/api/v1/customers/:id/instagram_conversations?page=0&results_per_page=0' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

instagram_conversationsArray of objects(messenger_message)

total_pagesinteger

Example: 1

Response

application/json

{
  "instagram_conversations": [
    { … }
  ],
  "total_pages": 1
}

Deals

En Mercately, los embudos permiten visualizar el recorrido que sigues a tus clientes a traves de las negociaciones.

Operations

Messenger

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

Operations

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

Operations

Flows

En Mercately, una vez creado uno o más flows, esta api permite realizar múltiples operaciones para obtener todos los flows.

Operations

Orders

Crea, actualiza y elimina órdenes en Mercately

Operations

Products

Crea, actualiza y elimina productos en Mercately

Operations

Customer events

Operations

Mercately Retailers API (1.0.0)

Agents

Customers

Customers

Request

Responses

Was this helpful?

Create Customers

RequestExpand all

Responses

Was this helpful?

Customer/:id

Request

Responses

Was this helpful?

Customer/:email

Request

Responses

Was this helpful?

Customer/:phone

Request

Responses

Was this helpful?

Update Customer by email, id or phone

RequestExpand all

Responses

Was this helpful?

Customer/:id/whatsapp_conversations

Request

Responses

Was this helpful?

Customer/:phone/whatsapp_conversations

Request

Responses

Was this helpful?

Customer/:id/messenger_conversations

Request

Responses

Was this helpful?

Customer/:id/instagram_conversations

Request

Responses

Was this helpful?

Deals

Messenger

WhatsApp

Flows

Orders

Products

Categories

Customer events

Request

Request