KIU_PurchaseItemRQ/RS
INDICE DE CONTENIDO
Objetivo:
Mensaje utilizado para emitir EMD-S (Electronic Miscellaneous Document-Standalone, Documento Electrónico Misceláneo-Autónomo). Estos documentos funcionan como un ticket, y permiten ofrecerle al cliente final productos o servicios relacionados a su itinerario, por fuera del costo de los pasajes.
KIU_PurchaseItemRQ
Ejemplo de Modelo de Request
KIU_PurchaseItemRQ - Sin PNR
<KIU_PurchaseItemRQ EchoToken="1" TimeStamp="2015-11-04T12:45:57-03:00" Target="Testing" Version="3.0" SequenceNmbr="1" PrimaryLangID="en-us" ForceIssue="true">
<POS>
<Source AgentSine="AEP00XXSM" TerminalID="AEP00XX816">
<RequestorID Type="5" />
<BookingChannel Type="1" />
</Source>
</POS>
<Orders CarrierCode="XX">
<Order>
<Products>
<Product ProductID="D98F" ProductIssueDate="2015-11-30" LocationCode="BUE" Amount="1200.00" CurrencyCode="ARS" />
<Product ProductID="D98J" ProductIssueDate="2015-11-30" LocationCode="BUE" Amount="500.00" CurrencyCode="ARS" />
</Products>
<Taxes>
<Tax TaxCode="AR" Amount="120.00" />
<Tax TaxCode="DL" Amount="45.00" />
</Taxes>
</Order>
</Orders>
<PaymentInformation PaymentType="5">
<PaymentCard CardType="1" CardCode="VI" CardNumber="4242424242424242" SeriesCode="123" ExpireDate="1213" />
<FiscalCode>123456789</FiscalCode>
<Endorsement Text="ENDOSO" />
</PaymentInformation>
<RecipientInfos>
<RecipientInfo>
<PersonName>
<GivenName>JUAN</GivenName>
<Surname>PEREZ</Surname>
</PersonName>
<Document DocID="123456789" DocType="NI" />
</RecipientInfo>
</RecipientInfos>
<Comments>
<Comment>
<Text>COMENTARIO</Text>
</Comment>
</Comments>
</KIU_PurchaseItemRQ>
KIU_PurchaseItemRQ - Asociado a Reserva
<KIU_PurchaseItemRQ EchoToken="1" TimeStamp="2015-11-04T12:45:57-03:00" Target="Testing" Version="3.0" SequenceNmbr="1" PrimaryLangID="en-us" ForceIssue="true">
<POS>
<Source AgentSine="AEP00XXSM" TerminalID="AEP00XX818">
<RequestorID Type="5" />
<BookingChannel Type="1" />
</Source>
</POS>
<Orders CarrierCode="XX">
<Order>
<Products>
<Product ProductID="E0BX" ProductIssueDate="2019-01-03" LocationCode="BUE" Amount="1200.00" CurrencyCode="ARS" />
</Products>
<Taxes>
<Tax TaxCode="AR" Amount="120.00" />
<Tax TaxCode="DL" Amount="45.00" />
</Taxes>
<TicketItemInfo TicketNumber="9990210003329" CouponNumber="1" />
</Order>
</Orders>
<PaymentInformation PaymentType="5">
<PaymentCard CardType="1" CardCode="VI" CardNumber="4242424242424242" SeriesCode="123" ExpireDate="1219" />
<FiscalCode>123456789</FiscalCode>
<Endorsement Text="ENDOSO" />
</PaymentInformation>
<RecipientInfos>
<RecipientInfo RPH="1" />
</RecipientInfos>
<Comments>
<Comment>
<Text>COMENTARIO</Text>
</Comment>
</Comments>
<UniqueID ID="BCECPI" />
</KIU_PurchaseItemRQ>
Elementos del mensaje KIU_PurchaseItemRQ:
ForceIssue: [true|false]. Optativo. Si este atributo es enviado en “true”, se forzará la emisión de los productos solicitados incluso en los casos en los que la emisión normalmente fallaría para los productos que se emiten por defecto con status FLOWN en lugar de OPEN FOR USE. El comportamiento por defecto es equivalente a enviar este atributo con valor “false”, o no enviarlo.
POS: Elemento que agrupa la información del Punto de Venta desde el cual se realiza la petición.
Source: Contenedor de los datos del Punto de Venta o POS
AgentSine: Alfanumérico[9]. Identificador del agente que realiza la petición.
TerminalID: Alfanumérico[10]. Código identificador del dispositivo desde el que se realiza la petición.
Orders: Elemento que agrupa las órdenes de emisión de EMD-S.
CarrierCode: Alfanumérico[2]. Optativo. Código IATA de la aerolínea que proveerá los productos solicitados. Este parámetro es obligatorio para las llamadas provinientes de una agencia de viajes, y no se tiene en cuenta cuando es enviado por una aerolínea.
Order: Contenedor para la información de cada una de las órdenes.
Products: Elemento que agrupa los productos de cada orden de emisión.
Product: Contenedor para la información de cada producto. Pueden incluirse hasta un máximo de cuatro productos en la misma llamada.
ProductID: Alfanumérico[4]. Código identificador del producto solicitado.
ProductIssueDate: Fecha ISO. Optativo. Fecha para la cual es aplicable el producto solicitado. Algunos productos la requieren obligatoriamente, mientras que para otros es obligatorio no incluirla.
LocationCode: Alfabético[3]. Optativo. Código del aeropuerto en el cual se aplica el producto solicitado. Algunos productos lo requieren obligatoriamente, mientras que para otros es obligatorio no incluirlo.
Amount: Decimal. Precio del producto solicitado.
CurrencyCode: Alfabético[3]. Código ISO de la moneda en la cual se expresa el precio del producto solicitado. Debe ser el mismo para todos los productos.
Taxes: Elemento que agrupa las tasas e impuestos aplicables a los productos solicitados.
Tax: Contendor de información acerca de una tasa o impuesto específica.
TaxCode: Alfabético[2]. Código de la tasa extra a aplicar.
Amount: Decimal. Monto de la tasa.
TicketItemInfo: Optativo. Contenedor de información acerca de un ticket y cupón al que se desea asociar la compra de los productos solicitados.
TicketNumber: Entero[13]. Número del ticket al cual se desea asociar la compra.
CouponNumber: Entero. Optativo. Número de cupón del ticket al que se desea asociar la compra.
PaymentInformation: Elemento que agrupa la información acerca del medio de pago utilizado.
PaymentType: Entero. Código OTA de la forma de pago, listado en la OpenTravel Code List Payment Type (1: Cash, 5: Credit Card, 6: Debit Card, 7: Cheque, 34: Invoice, 37: Miscellaneous).
PaymentCard: Optativo. Elemento para la inclusión de información de tarjetas de crédito o débito (este elemento debe estar presente obligatoriamente cuando la forma de pago sea 5 ó 6).
CardType: Código OTA del tipo de tarjeta, listado en la OpenTravel Code List Card Type (1: credit, 2: debit).
CardCode: Alfabético[2]. Código de la entidad emisora de la tarjeta de crédito.
CardNumber: Entero[16]. Número de la tarjeta de crédito.
SeriesCode: Entero[6]. Dígitos de verificación de la tarjeta de crédito.
ExpireDate: Entero[4]. Fecha de vencimiento de la tarjeta, como figura en la misma.
ChequeNumber: Entero. Optativo. Número del cheque utilizado como forma de pago (este atributo debe estar presente obligatoriamente en el elemento PaymentInformation cuando la forma de pago sea 7).
InvoiceCode: Alfanumérico. Código de la cuenta corporativa del cliente utilizada como forma de pago (este atributo debe estar presente obligatoriamente en el elemento PaymentInformation cuando la forma de pago sea 34).
MiscellaneousCode: Alfabético. Código del tipo de pago misceláneo utilizado como forma de pago (este atributo debe estar presente obligatoriamente en el elemento PaymentInformation cuando la forma de pago sea 37 ).
FiscalCode: Entero. Optativo. Clave fiscal del cliente que efectúa la compra.
Endorsement: Optativo. Comentario acerca de cualquier restricción que aplique al caso, para el entendimiento entre el pasajero y la aerolínea.
Text: Alfanumérico con caracteres especiales [50]. Especifica la información acerca de la aprobación del ticket.
RecipientInfos: Elemento que agrupa la información acerca del pasajero que utilizará el producto adquirido.
RecipientInfo: Contenedor de información acerca del pasajero.
RPH: Entero. Optativo. Número de orden del pasajero dentro de la reserva a la que se desea asociar la compra del producto. Este atributo es obligatorio en caso de que se incluya el elemento UniqueID (ver más abajo), caso contrario será desestimado. Si no se incluye el UniqueID, es obligatoria la inclusión de los elementos detallados a continuación para informar los datos del pasajero.
PersonName: Elemento que agrupa la información acerca del nombre completo del pasajero.
GivenName: Alfabético[63]. Nombre.
Surname: Alfabético[63]. Apellido.
Document: Información acerca del documento.
DocID: Alfanumérico[46]. Número de documento de la persona.
DocType: Alfanumérico. Tipo de documento, según listado (NI: National Identity Document, PP: Passport, DL: Drivers licence, ID: Locally defined ID number, TN: Ticket number, CN: Confirmation number or record locator, CC: Credit card number, FF: Frequent flyer number). Los dos últimos tipos (CC y FF) deben obligatoriamente ir seguidos de dos caracteres extra, el código de la entidad emisora de la tarjeta de crédito (por ej. CCVI: tarjeta de crédito Visa), o la aerolínea a la cual pertenece el código de viajero frecuente utilizado (por ej. FFXX: número de viajero frecuente de Aerolíneas XX).
Comments: Optativo. Elemento que agrupa los comentarios en formato de texto acerca de la transacción.
Comment: Comentario.
Text: Alfanumérico con caracteres especiales[100]. Texto de comentarios generales acerca de la compra de los productos solicitados.
UniqueID: Optativo. Elemento que contiene la información acerca de la reserva a la que se desea asociar la compra de los productos solicitados. Si se envía este elemento, es obligatorio el envío del atributo RPH en el elemento RecipientInfo (ver más arriba).
ID: Alfabético[6]. Código identificador único dentro del sistema KIU de la reserva (PNR) a la que se desea asociar la compra de los productos solicitados.
KIU_PurchaseItemRS
Ejemplo de Respuesta:
KIU_PurchaseItemRS
<?xml version="1.0" encoding="UTF-8"?>
<KIU_PurchaseItemRS EchoToken="1" TimeStamp="2015-11-04T12:45:57-03:00" Target="Testing" Version="3.0" SequenceNmbr="1">
<Success />
<Orders OrderID="9995570005038" />
</KIU_PurchaseItemRS>
Elementos del mensaje KIU_PurchaseItemRS:
Orders: Elemento que agrupa los datos de los productos solicitados.
OrderID: Entero[13]. Número del EMD emitido.
Posibles Mensajes de error:
Código | Mensaje | Explicación |
10047 | Only one currency is allowed for all Products. | Se solicitaron al menos dos productos con códigos de moneda distintos. Se permite un único código de moneda para todos los productos. |
10048 | All Comments cannot be over 100 characters. | La sumatoria de las longitudes de todos los comentarios supera los 100 caracteres. |
11020 | Error at parameter GivenName. | El valor del atributo GivenName del elemento RecipientInfo no se corresponde con el formato descripto (alfabético en mayúsculas de hasta 63 caracteres). |
11021 | Error at parameter SurName. | El valor del atributo Surname del elemento RecipientInfo no se corresponde con el formato descripto (alfabético en mayúsculas de hasta 63 caracteres). |
11023 | Error at parameter PaymentType. | El valor del atributo PaymentType del elemento PaymentInformation no se corresponde con el formato descripto (1, 5, 6, 7, 34 ó 37). |
11026 | Error at parameter Endorsement. | El valor del atributo Text del elemento Endorsement no se corresponde con el formato descripto (alfanumérico en mayúsculas con caracteres especiales de hasta 50 caracteres). |
11031 | Error at parameter Document ID. | El valor del atributo DocID del elemento Document no se corresponde con el formato descripto (alfanumérico en mayúsculas de hasta 46 caracteres). |
11039 | Error at parameter PNR. | El PNR enviado no se corresponde con el formato descripto (alfabético en mayúsculas de seis caracteres). |
11040 | Error at parameter Ticket Number. | El número de ticket enviado en el atributo TicketNumber del elemento TicketItemInfo no se corresponde con el formato descripto (número entero de 13 dígitos). |
11042 | Error at parameter Document Type. | El valor del atributo DocType del elemento Document no se corresponde con el formato descripto (alfanumérico en mayúsculas de dos o cuatro caracteres, ver explicación detallada en la descripción del elemento DocType). |
11056 | Error at parameter RPH. | El valor del atributo RPH del elemento RecipientInfo no se corresponde con el formato descripto (número entero entre 1 y 99). |
Código | Mensaje | Explicación |
11059 | Error at parameter Text. | El valor del elemento Text del elemento Comment no se corresponde con el formato descripto (alfanumérico en mayúsculas con caracteres especiales de hasta 100 caracteres). |
11070 | Error at parameter CardCode. | El valor del atributo CardCode del elemento PaymentCard no se corresponde con el formato descripto (alfabético en mayúsculas de dos caracteres). |
11076 | Error at parameter tax Amount. | El valor del atributo Amount del elemento Tax no se corresponde con el formato descripto (numero positivo). |
11077 | Error at parameter tax Code. | El valor del atributo TaxCode del elemento Tax no se corresponde con el formato descripto (alfabético en mayúsculas de dos caracteres). |
11078 | Error at parameter CardNumber. | El valor del atributo CardNumber del elemento PaymentCard no se corresponde con el formato descripto (número entero de 16 dígitos). |
11079 | Error at parameter CardType. | El valor del atributo CardType del elemento PaymentCard no se corresponde con el formato descripto (1 ó 2). |
11080 | Error at parameter SeriesCode. | El valor del atributo CardNumber del elemento PaymentCard no se corresponde con el formato descripto (número entero de hasta 6 dígitos). |
11081 | Error at parameter ExpireDate. | El valor del atributo ExpireDate del elemento PaymentCard no se corresponde con el formato descripto (número entero de 4 dígitos). |
11082 | Error at parameter InvoiceCode. | El valor del atributo InvoiceCode del elemento PaymentInformation no se corresponde con el formato descripto (alfanumérico de hasta 31 caracteres). |
11083 | Error at parameter MiscellaneousCode. | El valor del atributo MiscellaneousCode del elemento PaymentInfo no se corresponde con el formato descripto (alfabético en mayúsculas de hasta 4 caracteres). |
11102 | Error at parameter CurrencyCode. | El valor del atributo CurrencyCode del elemento Product no se corresponde con el formato descripto (alfabético en mayúsculas de tres caracteres. |
11103 | Error at parameter CouponNumber. | El valor del atributo CouponNumber del elemento TicketItemInfo no se corresponde con el formato descripto (número entero mayor a cero). |
Código | Mensaje | Explicación |
11104 | Error at parameter ChequeNumber. | El valor del atributo ChequeNumber del elemento PaymentInformation no se corresponde con el formato descripto (número entero). |
11105 | Error at parameter FiscalCode. | El valor del elemento FiscalCode no se corresponde con el formato descripto (número entero). |
11106 | Error at parameter ForceIssue | El valor del atributo ForceIssue del elemento root no se corresponde con el formato descripto (“true”, “false” o vacío). |
12002 | The PNR does not correspond with an active reservation. | No existe en el sistema una reserva identificada por el PNR informado en la llamada perteneciente al usuario de Webservices. |
12007 | There are no more available areas for operation. Please try again. | El sistema no pudo procesar la petición por sobrecarga. Se recomienda reintentar. |
12008 | The supplied AgentSine does not have the proper duties for this action. | El AgentSine enviado no tiene los permisos necesarios para emitir un EMD. Contactarse con webservices@kiusys.com. |
12017 | At least one of the requested Product Code is not supported. | Se solicitó un producto con un código inexistente o no soportado por la aerolínea. |
12018 | The ProductIssueDate parameter is mandatory for at least one of the requested Product Code. | Alguno de los productos solicitados no informa el parámeto ProductIssueDate, pero el mismo es obligatorio para ese código de producto. |
12019 | The requested Product Codes combination is not supported. | Se solicitaron dos o más productos cuya combinación no es permitida por la aerolínea. |
12020 | The LocationCode parameter is mandatory for at least one of the requested Product Code. | Alguno de los productos solicitados no informa el parámeto LocationCode, pero el mismo es obligatorio para ese código de producto. |
12021 | At least one of the requested ProductIssueDate is out of the range supported by the airline. | Alguno de los productos solicitados informó en el parámetro ProductIssueDate una fecha que está fuera del rango permitido por la aerolínea. |
12022 | The Carrier does not support the selected form of payment. | Se informó una forma de pago no soportada por la aerolínea. |
12023 | At least one of the requested Product can only be issued with flown status. | Alguno de los productos solicitados sólo puede emitirse con status FLOWN. Si se desea emitir el producto de todas formas, se puede evitar este error enviando el el atributo ForceIssue con valor “true”. |
12024 | The requested Ticket number could not be found. | No existe en el sistema un ticket identificado por el número informado en la llamada perteneciente al usuario de Webservices. |
Código | Mensaje | Explicación |
12025 | The requested Coupon number could not be found. | El número de cupón solicitado no existe en el ticket informado. |
12026 | At least one of the requested Product does not allow a ProductIssueDate. | Alguno de los productos solicitados informa el parámetro ProductIssueDate, pero la aerolínea no lo soporta para ese código de producto puntual. |
12027 | The ExpireDate of the provided PaymentCard is invalid. | El valor del atributo ExpireDate del elemento PaymentCard no se corresponde con el formato descripto (número entero de cuatro dígitos). |
12028 | The CardCode of the provided PaymentCard is invalid. | El código de tarjeta ingresado en el atributo CardCode del elemento PaymentCard no es reconocido por la aerolínea. |