Upnify Documentación API
CRM · /catalogos/productos/buscar

Catálogos

Buscar productos

GET/catalogos/productos/buscar

Busca productos activos de la empresa. Puedes filtrar por texto, marca, línea, modelo, producto o código; la ruta devuelve como máximo 100 resultados ordenados por código y nombre.

Parámetros

NombreTipoValidaciónDescripción
buscarStringTexto que se busca en los datos indexados del producto.
tkLineaStringIdentificador de la línea de productos. Admite varios identificadores separados por comas.
tkMarcaStringIdentificador de la marca. Admite varios identificadores separados por comas.
tkModeloStringIdentificador del modelo. Admite varios identificadores separados por comas.
tkProductoStringIdentificador de un producto específico.
buscarCodigoIntegerCódigo numérico o fragmento numérico que se busca dentro del código del producto.

Respuesta

NombreTipoDescripción
indiceIntegerPosición del producto dentro del resultado.
linkStringURL base para acceder a las imágenes del producto.
imagenesArray<Object>Imágenes asociadas al producto.
codigoStringCódigo del producto.
nombreStringNombre del producto.
marcaStringNombre de la marca. Puede ser null.
tkMarcaStringIdentificador de la marca. Puede ser null.
lineaProductoStringNombre de la línea de productos. Puede ser null.
tkLineaStringIdentificador de la línea. Puede ser null.
modeloStringNombre del modelo. Puede ser null.
tkModeloStringIdentificador del modelo. Puede ser null.
precioMinFloatPrecio mínimo configurado.
costoFloatCosto del producto.
unidadStringUnidad de medida del producto.
claveProductoServicioStringClave de producto o servicio del SAT. Puede ser null.
descripcionCvpStringDescripción de la clave de producto o servicio. Puede ser null.
descripcionCortaStringDescripción corta del producto.
descripcionExtendidaStringDescripción extendida del producto. Puede ser null.
descripcionExtendida2StringSegunda descripción extendida del producto. Puede ser null.
claveUnidadStringClave de unidad del SAT. Puede ser null.
nombreUniStringNombre de la unidad. Puede ser null.
anexosArray<Object>Anexos asociados al producto. Puede ser null.
nivelIntegerNivel del producto en el resultado.
existenciaStringExistencia disponible; puede mostrar Ilimitado.
cantidadExistenciaFloatCantidad numérica de existencia.
statusIntegerEstado del producto: 1 activo o 0 inactivo.
statusTextoStringTexto del estado del producto.
tkProductoStringIdentificador del producto.
situacionInventarioIntegerSituación calculada del inventario.
personalizadosStringCampos personalizados serializados como JSON.
metadataStringMetadatos del producto serializados como JSON. Puede ser null.
lotesNoSePuedenMezclarIntegerIndica si los lotes no se pueden mezclar.
vendedorConfiguraDetallesIntegerIndica si el vendedor configura los detalles.
venderSinExistenciaIntegerIndica si se permite vender sin existencia.
tkAlmacenStringIdentificador del almacén. Puede ser null.
almacenStringNombre del almacén. Puede ser null.
bajoPedidoIntegerIndica si el producto se maneja bajo pedido.
existenciaAlmacenFloatExistencia del producto en el almacén.
situacionExistenciaIntegerSituación de la existencia en el almacén.
proveedorPredeterminadoStringProveedor predeterminado. Puede ser null.
esKitIntegerIndica si el producto es un kit.
requiereSerieIntegerIndica si requiere número de serie.
requiereLoteIntegerIndica si requiere lote.
requiereCaducidadIntegerIndica si requiere fecha de caducidad.
requierePedimentoIntegerIndica si requiere pedimento.

Solicitud

Buscar productos por texto y marca

curl --request GET \
  --url 'https://api.upnify.com/v4/catalogos/productos/buscar?buscar=camisa&tkMarca=MAR-00000000-0000-4000-8000-000000000011' \
  --header 'token: 00000000-0000-4000-8000-000000000001'

Respuesta

Productos encontrados

JSON
[
  {
    "indice": 1,
    "link": "https://files.example.com/empresa/",
    "imagenes": [
      {
        "nombre": "imagen1",
        "valor": "imagen-producto.png",
        "pordefecto": "1"
      }
    ],
    "codigo": "CAM-001",
    "nombre": "Camisa de ejemplo",
    "marca": "Marca de ejemplo",
    "tkMarca": "MAR-00000000-0000-4000-8000-000000000011",
    "lineaProducto": "Ropa",
    "tkLinea": "LINP-00000000-0000-4000-8000-000000000012",
    "modelo": null,
    "tkModelo": null,
    "precioMin": 250,
    "costo": 150,
    "unidad": "Pza",
    "claveProductoServicio": null,
    "descripcionCvp": null,
    "descripcionCorta": "Camisa de ejemplo",
    "descripcionExtendida": null,
    "descripcionExtendida2": null,
    "claveUnidad": "H87",
    "nombreUni": "Pieza",
    "anexos": null,
    "nivel": 1,
    "existencia": "10",
    "cantidadExistencia": 10,
    "status": 1,
    "statusTexto": "Activo",
    "tkProducto": "PRO-00000000-0000-4000-8000-000000000010",
    "situacionInventario": 1,
    "personalizados": "{}",
    "metadata": null,
    "lotesNoSePuedenMezclar": 0,
    "vendedorConfiguraDetalles": 1,
    "venderSinExistencia": 0,
    "tkAlmacen": null,
    "almacen": null,
    "bajoPedido": 0,
    "existenciaAlmacen": 10,
    "situacionExistencia": 1,
    "proveedorPredeterminado": null,
    "esKit": 0,
    "requiereSerie": 0,
    "requiereLote": 0,
    "requiereCaducidad": 0,
    "requierePedimento": 0
  }
]