Consultar dados da ordem

GET 
/orders/:order_id

Consulta detalhes de um ordem de compra

Request

Path Parameters

order_id stringrequired

Responses

200

Sucesso

application/json

Schema

Schema

id stringrequired

ID da ordem de compra.

createDate stringnullable

Data de criação.

updateDate stringnullable

Data da última modificação.

buyerName stringnullable

Nome do comprador.

buyerCpf stringnullable

Documento do comprador. Ex: CPF.

buyerPhone stringnullable

Telfone do comprador.

buyerUsername stringnullable

Username do comprador.

clientId stringnullable

ID do cliente.

clientName stringnullable

Nome do cliente.

clientVat stringnullable

CNPJ do cliente.

clientExternalCode stringnullable

Código externo ou de integração definido para o cliente.

items object[]required
Itens que compõem a ordem. Ex: reservas de hotel, passagens aéreas.
Array [
id stringrequired
ID do Item.
type required
Possible values: [HOTEL]
Tipo da reserva.
createDate stringnullable
Data de criação.
updateDate stringnullable
Data da última modificação.
status stringrequired
Possible values: [CONFIRMED, CANCELLED, PENDING]
Situação atual.
startDate stringrequired
Data do inicio do serviço. Ex: Checkin.
endDate stringrequired
Data do final do serviço. Ex: Checkout.
locator stringnullable
Localizador da reserva junto ao fornecedor, de acordo com o tipo de credencial.
credentialId stringnullable
ID da credencial de integração com o fornecedor.
credentialAlias stringnullable
Nome da credencial de integração com o fornecedor.
credentialType stringnullable
Tipo da credencial de integração com o fornecedor.
productId stringnullable
ID do produto contratado, de acordo com o tipo do item. Ex: ID do Hotel
productName stringnullable
ID do produto contratado, de acordo com o tipo do item. Ex: Nome do Hotel
cityName stringnullable
Nome da cidade.
primaryGuestName stringnullable
Nome do viajante principal.
primaryGuestEmail stringnullable
E-mail do viajante principal.
primaryGuestPhone stringnullable
Telefone do viajante principal.
paymentType stringnullable
Tipo da forma de pagamento ao fornecedor.
paymentAlias stringnullable
Descrição da forma de pagamento ao fornecedor.
createdById stringnullable
ID do usuário emissor.
createdByName stringnullable
Nome do usuário emissor.
totalReservationPayable numbernullable
Valor de compra da reserva, devido ao fornecedor, incluindo impostos.
totalReservationPayCurrency stringnullable
Moeda de compra.
totalReservationTaxes numbernullable
Impostos contidos no valor de compra, na mesma moeda de compra.
totalReservationReceivable numbernullable
Valor de venda da reserva.
totalReservationReceiveCurrency stringnullable
Moeda de venda.
totalCommissionPayable numbernullable
Valor de comissão a pagar ao vendedor.
totalCommissionPayCurrency stringnullable
Moeda da comissão a pagar.
totalCommissionReceivable numbernullable
Valor de comissão a receber pela venda.
totalCommissionReceiveCurrency stringnullable
Moeda da comissão a receber.
hotelRooms object[]nullable
Somente item tipo HOTEL. Lista de quartos reservados.
Array [
id stringnullable
ID do quarto.
name stringnullable
Descrição do quarto.
guests object[]required
Identificação dos hóspedes.
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
Data do inicio do serviço. Ex: Checkin.
endDate stringrequired
Data do final do serviço. Ex: Checkout.
status stringrequired
Possible values: [CONFIRMED, CANCELLED]
Situação atual do quarto.
ratePlanName stringnullable
Descrição da tarifa.
]
]
payments object[]required
Pagamentos realizados para quitar a ordem.
Array [
id stringrequired
ID da transação de pagamento.
type stringrequired
Possible values: [CREDITCARD, PIX, POINTS]
Tipo do pagamento.
currency stringrequired
Moeda utilizada. Código padrão ISO 4217. Ex: BRL
amount numberrequired
Valor pago originalmente.
amountCancelled numbernullable
Valor estornado.
createDate stringnullable
Data de criação.
updateDate stringnullable
Data da última modificação.
cancellationDate stringnullable
Data de cancelamento.
status stringrequired
Possible values: [CONFIRMED, CANCELLED, REFUNDED, PENDING, REJECTED, FAILED, PROCESSING]
Situação atual da transação.
message stringnullable
Mensagem de retorno da transação ou descrição de erro.
paidItemsIds string[]required
IDs dos itens da ordem pagos total ou parcialmente com esta transação de pagamento.
credentialId stringnullable
ID da credencial de integração com o fornecedor.
credentialAlias stringnullable
Nome da credencial de integração com o fornecedor.
credentialType stringnullable
Tipo da credencial de integração com o fornecedor.
locator stringnullable
Localizador da transação na integração com o fornecedor, de acordo com o tipo de credencial.
creditCardNumber stringnullable
Somente pagamento tipo CREDITCARD. Número mascarado do cartão.
creditCardHolder stringnullable
Somente pagamento tipo CREDITCARD. Titular do cartão.
creditCardBrand stringnullable
Somente pagamento tipo CREDITCARD. Bandeira do cartão.
creditCardExpirationDate stringnullable
Somente pagamento tipo CREDITCARD. Data de validade do cartão.
installments numbernullable
Somente pagamento tipo CREDITCARD. Número de parcelas.
captureDate stringnullable
Somente pagamento tipo CREDITCARD. Data de captura.
authorizationCode stringnullable
Somente pagamento tipo CREDITCARD. Código de autorização.
proofOfSale stringnullable
Somente pagamento tipo CREDITCARD. NSU da transação.
provider stringnullable
Somente pagamento tipo CREDITCARD. Adquirente, quando disponível.
providerTransactionId stringnullable
Somente pagamento tipo CREDITCARD. ID da transação junto ao adquirente, quando disponível.
is3DS booleannullable
Somente pagamento tipo CREDITCARD. Autorização 3DS utilizada.
]
loyaltyRewards object[]required
Benefícios de programas de fidelidade gerados a partir da ordem.
Array [
id stringrequired
ID da transação de fidelidade.
type stringrequired
Possible values: [POINTS, CASHBACK]
Tipo do benefício de fidelidade.
value numberrequired
Valor do benefício, de acordo com o tipo. Ex. Quantidade de pontos, valor monetário via Cashback.
currency stringnullable
Somente para Cashback. Moeda utilizada. Código padrão ISO 4217. Ex: BRL
createDate stringrequired
Data de criação.
updateDate stringrequired
Data da última modificação.
status stringrequired
Possible values: [PENDING, CONFIRMED, CANCELLED]
Situação atual da transação.
unit stringnullable
Somente para Pontos. Descrição do tipo de pontos.
credentialId stringnullable
ID da credencial de integração com o fornecedor.
credentialAlias stringnullable
Nome da credencial de integração com o fornecedor.
credentialType stringnullable
Tipo da credencial de integração com o fornecedor.
locator stringnullable
Localizador da transação de acúmulo junto ao fornecedor, de acordo com o tipo de credencial.
]

Example (from schema)

{
  "id": "string",
  "createDate": "string",
  "updateDate": "string",
  "buyerName": "string",
  "buyerCpf": "string",
  "buyerPhone": "string",
  "buyerUsername": "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",
      "primaryGuestName": "string",
      "primaryGuestEmail": "string",
      "primaryGuestPhone": "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",
      "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"
    }
  ]
}

Loading...