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

WhatsApp Business Api Templates

Request

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

Security
api-key
Bodyapplication/json
object(WhatsApp Business Api templates)
curl -i -X GET \
  https://app.mercately.com/retailers/api/v1/whatsapp_templates \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

OK

Bodyapplication/json
templatesArray of objects
Response
application/json
{
  "templates": [
    { … }
  ]
}

Send WhatsApp Message for WhatsApp Business API

Request

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.

Security
api-key
Bodyapplication/json
phone_numberstringrequired

Número de teléfono del destinatario (formato internacional con +)

Example: "+593999999999"
internal_idstringrequired

ID interno del template de WhatsApp (gupshup_template_id)

Example: "997dd550-c8d8-4bf7-ad98-a5ac4844a1ed"
template_paramsArray of stringsrequired

Array de parámetros para rellenar el template

Example: ["test 1","test 2","test 3"]
media_urlstring

URL del archivo multimedia (solo si el template incluye media)

Example: "https://mercately.com/example.png"
agent_idinteger

ID del agente al que se asignará el cliente

Example: 980
tagsArray of objects

Array de etiquetas para asignar al cliente

Example: [[{"name":"at","value":true}]]
curl -i -X POST \
  https://app.mercately.com/retailers/api/v1/whatsapp/send_notification_by_id \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "phone_number": "+593999999999",
    "internal_id": "997dd550-c8d8-4bf7-ad98-a5ac4844a1ed",
    "template_params": [
      "test 1",
      "test 2",
      "test 3"
    ],
    "media_url": "https://mercately.com/example.png",
    "agent_id": 980,
    "tags": [
      [
        {
          "name": "at",
          "value": true
        }
      ]
    ]
  }'

Responses

OK

Bodyapplication/json
messagestring

Mensaje de confirmación

Example: "Ok"
infoobject(MessageInfo)
Response
application/json
{
  "message": "Ok",
  "info": {
    "channel": "whatsapp",
    "content": { … },
    "direction": "outbound",
    "status": "submitted",
    "destination": "+593999999999",
    "country": "EC",
    "created_time": "2022-09-23T16:34:16.768-04:00",
    "error": null
  }
}

Send WhatsApp Message for WhatsApp Business QR

Request

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.

Security
api-key
Bodyapplication/json
phone_numberstringrequired

Número de teléfono del destinatario (formato internacional con +)

Example: "+593999999999"
messagestring

Mensaje de texto a enviar (requerido si no se envía media_url)

Example: "Hello, this is a test message"
media_urlstring

URL del archivo multimedia (requerido si no se envía message). Solo se permiten imágenes JPG/JPEG/PNG y archivos PDF

Example: "https://mercately.com/example.png"
first_namestring

Nombre del cliente (opcional)

Example: "John"
last_namestring

Apellido del cliente (opcional)

Example: "Doe"
emailstring

Email del cliente (opcional)

Example: "john@example.com"
addressstring

Dirección del cliente (opcional)

Example: "123 Main St"
citystring

Ciudad del cliente (opcional)

Example: "Quito"
statestring

Estado/Provincia del cliente (opcional)

Example: "Pichincha"
zip_codestring

Código postal del cliente (opcional)

Example: "170101"
notesstring

Notas sobre el cliente (opcional)

Example: "Customer notes"
agent_idinteger

ID del agente al que se asignará el cliente (opcional)

Example: 980
tagsArray of objects

Array de etiquetas para asignar al cliente (opcional)

Example: [{"name":"at","value":true}]
custom_fieldsArray of objects

Array de campos personalizados del cliente (opcional)

Example: [{"identifier":"custom_field_1","value":"Some value"}]
funnel_namestring

Nombre del embudo para crear un deal (opcional, requiere stage)

Example: "Sales Funnel"
stagestring

Etapa del embudo para crear un deal (opcional, requiere funnel_name)

Example: "Lead"
curl -i -X POST \
  https://app.mercately.com/retailers/api/v1/whatsapp/send_message \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "phone_number": "+593999999999",
    "message": "Hello, this is a test message",
    "media_url": "https://mercately.com/example.png",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "address": "123 Main St",
    "city": "Quito",
    "state": "Pichincha",
    "zip_code": "170101",
    "notes": "Customer notes",
    "agent_id": 980,
    "tags": [
      {
        "name": "at",
        "value": true
      }
    ],
    "custom_fields": [
      {
        "identifier": "custom_field_1",
        "value": "Some value"
      }
    ],
    "funnel_name": "Sales Funnel",
    "stage": "Lead"
  }'

Responses

OK

Bodyapplication/json
messagestring

Mensaje de confirmación

Example: "Ok"
infoobject(MessageInfo)
Response
application/json
{
  "message": "Ok",
  "info": {
    "channel": "whatsapp",
    "content": { … },
    "direction": "outbound",
    "status": "submitted",
    "destination": "+593999999999",
    "country": "EC",
    "created_time": "2022-09-23T16:34:16.768-04:00",
    "error": null
  }
}

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
Copyleft © Mercately Inc.