# Mercately Retailers API

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.

Version: 1.0.0
License: MIT

## Servers

Production server
```
https://app.mercately.com
```

Shops API Production server
```
https://mercately.shop
```

## Security

### api-key

API Key authentication

Type: apiKey
In: header
Name: api-key

## Download OpenAPI description

[Mercately Retailers API](https://mercately.redocly.app/_bundle/apis/index.yaml)

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

### List all agents

 - [GET /retailers/api/v1/agents](https://mercately.redocly.app/apis/agents/listagents.md)

## Customers

En Mercately, todo contacto proveniente de conversaciones, compras o creados directamente se clasifica como cliente.

### Customers

 - [GET /retailers/api/v1/customers](https://mercately.redocly.app/apis/customers/customers.md): Obtén los datos de un cliente en especifico

### Create Customers

 - [POST /retailers/api/v1/customers](https://mercately.redocly.app/apis/customers/createcustomer.md): Crea un nuevo cliente

### Customer/:id

 - [GET /retailers/api/v1/customers/:id](https://mercately.redocly.app/apis/customers/customer/:id.md): Obtén los datos de un cliente en especifico buscado por ID

### Customer/:email

 - [GET /retailers/api/v1/customers/:email](https://mercately.redocly.app/apis/customers/customer/email.md): Obtén los datos de un cliente en especifico buscado por email

### Customer/:phone

 - [GET /retailers/api/v1/customers/:phone](https://mercately.redocly.app/apis/customers/customer/phone.md): Obtén los datos de un cliente en especifico buscado por phone

### Update Customer by email, id or phone

 - [PUT /retailers/api/v1/customers/:phone](https://mercately.redocly.app/apis/customers/updatecustomer/email.md): Actualiza un nuevo customer buscado por email, id o phone. Puedes realizar la busqueda igual que los métodos get

### Customer/:id/whatsapp_conversations

 - [GET /retailers/api/v1/customers/:id/whatsapp_conversations](https://mercately.redocly.app/apis/customers/customer/id/whatsapp_conversations.md): Obtén la conversación de Whatsapp del cliente por ID

### Customer/:phone/whatsapp_conversations

 - [GET /retailers/api/v1/customers/:phone/whatsapp_conversations](https://mercately.redocly.app/apis/customers/customer/phone/whatsapp_conversations.md): Obtén la conversación de Whatsapp del cliente por número de teléfono

### Customer/:id/messenger_conversations

 - [GET /retailers/api/v1/customers/:id/messenger_conversations](https://mercately.redocly.app/apis/customers/customer/id/messenger_conversations.md): Obtén la conversación de Messenger del cliente

### Customer/:id/instagram_conversations

 - [GET /retailers/api/v1/customers/:id/instagram_conversations](https://mercately.redocly.app/apis/customers/customer/id/instagram_conversations.md): Obtén la conversación de Instagram del cliente

## Deals

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

### Obtener deals

 - [GET /retailers/api/v1/deals](https://mercately.redocly.app/apis/deals/listdeal.md): Obtén la lista de negociaciones

### Create deal

 - [POST /retailers/api/v1/deals](https://mercately.redocly.app/apis/deals/createdeal.md): Crea una nueva negociación

### deals/:id

 - [GET /retailers/api/v1/deals/{id}](https://mercately.redocly.app/apis/deals/getdeal.md): Obtén una negociacion

### deals/:id

 - [PUT /retailers/api/v1/deals/{id}](https://mercately.redocly.app/apis/deals/updatedeal.md): Actualiza una negociación

### deals/:id

 - [DELETE /retailers/api/v1/deals/{id}](https://mercately.redocly.app/apis/deals/deletedeal.md): Elimina una negociación

## Messenger

En Mercately, una vez vinculado con Messenger, este api permite realizar múltiples operaciones para acceder a las conversaciones de Messenger.

### Messenger conversations

 - [GET /retailers/api/v1/messenger_conversations](https://mercately.redocly.app/apis/messenger/messengerclients.md): Obtén los clients que te han escrito por messenger

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

### WhatsApp Business Api Templates

 - [GET /retailers/api/v1/whatsapp_templates](https://mercately.redocly.app/apis/whatsapp/whatsapptemplates.md): Obtén los templates/plantillas creadas en WhatsApp Business API

### Send WhatsApp Message for WhatsApp Business API

 - [POST /retailers/api/v1/whatsapp/send_notification_by_id](https://mercately.redocly.app/apis/whatsapp/sendwhatsappapi.md): 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.

### Send WhatsApp Message for WhatsApp Business QR

 - [POST /retailers/api/v1/whatsapp/send_message](https://mercately.redocly.app/apis/whatsapp/sendwhatsappqr.md): 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.

## Flows

En Mercately, una vez creado uno o más flows, esta api permite realizar múltiples operaciones para obtener todos los flows.

### Get all flows

 - [GET /retailers/api/v1/flows](https://mercately.redocly.app/apis/flows/flows.md): Obtén todos los flows

### Deactivate flows by platform

 - [POST /retailers/api/v1/flow_deactivation](https://mercately.redocly.app/apis/flows/flow_deactivation.md): Desactiva todos los flows que estén previamente activos por customer y plataforma específica

### Pre-activate flow by platform

 - [POST /retailers/api/v1/flow_pre_activation](https://mercately.redocly.app/apis/flows/flow_pre_activation.md): 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.

## Orders

Crea, actualiza y elimina órdenes en Mercately

### Orders

 - [GET /api/v1/orders](https://mercately.redocly.app/apis/orders/orders.md): Obtén los datos de tus órdenes

### Create Order

 - [POST /api/v1/orders](https://mercately.redocly.app/apis/orders/createorder.md): Crea una nueva órden, puedes enviar el número de teléfono o email del cliente si ya esta creado en mercately, si no existe, creará el cliente.

### Order

 - [PUT /api/v1/orders/web_id](https://mercately.redocly.app/apis/orders/updateorder.md): Actualiza una órden buscada su id

### Orders

 - [DELETE /api/v1/orders/web_id](https://mercately.redocly.app/apis/orders/deleteorder.md): Borra una órden

## Products

Crea, actualiza y elimina productos en Mercately

### Products

 - [GET /api/v1/products](https://mercately.redocly.app/apis/products/products.md): Obtén los datos de tus productos

### Create Product

 - [POST /api/v1/products](https://mercately.redocly.app/apis/products/createproduct.md): Crea un nuevo producto.  
Envía máximo 3 opciones.  

Ejemplo de options:
json
"options": [
  { "name": "Talla", "values": ["SM", "LG", "XL", "MD"] },
  { "name": "Color", "values": ["Red", "Blue"] }
]


Para las variantes, combina los valores de las opciones.

Ejemplo de variants:
json
"variants": [
  { "price": 12, "wholesale_price": 10, "sku": "VAR-001", "option1": "SM", "option2": "Red" },
  { "price": 14, "wholesale_price": 10, "sku": "VAR-002", "option1": "LG", "option2": "Red" },
  { "price": 25, "wholesale_price": 13, "sku": "VAR-003", "option1": "XL", "option2": "Blue" }
]

### Product

 - [GET /api/v1/products/:id_or_sku](https://mercately.redocly.app/apis/products/searchproduct.md): Obtén los datos de un producto en especifico buscado su id

### Product

 - [PUT /api/v1/product/web_id](https://mercately.redocly.app/apis/products/updateproduct.md): Actualiza un producto buscado su id  
Envía máximo 3 opciones.  

Ejemplo de options:
json
"options": [
  { "name": "Talla", "values": ["SM", "LG", "XL", "MD"] },
  { "name": "Color", "values": ["Red", "Blue"] }
]


Para las variantes, combina los valores de las opciones.

Ejemplo de variants:
json
"variants": [
  { "price": 12, "wholesale_price": 10, "sku": "VAR-001", "option1": "SM", "option2": "Red" },
  { "price": 14, "wholesale_price": 10, "sku": "VAR-002", "option1": "LG", "option2": "Red" },
  { "price": 25, "wholesale_price": 13, "sku": "VAR-003", "option1": "XL", "option2": "Blue" }
]


Para eliminar todas las opciones y variantes envía:
json
"options": [],
"variants": []


Si no deseas hacer cambios en opciones ni variantes, no envíes los keys "options" ni "variants".  
Si quieres hacer actualizaciones, envía "options" y "variants" con los cambios.

### Product

 - [DELETE /api/v1/product/web_id](https://mercately.redocly.app/apis/products/deleteproduct.md): Borra un producto buscado su id

## Categories

Obtén todas las categorías creadas en Mercately

### Categories

 - [GET /api/v1/categories](https://mercately.redocly.app/apis/categories/categories.md): Obtén los datos de tus categorías

## Customer events

### Create Customer Event

 - [POST /retailers/api/v1/customers/:id/events](https://mercately.redocly.app/apis/customer-events/customer/:id/events.md): Crea un nuevo evento para el cliente

### Get Customer Events

 - [GET /retailers/api/v1/customers/:id/customer_events_history](https://mercately.redocly.app/apis/customer-events/customers/:id/customer_events.md): Obtiene los eventos del cliente