Skip to content

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

Terms of Service

Languages
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

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

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.

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

Categories

Obtén todas las categorías creadas en Mercately

Operations

Customer events

Operations

Create Customer Event

Request

Crea un nuevo evento para el cliente

Security
api-key
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/:id/events \
  -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

CREATED

Bodyapplication/json
messagesstring
Example: "Customer event created successfully"
Response
application/json
{
  "messages": "Customer event created successfully"
}

Get Customer Events

Request

Obtiene los eventos del cliente

Security
api-key
Query
pagenumber

Busca la página específica de eventos

results_per_pagenumber

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

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

Responses

OK

Bodyapplication/json
messagesstring
Example: "Customer event created successfully"
Response
application/json
{
  "messages": "Customer event created successfully"
}
Copyleft © Mercately Inc.