Retrieve order data

GET 
/orders/:order_id

Retrieves details of a purchase order

Request

Path Parameters

order_id stringrequired

Responses

200

Success

application/json

Schema

Schema

id stringrequired

Purchase order ID.

createDate stringnullable

Creation date.

updateDate stringnullable

Last modification date.

buyerName stringnullable

Buyer's name.

buyerCpf stringnullable

Buyer's document. E.g., CPF.

buyerPhone stringnullable

Buyer's phone.

buyerUsername stringnullable

Buyer's username.

buyerPassport stringnullable

Buyer's passport.

buyerPersonId stringnullable

Buyer's person ID.

buyerPersonloyaltyData object[]nullable
List of buyer's loyalty.
Array [
id stringnullable
Loyalty program ID.
alias stringnullable
Loyalty programs alias.
balance numbernullable
Balance.
nextExpirationAt stringnullable
Next expiration.
nextExpirationValue numbernullable
Next expiration amount.
tier stringnullable
Loyalty value.
]
clientId stringnullable

Client ID.

clientName stringnullable

Client name.

clientVat stringnullable

Client's CNPJ (company tax ID).

clientExternalCode stringnullable

External or integration code defined for the client.

items object[]required
Items included in the order. E.g., hotel reservations, airline tickets.
Array [
id stringrequired
Item ID.
type required
Possible values: [HOTEL]
Reservation type.
createDate stringnullable
Creation date.
updateDate stringnullable
Last modification date.
status stringrequired
Possible values: [CONFIRMED, CANCELLED, PENDING]
Current status.
billingComments stringnullable
Billing comments.
startDate stringrequired
Start date of the service. E.g., Check-in.
endDate stringrequired
End date of the service. E.g., Check-out.
locator stringnullable
Supplier reservation locator, based on the credential type.
credentialId stringnullable
Supplier integration credential ID.
credentialAlias stringnullable
Supplier integration credential name.
credentialType stringnullable
Supplier integration credential type.
productId stringnullable
Contracted product ID, based on the item type (e.g., Hotel ID).
productName stringnullable
Contracted product name, based on the item type (e.g., hotel name).
cityName stringnullable
City name.
primaryGuestName stringnullable
Primary guest's name.
primaryGuestEmail stringnullable
Primary guest's email.
primaryGuestPhone stringnullable
Primary guest's phone.
primaryGuestPassport stringnullable
Primary guest's passport.
primaryGuestPersonId stringnullable
Primary guest's person ID.
paymentType stringnullable
Type of payment method used with the supplier.
paymentAlias stringnullable
Description of the payment method used with the supplier.
createdById stringnullable
ID of the issuing user.
createdByName stringnullable
Name of the issuing user.
totalReservationPayable numbernullable
Amount payable to the supplier for the reservation, including taxes.
totalReservationPayCurrency stringnullable
Purchase currency.
totalReservationTaxes numbernullable
Taxes included in the purchase amount, in the same currency as the purchase.
totalReservationReceivable numbernullable
Sale amount of the reservation.
totalReservationReceiveCurrency stringnullable
Sale currency.
totalCommissionPayable numbernullable
Commission amount payable to the seller.
totalCommissionPayCurrency stringnullable
Currency of the commission payable.
totalCommissionReceivable numbernullable
Commission amount receivable for the sale.
totalCommissionReceiveCurrency stringnullable
Currency of the commission receivable.
hotelRooms object[]nullable
Only for HOTEL type items. List of reserved rooms.
Array [
id stringnullable
Room ID.
name stringnullable
Room description.
guests object[]required
Guests indetification.
Array [
firstName stringnullable
Nome do hóspede.
lastName stringnullable
Sobrenome do hóspede.
ageQualifying stringnullable
Possible values: [ADULT, CHILD]
Qualificador da idade.
age integernullable
Idade do hóspede.
]
startDate stringrequired
Start date of the service. E.g., Check-in.
endDate stringrequired
End date of the service. E.g., Check-out.
status stringrequired
Possible values: [CONFIRMED, CANCELLED]
Current room status.
ratePlanName stringnullable
Rate description.
]
]
payments object[]required
Payments made to settle the order.
Array [
id stringrequired
Payment transaction ID.
type stringrequired
Possible values: [CREDITCARD, PIX, POINTS]
Payment type.
currency stringrequired
Currency used. ISO 4217 standard code. E.g., BRL.
amount numberrequired
Amount originally paid.
amountCancelled numbernullable
Refunded amount.
createDate stringnullable
Creation date.
updateDate stringnullable
Last modification date.
cancellationDate stringnullable
Cancellation date.
status stringrequired
Possible values: [CONFIRMED, CANCELLED, REFUNDED, PENDING, REJECTED, FAILED, PROCESSING]
Current status of the transaction.
message stringnullable
Transaction return message or error description.
paidItemsIds string[]required
IDs of order items paid partially or fully by this payment transaction.
credentialId stringnullable
Supplier integration credential ID.
credentialAlias stringnullable
Supplier integration credential name.
credentialType stringnullable
Supplier integration credential type.
locator stringnullable
Transaction locator in the supplier integration, based on the credential type.
payerPassport stringnullable
Payer's passport.
creditCardNumber stringnullable
Only for CREDITCARD payment. Masked card number.
creditCardHolder stringnullable
Only for CREDITCARD payment. Cardholder's name.
creditCardBrand stringnullable
Only for CREDITCARD payment. Card brand.
creditCardExpirationDate stringnullable
Only for CREDITCARD payment. Card expiration date.
installments numbernullable
Only for CREDITCARD payment. Number of installments.
captureDate stringnullable
Only for CREDITCARD payment. Capture date.
authorizationCode stringnullable
Only for CREDITCARD payment. Authorization code.
proofOfSale stringnullable
Only for CREDITCARD payment. NSU (Unique Transaction Number).
provider stringnullable
Only for CREDITCARD payment. Acquirer, when available.
providerTransactionId stringnullable
Only for CREDITCARD payment. Transaction ID with the acquirer, when available.
is3DS booleannullable
Only for CREDITCARD payment. 3DS authorization used.
]
loyaltyRewards object[]required
Loyalty program rewards generated from the order.
Array [
id stringrequired
Loyalty transaction ID.
type stringrequired
Possible values: [POINTS, CASHBACK]
Type of loyalty benefit.
value numberrequired
Value of the benefit, according to its type. E.g., number of points or monetary value via cashback.
currency stringnullable
Cashback only. Currency used. ISO 4217 standard code. E.g., BRL.
createDate stringrequired
Creation date.
updateDate stringrequired
Last modification date.
status stringrequired
Possible values: [PENDING, CONFIRMED, CANCELLED]
Current status of the transaction.
unit stringnullable
Points only. Description of the point type.
credentialId stringnullable
Supplier integration credential ID.
credentialAlias stringnullable
Supplier integration credential name.
credentialType stringnullable
Supplier integration credential type.
locator stringnullable
Accumulation transaction locator in the supplier integration, based on the credential type.
scheduleDate stringnullable
Scheduled date for the benefit accumulation.
]

Example (from schema)

{
  "id": "string",
  "createDate": "string",
  "updateDate": "string",
  "buyerName": "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",
      "billingComments": "string",
      "startDate": "string",
      "endDate": "string",
      "locator": "string",
      "credentialId": "string",
      "credentialAlias": "string",
      "credentialType": "string",
      "productId": "string",
      "productName": "string",
      "cityName": "string",
      "primaryGuestName": "string",
      "primaryGuestEmail": "string",
      "primaryGuestPhone": "string",
      "primaryGuestPassport": "string",
      "primaryGuestPersonId": "string",
      "paymentType": "string",
      "paymentAlias": "string",
      "createdById": "string",
      "createdByName": "string",
      "totalReservationPayable": 0,
      "totalReservationPayCurrency": "string",
      "totalReservationTaxes": 0,
      "totalReservationReceivable": 0,
      "totalReservationReceiveCurrency": "string",
      "totalCommissionPayable": 0,
      "totalCommissionPayCurrency": "string",
      "totalCommissionReceivable": 0,
      "totalCommissionReceiveCurrency": "string",
      "hotelRooms": [
        {
          "id": "string",
          "name": "string",
          "guests": [
            {
              "firstName": "string",
              "lastName": "string",
              "ageQualifying": "ADULT",
              "age": 0
            }
          ],
          "startDate": "string",
          "endDate": "string",
          "status": "CONFIRMED",
          "ratePlanName": "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
    }
  ],
  "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"
    }
  ]
}

Loading...