Lost Reservation webhook
POST/
Responses
- 200
Order()
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
Purchase order ID.
Creation date.
Last modification date.
Buyer's name.
Buyer's email.
Buyer's document. E.g., CPF.
Buyer's phone.
Buyer's username.
Client ID.
Client name.
Client's CNPJ (company tax ID).
External or integration code defined for the client.
Checkout URL for the order.
items object[]required
Items included in the order. E.g., hotel reservations, airline tickets.
Item ID.
Possible values: [HOTEL]
Reservation type.
Creation date.
Last modification date.
Possible values: [CONFIRMED, CANCELLED, PENDING, LOST]
Current status.
Start date of the service. E.g., Check-in.
End date of the service. E.g., Check-out.
Supplier reservation locator, based on the credential type.
Supplier integration credential ID.
Supplier integration credential name.
Supplier integration credential type.
Contracted product ID, based on the item type (e.g., Hotel ID).
Contracted product name, based on the item type (e.g., hotel name).
City name.
ISO 3166-1 alpha-2 country code. E.g., BR.
Primary guest name.
Primary guest email.
Primary traveler's CPF (Brazilian taxpayer ID).
Primary guest phone number.
Type of payment method used with the supplier.
Description of the payment method used with the supplier.
paymentCreditCard objectnullable
Masked number of the credit card.
Cardholder's name.
Credit card brand.
Expire date of the credit card.
ID of the issuing user.
Name of the issuing user.
Amount payable to the supplier for the reservation, including taxes.
Purchase currency.
Original purchase currency.
Purchase amount of the reservation, including taxes.
Purchase amount of the reservation, including taxes.
Taxes included in the purchase amount, in the same currency as the purchase.
Sale amount of the reservation.
Sale currency.
Commission amount payable to the seller.
Currency of the commission payable.
Commission amount receivable for the sale.
Currency of the commission receivable.
Payment supplier ID for the item.
hotelRooms object[]nullable
Only for HOTEL type items. List of reserved rooms.
Room ID.
Room description.
guests object[]required
Guests indetification.
Guest first name.
Guest last name.
Possible values: [ADULT, CHILD]
Age qualifier.
Guest age.
Guest CPF.
Guest phone number.
Guest email.
Service start date. E.g., Check-in.
Service end date. E.g., Check-out.
Possible values: [CONFIRMED, CANCELLED, LOST]
Current room status.
Cancellation date. Applicable only when status = 'CANCELLED'.
Rate description.
Type of meal plan.
nights object[]required
Nights within the period.
Night date.
Percentage share of the night's value in the total room purchase value.
cancelPolicy objectnullable
Indicates if the rate is Non-Refundable.
Deadline date for cancellation without penalty.
Penalty amount in case of cancellation with penalty.
Penalty currency.
Indicates cancellation with penalty. Applicable only when status = 'CANCELLED'.
supplierCancelPolicy objectnullable
Indicates if the rate is Non-Refundable.
Deadline date for cancellation without penalty.
Penalty amount in case of cancellation with penalty.
Penalty currency.
Indicates cancellation with penalty. Applicable only when status = 'CANCELLED'.
Total purchase price of the room, including taxes.
Currency of room purchase.
Taxes included in the purchase price, in the same currency.
Promotional code used for the item purchase.
Promotional coupon used for the item purchase.
extraFields object[]nullable
Extra fields.
payments object[]required
Payments made to settle the order.
Payment transaction ID.
Possible values: [CREDITCARD, PIX, POINTS]
Payment type.
Currency used. ISO 4217 standard code. E.g., BRL.
Amount originally paid.
Refunded amount.
Creation date.
Last modification date.
Cancellation date.
Possible values: [CONFIRMED, CANCELLED, REFUNDED, PENDING, REJECTED, FAILED, PRE_CONFIRMED]
Current status of the transaction.
Transaction return message or error description.
IDs of order items paid partially or fully by this payment transaction.
Supplier integration credential ID.
Supplier integration credential name.
Type of integration credential with the supplier.
Transaction locator in the supplier integration, based on the credential type.
Only for CREDITCARD payment. Masked card number.
Only for CREDITCARD payment. Cardholder's name.
Only for CREDITCARD payment. Card brand.
Only for CREDITCARD payment. Card expiration date.
Only for CREDITCARD payment. Number of installments.
Only for CREDITCARD payment. Capture date.
Only for CREDITCARD payment. Authorization code.
Only for CREDITCARD payment. NSU (Unique Transaction Number).
Only for CREDITCARD payment. Acquirer, when available.
Only for CREDITCARD payment. Transaction ID with the acquirer, when available.
Only for CREDITCARD payment. 3DS authorization used.
paidItems object[]
PaymentOption details of the order items paid partially or fully with this payment transaction.
loyaltyRewards object[]required
Loyalty program rewards generated from the order.
Loyalty transaction ID.
Possible values: [POINTS, CASHBACK]
Type of loyalty benefit.
Value of the benefit, according to its type. E.g., number of points or monetary value via cashback.
Cashback only. Currency used. ISO 4217 standard code. E.g., BRL.
Creation date.
Last modification date.
Possible values: [PENDING, CONFIRMED, CANCELLED, REFUNDED, REJECTED]
Current status of the transaction.
Points only. Description of the point type.
Credential ID of the integration with the supplier.
Supplier integration credential name.
Type of integration credential with the supplier.
Accumulation transaction locator in the supplier integration, based on the credential type.
suppliers object[]required
Supplier data for the items that make up the order.
Supplier ID.
Unique NIARA ID of this supplier.
Corporate name.
Trade name.
CNPJ (Brazilian company tax ID).
E-mail.
Phone number.
Address (street and number).
City.
State.
Postal code.
ISO 3166-1 alpha-2 country code. E.g., BR
Municipal registration.
State registration.
quotation objectnullable
Quotation ID.
Request ID in the integration.
ID of the request that generated the quotation.
ID of the lost reservation that originated the quotation.
Channel source of the quotation.
Creation date of the quotation.
Name of the person responsible for the quotation.
Default value: true
{
"id": "string",
"createDate": "string",
"updateDate": "string",
"buyerName": "string",
"buyerEmail": "string",
"buyerCpf": "string",
"buyerPhone": "string",
"buyerUsername": "string",
"clientId": "string",
"clientName": "string",
"clientVat": "string",
"clientExternalCode": "string",
"checkoutUrl": "string",
"items": [
{
"id": "string",
"createDate": "string",
"updateDate": "string",
"status": "CONFIRMED",
"startDate": "string",
"endDate": "string",
"locator": "string",
"credentialId": "string",
"credentialAlias": "string",
"credentialType": "string",
"productId": "string",
"productName": "string",
"cityName": "string",
"countryCode": "string",
"primaryGuestName": "string",
"primaryGuestEmail": "string",
"primaryGuestCpf": "string",
"primaryGuestPhone": "string",
"paymentType": "string",
"paymentAlias": "string",
"paymentCreditCard": {
"number": "string",
"holder": "string",
"brand": "string",
"expirationDate": "string"
},
"createdById": "string",
"createdByName": "string",
"totalReservationPayable": 0,
"totalReservationPayCurrency": "string",
"totalReservationOriginalPriceCurrency": "string",
"totalReservationOriginalPrice": 0,
"totalReservationPrice": 0,
"totalReservationTaxes": 0,
"totalReservationReceivable": 0,
"totalReservationReceiveCurrency": "string",
"totalCommissionPayable": 0,
"totalCommissionPayCurrency": "string",
"totalCommissionReceivable": 0,
"totalCommissionReceiveCurrency": "string",
"supplierId": "string",
"hotelRooms": [
{
"id": "string",
"name": "string",
"guests": [
{
"firstName": "string",
"lastName": "string",
"ageQualifying": "ADULT",
"age": 0,
"cpf": "string",
"phone": "string",
"email": "string"
}
],
"startDate": "string",
"endDate": "string",
"status": "CONFIRMED",
"cancelDate": "string",
"ratePlanName": "string",
"meal": "string",
"nights": [
{
"date": "string",
"percent": 0
}
],
"cancelPolicy": {
"nonRefundable": true,
"penaltyDate": "string",
"penaltyValue": 0,
"penaltyCurrency": "string",
"cancelledInPenalty": true
},
"supplierCancelPolicy": {
"nonRefundable": true,
"penaltyDate": "string",
"penaltyValue": 0,
"penaltyCurrency": "string",
"cancelledInPenalty": true
},
"totalRoomPrice": 0,
"totalRoomPriceCurrency": "string",
"totalRoomTaxes": 0
}
],
"promoCode": "string",
"couponCode": "string",
"extraFields": [
{
"label": "string",
"name": "string",
"valueInt": 0,
"valueStr": "string"
}
]
}
],
"payments": [
{
"id": "string",
"type": "CREDITCARD",
"currency": "string",
"amount": 0,
"amountCancelled": 0,
"createDate": "string",
"updateDate": "string",
"cancellationDate": "string",
"status": "CONFIRMED",
"message": "string",
"paidItemsIds": [
"string"
],
"credentialId": "string",
"credentialAlias": "string",
"credentialType": "string",
"locator": "string",
"creditCardNumber": "string",
"creditCardHolder": "string",
"creditCardBrand": "string",
"creditCardExpirationDate": "string",
"installments": 0,
"captureDate": "string",
"authorizationCode": "string",
"proofOfSale": "string",
"provider": "string",
"providerTransactionId": "string",
"is3DS": true,
"paidItems": [
{
"id": "string",
"amountCancelled": "string",
"amount": 0,
"exchangeAmountCancelled": 0,
"exchangeAmount": 0,
"exchangeCurrency": "string",
"exchangeRate": 0,
"currency": "string"
}
]
}
],
"loyaltyRewards": [
{
"id": "string",
"type": "POINTS",
"value": 0,
"currency": "string",
"createDate": "string",
"updateDate": "string",
"status": "PENDING",
"unit": "string",
"credentialId": "string",
"credentialAlias": "string",
"credentialType": "string",
"locator": "string"
}
],
"suppliers": [
{
"id": "string",
"niaraId": "string",
"corporateName": "string",
"brandName": "string",
"vat": "string",
"email": "string",
"phone": "string",
"address": "string",
"cityName": "string",
"stateName": "string",
"zipCode": "string",
"countryCode": "string",
"cityRegistration": "string",
"stateRegistration": "string"
}
],
"quotation": {
"id": "string",
"externalId": "string",
"requestId": "string",
"lostReservationId": "string",
"channelSource": "string",
"createdAt": "string",
"responsible": "string"
},
"ignoreApiMetadata": true
}