Manual BarramentoAzulViagens v2.3.6

Barramento Azul Viagens
Manual de Utilização
do Barramento
Azul Viagens
v2.3.6
Sumário
Introdução ............................................................................................................................. 4
Authentication ....................................................................................................................... 5
Token ............................................................................................................................... 6
Authenticate .................................................................................................................... 7
Configuration ........................................................................................................................ 8
Feature Flags ................................................................................................................... 9
Loyalty ................................................................................................................................ 10
Customer ....................................................................................................................... 11
Catalog ............................................................................................................................... 12
Destinations .................................................................................................................. 13
Destinations for Ticket.................................................................................................. 14
Suggested Ticket Destinations .................................................................................... 15
Content .......................................................................................................................... 16
Cep ................................................................................................................................. 18
Hotel List........................................................................................................................ 19
Rating ................................................................................................................................. 20
Hotel Rating Details ...................................................................................................... 21
Hotel Availability.................................................................................................................. 22
Hotel Availability ........................................................................................................... 23
V1 ................................................................................................................................ 23
V2 ................................................................................................................................ 27
Accommodations .......................................................................................................... 31
Accommodations Details ............................................................................................. 33
Hotel Recommendations .............................................................................................. 36
Ticket Availability ................................................................................................................ 37
Ticket Availability .......................................................................................................... 38
Ticket Data ..................................................................................................................... 41
Ticket Options by Date ................................................................................................. 42
Ticket Details ................................................................................................................. 44
Payment.............................................................................................................................. 46
Payment ......................................................................................................................... 47
Installments ................................................................................................................... 49
Bins ................................................................................................................................ 50
Booking ............................................................................................................................... 51
Booking Passenger ....................................................................................................... 52
Booking Passengers ..................................................................................................... 53
Booking Discounts ....................................................................................................... 54
Booking Status .............................................................................................................. 55

Booking Data ................................................................................................................. 56
Booking Locator............................................................................................................ 57
Booking Details ............................................................................................................. 58
V1 ................................................................................................................................ 58
V2 ................................................................................................................................ 60
Booking Voucher .......................................................................................................... 62
V1 ................................................................................................................................ 62
V2 ................................................................................................................................ 65
Booking Ticket Details .................................................................................................. 68
Booking Ticket Voucher ............................................................................................... 70
Booking Cancellation Information ............................................................................... 72
Booking Cancellation.................................................................................................... 73
Notifications ........................................................................................................................ 74
Booking Notification ..................................................................................................... 75
Lista de Enums ................................................................................................................... 76
iconCode........................................................................................................................ 76
Sort................................................................................................................................. 76
Document type .............................................................................................................. 76
Board type ..................................................................................................................... 76
Board names ................................................................................................................. 77
Cancellation Type ......................................................................................................... 77
Type – Payment e Installments .................................................................................... 77
Status de reservas ........................................................................................................ 77
Cancellation names ...................................................................................................... 78
Rating names ................................................................................................................ 78
Discounts errors ........................................................................................................... 78
Currency Code .............................................................................................................. 78
Passenger type – Booking Passengers ....................................................................... 78
Passenger type – Booking Ticket Details e Voucher .................................................. 79
Introdução
Este documento destina-se aos desenvolvedores de sistemas que utilizarão o Barramento
Azul Viagens.
Serão abordados os serviços abaixo:

• Authentication: Para realizar a autenticação e autorização para consumo deste
barramento;
• Configuration: Para armazenar, distribuir e gerenciar configurações e feature flags.
• Loyalty: Para obter informações de cliente TudoAzul;
• Catalog: Para obter informações dos dados estáticos (destinos, hotéis etc.);
• Rating: Para obter dados de avaliações de hotéis;
• Availability: Para obter as disponibilidades e preços das reservas dos hotéis;
• Ticket Availability: Para obter as disponibilidades e preços da compra de ingressos;
• Booking: Para realizar e buscar informações sobre reservas;
• Payment: Para realizar e buscar informações sobre o pagamento da reserva;
• Notifications: Para enviar e-mails e outras notificações para o cliente final.
Authentication
O serviço de Authentication é responsável por autenticar e identificar o usuário sistêmico do
Barramento Azul Viagens.
A obtenção do Token através do serviço Authentication é obrigatória no início da sessão de

cada usuário final e deve ser utilizado até o final da sessão deste usuário.
O Token irá expirar após 15 minutos de inatividade. Após este tempo, será necessário solicitar
um novo Token, caso contrário o método chamado irá retornar HTTP 403: Forbidden
Sistemas B2C
Só é necessária a chamada do método Token no início de cada sessão do usuário final. Não
se faz necessário chamar o método Authenticate.
Sistemas B2B
São necessárias as chamadas do método Token e o método Authenticate no início de cada

sessão do usuário final.
O Barramento não irá funcionar adequadamente se for iniciado um Availability e depois for
realizada chamada do método Authenticate.
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/authentication/ + URL relativa da API
Ambiente de Homologação: (recomendado)

https://general-api-stg.voeazul.com.br/sales/azulviagens/authentication/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/authentication/api/v1/authentication/token
Token
Método responsável por autenticar o sistema da Azul que utilizará os serviços do Barramento
Azul Viagens.
Este método deverá ser chamado no início de uma nova sessão do usuário final.
URL:
POST /api/v1/authentication/token
Headers:
Campo Tipo Descrição
Ocp-Apim-Subscription-Key string API Subscription Key
Client string Tipo do cliente (B2B ou B2C)
Responses:
HTTP 200: OK
{
"data": "string",
"notifications": [
"string"
]
}
HTTP 400: Bad Request (client inválido)
HTTP 504: Gateway Timeout (Timeout de requisições externas)
Authenticate
Método responsável por autenticar os sistemas parceiros que utilizarão os serviços do
Barramento Azul Viagens.
Este método deverá ser chamado após obter o Token e antes do início do processo do
Availability somente para os sistemas B2B.
URL:
POST /api/v1/authentication/authenticate
Headers:
Authorization string Token recebido no método Token
Request:
{
"username": "string",
"password": "string"
}
Responses:
HTTP 200: OK
{
"data": {},
"notifications": [
"string"
]
}
HTTP 400: Bad Request (senha ou usuário não fornecidos)
HTTP 401: Unauthorized
Configuration
O serviço de Configuration é responsável por armazenar, distribuir e gerenciar configurações
e feature flags do Barramento AzulViagens
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/configuration/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/configuration/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/configuration/api/v1/featureflags
Feature Flags
Método responsável por retornar a lista de feature flags e seu status (true/false).
URL:
GET /api/v1/featureflags
Headers:
Authorization string Token recebido no serviço Authentication
Responses:
HTTP 200: OK
{
"data": {
"featureFlags": {
"featureName": "Boolean"
}
},
"notifications": [
"string"
]
}
HTTP 400: Bad Request
HTTP 404: Not found (feature flags não encontradas)
Loyalty
O serviço de Loyalty é responsável por gerenciar o cliente TudoAzul, incluindo autenticação,
pontos, número TudoAzul entre outros.
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/loyalty/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/loyalty/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/loyalty/api/v1/
Customer
Método que retorna os dados do cliente Tudo Azul.
URL:
GET
/api/v1/customer/{documentNumber}
?firstName={firstName}&lastName={lastName}
Headers:
Ocp-Apim-Subscription-Key string API Subscription Keysettings
Client string Device utilizado para acessar o Barramento
Path:
documentNumber string CPF ou Número Tudo Azul do cliente
Query string:
firstName string Primeiro nome
lastName string Último sobrenome
Responses:
HTTP 200: OK
{
"data": {
"customer": {
"cpf": "string",
"birthDate": "string date ISO",
"name": {
"first": "string",
"last": "string"
}
},
"program": {
"levelCode": "string",
"name": "string"
}
},
"notifications": [
"string"
]
}
HTTP 400: Bad Request (CPF ou sobrenome digitado é inválido/em branco)
HTTP 404: Not Found
Catalog
O serviço de Catalog é responsável por retornar os dados estáticos do Azul Viagens, como
lista de Destinos, dados estáticos de Hotéis, etc.
Para realizar as chamadas dos métodos do Catalog, é necessário passar um Token obtido
através do serviço Authentication.
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/catalog/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/catalog/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/catalog/api/v1/catalog/destinations
Destinations
Método que retorna a lista de destinos (Cidades, Bairros e Hotéis) que possuem determinados
caracteres no nome. Deverá ser informado pelo menos 3 caracteres do destino.
URL:
GET /api/v1/catalog/destinations?name={name}
Headers:
QueryString:
name string Nome do destino
Responses:
HTTP 200: OK
{
"data": [
{
"type": "string",
"destinations": [
{
"id": "string",
"name": "string",
"address": {
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
}
}
]
}
],
"notifications": [
"string"
]
}
HTTP 204: No Content
Destinations for Ticket

Método que retorna a lista de destinos (cidades, bairros e ingressos) que possuem
determinados caracteres no nome. Deverá ser informado pelo menos 3 caracteres do destino.
URL:
GET /api/v1/catalog/ticket/destinations?name={name}
Headers:
QueryString:
name string Nome do destino
Responses:
HTTP 200: OK
{
"data": {
"destinations": [
{
"id": "string",
"name": "string",
"type": "string enum",
"address": {
"city": "string",
"state": "string",
"country": "string"
}
}
]
},
"notifications": [
"string"
]
}
Suggested Ticket Destinations

Método que retorna a lista fixa de destinos sugeridos pré-definidos por configuração prévia.
URL:
GET /api/v1/catalog/ticket/suggested
Headers:
Responses:
HTTP 200: OK
{
"data": {
"suggested": [
{
"id": "string",
"name": "string",
"type": "string",
"address": {
"city": "string",
"state": "string",
"country": "string"
}
}
]
},
"notifications": [
"string"
]
}
Content
Método que retorna os dados estáticos do Hotel.
URL:
GET /api/v1/catalog/hotels/{idHotel}/content
Headers:
Path:
idHotel string Deverá ser informado o identificador de hotel
Responses:
HTTP 200: OK
{
"data": {
"id": "string",
"name": "string",
"description": "string",
"rules": "string",
"location": {
"latitude": "string",
"longitude": "string",
"address": {
"street": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"country": "string"
},
"pointsOfInterest": [
{
"distance": "string",
"name": "string"
}
]
},
"contactInformation": {
"emails": [
"string"
],
"faxes": [
"string"
],
"phoneNumbers": [
"string"
]
},
"images": [
{
"url": "string",
"title": "string"
}
],
"chain": "string",
"category": "string",
"amenities": [
{
"name": "string",
"iconCode": "string enum"
}
],
"services": [
{
"title": "string",
"items": [
"string"
]
}
],
"labels": [
"string"
],
"checkIn": "string",
"checkOut": "string"
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Cep
Método que retorna o endereço através de um CEP informado.
URL:
GET /api/v1/catalog/postalCode/{postalCode}
Headers:
Path:
postalCode string Deverá ser informado o cep pesquisado
Responses:
HTTP 200: OK
{
"data": [
{
"type": "string",
"street": "string",
"city": "string",
"state": "string",
"postalCode": "string"
}
],
"notifications": [
"string"
]
}
HTTP 404: Not Found
Hotel List
Método que retorna a lista de código dos hotéis de um destino específico. Este método é de
utilização interna do Barramento Azul Viagens.
URL:
GET /api/v1/catalog/destinations/{idDestination}/hotels
Headers:
Path:
IdDestination string Deverá ser informado o código do destino
Responses:
HTTP 200: OK
{
"data": [
{
"id": "string",
}
],
"notifications": [
"string"
]
}
HTTP 204: No Content (Destino não encontrado)
Rating
O serviço de Rating é responsável por retornar os dados de avaliações de hotéis e outros
serviços do Azul Viagens.
Para realizar as chamadas dos métodos do Rating, é necessário passar um Token obtido
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/rating/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/rating/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/rating/api/v1/rating/hotel
Hotel Rating Details

Método que retorna a lista de avaliações de um determinado hotel. Deverá ser informado o
código do hotel.
URL:
GET /api/v1/rating/hotel/{idHotel}
Headers:
Path:
idHotel string Id do Hotel
Responses:
HTTP 200: OK
{
"data": {
"rating": {
"count": 0,
"classification": "string",
"value": 0
},
"reviewsCount": 0,
"reviews": [
{
"author": "string",
"rating": 0,
"date": "string datetime UTC ISO",
"relativeDate": "string",
"comment": "string",
"classification": "string"
}
]
},
"notifications": [
"string"
]
}
HTTP 204: No Content (não foram encontradas avaliações para o hotel)
HTTP 400: Bad Request (ID do hotel inválido)
HTTP 404: Not Found (hotel não encontrado)
Hotel Availability
O serviço de Hotel Availability é responsável por retornar as disponibilidades e precificações
das Acomodações dos Hotéis
Para realizar as chamadas dos métodos do Hotel Availability, é necessário passar um Token
obtido através do serviço Authentication.
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/hotel/availability/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/hotel/availability/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/hotel/availability/api/v1/hotel/availability
Hotel Availability
Método responsável por realizar as consultas de disponibilidades e preços dos Hotéis para
um determinado destino.
V1
URL:
POST /api/v1/hotel/availability
(Este método será removido em 12/04/2023. Usar api/v2/hotel/availability)
Headers:
Client string Identificador de cliente
Request:
{
"criteria": {
"idDestination": "string",
"checkOut": "string",
"accommodations": [
{
"adults": 0,
"children": [
{
"age": 0
}
]
}
]
},
"filters": {
"categories": [
{
"id": "string"
}
],
"ratings": [
{
"id": "string"
}
],
"price": {
"min": 0,
"max": 0
},
"pointOfInterest": {
"id": "string",
"radius": 0
},
"amenities": [
{
"id": "string"
}
],
"labels": [
{
"id": "string"
}
],
"chains": [
{
"id": "string"
}
],
"neighborhoods": [
{
"id": "string"
}
],
"name": "string"
},
"page": {
"number": 0,
"size": 0,
"sort": "string"
}
}
Responses:
HTTP 200: OK
{
"data": {
"criteria": {
"availabilityKey": "string",
"nights": 0
},
"hotels": [
{
"id": "string",
"name": "string",
"location": {
"address": {
"street": "string",
"city": "string",
"state": "string",
"country": "string"
},
"downtownDistance": "string",
{
"name": "string",
"distance": "string"
}
]
},
"cancellationPolicyDescription": "string",
"availableAccommodations": 0,
"images": [
{
"title": "string",
"url": "string"
}
],
"chain": "string",
"labels": [
"string"
],
"amenities": [
{
"name": "string",
}
],
"price": {
"offer": "boolean",
"original": 0,
"installment": {
"amount": 0,
"rate": 0
},
"discounted": 0,
"currencyCode": "string enum"
},
"rating": {
"count": 0,
"value": 0
}
}
],
"filters": {
"categories": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"ratings": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"price": {
"min": 0,
"max": 0
},
{
"name": "string",
"id": "string"
}
],
"amenities": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"labels": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"chains": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"neighborhoods": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"names": [
"string"
],
"sorting": [
"string"
]
},
"page": {
"number": 0,
"total": 0,
"totalResults": 0
}
},
"notifications": [
"string"
]
}
HTTP 502: Bad Gateway (Resposta do provedor inválida)
V2
URL:
POST /api/v2/hotel/availability
Headers:
Request:
{
"criteria": {
"accommodations": [
{
"adults": 0,
"children": [
{
"age": 0
}
]
}
]
},
"filters": {
"categories": [
{
"id": "string"
}
],
"ratings": [
{
"id": "string"
}
],
"price": {
"min": 0,
"max": 0
},
"pointOfInterest": {
"id": "string",
"radius": 0
},
"amenities": [
{
"id": "string"
}
],
"labels": [
{
"id": "string"
}
],
"boards": [
{
"id": "string"
}
],
"chains": [
{
"id": "string"
}
],
"neighborhoods": [
{
"id": "string"
}
],
"name": "string",
"freeCancellation": "boolean"
},
"page": {
"number": 0,
"size": 0,
"sort": "string enum"
}
}
Responses:
HTTP 200: OK
{
"data": {
"criteria": {
"availabilityKey": "string",
"nights": 0,
"destination": {
"name": "string",
"type": "string enum"
},
"hotels": [
{
"id": "string",
"name": "string",
"location": {
"address": {
"street": "string",
"city": "string",
"state": "string",
"country": "string"
},
"downtownDistance": "string",
{
"name": "string",
"distance": "string"
}
]
},
"cancellationPolicyDescription": "string",
"boardType": "string",
"availableAccommodations": 0,
"images": [
{
"title": "string",
"url": "string"
}
],
"chain": "string",
"labels": [
"string"
],
"amenities": [
{
"iconCode": "string enum",
"name": "string"
}
],
"price": {
"offer": "boolean",
"original": 0,
"installment": {
"amount": 0,
"rate": 0
},
"discounted": 0,
},
"rating": {
"count": 0,
"value": 0
}
}
],
"filters": {
"categories": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"ratings": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"price": {
"min": 0,
"max": 0
},
{
"name": "string",
"id": "string"
}
],
"amenities": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"labels": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"chains": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"neighborhoods": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"names": [
"string"
],
"sorting": [
"string"
],
"boards": [
{
"quantity": 0,
"name": "string",
"id": "string"
}
],
"freeCancellation": "boolean"
},
"page": {
"number": 0,
"total": 0,
"totalResults": 0
}
}
},
"notifications": [
"string"
]
}
Accommodations
Método que retorna disponibilidade dos quartos de um determinado Hotel.
URL:
GET /api/v1/hotel/{idHotel}/availability/
{availabilityKey}/accommodations
Headers:
Path:
availabilityKey string Chave do Availability
Responses:
HTTP 200: OK
{
"data": {
"accommodations": [
{
"id": "string",
"descriptions": [
{
"accommodationName": "string",
"description": "string"
}
],
"hold": {
"available": false,
"time": 0
},
"accommodations": [
{
"name": "string",
"rooms": 0,
"available": 0,
"size": {
"unit": "string",
"value": 0
},
"amenities": [
"string"
],
"images": [
{
"title": "string",
"url": "string"
}
],
"occupancy": {
"limit": 0,
"adults": 0,
"children": 0
}
}
],
"supplier": "string",
"nights": 0,
"board": {
"name": "string",
},
"price": {
"lowest": "boolean",
"offers": [
{
"name": "string",
}
],
"original": 0,
"installment": {
"amount": 0,
"rate": 0
},
"discounted": 0,
},
"cancellationPolicy": {
"freeCancellationUntilDate": "string datetime ISO",
}
}
]
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Accommodations Details
Método que retorna as informações detalhadas para realizar a reserva das acomodações.
URL:
POST /api/v1/hotel/{idHotel}/availability/
{availabilityKey}/accommodations/details
Headers:
Path:
Request:
{
"hold": "boolean",
"accommodations": [
{
"id": "string",
"quantity": 0
}
]
}
Responses:
HTTP 200: OK
{
"data": {
"bookingKey": "string",
"hotel": {
"name": "string",
"location": {
"address": {
"street": "string",
"city": "string",
"state": "string",
"country": "string"
}
},
"rules": "string",
"emails": [
"string"
],
"faxes": [
"string"
],
"phoneNumbers": [
"string"
]
},
"images": [
{
"url": "string",
"title": "string"
}
],
"chain": "string",
"labels": [
"string"
],
"amenities": [
{
"name": "string",
}
],
"services": [
{
"title": "string",
"items": [
"string"
]
}
],
"checkOut": "string"
},
"accommodations": [
{
"name": "string",
"rooms": 0,
"available": 0,
"size": {
"unit": "string",
"value": 0
},
"amenities": [
"string"
],
"images": [
"string"
],
"occupancy": {
"limit": 0,
"adults": 0,
"children": 0
}
}
],
"supplier": "string",
"board": {
"name": "string",
},
"price": {
"offers": [
{
"name": "string",
}
],
"original": 0,
"installment": {
"amount": 0,
"rate": 0
},
"discounted": 0,
},
"descriptions": [
{
"accommodationName": "string",
}
],
},
"hold": {
"available": false,
"time": 0
}
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
HTTP 424: Failed Dependency
Hotel Recommendations
Método de recomendações de Hotéis semelhantes.
URL:
GET /api/v1/hotel/{idHotel}/availability/
{availabilityKey}/recommendations
Headers:
Path:
Responses:
HTTP 200: OK
{
"data": [
{
"id": "string",
"name": "string",
"images": [
"string"
],
"chain": "string",
"labels": [
"string"
],
"price": {
"original": 0,
"installment": {
"amount": 0,
"rate": 0
},
"discounted": 0,
},
"location": {
"address": {
"city": "string",
"state": "string"
},
"hotelDistance": "string"
}
}
],
"notifications": [
"string"
]
}
HTTP 404: Not Found
HTTP 504: Gateway Timeout (Timeout de requisições externas
Ticket Availability
O serviço de Ticket Availability é responsável por retornar as disponibilidades e precificações
dos ingressos.
Para realizar as chamadas dos métodos do Ticket Availability, é necessário passar um Token
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/ticket/availability/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/ticket/availability/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/ticket/availability/api/v1/ticket/availability
Ticket Availability
Método responsável por realizar as consultas de disponibilidades e preços dos ingressos para
um determinado destino ou grupo.
URL:
POST /api/v1/ticket/availability
Headers:
Content-Type string application/json
Request:
{
"criteria": {
"dates": {
"from": "string",
"to": "string"
},
"passengers": {
"adults": 0,
"children": [
{
"age": 0
}
]
},
"banner": "string"
},
"filters": {
"price": {
"min": 0,
"max": 0
},
"labels": [
{
"id": "string"
}
],
"attractionTypes": [
{
"id": "string"
}
],
"name": "string"
},
"sort": "string"
}
Responses:
HTTP 200: OK
{
"data": {
"criteria": {
"destination": {
"name": "string",
}
},
"ticketsGroups": [
{
"name": "string",
"tickets": [
{
"key": "string",
"name": "string",
"labels": [
"string"
],
"image": {
"title": "string",
"url": "string"
},
"loyalty": {
"accrual": 0
},
"price": {
"original": 0,
"installments": 0,
"currencyCode": "Enum string"
},
"date": "string",
"externalCode": "string"
}
]
}
],
"filters": {
"price": {
"min": 0,
"max": 0
},
"labels": [
{
"id": "string",
"name": "string",
"quantity": 0
}
],
"attractionTypes": [
{
"id": "string",
"name": "string",
"quantity": 0
}
],
"names": [
"string"
],
"sorting": [
"string"
]
},
"totalResults": 0
},
"notification": [
"string"
]
}

HTTP 404: Not Found
Ticket Data
Método que retorna disponibilidade das datas de um determinado Ingresso.
URL:
GET /api/v1/ticket/{ticketKey}
Headers:
Path:
ticketKey string Chave do ticket
Responses:
HTTP 200: OK
{
"data": {
"ticket": {
"name": "string",
"descriptions": [
{
"title": "string",
"value": "string"
}
],
"groups": ["string"],
"images": [
{
"title": "string",
"url": "string"
}
],
"dates": [
{
"date": "string",
"available": "boolean",
"price": {
"original": 0,
}
}
]
}
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Ticket Options by Date

Método que retorna as opções disponíveis para datas de um determinado Ingresso.
URL:
GET /api/v1/ticket/{ticketKey}/{date}
Headers:
Path:
ticketKey string Chave do ticket
date string Data (yyyy-mm-dd)
Responses:
HTTP 200: OK
{
"data": {
"parks": [
{
"dates": [
"string Datetime ISO"
],
"names": [
"string"
]
}
],
"tickets": [
{
"name": "string",
"options": [
{
"key": "string",
"name": "string",
"days": 0,
"dates": {
"from": "string Datetime ISO",
"to": "string Datetime ISO"
},
"passengers": {
"adults": 0,
"children": 0
},
"loyalty": {
"accrual": 0
},
"price": {
"original": 0,
"difference": 0,
"installment": 0,
},
"descriptions": [
{
"title": "string",
"value": "string"
}
]
}
]
}
],
"cancellationPolicy": "string"
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Ticket Details
Método que retorna as informações detalhadas da seleção de um determinado Ingresso.
URL:
GET /api/v1/ticket/{ticketKey}/option/{optionKey}
Headers:
Path:
optionKey string Chave da Option
ticketKey string Chave do Ticket
Responses:
HTTP 200: OK
{
"data": {
"ticket": {
"name": "string",
"passengers": {
"total": 0,
"adults": 0,
"children": 0
},
"dates": {
},
"days": 0,
"parks": [
{
"dates": [
],
"names": [
"string"
]
}
],
"option": {
"name": "string",
"descriptions": [
{
"title": "string",
"value": "string"
}
]
},
"address": {
"city": "string",
"state": "string",
"country": "string",
"street": "string",
},
"cancellationPolicy": "string",
"descriptions": [
{
"title": "string",
"value": "string"
}
],
"price": {
"original": 0,
"currencyCode": "Enum string"
},
"loyalty": {
"accrual": 0
}
}
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Payment
O serviço de Payment é responsável por realizar o pagamento e a realização da Reserva dos
serviços de Availability.
Para realizar as chamadas dos métodos do Payment, é necessário passar um Token obtido
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/payment/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/payment/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/payment/api/v1/payment
Payment
Método assíncrono responsável por realizar o pagamento e a reserva.
URL:
POST /api/v1/payment/
Headers:
Request:
{
"holder": {
"document": {
"number": "string",
},
"fullName": "string",
"email": "string",
"phone": {
"ddi": "string",
"number": "string"
},
"nationality": "string",
"address": {
"street": "string",
"complement": "string",
"city": "string",
"state": "string",
"country": "string"
}
},
"installments": 0,
"card": {
"accountNumber": "string",
"bin": "string",
"expirationDate": {
"month": "string",
"year": "string"
},
"verificationCode": "string"
}
}
Responses:
HTTP 202: Accepted
{
"data": {},
"notifications": [
"string"
]
}
• Type inválido – Deve conter um dos valores da enumeração
• Booking key inválido
• Dados do holder inválidos ou ausentes
• Dados de cartão inválidos
• Termos e condições não aceitos
• Installments inválido – Deve ser entre 1 e o máximo autorizado pelo endpoint Installments
• Dados de endereço inválidos
o Caso presente, CEP não representa um CEP
HTTP 425: Too Early (Pagamento já identificado, potencial chamada duplicada)
HTTP 402: Payment Required (Pagamento não foi autorizado)
HTTP 503: Service Unavailable (Erros sistêmicos, tentar pagamento novamente)
Installments
Método responsável por obter os valores de parcelamentos para a reserva.
URL:
POST /api/v1/payment/{bookingKey}/installments
Headers:
Path:
bookingKey string Chave do Booking
Request:
{
"cardBin": "string"
}
Responses:
HTTP 200: OK
{
"data": {
"currencyCode": "string enum",
"maxInstallments": 0,
"installments": [
{
"installment": 0,
"total": 0,
"interest": {
"amount": 0,
"percentage": 0
},
"description": [
{
"key": 0,
"value": 0
}
]
}
]
},
"notifications": [
"string"
]
}
• Type inválido – Deve conter um dos valores da enumeração
• Type incorreto – Deve corresponder ao produto da reserva
• cardBin inválido – Deve conter de 4 ou 6 dígitos
HTTP 503: Service Unavailable (Erros sistêmicos)
Bins
Método responsável por obter os dados referentes ao bin do cartão pesquisado.
URL:
GET /api/v1/payment/bin/{cardBin}
Headers:
Path:
cardBin string Bin do cartão
Responses:
HTTP 200: OK
{
"data": {
"cardBin": "string",
"brand": "string"
},
"notifications": [
"string"
]
}
• cardBin inválido – Deve conter de 4 a 6 dígitos
HTTP 404: Not Found (cardBin não encontrado)
Booking
O serviço de Booking é responsável por realizar a reserva das Acomodações realizadas no
serviço Availability.
Para realizar as chamadas dos métodos do Booking, é necessário passar um Token obtido
URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/booking/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/booking/ + URL relativa da API
Exemplo:
https://general-api-stg.voeazul.com.br/sales/azulviagens/booking/api/v1/booking/xpto/status
Booking Passenger
Método que armazena os dados do Hóspede Titular.
URL:
POST /api/v1/booking/{bookingKey}/passenger
Headers:
Path:
Request:
{
"name": {
"first": "string",
"last": "string"
},
"document": {
"number": "string",
"type": "string"
},
"birthDate": "string",
"email": "string",
"phone": {
"ddi": "string",
"number": "string"
},
"hold": "boolean"
}
Responses:
HTTP 200: OK
{
"data": {},
"notifications": [
"string"
]
}
HTTP 404: Not Found
HTTP 425: Too Early (Reserva em hold já criada, potencial chamada duplicada)
HTTP 503: Service Unavailable (Indisponibilidade do serviço, tente novamente)
Booking Passengers
Método que armazena os dados dos passageiros.
URL:
POST /api/v1/booking/{bookingKey}/passengers
Headers:
Path:
Request:
{
"passengers": [
{
"holder":"boolean",
"name": {
"first": "string",
"last": "string"
},
"nationality": "string",
"birthDate": "string",
"document": {
"number": "string",
"type": "string"
},
"email": "string",
"phone": {
"ddi": "string",
"number": "string"
}
}
],
"hold": "boolean"
}
Responses:
HTTP 200: OK
{
"data": {},
"notifications": [
"string"
]
}
HTTP 404: Not Found
HTTP 425: Too Early (Reserva em hold já criada, potencial chamada duplicada)
HTTP 503: Service Unavailable (Indisponibilidade do serviço, tente novamente)
Booking Discounts
Método que aplica e remove os descontos na reserva.
URL:
PUT /api/v1/booking/{bookingKey}/discounts?promocode=
{promocode}&bin={cardBin}
Headers:
Path:
Query string:
promocode string Promocode
cardBin String Bin do cartão
Responses:
HTTP 200: OK (Para promocode/bin aplicado ou removido com sucesso)
{
"data": {
"promocode": {
"title": "string",
"notes": "string",
"category": "string"
},
"price": {
"original": 0,
"discount": 0,
"amount": 0
}
},
"notifications": [
"string"
]
}
HTTP 304: Not Modified (Promocode/Bin já aplicado)
HTTP 400: Bad Request (Booking key e/ou promocode e/ou Bin é inválido)
HTTP 404: Not Found (Booking key)
HTTP 417: Expectation Failed (Promocode não encontrado ou esgotado)
{
"data": {
"error": "string enum"
},
"notifications": [
"string"
]
}
Booking Status
Método que retorna o status da reserva solicitada no método Booking.
URL:
GET /api/v1/booking/{bookingKey}/status
Headers:
Path:
Responses:
HTTP 200: OK (reserva efetuada com sucesso)
{
"data": {},
"notifications": [
"string"
]
}
HTTP 202: Accepted (Em processamento)
HTTP 402: Payment Required (Pagamento não foi autorizado)
HTTP 404: Not Found (BookingKey não encontrado)
HTTP 409: Conflict (Preço diferente do pagamento)
{
"data": {
"oldPrice": 0,
"newPrice": 0,
"difference": 0
},
"notifications": [
"string"
]
}
HTTP 424: Failed Dependency (Reserva não está mais disponível)
HTTP 500: Internal Server Error (Erro de processamento)
HTTP 502: Bad Gateway (Resposta do provedor inválida, reembolso solicitado à Adyen)
Booking Data
Método que retorna os dados da Reserva realizada.
URL:
GET /api/v1/booking/{bookingKey}
Headers:
Path:
Responses:
HTTP 200: OK
{
"data": {
"booking": {
"key": "string",
"locator": "string",
"status": "string enum",
"cancellationDate": "string Datetime ISO",
"payment": {
"date": "string Datetime ISO",
"holderName": "string",
"card": {
"summary": "string",
"brand": "string"
},
"price": {
"totalAmount": 0,
"refundAmount": 0,
"installment": {
"number": 0,
"amount": 0
},
}
}
}
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
HTTP 417: Expectation Failed (Falhas gerais no processo)
Booking Locator
Método que retorna a chave da reserva realizada.
URL:
GET /api/v1/booking/locator/{recordLocator}/email/{email}
Headers:
Path:
recordLocator string Código da reserva
email string E-mail do cliente
Responses:
HTTP 200: OK
{
"data": {
"bookingKey": "string"
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Booking Details
Método que retorna os dados da Reserva realizada.
V1
URL:
GET /api/v1/booking/{bookingKey}/details
(Este método será removido em 12/06/2023. Usar
/api/v2/booking/{bookingKey}/details)
Headers:
Path:
Responses:
HTTP 200: OK
{
"data": {
"hotel": {
"name": "string",
"location": {
"address": {
"street": "string",
"city": "string",
"state": "string",
}
},
"emails": [
"string"
],
"faxes": [
"string"
],
"phoneNumbers": [
"string"
]
},
"chain": "string",
}
},
"booking": {
"recordLocator": "string",
"externalLocator": "string",
"passenger": {
"documentNumber": "string",
"name": {
"first": "string",
"last": "string"
},
"birthDate": "string"
},
"reservationDate": "string Datetime ISO",
"paymentDate": "string Datetime ISO",
"payment": {
"card": {
"brand": "string"
},
"price": {
"amount": 0,
"refundAmount": 0,
"installment": {
"rate": 0,
"amount": 0
},
}
},
"hold": {
"countdown": {
"days": 0,
"hours": 0,
"minutes": 0,
"seconds": 0
}
},
"accommodations": [
{
"rooms": 0,
"name": "string",
"board": "string",
"offers": [
{
"name": "string",
}
],
"adults": 0,
"children": [
{
"age": 0
}
]
}
]
}
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
V2
URL:
GET /api/v2/booking/{bookingKey}/details
Headers:
Path:
Responses:
HTTP 200: OK
{
"data": {
"hotels": [
{
"name": "string",
"location": {
"address": {
"street": "string",
"city": "string",
"state": "string",
}
},
"emails": [
"string"
],
"faxes": [
"string"
],
"phoneNumbers": [
"string"
]
},
"chain": "string",
},
"accommodations": [
{
"rooms": 0,
"name": "string",
"board": "string",
"offers": [
{
"name": "string",
}
],
"passengers": [
{
"name": {
"first": "string",
"last": "string"
},
}
],
"adults": 0,
"children": [
{
"age": 0
}
]
}
]
}
]
},
"booking": {
"seconds": 0
}
}
"passenger": {
"name": "string",
"birthDate": "datetime"
},
"payment": {
"card": {
"brand": "string"
},
"price": {
"amount": 0,
"refundAmount": 0,
"installment": {
"rate": 0,
"amount": 0
},
}
},
"hold": {
"countdown": {
"days": 0,
"hours": 0,
"minutes": 0,
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Booking Voucher
Método que retorna os dados da Reserva realizada através de um PNR (record locator) e um
e-mail informado.
V1
URL:
GET /api/v1/booking/{recordLocator}/voucher?email={email}
(Este método será removido em 12/06/2023. Usar
/api/v2/booking/{recordLocator}/voucher?email={email})
Headers:
Path:
Query string:
email string Email do cliente
Responses:
HTTP 200: OK
{
"data": {
"hotel": {
"name": "string",
"location": {
"address": {
"city": "string",
"state": "string",
"street": "string",
}
},
"emails": [
"string"
],
"faxes": [
"string"
],
"phoneNumbers": [
"string"
]
},
"chain": "string",

}
},
"booking": {
"hold": {
"countdown": {
"days": 0,
"hours": 0,
"minutes": 0,
"seconds": 0
}
},
"passenger": {
"name": {
"first": "string",
"last": "string"
},
},
"payment": {
"card": {
"brand": "string"
},
"price": {
"amount": 0,
"refundAmount": 0,
"installment": {
"rate": 0,
"amount": 0
},
}
},
"accommodations": [
{
"rooms": 0,
"name": "string",
"board": "string",
"offers": [
{
"name": "string",
}
],
"adults": 0,
"children": [
{
"age": 0
}
]
}
]
}
},
"notifications": [
"string"
]
}

HTTP 404: Not Found
V2
URL:
GET /api/v2/booking/{recordLocator}/voucher?email={email}
Headers:
Path:
Query string:
email string Email do cliente
Responses:
HTTP 200: OK
{
"data": {
"hotels": [
{
"name": "string",
"location": {
"address": {
"street": "string",
"city": "string",
"state": "string",
}
},
"emails": [
"string"
],
"faxes": [
"string"
],
"phoneNumbers": [
"string"
]
},
"chain": "string",
},
"accommodations": [
{
"rooms": 0,
"name": "string",
"board": "string",
"offers": [
{
"name": "string",
}
],
"passengers": [
{
"name": {
"first": "string",
"last": "string"
},
}
],
"adults": 0,
"children": [
{
"age": 0
}
]
}
]
}
]
},
"booking": {
"passenger": {
"name": "string",
"birthDate": "datetime"
},
"payment": {
"card": {
"brand": "string"
},
"price": {
"amount": 0,
"refundAmount": 0,
"installment": {
"rate": 0,
"amount": 0
},
}
},
"hold": {
"countdown": {
"days": 0,
"hours": 0,
"minutes": 0,
"seconds": 0
}
}
},
"notifications": [
"string"
]
}
HTTP 404: Not Found

Booking Ticket Details

Método que retorna os dados dos tickets da reserva realizada.
URL:
GET /api/v1/booking/ticket/{bookingKey}
Headers:
Path:
Responses:
HTTP 200: OK
{
"data": {
"tickets": [
{
"name": "string",
"ticketIssued": "boolean",
"ticketSupplier": "boolean",
"option": {
"name": "string",
"descriptions": [
{
"title": "string",
"value": "string"
}
]
},
"address": {
"city": "string",
"state": "string",
"street": "string",
},
"parks": [
{
"dates": [
"string"
],
"names": [
"string"
]
}
],
"passengers": [
{
"name": "string",
"birthDate": "string Datetime ISO",
"document": {
"number": "string"
},
}
],
"adults": 0,
"children": [
{
"age": 0
}
],
"dates": {
},
"descriptions": [
{
"title": "string",
"value": "string"
}
],
"willCall": "string"
}
]
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Booking Ticket Voucher

Método que retorna os dados dos tickets da reserva realizada.
URL:
GET /api/v1/booking/ticket/{bookingKey}/voucher
Headers:
Path:
Responses:
HTTP 200: OK
{
"data": {
"booking": {
"key": "string",
"locator": "string",
"payment": {
"card": {
"brand": "string"
},
"price": {
"totalAmount": 0,
"refundAmount": 0,
"installment": {
"number": 0,
"amount": 0
},
"currencyCode": "string"
}
}
},
"tickets": [
{
"name": "string",
"address": {
"city": "string",
"state": "string",
"street": "string",
},
"option": {
"name": "string",
"descriptions": [
{
"title": "string",
"value": "string"
}
]
},
"parks": [
{
"dates": [
],
"names": [
"string"
]
}
],
"passengers": [
{
"name": "string",
"birthDate": "string Datetime ISO",
"document": {
"number": "string"
},
}
],
"adults": 0,
"children": [
{
"age": 0
}
],
"dates": {
},
"descriptions": [
{
"title": "string",
"value": "string"
}
],
"willCall": "string"
}
]
},
"notifications": [
"string"
]
}
HTTP 404: Not Found
Booking Cancellation Information

Método que busca informações de custo sobre o cancelamento de uma reserva dado o e-
mail e localizador da reserva.
URL:
GET /api/v1/booking/{recordLocator}/cancellation
?email={email}
Headers:
Path:
email string E-mail do cliente
Responses:
HTTP 200: OK
{
"data": {
"amount": {
"paid": 0,
"due": 0,
"refund": 0,
"currency": "string enum"
},
"cancellation": {
"key": "string",
"expiration": "string"
}
},
"notifications": [
"string"
]
}
HTTP 404: Not Found (reserva não encontrada)
HTTP 406: Not Acceptable (reserva do Call Center)
HTTP 412: Precondition Failed (Juniper não retornou dados de cancelamento necessários)
HTTP 417: Expectation failed (reserva já cancelada)
HTTP 422: Unprocessable Entity (reserva hold retornou com penalidade)
HTTP 502: Bad Gateway (resposta do provedor inválida)
HTTP 504: Gateway Timeout (timeout de requisições externas)
Booking Cancellation
Método que cancela uma reserva associada ao Booking key, record locator e a uma
cancellation key válida. Esse método não realiza reembolso do pagamento.
URL:
DELETE /api/v1/booking/{recordLocator}/cancellation/
{cancellationKey}
Headers:
Path:
cancellationKey string Chave de cancelamento fornecida pelo método GET Cancellation Information
Responses:
HTTP 202: Accepted (Cancelamento realizado com sucesso)
{
"data": {},
"notifications": [
"string"
]
}
HTTP 304: Not Modified (Cancelamento já realizado)
HTTP 400: Bad request (informações faltantes ou chave de cancelamento vencida)
HTTP 404: Not Found (reserva não encontrada)
HTTP 412: PreconditionFailed (Cancellation Information não foi chamado)
HTTP 409: Conflict (Valores de cancelamento mudaram, chame o Cancellation Information novamente)
HTTP 422: Unprocessable Entity (Cancelamento não pode ser realizado pelo barramento)
Notifications
O serviço de Notifications é responsável por enviar e-mails e outras notificações aos usuários
finais.
Para realizar as chamadas dos métodos do Notifications, é necessário passar um Token

URLs
Ambiente de Testes:
https://general-api-tst.voeazul.com.br/sales/azulviagens/notifications/ + URL relativa da API

https://general-api-stg.voeazul.com.br/sales/azulviagens/notifications/ + URL relativa da API
Exemplo:
https://general-api-
stg.voeazul.com.br/sales/azulviagens/notifications/api/v1/notifications/booking/xpto/email
Booking Notification
Método que dispara o envio de e-mail com as informações da reserva
URL:
POST /api/v1/notifications/booking/{bookingKey}/email
Headers:
Path:
Responses:
HTTP 202: Accepted
HTTP 404: Not Found (Reserva não encontrada)
HTTP 412: Precondition failed (Reserva cancelada)
HTTP 502: Service unavailable (Erros não identificados com a reserva)
Lista de Enums
iconCode
Os valores de ícones possíveis do campo amenities.iconCode nos responses dos métodos
Content, Hotel Availability e Accommodations:
Valor Descrição
wifi Wifi
airconditioner Ar Condicionado
24hfrontdesk Recepção 24 horas
parkinglot Estacionamento disponível
pets Aceita animais de estimação
nosmoking Proibido fumar em todo o Hotel
smoking Área para fumantes
pool Piscina
gym Academia
restaurant Restaurante
bar Bar
bussinesscenter Centro de Negócios
reducedmobility Comodidades para hóspedes com mobilidade reduzida
Sort
Valores possíveis do campo page.sort para o request do Hotel Availability:
Valor Descrição
label Do mais relevante para o menos relevante (label)
priceAsc Do mais barato para o mais caro
priceDesc Do mais caro para o mais barato
distanceAsc Do mais próximo ao centro para o mais distante
starDesc Da maior quantidade de estrelas para a menor quantidade de estrelas
starAsc Da menor quantidade de estrelas para a maior quantidade de estrelas
ratingDesc Da maior avaliação para a menor
Document type
Valores possíveis do campo type para a request dos métodos Passenger e Payment:
Valor Descrição
CPF Documento do tipo CPF
Passport Documento do tipo Passaporte
RNE Documento do tipo RNE
Board type
Valores possíveis do campo type para o response do método Accommodations e
Accommodations Details no objeto board e também das opções de filtro de board do Availability:
Enum Descrição
accommodationOnly Somente quarto
all Tudo incluso
breakfast Café da manhã
full Pensão completa
half Meia pensão
Board names
Valores possíveis do campo boardType para o response do método Availability
(URL:/api/v2/hotel/availability).
Valor Descrição
All Inclusive Todos os quartos são do tipo “All Inclusive”

Café da manhã Todos os quartos têm café da manhã
Pensão completa Todos os quartos têm pensão completa
Meia pensão Todos os quartos têm meia pensão
Todos as opções são do tipo All Inclusive e pelo menos
Opções com All Inclusive
um dos quartos é do tipo Accommodation Only
Todos os quartos têm café da manhã e pelo menos um
Opções com Café da manhã
dos quartos é do tipo Accommodation Only
Todos os quartos têm pensão completa e e pelo menos
Opções com Pensão completa
um dos quartos é do tipo Accommodation Only
Todos os quartos têm meia pensão e pelo menos um dos
Opções com Meia pensão
quartos é do tipo Accommodation Only
Qualquer combinação de regime de alimentação, exceto
Várias opções de Refeição
os do tipo Accommodation Only
Cancellation Type
Valores possíveis do campo type para o response dos objetos cancellationPolicy nos métodos
Accommodations, Accommodations Details, Booking Details e Booking Voucher:
Valor Descrição
FullRefundUntilDate Cancelamento grátis até [freeCancellationUntilDate]
Partial Reembolso parcial
NoRefund Sem reembolso ou sem informação de cancelamento
Type – Payment e Installments

Valores possíveis do campo type para as requests dos métodos Payment e Installments:
Valor Descrição
Hotel Reserva para hotel
Ticket Reserva de ingresso
Status de reservas
Valores possíveis do campo status para as respostas do Booking Voucher e Booking Details:
Valor Descrição
Confirmed Reserva confirmada e paga
Hold Reserva confirmada
Canceled Reserva cancelada
Initial Reserva "on request"
OnRequest Reserva "on request"
Cotação (este é um estado semelhante ao "on request", e será recebido quando a
Quotation
sua conta exigir o pagamento da reserva através do WebService)
Cancellation names
Valores possíveis de retorno dos nomes de cancelamentos no método Hotel Availability:
Valor Descrição
Cancelamento grátis Todos os quartos têm cancelamento grátis
Opções com cancelamento grátis Alguns quartos têm cancelamento grátis
Nenhum quarto tem cancelamento grátis
Rating names
Valores possíveis de retorno dos nomes de ratings nos métodos Hotel Availability e Rating
Details.
Valor Descrição
Sem Avaliação Value 0
Mal Avaliado Value de 1,0 até 3,9 (incluso)
Bom Value de 4,0 até 4,4 (incluso)
Excelente Value de 4,5 até 5 (incluso)
Discounts errors
Valores possíveis de retorno dos erros no método Discounts.
Valor Descrição
NotFound Promocode não encontrado

CampaignSoldOut Promocode de Campaign esgotado
PromotionSoldOut Promocode de Promotion esgotado
Unknown Erro desconhecido e promocode vencido
BinNotApply Promocode de Bin não aplicado
Currency Code
Valores possíveis para o campo currencyCode que representa a moeda nos métodos Hotel
Availability, Accommodations, Accommodations Details, Recommendations, Ticket
Availability, Ticket Data, Ticket Options by Date, Ticket Details, Installments, Booking,
Booking Details, Booking Voucher e Booking Ticket Print.
Valor Descrição
BRL Real (R$)
Passenger type – Booking Passengers

Valores possíveis para o campo type que representa o tipo do passageiro no método Booking
Passengers.
Valor Descrição
adult Passageiro adulto com 18 anos ou mais.

child Passageiro criança com menos de 18 anos.
Passenger type – Booking Ticket Details e Voucher

Valores possíveis para o campo type que representa o tipo do passageiro no método Booking
Ticket Details e Booking Ticket Voucher.
Valor Descrição
adult Passageiro adulto com 18 anos ou mais.

child Passageiro criança com menos de 18 anos.
holder Passageiro adulto titular da reserva.

Manual BarramentoAzulViagens v2.3.6

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual BarramentoAzulViagens v2.3.6

Enviado por

Direitos autorais:

Formatos disponíveis

Barramento Azul Viagens

Booking Status .............................................................................................................. 55

Serão abordados os serviços abaixo:

A obtenção do Token através do serviço Authentication é obrigatória no início da sessão de

São necessárias as chamadas do método Token e o método Authenticate no início de cada

Ambiente de Homologação: (recomendado)

Ambiente de Homologação: (recomendado)

Ambiente de Homologação: (recomendado)

Ambiente de Homologação: (recomendado)

Destinations for Ticket

Suggested Ticket Destinations

Ambiente de Homologação: (recomendado)

Hotel Rating Details

Ambiente de Homologação: (recomendado)

(Este método será removido em 12/04/2023. Usar api/v2/hotel/availability)

Ambiente de Homologação: (recomendado)

HTTP 204: No Content

Ticket Options by Date

Ambiente de Homologação: (recomendado)

Ambiente de Homologação: (recomendado)

"freeCancellationUntilDate": "string datetime ISO",

HTTP 401: Unauthorized

HTTP 404: Not Found

Booking Ticket Details

Booking Ticket Voucher

Booking Cancellation Information

Para realizar as chamadas dos métodos do Notifications, é necessário passar um Token

Ambiente de Homologação: (recomendado)

All Inclusive Todos os quartos são do tipo “All Inclusive”

Type – Payment e Installments

NotFound Promocode não encontrado

BRL Real (R$)

Passenger type – Booking Passengers

adult Passageiro adulto com 18 anos ou mais.

Passenger type – Booking Ticket Details e Voucher

adult Passageiro adulto com 18 anos ou mais.

Você também pode gostar