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

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.

Bodyapplication/json
phone_numberstring
internal_idstring
template_paramsArray of strings
media_urlstring
first_namestring
last_namestring
emailstring
addressstring
citystring
statestring
zip_codestring
notesstring
agent_idnumber
funnel_namestring
stagestring
tagsArray of objects
custom_fieldsArray of objects
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": "string",
    "internal_id": "string",
    "template_params": [
      "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,
    "funnel_name": "string",
    "stage": "string",
    "tags": [
      {
        "name": "string",
        "value": true
      }
    ],
    "custom_fields": [
      {
        "identifier": "string",
        "value": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
phone_numberstring
internal_idstring
template_paramsArray of strings
media_urlstring
first_namestring
last_namestring
emailstring
addressstring
citystring
statestring
zip_codestring
notesstring
agent_idnumber
funnel_namestring
stagestring
tagsArray of objects
custom_fieldsArray of objects
Response
application/json
{
  "phone_number": "string",
  "internal_id": "string",
  "template_params": [
    "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,
  "funnel_name": "string",
  "stage": "string",
  "tags": [
    { … }
  ],
  "custom_fields": [
    { … }
  ]
}

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.

Bodyapplication/json
phone_numberstring
internal_idstring
template_paramsArray of strings
media_urlstring
first_namestring
last_namestring
emailstring
addressstring
citystring
statestring
zip_codestring
notesstring
agent_idnumber
funnel_namestring
stagestring
tagsArray of objects
custom_fieldsArray of objects
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": "string",
    "internal_id": "string",
    "template_params": [
      "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,
    "funnel_name": "string",
    "stage": "string",
    "tags": [
      {
        "name": "string",
        "value": true
      }
    ],
    "custom_fields": [
      {
        "identifier": "string",
        "value": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
phone_numberstring
internal_idstring
template_paramsArray of strings
media_urlstring
first_namestring
last_namestring
emailstring
addressstring
citystring
statestring
zip_codestring
notesstring
agent_idnumber
funnel_namestring
stagestring
tagsArray of objects
custom_fieldsArray of objects
Response
application/json
{
  "phone_number": "string",
  "internal_id": "string",
  "template_params": [
    "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,
  "funnel_name": "string",
  "stage": "string",
  "tags": [
    { … }
  ],
  "custom_fields": [
    { … }
  ]
}

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.