mirlo

Productos

Gestionar productos, catalogos y costos

Endpoints

MetodoRutaDescripcion
GET/organizations/{organization_id}/productsListar productos
POST/organizations/{organization_id}/productsCrear producto
GET/organizations/{organization_id}/products/:idObtener producto
PATCH/organizations/{organization_id}/products/:idActualizar producto
DELETE/organizations/{organization_id}/products/:idEliminar producto
PUT/organizations/{organization_id}/products/replaceReemplazar todos los productos
GET/organizations/{organization_id}/products/catalogsListar catalogos
POST/organizations/{organization_id}/products/catalogsCrear catalogo
PATCH/organizations/{organization_id}/products/catalogs/:idActualizar catalogo
DELETE/organizations/{organization_id}/products/catalogs/:idEliminar catalogo
GET/organizations/{organization_id}/products/catalogs/:id/productsProductos de un catalogo
PUT/organizations/{organization_id}/products/catalogs/:id/productsReemplazar productos de un catalogo
GET/organizations/{organization_id}/products/:id/costObtener costo interno
PUT/organizations/{organization_id}/products/:id/costActualizar costo interno
DELETE/organizations/{organization_id}/products/:id/costEliminar costo interno

Crear Producto

curl -X POST "https://api.mirlo.com/v1/crm/organizations/{organization_id}/products" \
  -H "X-API-Key: sk_live_tu_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Plan Enterprise",
    "description": "Plan empresarial con agentes ilimitados",
    "sku": "PLAN-ENT-001",
    "category": "planes",
    "price_amount": 4999,
    "price_currency": "MXN",
    "status": "active",
    "media": [
      {
        "kind": "image",
        "uri": "https://example.com/plan-enterprise.jpg",
        "content_type": "image/jpeg",
        "is_primary": true
      }
    ]
  }'

Body

CampoTipoRequeridoDescripcion
namestringSiNombre del producto
sourcestringNomanual o integration
external_product_idstringNoID del producto en sistema externo
descriptionstringNoDescripcion del producto
skustringNoSKU
categorystringNoCategoria
price_amountnumberNoPrecio
price_currencystringNoMoneda (default: MXN)
product_urlstringNoURL del producto
statusstringNoEstado del producto
metadataobjectNoDatos adicionales
mediaarrayNoArchivos multimedia
catalog_idstringNoUUID del catalogo

Media

CampoTipoRequeridoDescripcion
kindstringSiTipo: image, video, etc.
uristringSiURL del archivo
content_typestringNoMIME type
filenamestringNoNombre del archivo
size_bytesnumberNoTamano en bytes
positionnumberNoOrden de visualizacion
is_primarybooleanNoSi es la imagen principal

Listar Productos

curl "https://api.mirlo.com/v1/crm/organizations/{organization_id}/products?search=plan&status=active&limit=20" \
  -H "X-API-Key: sk_live_tu_api_key"
ParametroTipoDescripcion
searchstringBusqueda por nombre
sourcestringFiltrar por origen
statusstringFiltrar por estado
limitnumberMax resultados (default: 100, max: 500)
offsetnumberOffset para paginacion

Catalogos

curl -X POST "https://api.mirlo.com/v1/crm/organizations/{organization_id}/products/catalogs" \
  -H "X-API-Key: sk_live_tu_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Catalogo Principal",
    "description": "Productos disponibles para venta",
    "is_default": true,
    "status": "active"
  }'
CampoTipoRequeridoDescripcion
namestringSiNombre del catalogo
descriptionstringNoDescripcion
is_defaultbooleanNoSi es el catalogo por defecto
statusstringNoEstado
is_publicbooleanNoPublicar como pagina publica
public_slugstringNoSlug para la URL publica (ej: mi-tienda)
public_configobjectNoConfiguracion de la pagina publica
curl -X PUT "https://api.mirlo.com/v1/crm/organizations/{organization_id}/products/catalogs/{catalog_id}/products" \
  -H "X-API-Key: sk_live_tu_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": ["prod-uuid-1", "prod-uuid-2"]
  }'

Costos Internos

Los costos se gestionan separados del producto para no exponerlos en catalogos publicos ni agentes.

Actualizar Costo

curl -X PUT "https://api.mirlo.com/v1/crm/organizations/{organization_id}/products/{product_id}/cost" \
  -H "X-API-Key: sk_live_tu_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "cost_amount": 2500,
    "cost_currency": "MXN"
  }'
CampoTipoRequeridoDescripcion
cost_amountnumberSiCosto del producto
cost_currencystringNoMoneda (default: MXN)
updated_bystringNoQuien actualizo

En esta pagina