Consulta de Aforo Disponible
El aforo disponible permite conocer cuántos boletos pueden venderse en una fecha específica para un producto, una categoría de productos (ProductBase) o una sesión. Antes de ofrecer un producto al cliente, es necesario verificar la disponibilidad, ya que si se ha superado el aforo, la transacción generará un error.
1. Método de Acceso
2. Estructura de Datos de Envío
Es necesario definir al menos un ProductBaseId, un ProductId o un SessionId para filtrar la consulta. Se pueden combinar varios identificadores y serán considerados como un OR.
Parámetros Disponibles
3. Consideraciones sobre el Aforo
- Para los productos y categorías con fechas de capacidad limitada (DaysWithLimitedCapacity), se debe consultar el aforo disponible antes de ofrecerlos al cliente.
- Si el aforo está superado, la transacción fallará y devolverá un error.
- El aforo aplica solo a tickets de tipo aforo (IsQuotaTicket == true).
-
La capacidad de un producto es la cantidad de boletos de tipo aforo que se pueden vender.
- Ejemplo: Si un producto está compuesto por 3 tickets de aforo y la capacidad disponible es 9, solo se pueden vender 3 productos (9 / 3 = 3).
- La capacidad de una categoría (ProductBase) es la suma de los tickets de tipo aforo de todos los productos que la componen.
Ejemplo de Cálculo del Aforo de una Categoría
Supongamos que la categoría ProductBaseId: gfo753rgjfbw6 contiene:
- Producto "ctgyir9m9q4bo" con 1 ticket de aforo.
- Producto "htgy4tgm9q21n" con 3 tickets de aforo.
Si el aforo total es 21, podríamos vender las siguientes combinaciones:
- 21 boletos de "ctgyir9m9q4bo" (21 × 1 = 21).
- 7 boletos de "htgy4tgm9q21n" (7 × 3 = 21).
- 6 boletos de "ctgyir9m9q4bo" + 5 boletos de "htgy4tgm9q21n" (6 × 1 + 5 × 3 = 21).
- Cualquier otra combinación equivalente.
4. Ejemplo de Llamadas a la API
Consulta de Aforo de un ProductBaseId para Todas las Fechas Disponibles
GET https://demo.api.experticket.com/api/availablecapacity?PartnerId=ptfhni79b311e&ProductBaseIds=MyProductBaseId
Consulta de Aforo de un ProductId Específico
GET https://demo.api.experticket.com/api/availablecapacity?PartnerId=ptfhni79b311e&ProductIds=MyProductId
Consulta de Aforo de Varias Sesiones
GET https://demo.api.experticket.com/api/availablecapacity?PartnerId=ptfhni79b311e&SessionIds=MySessionId_1&SessionIds=MySessionId_2
Consulta de Aforo en una Fecha Específica
Consulta de Aforo en un Rango de Fechas
Consulta Compleja Combinando Filtros
GET https://demo.api.experticket.com/api/availablecapacity?PartnerId=ptfhni79b311e&ProductBaseIds=Base1&ProductIds=Product1&SessionIds=Session1&FromDate=2025-08-01&ToDate=2025-08-31
5. Estructura de la Respuesta
6. Ejemplo de Respuesta Exitosa
{
"Products": [
{
"ProductId": "htgy4tgm9q21n",
"Date": "2025-08-15",
"AvailableCapacity": 9,
"Price": 30.50,
"PriceMode": 1
}
],
"Sessions": [
{
"SessionId": "session123",
"Date": "2025-08-15",
"AvailableCapacity": 5
}
],
"Success": true,
"Timestamp": "2025-08-15T12:00:00"
}
7. Ejemplo de Respuesta con Error
{
"Success": false,
"Timestamp": "2025-08-15T12:00:00",
"ErrorMessage": "Invalid PartnerId",
"ErrorEntityBreakDown": [
{
"Id": "12345",
"Name": "PartnerId Not Found"
}
]
}
8. Consideraciones
- El aforo disponible se debe consultar antes de procesar una compra para evitar errores.
- Se pueden filtrar productos, categorías o sesiones y trabajar con fechas específicas o rangos de fechas.
- Si se supera el aforo, la transacción fallará, por lo que es crucial validar la disponibilidad antes de ofrecer boletos a los clientes.
- La API devuelve los datos en formato ISO 8601, facilitando su procesamiento en cualquier aplicación.