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
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

Product Variants

Actualiza variantes de productos en Mercately

Operations

Categories

Obtén todas las categorías creadas en Mercately

Operations
Operations

Request

Crea un nuevo evento para el cliente

Security
api-key
Bodyapplication/json
customer_eventobject(CustomerEvent)required
customer_event.​categorystringrequired

Categoría del evento

Example: "purchase"
customer_event.​subcategorystringrequired

Subcategoría del evento

Example: "order_placed"
customer_event.​actionstringrequired

Acción del evento

Example: "created"
customer_event.​type_eventstring

Tipo de evento (opcional)

Example: "order"
customer_event.​sourcestring

Fuente del evento (opcional)

Example: "api"
customer_event.​url_specstring

URL específica relacionada con el evento (opcional)

Example: "https://example.com/order/123"
customer_event.​created_atstring(date-time)

Fecha y hora de creación del evento (opcional). Si no se proporciona, se usa la fecha actual

Example: "2024-01-15T10:30:00Z"
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 '{
    "customer_event": {
      "category": "purchase",
      "subcategory": "order_placed",
      "action": "created",
      "type_event": "order",
      "source": "api",
      "url_spec": "https://example.com/order/123",
      "created_at": "2024-01-15T10:30:00Z"
    }
  }'

Responses

CREATED

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

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
resultsinteger

Número total de eventos

Example: 10
total_pagesinteger

Número total de páginas

Example: 2
customer_eventsArray of objects(CustomerEvent)

Array de eventos del cliente

Response
application/json
{ "results": 10, "total_pages": 2, "customer_events": [ {} ] }