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

Get all flows

Request

Obtén todos los flows

Query
pagenumber

Busca la página específica de flows

results_per_pagenumber

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

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

Responses

OK

Bodyapplication/json
resultsinteger
Example: 1
total_pagesinteger
Example: 1
flowsArray of objects(flow)
Response
application/json
{
  "results": 1,
  "total_pages": 1,
  "flows": [
    { … }
  ]
}

Deactivate flows by platform

Request

Desactiva todos los flows que estén previamente activos por customer y plataforma específica

Bodyapplication/jsonrequired
customer_idstringrequired

Id del customer(Opcional, siempre y cuando se busque por customer_phone)

Example: "d126hhh"
customer_phonestringrequired

Teléfono del customer(Opcional, siempre y cuando se busque por customer_id)

Example: "+573201548587"
platformstringrequired

Plataforma sobre la cual se realizará la búsqueda para pre-activar un flow específico para el customer. Sólo se permiten los valores de 'whatsapp', 'messenger' o 'instagram'

Example: "whatsapp"
curl -i -X POST \
  https://app.mercately.com/retailers/api/v1/flow_deactivation \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "customer_id": "d126hhh",
    "customer_phone": "+573201548587",
    "platform": "whatsapp"
  }'

Responses

OK

Bodyapplication/json
messagestring
Example: "Flows by platform successfully deactivated"
infoArray of arrays
Response
application/json
{
  "message": "Flows by platform successfully deactivated",
  "info": []
}

Pre-activate flow by platform

Request

Pre-activa un flow en específico para un customer y plataforma específica, siempre y cuando el flow esté activo, tenga un paso inicial configurado y la plataforma para dicho flow esté activa. Esta operación solo está habilitada para flows con versión 2. Si deseas usar un flow con versión 1, debes hacer upgrade del mismo.

Bodyapplication/jsonrequired
customer_idstringrequired

Id del customer(Opcional, siempre y cuando se busque por customer_phone)

Example: "d126hhh"
customer_phonestringrequired

Teléfono del customer(Opcional, siempre y cuando se busque por customer_id)

Example: "+573201548587"
flow_idstringrequired

Id del flow

Example: "d82ijd8"
platformstringrequired

Plataforma sobre la cual se realizará la búsqueda para pre-activar un flow específico para el customer. Sólo se permiten los valores de 'whatsapp', 'messenger' o 'instagram'

Example: "whatsapp"
curl -i -X POST \
  https://app.mercately.com/retailers/api/v1/flow_pre_activation \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "customer_id": "d126hhh",
    "customer_phone": "+573201548587",
    "flow_id": "d82ijd8",
    "platform": "whatsapp"
  }'

Responses

OK

Bodyapplication/json
messagestring
Example: "Flow successfully preactivated"
infoArray of arrays
Response
application/json
{
  "message": "Flow successfully preactivated",
  "info": []
}

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.