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

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

List Categories

Request

Obtén los datos de tus categorías con sus subcategorías

Security
api-key
Query
pageinteger>= 1

Número de página para la paginación

Default 1
curl -i -X GET \
  'https://mercately.shop/api/v1/categories?page=1' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
categoriesArray of objects
total_pagesinteger

Total de páginas disponibles

Example: 1
Response
application/json
{
  "categories": [
    { … }
  ],
  "total_pages": 1
}

Create Category

Request

Crea una nueva categoría con sus subcategorías

Security
api-key
Bodyapplication/jsonrequired
categoryobjectrequired
category.​namestringrequired

Nombre de la categoría (requerido)

Example: "Electrónica"
category.​descriptionstring<= 250 characters

Descripción de la categoría (máximo 250 caracteres)

Example: "Productos electrónicos y dispositivos tecnológicos"
category.​orderinteger

Orden de visualización. Si no se proporciona, se asigna automáticamente

Example: 1
category.​subcategories_attributesArray of objects

Array de subcategorías a crear

curl -i -X POST \
  https://mercately.shop/api/v1/categories \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "category": {
      "name": "Electrónica",
      "description": "Productos electrónicos y dispositivos tecnológicos",
      "order": 1,
      "subcategories_attributes": [
        {
          "name": "Smartphones",
          "description": "Teléfonos inteligentes y accesorios",
          "order": 1
        },
        {
          "name": "Laptops",
          "description": "Computadoras portátiles",
          "order": 2
        }
      ]
    }
  }'

Responses

Category created successfully

Bodyapplication/json
web_idstring

Identificador único de la categoría

Example: "I7ROmS7Jui"
namestring

Nombre de la categoría

Example: "Electrónica"
descriptionstring

Descripción de la categoría

Example: "Productos electrónicos y dispositivos tecnológicos"
products_countinteger

Número de productos activos en la categoría

Example: 0
orderinteger

Orden de visualización de la categoría

Example: 1
subcategoriesArray of objects

Lista de subcategorías

Response
application/json
{
  "web_id": "I7ROmS7Jui",
  "name": "Electrónica",
  "description": "Productos electrónicos y dispositivos tecnológicos",
  "products_count": 0,
  "order": 1,
  "subcategories": [
    { … },
    { … }
  ]
}

Update Category

Request

Actualiza una categoría existente y sus subcategorías. Puedes actualizar, crear o eliminar subcategorías.

Security
api-key
Path
idstringrequired

Web ID de la categoría

Example: I7ROmS7Jui
Bodyapplication/jsonrequired
categoryobjectrequired
category.​namestring

Nombre de la categoría

Example: "Electrónica"
category.​descriptionstring<= 250 characters

Descripción de la categoría (máximo 250 caracteres)

Example: "Productos electrónicos actualizados"
category.​orderinteger

Orden de visualización

Example: 1
category.​subcategories_attributesArray of objects

Array de subcategorías.

  • Para actualizar: incluye el campo 'id' con el web_id de la subcategoría
  • Para crear: omite el campo 'id'
  • Para eliminar: incluye el campo 'id' y '_destroy: true'
curl -i -X PUT \
  https://mercately.shop/api/v1/categories/web_id \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "category": {
      "name": "Electrónica",
      "description": "Productos electrónicos actualizados",
      "order": 1,
      "subcategories_attributes": [
        {
          "web_id": "bas9UxSaUq",
          "name": "Smartphones",
          "description": "Teléfonos inteligentes actualizados",
          "order": 1
        },
        {
          "web_id": "VqpkV7TLd5",
          "name": "Laptops",
          "description": "Computadoras portátiles actualizadas",
          "order": 2
        }
      ]
    }
  }'

Responses

Category updated successfully

Bodyapplication/json
web_idstring

Identificador único de la categoría

Example: "I7ROmS7Jui"
namestring

Nombre de la categoría

Example: "Electrónica"
descriptionstring

Descripción de la categoría

Example: "Productos electrónicos actualizados"
products_countinteger

Número de productos activos en la categoría

Example: 7
orderinteger

Orden de visualización de la categoría

Example: 1
subcategoriesArray of objects

Lista de subcategorías

Response
application/json
{
  "web_id": "I7ROmS7Jui",
  "name": "Electrónica",
  "description": "Productos electrónicos actualizados",
  "products_count": 7,
  "order": 1,
  "subcategories": [
    { … }
  ]
}

Update Category (Partial)

Request

Actualiza parcialmente una categoría existente

Security
api-key
Path
idstringrequired

Web ID de la categoría

Example: I7ROmS7Jui
Bodyapplication/jsonrequired
categoryobjectrequired
category.​namestring

Nombre de la categoría

Example: "Electrónica"
category.​descriptionstring<= 250 characters

Descripción de la categoría (máximo 250 caracteres)

Example: "Productos electrónicos actualizados"
category.​orderinteger

Orden de visualización

Example: 1
category.​subcategories_attributesArray of objects

Array de subcategorías

curl -i -X PATCH \
  https://mercately.shop/api/v1/categories/web_id \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "category": {
      "name": "Electrónica",
      "description": "Productos electrónicos actualizados",
      "order": 1,
      "subcategories_attributes": [
        {
          "web_id": "bas9UxSaUq",
          "name": "Smartphones",
          "description": "Teléfonos inteligentes actualizados",
          "order": 1,
          "_destroy": false
        }
      ]
    }
  }'

Responses

Category updated successfully

Bodyapplication/json
web_idstring
Example: "I7ROmS7Jui"
namestring
Example: "Electrónica"
descriptionstring
Example: "Productos electrónicos actualizados"
products_countinteger
Example: 7
orderinteger
Example: 1
subcategoriesArray of objects
Response
application/json
{
  "web_id": "I7ROmS7Jui",
  "name": "Electrónica",
  "description": "Productos electrónicos actualizados",
  "products_count": 7,
  "order": 1,
  "subcategories": [
    { … }
  ]
}

Delete Category

Request

Elimina una categoría y todas sus subcategorías

Security
api-key
Path
idstringrequired

Web ID de la categoría

Example: I7ROmS7Jui
curl -i -X DELETE \
  https://mercately.shop/api/v1/categories/web_id \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Category deleted successfully

Bodyapplication/json
web_idstring
Example: "I7ROmS7Jui"
namestring
Example: "Electrónica"
descriptionstring
Example: "Productos electrónicos y dispositivos tecnológicos"
products_countinteger
Example: 0
orderinteger
Example: 1
subcategoriesArray of objects
Response
application/json
{
  "web_id": "I7ROmS7Jui",
  "name": "Electrónica",
  "description": "Productos electrónicos y dispositivos tecnológicos",
  "products_count": 0,
  "order": 1,
  "subcategories": [
    { … }
  ]
}

Customer events

Operations
Copyleft © Mercately Inc.