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

Create Variant

Request

Crea una nueva variante (ProductVariantCombination) para un producto existente.

Creación incremental

Este endpoint permite agregar una sola variante a un producto sin afectar las variantes existentes.

Ideal para integraciones POS que necesitan agregar SKUs uno por uno sin reenviar todo el catálogo.

Ejemplo: Crear variante con una opción

{ "variant": { "option1": "XXL", "price": 35.00, "quantity": 10, "sku": "CAMISETA-XXL" } }

Ejemplo: Crear variante con múltiples opciones

{ "variant": { "option1": "XXL", "option2": "Azul", "price": 35.00, "quantity": 10, "sku": "CAMISETA-XXL-AZUL" } }

Notas importantes

  • Los valores de option1, option2, option3 deben existir en las opciones del producto.
  • Si la combinación ya existe, retorna error 409 Conflict.
  • Las variantes existentes no se ven afectadas.
Security
api-key
Path
product_web_idstringrequired

El web_id del producto al que se agregará la variante

Example: FzOWVvUwbC
Bodyapplication/json
variantobjectrequired
variant.​option1stringrequired

Valor de la primera opción (debe existir en el producto)

Example: "XXL"
variant.​option2string

Valor de la segunda opción (opcional)

Example: "Azul"
variant.​option3string

Valor de la tercera opción (opcional)

Example: "Algodón"
variant.​pricenumber

Precio de venta

Example: 35
variant.​wholesale_pricenumber

Precio mayorista

Example: 28
variant.​quantityinteger

Cantidad en stock

Example: 10
variant.​skustring

Código SKU único

Example: "CAMISETA-XXL-AZUL"
variant.​selling_without_stockboolean

Permitir venta sin stock

Example: false
variant.​variant_urlstring

URL de la variante

Example: "https://example.com/product?variant=123"
curl -i -X POST \
  https://mercately.shop/api/v1/products/product_web_id/variants \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "variant": {
      "option1": "XXL",
      "option2": "Azul",
      "option3": "Algodón",
      "price": 35,
      "wholesale_price": 28,
      "quantity": 10,
      "sku": "CAMISETA-XXL-AZUL",
      "selling_without_stock": false,
      "variant_url": "https://example.com/product?variant=123"
    }
  }'

Responses

Created

Bodyapplication/json
object
Response
application/json
{
  "message": "Variante creada con éxito",
  "variant": {
    "web_id": "newVariantId",
    "name": "XXL/Azul",
    "price": "35.0",
    "wholesale_price": "28.0",
    "sku": "CAMISETA-XXL-AZUL",
    "quantity": 10,
    "variant_option_web_ids": [ … ],
    "image": "",
    "variant_url": "https://example.com/product?variant=123"
  }
}

Get Variant

Request

Obtiene una variante (ProductVariantCombination) por su web_id.

Consulta individual

Este endpoint retorna una sola variante sin traer el producto completo.

Ideal para integraciones POS que necesitan verificar el estado de una variante específica.

Security
api-key
Path
web_idstringrequired

El web_id de la variante a consultar

Example: x0wsCBTIMI
curl -i -X GET \
  https://mercately.shop/api/v1/variants/x0wsCBTIMI \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
object
Response
application/json
{
  "variant": {
    "web_id": "x0wsCBTIMI",
    "name": "SM/Azul",
    "price": "100.0",
    "wholesale_price": "80.0",
    "sku": "VAR-SM-001",
    "quantity": 50,
    "variant_option_web_ids": [ … ],
    "image": "https://example.com/image.webp",
    "variant_url": "https://example.com/variant"
  }
}

Update Variant

Request

Actualiza una variante (ProductVariantCombination) de forma parcial.

Actualización parcial

Este endpoint permite actualizar solo los campos enviados sin afectar otros atributos de la variante, otras variantes del producto, ni el producto padre.

Ideal para integraciones POS que necesitan actualizar precio o stock de una variante específica sin reenviar el producto completo.

Ejemplo: Actualizar solo el precio

{ "variant": { "price": 150.00 } }

Ejemplo: Actualizar precio y stock

{ "variant": { "price": 150.00, "quantity": 25 } }

Ejemplo: Actualizar múltiples atributos

{ "variant": { "price": 200.00, "wholesale_price": 150.00, "quantity": 100, "sku": "NEW-SKU-001", "selling_without_stock": true } } parameters:

  • name: web_id in: path required: true description: El web_id de la variante a actualizar schema: type: string example: "x0wsCBTIMI"
Security
api-key
Bodyapplication/json
variantobject

Solo envía los campos que deseas actualizar

curl -i -X PATCH \
  'https://mercately.shop/api/v1/variants/{web_id}' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "variant": {
      "price": 150,
      "wholesale_price": 120,
      "quantity": 50,
      "sku": "VAR-SM-001",
      "selling_without_stock": false,
      "variant_url": "https://example.com/product?variant=123",
      "image": "string"
    }
  }'

Responses

OK

Bodyapplication/json
object
Response
application/json
{
  "message": "Variante actualizada con éxito",
  "variant": {
    "web_id": "x0wsCBTIMI",
    "name": "SM/Azul",
    "price": "150.0",
    "wholesale_price": "120.0",
    "sku": "VAR-SM-001",
    "quantity": 50,
    "variant_option_web_ids": [ … ],
    "image": "https://dc2p3rqc7bvrd.cloudfront.net/uploads/1/product_variant_combination/x0wsCBTIMI/image.webp",
    "variant_url": "https://example.com/product?variant=123"
  }
}

Delete Variant

Request

Elimina una variante (ProductVariantCombination) de forma explícita.

Borrado inteligente

Este endpoint elimina solo la variante indicada sin afectar otras variantes del producto ni el producto padre.

Comportamiento según integridad:

  • Si la variante no tiene órdenes asociadas → Hard delete (eliminación permanente)
  • Si la variante tiene órdenes asociadas → Soft delete (marca deleted_at, preserva historial)

Ideal para integraciones POS que necesitan eliminar SKUs descontinuados sin afectar el catálogo completo.

Notas importantes

  • El producto padre permanece intacto
  • Las demás variantes no se ven afectadas
  • Los ProductVariant y ProductVariantOption no se eliminan
  • El borrado es explícito, nunca por omisión
Security
api-key
Path
web_idstringrequired

El web_id de la variante a eliminar

Example: x0wsCBTIMI
curl -i -X DELETE \
  https://mercately.shop/api/v1/variants/x0wsCBTIMI \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

No Content - Variante eliminada exitosamente

Response
No content

Categories

Obtén todas las categorías creadas en Mercately

Operations

Customer events

Operations
Copyleft © Mercately Inc.