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 [
- ]
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]
Reservation type.
Creation date.
Last modification date.
Possible values: [CONFIRMED, CANCELLED, LOST]
Current status.
Service start date. Ex: Check-in.
Service end date. Ex: Check-out.
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
Name of the contracted product, according to the item type. Ex: Hotel Name
City name.
ISO 3166-1 alpha-2 country code. Ex: BR
Primary traveler's name.
Primary traveler's email.
Primary traveler's CPF (Brazilian individual taxpayer registry).
Primary traveler's phone number.
Primary traveler'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.
ID of the issuing user.
Name of the issuing user.
Amount due to the supplier for the reservation purchase, including taxes.
Purchase currency (supplier).
Original purchase currency.
Reservation purchase value in the original currency, including taxes.
Reservation purchase price, including taxes, in the same purchase currency (client).
Taxes included in the purchase price, in the same purchase currency (client).
Purchase currency (client).
Reservation sale value.
Sale currency.
Commission amount to be paid to the seller.
Currency of the commission to be paid.
Commission amount to be received for the sale.
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.
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.
PMS Number
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. Ex: 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 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.
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.
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",
"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"
},
"createdById": "string",
"createdByName": "string",
"totalReservationPayable": 0,
"totalReservationPayCurrency": "string",
"totalReservationOriginalPriceCurrency": "string",
"totalReservationOriginalPrice": 0,
"totalReservationPrice": 0,
"totalReservationTaxes": 0,
"totalReservationCurrency": "string",
"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",
"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
}
],
"promoCode": "string",
"couponCode": "string",
"extraFields": [
{
"label": "string",
"name": "string",
"valueInt": 0,
"valueStr": "string"
}
],
"includeExtras": [
{
"id": "string",
"label": "string"
}
],
"billingComments": "string",
"pmsNumber": "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"
}
]
}
],
"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,
"checkoutUrl": "string"
}