Retrieve order data
GET/orders/:order_id
Retrieves details of a purchase order
Request
Path Parameters
Responses
- 200
Success
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- Array [
- ]
- ]
- 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. Ex: CPF (Brazilian individual taxpayer registry).
Buyer's phone number.
Buyer's username.
Buyer's passport.
Buyer's person ID.
buyerPersonLoyaltyData object[]nullable
List of the buyer's loyalty programs.
Loyalty program ID.
Loyalty programs alias.
Balance.
Next expiration.
Next expiration amount.
Loyalty value.
Client ID.
Client name.
Client's VAT number (CNPJ for Brazil).
External or integration code defined for the client.
items object[]required
Items that make up the order. Ex: hotel reservations, airline tickets.
Item ID.
Possible values: [HOTEL, ADDON, BUS, CAR]
Reservation type.
Creation date.
Last modification date.
Possible values: [CONFIRMED, WAITING_CONFIRMATION, CANCELLED, LOST]
Current status. WAITING_CONFIRMATION applies to CAR item type only, while the reservation awaits supplier confirmation (Ex: credit analysis pending).
Service start date. Always present when item type is HOTEL, BUS or CAR. Ex: Check-in, first leg's departure date for BUS, or pick-up date for CAR.
Service end date. Always present when item type is HOTEL, BUS or CAR. Ex: Check-out, last leg's arrival date for BUS, or return date for CAR.
Reservation locator with the supplier, according to the credential type.
Supplier integration credential ID.
Supplier integration credential name.
Supplier integration credential type.
Product/supplier ID of the contracted service, according to the item type. Ex: Hotel ID, Bus company ID, Rental company ID (CAR). References the suppliers node.
Name of the contracted product, according to the item type. Ex: Hotel Name, Bus company Name, Rental company Name (CAR)
Description of the contracted product, according to the item type. Ex: Addon Name
City name.
ISO 3166-1 alpha-2 country code. Ex: BR
Primary traveler's name. For CAR item type, the primary driver's name.
Primary traveler's email. For CAR item type, the primary driver's email.
Primary traveler's CPF (Brazilian individual taxpayer registry). For CAR item type, the primary driver's CPF.
Primary traveler's phone number. For CAR item type, the primary driver's phone number.
Primary traveler's passport. For CAR item type, the primary driver's passport.
Primary traveler's person ID.
Type of payment method to the supplier.
Description of the payment method to the supplier.
paymentCreditCard objectnullable
Masked card number.
Cardholder's name.
Card brand.
Card expiration date.
CAR item type only. Payment mode sent to the supplier: INVOICED or PAY_AT_COUNTER.
CAR item type only. Description of the payment mode sent to the supplier. Ex: Faturado, Direto no balcão.
ID of the issuing user.
Name of the issuing user.
Amount due to the supplier for the reservation purchase, including taxes. For CAR item type, considers only INVOICED charges; "0" when supplierPaymentType = PAY_AT_COUNTER.
Purchase currency (supplier).
Original purchase currency.
Reservation purchase value in the original currency, including taxes. For CAR item type, considers only INVOICED charges; "0" when supplierPaymentType = PAY_AT_COUNTER.
Reservation purchase price, including taxes, in the same purchase currency (client). For CAR item type, considers only INVOICED charges; "0" when supplierPaymentType = PAY_AT_COUNTER.
Taxes included in the purchase price, in the same purchase currency (client). For CAR item type, considers only INVOICED charges with type = TAX; "0" when supplierPaymentType = PAY_AT_COUNTER.
Insurance amount included in the reservation. CAR item type: always null — the protection cost is exported in carRentals[].charges with type = PROTECTION.
Insurance amount currency. CAR item type: always null.
Purchase currency (client).
Reservation sale value. For CAR item type, considers only INVOICED charges; "0" when supplierPaymentType = PAY_AT_COUNTER.
Sale currency.
CAR item type only. Total amount paid by the driver directly at the rental store (sum of PAY_AT_COUNTER charges). Informative: not included in totalReservationPayable, totalReservationReceivable or in payments. "0" when there is no pay-at-counter charge.
CAR item type only. Currency of totalReservationPayAtCounter.
Commission amount to be paid to the seller. For CAR item type, considers only INVOICED charges; "0" when supplierPaymentType = PAY_AT_COUNTER.
Currency of the commission to be paid.
Commission amount to be received for the sale. For CAR item type, considers only INVOICED charges; "0" when supplierPaymentType = PAY_AT_COUNTER.
Currency of the commission to be received.
Item's payment supplier ID.
hotelRooms object[]nullable
HOTEL item type only. List of reserved rooms.
Room ID.
Room description.
guests object[]required
Guest identification.
Guest's first name.
Guest's last name.
Possible values: [ADULT, CHILD]
Age qualifier.
Guest's age.
Guest's CPF (Brazilian individual taxpayer registry).
Guest's phone number.
Guest's email.
Guest's city.
Guest's address complement.
Guest's district/neighborhood.
Guest's street number.
Guest's state.
Guest's street.
Guest's zip code.
Guest's birth certificate.
Guest's country.
Guest's date of birth.
Guest's nationality.
Guest's passport.
Indicates the primary guest.
Guest's RG (Brazilian ID card).
Service start date. Ex: Check-in.
Service end date. Ex: Check-out.
Possible values: [CONFIRMED, CANCELLED, LOST]
Current room status.
Cancellation date. Only applicable when status = 'CANCELLED'.
Rate plan description.
Meal plan type
nights object[]required
Nightly stays for the period.
Date of the nightly stay.
Percentage share of the nightly rate in the total room purchase price.
cancelPolicy objectnullable
Indicates a non-refundable rate.
Deadline for cancellation without penalty.
Penalty amount, in case of cancellation with penalty.
Penalty currency.
Indicates cancellation with penalty. Only applicable when status = 'CANCELLED'.
supplierCancelPolicy objectnullable
Indicates a non-refundable rate.
Deadline for cancellation without penalty.
Penalty amount, in case of cancellation with penalty.
Penalty currency.
Indicates cancellation with penalty. Only applicable when status = 'CANCELLED'.
Room purchase price, including taxes.
Room purchase currency.
Taxes included in the purchase price, in the same purchase currency.
taxesBreakdown object[]
Tax details.
Tax value.
Tax currency.
Tax description.
Taxes included in the supplier price.
Currency of the taxes included in the supplier price.
supplierRoomTaxesBreakdown object[]
Supplier tax details.
Tax value.
Tax currency.
Tax description.
busRoutes object[]nullable
BUS item type only. List of legs/routes for this direction of the trip. Has two entries when this leg has a connection (baldeação); a round trip is not represented here — it produces two separate BUS items instead (one per direction), each with its own busRoutes.
Zero-based sequential index of this leg within the reservation's busRoutes, as a string: '0' for the direct/outbound leg, '1' for a connecting leg, '2' for a further connection if present, and so on. Not a supplier travel/connection identifier.
Operating bus company for this leg.
Service class/equipment type. Ex: 'Leito cama'.
departureLocation objectnullable
Terminal/station code.
Terminal/station name.
Departure date and time.
arrivalLocation objectnullable
Terminal/station code.
Terminal/station name.
Arrival date and time.
Current status of this leg.
guests object[]
Passengers of this leg.
Passenger's first name. Not available from the supplier today.
Passenger's last name. Not available from the supplier today.
Age qualifier (ADULT/CHILD). Not available from the supplier today.
Passenger's age. Not available from the supplier today.
Passenger's CPF (Brazilian individual taxpayer registry).
Passenger's phone number. Not available from the supplier today.
Passenger's email. Not available from the supplier today.
Passenger's gender. Not available from the supplier today.
Confirmed seat number. Not persisted from the booking confirmation today.
Supplier ticket number. Not persisted from the booking confirmation today.
Boarding voucher URL. Not persisted from the booking confirmation today.
Passenger's date of birth.
Passenger's nationality. Not available from the supplier today.
Passenger's passport. Not available from the supplier today.
Indicates the primary passenger. Not available from the supplier today.
Passenger's RG (Brazilian ID card). Not available from the supplier today.
Cancellation policy for this leg, as returned by the supplier.
Leg purchase price, including taxes.
Leg purchase currency.
Taxes included in the leg purchase price.
carRentals object[]nullable
CAR item type only. Car rental detail. Always has exactly one element.
Sequential index of the rental within the item ("0").
Rental company name.
Possible values: [CONFIRMED, WAITING_CONFIRMATION, CANCELLED]
Niara status of the rental, following the same mapping as the item status.
Original supplier status. Ex: Movida - Booked, Approved, Confirmed, Canceled.
Cancellation date/time. Null when not cancelled.
Pick-up date and time (UTC).
pickUpLocation objectnullable
Store/station code (IATA or Sabre). Ex: GRU.
Store/station name.
Store address.
Store city.
Store state code.
ISO 3166-1 alpha-2 country code. Ex: BR
Store phone number.
Store latitude, in decimal degrees.
Store longitude, in decimal degrees.
Return date and time (UTC).
returnLocation objectnullable
Store/station code (IATA or Sabre). Ex: GRU.
Store/station name.
Store address.
Store city.
Store state code.
ISO 3166-1 alpha-2 country code. Ex: BR
Store phone number.
Store latitude, in decimal degrees.
Store longitude, in decimal degrees.
Number of rental days.
vehicle objectnullable
Specifications not returned by the supplier are exported as null.
Vehicle group code. Ex: B.
Vehicle group description. Ex: Grupo B - Hatch Compacto 1.0.
ACRISS code. Ex: EDMR.
Reference vehicle model.
Indicates whether the reserved vehicle is the reference model "or similar".
Possible values: [MANUAL, AUTOMATIC]
Transmission type.
Indicates whether the vehicle has air conditioning.
Passenger capacity.
Baggage capacity.
Number of doors.
Mileage policy: UNLIMITED (free mileage) or the allowance informed by the supplier.
Vehicle image URL.
drivers object[]
Rental drivers.
Driver's first name.
Driver's last name.
Age qualifier (ADULT/CHILD), when informed.
Driver's age, when informed.
Driver's date of birth, when informed.
Driver's CPF (Brazilian individual taxpayer registry).
Driver's passport.
Driver's RG (Brazilian ID card).
Driver's nationality.
Driver's phone number.
Driver's email.
Indicates the primary driver.
Specific rate used in the reservation. Null when not used.
Promotional code used in the reservation. Null when not used.
charges object[]
Rental charges.
Possible values: [BASE_RATE, PROTECTION, EXTRA, ADDITIONAL_DRIVER, ONE_WAY_FEE, TAX]
Charge type: BASE_RATE (rate/daily rent), PROTECTION, EXTRA (optional), ADDITIONAL_DRIVER, ONE_WAY_FEE (one-way/return fee) or TAX (rental company tax).
Supplier code for the charge. Ex: LDW.
Charge description. Ex: Proteção do Veículo (LDW).
Charged quantity.
Possible values: [DAY, UNIT, RENTAL]
Charge unit: DAY (per rental day), UNIT (per unit) or RENTAL (per rental).
Possible values: [INVOICED, PAY_AT_COUNTER]
Payment mode for this charge: INVOICED (invoiced to the agency) or PAY_AT_COUNTER (paid by the driver at the store).
Supplier unit price.
Supplier total price.
Sale unit price.
Sale total price. Equal to supplierPrice when paymentMode = PAY_AT_COUNTER.
Markup applied to the charge. Zero when paymentMode = PAY_AT_COUNTER.
Commission applied to the charge. Zero when paymentMode = PAY_AT_COUNTER.
Charge currency.
Sum of the sale price of INVOICED charges.
Sum of the supplier price of INVOICED charges.
Sum of the sale price of PAY_AT_COUNTER charges.
Total rental value (invoiced + pay-at-counter). Equal to totalInvoicedPrice + totalPayAtCounterPrice.
Total rental value currency.
Sum of TAX type charges (invoiced and pay-at-counter).
cancelPolicy objectnullable
Indicates a non-refundable rate.
Deadline for cancellation without penalty.
Penalty amount, in case of cancellation with penalty.
Penalty currency.
Indicates cancellation with penalty. Only applicable when status = 'CANCELLED'.
supplierCancelPolicy objectnullable
Indicates a non-refundable rate.
Deadline for cancellation without penalty.
Penalty amount, in case of cancellation with penalty.
Penalty currency.
Indicates cancellation with penalty. Only applicable when status = 'CANCELLED'.
Rental company notices/warnings, as received from the supplier. Empty list when there are none.
Rental voucher (PDF) URL.
Promotional code used for the item purchase.
Promotional coupon used for the item purchase.
extraFields object[]nullable
Extra fields.
includeExtras object[]nullable
Included extra fields.
Billing comments.
Reservation's PMS Number.
ADDON item type only. Indicates whether the addon is a mandatory purchase.
ADDON item type only. If the addon is scheduled, indicates the scheduled date.
ADDON item type only. If the addon is scheduled, indicates the scheduled time.
ADDON item type only. Type or category of the addon. Ex: TRANSPORTATION_PRIVATE, MEAL, SERVICE, TICKET.
ADDON item type only. Scheduled datetime (ISO 8601) for a notification or reminder related to the addon, if applicable.
ADDON item type only. Label identifying the selected variant or option of the addon.
ADDON item type only. ID of the correlated hotel reservation, if the addon purchase is linked to one.
BUS item type only. Commercial condition linked to the sale. Not available today.
Device type used to make the reservation.
Source/origin of the reservation within Niara.
HOTEL and ADDON item types only. Tracking source (UTM source).
HOTEL and ADDON item types only. Tracking medium (UTM medium).
HOTEL and ADDON item types only. Tracking campaign (UTM campaign).
External reference code.
Name of the external related client.
HOTEL item type only. Country name.
HOTEL item type only. Hotel address.
HOTEL item type only. Hotel latitude, in decimal degrees.
HOTEL item type only. Hotel longitude, in decimal degrees.
HOTEL item type only. Hotel code in the original supplier's system.
HOTEL item type only. Rebooking process status.
payments object[]required
Payments made to settle the order.
Payment transaction ID.
Possible values: [CREDITCARD, PIX, POINTS, OFFLINE]
Payment type. OFFLINE is used for invoiced payments (Ex: CAR item type, with supplierPaymentType = INVOICED).
Currency used. ISO 4217 standard code. Ex: BRL
Amount originally paid. For CAR item type, only the invoiced amount (totalReservationReceivable); pay-at-counter amounts never generate a payment record.
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 the order items paid in full or in part with this payment transaction.
Supplier integration credential ID.
Supplier integration credential name.
Supplier integration credential type.
Transaction locator in the supplier integration, according to the credential type.
Payer's passport.
CREDITCARD payment type only. Masked card number.
CREDITCARD payment type only. Cardholder's name.
CREDITCARD payment type only. Card brand.
CREDITCARD payment type only. Card expiration date.
CREDITCARD payment type only. Number of installments.
CREDITCARD payment type only. Capture date.
CREDITCARD payment type only. Authorization code.
CREDITCARD payment type only. Transaction NSU (Sequential Unique Number).
CREDITCARD payment type only. Acquirer, when available.
CREDITCARD payment type only. Transaction ID with the acquirer, when available.
CREDITCARD payment type only. 3DS authorization used.
paidItems object[]
PaymentOption of the order items paid in full or in part with this payment transaction.
ID of the order item paid in full or in part with this payment transaction.
Refunded amount for this item.
Amount paid for this item.
Refunded amount, converted to the exchange currency.
Amount paid for this item, converted to the exchange currency.
Currency the amount was converted to. ISO 4217 standard code. Ex: USD
Exchange rate applied to convert the amount to the exchange currency.
Currency used to pay for this item. ISO 4217 standard code. Ex: BRL
Indicates whether interest was applied to this paid item.
Interest rate applied to the paid item. Only relevant when hasInterest is true.
Surcharge amount resulting from the interest applied to the paid item. Only relevant when hasInterest is true.
loyaltyRewards object[]required
Loyalty program benefits generated from the order.
Loyalty transaction ID.
Possible values: [POINTS, CASHBACK]
Type of loyalty benefit.
Value of the benefit, according to the type. Ex. Number of points, monetary value via Cashback.
For Cashback only. Currency used. ISO 4217 standard code. Ex: BRL
Creation date.
Last modification date.
Possible values: [PENDING, CONFIRMED, CANCELLED, REFUNDED, REJECTED]
Current status of the transaction.
For Points only. Description of the points type.
Supplier integration credential ID.
Supplier integration credential name.
Supplier integration credential type.
Locator for the accumulation transaction with the supplier, according to the credential type.
Scheduled date for the benefit accumulation.
suppliers object[]required
Data of the suppliers for the items that make up the order.
Supplier ID.
Unique NIARA ID for this supplier.
Corporate Name.
Brand Name.
VAT number (CNPJ for Brazil).
Email.
Phone.
Address (street and number).
City.
State.
Zip code.
ISO 3166-1 alpha-2 country code. Ex: 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 from which the quotation was generated.
Quotation creation date.
Name of the person responsible for the quotation.
Whether the trip is for groups or not.
Group description.
Checkout URL.
{
"id": "string",
"createDate": "string",
"updateDate": "string",
"buyerName": "string",
"buyerEmail": "string",
"buyerCpf": "string",
"buyerPhone": "string",
"buyerUsername": "string",
"buyerPassport": "string",
"buyerPersonId": "string",
"buyerPersonLoyaltyData": [
{
"id": "string",
"alias": "string",
"balance": 0,
"nextExpirationAt": "string",
"nextExpirationValue": 0,
"tier": "string"
}
],
"clientId": "string",
"clientName": "string",
"clientVat": "string",
"clientExternalCode": "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",
"productDescription": "string",
"cityName": "string",
"countryCode": "string",
"primaryGuestName": "string",
"primaryGuestEmail": "string",
"primaryGuestCpf": "string",
"primaryGuestPhone": "string",
"primaryGuestPassport": "string",
"primaryGuestPersonId": "string",
"paymentType": "string",
"paymentAlias": "string",
"paymentCreditCard": {
"number": "string",
"holder": "string",
"brand": "string",
"expirationDate": "string"
},
"supplierPaymentType": "string",
"supplierPaymentAlias": "string",
"createdById": "string",
"createdByName": "string",
"totalReservationPayable": 0,
"totalReservationPayCurrency": "string",
"totalReservationOriginalPriceCurrency": "string",
"totalReservationOriginalPrice": 0,
"totalReservationPrice": 0,
"totalReservationTaxes": 0,
"totalReservationInsurance": 0,
"totalReservationInsuranceCurrency": "string",
"totalReservationCurrency": "string",
"totalReservationReceivable": 0,
"totalReservationReceiveCurrency": "string",
"totalReservationPayAtCounter": 0,
"totalReservationPayAtCounterCurrency": "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",
"addressCity": "string",
"addressComplement": "string",
"addressDistrict": "string",
"addressNumber": "string",
"addressState": "string",
"addressStreet": "string",
"addressZipCode": "string",
"birthCertificate": "string",
"country": "string",
"dob": "string",
"nationality": "string",
"passport": "string",
"primary": true,
"rg": "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,
"taxesBreakdown": [
{
"value": 0,
"currency": "string",
"description": "string"
}
],
"supplierRoomTaxes": 0,
"supplierRoomTaxesCurrency": "string",
"supplierRoomTaxesBreakdown": [
{
"value": 0,
"currency": "string",
"description": "string"
}
]
}
],
"busRoutes": [
{
"id": "string",
"company": "string",
"equipmentType": "string",
"departureLocation": {
"code": "string",
"name": "string"
},
"departureDateTime": "string",
"arrivalLocation": {
"code": "string",
"name": "string"
},
"arrivalDateTime": "string",
"status": "string",
"guests": [
{
"firstName": "string",
"lastName": "string",
"ageQualifying": "string",
"age": 0,
"cpf": "string",
"phone": "string",
"email": "string",
"gender": "string",
"seatNumber": "string",
"ticketNumber": "string",
"voucherUrl": "string",
"dob": "string",
"nationality": "string",
"passport": "string",
"primary": true,
"rg": "string"
}
],
"cancelPolicy": {},
"totalRoutePrice": 0,
"totalRoutePriceCurrency": "string",
"totalRouteTaxes": 0
}
],
"carRentals": [
{
"id": "string",
"rentalCompany": "string",
"status": "CONFIRMED",
"supplierStatus": "string",
"cancelDate": "string",
"pickUpDateTime": "string",
"pickUpLocation": {
"code": "string",
"name": "string",
"address": "string",
"cityName": "string",
"stateCode": "string",
"countryCode": "string",
"phone": "string",
"latitude": 0,
"longitude": 0
},
"returnDateTime": "string",
"returnLocation": {
"code": "string",
"name": "string",
"address": "string",
"cityName": "string",
"stateCode": "string",
"countryCode": "string",
"phone": "string",
"latitude": 0,
"longitude": 0
},
"rentalDays": 0,
"vehicle": {
"groupCode": "string",
"groupName": "string",
"acrissCode": "string",
"model": "string",
"orSimilar": true,
"transmission": "MANUAL",
"airConditioning": true,
"passengers": 0,
"baggage": 0,
"doors": 0,
"mileage": "string",
"imageUrl": "string"
},
"drivers": [
{
"firstName": "string",
"lastName": "string",
"ageQualifying": "string",
"age": 0,
"dob": "string",
"cpf": "string",
"passport": "string",
"rg": "string",
"nationality": "string",
"phone": "string",
"email": "string",
"primary": true
}
],
"rateQualifier": "string",
"promotionCode": "string",
"charges": [
{
"type": "BASE_RATE",
"code": "string",
"description": "string",
"quantity": 0,
"unit": "DAY",
"paymentMode": "INVOICED",
"supplierUnitPrice": 0,
"supplierPrice": 0,
"unitPrice": 0,
"price": 0,
"markup": 0,
"commission": 0,
"currency": "string"
}
],
"totalInvoicedPrice": 0,
"totalInvoicedSupplierPrice": 0,
"totalPayAtCounterPrice": 0,
"totalRentalPrice": 0,
"totalRentalPriceCurrency": "string",
"totalRentalTaxes": 0,
"cancelPolicy": {
"nonRefundable": true,
"penaltyDate": "string",
"penaltyValue": 0,
"penaltyCurrency": "string",
"cancelledInPenalty": true
},
"supplierCancelPolicy": {
"nonRefundable": true,
"penaltyDate": "string",
"penaltyValue": 0,
"penaltyCurrency": "string",
"cancelledInPenalty": true
},
"vendorMessages": [
"string"
],
"voucherUrl": "string"
}
],
"promoCode": "string",
"couponCode": "string",
"extraFields": [
{
"label": "string",
"name": "string",
"valueInt": 0,
"valueStr": "string"
}
],
"includeExtras": [
{
"id": "string",
"label": "string"
}
],
"billingComments": "string",
"pmsNumber": "string",
"mandatoryPurchase": true,
"scheduleDate": "string",
"scheduleTime": "string",
"addonType": "string",
"notificationReminderDatetime": "string",
"variantLabel": "string",
"hotelReservationId": "string",
"tourCode": "string",
"deviceType": "string",
"niaraSource": "string",
"trackingSource": "string",
"trackingMedium": "string",
"trackingCampaign": "string",
"refCode": "string",
"associatedClientName": "string",
"countryName": "string",
"hotelAddress": "string",
"hotelLatitude": 0,
"hotelLongitude": 0,
"supplierHotelCode": "string",
"rebookStatus": "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",
"payerPassport": "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",
"hasInterest": true,
"interestRate": 0,
"interestSurcharge": 0
}
]
}
],
"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",
"scheduleDate": "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"
},
"isForGroups": true,
"groupDescription": "string",
"checkoutUrl": "string"
}