LOloggro
Promociones

Consultar todas las promociones

Retorna todas las promociones activas (no eliminadas) del negocio del usuario autenticado, ordenadas por nombre. Si el negocio hereda productos del padre y tiene inheritParentsProducts habilitado, también incluye las promociones del negocio padre.

Autenticación requerida: Bearer Token obtenido del campo tokenCurrent en el servicio de login.

Authorization: Bearer {tokenCurrent}

get/promos

Request

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

Response

Lista de promociones obtenida exitosamente

_idstring

ID único de la promoción

businessstring

ID del negocio al que pertenece la promoción

namestring required

Nombre de la promoción

descriptionstring

Descripción de la promoción

type'Porcentaje' | 'ProcentajeCantidad' | 'Cantidad' required

Tipo de promoción: Porcentaje | ProcentajeCantidad | Cantidad

isActiveboolean

Indica si la promoción está activa

forDigitalMenuboolean

Indica si aplica para el menú digital

deletedboolean

Indica si la promoción fue eliminada (soft delete)

createdOnstring date-time

Fecha de creación

modifiedOnstring date-time

Fecha de última modificación

Example response

[
  {
    "_id": "507f1f77bcf86cd799439021",
    "business": "507f1f77bcf86cd799439012",
    "name": "2x1 en bebidas",
    "description": "Lleva 2 bebidas y paga solo 1",
    "type": "Porcentaje",
    "dateSettings": {
      "date": {
        "start": "2025-01-01T00:00:00.000Z",
        "final": "2025-12-31T23:59:59.000Z"
      },
      "days": [
        "L",
        "M",
        "X",
        "J",
        "V"
      ],
      "happyHours": {
        "hours": {
          "hourStart": {
            "hour": 18
          },
          "hourEnd": {
            "hour": 20
          }
        }
      }
    },
    "data": {
      "typePorcentaje": {
        "value": 15
      },
      "typePorcentajeCantidad": {
        "values": [
          {
            "qtyMin": 1,
            "qtyMax": 5,
            "value": 10
          }
        ]
      },
      "typeCantidad": {
        "takeAmount": 3,
        "payAmount": 2
      }
    },
    "isActive": true,
    "createdOn": "2025-01-15T08:30:00.000Z",
    "modifiedOn": "2025-06-10T14:00:00.000Z"
  }
]

Changes

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