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

Deals

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

Operations

Obtener deals

Request

Obtén la lista de negociaciones

Query

funnel_namestringrequired

Nombre del embudo

Example: funnel_name=Negociaciones

stagestringrequired

Nombre de la etapa

Example: stage=Calificado

pageinteger

número de pagina

Example: page=1

curl -i -X GET \
  'https://app.mercately.com/retailers/api/v1/deals?funnel_name=Negociaciones&page=1&stage=Calificado' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

totalinteger

Example: 2

total_pageinteger

Example: 1

dealsArray of objects(deal)

Response

application/json

{
  "total": 2,
  "total_page": 1,
  "deals": [
    { … }
  ]
}

Create deal

Request

Crea una nueva negociación

Bodyapplication/jsonrequired

funnel_namestringrequired

Example: "Negociaciones"

stagestringrequired

Example: "Calificado"

dealobjectrequired

deal.amountstring

Example: "150000"

deal.namestring

deal.customer_idstring

Example: "91989a87"

deal.agent_idinteger

deal.lead_statusstring

Enum"cold""warm""hot"

Example: "cold"

deal.opening_datestring(date)

Example: "2024-05-16"

deal.expected_close_datestring(date)

Example: "2024-05-23"

curl -i -X POST \
  https://app.mercately.com/retailers/api/v1/deals \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "funnel_name": "Negociaciones",
    "stage": "Calificado",
    "deal": {
      "amount": "150000",
      "name": "string",
      "customer_id": "91989a87",
      "agent_id": 0,
      "lead_status": "cold",
      "opening_date": "2024-05-16",
      "expected_close_date": "2024-05-23"
    }
  }'

Responses

Bodyapplication/json

messagestring

Example: "deal was created successfully"

dealobject(deal)

Response

application/json

{
  "message": "deal was created successfully",
  "deal": {
    "id": "9fb882221",
    "name": "Neptu",
    "amount": "150000.0",
    "currency": "$",
    "funnel_name": "Negociaciones",
    "stage": "Calificado!",
    "agent": { … },
    "customer": { … },
    "channel": "string"
  }
}

deals/:id

Request

Obtén una negociacion

Path

idstringrequired

ID de la negociación

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

Responses

Bodyapplication/json

messagestring

Example: "deal found successfully"

dealobject(deal)

Response

application/json

{
  "message": "deal found successfully",
  "deal": {
    "id": "9fb882221",
    "name": "Neptu",
    "amount": "150000.0",
    "currency": "$",
    "funnel_name": "Negociaciones",
    "stage": "Calificado!",
    "agent": { … },
    "customer": { … },
    "channel": "string"
  }
}

deals/:id

Request

Actualiza una negociación

Path

idstringrequired

ID de la negociación

Example: 9c6d04017

Bodyapplication/jsonrequired

funnel_namestringrequired

Example: "Negociaciones"

stagestringrequired

Example: "Calificado"

dealobjectrequired

deal.amountstring

Example: "150000"

deal.namestring

Example: "Ricardo - pavo"

deal.customer_idstring

Example: "91989a87"

deal.lead_statusstring

Example: "cold"

deal.opening_datestring(date)

Example: "2024-05-16"

deal.expected_close_datestring(date)

Example: "2024-05-23"

deal.funnel_namestring

Example: "Negociaciones"

deal.stagestring

Example: "Calificado"

curl -i -X PUT \
  https://app.mercately.com/retailers/api/v1/deals/9c6d04017 \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "funnel_name": "Negociaciones",
    "stage": "Calificado",
    "deal": {
      "amount": "150000",
      "name": "Ricardo - pavo",
      "customer_id": "91989a87",
      "lead_status": "cold",
      "opening_date": "2024-05-16",
      "expected_close_date": "2024-05-23",
      "funnel_name": "Negociaciones",
      "stage": "Calificado"
    }
  }'

Responses

Bodyapplication/json

messagestring

Example: "deal was updated successfully"

dealobject(deal)

Response

application/json

{
  "message": "deal was updated successfully",
  "deal": {
    "id": "9fb882221",
    "name": "Neptu",
    "amount": "150000.0",
    "currency": "$",
    "funnel_name": "Negociaciones",
    "stage": "Calificado!",
    "agent": { … },
    "customer": { … },
    "channel": "string"
  }
}

deals/:id

Request

Elimina una negociación

Path

idstringrequired

ID de la negociación

Example: 93390836

curl -i -X DELETE \
  https://app.mercately.com/retailers/api/v1/deals/93390836 \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

messagestring

Example: "deal was deleted successfully"

Response

application/json

{
  "message": "deal was deleted successfully"
}

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

Deals

Obtener deals

Request

Responses

Was this helpful?

Create deal

Request

Responses

Was this helpful?

deals/:id

Request

Responses

Was this helpful?

deals/:id

Request

Responses

Was this helpful?

deals/:id

Request

Responses

Was this helpful?

Messenger

WhatsApp

Flows

Orders

Products

Categories

Customer events

Mercately Retailers API (1.0.0)

Agents

Customers

Deals

Obtener deals

Request

Responses

Was this helpful?

Create deal

RequestExpand all

Responses

Was this helpful?

deals/:id

Request

Responses

Was this helpful?

deals/:id

RequestExpand all

Responses

Was this helpful?

deals/:id

Request

Responses

Was this helpful?

Messenger

WhatsApp

Flows

Orders

Products

Categories

Customer events

Request

Request