Obtener Listado de Transacciones

Este método permite obtener las transacciones realizadas en la taquilla de Colaborador, aplicando diversos filtros y utilizando paginación.

1. Método de Acceso

Parámetro	Descripción
URL (versión por defecto 3.21)	{baseurl}/api/transaction
URL (versión actual 3.60)	{baseurl}/api/transaction&api-version=3.60
Verbo HTTP	GET
Longitud máxima de URL	2048 caracteres

2. Filtros Disponibles en la Query String

La API permite filtrar por diferentes criterios en la URL:

Campo	Descripción
ApiKey	Clave única y privada para el colaborador.
LanguageCode	Define el idioma en que se mostrarán los textos (es, en, fr, it, etc.).
SaleId	Devuelve la transacción que corresponde a este identificador de venta.
ReservationId	Devuelve la transacción asociada al identificador de reserva.
PartnerSaleId	Devuelve la transacción asociada a este identificador interno del colaborador.
PointOfSaleId	Filtra por el identificador del punto de venta.
PointOfSaleCustomCode	Filtra por el identificador del punto de venta de Colaborador.
FromTransactionDateTime	Filtra por fecha de transacción desde esta fecha (formato ISO 8601).
ToTransactionDateTime	Filtra por fecha de transacción hasta esta fecha (formato ISO 8601).
FromAccessDateTime	Filtra por fecha de acceso desde esta fecha.
ToAccessDateTime	Filtra por fecha de acceso hasta esta fecha.
ClientEmail	Filtra por email del cliente.
ClientName	Filtra por nombre del cliente.
ClientPhone	Filtra por teléfono del cliente.
ClientDocumentIdentifier	Filtra por número de identificación del cliente.
FromCancelledDateTime	Devuelve transacciones canceladas desde esta fecha.
ToCancelledDateTime	Devuelve transacciones canceladas hasta esta fecha.
PageSize	Define cuántas transacciones devolver (máximo 200).
Page	Página de resultados a devolver (por defecto 1).

3. Ejemplo de Peticiones

🔹 Obtener las últimas 200 transacciones

plaintext

CopiarEditar

GET {baseurl}/api/transaction?ApiKey=xyz123

🔹 Filtrar transacciones creadas entre el 1 de enero de 2000 y el 15 de agosto de 2000

GET {baseurl}/api/transaction?ApiKey=xyz123&FromTransactionDateTime=2000-01-01&ToTransactionDateTime=2000-08-15

🔹 Obtener transacciones con fecha de acceso entre el 1 de febrero de 2000 y el 1 de septiembre de 2000

GET {baseurl}/api/transaction?ApiKey=xyz123&FromAccessDateTime=2000-02-01&ToAccessDateTime=2000-09-01

🔹 Paginación: Obtener las transacciones de la quinta página (de la 501 a la 600)

GET {baseurl}/api/transaction?ApiKey=xyz123&PageSize=100&Page=5

🔹 Combinación de filtros y paginación

GET {baseurl}/api/transaction?ApiKey=xyz123&PageSize=100&Page=5&FromTransactionDateTime=2000-01-01&ToTransactionDateTime=2000-08-15&FromAccessDateTime=2000-02-01&ToAccessDateTime=2000-09-01

4. Estructura de la Respuesta

La respuesta devuelve un array de transacciones, junto con información de paginación.

🔹 Campos de la Respuesta

Campo	Descripción
Success	true si la solicitud fue exitosa, false en caso de error.
Timestamp	Marca de tiempo de la respuesta.
ErrorMessage	Mensaje de error si la solicitud falla.
PageNumber	Número de página solicitada.
PageSize	Número de transacciones devueltas por página.
PageCount	Número total de páginas disponibles.
HasPreviousPage	true si hay una página anterior.
HasNextPage	true si hay una página siguiente.
Transactions	Array de transacciones encontradas.

5. Ejemplo de Respuesta Exitosa

{

"Transactions": [

{

"TransactionId": "1234567890",

"SaleId": "1234567890",

"PaymentStatus": 3,

"PartnerPaymentType": 1,

"AccessDateTime": "2014-05-03T00:00:00",

"TransactionDateTime": "2014-04-23T00:00:00",

"Client": {

"FullName": "Jack Harkness",

"Email": "jhdw@experticket.com"

"Products": [

{

"ProductId": "ctgyir9m9q4bo",

"AccessCode": "505863569872139692",

"Price": 42.00,

"Tickets": [

{

"TicketId": "1tqgtrf7ctefc",

"AccessCode": "505863569872139692"

}

]

}

]

{

"TransactionId": "0/4611965972426965169",

"SaleId": "1234567890",

"AccessDateTime": "2011-09-24T00:00:00",

"TransactionDateTime": "2011-09-23T00:00:00",

"Client": {

"FullName": "Clara Oswald",

"Email": "codw@gmail.com"

"Products": [

{

"ProductId": "htgy4tgm9q21n",

"AccessCode": "468363134570091567",

"Price": 59.90,

"Tickets": [

{

"TicketId": "1tqgtrf7ctefc",

"AccessCode": "468363134570091567"

}

]

}

]

}

"PageNumber": 1,

"PageSize": 2,

"TotalItemCount": 101915,

"PageCount": 50958,

"HasPreviousPage": false,

"HasNextPage": true,

"IsFirstPage": true,

"IsLastPage": false,

"Success": true,

"Timestamp": "2021-02-18T17:02:27.8165916"

}

6. Consideraciones Finales

Puedes obtener hasta 200 transacciones por solicitud.
Usa paginación para explorar grandes volúmenes de datos.
Aprovecha los filtros para reducir la cantidad de datos retornados.
Si Success = false, revisar ErrorMessage y ErrorCodes.
Almacena los SaleId y PartnerSaleId para futuras referencias y consultas.

Home

API