Productos

Consultar todos los productos

Consulta todos los productos activos del negocio del usuario autenticado.

Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}

Ejemplos de uso:

  • Consultar todos los productos: GET /products
  • Con paginación: GET /products?pagination=true&limit=10&page=0
  • Filtrar por categoría: GET /products?categoryId=507f1f77bcf86cd799439013
  • Buscar por nombre: GET /products?name=Hamburguesa
  • Incluir ingredientes: GET /products?includeIngredients=true
  • Productos para Rappi: GET /products?useInRappi=true
  • Tipos específicos: GET /products?types=Combo,Subproducto
  • Combinado: GET /products?pagination=true&limit=20&page=1&categoryId=123&name=Pizza&useInRappi=true
get/products

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/products
  • Auth
    HTTP bearer

Query parameters

paginationboolean

Habilitar paginación de resultados

limitinteger

Número de elementos por página (solo cuando pagination=true)

pageinteger

Número de página (basado en 0, solo cuando pagination=true)

includeIngredientsboolean

Si incluir ingredientes en los resultados

typesstring

Tipos de productos separados por coma (Combo, Subproducto)

categoryIdstring

ID de la categoría para filtrar productos

namestring

Nombre o código de barras del producto para búsqueda

inventoryTypestring

Tipo de inventario para filtrar

useInRappiboolean

Filtrar productos que se usan en Rappi

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token JWT obtenido del campo tokenCurrent en el servicio de login

Response

Lista de productos obtenida exitosamente

_idstring

ID único del producto

businessstring

ID del negocio al que pertenece el producto

categorystring

ID de la categoría del producto

namestring

Nombre del producto

nameShortstring

Nombre corto del producto

descriptionstring

Descripción del producto

pricenumber

Precio base del producto (deprecado)

pricePurchasenumber

Costo de compra

urlImagestring

URL de la imagen del producto

barcodestring

Código de barras del producto

taxstring

ID del impuesto

promostring

ID de la promoción

unitstring

ID de la unidad

stocknumber

Stock total

stockMinimumnumber

Stock mínimo

subProductsstring[]

Subproductos

parentstring

ID del producto padre

weekdaysnumber[]

Días de la semana (1-7) en que aplica

notesstring[]

Notas del producto

isIngredientboolean

Si el producto es un ingrediente

isActiveboolean

Si el producto está activo

isSubproductboolean

Si el producto es subproducto

discountInventoryboolean

Si descuenta inventario

withoutIngredientsboolean

Si no maneja ingredientes

inventoryTypestring

Tipo de inventario (WithIngredients|PerUnit|Mixed|None)

typestring

Tipo de producto (Normal|Subproducto|Ingrediente|Combo)

waiterOrderAreastring

ID del área de pedidos

deletedboolean

Si el producto está eliminado

modifiedOnstring date-time

Fecha de última modificación

createdOnstring date-time

Fecha de creación

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "business": "507f1f77bcf86cd799439012",
    "category": "507f1f77bcf86cd799439013",
    "name": "Hamburguesa Clásica",
    "nameShort": "Hamb. Clásica",
    "description": "Deliciosa hamburguesa con carne, lechuga y tomate",
    "price": 15000,
    "pricePurchase": 9000,
    "urlImage": "https://ejemplo.com/hamburguesa.jpg",
    "barcode": "1234567890123",
    "tax": "507f1f77bcf86cd799439020",
    "promo": "507f1f77bcf86cd799439021",
    "unit": "507f1f77bcf86cd799439030",
    "stock": 50,
    "stockMinimum": 5,
    "variablePrice": {
      "type": "MayorValor"
    },
    "isActive": true,
    "discountInventory": true,
    "inventoryType": "PerUnit",
    "type": "Normal",
    "configCombo": {
      "options": [
        {
          "selectionType": "All",
          "name": "Opción"
        }
      ]
    },
    "modifiedOn": "2025-08-04T10:30:00.000Z",
    "createdOn": "2025-08-01T09:15:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.