Documentação REST — Cangooroo API

Sua configuração

Estes valores são inseridos nos exemplos de código abaixo. Nenhuma chamada é feita a partir deste portal.

Identificador de cliente (clientId)

ws-

Sem o prefixo ws-. Ex.: cliente → resulta em ws-cliente.cangooroo.net

managerId (Commons API)

Diferente do clientId. Usado apenas na Commons API (Autocomplete/HotelDetail).

token (Commons API)

Token concedido ao parceiro integrador.

Portal

Introdução

O Cangooroo API Docs é o portal interativo da API REST Cangooroo para integração B2B de turismo. Aqui você consulta todos os endpoints, gera exemplos em 6 linguagens e revisa convenções que o parceiro precisa dominar antes de publicar em produção.

O fluxo dinâmico segue quatro etapas numeradas na sidebar: 1. Dados estáticos → 2. Autocomplete → 3. Enriquecimento → 4. Chamadas dinâmicas (Search → GetBookingConditions → DoBooking → Cancel).

Convenções

Datas & UTC

Regra geral

Atenção

Nunca converta datas de check-in/check-out — elas são locais por definição. Nunca envie timezone, salvo quando um método específico documentar explicitamente o contrário.

Formatos por tipo de campo

Campo	Formato	Fuso
checkIn / checkOut	YYYY-MM-DD	Horário local do hotel
createdAt / updatedAt	ISO 8601	UTC
TimeSpan	HH:MM:SS	Horário local do serviço

Segurança

Autenticação

Hosts e credenciais

Ambiente	Host	Identificação
API dinâmica	ws-[clientId].cangooroo.net	Credential { Username, Password } no corpo
Commons API	commons.t4w.com.br	managerid + token na URL

Atenção

managerId/token da Commons API não são intercambiáveis com o clientId da API dinâmica.

Configure seus três valores no card acima. Todos os exemplos de código serão reescritos automaticamente.

HTTP

Erros & Status HTTP

Códigos de resposta

Código	Significado	O que fazer
200 / 201	Sucesso	Prosseguir
204	Sem conteúdo	Nada a processar
400	Payload inválido	Ver campo errors e corrigir o request
401 / 403	Credencial inválida ou sem permissão	Revisar Credential e o nível de usuário exigido
404	Recurso inexistente	Conferir identificadores enviados
409	Indisponibilidade / conflito de estado	Chamar ReToken e reprocessar
500 / timeout	Erro interno	Não criar nova reserva — resolver o status real primeiro

Atenção

Em 5xx ou timeout, não crie nova reserva. Use CheckBookingStatus e GetBookingDetail para resolver o status real antes de qualquer nova ação.

Reserva

Status de Reserva

Status	Significado
Pending	Reserva aceita internamente, aguardando confirmação do fornecedor
Confirmed	Fornecedor confirmou; localizador emitido
OnRequest	Depende de confirmação manual (SLA definido por fornecedor)
Cancelled	Reserva cancelada; verifique políticas antes de reprocessar cobrança
Rejected	Fornecedor recusou; a reserva não conta como emitida

Atenção

Só considere uma reserva confirmada quando o campo Status vier literalmente "Confirmed".

Revalidação

ReToken

Após a Search, cada tarifa tem um rateKey com validade curta. Se o cliente demorar para escolher, chame ReToken para revalidar antes do GetBookingConditions — isso evita erros 409 no momento do DoBooking.

Atenção

O Token expira em 30 minutos e só pode gerar uma reserva.

Resiliência

Tratamento de erros e timeout

Fluxo consolidado

Erro HTTP (4XX/5XX) ou timeout no DoBooking? → chame CheckBookingStatus (Hotel) com o mesmo Token usado no DoBooking.
CheckBookingStatus retornou BookingId + ServiceId? → a reserva EXISTE. Use ClientBackOffice.GetBookingDetail para confirmar o status real antes de qualquer nova ação.
CheckBookingStatus retornou erro (reserva não encontrada)? → pode tentar o doBooking novamente, com o mesmo Token.
Nunca assuma que uma reserva “não foi confirmada” só por causa de erro, timeout ou falta de resposta no DoBooking. Só considere confirmada quando o campo Status vier literalmente "Confirmed" (no DoBooking ou no GetBookingDetail).
Cancelamento: só considere uma reserva cancelada após receber confirmação explícita do cancelamento na resposta — se não vier, repita a chamada de cancelamento.

Erro [ERR_0567] — “Este persist já foi utilizado em outra reserva!”

Causa: o Token já foi usado para criar uma reserva e está sendo reenviado no DoBooking para tentar criar outra. Um Token só pode gerar uma reserva. O Token expira em 30 minutos.

Erro “The rooms cannot be booked without executing the cancellation policies first.”

Causa raiz mais comum: divergência de Token entre getBookingConditions e DoBooking — o “carimbo” de que as políticas foram executadas fica associado ao Token específico.
Outras causas: parâmetros diferentes entre as duas chamadas (hotel/quarto/datas/ocupação); Token expirado por demora; retries em paralelo trocando o Token no meio do fluxo; Token antigo reaproveitado de cache/sessão.
Prevenção: nunca reutilizar Token entre tentativas diferentes; evitar checkout em paralelo; ao mudar quarto/data/ocupação, gerar novo Token e refazer o getBookingConditions; em retry do DoBooking, rodar o getBookingConditions de novo antes, com o Token do retry.
Auditoria rápida: comparar Token, HotelId e RoomId/RoomIds entre as duas chamadas.

Token

Token e múltiplos quartos

Cada busca gera um Token único, vinculado a Credential + parâmetros da busca — vale para todos os produtos, não só Hotel.
Não é possível dividir quartos entre requisições diferentes com o mesmo Token: se a busca foi de 2 quartos, TODAS as chamadas seguintes (inclusive o DoBooking) precisam manter os 2 quartos juntos no mesmo request.
Para trabalhar com 1 Token por quarto reservado, é preciso rodar dois fluxos completos e separados (Search → GetBookingConditions → DoBooking), um por quarto.

BackOffice

Escopo de usuário nos BackOffices

Requer nível de usuário

CangoorooBackOffice.GetBookingDetail — só retorna dado com usuário operador (licensee). Usuário de agência recebe erro.

Requer nível de usuário

ClientBackOffice.GetBookingDetail — só retorna reservas da mesma agência do usuário autenticado. Buscar reserva de outra agência gera [ERR_0247] CangoorooLib_V2.Reserva.Reserva.carregar - Erro ao carregar uma Reserva.

Autenticação & Regras globais

POST

Credential — bloco de autenticação

O que faz: Objeto { Username, Password } que identifica a agência/parceiro.

Request: Enviado no corpo de TODAS as chamadas dinâmicas (Search, GetBookingConditions, DoBooking, Cancel, BackOffice, Payment).

Nota

Não é um endpoint separado — é um campo obrigatório em cada request.

URL

https://ws-cliente.cangooroo.net(bloco enviado em todas as chamadas)

Parâmetros

Usernamestringrequired
Usuário fornecido pela Cangooroo à agência.
Passwordstringrequired
Senha correspondente ao Username.

Try it outReferência

Usernamestring*

Usuário fornecido pela Cangooroo à agência.

Passwordstring*

Senha correspondente ao Username.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net(bloco enviado em todas as chamadas)" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  }
}'

POST

Token — ciclo de vida de 30 minutos

O que faz: String retornada pelo Search de cada produto e obrigatória nas etapas seguintes.

Request: Enviar em GetBookingConditions e DoBooking, sem alterações.

Atenção

O Token é único por busca (vinculado à Credential + parâmetros) e expira em 30 minutos. Não reutilize um Token entre tentativas ou fluxos diferentes.

Atenção

Após expirado, o comportamento padrão é refazer o Search. Se o módulo Retoken estiver ativo, ver a entrada específica abaixo.

URL

https://ws-cliente.cangooroo.net(retornado pelo Search de cada produto)

Parâmetros

Tokenstringrequired
String retornada em Search.Token. Enviar em GetBookingConditions e DoBooking.

Try it outReferência

Tokenstring*

String retornada em Search.Token. Enviar em GetBookingConditions e DoBooking.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net(retornado pelo Search de cada produto)"

Exemplo de response

{
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "TokenExpiresAt": "2026-11-14T18:50:00",
  "Note": "Válido por 30 minutos a partir do Search. Após expirar, refaça o Search — ou, com o módulo Retoken ativo, envie o Token expirado no getBookingConditions (Hotel) e trate o campo RoomsConditions da resposta."
}

GET

Retoken — módulo opcional (não é endpoint)

O que faz: Módulo opcional que reaproveita um Token expirado no getBookingConditions do Hotel, evitando refazer o Search.

Response: Campo RoomsConditions + (quando há disponibilidade) novo Token e RoomId prontos para o DoBooking.

Atenção

Retoken NÃO é um endpoint: é um módulo ativado pelo time comercial da Cangooroo e aplica-se apenas ao produto Hotel.

Valores de RoomsConditions

Valor	Significado	Ação
RoomsNotFound	Sem disponibilidade	Redirecione o usuário
SameRoomsFound	Mesmo quarto disponível	Siga o DoBooking com o novo Token + RoomId
RoomsFoundWithChanges	Quarto diferente encontrado	Exiba descrição/regime/preço/taxas atualizados e, se aceito, prossiga com o novo Token + RoomId

URL

https://ws-cliente.cangooroo.net(módulo opcional — sem endpoint próprio)

Parâmetros

RoomsConditionsstring
Retornado APENAS quando o módulo Retoken está ativo e o Token enviado ao getBookingConditions expirou. Valores: RoomsNotFound | SameRoomsFound | RoomsFoundWithChanges.

Try it outReferência

RoomsConditionsstring

Retornado APENAS quando o módulo Retoken está ativo e o Token enviado ao getBookingConditions expirou. Valores: RoomsNotFound | SameRoomsFound | RoomsFoundWithChanges.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X GET "https://ws-cliente.cangooroo.net(módulo opcional — sem endpoint próprio)"

Exemplo de response

{
  "RoomsConditions": "RoomsFoundWithChanges",
  "Token": "eyJhbGciOiJIUzI1NiIs...NEW",
  "RoomId": "R-NEW-9182",
  "RoomChanges": {
    "Description": "Deluxe King Room — City View",
    "Board": "Café da manhã incluso",
    "TotalPrice": 1289.9,
    "PropertyTaxes": 45,
    "Currency": "BRL"
  },
  "NextStep": "Confirmar mudança com o usuário e chamar DoBooking com o novo Token + RoomId."
}

GET

Regras globais da API

O que faz: Regras que valem para toda a API Cangooroo, independentemente do produto.

Datas e horário

Nunca envie timezone — todas as datas são em horário local. Exceção: quando um método específico documentar explicitamente o contrário.
Campos DATE: YYYY-MM-DD, sem hora nem timezone.

Headers recomendados

Header	Valor	Observação
Accept-Encoding	gzip	Compressão suportada em todos os endpoints
Accept	application/json	Recomendado para compatibilidade futura

Métodos HTTP

Método	Uso
GET	Consulta
POST	Cria ou executa uma operação
PUT	Atualiza
DELETE	Remove
OPTIONS	Métodos suportados por um endpoint

Códigos de resposta HTTP

Código	Significado
200	OK
201	Created
204	Sem conteúdo
400	Request inválido
403	Credencial inválida ou sem permissão
404	Recurso inexistente
500	Erro interno

Protocolo

A API é oferecida em SOAP e REST — este portal documenta o flavor REST.

URL

https://ws-cliente.cangooroo.net(regras aplicadas a todas as chamadas)

Exemplo de request

curl -X GET "https://ws-cliente.cangooroo.net(regras aplicadas a todas as chamadas)"

Exemplo de response

{
  "HttpStatusCodes": {
    "200": "OK",
    "201": "Created",
    "204": "No Content",
    "400": "Bad Request (payload inválido)",
    "403": "Forbidden (Credential inválida ou sem permissão)",
    "404": "Not Found",
    "500": "Internal Server Error"
  },
  "HttpMethods": {
    "GET": "Consulta",
    "POST": "Cria / executa operação",
    "PUT": "Atualiza",
    "DELETE": "Remove",
    "OPTIONS": "Métodos suportados por um endpoint"
  },
  "Headers": {
    "Accept": "application/json (recomendado, não obrigatório)",
    "Accept-Encoding": "gzip (suportado em todos os endpoints)"
  },
  "DateFormat": "YYYY-MM-DD (sem timezone; exceções apenas quando o método documentar explicitamente)",
  "Encoding": "GZip recomendado",
  "Flavors": [
    "REST",
    "SOAP"
  ]
}

Commons API

GET

HotelDetail (Commons API)

O que faz: Retorna os dados estáticos de um hotel: nome, endereço, coordenadas, fotos, comodidades, descrições e quartos.

Request: hotelId no path + managerId e token como QUERY PARAMETERS.

Response: Objeto multilíngue e aninhado — textos vêm como { en, es, 'pt-BR' }.

Atenção

O path é /mapping/hotel/ (não /hoteldetail/) e o managerId vai como query parameter, não como segmento de path.

Nota

Não existe RoomMediaId nesta resposta: cada quarto tem seu próprio code e sua própria lista photos.

A Cangooroo recomenda consumir dados estáticos SEMPRE pela Commons API (não pelo SOAP).

URL

http://commons.t4w.com.br/new/api/v1/mapping/hotel/{hotelId}/token/SEU_TOKEN_AQUI?managerId=123

Parâmetros

hotelIdstringrequired
HotelId retornado pelo Search dinâmico (int estável).
tokenstringrequired
Token concedido ao parceiro (diferente do Token dinâmico de 30 min). Vai no path.
managerIdstringrequired
managerId do parceiro na Commons API. Vai como query parameter (?managerId=).

Try it outReferência

Credenciais Commons API

managerIdstring

Identificador do integrador na Commons API.

tokenstring

Token concedido ao parceiro. Compartilhado por todos os endpoints Commons.

hotelIdstring*

HotelId retornado pelo Search dinâmico (int estável).

tokenstring*

Token concedido ao parceiro (diferente do Token dinâmico de 30 min). Vai no path.

managerIdstring*

managerId do parceiro na Commons API. Vai como query parameter (?managerId=).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X GET "http://commons.t4w.com.br/new/api/v1/mapping/hotel/{hotelId}/token/SEU_TOKEN_AQUI?managerId=123"

Exemplo de response

{
  "id": 1135691,
  "destination": {
    "id": 1019215,
    "countryId": "BR",
    "name": {
      "en": "Sao Paulo",
      "es": "São Paulo",
      "pt-BR": "São Paulo"
    }
  },
  "name": "Hotel Exemplo",
  "address": "Av. Exemplo, 1000",
  "phone1": "+55 11 5555-0000",
  "phone2": "",
  "description": {
    "en": "Hotel description",
    "es": "Descripción",
    "pt-BR": "Descrição do hotel"
  },
  "category": 3,
  "zipCode": "04578-000",
  "urlThumb": "https://cdn.example/thumb.jpg",
  "chain": {
    "id": 1155,
    "name": "Exemplo Hotels"
  },
  "webSite": "https://exemplo.com",
  "localization": {
    "latitude": -23.62,
    "longitude": -46.58
  },
  "amenities": [
    {
      "id": 1,
      "name": {
        "en": "Wi-Fi",
        "es": "Wi-Fi",
        "pt-BR": "Wi-Fi"
      }
    }
  ],
  "photos": [
    {
      "url": "https://cdn.example/1.jpg",
      "description": {
        "en": "Facade",
        "es": "Fachada",
        "pt-BR": "Fachada"
      }
    }
  ],
  "rooms": [
    {
      "code": "STD",
      "name": {
        "en": "Standard",
        "es": "Estándar",
        "pt-BR": "Standard"
      },
      "description": {
        "en": "Standard room",
        "es": "Habitación estándar",
        "pt-BR": "Quarto standard"
      },
      "amenities": [
        {
          "id": 1,
          "name": {
            "en": "Air conditioning",
            "es": "Aire",
            "pt-BR": "Ar-condicionado"
          }
        }
      ],
      "photos": [
        {
          "url": "https://cdn.example/room-std.jpg",
          "description": {
            "en": "Room",
            "es": "Habitación",
            "pt-BR": "Quarto"
          }
        }
      ]
    }
  ],
  "checkInBegin": "14:00",
  "checkInEnd": "",
  "checkOut": "12:00",
  "cnpj": "00.000.000/0001-00",
  "type": "Hotel",
  "updateDate": "2026-11-14T09:00:00"
}

GET

AirportDetail (Commons API)

O que faz: Retorna os dados estáticos de um aeroporto a partir do código IATA.

Request: IATA (3 letras) + managerId e token.

Atenção

Atenção ao path: aqui o segmento é /manager/ (singular), diferente do HotelDetail.

Nota

A Cangooroo ainda não publicou o schema completo da resposta — trate o retorno como genérico e valide em sandbox antes de tipar estritamente.

URL

http://commons.t4w.com.br/new/api/v1/mapping/airport/iata/{IATA}/manager/123/token/SEU_TOKEN_AQUI

Parâmetros

IATAstringrequired
Código IATA do aeroporto (3 letras).
managerIdstringrequired
managerId do parceiro na Commons API.
tokenstringrequired
Token concedido ao parceiro.

Try it outReferência

Credenciais Commons API

managerIdstring

Identificador do integrador na Commons API.

tokenstring

Token concedido ao parceiro. Compartilhado por todos os endpoints Commons.

IATAstring*

Código IATA do aeroporto (3 letras).

managerIdstring*

managerId do parceiro na Commons API.

tokenstring*

Token concedido ao parceiro.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X GET "http://commons.t4w.com.br/new/api/v1/mapping/airport/iata/{IATA}/manager/123/token/SEU_TOKEN_AQUI"

Exemplo de response

{
  "_comment": "Schema não publicado pela Cangooroo — resposta tratada como genérica até validação em sandbox."
}

GET

Bulk downloads (S3)

O que faz: Dumps completos publicados em S3 para carga inicial e sincronização periódica.

Nota

Prefira estes dumps para carga inicial em vez de milhares de chamadas HotelDetail.

Arquivo de Destinations — hierarquia de cidades, POIs e aeroportos.
cangooroo_data_cache_hotels_v2.zip — IDs, nomes, descrições e detalhes de todos os hotéis.

URL

http://commons.t4w.com.br(arquivos estáticos em S3)

Try it outReferência

Credenciais Commons API

managerIdstring

Identificador do integrador na Commons API.

tokenstring

Token concedido ao parceiro. Compartilhado por todos os endpoints Commons.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X GET "http://commons.t4w.com.br(arquivos estáticos em S3)"

Exemplo de response

{
  "DestinationsFile": "https://s3.example/commons/destinations.json.gz",
  "HotelsCache": "https://s3.example/commons/cangooroo_data_cache_hotels_v2.zip",
  "RefreshSuggested": "24h"
}

GET

Autocomplete

O que faz: Retorna sugestões de destino a partir de um termo digitado.

Request: term (mín. 3 caracteres) + managerId/token; quantity é opcional.

Response: Cidades, aeroportos, POIs e hotéis correspondentes ao termo.

URL

http://commons.t4w.com.br/new/api/v1/mapping/autocomplete/all/{term}/managerid/123/token/SEU_TOKEN_AQUI

Parâmetros

termstringrequired
Termo digitado pelo usuário (mín. 3 caracteres).
quantitynumber
Número máximo de resultados retornados. Se omitido, usa o default da Commons API.
managerIdstringrequired
managerId do parceiro.
tokenstringrequired
Token Commons do parceiro.

Try it outReferência

Credenciais Commons API

managerIdstring

Identificador do integrador na Commons API.

tokenstring

Token concedido ao parceiro. Compartilhado por todos os endpoints Commons.

termstring*

Termo digitado pelo usuário (mín. 3 caracteres).

quantitynumber

Número máximo de resultados retornados. Se omitido, usa o default da Commons API.

managerIdstring*

managerId do parceiro.

tokenstring*

Token Commons do parceiro.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X GET "http://commons.t4w.com.br/new/api/v1/mapping/autocomplete/all/{term}/managerid/123/token/SEU_TOKEN_AQUI"

Exemplo de response

[
  {
    "type": "city",
    "code": "RIO",
    "name": "Rio de Janeiro, Brasil"
  },
  {
    "type": "poi",
    "code": "POI-CRISTO",
    "name": "Cristo Redentor"
  },
  {
    "type": "airport",
    "code": "GIG",
    "name": "Aeroporto Galeão"
  },
  {
    "type": "hotel",
    "code": "489479",
    "name": "Hotel Copacabana Palace"
  }
]

GET

Destination Hierarchy

O que faz: Retorna a árvore de destinos (países → estados → cidades → POIs → aeroportos).

Response: Hierarquia usada para montar o DestinationId enviado no Search dinâmico.

Pode ser consumida on-demand ou baixada em bulk (ver Downloads estáticos).

URL

http://commons.t4w.com.br/new/api/v1/mapping/destination-hierarchy/managerid/123/token/SEU_TOKEN_AQUI

Parâmetros

managerIdstringrequired
managerId do parceiro.
tokenstringrequired
Token Commons do parceiro.
parentIdnumber
Se informado, retorna apenas a subárvore deste nó. Útil para lazy load.

Try it outReferência

Credenciais Commons API

managerIdstring

Identificador do integrador na Commons API.

tokenstring

Token concedido ao parceiro. Compartilhado por todos os endpoints Commons.

managerIdstring*

managerId do parceiro.

tokenstring*

Token Commons do parceiro.

parentIdnumber

Se informado, retorna apenas a subárvore deste nó. Útil para lazy load.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X GET "http://commons.t4w.com.br/new/api/v1/mapping/destination-hierarchy/managerid/123/token/SEU_TOKEN_AQUI"

Exemplo de response

[
  {
    "DestinationId": 1,
    "Name": "Brasil",
    "Type": "Country",
    "Children": [
      {
        "DestinationId": 42,
        "Name": "Rio de Janeiro (estado)",
        "Type": "State",
        "Children": [
          {
            "DestinationId": 12345,
            "Name": "Rio de Janeiro (cidade)",
            "Type": "City"
          }
        ]
      }
    ]
  }
]

Hotel

Filtrar por produto

HotelPOST

Search — Hotel

O que faz: Pesquisa a disponibilidade de hotéis por destino (DestinationId) ou por lista de hotéis (HotelsIds), para uma data de check-in e quantidade de noites.

Atenção

O Token é único por busca (vinculado à Credential + parâmetros) e expira em 30 minutos. Não reutilize um Token entre tentativas ou fluxos diferentes.

Atenção

Resultados podem vir de cache — reconfirme preço e políticas no GetBookingConditions antes de reservar. Use o Id retornado para identificar o quarto, sem substituir por um campo RoomId inexistente nesta resposta.

Regras e detalhes da operação

Respostas HTTP

HTTP	Descrição
200	OK — SearchResponse.
400	Requisição inválida: JSON malformado ou com campos inválidos.
500	Erro não tratado (fault WCF).

URL

https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/Search

Parâmetros

Campo	Tipo	Obrigatório	Descrição
Credential	object	Sim	Credenciais de integração.
Criteria	object	Sim	Critérios de disponibilidade e ocupação dos quartos.
RequestCustomFields	array	Não	Campos personalizados enviados na requisição.

Credential

Campo	Tipo	Obrigatório	Descrição
Username	string	Sim	Usuário da integração.
Password	string	Sim	Senha do usuário.

Criteria

Campo	Tipo	Obrigatório	Descrição
DestinationId	number	Não	Destino da pesquisa; pode ser substituído pela seleção de hotéis.
SearchRooms	array<object>	Sim	Configuração de ocupação e quantidade dos quartos pesquisados.
NumNights	number	Sim	Quantidade de noites.
HotelsIds	array<number>	Não informado	Lista numérica dos hotéis selecionados.
HotelAndDestinationIds	array<string>	Não informado	Lista de strings para seleção de hotéis e destinos.
SuppliersIds	array<number>	Não informado	Lista numérica dos fornecedores selecionados.
ReturnOnRequestRooms	boolean	Não informado	Indicador de inclusão de quartos sob consulta.
ReturnHotelStaticData	boolean	Não informado	Indicador de retorno de dados estáticos do hotel.
ReturnExtendedHotelStaticData	boolean	Não informado	Indicador de retorno de dados estáticos estendidos do hotel.
CheckinDate	string	Sim	Data de entrada no hotel.
MainPaxCountryCodeNationality	string	Não informado	Nacionalidade do passageiro principal (ISO 3166-1 alpha-2).
SearchType	string	Não informado	Tipo de pesquisa.
Filters	object	Não informado	Filtros de preço e seleção de hotéis.
Timeout	number	Não informado	Limite de espera da pesquisa.
DiscountCode	string	Não informado	Cupom de desconto; reenvie no GetBookingConditions quando utilizado.
PreferredLanguage	string	Não informado	Idioma preferido.

Outros campos (8)

Campo	Tipo	Obrigatório
ShowAllRoomsFromSuppliers	boolean	Não informado
ReturnOnlyHotelsByDirectAgreement	boolean	Não informado
ReturnOnlyRoomsWithCancelPenalty	boolean	Não informado
ForceTimeoutError	boolean	Não informado
ReturnOnlyRoomsWithBreakfast	boolean	Não informado
ReturnOnlyRefundableRates	boolean	Não informado
ReturnDailyRate	boolean	Não informado
ShowPropertyType	string	Não informado

SearchRooms[]

Campo	Tipo	Obrigatório	Descrição
NumAdults	number	Sim	Quantidade de adultos por quarto.
ChildAges	array<number>	Não	Lista de idades numéricas das crianças (campo opcional). A quantidade de crianças é identificada pelas idades: envie a idade de todas as crianças em lista.
Quantity	number	Sim	Quantidade de quartos com a configuração informada.

Filters

Campo	Tipo	Descrição
MinPrice	number	Preço mínimo.
MaxPrice	number	Preço máximo.
SelectedHotelsIds	array<number>	Lista numérica dos hotéis selecionados pelo filtro.
CheapestRoomOnly	boolean	Retorna apenas o quarto mais barato por hotel. Ignorado quando a pesquisa é feita com apenas 1 hotel.
HidePackageRate	boolean	Indicador de ocultação de tarifas de pacote.

RequestCustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Try it outReferência

Credentialobject*

Credenciais de integração.

Criteriaobject*

Critérios de disponibilidade e ocupação dos quartos.

RequestCustomFieldsarray

Campos personalizados enviados na requisição.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/Search" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "string",
    "Password": "string"
  },
  "Criteria": {
    "DestinationId": 0,
    "SearchRooms": [
      {
        "NumAdults": 0,
        "ChildAges": [
          0
        ],
        "Quantity": 0
      }
    ],
    "NumNights": 0,
    "HotelsIds": [
      0
    ],
    "HotelAndDestinationIds": [
      "string"
    ],
    "SuppliersIds": [
      0
    ],
    "ReturnOnRequestRooms": true,
    "ReturnHotelStaticData": true,
    "ReturnExtendedHotelStaticData": true,
    "CheckinDate": "string",
    "MainPaxCountryCodeNationality": "string",
    "SearchType": "string",
    "Filters": {
      "MinPrice": 0.1,
      "MaxPrice": 0.1,
      "SelectedHotelsIds": [
        0
      ],
      "CheapestRoomOnly": true,
      "HidePackageRate": true
    },
    "Timeout": 0,
    "ShowAllRoomsFromSuppliers": true,
    "ReturnOnlyHotelsByDirectAgreement": true,
    "ReturnOnlyRoomsWithCancelPenalty": true,
    "DiscountCode": "string",
    "ForceTimeoutError": true,
    "ReturnOnlyRoomsWithBreakfast": true,
    "ReturnOnlyRefundableRates": true,
    "ReturnDailyRate": true,
    "PreferredLanguage": "string",
    "ShowPropertyType": "string"
  },
  "RequestCustomFields": [
    {
      "Name": "string",
      "Value": "string"
    }
  ]
}'

Campos da resposta

Campo	Tipo	Descrição
Token	string	Token da pesquisa, utilizado nas próximas etapas.
Error	object	Detalhes de erro retornados pela API.
Messages	array<object>	Mensagens da operação.
TotalHotelResults	number	Total de hotéis retornados pela pesquisa.
Hotels	array<object>	Lista de hotéis e seus quartos.
DebugInfo	array<string>	Lista de informações de diagnóstico retornadas.
Warnings	array<string>	Lista de avisos retornados.

Outros campos (4)

Campo	Tipo	Descrição
TotalTime	number
TimeSpan	string
SInfo	string
CustomFields	array<object>

Error

Campo	Tipo	Descrição
Token	string	Token da pesquisa, utilizado nas próximas etapas.

Outros campos (7)

Campo	Tipo	Descrição
Server	string
Message	string
Stacktrace	string
TotalTime	number
Code	number
TimeSpan	string
SupportInfo	string

Messages[]

Outros campos (2)

Campo	Tipo	Descrição
value	string
content	string

Hotels[]

Campo	Tipo	Descrição
HotelId	number	Identificador numérico do hotel.
Rooms	array<object>	Opções de quartos retornadas para o hotel.
Destination	object	Dados do destino do hotel.

Outros campos (14)

Campo	Tipo	Descrição
IsRecommended	boolean
Name	string
Category	string
ThumbUrl	string
Latitude	number
CustomFields	array<object>
Longitude	number
Address	string
Phone	string
Photos	string
HotelDescription	string
Amenities	string
Chain	string
PropertyType	string

Hotels[].Rooms[]

Campo	Tipo	Descrição
Id	number	Identificador retornado neste objeto. Em Hotels[].Rooms[], identifica o quarto (number).
SellingPricePerRoom	object	Preço de venda por quarto.
MinimumSellingPrice	object	Preço mínimo de venda.
TotalSellingPrice	object	Preço total de venda.
Quantity	number	Quantidade de quartos com a configuração informada.
CanBook	boolean	Indicador retornado de possibilidade de reserva; reconfirme no GetBookingConditions antes de reservar.
CancellationPolicies	array<object>	Políticas de cancelamento do quarto.
NumAdults	number	Quantidade de adultos por quarto.
ChildAges	array<number>	Lista de idades numéricas das crianças (campo opcional). A quantidade de crianças é identificada pelas idades: envie a idade de todas as crianças em lista.
Services	array<object>	Serviços associados ao quarto.
MediaRoomId	string	Identificador de mídia do quarto.
HotelId	number	Identificador numérico do hotel.
PaymentLimitDate	string	Prazo de pagamento, no formato /Date(...)/ apresentado.
PriceBreakdown	array<object>	Detalhamento dos preços por data.

Outros campos (48)

Campo	Tipo	Descrição
BoardDescription	string
RoomDescription	string
IsAvailable	boolean
PayDirectToHotel	boolean
IsPrePayment	boolean
InvoiceCC	boolean
MoreInformation	string
Halfboard	boolean
Fulllboard	boolean
AllInclusive	boolean
HasBreakfast	boolean
IsNonRefundable	boolean
CustomFields	array<object>
DepositRequired	boolean
HomeId	string
CheckInHour	string
CheckOutHour	string
DirectAgreement	boolean
Taxes	array<object>
TotalTax	object
Promotions	array<string>
SpecialOffer	boolean
CommissionPercent	number
Commission	object
UniqueRoomId	string
CanInforSupplierInformation	boolean
InvoiceItems	array<string>
PackageRate	boolean
CancellationType	string
PropertyValue	object
CanSelectFirstDay	boolean
DiscountCoupon	object
PropertyTaxes	array<object>
PriceWithCoupon	object
TotalPriceWithCoupon	object
CouponPrice	object
CouponCode	string
CouponDescription	string
PriceHasChanged	boolean
ExclusiveDeal	boolean
TopHotel	boolean
QuantityAvailable	number
BoardCode	string
BoardMoreInformation	string
BedDescription	string
DisneyPackage	boolean
AcceptsLoyaltyNumber	boolean
MarketingIncentive	string

Hotels[].Rooms[].SellingPricePerRoom

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].MinimumSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].TotalSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].CancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

Hotels[].Rooms[].CancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].CustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Hotels[].Rooms[].Services[]

Campo	Tipo	Descrição
Services	array<object>	Serviços associados ao quarto.

Outros campos (3)

Campo	Tipo	Descrição
Type	string
QtyMax	number
QtyMin	number

Hotels[].Rooms[].Services[].Services[]

Outros campos (6)

Campo	Tipo	Descrição
ID	string
Name	string
Price	object
Comission	object
Description	string
CanSelectFirstDay	boolean

Hotels[].Rooms[].Services[].Services[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].Services[].Services[].Comission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].Taxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Hotels[].Rooms[].Taxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].TotalTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].Commission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].PropertyValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].DiscountCoupon

Outros campos (3)

Campo	Tipo	Descrição
DiscountCouponValue	object
DiscountCouponDescription	string
DiscountCoupon	string

Hotels[].Rooms[].DiscountCoupon.DiscountCouponValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].PropertyTaxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Hotels[].Rooms[].PropertyTaxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].PriceWithCoupon

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].TotalPriceWithCoupon

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].CouponPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].Rooms[].PriceBreakdown[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.

Outros campos (4)

Campo	Tipo	Descrição
Price	number
DateBreakdown	string
DateBreakdownStr	string
PriceToFront	object

Hotels[].Rooms[].PriceBreakdown[].PriceToFront

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Hotels[].CustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Hotels[].Destination

Campo	Tipo	Descrição
Id	string	Identificador retornado neste objeto. Em Hotels[].Rooms[], identifica o quarto (number).

Outros campos (2)

Campo	Tipo	Descrição
CountryId	string
Name	object

Hotels[].Destination.Name

Outros campos (3)

Campo	Tipo	Descrição
ptBR	string
es	string
en	string

CustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Exemplo de response

{
  "TotalTime": 0,
  "Token": "string",
  "TimeSpan": "string",
  "Error": {
    "Server": "string",
    "Message": "string",
    "Stacktrace": "string",
    "TotalTime": 0,
    "Code": 0,
    "Token": "string",
    "TimeSpan": "string",
    "SupportInfo": "string"
  },
  "Messages": [
    {
      "value": "string",
      "content": "string"
    }
  ],
  "SInfo": "string",
  "TotalHotelResults": 0,
  "Hotels": [
    {
      "HotelId": 0,
      "IsRecommended": true,
      "Rooms": [
        {
          "Id": 0,
          "BoardDescription": "string",
          "RoomDescription": "string",
          "SellingPricePerRoom": {
            "Currency": "string",
            "Value": 0
          },
          "MinimumSellingPrice": {
            "Currency": "string",
            "Value": 0
          },
          "TotalSellingPrice": {
            "Currency": "string",
            "Value": 0
          },
          "Quantity": 0,
          "IsAvailable": true,
          "CanBook": true,
          "PayDirectToHotel": true,
          "IsPrePayment": true,
          "InvoiceCC": true,
          "MoreInformation": "string",
          "CancellationPolicies": [
            {
              "StartDate": "string",
              "EndDate": "string",
              "Value": {
                "Currency": "string",
                "Value": 0
              }
            }
          ],
          "NumAdults": 0,
          "Halfboard": true,
          "Fulllboard": true,
          "AllInclusive": true,
          "HasBreakfast": true,
          "ChildAges": [
            0
          ],
          "IsNonRefundable": true,
          "CustomFields": [
            {
              "Name": "string",
              "Value": "string"
            }
          ],
          "Services": [
            {
              "Services": [
                {
                  "ID": "string",
                  "Name": "string",
                  "Price": {
                    "Currency": "string",
                    "Value": 0
                  },
                  "Comission": {
                    "Currency": "string",
                    "Value": 0
                  },
                  "Description": "string",
                  "CanSelectFirstDay": true
                }
              ],
              "Type": "string",
              "QtyMax": 0,
              "QtyMin": 0
            }
          ],
          "MediaRoomId": "string",
          "DepositRequired": true,
          "HomeId": "string",
          "CheckInHour": "string",
          "CheckOutHour": "string",
          "DirectAgreement": true,
          "Taxes": [
            {
              "Price": {
                "Currency": "string",
                "Value": 0
              },
              "Description": "string"
            }
          ],
          "TotalTax": {
            "Currency": "string",
            "Value": 0
          },
          "Promotions": [
            "string"
          ],
          "SpecialOffer": true,
          "CommissionPercent": 0,
          "Commission": {
            "Currency": "string",
            "Value": 0
          },
          "UniqueRoomId": "string",
          "CanInforSupplierInformation": true,
          "HotelId": 0,
          "InvoiceItems": [
            "string"
          ],
          "PaymentLimitDate": "/Date(1767225600000-0300)/",
          "PackageRate": true,
          "CancellationType": "string",
          "PropertyValue": {
            "Currency": "string",
            "Value": 0
          },
          "CanSelectFirstDay": true,
          "DiscountCoupon": {
            "DiscountCouponValue": {
              "Currency": "string",
              "Value": 0
            },
            "DiscountCouponDescription": "string",
            "DiscountCoupon": "string"
          },
          "PropertyTaxes": [
            {
              "Price": {
                "Currency": "string",
                "Value": 0
              },
              "Description": "string"
            }
          ],
          "PriceWithCoupon": {
            "Currency": "string",
            "Value": 0
          },
          "TotalPriceWithCoupon": {
            "Currency": "string",
            "Value": 0
          },
          "CouponPrice": {
            "Currency": "string",
            "Value": 0
          },
          "CouponCode": "string",
          "CouponDescription": "string",
          "PriceHasChanged": true,
          "PriceBreakdown": [
            {
              "Price": 0,
              "Currency": "string",
              "DateBreakdown": "/Date(1767225600000-0300)/",
              "DateBreakdownStr": "string",
              "PriceToFront": {
                "Currency": "string",
                "Value": 0
              }
            }
          ],
          "ExclusiveDeal": true,
          "TopHotel": true,
          "QuantityAvailable": 0,
          "BoardCode": "string",
          "BoardMoreInformation": "string",
          "BedDescription": "string",
          "DisneyPackage": true,
          "AcceptsLoyaltyNumber": true,
          "MarketingIncentive": "string"
        }
      ],
      "Name": "string",
      "Category": "string",
      "ThumbUrl": "string",
      "Latitude": 0.1,
      "CustomFields": [
        {
          "Name": "string",
          "Value": "string"
        }
      ],
      "Destination": {
        "Id": "string",
        "CountryId": "string",
        "Name": {
          "ptBR": "string",
          "es": "string",
          "en": "string"
        }
      },
      "Longitude": 0.1,
      "Address": "string",
      "Phone": "string",
      "Photos": "string",
      "HotelDescription": "string",
      "Amenities": "string",
      "Chain": "string",
      "PropertyType": "string"
    }
  ],
  "DebugInfo": [
    "string"
  ],
  "CustomFields": [
    {
      "Name": "string",
      "Value": "string"
    }
  ],
  "Warnings": [
    "string"
  ]
}

HotelPOST

GetBookingConditions — Hotel

O que faz: Consulta as condições de reserva dos quartos escolhidos em RoomIds, a partir do Token da pesquisa: políticas de cancelamento, prazos de depósito e formas de pagamento.

Atenção

Chamada obrigatória antes do DoBooking — o Search pode trazer dados de cache.

Atenção

CanBook: false bloqueia o DoBooking — não prossiga para a reserva.

Atenção

MustCheckHotelInfo: true significa que o hotel do fornecedor pode ser diferente do pesquisado. Gere um alerta pedindo confirmação do usuário; avançar mesmo assim é responsabilidade do integrador.

Nota

Mesmo se o cupom já foi aplicado no Search, reenvie o DiscountCode aqui — esta etapa garante o preço final e a disponibilidade real do quarto.

Regras e detalhes da operação

RoomIds deve corresponder à configuração de quartos escolhida na pesquisa.
DepositDeadlines[] contém Amount, Type e DeadlineMember. RoomsNextOption é uma lista no primeiro nível da resposta, não um campo dentro de Rooms[].

Respostas HTTP

HTTP	Descrição
200	OK — GetBookingConditionsResponse.
400	Requisição inválida: JSON malformado ou com campos inválidos.
500	Erro não tratado (fault WCF).

URL

https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/GetBookingConditions

Parâmetros

Campo	Tipo	Obrigatório	Descrição
Credential	object	Sim	Credenciais da integração.
Token	string	Sim	Token retornado na pesquisa de Hotel.
HotelId	number	Sim	Identificador numérico do hotel escolhido.
RoomIds	array	Sim	Lista de strings com os identificadores dos quartos selecionados na pesquisa.
RoomServices	array	Não	Serviços escolhidos por quarto. Services é uma lista de objetos com RoomDate e ServiceID, sem wrapper TicketDate.
DiscountCode	string	Não	Cupom de desconto; reenvie o código utilizado na pesquisa caso necessario.
RequestCustomFields	array	Não	Lista de campos personalizados com Name e Value.
GetNextRoomOnError	boolean	Não	Permite retornar opções alternativas em RoomsNextOption quando o quarto solicitado estiver indisponível.

Credential

Campo	Tipo	Obrigatório	Descrição
Username	string	Sim	Usuário da integração.
Password	string	Sim	Senha do usuário.

RoomServices[]

Campo	Tipo	Descrição
RoomId	string	Identificador do quarto ao qual os serviços se aplicam.

Outros campos (1)

Campo	Tipo	Descrição
Services	array<object>

RoomServices[].Services[]

Campo	Tipo	Descrição
RoomDate	string	Data do serviço no formato /Date(...)/.
ServiceID	string	Identificador do serviço selecionado.

RequestCustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Try it outReferência

Credentialobject*

Credenciais da integração.

Tokenstring*

Token retornado na pesquisa de Hotel.

HotelIdnumber*

Identificador numérico do hotel escolhido.

RoomIdsarray*

Lista de strings com os identificadores dos quartos selecionados na pesquisa.

RoomServicesarray

Serviços escolhidos por quarto. Services é uma lista de objetos com RoomDate e ServiceID, sem wrapper TicketDate.

DiscountCodestring

Cupom de desconto; reenvie o código utilizado na pesquisa caso necessario.

RequestCustomFieldsarray

Lista de campos personalizados com Name e Value.

GetNextRoomOnErrorboolean

Permite retornar opções alternativas em RoomsNextOption quando o quarto solicitado estiver indisponível.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/GetBookingConditions" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "string",
    "Password": "string"
  },
  "Token": "string",
  "HotelId": 0,
  "RoomIds": [
    "string"
  ],
  "RoomServices": [
    {
      "RoomId": "string",
      "Services": [
        {
          "RoomDate": "/Date(1767225600000-0300)/",
          "ServiceID": "string"
        }
      ]
    }
  ],
  "DiscountCode": "string",
  "RequestCustomFields": [
    {
      "Name": "string",
      "Value": "string"
    }
  ],
  "GetNextRoomOnError": true
}'

Campos da resposta

Campo	Tipo	Descrição
Token	string	Token da pesquisa usado nas próximas etapas.
Error	object	Detalhes de erro retornados pela API.
Messages	array<object>	Mensagens da operação.
Rooms	array<object>	Quartos selecionados e suas condições de reserva.
RoomsNextOption	array<object>	Lista de quartos alternativos quando GetNextRoomOnError permite buscar outra opção.
CanPayLater	boolean	Indicador de possibilidade de pagamento posterior.
RestrictionType	string	Tipo de restrição.
PayWithAgencyVCType	string	Tipo de pagamento com cartão virtual da agência.
RevalidateBookingConditions	object	Dados para revalidação das condições de reserva.

Outros campos (4)

Campo	Tipo	Descrição
TotalTime	number
TimeSpan	string
SInfo	string
PropertyType	string

Error

Campo	Tipo	Descrição
Token	string	Token da pesquisa usado nas próximas etapas.

Outros campos (7)

Campo	Tipo	Descrição
Server	string
Message	string
Stacktrace	string
TotalTime	number
Code	number
TimeSpan	string
SupportInfo	string

Messages[]

Outros campos (2)

Campo	Tipo	Descrição
value	string
content	string

Rooms[]

Campo	Tipo	Descrição
Id	number	Identificador numérico do quarto retornado.
SellingPricePerRoom	object	Preço de venda por quarto.
TotalSellingPrice	object	Preço total de venda.
CanBook	boolean	Se false, não prossiga para DoBooking.
CancellationPolicies	array<object>	Políticas de cancelamento com períodos e valores.
SupplierHotelName	string	Nome do hotel informado pelo fornecedor.
SupplierHotelAddress	string	Endereço do hotel informado pelo fornecedor.
RequiredFields	array<string>	Lista de campos exigidos retornada pelo fornecedor.
DepositDeadlines	array<object>	Prazos de depósito com Amount, Type e DeadlineMember.
MustCheckHotelInfo	boolean	Se true, confirme SupplierHotelName e SupplierHotelAddress com o usuário antes de reservar.
ShowCreditCard	boolean	Indicador de exibição de cartão retornado pela API.

Outros campos (59)

Campo	Tipo	Descrição
BoardDescription	string
RoomDescription	string
MinimumSellingPrice	object
Quantity	number
IsAvailable	boolean
PayDirectToHotel	boolean
IsPrePayment	boolean
InvoiceCC	boolean
MoreInformation	string
NumAdults	number
Halfboard	boolean
Fulllboard	boolean
AllInclusive	boolean
HasBreakfast	boolean
ChildAges	array<number>
IsNonRefundable	boolean
CustomFields	array<object>
Services	array<object>
MediaRoomId	string
DepositRequired	boolean
HomeId	string
CheckInHour	string
CheckOutHour	string
DirectAgreement	boolean
Taxes	array<object>
TotalTax	object
Promotions	array<string>
SpecialOffer	boolean
CommissionPercent	number
Commission	object
UniqueRoomId	string
CanInforSupplierInformation	boolean
HotelId	number
InvoiceItems	array<string>
PaymentLimitDate	string
PackageRate	boolean
CancellationType	string
PropertyValue	object
CanSelectFirstDay	boolean
DiscountCoupon	object
PropertyTaxes	array<object>
PriceWithCoupon	object
TotalPriceWithCoupon	object
CouponPrice	object
CouponCode	string
CouponDescription	string
PriceHasChanged	boolean
PriceBreakdown	array<object>
ExclusiveDeal	boolean
TopHotel	boolean
QuantityAvailable	number
BoardCode	string
BoardMoreInformation	string
BedDescription	string
DisneyPackage	boolean
AcceptsLoyaltyNumber	boolean
MarketingIncentive	string
Required	boolean
OperatorBookingDescription	string

Rooms[].SellingPricePerRoom

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].MinimumSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].TotalSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].CancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

Rooms[].CancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].CustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Rooms[].Services[]

Outros campos (4)

Campo	Tipo	Descrição
Services	array<object>
Type	string
QtyMax	number
QtyMin	number

Rooms[].Services[].Services[]

Outros campos (6)

Campo	Tipo	Descrição
ID	string
Name	string
Price	object
Comission	object
Description	string
CanSelectFirstDay	boolean

Rooms[].Services[].Services[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Services[].Services[].Comission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Taxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].Taxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].TotalTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Commission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].PropertyValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].DiscountCoupon

Outros campos (3)

Campo	Tipo	Descrição
DiscountCouponValue	object
DiscountCouponDescription	string
DiscountCoupon	string

Rooms[].DiscountCoupon.DiscountCouponValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].PropertyTaxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].PropertyTaxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].PriceWithCoupon

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].TotalPriceWithCoupon

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].CouponPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].PriceBreakdown[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.

Outros campos (4)

Campo	Tipo	Descrição
Price	number
DateBreakdown	string
DateBreakdownStr	string
PriceToFront	object

Rooms[].PriceBreakdown[].PriceToFront

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].DepositDeadlines[]

Campo	Tipo	Descrição
Amount	object	Montante do depósito.

Outros campos (2)

Campo	Tipo	Descrição
Type	number
DeadlineMember	string

Rooms[].DepositDeadlines[].Amount

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[]

Campo	Tipo	Descrição
Id	number	Identificador numérico do quarto retornado.
SellingPricePerRoom	object	Preço de venda por quarto.
TotalSellingPrice	object	Preço total de venda.
CanBook	boolean	Se false, não prossiga para DoBooking.
CancellationPolicies	array<object>	Políticas de cancelamento com períodos e valores.
SupplierHotelName	string	Nome do hotel informado pelo fornecedor.
SupplierHotelAddress	string	Endereço do hotel informado pelo fornecedor.
RequiredFields	array<string>	Lista de campos exigidos retornada pelo fornecedor.
DepositDeadlines	array<object>	Prazos de depósito com Amount, Type e DeadlineMember.
MustCheckHotelInfo	boolean	Se true, confirme SupplierHotelName e SupplierHotelAddress com o usuário antes de reservar.
ShowCreditCard	boolean	Indicador de exibição de cartão retornado pela API.

Outros campos (59)

Campo	Tipo	Descrição
BoardDescription	string
RoomDescription	string
MinimumSellingPrice	object
Quantity	number
IsAvailable	boolean
PayDirectToHotel	boolean
IsPrePayment	boolean
InvoiceCC	boolean
MoreInformation	string
NumAdults	number
Halfboard	boolean
Fulllboard	boolean
AllInclusive	boolean
HasBreakfast	boolean
ChildAges	array<number>
IsNonRefundable	boolean
CustomFields	array<object>
Services	array<object>
MediaRoomId	string
DepositRequired	boolean
HomeId	string
CheckInHour	string
CheckOutHour	string
DirectAgreement	boolean
Taxes	array<object>
TotalTax	object
Promotions	array<string>
SpecialOffer	boolean
CommissionPercent	number
Commission	object
UniqueRoomId	string
CanInforSupplierInformation	boolean
HotelId	number
InvoiceItems	array<string>
PaymentLimitDate	string
PackageRate	boolean
CancellationType	string
PropertyValue	object
CanSelectFirstDay	boolean
DiscountCoupon	object
PropertyTaxes	array<object>
PriceWithCoupon	object
TotalPriceWithCoupon	object
CouponPrice	object
CouponCode	string
CouponDescription	string
PriceHasChanged	boolean
PriceBreakdown	array<object>
ExclusiveDeal	boolean
TopHotel	boolean
QuantityAvailable	number
BoardCode	string
BoardMoreInformation	string
BedDescription	string
DisneyPackage	boolean
AcceptsLoyaltyNumber	boolean
MarketingIncentive	string
Required	boolean
OperatorBookingDescription	string

RoomsNextOption[].SellingPricePerRoom

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].MinimumSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].TotalSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].CancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

RoomsNextOption[].CancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].CustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

RoomsNextOption[].Services[]

Outros campos (4)

Campo	Tipo	Descrição
Services	array<object>
Type	string
QtyMax	number
QtyMin	number

RoomsNextOption[].Services[].Services[]

Outros campos (6)

Campo	Tipo	Descrição
ID	string
Name	string
Price	object
Comission	object
Description	string
CanSelectFirstDay	boolean

RoomsNextOption[].Services[].Services[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].Services[].Services[].Comission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].Taxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

RoomsNextOption[].Taxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].TotalTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].Commission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].PropertyValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].DiscountCoupon

Outros campos (3)

Campo	Tipo	Descrição
DiscountCouponValue	object
DiscountCouponDescription	string
DiscountCoupon	string

RoomsNextOption[].DiscountCoupon.DiscountCouponValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].PropertyTaxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

RoomsNextOption[].PropertyTaxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].PriceWithCoupon

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].TotalPriceWithCoupon

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].CouponPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].PriceBreakdown[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.

Outros campos (4)

Campo	Tipo	Descrição
Price	number
DateBreakdown	string
DateBreakdownStr	string
PriceToFront	object

RoomsNextOption[].PriceBreakdown[].PriceToFront

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RoomsNextOption[].DepositDeadlines[]

Campo	Tipo	Descrição
Amount	object	Montante do depósito.

Outros campos (2)

Campo	Tipo	Descrição
Type	number
DeadlineMember	string

RoomsNextOption[].DepositDeadlines[].Amount

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

RevalidateBookingConditions

Campo	Tipo	Descrição
RoomsConditions	string	Condições de quartos retornadas para revalidação.

Exemplo de response

{
  "TotalTime": 0,
  "Token": "string",
  "TimeSpan": "string",
  "Error": {
    "Server": "string",
    "Message": "string",
    "Stacktrace": "string",
    "TotalTime": 0,
    "Code": 0,
    "Token": "string",
    "TimeSpan": "string",
    "SupportInfo": "string"
  },
  "Messages": [
    {
      "value": "string",
      "content": "string"
    }
  ],
  "SInfo": "string",
  "Rooms": [
    {
      "Id": 0,
      "BoardDescription": "string",
      "RoomDescription": "string",
      "SellingPricePerRoom": {
        "Currency": "string",
        "Value": 0
      },
      "MinimumSellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "TotalSellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "Quantity": 0,
      "IsAvailable": true,
      "CanBook": true,
      "PayDirectToHotel": true,
      "IsPrePayment": true,
      "InvoiceCC": true,
      "MoreInformation": "string",
      "CancellationPolicies": [
        {
          "StartDate": "string",
          "EndDate": "string",
          "Value": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "NumAdults": 0,
      "Halfboard": true,
      "Fulllboard": true,
      "AllInclusive": true,
      "HasBreakfast": true,
      "ChildAges": [
        0
      ],
      "IsNonRefundable": true,
      "CustomFields": [
        {
          "Name": "string",
          "Value": "string"
        }
      ],
      "Services": [
        {
          "Services": [
            {
              "ID": "string",
              "Name": "string",
              "Price": {
                "Currency": "string",
                "Value": 0
              },
              "Comission": {
                "Currency": "string",
                "Value": 0
              },
              "Description": "string",
              "CanSelectFirstDay": true
            }
          ],
          "Type": "string",
          "QtyMax": 0,
          "QtyMin": 0
        }
      ],
      "MediaRoomId": "string",
      "DepositRequired": true,
      "HomeId": "string",
      "CheckInHour": "string",
      "CheckOutHour": "string",
      "DirectAgreement": true,
      "Taxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "TotalTax": {
        "Currency": "string",
        "Value": 0
      },
      "Promotions": [
        "string"
      ],
      "SpecialOffer": true,
      "CommissionPercent": 0,
      "Commission": {
        "Currency": "string",
        "Value": 0
      },
      "UniqueRoomId": "string",
      "CanInforSupplierInformation": true,
      "HotelId": 0,
      "InvoiceItems": [
        "string"
      ],
      "PaymentLimitDate": "/Date(1767225600000-0300)/",
      "PackageRate": true,
      "CancellationType": "string",
      "PropertyValue": {
        "Currency": "string",
        "Value": 0
      },
      "CanSelectFirstDay": true,
      "DiscountCoupon": {
        "DiscountCouponValue": {
          "Currency": "string",
          "Value": 0
        },
        "DiscountCouponDescription": "string",
        "DiscountCoupon": "string"
      },
      "PropertyTaxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "PriceWithCoupon": {
        "Currency": "string",
        "Value": 0
      },
      "TotalPriceWithCoupon": {
        "Currency": "string",
        "Value": 0
      },
      "CouponPrice": {
        "Currency": "string",
        "Value": 0
      },
      "CouponCode": "string",
      "CouponDescription": "string",
      "PriceHasChanged": true,
      "PriceBreakdown": [
        {
          "Price": 0,
          "Currency": "string",
          "DateBreakdown": "/Date(1767225600000-0300)/",
          "DateBreakdownStr": "string",
          "PriceToFront": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "ExclusiveDeal": true,
      "TopHotel": true,
      "QuantityAvailable": 0,
      "BoardCode": "string",
      "BoardMoreInformation": "string",
      "BedDescription": "string",
      "DisneyPackage": true,
      "AcceptsLoyaltyNumber": true,
      "MarketingIncentive": "string",
      "SupplierHotelName": "string",
      "SupplierHotelAddress": "string",
      "Required": true,
      "RequiredFields": [
        "string"
      ],
      "DepositDeadlines": [
        {
          "Amount": {
            "Currency": "string",
            "Value": 0
          },
          "Type": 0,
          "DeadlineMember": "/Date(1767225600000-0300)/"
        }
      ],
      "OperatorBookingDescription": "string",
      "MustCheckHotelInfo": true,
      "ShowCreditCard": true
    }
  ],
  "RoomsNextOption": [
    {
      "Id": 0,
      "BoardDescription": "string",
      "RoomDescription": "string",
      "SellingPricePerRoom": {
        "Currency": "string",
        "Value": 0
      },
      "MinimumSellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "TotalSellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "Quantity": 0,
      "IsAvailable": true,
      "CanBook": true,
      "PayDirectToHotel": true,
      "IsPrePayment": true,
      "InvoiceCC": true,
      "MoreInformation": "string",
      "CancellationPolicies": [
        {
          "StartDate": "string",
          "EndDate": "string",
          "Value": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "NumAdults": 0,
      "Halfboard": true,
      "Fulllboard": true,
      "AllInclusive": true,
      "HasBreakfast": true,
      "ChildAges": [
        0
      ],
      "IsNonRefundable": true,
      "CustomFields": [
        {
          "Name": "string",
          "Value": "string"
        }
      ],
      "Services": [
        {
          "Services": [
            {
              "ID": "string",
              "Name": "string",
              "Price": {
                "Currency": "string",
                "Value": 0
              },
              "Comission": {
                "Currency": "string",
                "Value": 0
              },
              "Description": "string",
              "CanSelectFirstDay": true
            }
          ],
          "Type": "string",
          "QtyMax": 0,
          "QtyMin": 0
        }
      ],
      "MediaRoomId": "string",
      "DepositRequired": true,
      "HomeId": "string",
      "CheckInHour": "string",
      "CheckOutHour": "string",
      "DirectAgreement": true,
      "Taxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "TotalTax": {
        "Currency": "string",
        "Value": 0
      },
      "Promotions": [
        "string"
      ],
      "SpecialOffer": true,
      "CommissionPercent": 0,
      "Commission": {
        "Currency": "string",
        "Value": 0
      },
      "UniqueRoomId": "string",
      "CanInforSupplierInformation": true,
      "HotelId": 0,
      "InvoiceItems": [
        "string"
      ],
      "PaymentLimitDate": "/Date(1767225600000-0300)/",
      "PackageRate": true,
      "CancellationType": "string",
      "PropertyValue": {
        "Currency": "string",
        "Value": 0
      },
      "CanSelectFirstDay": true,
      "DiscountCoupon": {
        "DiscountCouponValue": {
          "Currency": "string",
          "Value": 0
        },
        "DiscountCouponDescription": "string",
        "DiscountCoupon": "string"
      },
      "PropertyTaxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "PriceWithCoupon": {
        "Currency": "string",
        "Value": 0
      },
      "TotalPriceWithCoupon": {
        "Currency": "string",
        "Value": 0
      },
      "CouponPrice": {
        "Currency": "string",
        "Value": 0
      },
      "CouponCode": "string",
      "CouponDescription": "string",
      "PriceHasChanged": true,
      "PriceBreakdown": [
        {
          "Price": 0,
          "Currency": "string",
          "DateBreakdown": "/Date(1767225600000-0300)/",
          "DateBreakdownStr": "string",
          "PriceToFront": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "ExclusiveDeal": true,
      "TopHotel": true,
      "QuantityAvailable": 0,
      "BoardCode": "string",
      "BoardMoreInformation": "string",
      "BedDescription": "string",
      "DisneyPackage": true,
      "AcceptsLoyaltyNumber": true,
      "MarketingIncentive": "string",
      "SupplierHotelName": "string",
      "SupplierHotelAddress": "string",
      "Required": true,
      "RequiredFields": [
        "string"
      ],
      "DepositDeadlines": [
        {
          "Amount": {
            "Currency": "string",
            "Value": 0
          },
          "Type": 0,
          "DeadlineMember": "/Date(1767225600000-0300)/"
        }
      ],
      "OperatorBookingDescription": "string",
      "MustCheckHotelInfo": true,
      "ShowCreditCard": true
    }
  ],
  "CanPayLater": true,
  "RestrictionType": "string",
  "PayWithAgencyVCType": "string",
  "RevalidateBookingConditions": {
    "RoomsConditions": "string"
  },
  "PropertyType": "string"
}

HotelPOST

DoBooking — Hotel

O que faz: Efetua a reserva dos quartos escolhidos a partir do Token da pesquisa, informando hóspedes e pagamento.

Atenção

Em erro HTTP ou timeout, NÃO crie nova reserva: consulte CheckBookingStatus / GetBookingDetail antes de qualquer nova tentativa.

Atenção

Um Token só pode gerar UMA reserva. Reenviar o mesmo Token para criar outra retorna [ERR_0567].

Nota

Quando IsBilled = true, os dados de cartão e contratante são dispensados; sem uso de uma forma de pagamento, Payment e IsBilled não precisam ser enviados.

Regras e detalhes da operação

Se SetWaitingPayment = true, a reserva fica "awaiting payment" até o payBooking.
Age é obrigatório somente para hóspedes com isChild = true. Address não é obrigatório e não há regra de quantidade de caracteres para Cpf.
Payment fica dentro de Rooms[].
Use Rooms[].ReservationId como BookingId nas operações posteriores e confira Rooms[].Status para saber se o serviço está Confirmed.

Respostas HTTP

HTTP	Descrição
200	OK — DoBookingResponse.
400	Requisição inválida: JSON malformado ou com campos inválidos.
500	Erro não tratado (fault WCF).

URL

https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/DoBooking

Parâmetros

Campo	Tipo	Obrigatório	Descrição
Token	string	Sim	Token retornado pela pesquisa de Hotel.
Credential	object	Sim	Credenciais da integração.
HotelId	number	Sim	Identificador do hotel escolhido.
Rooms	array	Sim	Quartos da reserva; cada item contém RoomId, Paxs e, quando utilizado, Payment.
BookingId	number	Não	Identificador numérico da reserva.
SendEmail	boolean	Não	Indicador de envio de e-mail.
SetWaitingPayment	boolean	Não	Se true, a reserva fica awaiting payment até o payBooking.
ClientReference	string	Não	Referência interna do integrador; recomendada para localizar a reserva em casos de erro ou timeout.
DiscountCode	string	Não	Código do cupom de desconto; mantenha o código utilizado nas etapas anteriores.

Outros campos (11)

Campo	Tipo	Obrigatório
PayBeforeBook	boolean	Não
ResponsibleOperatorId	number	Não
PayWithAgencyVC	boolean	Não
Invoice	boolean	Não
AgencyCardId	number	Não
SupplierPaymentAgencyCardId	number	Não
CardId	number	Não
CgrCore	boolean	Não
MotivoViagem	number	Não
CentroCusto	string	Não
Projeto	string	Não

Credential

Campo	Tipo	Obrigatório	Descrição
Username	string	Sim	Usuário da integração.
Password	string	Sim	Senha do usuário.

Rooms[]

Campo	Tipo	Descrição
Paxs	array<object>	Hóspedes do quarto. Age é obrigatório quando isChild = true; para adultos, é opcional.
RoomId	string	Identificador do quarto selecionado, enviado como string nesta operação.
Payment	object	Pagamento do quarto. Sem uso de uma forma de pagamento, não é necessário enviar Payment ou IsBilled.
RoomServices	array<string>	Lista de strings dos serviços do quarto.
InvoceItens	array<number>	Lista numérica de itens no request; grafia preservada.
CorporateInfo	object	Informações corporativas associadas ao quarto.

Outros campos (1)

Campo	Tipo	Descrição
InformationToSupplier	string

Rooms[].Paxs[]

Campo	Tipo	Descrição
Age	number	Idade do hóspede; obrigatória somente quando isChild = true.
MainPax	boolean	Indica o hóspede principal.
isChild	boolean	Indica se o hóspede é criança.

Outros campos (31)

Campo	Tipo	Descrição
Name	string
Surname	string
Cpf	string
DocumentNumber	string
DocumentExpirationDate	string
DocumentCountryId	string
DocumentType	string
Title	string
EnumTitle	string
Address	string
City	string
ZipCode	string
State	string
AddressNumber	number
AddressComplement	string
Email	string
PhoneDDD	string
PhoneDDI	string
PhoneNumber	string
BirthDate	string
CountryCodeISO	string
Type	string
EmergencyContactFirstName	string
EmergencyContactLastName	string
EmergencyContactDDI	string
EmergencyContactDDD	string
EmergencyContactTelephone	string
EmergencyContactParentage	string
Ticket	string
LoyaltyNumber	string
AcceptMarketingEmail	boolean

Rooms[].Payment

Campo	Tipo	Descrição
PaymentRequestCC1	object	Dados da primeira solicitação de pagamento por cartão.
PaymentRequestCC2	object	Dados da segunda solicitação de pagamento por cartão.
PaymentConditionId	number	Identificador da condição de pagamento utilizada.

Outros campos (5)

Campo	Tipo	Descrição
UrlPosPayment	string
RetainCommission	boolean
SmartCommissionValue	number
PaymentSource	string
FraudAnalysis	object

Rooms[].Payment.PaymentRequestCC1

Campo	Tipo	Descrição
IsBilled	boolean	Quando true, dispensa os dados de cartão e contratante. Se houver pagamento e IsBilled não for true, informe os dados necessários da forma de pagamento.
CreditCard	object	Dados do cartão de pagamento.
ContractingParty	object	Dados do contratante do pagamento.

Rooms[].Payment.PaymentRequestCC1.CreditCard

Outros campos (7)

Campo	Tipo	Descrição
Holder	string
CardNumber	string
SecurityCode	string
YearExpiration	number
MonthExpiration	number
NumberPayments	number
CardOperator	string

Rooms[].Payment.PaymentRequestCC1.ContractingParty

Outros campos (15)

Campo	Tipo	Descrição
DistrictName	string
ZipCode	string
CityName	string
AddressComplement	string
CPF	string
Address	string
PersonName	string
AddressNumber	string
PhoneNumber	string
PhoneNumberDDD	string
PhoneNumberDDI	string
StateCode	string
Email	string
ReceiveCreditCardReceipt	boolean
CountryCode	string

Rooms[].Payment.PaymentRequestCC2

Campo	Tipo	Descrição
IsBilled	boolean	Quando true, dispensa os dados de cartão e contratante. Se houver pagamento e IsBilled não for true, informe os dados necessários da forma de pagamento.
CreditCard	object	Dados do cartão de pagamento.
ContractingParty	object	Dados do contratante do pagamento.

Rooms[].Payment.PaymentRequestCC2.CreditCard

Outros campos (7)

Campo	Tipo	Descrição
Holder	string
CardNumber	string
SecurityCode	string
YearExpiration	number
MonthExpiration	number
NumberPayments	number
CardOperator	string

Rooms[].Payment.PaymentRequestCC2.ContractingParty

Outros campos (15)

Campo	Tipo	Descrição
DistrictName	string
ZipCode	string
CityName	string
AddressComplement	string
CPF	string
Address	string
PersonName	string
AddressNumber	string
PhoneNumber	string
PhoneNumberDDD	string
PhoneNumberDDI	string
StateCode	string
Email	string
ReceiveCreditCardReceipt	boolean
CountryCode	string

Rooms[].Payment.FraudAnalysis

Outros campos (3)

Campo	Tipo	Descrição
FingerPrintId	string
IpAddress	string
UserAgent	string

Rooms[].CorporateInfo

Outros campos (11)

Campo	Tipo	Descrição
ControlInfo	string
ControlInfo2	string
ControlInfo3	string
Authorizer	string
CostCenter	string
Department	string
Registration	string
Request	string
Requester	string
ClientId	string
Chavecartao	string

Try it outReferência

Tokenstring*

Token retornado pela pesquisa de Hotel.

Credentialobject*

Credenciais da integração.

HotelIdnumber*

Identificador do hotel escolhido.

Roomsarray*

[{"Paxs":[{"Name":"string","Surname":"string","Age":0,"Cpf":"string","DocumentNumber":"string","DocumentExpirationDate":"string","DocumentCountryId":"string","DocumentType":"string","Title":"string","EnumTitle":"string","MainPax":true,"isChild":true,"Address":"string","City":"string","ZipCode":"string","State":"string","AddressNumber":0,"AddressComplement":"string","Email":"string","PhoneDDD":"string","PhoneDDI":"string","PhoneNumber":"string","BirthDate":"string","CountryCodeISO":"string","Type":"string","EmergencyContactFirstName":"string","EmergencyContactLastName":"string","EmergencyContactDDI":"string","EmergencyContactDDD":"string","EmergencyContactTelephone":"string","EmergencyContactParentage":"string","Ticket":"string","LoyaltyNumber":"string","AcceptMarketingEmail":true}],"RoomId":"string","Payment":{"PaymentRequestCC1":{"IsBilled":true,"CreditCard":{"Holder":"string","CardNumber":"string","SecurityCode":"string","YearExpiration":0,"MonthExpiration":0,"NumberPayments":0,"CardOperator":"string"},"ContractingParty":{"DistrictName":"string","ZipCode":"string","CityName":"string","AddressComplement":"string","CPF":"string","Address":"string","PersonName":"string","AddressNumber":"string","PhoneNumber":"string","PhoneNumberDDD":"string","PhoneNumberDDI":"string","StateCode":"string","Email":"string","ReceiveCreditCardReceipt":true,"CountryCode":"string"}},"PaymentRequestCC2":{"IsBilled":true,"CreditCard":{"Holder":"string","CardNumber":"string","SecurityCode":"string","YearExpiration":0,"MonthExpiration":0,"NumberPayments":0,"CardOperator":"string"},"ContractingParty":{"DistrictName":"string","ZipCode":"string","CityName":"string","AddressComplement":"string","CPF":"string","Address":"string","PersonName":"string","AddressNumber":"string","PhoneNumber":"string","PhoneNumberDDD":"string","PhoneNumberDDI":"string","StateCode":"string","Email":"string","ReceiveCreditCardReceipt":true,"CountryCode":"string"}},"UrlPosPayment":"string","RetainCommission":true,"SmartCommissionValue":0,"PaymentConditionId":0,"PaymentSource":"string","FraudAnalysis":{"FingerPrintId":"string","IpAddress":"string","UserAgent":"string"}},"InformationToSupplier":"string","RoomServices":["string"],"InvoceItens":[0],"CorporateInfo":{"ControlInfo":"string","ControlInfo2":"string","ControlInfo3":"string","Authorizer":"string","CostCenter":"string","Department":"string","Registration":"string","Request":"string","Requester":"string","ClientId":"string","Chavecartao":"string"}}]

Quartos da reserva; cada item contém RoomId, Paxs e, quando utilizado, Payment.

BookingIdnumber

Identificador numérico da reserva.

SendEmailboolean

Indicador de envio de e-mail.

SetWaitingPaymentboolean

Se true, a reserva fica awaiting payment até o payBooking.

PayBeforeBookboolean

ClientReferencestring

Referência interna do integrador; recomendada para localizar a reserva em casos de erro ou timeout.

ResponsibleOperatorIdnumber

DiscountCodestring

Código do cupom de desconto; mantenha o código utilizado nas etapas anteriores.

PayWithAgencyVCboolean

Invoiceboolean

AgencyCardIdnumber

SupplierPaymentAgencyCardIdnumber

CardIdnumber

CgrCoreboolean

MotivoViagemnumber

CentroCustostring

Projetostring

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/DoBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Token": "string",
  "Credential": {
    "Username": "string",
    "Password": "string"
  },
  "HotelId": 0,
  "Rooms": [
    {
      "Paxs": [
        {
          "Name": "string",
          "Surname": "string",
          "Age": 0,
          "Cpf": "string",
          "DocumentNumber": "string",
          "DocumentExpirationDate": "string",
          "DocumentCountryId": "string",
          "DocumentType": "string",
          "Title": "string",
          "EnumTitle": "string",
          "MainPax": true,
          "isChild": true,
          "Address": "string",
          "City": "string",
          "ZipCode": "string",
          "State": "string",
          "AddressNumber": 0,
          "AddressComplement": "string",
          "Email": "string",
          "PhoneDDD": "string",
          "PhoneDDI": "string",
          "PhoneNumber": "string",
          "BirthDate": "string",
          "CountryCodeISO": "string",
          "Type": "string",
          "EmergencyContactFirstName": "string",
          "EmergencyContactLastName": "string",
          "EmergencyContactDDI": "string",
          "EmergencyContactDDD": "string",
          "EmergencyContactTelephone": "string",
          "EmergencyContactParentage": "string",
          "Ticket": "string",
          "LoyaltyNumber": "string",
          "AcceptMarketingEmail": true
        }
      ],
      "RoomId": "string",
      "Payment": {
        "PaymentRequestCC1": {
          "IsBilled": true,
          "CreditCard": {
            "Holder": "string",
            "CardNumber": "string",
            "SecurityCode": "string",
            "YearExpiration": 0,
            "MonthExpiration": 0,
            "NumberPayments": 0,
            "CardOperator": "string"
          },
          "ContractingParty": {
            "DistrictName": "string",
            "ZipCode": "string",
            "CityName": "string",
            "AddressComplement": "string",
            "CPF": "string",
            "Address": "string",
            "PersonName": "string",
            "AddressNumber": "string",
            "PhoneNumber": "string",
            "PhoneNumberDDD": "string",
            "PhoneNumberDDI": "string",
            "StateCode": "string",
            "Email": "string",
            "ReceiveCreditCardReceipt": true,
            "CountryCode": "string"
          }
        },
        "PaymentRequestCC2": {
          "IsBilled": true,
          "CreditCard": {
            "Holder": "string",
            "CardNumber": "string",
            "SecurityCode": "string",
            "YearExpiration": 0,
            "MonthExpiration": 0,
            "NumberPayments": 0,
            "CardOperator": "string"
          },
          "ContractingParty": {
            "DistrictName": "string",
            "ZipCode": "string",
            "CityName": "string",
            "AddressComplement": "string",
            "CPF": "string",
            "Address": "string",
            "PersonName": "string",
            "AddressNumber": "string",
            "PhoneNumber": "string",
            "PhoneNumberDDD": "string",
            "PhoneNumberDDI": "string",
            "StateCode": "string",
            "Email": "string",
            "ReceiveCreditCardReceipt": true,
            "CountryCode": "string"
          }
        },
        "UrlPosPayment": "string",
        "RetainCommission": true,
        "SmartCommissionValue": 0,
        "PaymentConditionId": 0,
        "PaymentSource": "string",
        "FraudAnalysis": {
          "FingerPrintId": "string",
          "IpAddress": "string",
          "UserAgent": "string"
        }
      },
      "InformationToSupplier": "string",
      "RoomServices": [
        "string"
      ],
      "InvoceItens": [
        0
      ],
      "CorporateInfo": {
        "ControlInfo": "string",
        "ControlInfo2": "string",
        "ControlInfo3": "string",
        "Authorizer": "string",
        "CostCenter": "string",
        "Department": "string",
        "Registration": "string",
        "Request": "string",
        "Requester": "string",
        "ClientId": "string",
        "Chavecartao": "string"
      }
    }
  ],
  "BookingId": 0,
  "SendEmail": true,
  "SetWaitingPayment": true,
  "PayBeforeBook": true,
  "ClientReference": "string",
  "ResponsibleOperatorId": 0,
  "DiscountCode": "string",
  "PayWithAgencyVC": true,
  "Invoice": true,
  "AgencyCardId": 0,
  "SupplierPaymentAgencyCardId": 0,
  "CardId": 0,
  "CgrCore": true,
  "MotivoViagem": 0,
  "CentroCusto": "string",
  "Projeto": "string"
}'

Campos da resposta

Campo	Tipo	Descrição
Token	string	Token retornado pela pesquisa de Hotel.
Error	object	Detalhes de erro retornados pela API.
Messages	array<object>	Mensagens da operação.
Rooms	array<object>	Quartos da reserva; cada item contém RoomId, Paxs e, quando utilizado, Payment.
RequestId	number	Identificador numérico da solicitação gerada quando aplicável, inclusive em caso de restrição do cliente.

Outros campos (3)

Campo	Tipo	Descrição
TotalTime	number
TimeSpan	string
SInfo	string

Error

Campo	Tipo	Descrição
Token	string	Token retornado pela pesquisa de Hotel.

Outros campos (7)

Campo	Tipo	Descrição
Server	string
Message	string
Stacktrace	string
TotalTime	number
Code	number
TimeSpan	string
SupportInfo	string

Messages[]

Outros campos (2)

Campo	Tipo	Descrição
value	string
content	string

Rooms[]

Campo	Tipo	Descrição
ServiceId	string	Identificador do serviço retornado em Rooms[].
ReservationId	string	Identificador da reserva retornado em Rooms[], utilizado como BookingId nas operações posteriores.
Status	string	Estado do serviço; considere confirmado somente quando o valor for Confirmed. O valor string do exemplo não indica sucesso.
Paxs	array<object>	Hóspedes do quarto. Age é obrigatório quando isChild = true; para adultos, é opcional.
CancellationPolicies	array<object>	Políticas de cancelamento com períodos e valores.
SupplierReservationCode	string	Localizador da reserva no fornecedor.
HotelConfirmationNumber	string	Número de confirmação do próprio hotel.
HotelId	string	Identificador do hotel escolhido.
HCN	string	Número de confirmação do hotel.
Payments	array<object>	Pagamentos retornados para o serviço; estrutura distinta do Payment enviado na requisição.
DepositDeadlines	array<object>	Prazos de depósito com Deadline, Value e Type nesta resposta.

Outros campos (104)

Campo	Tipo	Descrição
Observations	string
SellingPrice	object
Comission	object
HotelName	string
DestinationName	string
CheckIn	string
CheckOut	string
HotelAddress	string
BoardDescription	string
RoomDescription	string
CustomFields	array<object>
PaymentStatus	string
Phone	string
DestinationId	string
SupplierHotelId	string
CancellationDate	string
HotelCategory	string
ReservationDate	string
LogXMLAudit	string
NumberOfAdults	number
NumberOfChildren	number
NumberOfNights	number
CountryId	string
AutomaticCancellation	boolean
Markup	number
MarkupCalculation	string
CommissionCalculation	string
IsOffline	boolean
MarkupType	string
CommissionRetained	boolean
CancellationBlockedWS	boolean
PaymentDeadLine	string
VoucherObservation	string
PaymentDate	string
InvoiceId	number
PaymentConvertionRate	number
PaymentCurrency	string
NetTax	object
TotalTax	object
SellingPriceWithoutTax	object
CanSeeVoucher	boolean
AgencyCommissionPercent	number
OperatorBookingDescription	string
CheckInHour	string
CheckOutHour	string
InvoiceItens	array<string>
SupplierInformation	string
AddAdditionalInfo	array<object>
Taxes	array<object>
DiscountCoupon	object
CityId	number
CountryCode	string
CountryName	string
CityName	string
ManualReservationPaymentType	string
PropertyTaxes	array<object>
CancellationType	string
VoucherUrl	string
CreationUserDetail	object
BookingWillBeInvoiced	boolean
AutomaticCancellationEnabled	boolean
HotelCNPJ	string
BreakdownSales	array<object>
BookingDescription	string
BreakfastIncluded	boolean
Billed	boolean
AgencyCommission	number
CheckInDate	string
ExtraInformation	string
AgencyCurrencyCommission	string
NetPrice	object
OperatorCancellationPolicies	array<object>
SystemStatus	number
PaymentsConditions	object
ProviderID	number
ProviderName	string
LastUpdateUserDetail	object
OriginalAgencyCommission	number
BilletURL	string
UniqueIdentifier	string
FinancialTransactions	array<object>
SupplierFinancialTransactions	array<object>
BloquearRebooking	boolean
PaymentType	string
UrlRedirectAfterCancelWhenHasRefund	string
SupplierComission	object
SupplierCommissionPercent	number
PayAtHotel	boolean
SupplierVCNPayment	boolean
SupplierCardNumber	string
BeforeBooking	string
Discount	object
OriginalSellingPrice	object
MotivoViagem	string
CentroCusto	string
CheckinInstructions	string
CheckinUrl	string
Projeto	string
CardProcessingDate	string
Extras	array<object>
AssyncBooking	boolean
PropertyType	string
CangoorooInvoiceType	string
ManualReservation	boolean

Rooms[].Paxs[]

Campo	Tipo	Descrição
Age	number	Idade do hóspede; obrigatória somente quando isChild = true.
MainPax	boolean	Indica o hóspede principal.
isChild	boolean	Indica se o hóspede é criança.

Outros campos (31)

Campo	Tipo	Descrição
Name	string
Surname	string
Cpf	string
DocumentNumber	string
DocumentExpirationDate	string
DocumentCountryId	string
DocumentType	string
Title	string
EnumTitle	string
Address	string
City	string
ZipCode	string
State	string
AddressNumber	number
AddressComplement	string
Email	string
PhoneDDD	string
PhoneDDI	string
PhoneNumber	string
BirthDate	string
CountryCodeISO	string
Type	string
EmergencyContactFirstName	string
EmergencyContactLastName	string
EmergencyContactDDI	string
EmergencyContactDDD	string
EmergencyContactTelephone	string
EmergencyContactParentage	string
Ticket	string
LoyaltyNumber	string
AcceptMarketingEmail	boolean

Rooms[].SellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Comission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].CustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Rooms[].CancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

Rooms[].CancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].NetTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].TotalTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].SellingPriceWithoutTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].AddAdditionalInfo[]

Outros campos (2)

Campo	Tipo	Descrição
Content	string
Name	string

Rooms[].Payments[]

Campo	Tipo	Descrição
Status	number	Estado do serviço; considere confirmado somente quando o valor for Confirmed. O valor string do exemplo não indica sucesso.
CreditCard	object	Dados do cartão de pagamento.
Currency	object	Moeda do valor informado.

Outros campos (16)

Campo	Tipo	Descrição
Date	string
PaymentType	number
PaymentOriginal	object
PaymentConverted	object
PaymentPortion	object
Check	object
Billet	object
CreditAccount	object
MessageClientAuth	string
MessageOperAuth	string
URLReceiptOfPayment	string
TransactionId	string
InvoicePaymentId	string
PaymentSupplierId	number
PaymentSupplierName	string
Observation	string

Rooms[].Payments[].PaymentOriginal

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Payments[].PaymentConverted

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Payments[].PaymentPortion

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Payments[].CreditCard

Outros campos (10)

Campo	Tipo	Descrição
Name	string
CPF	string
Location	object
Phone	object
CardNumber	string
PaymentNumber	number
CardType	object
ExpirationMonth	number
ExpirationYear	number
InstallmentsNumber	number

Rooms[].Payments[].CreditCard.Location

Outros campos (7)

Campo	Tipo	Descrição
Address	string
Number	string
Complement	string
District	string
ZipCode	string
City	string
State	string

Rooms[].Payments[].CreditCard.Phone

Outros campos (3)

Campo	Tipo	Descrição
DDI	string
DDD	string
Number	string

Rooms[].Payments[].CreditCard.CardType

Outros campos (8)

Campo	Tipo	Descrição
Name	string
AutorizationCode	string
TransactionId	string
Price	object
TransactionDate	string
ReturnCode	string
NSU	string
Gateway	string

Rooms[].Payments[].CreditCard.CardType.Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Payments[].Check

Campo	Tipo	Descrição
Value	object	Valor informado.

Outros campos (2)

Campo	Tipo	Descrição
Number	string
Bank	string

Rooms[].Payments[].Check.Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Payments[].Billet

Outros campos (5)

Campo	Tipo	Descrição
Name	string
CPF	string
CNPJ	string
Location	object
Phone	object

Rooms[].Payments[].Billet.Location

Outros campos (7)

Campo	Tipo	Descrição
Address	string
Number	string
Complement	string
District	string
ZipCode	string
City	string
State	string

Rooms[].Payments[].Billet.Phone

Outros campos (3)

Campo	Tipo	Descrição
DDI	string
DDD	string
Number	string

Rooms[].Payments[].CreditAccount

Outros campos (6)

Campo	Tipo	Descrição
Bank	string
BankCode	string
AgencyCode	string
AccountNumber	string
CardName	string
CNPJ	string

Rooms[].Payments[].Currency

Outros campos (3)

Campo	Tipo	Descrição
CurrencyFrom	string
CurrencyTo	string
ConvertionValue	number

Rooms[].Taxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].Taxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].DiscountCoupon

Outros campos (3)

Campo	Tipo	Descrição
DiscountCouponValue	object
DiscountCouponDescription	string
DiscountCoupon	string

Rooms[].DiscountCoupon.DiscountCouponValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].PropertyTaxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].PropertyTaxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].CreationUserDetail

Outros campos (9)

Campo	Tipo	Descrição
id	number
Username	string
Name	string
Type	string
AgencyId	number
AgencyName	string
BranchOfficeId	number
BranchOfficeName	string
Email	string

Rooms[].BreakdownSales[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.

Outros campos (4)

Campo	Tipo	Descrição
Price	number
DateBreakdown	string
DateBreakdownStr	string
PriceToFront	object

Rooms[].BreakdownSales[].PriceToFront

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].NetPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].OperatorCancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

Rooms[].OperatorCancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].PaymentsConditions

Campo	Tipo	Descrição
Status	boolean	Estado do serviço; considere confirmado somente quando o valor for Confirmed. O valor string do exemplo não indica sucesso.

Outros campos (4)

Campo	Tipo	Descrição
PaymentType	number
NameCondition	string
FinancialRate	string
IdCondition	number

Rooms[].LastUpdateUserDetail

Outros campos (9)

Campo	Tipo	Descrição
id	number
Username	string
Name	string
Type	string
AgencyId	number
AgencyName	string
BranchOfficeId	number
BranchOfficeName	string
Email	string

Rooms[].DepositDeadlines[]

Campo	Tipo	Descrição
Value	object	Valor informado.

Outros campos (2)

Campo	Tipo	Descrição
Deadline	string
Type	number

Rooms[].DepositDeadlines[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].FinancialTransactions[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.
Status	string	Estado do serviço; considere confirmado somente quando o valor for Confirmed. O valor string do exemplo não indica sucesso.

Outros campos (3)

Campo	Tipo	Descrição
Date	string
Type	string
Information	string

Rooms[].SupplierFinancialTransactions[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.
Status	string	Estado do serviço; considere confirmado somente quando o valor for Confirmed. O valor string do exemplo não indica sucesso.

Outros campos (3)

Campo	Tipo	Descrição
Date	string
Type	string
Information	string

Rooms[].SupplierComission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Discount

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].OriginalSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Rooms[].Extras[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].Extras[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado.

Exemplo de response

{
  "TotalTime": 0,
  "Token": "string",
  "TimeSpan": "string",
  "Error": {
    "Server": "string",
    "Message": "string",
    "Stacktrace": "string",
    "TotalTime": 0,
    "Code": 0,
    "Token": "string",
    "TimeSpan": "string",
    "SupportInfo": "string"
  },
  "Messages": [
    {
      "value": "string",
      "content": "string"
    }
  ],
  "SInfo": "string",
  "Rooms": [
    {
      "ServiceId": "string",
      "ReservationId": "string",
      "Status": "string",
      "Observations": "string",
      "Paxs": [
        {
          "Name": "string",
          "Surname": "string",
          "Age": 0,
          "Cpf": "string",
          "DocumentNumber": "string",
          "DocumentExpirationDate": "string",
          "DocumentCountryId": "string",
          "DocumentType": "string",
          "Title": "string",
          "EnumTitle": "string",
          "MainPax": true,
          "isChild": true,
          "Address": "string",
          "City": "string",
          "ZipCode": "string",
          "State": "string",
          "AddressNumber": 0,
          "AddressComplement": "string",
          "Email": "string",
          "PhoneDDD": "string",
          "PhoneDDI": "string",
          "PhoneNumber": "string",
          "BirthDate": "string",
          "CountryCodeISO": "string",
          "Type": "string",
          "EmergencyContactFirstName": "string",
          "EmergencyContactLastName": "string",
          "EmergencyContactDDI": "string",
          "EmergencyContactDDD": "string",
          "EmergencyContactTelephone": "string",
          "EmergencyContactParentage": "string",
          "Ticket": "string",
          "LoyaltyNumber": "string",
          "AcceptMarketingEmail": true
        }
      ],
      "SellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "Comission": {
        "Currency": "string",
        "Value": 0
      },
      "HotelName": "string",
      "DestinationName": "string",
      "CheckIn": "string",
      "CheckOut": "string",
      "HotelAddress": "string",
      "BoardDescription": "string",
      "RoomDescription": "string",
      "CustomFields": [
        {
          "Name": "string",
          "Value": "string"
        }
      ],
      "PaymentStatus": "string",
      "CancellationPolicies": [
        {
          "StartDate": "string",
          "EndDate": "string",
          "Value": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "SupplierReservationCode": "string",
      "Phone": "string",
      "HotelConfirmationNumber": "string",
      "DestinationId": "string",
      "HotelId": "string",
      "SupplierHotelId": "string",
      "HCN": "string",
      "CancellationDate": "string",
      "HotelCategory": "string",
      "ReservationDate": "string",
      "LogXMLAudit": "string",
      "NumberOfAdults": 0,
      "NumberOfChildren": 0,
      "NumberOfNights": 0,
      "CountryId": "string",
      "AutomaticCancellation": true,
      "Markup": 0,
      "MarkupCalculation": "string",
      "CommissionCalculation": "string",
      "IsOffline": true,
      "MarkupType": "string",
      "CommissionRetained": true,
      "CancellationBlockedWS": true,
      "PaymentDeadLine": "string",
      "VoucherObservation": "string",
      "PaymentDate": "string",
      "InvoiceId": 0,
      "PaymentConvertionRate": 0.1,
      "PaymentCurrency": "string",
      "NetTax": {
        "Currency": "string",
        "Value": 0
      },
      "TotalTax": {
        "Currency": "string",
        "Value": 0
      },
      "SellingPriceWithoutTax": {
        "Currency": "string",
        "Value": 0
      },
      "CanSeeVoucher": true,
      "AgencyCommissionPercent": 0,
      "OperatorBookingDescription": "string",
      "CheckInHour": "string",
      "CheckOutHour": "string",
      "InvoiceItens": [
        "string"
      ],
      "SupplierInformation": "string",
      "AddAdditionalInfo": [
        {
          "Content": "string",
          "Name": "string"
        }
      ],
      "Payments": [
        {
          "Date": "string",
          "Status": 0,
          "PaymentType": 0,
          "PaymentOriginal": {
            "Currency": "string",
            "Value": 0
          },
          "PaymentConverted": {
            "Currency": "string",
            "Value": 0
          },
          "PaymentPortion": {
            "Currency": "string",
            "Value": 0
          },
          "CreditCard": {
            "Name": "string",
            "CPF": "string",
            "Location": {
              "Address": "string",
              "Number": "string",
              "Complement": "string",
              "District": "string",
              "ZipCode": "string",
              "City": "string",
              "State": "string"
            },
            "Phone": {
              "DDI": "string",
              "DDD": "string",
              "Number": "string"
            },
            "CardNumber": "string",
            "PaymentNumber": 0,
            "CardType": {
              "Name": "string",
              "AutorizationCode": "string",
              "TransactionId": "string",
              "Price": {
                "Currency": "string",
                "Value": 0
              },
              "TransactionDate": "string",
              "ReturnCode": "string",
              "NSU": "string",
              "Gateway": "string"
            },
            "ExpirationMonth": 0,
            "ExpirationYear": 0,
            "InstallmentsNumber": 0
          },
          "Check": {
            "Number": "string",
            "Bank": "string",
            "Value": {
              "Currency": "string",
              "Value": 0
            }
          },
          "Billet": {
            "Name": "string",
            "CPF": "string",
            "CNPJ": "string",
            "Location": {
              "Address": "string",
              "Number": "string",
              "Complement": "string",
              "District": "string",
              "ZipCode": "string",
              "City": "string",
              "State": "string"
            },
            "Phone": {
              "DDI": "string",
              "DDD": "string",
              "Number": "string"
            }
          },
          "CreditAccount": {
            "Bank": "string",
            "BankCode": "string",
            "AgencyCode": "string",
            "AccountNumber": "string",
            "CardName": "string",
            "CNPJ": "string"
          },
          "Currency": {
            "CurrencyFrom": "string",
            "CurrencyTo": "string",
            "ConvertionValue": 0
          },
          "MessageClientAuth": "string",
          "MessageOperAuth": "string",
          "URLReceiptOfPayment": "string",
          "TransactionId": "string",
          "InvoicePaymentId": "string",
          "PaymentSupplierId": 0,
          "PaymentSupplierName": "string",
          "Observation": "string"
        }
      ],
      "Taxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "DiscountCoupon": {
        "DiscountCouponValue": {
          "Currency": "string",
          "Value": 0
        },
        "DiscountCouponDescription": "string",
        "DiscountCoupon": "string"
      },
      "CityId": 0,
      "CountryCode": "string",
      "CountryName": "string",
      "CityName": "string",
      "ManualReservationPaymentType": "string",
      "PropertyTaxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "CancellationType": "string",
      "VoucherUrl": "string",
      "CreationUserDetail": {
        "id": 0,
        "Username": "string",
        "Name": "string",
        "Type": "string",
        "AgencyId": 0,
        "AgencyName": "string",
        "BranchOfficeId": 0,
        "BranchOfficeName": "string",
        "Email": "string"
      },
      "BookingWillBeInvoiced": true,
      "AutomaticCancellationEnabled": true,
      "HotelCNPJ": "string",
      "BreakdownSales": [
        {
          "Price": 0,
          "Currency": "string",
          "DateBreakdown": "/Date(1767225600000-0300)/",
          "DateBreakdownStr": "string",
          "PriceToFront": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "BookingDescription": "string",
      "BreakfastIncluded": true,
      "Billed": true,
      "AgencyCommission": 0.1,
      "CheckInDate": "/Date(1767225600000-0300)/",
      "ExtraInformation": "string",
      "AgencyCurrencyCommission": "string",
      "NetPrice": {
        "Currency": "string",
        "Value": 0
      },
      "OperatorCancellationPolicies": [
        {
          "StartDate": "string",
          "EndDate": "string",
          "Value": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "SystemStatus": 0,
      "PaymentsConditions": {
        "PaymentType": 0,
        "NameCondition": "string",
        "Status": true,
        "FinancialRate": "string",
        "IdCondition": 0
      },
      "ProviderID": 0,
      "ProviderName": "string",
      "LastUpdateUserDetail": {
        "id": 0,
        "Username": "string",
        "Name": "string",
        "Type": "string",
        "AgencyId": 0,
        "AgencyName": "string",
        "BranchOfficeId": 0,
        "BranchOfficeName": "string",
        "Email": "string"
      },
      "OriginalAgencyCommission": 0.1,
      "BilletURL": "string",
      "DepositDeadlines": [
        {
          "Deadline": "/Date(1767225600000-0300)/",
          "Value": {
            "Currency": "string",
            "Value": 0
          },
          "Type": 0
        }
      ],
      "UniqueIdentifier": "string",
      "FinancialTransactions": [
        {
          "Date": "/Date(1767225600000-0300)/",
          "Type": "string",
          "Currency": "string",
          "Value": 0.1,
          "Status": "string",
          "Information": "string"
        }
      ],
      "SupplierFinancialTransactions": [
        {
          "Date": "/Date(1767225600000-0300)/",
          "Type": "string",
          "Currency": "string",
          "Value": 0.1,
          "Status": "string",
          "Information": "string"
        }
      ],
      "BloquearRebooking": true,
      "PaymentType": "string",
      "UrlRedirectAfterCancelWhenHasRefund": "string",
      "SupplierComission": {
        "Currency": "string",
        "Value": 0
      },
      "SupplierCommissionPercent": 0,
      "PayAtHotel": true,
      "SupplierVCNPayment": true,
      "SupplierCardNumber": "string",
      "BeforeBooking": "string",
      "Discount": {
        "Currency": "string",
        "Value": 0
      },
      "OriginalSellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "MotivoViagem": "string",
      "CentroCusto": "string",
      "CheckinInstructions": "string",
      "CheckinUrl": "string",
      "Projeto": "string",
      "CardProcessingDate": "string",
      "Extras": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "AssyncBooking": true,
      "PropertyType": "string",
      "CangoorooInvoiceType": "string",
      "ManualReservation": true
    }
  ],
  "RequestId": 0
}

HotelPOST

CancelAllHotelServices — Hotel

O que faz: Cancela todos os serviços de hotel confirmados ou sob consulta (on request) de uma reserva (BookingId).

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

Atenção

Só considere cancelada após confirmação explícita na resposta — se não vier, repita a chamada.

Regras e detalhes da operação

Demais produtos da reserva permanecem inalterados.

Respostas HTTP

HTTP	Descrição
200	OK — CancelResponse.
400	Requisição inválida: JSON malformado ou com campos inválidos.
500	Erro não tratado (fault WCF).

URL

https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/CancelAllHotelServices

Parâmetros

Campo	Tipo	Obrigatório	Descrição
Credential	object	Sim	Credenciais da chamada. Os campos adicionais constam.
BookingId	number	Sim	Identificador da reserva cujos serviços de hotel serão cancelados.
CancellationReasonId	number	Não	Identificador do motivo de cancelamento. não é exigido no formulário de exemplo.
RefundPayment	boolean	Não	Indicador de reembolso do pagamento. não é exigido no formulário de exemplo.

Credential

Campo	Tipo	Obrigatório	Descrição
Username	string	Sim	Usuário da integração.
Password	string	Sim	Senha correspondente ao usuário.

Try it outReferência

Credentialobject*

Credenciais da chamada. Os campos adicionais constam.

BookingIdnumber*

Identificador da reserva cujos serviços de hotel serão cancelados.

CancellationReasonIdnumber

Identificador do motivo de cancelamento. não é exigido no formulário de exemplo.

RefundPaymentboolean

Indicador de reembolso do pagamento. não é exigido no formulário de exemplo.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/CancelAllHotelServices" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "string",
    "Password": "string"
  },
  "BookingId": 0,
  "CancellationReasonId": 0,
  "RefundPayment": true
}'

Campos da resposta

Campo	Tipo	Descrição
TotalTime	number	Tempo total informado pela API.
Token	string	Token retornado pela operação.
TimeSpan	string	Duração informada pela API.
Error	object	Detalhes de erro retornados pela API.
Messages	array<object>	Mensagens retornadas pela operação.
SInfo	string	Informação complementar da resposta.
Rooms	array<object>	Serviços de hotel retornados após a operação.

Error

Campo	Tipo	Descrição
TotalTime	number	Tempo total informado pela API.
Token	string	Token retornado pela operação.
TimeSpan	string	Duração informada pela API.

Outros campos (5)

Campo	Tipo	Descrição
Server	string
Message	string
Stacktrace	string
Code	number
SupportInfo	string

Messages[]

Outros campos (2)

Campo	Tipo	Descrição
value	string
content	string

Rooms[]

Campo	Tipo	Descrição
ServiceId	string	Identificador do serviço de hotel.
ReservationId	string	Identificador da reserva no serviço retornado.
Status	string	Estado retornado pela API.
Paxs	array<object>	Passageiros vinculados ao serviço.
CancellationPolicies	array<object>	Políticas de cancelamento do serviço.
SupplierReservationCode	string	Localizador do fornecedor.
HotelConfirmationNumber	string	Número de confirmação do hotel.
HCN	string	Campo HCN retornado pela API.
Payments	array<object>	Dados dos pagamentos vinculados ao serviço.
OperatorCancellationPolicies	array<object>	Políticas de cancelamento da operadora.
DepositDeadlines	array<object>	Prazos de depósito retornados para o serviço.

Outros campos (104)

Campo	Tipo	Descrição
Observations	string
SellingPrice	object
Comission	object
HotelName	string
DestinationName	string
CheckIn	string
CheckOut	string
HotelAddress	string
BoardDescription	string
RoomDescription	string
CustomFields	array<object>
PaymentStatus	string
Phone	string
DestinationId	string
HotelId	string
SupplierHotelId	string
CancellationDate	string
HotelCategory	string
ReservationDate	string
LogXMLAudit	string
NumberOfAdults	number
NumberOfChildren	number
NumberOfNights	number
CountryId	string
AutomaticCancellation	boolean
Markup	number
MarkupCalculation	string
CommissionCalculation	string
IsOffline	boolean
MarkupType	string
CommissionRetained	boolean
CancellationBlockedWS	boolean
PaymentDeadLine	string
VoucherObservation	string
PaymentDate	string
InvoiceId	number
PaymentConvertionRate	number
PaymentCurrency	string
NetTax	object
TotalTax	object
SellingPriceWithoutTax	object
CanSeeVoucher	boolean
AgencyCommissionPercent	number
OperatorBookingDescription	string
CheckInHour	string
CheckOutHour	string
InvoiceItens	array<string>
SupplierInformation	string
AddAdditionalInfo	array<object>
Taxes	array<object>
DiscountCoupon	object
CityId	number
CountryCode	string
CountryName	string
CityName	string
ManualReservationPaymentType	string
PropertyTaxes	array<object>
CancellationType	string
VoucherUrl	string
CreationUserDetail	object
BookingWillBeInvoiced	boolean
AutomaticCancellationEnabled	boolean
HotelCNPJ	string
BreakdownSales	array<object>
BookingDescription	string
BreakfastIncluded	boolean
Billed	boolean
AgencyCommission	number
CheckInDate	string
ExtraInformation	string
AgencyCurrencyCommission	string
NetPrice	object
SystemStatus	number
PaymentsConditions	object
ProviderID	number
ProviderName	string
LastUpdateUserDetail	object
OriginalAgencyCommission	number
BilletURL	string
UniqueIdentifier	string
FinancialTransactions	array<object>
SupplierFinancialTransactions	array<object>
BloquearRebooking	boolean
PaymentType	string
UrlRedirectAfterCancelWhenHasRefund	string
SupplierComission	object
SupplierCommissionPercent	number
PayAtHotel	boolean
SupplierVCNPayment	boolean
SupplierCardNumber	string
BeforeBooking	string
Discount	object
OriginalSellingPrice	object
MotivoViagem	string
CentroCusto	string
CheckinInstructions	string
CheckinUrl	string
Projeto	string
CardProcessingDate	string
Extras	array<object>
AssyncBooking	boolean
PropertyType	string
CangoorooInvoiceType	string
ManualReservation	boolean

Rooms[].Paxs[]

Outros campos (34)

Campo	Tipo	Descrição
Name	string
Surname	string
Age	number
Cpf	string
DocumentNumber	string
DocumentExpirationDate	string
DocumentCountryId	string
DocumentType	string
Title	string
EnumTitle	string
MainPax	boolean
isChild	boolean
Address	string
City	string
ZipCode	string
State	string
AddressNumber	number
AddressComplement	string
Email	string
PhoneDDD	string
PhoneDDI	string
PhoneNumber	string
BirthDate	string
CountryCodeISO	string
Type	string
EmergencyContactFirstName	string
EmergencyContactLastName	string
EmergencyContactDDI	string
EmergencyContactDDD	string
EmergencyContactTelephone	string
EmergencyContactParentage	string
Ticket	string
LoyaltyNumber	string
AcceptMarketingEmail	boolean

Rooms[].SellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Comission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].CustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado pela API.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Rooms[].CancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado pela API.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

Rooms[].CancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].NetTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].TotalTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].SellingPriceWithoutTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].AddAdditionalInfo[]

Outros campos (2)

Campo	Tipo	Descrição
Content	string
Name	string

Rooms[].Payments[]

Campo	Tipo	Descrição
Status	number	Estado retornado pela API.
Currency	object	Moeda do valor informado.

Outros campos (17)

Campo	Tipo	Descrição
Date	string
PaymentType	number
PaymentOriginal	object
PaymentConverted	object
PaymentPortion	object
CreditCard	object
Check	object
Billet	object
CreditAccount	object
MessageClientAuth	string
MessageOperAuth	string
URLReceiptOfPayment	string
TransactionId	string
InvoicePaymentId	string
PaymentSupplierId	number
PaymentSupplierName	string
Observation	string

Rooms[].Payments[].PaymentOriginal

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].PaymentConverted

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].PaymentPortion

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].CreditCard

Outros campos (10)

Campo	Tipo	Descrição
Name	string
CPF	string
Location	object
Phone	object
CardNumber	string
PaymentNumber	number
CardType	object
ExpirationMonth	number
ExpirationYear	number
InstallmentsNumber	number

Rooms[].Payments[].CreditCard.Location

Outros campos (7)

Campo	Tipo	Descrição
Address	string
Number	string
Complement	string
District	string
ZipCode	string
City	string
State	string

Rooms[].Payments[].CreditCard.Phone

Outros campos (3)

Campo	Tipo	Descrição
DDI	string
DDD	string
Number	string

Rooms[].Payments[].CreditCard.CardType

Outros campos (8)

Campo	Tipo	Descrição
Name	string
AutorizationCode	string
TransactionId	string
Price	object
TransactionDate	string
ReturnCode	string
NSU	string
Gateway	string

Rooms[].Payments[].CreditCard.CardType.Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].Check

Campo	Tipo	Descrição
Value	object	Valor informado pela API.

Outros campos (2)

Campo	Tipo	Descrição
Number	string
Bank	string

Rooms[].Payments[].Check.Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].Billet

Outros campos (5)

Campo	Tipo	Descrição
Name	string
CPF	string
CNPJ	string
Location	object
Phone	object

Rooms[].Payments[].Billet.Location

Outros campos (7)

Campo	Tipo	Descrição
Address	string
Number	string
Complement	string
District	string
ZipCode	string
City	string
State	string

Rooms[].Payments[].Billet.Phone

Outros campos (3)

Campo	Tipo	Descrição
DDI	string
DDD	string
Number	string

Rooms[].Payments[].CreditAccount

Outros campos (6)

Campo	Tipo	Descrição
Bank	string
BankCode	string
AgencyCode	string
AccountNumber	string
CardName	string
CNPJ	string

Rooms[].Payments[].Currency

Outros campos (3)

Campo	Tipo	Descrição
CurrencyFrom	string
CurrencyTo	string
ConvertionValue	number

Rooms[].Taxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].Taxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].DiscountCoupon

Outros campos (3)

Campo	Tipo	Descrição
DiscountCouponValue	object
DiscountCouponDescription	string
DiscountCoupon	string

Rooms[].DiscountCoupon.DiscountCouponValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].PropertyTaxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].PropertyTaxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].CreationUserDetail

Outros campos (9)

Campo	Tipo	Descrição
id	number
Username	string
Name	string
Type	string
AgencyId	number
AgencyName	string
BranchOfficeId	number
BranchOfficeName	string
Email	string

Rooms[].BreakdownSales[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.

Outros campos (4)

Campo	Tipo	Descrição
Price	number
DateBreakdown	string
DateBreakdownStr	string
PriceToFront	object

Rooms[].BreakdownSales[].PriceToFront

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].NetPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].OperatorCancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado pela API.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

Rooms[].OperatorCancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].PaymentsConditions

Campo	Tipo	Descrição
Status	boolean	Estado retornado pela API.

Outros campos (4)

Campo	Tipo	Descrição
PaymentType	number
NameCondition	string
FinancialRate	string
IdCondition	number

Rooms[].LastUpdateUserDetail

Outros campos (9)

Campo	Tipo	Descrição
id	number
Username	string
Name	string
Type	string
AgencyId	number
AgencyName	string
BranchOfficeId	number
BranchOfficeName	string
Email	string

Rooms[].DepositDeadlines[]

Campo	Tipo	Descrição
Value	object	Valor informado pela API.

Outros campos (2)

Campo	Tipo	Descrição
Deadline	string
Type	number

Rooms[].DepositDeadlines[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].FinancialTransactions[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.
Status	string	Estado retornado pela API.

Outros campos (3)

Campo	Tipo	Descrição
Date	string
Type	string
Information	string

Rooms[].SupplierFinancialTransactions[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.
Status	string	Estado retornado pela API.

Outros campos (3)

Campo	Tipo	Descrição
Date	string
Type	string
Information	string

Rooms[].SupplierComission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Discount

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].OriginalSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Extras[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].Extras[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Exemplo de response

{
  "TotalTime": 0,
  "Token": "string",
  "TimeSpan": "string",
  "Error": {
    "Server": "string",
    "Message": "string",
    "Stacktrace": "string",
    "TotalTime": 0,
    "Code": 0,
    "Token": "string",
    "TimeSpan": "string",
    "SupportInfo": "string"
  },
  "Messages": [
    {
      "value": "string",
      "content": "string"
    }
  ],
  "SInfo": "string",
  "Rooms": [
    {
      "ServiceId": "string",
      "ReservationId": "string",
      "Status": "string",
      "Observations": "string",
      "Paxs": [
        {
          "Name": "string",
          "Surname": "string",
          "Age": 0,
          "Cpf": "string",
          "DocumentNumber": "string",
          "DocumentExpirationDate": "string",
          "DocumentCountryId": "string",
          "DocumentType": "string",
          "Title": "string",
          "EnumTitle": "string",
          "MainPax": true,
          "isChild": true,
          "Address": "string",
          "City": "string",
          "ZipCode": "string",
          "State": "string",
          "AddressNumber": 0,
          "AddressComplement": "string",
          "Email": "string",
          "PhoneDDD": "string",
          "PhoneDDI": "string",
          "PhoneNumber": "string",
          "BirthDate": "string",
          "CountryCodeISO": "string",
          "Type": "string",
          "EmergencyContactFirstName": "string",
          "EmergencyContactLastName": "string",
          "EmergencyContactDDI": "string",
          "EmergencyContactDDD": "string",
          "EmergencyContactTelephone": "string",
          "EmergencyContactParentage": "string",
          "Ticket": "string",
          "LoyaltyNumber": "string",
          "AcceptMarketingEmail": true
        }
      ],
      "SellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "Comission": {
        "Currency": "string",
        "Value": 0
      },
      "HotelName": "string",
      "DestinationName": "string",
      "CheckIn": "string",
      "CheckOut": "string",
      "HotelAddress": "string",
      "BoardDescription": "string",
      "RoomDescription": "string",
      "CustomFields": [
        {
          "Name": "string",
          "Value": "string"
        }
      ],
      "PaymentStatus": "string",
      "CancellationPolicies": [
        {
          "StartDate": "string",
          "EndDate": "string",
          "Value": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "SupplierReservationCode": "string",
      "Phone": "string",
      "HotelConfirmationNumber": "string",
      "DestinationId": "string",
      "HotelId": "string",
      "SupplierHotelId": "string",
      "HCN": "string",
      "CancellationDate": "string",
      "HotelCategory": "string",
      "ReservationDate": "string",
      "LogXMLAudit": "string",
      "NumberOfAdults": 0,
      "NumberOfChildren": 0,
      "NumberOfNights": 0,
      "CountryId": "string",
      "AutomaticCancellation": true,
      "Markup": 0,
      "MarkupCalculation": "string",
      "CommissionCalculation": "string",
      "IsOffline": true,
      "MarkupType": "string",
      "CommissionRetained": true,
      "CancellationBlockedWS": true,
      "PaymentDeadLine": "string",
      "VoucherObservation": "string",
      "PaymentDate": "string",
      "InvoiceId": 0,
      "PaymentConvertionRate": 0.1,
      "PaymentCurrency": "string",
      "NetTax": {
        "Currency": "string",
        "Value": 0
      },
      "TotalTax": {
        "Currency": "string",
        "Value": 0
      },
      "SellingPriceWithoutTax": {
        "Currency": "string",
        "Value": 0
      },
      "CanSeeVoucher": true,
      "AgencyCommissionPercent": 0,
      "OperatorBookingDescription": "string",
      "CheckInHour": "string",
      "CheckOutHour": "string",
      "InvoiceItens": [
        "string"
      ],
      "SupplierInformation": "string",
      "AddAdditionalInfo": [
        {
          "Content": "string",
          "Name": "string"
        }
      ],
      "Payments": [
        {
          "Date": "string",
          "Status": 0,
          "PaymentType": 0,
          "PaymentOriginal": {
            "Currency": "string",
            "Value": 0
          },
          "PaymentConverted": {
            "Currency": "string",
            "Value": 0
          },
          "PaymentPortion": {
            "Currency": "string",
            "Value": 0
          },
          "CreditCard": {
            "Name": "string",
            "CPF": "string",
            "Location": {
              "Address": "string",
              "Number": "string",
              "Complement": "string",
              "District": "string",
              "ZipCode": "string",
              "City": "string",
              "State": "string"
            },
            "Phone": {
              "DDI": "string",
              "DDD": "string",
              "Number": "string"
            },
            "CardNumber": "string",
            "PaymentNumber": 0,
            "CardType": {
              "Name": "string",
              "AutorizationCode": "string",
              "TransactionId": "string",
              "Price": {
                "Currency": "string",
                "Value": 0
              },
              "TransactionDate": "string",
              "ReturnCode": "string",
              "NSU": "string",
              "Gateway": "string"
            },
            "ExpirationMonth": 0,
            "ExpirationYear": 0,
            "InstallmentsNumber": 0
          },
          "Check": {
            "Number": "string",
            "Bank": "string",
            "Value": {
              "Currency": "string",
              "Value": 0
            }
          },
          "Billet": {
            "Name": "string",
            "CPF": "string",
            "CNPJ": "string",
            "Location": {
              "Address": "string",
              "Number": "string",
              "Complement": "string",
              "District": "string",
              "ZipCode": "string",
              "City": "string",
              "State": "string"
            },
            "Phone": {
              "DDI": "string",
              "DDD": "string",
              "Number": "string"
            }
          },
          "CreditAccount": {
            "Bank": "string",
            "BankCode": "string",
            "AgencyCode": "string",
            "AccountNumber": "string",
            "CardName": "string",
            "CNPJ": "string"
          },
          "Currency": {
            "CurrencyFrom": "string",
            "CurrencyTo": "string",
            "ConvertionValue": 0
          },
          "MessageClientAuth": "string",
          "MessageOperAuth": "string",
          "URLReceiptOfPayment": "string",
          "TransactionId": "string",
          "InvoicePaymentId": "string",
          "PaymentSupplierId": 0,
          "PaymentSupplierName": "string",
          "Observation": "string"
        }
      ],
      "Taxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "DiscountCoupon": {
        "DiscountCouponValue": {
          "Currency": "string",
          "Value": 0
        },
        "DiscountCouponDescription": "string",
        "DiscountCoupon": "string"
      },
      "CityId": 0,
      "CountryCode": "string",
      "CountryName": "string",
      "CityName": "string",
      "ManualReservationPaymentType": "string",
      "PropertyTaxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "CancellationType": "string",
      "VoucherUrl": "string",
      "CreationUserDetail": {
        "id": 0,
        "Username": "string",
        "Name": "string",
        "Type": "string",
        "AgencyId": 0,
        "AgencyName": "string",
        "BranchOfficeId": 0,
        "BranchOfficeName": "string",
        "Email": "string"
      },
      "BookingWillBeInvoiced": true,
      "AutomaticCancellationEnabled": true,
      "HotelCNPJ": "string",
      "BreakdownSales": [
        {
          "Price": 0,
          "Currency": "string",
          "DateBreakdown": "/Date(1767225600000-0300)/",
          "DateBreakdownStr": "string",
          "PriceToFront": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "BookingDescription": "string",
      "BreakfastIncluded": true,
      "Billed": true,
      "AgencyCommission": 0.1,
      "CheckInDate": "/Date(1767225600000-0300)/",
      "ExtraInformation": "string",
      "AgencyCurrencyCommission": "string",
      "NetPrice": {
        "Currency": "string",
        "Value": 0
      },
      "OperatorCancellationPolicies": [
        {
          "StartDate": "string",
          "EndDate": "string",
          "Value": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "SystemStatus": 0,
      "PaymentsConditions": {
        "PaymentType": 0,
        "NameCondition": "string",
        "Status": true,
        "FinancialRate": "string",
        "IdCondition": 0
      },
      "ProviderID": 0,
      "ProviderName": "string",
      "LastUpdateUserDetail": {
        "id": 0,
        "Username": "string",
        "Name": "string",
        "Type": "string",
        "AgencyId": 0,
        "AgencyName": "string",
        "BranchOfficeId": 0,
        "BranchOfficeName": "string",
        "Email": "string"
      },
      "OriginalAgencyCommission": 0.1,
      "BilletURL": "string",
      "DepositDeadlines": [
        {
          "Deadline": "/Date(1767225600000-0300)/",
          "Value": {
            "Currency": "string",
            "Value": 0
          },
          "Type": 0
        }
      ],
      "UniqueIdentifier": "string",
      "FinancialTransactions": [
        {
          "Date": "/Date(1767225600000-0300)/",
          "Type": "string",
          "Currency": "string",
          "Value": 0.1,
          "Status": "string",
          "Information": "string"
        }
      ],
      "SupplierFinancialTransactions": [
        {
          "Date": "/Date(1767225600000-0300)/",
          "Type": "string",
          "Currency": "string",
          "Value": 0.1,
          "Status": "string",
          "Information": "string"
        }
      ],
      "BloquearRebooking": true,
      "PaymentType": "string",
      "UrlRedirectAfterCancelWhenHasRefund": "string",
      "SupplierComission": {
        "Currency": "string",
        "Value": 0
      },
      "SupplierCommissionPercent": 0,
      "PayAtHotel": true,
      "SupplierVCNPayment": true,
      "SupplierCardNumber": "string",
      "BeforeBooking": "string",
      "Discount": {
        "Currency": "string",
        "Value": 0
      },
      "OriginalSellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "MotivoViagem": "string",
      "CentroCusto": "string",
      "CheckinInstructions": "string",
      "CheckinUrl": "string",
      "Projeto": "string",
      "CardProcessingDate": "string",
      "Extras": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "AssyncBooking": true,
      "PropertyType": "string",
      "CangoorooInvoiceType": "string",
      "ManualReservation": true
    }
  ]
}

HotelPOST

CancelByService — Hotel

O que faz: Cancela os serviços de hotel informados em ServiceIds.

Atenção

Serviços com política de cancelamento por reserva só podem ser cancelados junto com os demais serviços vinculados.

Regras e detalhes da operação

Confira Rooms[].Status para confirmar explicitamente o cancelamento de cada serviço e Error / Messages para informações da operação. O valor string do exemplo não confirma um cancelamento.

Respostas HTTP

HTTP	Descrição
200	OK — CancelResponse.
400	Requisição inválida: JSON malformado ou com campos inválidos.
500	Erro não tratado (fault WCF).

URL

https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/CancelByService

Parâmetros

Campo	Tipo	Obrigatório	Descrição
Credential	object	Sim	Credenciais da integração.
ServiceIds	array	Sim	Lista numérica dos identificadores dos serviços de hotel a cancelar.
SendEmail	boolean	Não	Indicador de envio de e-mail.
CancellationReasonId	number	Não	Identificador numérico do motivo de cancelamento.
RefundPayment	boolean	Não	Indicador de reembolso do pagamento.
IsProfitability	boolean	Não	Indicador booleano.

Credential

Campo	Tipo	Obrigatório	Descrição
Username	string	Sim	Usuário da integração.
Password	string	Sim	Senha do usuário.

Try it outReferência

Credentialobject*

Credenciais da integração.

ServiceIdsarray*

Lista numérica dos identificadores dos serviços de hotel a cancelar.

SendEmailboolean

Indicador de envio de e-mail.

CancellationReasonIdnumber

Identificador numérico do motivo de cancelamento.

RefundPaymentboolean

Indicador de reembolso do pagamento.

IsProfitabilityboolean

Indicador booleano.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Hotel.svc/CancelByService" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "string",
    "Password": "string"
  },
  "ServiceIds": [
    0
  ],
  "SendEmail": true,
  "CancellationReasonId": 0,
  "RefundPayment": true,
  "IsProfitability": true
}'

Campos da resposta

Campo	Tipo	Descrição
TotalTime	number	Tempo total informado pela API.
Token	string	Token retornado pela operação.
TimeSpan	string	Duração informada pela API.
Error	object	Detalhes de erro retornados pela API.
Messages	array<object>	Mensagens retornadas pela operação.
SInfo	string	Informação complementar da resposta.
Rooms	array<object>	Resultados dos serviços de hotel após a operação.

Error

Campo	Tipo	Descrição
TotalTime	number	Tempo total informado pela API.
Token	string	Token retornado pela operação.
TimeSpan	string	Duração informada pela API.

Outros campos (5)

Campo	Tipo	Descrição
Server	string
Message	string
Stacktrace	string
Code	number
SupportInfo	string

Messages[]

Outros campos (2)

Campo	Tipo	Descrição
value	string
content	string

Rooms[]

Campo	Tipo	Descrição
ServiceId	string	Identificador do serviço retornado como string nesta resposta; ServiceIds da requisição contém números.
ReservationId	string	Identificador da reserva associada ao serviço retornado.
Status	string	Estado do serviço. Considere cancelado somente após confirmação explícita em Rooms[].Status; string é um exemplo de tipo, não uma confirmação.
Paxs	array<object>	Passageiros vinculados ao serviço.
CancellationPolicies	array<object>	Políticas de cancelamento do serviço.
SupplierReservationCode	string	Localizador da reserva no fornecedor.
HotelConfirmationNumber	string	Número de confirmação do próprio hotel.
HCN	string	Campo HCN retornado pela API.
Payments	array<object>	Pagamentos vinculados ao serviço.
OperatorCancellationPolicies	array<object>	Políticas de cancelamento da operadora.
DepositDeadlines	array<object>	Prazos de depósito com Deadline, Value e Type.

Outros campos (104)

Campo	Tipo	Descrição
Observations	string
SellingPrice	object
Comission	object
HotelName	string
DestinationName	string
CheckIn	string
CheckOut	string
HotelAddress	string
BoardDescription	string
RoomDescription	string
CustomFields	array<object>
PaymentStatus	string
Phone	string
DestinationId	string
HotelId	string
SupplierHotelId	string
CancellationDate	string
HotelCategory	string
ReservationDate	string
LogXMLAudit	string
NumberOfAdults	number
NumberOfChildren	number
NumberOfNights	number
CountryId	string
AutomaticCancellation	boolean
Markup	number
MarkupCalculation	string
CommissionCalculation	string
IsOffline	boolean
MarkupType	string
CommissionRetained	boolean
CancellationBlockedWS	boolean
PaymentDeadLine	string
VoucherObservation	string
PaymentDate	string
InvoiceId	number
PaymentConvertionRate	number
PaymentCurrency	string
NetTax	object
TotalTax	object
SellingPriceWithoutTax	object
CanSeeVoucher	boolean
AgencyCommissionPercent	number
OperatorBookingDescription	string
CheckInHour	string
CheckOutHour	string
InvoiceItens	array<string>
SupplierInformation	string
AddAdditionalInfo	array<object>
Taxes	array<object>
DiscountCoupon	object
CityId	number
CountryCode	string
CountryName	string
CityName	string
ManualReservationPaymentType	string
PropertyTaxes	array<object>
CancellationType	string
VoucherUrl	string
CreationUserDetail	object
BookingWillBeInvoiced	boolean
AutomaticCancellationEnabled	boolean
HotelCNPJ	string
BreakdownSales	array<object>
BookingDescription	string
BreakfastIncluded	boolean
Billed	boolean
AgencyCommission	number
CheckInDate	string
ExtraInformation	string
AgencyCurrencyCommission	string
NetPrice	object
SystemStatus	number
PaymentsConditions	object
ProviderID	number
ProviderName	string
LastUpdateUserDetail	object
OriginalAgencyCommission	number
BilletURL	string
UniqueIdentifier	string
FinancialTransactions	array<object>
SupplierFinancialTransactions	array<object>
BloquearRebooking	boolean
PaymentType	string
UrlRedirectAfterCancelWhenHasRefund	string
SupplierComission	object
SupplierCommissionPercent	number
PayAtHotel	boolean
SupplierVCNPayment	boolean
SupplierCardNumber	string
BeforeBooking	string
Discount	object
OriginalSellingPrice	object
MotivoViagem	string
CentroCusto	string
CheckinInstructions	string
CheckinUrl	string
Projeto	string
CardProcessingDate	string
Extras	array<object>
AssyncBooking	boolean
PropertyType	string
CangoorooInvoiceType	string
ManualReservation	boolean

Rooms[].Paxs[]

Outros campos (34)

Campo	Tipo	Descrição
Name	string
Surname	string
Age	number
Cpf	string
DocumentNumber	string
DocumentExpirationDate	string
DocumentCountryId	string
DocumentType	string
Title	string
EnumTitle	string
MainPax	boolean
isChild	boolean
Address	string
City	string
ZipCode	string
State	string
AddressNumber	number
AddressComplement	string
Email	string
PhoneDDD	string
PhoneDDI	string
PhoneNumber	string
BirthDate	string
CountryCodeISO	string
Type	string
EmergencyContactFirstName	string
EmergencyContactLastName	string
EmergencyContactDDI	string
EmergencyContactDDD	string
EmergencyContactTelephone	string
EmergencyContactParentage	string
Ticket	string
LoyaltyNumber	string
AcceptMarketingEmail	boolean

Rooms[].SellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Comission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].CustomFields[]

Campo	Tipo	Descrição
Value	string	Valor informado pela API.

Outros campos (1)

Campo	Tipo	Descrição
Name	string

Rooms[].CancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado pela API.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

Rooms[].CancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].NetTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].TotalTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].SellingPriceWithoutTax

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].AddAdditionalInfo[]

Outros campos (2)

Campo	Tipo	Descrição
Content	string
Name	string

Rooms[].Payments[]

Campo	Tipo	Descrição
Status	number	Estado do serviço. Considere cancelado somente após confirmação explícita em Rooms[].Status; string é um exemplo de tipo, não uma confirmação.
Currency	object	Moeda do valor informado.

Outros campos (17)

Campo	Tipo	Descrição
Date	string
PaymentType	number
PaymentOriginal	object
PaymentConverted	object
PaymentPortion	object
CreditCard	object
Check	object
Billet	object
CreditAccount	object
MessageClientAuth	string
MessageOperAuth	string
URLReceiptOfPayment	string
TransactionId	string
InvoicePaymentId	string
PaymentSupplierId	number
PaymentSupplierName	string
Observation	string

Rooms[].Payments[].PaymentOriginal

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].PaymentConverted

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].PaymentPortion

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].CreditCard

Outros campos (10)

Campo	Tipo	Descrição
Name	string
CPF	string
Location	object
Phone	object
CardNumber	string
PaymentNumber	number
CardType	object
ExpirationMonth	number
ExpirationYear	number
InstallmentsNumber	number

Rooms[].Payments[].CreditCard.Location

Outros campos (7)

Campo	Tipo	Descrição
Address	string
Number	string
Complement	string
District	string
ZipCode	string
City	string
State	string

Rooms[].Payments[].CreditCard.Phone

Outros campos (3)

Campo	Tipo	Descrição
DDI	string
DDD	string
Number	string

Rooms[].Payments[].CreditCard.CardType

Outros campos (8)

Campo	Tipo	Descrição
Name	string
AutorizationCode	string
TransactionId	string
Price	object
TransactionDate	string
ReturnCode	string
NSU	string
Gateway	string

Rooms[].Payments[].CreditCard.CardType.Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].Check

Campo	Tipo	Descrição
Value	object	Valor informado pela API.

Outros campos (2)

Campo	Tipo	Descrição
Number	string
Bank	string

Rooms[].Payments[].Check.Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Payments[].Billet

Outros campos (5)

Campo	Tipo	Descrição
Name	string
CPF	string
CNPJ	string
Location	object
Phone	object

Rooms[].Payments[].Billet.Location

Outros campos (7)

Campo	Tipo	Descrição
Address	string
Number	string
Complement	string
District	string
ZipCode	string
City	string
State	string

Rooms[].Payments[].Billet.Phone

Outros campos (3)

Campo	Tipo	Descrição
DDI	string
DDD	string
Number	string

Rooms[].Payments[].CreditAccount

Outros campos (6)

Campo	Tipo	Descrição
Bank	string
BankCode	string
AgencyCode	string
AccountNumber	string
CardName	string
CNPJ	string

Rooms[].Payments[].Currency

Outros campos (3)

Campo	Tipo	Descrição
CurrencyFrom	string
CurrencyTo	string
ConvertionValue	number

Rooms[].Taxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].Taxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].DiscountCoupon

Outros campos (3)

Campo	Tipo	Descrição
DiscountCouponValue	object
DiscountCouponDescription	string
DiscountCoupon	string

Rooms[].DiscountCoupon.DiscountCouponValue

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].PropertyTaxes[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].PropertyTaxes[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].CreationUserDetail

Outros campos (9)

Campo	Tipo	Descrição
id	number
Username	string
Name	string
Type	string
AgencyId	number
AgencyName	string
BranchOfficeId	number
BranchOfficeName	string
Email	string

Rooms[].BreakdownSales[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.

Outros campos (4)

Campo	Tipo	Descrição
Price	number
DateBreakdown	string
DateBreakdownStr	string
PriceToFront	object

Rooms[].BreakdownSales[].PriceToFront

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].NetPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].OperatorCancellationPolicies[]

Campo	Tipo	Descrição
Value	object	Valor informado pela API.

Outros campos (2)

Campo	Tipo	Descrição
StartDate	string
EndDate	string

Rooms[].OperatorCancellationPolicies[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].PaymentsConditions

Campo	Tipo	Descrição
Status	boolean	Estado do serviço. Considere cancelado somente após confirmação explícita em Rooms[].Status; string é um exemplo de tipo, não uma confirmação.

Outros campos (4)

Campo	Tipo	Descrição
PaymentType	number
NameCondition	string
FinancialRate	string
IdCondition	number

Rooms[].LastUpdateUserDetail

Outros campos (9)

Campo	Tipo	Descrição
id	number
Username	string
Name	string
Type	string
AgencyId	number
AgencyName	string
BranchOfficeId	number
BranchOfficeName	string
Email	string

Rooms[].DepositDeadlines[]

Campo	Tipo	Descrição
Value	object	Valor informado pela API.

Outros campos (2)

Campo	Tipo	Descrição
Deadline	string
Type	number

Rooms[].DepositDeadlines[].Value

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].FinancialTransactions[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.
Status	string	Estado do serviço. Considere cancelado somente após confirmação explícita em Rooms[].Status; string é um exemplo de tipo, não uma confirmação.

Outros campos (3)

Campo	Tipo	Descrição
Date	string
Type	string
Information	string

Rooms[].SupplierFinancialTransactions[]

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.
Status	string	Estado do serviço. Considere cancelado somente após confirmação explícita em Rooms[].Status; string é um exemplo de tipo, não uma confirmação.

Outros campos (3)

Campo	Tipo	Descrição
Date	string
Type	string
Information	string

Rooms[].SupplierComission

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Discount

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].OriginalSellingPrice

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Rooms[].Extras[]

Outros campos (2)

Campo	Tipo	Descrição
Price	object
Description	string

Rooms[].Extras[].Price

Campo	Tipo	Descrição
Currency	string	Moeda do valor informado.
Value	number	Valor informado pela API.

Exemplo de response

{
  "TotalTime": 0,
  "Token": "string",
  "TimeSpan": "string",
  "Error": {
    "Server": "string",
    "Message": "string",
    "Stacktrace": "string",
    "TotalTime": 0,
    "Code": 0,
    "Token": "string",
    "TimeSpan": "string",
    "SupportInfo": "string"
  },
  "Messages": [
    {
      "value": "string",
      "content": "string"
    }
  ],
  "SInfo": "string",
  "Rooms": [
    {
      "ServiceId": "string",
      "ReservationId": "string",
      "Status": "string",
      "Observations": "string",
      "Paxs": [
        {
          "Name": "string",
          "Surname": "string",
          "Age": 0,
          "Cpf": "string",
          "DocumentNumber": "string",
          "DocumentExpirationDate": "string",
          "DocumentCountryId": "string",
          "DocumentType": "string",
          "Title": "string",
          "EnumTitle": "string",
          "MainPax": true,
          "isChild": true,
          "Address": "string",
          "City": "string",
          "ZipCode": "string",
          "State": "string",
          "AddressNumber": 0,
          "AddressComplement": "string",
          "Email": "string",
          "PhoneDDD": "string",
          "PhoneDDI": "string",
          "PhoneNumber": "string",
          "BirthDate": "string",
          "CountryCodeISO": "string",
          "Type": "string",
          "EmergencyContactFirstName": "string",
          "EmergencyContactLastName": "string",
          "EmergencyContactDDI": "string",
          "EmergencyContactDDD": "string",
          "EmergencyContactTelephone": "string",
          "EmergencyContactParentage": "string",
          "Ticket": "string",
          "LoyaltyNumber": "string",
          "AcceptMarketingEmail": true
        }
      ],
      "SellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "Comission": {
        "Currency": "string",
        "Value": 0
      },
      "HotelName": "string",
      "DestinationName": "string",
      "CheckIn": "string",
      "CheckOut": "string",
      "HotelAddress": "string",
      "BoardDescription": "string",
      "RoomDescription": "string",
      "CustomFields": [
        {
          "Name": "string",
          "Value": "string"
        }
      ],
      "PaymentStatus": "string",
      "CancellationPolicies": [
        {
          "StartDate": "string",
          "EndDate": "string",
          "Value": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "SupplierReservationCode": "string",
      "Phone": "string",
      "HotelConfirmationNumber": "string",
      "DestinationId": "string",
      "HotelId": "string",
      "SupplierHotelId": "string",
      "HCN": "string",
      "CancellationDate": "string",
      "HotelCategory": "string",
      "ReservationDate": "string",
      "LogXMLAudit": "string",
      "NumberOfAdults": 0,
      "NumberOfChildren": 0,
      "NumberOfNights": 0,
      "CountryId": "string",
      "AutomaticCancellation": true,
      "Markup": 0,
      "MarkupCalculation": "string",
      "CommissionCalculation": "string",
      "IsOffline": true,
      "MarkupType": "string",
      "CommissionRetained": true,
      "CancellationBlockedWS": true,
      "PaymentDeadLine": "string",
      "VoucherObservation": "string",
      "PaymentDate": "string",
      "InvoiceId": 0,
      "PaymentConvertionRate": 0.1,
      "PaymentCurrency": "string",
      "NetTax": {
        "Currency": "string",
        "Value": 0
      },
      "TotalTax": {
        "Currency": "string",
        "Value": 0
      },
      "SellingPriceWithoutTax": {
        "Currency": "string",
        "Value": 0
      },
      "CanSeeVoucher": true,
      "AgencyCommissionPercent": 0,
      "OperatorBookingDescription": "string",
      "CheckInHour": "string",
      "CheckOutHour": "string",
      "InvoiceItens": [
        "string"
      ],
      "SupplierInformation": "string",
      "AddAdditionalInfo": [
        {
          "Content": "string",
          "Name": "string"
        }
      ],
      "Payments": [
        {
          "Date": "string",
          "Status": 0,
          "PaymentType": 0,
          "PaymentOriginal": {
            "Currency": "string",
            "Value": 0
          },
          "PaymentConverted": {
            "Currency": "string",
            "Value": 0
          },
          "PaymentPortion": {
            "Currency": "string",
            "Value": 0
          },
          "CreditCard": {
            "Name": "string",
            "CPF": "string",
            "Location": {
              "Address": "string",
              "Number": "string",
              "Complement": "string",
              "District": "string",
              "ZipCode": "string",
              "City": "string",
              "State": "string"
            },
            "Phone": {
              "DDI": "string",
              "DDD": "string",
              "Number": "string"
            },
            "CardNumber": "string",
            "PaymentNumber": 0,
            "CardType": {
              "Name": "string",
              "AutorizationCode": "string",
              "TransactionId": "string",
              "Price": {
                "Currency": "string",
                "Value": 0
              },
              "TransactionDate": "string",
              "ReturnCode": "string",
              "NSU": "string",
              "Gateway": "string"
            },
            "ExpirationMonth": 0,
            "ExpirationYear": 0,
            "InstallmentsNumber": 0
          },
          "Check": {
            "Number": "string",
            "Bank": "string",
            "Value": {
              "Currency": "string",
              "Value": 0
            }
          },
          "Billet": {
            "Name": "string",
            "CPF": "string",
            "CNPJ": "string",
            "Location": {
              "Address": "string",
              "Number": "string",
              "Complement": "string",
              "District": "string",
              "ZipCode": "string",
              "City": "string",
              "State": "string"
            },
            "Phone": {
              "DDI": "string",
              "DDD": "string",
              "Number": "string"
            }
          },
          "CreditAccount": {
            "Bank": "string",
            "BankCode": "string",
            "AgencyCode": "string",
            "AccountNumber": "string",
            "CardName": "string",
            "CNPJ": "string"
          },
          "Currency": {
            "CurrencyFrom": "string",
            "CurrencyTo": "string",
            "ConvertionValue": 0
          },
          "MessageClientAuth": "string",
          "MessageOperAuth": "string",
          "URLReceiptOfPayment": "string",
          "TransactionId": "string",
          "InvoicePaymentId": "string",
          "PaymentSupplierId": 0,
          "PaymentSupplierName": "string",
          "Observation": "string"
        }
      ],
      "Taxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "DiscountCoupon": {
        "DiscountCouponValue": {
          "Currency": "string",
          "Value": 0
        },
        "DiscountCouponDescription": "string",
        "DiscountCoupon": "string"
      },
      "CityId": 0,
      "CountryCode": "string",
      "CountryName": "string",
      "CityName": "string",
      "ManualReservationPaymentType": "string",
      "PropertyTaxes": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "CancellationType": "string",
      "VoucherUrl": "string",
      "CreationUserDetail": {
        "id": 0,
        "Username": "string",
        "Name": "string",
        "Type": "string",
        "AgencyId": 0,
        "AgencyName": "string",
        "BranchOfficeId": 0,
        "BranchOfficeName": "string",
        "Email": "string"
      },
      "BookingWillBeInvoiced": true,
      "AutomaticCancellationEnabled": true,
      "HotelCNPJ": "string",
      "BreakdownSales": [
        {
          "Price": 0,
          "Currency": "string",
          "DateBreakdown": "/Date(1767225600000-0300)/",
          "DateBreakdownStr": "string",
          "PriceToFront": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "BookingDescription": "string",
      "BreakfastIncluded": true,
      "Billed": true,
      "AgencyCommission": 0.1,
      "CheckInDate": "/Date(1767225600000-0300)/",
      "ExtraInformation": "string",
      "AgencyCurrencyCommission": "string",
      "NetPrice": {
        "Currency": "string",
        "Value": 0
      },
      "OperatorCancellationPolicies": [
        {
          "StartDate": "string",
          "EndDate": "string",
          "Value": {
            "Currency": "string",
            "Value": 0
          }
        }
      ],
      "SystemStatus": 0,
      "PaymentsConditions": {
        "PaymentType": 0,
        "NameCondition": "string",
        "Status": true,
        "FinancialRate": "string",
        "IdCondition": 0
      },
      "ProviderID": 0,
      "ProviderName": "string",
      "LastUpdateUserDetail": {
        "id": 0,
        "Username": "string",
        "Name": "string",
        "Type": "string",
        "AgencyId": 0,
        "AgencyName": "string",
        "BranchOfficeId": 0,
        "BranchOfficeName": "string",
        "Email": "string"
      },
      "OriginalAgencyCommission": 0.1,
      "BilletURL": "string",
      "DepositDeadlines": [
        {
          "Deadline": "/Date(1767225600000-0300)/",
          "Value": {
            "Currency": "string",
            "Value": 0
          },
          "Type": 0
        }
      ],
      "UniqueIdentifier": "string",
      "FinancialTransactions": [
        {
          "Date": "/Date(1767225600000-0300)/",
          "Type": "string",
          "Currency": "string",
          "Value": 0.1,
          "Status": "string",
          "Information": "string"
        }
      ],
      "SupplierFinancialTransactions": [
        {
          "Date": "/Date(1767225600000-0300)/",
          "Type": "string",
          "Currency": "string",
          "Value": 0.1,
          "Status": "string",
          "Information": "string"
        }
      ],
      "BloquearRebooking": true,
      "PaymentType": "string",
      "UrlRedirectAfterCancelWhenHasRefund": "string",
      "SupplierComission": {
        "Currency": "string",
        "Value": 0
      },
      "SupplierCommissionPercent": 0,
      "PayAtHotel": true,
      "SupplierVCNPayment": true,
      "SupplierCardNumber": "string",
      "BeforeBooking": "string",
      "Discount": {
        "Currency": "string",
        "Value": 0
      },
      "OriginalSellingPrice": {
        "Currency": "string",
        "Value": 0
      },
      "MotivoViagem": "string",
      "CentroCusto": "string",
      "CheckinInstructions": "string",
      "CheckinUrl": "string",
      "Projeto": "string",
      "CardProcessingDate": "string",
      "Extras": [
        {
          "Price": {
            "Currency": "string",
            "Value": 0
          },
          "Description": "string"
        }
      ],
      "AssyncBooking": true,
      "PropertyType": "string",
      "CangoorooInvoiceType": "string",
      "ManualReservation": true
    }
  ]
}

RentACar

RentACarPOST

Search — Rentacar

O que faz: Busca disponibilidade de veículos para os critérios informados.

Request: Credential + Criteria (ver tabela de parâmetros abaixo).

Response: Token + lista de Cars, cada um com CarId.

Atenção

O Token é único por busca (vinculado à Credential + parâmetros) e expira em 30 minutos. Não reutilize um Token entre tentativas ou fluxos diferentes.

O condutor principal é informado apenas no DoBooking (bloco Driver).

URL

https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/search

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

Criteriaobjectrequired

Wrapper oficial da busca (documentação Cangooroo).

Campo	Tipo	Obrigatório	Descrição
Pickup	object	Sim	Retirada do veículo — ver estrutura abaixo.
Dropoff	object	Sim	Devolução do veículo (pode ser em cidade diferente) — mesmos campos de Pickup.

Pickup

Campo	Tipo	Obrigatório	Valores	Descrição
Date	string (YYYY-MM-DD)	Sim	—	Data da retirada.
Hour	int	Sim	0-23	Hora da retirada.
Minutes	int	Sim	0-59	Minutos da retirada.
LocationCode	string	Sim	—	Código do local de retirada.
LocationType	enum	Sim	Hotel \| Airport \| Store \| undefined	Tipo do local de retirada.

Dropoff(mesmos campos de Pickup)

Campo	Tipo	Obrigatório	Valores	Descrição
Date	string (YYYY-MM-DD)	Sim	—	Data da devolução.
Hour	int	Sim	0-23	Hora da devolução.
Minutes	int	Sim	0-59	Minutos da devolução.
LocationCode	string	Sim	—	Código do local de devolução.
LocationType	enum	Sim	Hotel \| Airport \| Store \| undefined	Tipo do local de devolução.

languagestring
Idioma do conteúdo (pt, en, es).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Criteriaobject*

Wrapper oficial da busca (documentação Cangooroo).

languagestring

Idioma do conteúdo (pt, en, es).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/search" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Criteria": {
    "Pickup": {
      "Date": "2026-12-20",
      "Hour": 10,
      "Minutes": 0,
      "LocationCode": "MCO",
      "LocationType": "Airport"
    },
    "Dropoff": {
      "Date": "2026-12-27",
      "Hour": 12,
      "Minutes": 0,
      "LocationCode": "MIA",
      "LocationType": "Airport"
    }
  },
  "language": "pt"
}'

Exemplo de response

{
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "TokenExpiresAt": "2026-11-14T18:50:00",
  "TotalCarResults": 32,
  "Cars": [
    {
      "CarId": 1,
      "Category": "Econômico",
      "VendorName": "Localiza",
      "TotalPrice": 890,
      "Currency": "BRL"
    }
  ]
}

RentACarPOST

GetBookingConditions — Rentacar

O que faz: Retorna as condições finais (preço firme e políticas de cancelamento) para o item selecionado.

Request: Credential + Token + identificador do item selecionado no Search.

Response: Preço firme e políticas de cancelamento.

Atenção

Chamada obrigatória antes do DoBooking.

URL

https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/getBookingConditions

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.
CarIdnumberrequired
CarId (int retornado pela Search)

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.

CarIdnumber*

CarId (int retornado pela Search)

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/getBookingConditions" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "CarId": 1
}'

Exemplo de response

{
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "Price": {
    "Total": 890,
    "Currency": "BRL",
    "Firm": true
  },
  "CancellationPolicy": [
    {
      "Deadline": "2026-12-15T23:59:59",
      "Penalty": 0
    }
  ]
}

RentACarPOST

DoBooking — Rentacar

O que faz: Confirma a reserva no fornecedor.

Request: Credential + Token + identificador do item + passageiros e Payment inline (ver tabela de parâmetros).

Response: BookingId, Status e o localizador do fornecedor (SupplierReservationCode / SupplierLocator).

Atenção

Em erro HTTP ou timeout, NÃO crie nova reserva: consulte CheckBookingStatus / GetBookingDetail antes de qualquer nova tentativa.

Atenção

Um Token só pode gerar UMA reserva. Reenviar o mesmo Token para criar outra retorna [ERR_0567].

Envie a mesma idempotencyKey em caso de retry.
Se SetWaitingPayment = true, a reserva fica "awaiting payment" até o payBooking.

URL

https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/doBooking

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.
idempotencyKeyuuidrequired
UUID v4 exclusivo desta tentativa. Reenvie o mesmo valor após timeout — NUNCA gere um novo.

Driverarrayrequired

Array de passageiros/motoristas. O primeiro com MainPax=true é o titular da reserva.

Driver[](cada item do array)

Campo	Tipo	Obrigatório	Valores	Descrição
Name	string	Sim	—	Primeiro nome do passageiro.
Surname	string	Sim	—	Sobrenome do passageiro.
Age	int	Sim	—	Idade do passageiro.
Cpf	string	Sim	—	CPF do passageiro (somente dígitos).
Title	enum	Sim	Mr \| Mrs \| Ms	Tratamento do passageiro.
MainPax	bool	Sim	—	Titular da reserva. Exatamente um passageiro com MainPax=true.
isChild	bool	Sim	—	Indica se o passageiro é criança.
Address	string	Sim	—	Logradouro do passageiro.
AddressNumber	string	Sim	—	Número do endereço.
City	string	Sim	—	Cidade.
State	string	Sim	—	Estado / UF.
ZipCode	string	Sim	—	CEP.
Email	string	Sim	—	E-mail de contato.
PhoneDDI	string	Sim	—	Código do país do telefone.
PhoneDDD	string	Sim	—	Código de área do telefone.
PhoneNumber	string	Sim	—	Número do telefone.

CarIdnumberrequired
Identificador do carro escolhido (retornado na Search e confirmado no GetBookingConditions).

Paymentobjectrequired

Bloco de pagamento do RentACar — estrutura própria e ACHATADA, SEM PaymentConditionId e SEM ContractingParty.

Campo	Tipo	Obrigatório	Descrição
CreditCard	object	Sim	Dados do cartão — ver estrutura abaixo.

Payment.CreditCard

Campo	Tipo	Obrigatório	Descrição
Holder	string	Sim	Nome do titular impresso no cartão.
CardNumber	string	Sim	Número do cartão (somente dígitos).
SecurityCode	string	Sim	Código de segurança (CVV).
YearExpiration	int	Sim	Ano de validade (4 dígitos).
MonthExpiration	int	Sim	Mês de validade (1-12).
Installments	int	Sim	Número de parcelas (schema achatado usa Installments).
CardOperator	string	Sim	Bandeira do cartão (ex.: VISA).

SetWaitingPaymentboolean
Se true, cria a reserva com status 'awaiting payment' até o vencimento do Token. Útil para fluxos com pagamento assíncrono (payBooking).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

idempotencyKeyuuid*

UUID v4 exclusivo desta tentativa. Reenvie o mesmo valor após timeout — NUNCA gere um novo.

Driverarray*

Array de passageiros/motoristas. O primeiro com MainPax=true é o titular da reserva.

CarIdnumber*

Identificador do carro escolhido (retornado na Search e confirmado no GetBookingConditions).

Paymentobject*

Bloco de pagamento do RentACar — estrutura própria e ACHATADA, SEM PaymentConditionId e SEM ContractingParty.

SetWaitingPaymentboolean

Se true, cria a reserva com status 'awaiting payment' até o vencimento do Token. Útil para fluxos com pagamento assíncrono (payBooking).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/doBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "idempotencyKey": "b3c1c9a2-8f2d-4a10-9c1f-1d2b6e0a4e77",
  "Driver": [
    {
      "Name": "Ana",
      "Surname": "Souza",
      "Age": 34,
      "Cpf": "12345678900",
      "Title": "Mrs",
      "MainPax": true,
      "isChild": false,
      "Address": "Av. Atlântica",
      "AddressNumber": "1702",
      "City": "Rio de Janeiro",
      "State": "RJ",
      "ZipCode": "22021-001",
      "Email": "[email protected]",
      "PhoneDDI": "55",
      "PhoneDDD": "21",
      "PhoneNumber": "999998888"
    },
    {
      "Name": "Bruno",
      "Surname": "Souza",
      "Age": 34,
      "Cpf": "98765432100",
      "Title": "Mrs",
      "MainPax": false,
      "isChild": false,
      "Address": "Av. Atlântica",
      "AddressNumber": "1702",
      "City": "Rio de Janeiro",
      "State": "RJ",
      "ZipCode": "22021-001",
      "Email": "[email protected]",
      "PhoneDDI": "55",
      "PhoneDDD": "21",
      "PhoneNumber": "999998888"
    }
  ],
  "CarId": 123456,
  "Payment": {
    "CreditCard": {
      "Holder": "ANA SOUZA",
      "CardNumber": "4111111111111111",
      "SecurityCode": "123",
      "YearExpiration": 2029,
      "MonthExpiration": 12,
      "Installments": 3,
      "CardOperator": "VISA"
    }
  },
  "SetWaitingPayment": false
}'

Campos da resposta

Campo	Tipo	Descrição
BookingId	string\|int	Localizador Cangooroo da reserva.
Status	string	Só considere confirmada quando vier literalmente "Confirmed".
SupplierReservationCode	string	Localizador oficial do fornecedor (nome confirmado pela documentação de suporte da Cangooroo).
SupplierLocator	string	Mesmo valor — mantido por compatibilidade com integrações existentes.

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Confirmed",
  "SupplierLocator": "SUP-4a7b",
  "SupplierReservationCode": "SUP-4a7b"
}

RentACarPOST

cancelAllRentACarServices — Rentacar

O que faz: Cancela TODOS os serviços de locação de veículo associados a uma reserva (BookingId).

Request: Credential + BookingId.

Response: BookingId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

Atenção

Só considere cancelada após confirmação explícita na resposta — se não vier, repita a chamada.

Demais produtos da reserva permanecem inalterados.

URL

https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/cancelAllRentACarServices

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdnumberrequired
BookingId da reserva (retornado no DoBooking).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdnumber*

BookingId da reserva (retornado no DoBooking).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/cancelAllRentACarServices" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": 1465
}'

Exemplo de response

{
  "BookingId": 1465,
  "Status": "Cancelled",
  "refundAmount": 0
}

RentACarPOST

cancelByService — Rentacar

O que faz: Cancela UM serviço de locação de veículo específico.

Request: Credential + ServiceId (retornado no DoBooking).

Response: ServiceId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

URL

https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/cancelByService

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdnumberrequired
BookingId da reserva (retornado no DoBooking).
ServiceIdstringrequired
Identificador do serviço a ser cancelado (retornado por GetBookingDetail).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdnumber*

BookingId da reserva (retornado no DoBooking).

ServiceIdstring*

Identificador do serviço a ser cancelado (retornado por GetBookingDetail).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/RentACar.svc/cancelByService" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": 1465,
  "ServiceId": "SVC-001"
}'

Exemplo de response

{
  "BookingId": 1465,
  "ServiceId": "SVC-001",
  "Status": "Cancelled",
  "refundAmount": 0
}

Transfer

TransferPOST

Search — Transfer

O que faz: SearchAvailability — busca disponibilidade de traslados para a data/hora e locais informados.

Request: Credential + Criteria (ver tabela de parâmetros abaixo).

Response: Token (30 min), TotalTransfersResults e a lista de Transfers com TransferId.

Atenção

O Token é único por busca (vinculado à Credential + parâmetros) e expira em 30 minutos. Não reutilize um Token entre tentativas ou fluxos diferentes.

Para IDA E VOLTA (transfer IN/OUT), inclua ServiceDateBack + HourBack + MinutesBack.
LocationType aceita Airport | Accommodation | Port | Station | ThemePark | Other.
Use TransferId no GetBookingConditions e no DoBooking.

URL

https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/searchAvailability

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

Criteriaobjectrequired

Especificação da busca. Para transfer IN/OUT (ida e volta), adicione também ServiceDateBack, HourBack e MinutesBack.

Campo	Tipo	Obrigatório	Valores	Descrição
ServiceDate	string (YYYY-MM-DD)	Sim	—	Data do serviço.
Hour	int	Sim	0-23	Hora do serviço.
Minutes	int	Sim	0-59	Minutos do serviço.
NumberOfAdults	int	Sim	—	Quantidade de adultos.
NumberOfChildren	int	Não	—	Quantidade de crianças.
Pickup	object	Sim	—	Local de retirada — ver estrutura abaixo.
Dropoff	object	Sim	—	Local de entrega — ver estrutura abaixo.
ServiceLanguage	string	Não	all \| código do idioma	Idioma do serviço.
ServiceDateBack	string (YYYY-MM-DD)	Não	—	Data do trecho de volta (transfer IN/OUT).
HourBack	int	Não	0-23	Hora do trecho de volta.
MinutesBack	int	Não	0-59	Minutos do trecho de volta.

Pickup

Campo	Tipo	Obrigatório	Valores	Descrição
LocationCode	string	Sim	—	Código do local de retirada.
LocationType	enum	Sim	Hotel \| Airport \| Store \| undefined	Tipo do local de retirada.

Dropoff

Campo	Tipo	Obrigatório	Valores	Descrição
LocationCode	string	Sim	—	Código do local de entrega.
LocationType	enum	Sim	Hotel \| Airport \| Store \| undefined	Tipo do local de entrega.

LocationTypestring
Enum aceito em Criteria.Pickup/Dropoff.LocationType: 'Airport' | 'Accommodation' | 'Port' | 'Station' | 'ThemePark' | 'Other'.
ServiceDateBackdate
Somente transfer IN/OUT (ida e volta). Data do retorno (YYYY-MM-DD). Deve vir junto com HourBack/MinutesBack.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Criteriaobject*

Especificação da busca. Para transfer IN/OUT (ida e volta), adicione também ServiceDateBack, HourBack e MinutesBack.

LocationTypestring

ServiceDateBackdate

Somente transfer IN/OUT (ida e volta). Data do retorno (YYYY-MM-DD). Deve vir junto com HourBack/MinutesBack.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/searchAvailability" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Criteria": {
    "ServiceDate": "2026-12-20",
    "Hour": 12,
    "Minutes": 0,
    "NumberOfAdults": 1,
    "Pickup": {
      "LocationCode": "26486",
      "LocationType": "Accommodation"
    },
    "Dropoff": {
      "LocationCode": "26602",
      "LocationType": "Accommodation"
    },
    "ServiceLanguage": "all"
  }
}'

Exemplo de response

{
  "Token": "d09c4456-02cb-4a43-87e5-1e696ab6965f",
  "TotalTransfersResults": 8,
  "Transfers": [
    {
      "TransferId": 45219,
      "VehicleType": "Sedan Privativo",
      "MaxPax": 3,
      "ServiceLanguage": "en",
      "TotalPrice": 220,
      "Currency": "BRL"
    }
  ]
}

TransferPOST

GetBookingConditions — Transfer

O que faz: Retorna condições finais (preço firme, políticas de cancelamento e dados do veículo) para o(s) TransferId(s) selecionado(s).

Request: Credential + Token + TransferId(s).

Response: Preço firme, políticas de cancelamento e dados do serviço.

Atenção

Chamada obrigatória antes do DoBooking.

Atenção

Fornecedores podem trabalhar com cache — compare preço e política com a Search e notifique o usuário em caso de mudança.

URL

https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/getBookingConditions

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.
TransferIdsarrayrequired
Array com o(s) TransferId(s) escolhido(s) na SearchAvailability.
ServiceDatedaterequired
Data do transfer (YYYY-MM-DD). Deve casar com o Criteria.ServiceDate da busca.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

TransferIdsarray*

Array com o(s) TransferId(s) escolhido(s) na SearchAvailability.

ServiceDatedate*

Data do transfer (YYYY-MM-DD). Deve casar com o Criteria.ServiceDate da busca.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/getBookingConditions" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "d09c4456-02cb-4a43-87e5-1e696ab6965f",
  "TransferIds": [
    45219
  ],
  "ServiceDate": "2026-12-20"
}'

Exemplo de response

{
  "Token": "d09c4456-02cb-4a43-87e5-1e696ab6965f",
  "Transfers": [
    {
      "TransferId": 45219,
      "VehicleType": "Sedan Privativo",
      "TotalPrice": 220,
      "Currency": "BRL",
      "CancellationPolicy": [
        {
          "Deadline": "2026-12-15T23:59:59",
          "Penalty": 0
        }
      ]
    }
  ]
}

TransferPOST

DoBooking — Transfer

O que faz: Confirma a reserva no fornecedor.

Request: Credential + Token + identificador do item + passageiros e Payment inline (ver tabela de parâmetros).

Response: BookingId, Status e o localizador do fornecedor (SupplierReservationCode / SupplierLocator).

Atenção

Em erro HTTP ou timeout, NÃO crie nova reserva: consulte CheckBookingStatus / GetBookingDetail antes de qualquer nova tentativa.

Atenção

Um Token só pode gerar UMA reserva. Reenviar o mesmo Token para criar outra retorna [ERR_0567].

Envie a mesma idempotencyKey em caso de retry.
Se SetWaitingPayment = true, a reserva fica "awaiting payment" até o payBooking.

URL

https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/doBooking

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.
idempotencyKeyuuidrequired
UUID v4 exclusivo desta tentativa. Reenvie o mesmo valor após timeout — NUNCA gere um novo.

Passengersarrayrequired

Array de Pax do serviço. Exatamente um titular (MainPax=true) por reserva.

Passengers[](cada item do array)

Campo	Tipo	Obrigatório	Valores	Descrição
Name	string	Sim	—	Primeiro nome do passageiro.
Surname	string	Sim	—	Sobrenome do passageiro.
Age	int	Sim	—	Idade do passageiro.
Cpf	string	Sim	—	CPF do passageiro.
Rg	string	Sim	—	RG do passageiro.
Title	enum	Sim	Mr \| Mrs \| Ms	Tratamento do passageiro.
MainPax	bool	Sim	—	Titular da reserva — exatamente um por reserva.
isChild	bool	Sim	—	Indica se o passageiro é criança.

TransferIdnumberrequired
TransferId escolhido (retornado na SearchAvailability e confirmado no GetBookingConditions).
BookingIdstring
Opcional. Preencha para anexar este transfer a uma reserva existente (multi-serviços).
SetWaitingPaymentboolean
Se true, a reserva é criada com status 'awaiting payment' até o Token expirar. Se paga no prazo, é enviada ao fornecedor para confirmação; caso contrário, é rejeitada.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

idempotencyKeyuuid*

UUID v4 exclusivo desta tentativa. Reenvie o mesmo valor após timeout — NUNCA gere um novo.

Passengersarray*

Array de Pax do serviço. Exatamente um titular (MainPax=true) por reserva.

TransferIdnumber*

TransferId escolhido (retornado na SearchAvailability e confirmado no GetBookingConditions).

BookingIdstring

Opcional. Preencha para anexar este transfer a uma reserva existente (multi-serviços).

SetWaitingPaymentboolean

Se true, a reserva é criada com status 'awaiting payment' até o Token expirar. Se paga no prazo, é enviada ao fornecedor para confirmação; caso contrário, é rejeitada.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/doBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "d09c4456-02cb-4a43-87e5-1e696ab6965f",
  "idempotencyKey": "b3c1c9a2-8f2d-4a10-9c1f-1d2b6e0a4e77",
  "Passengers": [
    {
      "Name": "Ana",
      "Surname": "Souza",
      "Age": 34,
      "Cpf": "12345678900",
      "Rg": "123456789",
      "Title": "Mrs",
      "MainPax": true,
      "isChild": false
    }
  ],
  "TransferId": 45219,
  "SetWaitingPayment": false
}'

Campos da resposta

Campo	Tipo	Descrição
BookingId	string\|int	Localizador Cangooroo da reserva.
Status	string	Só considere confirmada quando vier literalmente "Confirmed".
SupplierReservationCode	string	Localizador oficial do fornecedor (nome confirmado pela documentação de suporte da Cangooroo).
SupplierLocator	string	Mesmo valor — mantido por compatibilidade com integrações existentes.

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Confirmed",
  "SupplierLocator": "SUP-4a7b",
  "SupplierReservationCode": "SUP-4a7b"
}

TransferPOST

cancelAllTransferServices — Transfer

O que faz: Cancela TODOS os serviços de transfer associados a uma reserva (BookingId).

Request: Credential + BookingId.

Response: BookingId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

Atenção

Só considere cancelada após confirmação explícita na resposta — se não vier, repita a chamada.

Demais produtos da reserva permanecem inalterados.

URL

https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/cancelAllTransferServices

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdnumberrequired
BookingId (number) da reserva cujos serviços de transfer serão cancelados.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdnumber*

BookingId (number) da reserva cujos serviços de transfer serão cancelados.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/cancelAllTransferServices" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": 1465
}'

Exemplo de response

{
  "BookingId": 1465,
  "Status": "Cancelled",
  "CancelledServices": [
    {
      "ServiceId": 1466,
      "Status": "Cancelled"
    }
  ]
}

TransferPOST

cancelByService — Transfer

O que faz: Cancela UM serviço de transfer específico.

Request: Credential + ServiceId (retornado no DoBooking).

Response: ServiceId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

URL

https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/cancelByService

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ServiceIdnumberrequired
ServiceId do serviço (retornado no DoBooking Response).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ServiceIdnumber*

ServiceId do serviço (retornado no DoBooking Response).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Transfer.svc/cancelByService" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "ServiceId": 1466
}'

Exemplo de response

{
  "ServiceId": 1466,
  "Status": "Cancelled",
  "CancelationDate": "2026-12-10T10:15:00"
}

Tour & Tickets

Tour & TicketsPOST

Search — Tour

O que faz: Busca disponibilidade de passeios e ingressos para os critérios informados.

Request: Credential + Criteria (ver tabela de parâmetros abaixo).

Response: Token (30 min) + Tours com TourId e IdAvailability.

Atenção

O Token é único por busca (vinculado à Credential + parâmetros) e expira em 30 minutos. Não reutilize um Token entre tentativas ou fluxos diferentes.

Atenção

TourId e IdAvailability são ambos obrigatórios no GetBookingConditions e no DoBooking.

AdultAges é a lista de IDADES (uma por adulto), não a quantidade de adultos.

URL

https://ws-cliente.cangooroo.net/API/REST/Tour.svc/search

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

Criteriaobjectrequired

Wrapper oficial da busca de Tour (documentação Cangooroo).

Campo	Tipo	Obrigatório	Valores	Descrição
CityId	int	Sim	—	Cidade do passeio, obtida no Destination Hierarchy/Autocomplete.
AdultAges[]	array<int>	Sim	—	Lista com a IDADE de cada adulto (não a contagem).
ChildAges[]	array<int> \| null	Não	—	Idades das crianças; envie null quando não houver.
ServiceLanguage	string	Não	all \| código do idioma	Idioma do serviço.
InitialServiceDate	string (YYYY-MM-DD)	Sim	—	Data inicial do serviço.
NumberOfDays	int	Sim	—	Quantidade de dias a partir da data inicial.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Criteriaobject*

Wrapper oficial da busca de Tour (documentação Cangooroo).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Tour.svc/search" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Criteria": {
    "CityId": 1009709,
    "ChildAges": null,
    "AdultAges": [
      25
    ],
    "ServiceLanguage": "all",
    "InitialServiceDate": "2026-12-22",
    "NumberOfDays": 2
  }
}'

Exemplo de response

{
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "Tours": [
    {
      "TourId": 45219,
      "IdAvailability": 1,
      "Name": "Cristo Redentor + City Tour",
      "ServiceDate": "2026-12-22",
      "TotalPrice": 340,
      "Currency": "BRL"
    }
  ]
}

Tour & TicketsPOST

GetBookingConditions — Tour

O que faz: Retorna as condições finais (preço firme e políticas de cancelamento) para o item selecionado.

Request: Credential + Token + identificador do item selecionado no Search.

Response: Preço firme e políticas de cancelamento.

Atenção

Chamada obrigatória antes do DoBooking.

URL

https://ws-cliente.cangooroo.net/API/REST/Tour.svc/getBookingConditions

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.
TourIdnumberrequired
TourId (int retornado pela Search)
IdAvailabilitynumberrequired
Identificador da disponibilidade escolhida (retornado junto ao TourId na Search).
ServiceDatedaterequired
Data do passeio (YYYY-MM-DD). Deve estar dentro da janela pesquisada.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

TourIdnumber*

TourId (int retornado pela Search)

IdAvailabilitynumber*

Identificador da disponibilidade escolhida (retornado junto ao TourId na Search).

ServiceDatedate*

Data do passeio (YYYY-MM-DD). Deve estar dentro da janela pesquisada.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Tour.svc/getBookingConditions" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "TourId": 45219,
  "IdAvailability": 1,
  "ServiceDate": "2026-12-22"
}'

Exemplo de response

{
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "Price": {
    "Total": 890,
    "Currency": "BRL",
    "Firm": true
  },
  "CancellationPolicy": [
    {
      "Deadline": "2026-12-15T23:59:59",
      "Penalty": 0
    }
  ]
}

Tour & TicketsPOST

DoBooking — Tour

O que faz: Confirma a reserva no fornecedor.

Request: Credential + Token + identificador do item + passageiros e Payment inline (ver tabela de parâmetros).

Response: BookingId, Status e o localizador do fornecedor (SupplierReservationCode / SupplierLocator).

Atenção

Em erro HTTP ou timeout, NÃO crie nova reserva: consulte CheckBookingStatus / GetBookingDetail antes de qualquer nova tentativa.

Atenção

Um Token só pode gerar UMA reserva. Reenviar o mesmo Token para criar outra retorna [ERR_0567].

Envie a mesma idempotencyKey em caso de retry.
Se SetWaitingPayment = true, a reserva fica "awaiting payment" até o payBooking.

URL

https://ws-cliente.cangooroo.net/API/REST/Tour.svc/doBooking

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.

Passengersarrayrequired

Array de Pax do serviço. Exatamente um titular (MainPax=true) por reserva.

Passengers[](cada item do array)

Campo	Tipo	Obrigatório	Valores	Descrição
Name	string	Sim	—	Primeiro nome do passageiro.
Surname	string	Sim	—	Sobrenome do passageiro.
Age	int	Sim	—	Idade do passageiro.
Cpf	string	Sim	—	CPF do passageiro.
Rg	string	Sim	—	RG do passageiro.
Title	enum	Sim	Mr \| Mrs \| Ms	Tratamento do passageiro.
MainPax	bool	Sim	—	Titular da reserva — exatamente um por reserva.
isChild	bool	Sim	—	Indica se o passageiro é criança.

TourIdnumberrequired
TourId escolhido (retornado na Search e confirmado no GetBookingConditions).
IdAvailabilitynumberrequired
Disponibilidade escolhida para o TourId (retornada na Search).
SupplierQuestionsarray
Respostas às perguntas obrigatórias do fornecedor, quando existirem (retornadas no GetBookingConditions). Envie null quando não houver perguntas.

Paymentobjectrequired

Bloco de pagamento do Tour — estrutura ACHATADA (igual à do RentACar), SEM PaymentConditionId e SEM ContractingParty.

Campo	Tipo	Obrigatório	Descrição
CreditCard	object	Sim	Dados do cartão — ver estrutura abaixo.

Payment.CreditCard

Campo	Tipo	Obrigatório	Descrição
Holder	string	Sim	Nome do titular impresso no cartão.
CardNumber	string	Sim	Número do cartão (somente dígitos).
SecurityCode	string	Sim	Código de segurança (CVV).
YearExpiration	int	Sim	Ano de validade (4 dígitos).
MonthExpiration	int	Sim	Mês de validade (1-12).
Installments	int	Sim	Número de parcelas (schema achatado usa Installments).
CardOperator	string	Sim	Bandeira do cartão (ex.: VISA).

SetWaitingPaymentboolean
Se true, cria a reserva com status 'awaiting payment' até o vencimento do Token.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

Passengersarray*

Array de Pax do serviço. Exatamente um titular (MainPax=true) por reserva.

TourIdnumber*

TourId escolhido (retornado na Search e confirmado no GetBookingConditions).

IdAvailabilitynumber*

Disponibilidade escolhida para o TourId (retornada na Search).

SupplierQuestionsarray

Respostas às perguntas obrigatórias do fornecedor, quando existirem (retornadas no GetBookingConditions). Envie null quando não houver perguntas.

Paymentobject*

Bloco de pagamento do Tour — estrutura ACHATADA (igual à do RentACar), SEM PaymentConditionId e SEM ContractingParty.

SetWaitingPaymentboolean

Se true, cria a reserva com status 'awaiting payment' até o vencimento do Token.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Tour.svc/doBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "Passengers": [
    {
      "Name": "Ana",
      "Surname": "Souza",
      "Age": 34,
      "Cpf": "12345678900",
      "Rg": "123456789",
      "Title": "Mrs",
      "MainPax": true,
      "isChild": false
    }
  ],
  "TourId": 45246,
  "IdAvailability": 1,
  "SupplierQuestions": null,
  "Payment": {
    "CreditCard": {
      "Holder": "ANA SOUZA",
      "CardNumber": "4111111111111111",
      "SecurityCode": "123",
      "YearExpiration": 2029,
      "MonthExpiration": 12,
      "Installments": 3,
      "CardOperator": "VISA"
    }
  },
  "SetWaitingPayment": false
}'

Campos da resposta

Campo	Tipo	Descrição
BookingId	string\|int	Localizador Cangooroo da reserva.
Status	string	Só considere confirmada quando vier literalmente "Confirmed".
SupplierReservationCode	string	Localizador oficial do fornecedor (nome confirmado pela documentação de suporte da Cangooroo).
SupplierLocator	string	Mesmo valor — mantido por compatibilidade com integrações existentes.

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Confirmed",
  "SupplierLocator": "SUP-4a7b",
  "SupplierReservationCode": "SUP-4a7b"
}

Tour & TicketsPOST

cancelAllTourServices — Tour

O que faz: Cancela TODOS os serviços de passeio/ingresso associados a uma reserva (BookingId).

Request: Credential + BookingId.

Response: BookingId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

Atenção

Só considere cancelada após confirmação explícita na resposta — se não vier, repita a chamada.

Demais produtos da reserva permanecem inalterados.

URL

https://ws-cliente.cangooroo.net/API/REST/Tour.svc/cancelAllTourServices

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdnumberrequired
BookingId (number) da reserva cujos serviços de tour serão cancelados.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdnumber*

BookingId (number) da reserva cujos serviços de tour serão cancelados.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Tour.svc/cancelAllTourServices" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": 1465
}'

Exemplo de response

{
  "BookingId": 1465,
  "Status": "Cancelled",
  "CancelledServices": [
    {
      "ServiceId": 1466,
      "Status": "Cancelled"
    }
  ]
}

Tour & TicketsPOST

cancelByService — Tour

O que faz: Cancela UM serviço de passeio/ingresso específico.

Request: Credential + ServiceId (retornado no DoBooking).

Response: ServiceId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

URL

https://ws-cliente.cangooroo.net/API/REST/Tour.svc/cancelByService

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ServiceIdnumberrequired
ServiceId do serviço (retornado no DoBooking Response).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ServiceIdnumber*

ServiceId do serviço (retornado no DoBooking Response).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Tour.svc/cancelByService" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "ServiceId": 1466
}'

Exemplo de response

{
  "ServiceId": 1466,
  "Status": "Cancelled",
  "CancelationDate": "2026-12-10T10:15:00"
}

Flight

FlightPOST

Search — Flight

O que faz: Busca disponibilidade de voos.

Request: Credential + Criteria (ver tabela de parâmetros abaixo).

Response: Token + opções de voo com ResponseId.

Atenção

O Token é único por busca (vinculado à Credential + parâmetros) e expira em 30 minutos. Não reutilize um Token entre tentativas ou fluxos diferentes.

Atenção

Para SearchType RoundTrip e MultiStretches é OBRIGATÓRIO chamar SearchNextSegment em seguida para obter os demais trechos.

URL

https://ws-cliente.cangooroo.net/API/REST/Flight.svc/search

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

Criteriaobjectrequired

Wrapper oficial da busca de voos.

Campo	Tipo	Obrigatório	Valores	Descrição
DepartureDate	string (YYYY-MM-DD)	Sim	—	Data de ida.
ReturnDate	string (YYYY-MM-DD)	Não	—	Data de volta (obrigatória em RoundTrip).
IataOriginAirport	string (IATA)	Sim	—	Aeroporto de origem.
IataDestinationAirport	string (IATA)	Sim	—	Aeroporto de destino.
NumberOfAdults	int	Sim	—	Quantidade de adultos.
ChildrenAge[]	array<int>	Não	—	Idade de cada criança.
NationalityPax	string (ISO 3166-1 alpha-2)	Sim	—	Nacionalidade do passageiro.
SearchType	enum	Sim	RoundTrip \| OneWay \| MultiStretches	RoundTrip e MultiStretches exigem SearchNextSegment em seguida.
ClassFlight	enum	Sim	All \| Economic \| EconomicPremium \| Business \| FirstClass	Classe de voo desejada.
Luggage	enum	Sim	Both \| Included \| NotIncluded	Filtro de bagagem despachada.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Criteriaobject*

Wrapper oficial da busca de voos.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Flight.svc/search" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Criteria": {
    "DepartureDate": "2026-12-20",
    "ReturnDate": "2026-12-27",
    "IataOriginAirport": "GRU",
    "IataDestinationAirport": "MIA",
    "NumberOfAdults": 1,
    "ChildrenAge": [
      7
    ],
    "NationalityPax": "BR",
    "SearchType": "RoundTrip",
    "ClassFlight": "All",
    "Luggage": "Both"
  }
}'

Exemplo de response

{
  "ResponseId": "9f8e-1a2b",
  "Flights": [
    {
      "ResponseId": "9f8e-1a2b",
      "Carrier": "LA",
      "TotalPrice": 4200,
      "Currency": "BRL",
      "Luggage": "Included"
    }
  ]
}

FlightPOST

SearchNextSegment — Flight

O que faz: Retorna as opções do próximo trecho a partir do ResponseId escolhido no passo anterior.

Atenção

Obrigatório para SearchType RoundTrip e MultiStretches.

Repita até completar todos os trechos; guarde cada ResponseId para o GetBookingConditions.

URL

https://ws-cliente.cangooroo.net/API/REST/Flight.svc/SearchNextSegment

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ResponseIdstringrequired
ResponseId da opção escolhida no trecho anterior.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ResponseIdstring*

ResponseId da opção escolhida no trecho anterior.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Flight.svc/SearchNextSegment" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "ResponseId": "9f8e-1a2b"
}'

Exemplo de response

{
  "Flights": [
    {
      "ResponseId": "7c6d-3e4f",
      "Carrier": "LA",
      "TotalPrice": 0,
      "Currency": "BRL"
    }
  ]
}

FlightPOST

GetBookingConditions — Flight

O que faz: Retorna condições finais (preço firme, bagagem, regras tarifárias) para a combinação de trechos escolhida.

Request: Envie TODOS os ResponsesIds coletados na Search + SearchNextSegment.

URL

https://ws-cliente.cangooroo.net/API/REST/Flight.svc/getBookingConditions

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ResponsesIdsarrayrequired
Array com os ResponseId de cada trecho selecionado.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ResponsesIdsarray*

Array com os ResponseId de cada trecho selecionado.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Flight.svc/getBookingConditions" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "ResponsesIds": [
    "9f8e-1a2b",
    "7c6d-3e4f"
  ]
}'

Exemplo de response

{
  "TotalPrice": 4200,
  "Currency": "BRL",
  "Firm": true,
  "CancellationPolicy": [
    {
      "Deadline": "2026-12-10T23:59:59",
      "Penalty": 350
    }
  ]
}

FlightPOST

DoBooking — Flight

O que faz: Emite a reserva aérea para os trechos selecionados.

Request: Passengers usa o mesmo schema completo do Hotel; o bloco Payment é ACHATADO (Payment.CreditCard, sem PaymentConditionId e sem ContractingParty).

Atenção

Em erro ou timeout, não reemita: confirme o status real antes de nova tentativa.

URL

https://ws-cliente.cangooroo.net/API/REST/Flight.svc/doBooking

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ResponsesIdsarrayrequired
Array com os ResponseId de cada trecho confirmado no GetBookingConditions.

Passengersarrayrequired

Array de passageiros — mesmo schema completo do Hotel. Exatamente um passageiro com MainPax=true.

Passengers[](cada item do array)

Campo	Tipo	Obrigatório	Valores	Descrição
Name	string	Sim	—	Primeiro nome do passageiro.
Surname	string	Sim	—	Sobrenome do passageiro.
Age	int	Sim	—	Idade do passageiro.
Cpf	string	Sim	—	CPF do passageiro (somente dígitos).
Title	enum	Sim	Mr \| Mrs \| Ms	Tratamento do passageiro.
MainPax	bool	Sim	—	Titular da reserva. Exatamente um passageiro com MainPax=true.
isChild	bool	Sim	—	Indica se o passageiro é criança.
Address	string	Sim	—	Logradouro do passageiro.
AddressNumber	string	Sim	—	Número do endereço.
City	string	Sim	—	Cidade.
State	string	Sim	—	Estado / UF.
ZipCode	string	Sim	—	CEP.
Email	string	Sim	—	E-mail de contato.
PhoneDDI	string	Sim	—	Código do país do telefone.
PhoneDDD	string	Sim	—	Código de área do telefone.
PhoneNumber	string	Sim	—	Número do telefone.

Paymentobjectrequired

Bloco de pagamento ACHATADO (igual ao RentACar), sem PaymentConditionId e sem ContractingParty.

Campo	Tipo	Obrigatório	Descrição
CreditCard	object	Sim	Dados do cartão — ver estrutura abaixo.

Payment.CreditCard

Campo	Tipo	Obrigatório	Descrição
Holder	string	Sim	Nome do titular impresso no cartão.
CardNumber	string	Sim	Número do cartão (somente dígitos).
SecurityCode	string	Sim	Código de segurança (CVV).
YearExpiration	int	Sim	Ano de validade (4 dígitos).
MonthExpiration	int	Sim	Mês de validade (1-12).
Installments	int	Sim	Número de parcelas (schema achatado usa Installments).
CardOperator	string	Sim	Bandeira do cartão (ex.: VISA).

SetWaitingPaymentboolean
Se true, a reserva fica 'awaiting payment' até o pagamento ser confirmado.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ResponsesIdsarray*

Array com os ResponseId de cada trecho confirmado no GetBookingConditions.

Passengersarray*

Array de passageiros — mesmo schema completo do Hotel. Exatamente um passageiro com MainPax=true.

Paymentobject*

Bloco de pagamento ACHATADO (igual ao RentACar), sem PaymentConditionId e sem ContractingParty.

SetWaitingPaymentboolean

Se true, a reserva fica 'awaiting payment' até o pagamento ser confirmado.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Flight.svc/doBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "ResponsesIds": [
    "9f8e-1a2b",
    "7c6d-3e4f"
  ],
  "Passengers": [
    {
      "Name": "Ana",
      "Surname": "Souza",
      "Age": 34,
      "Cpf": "12345678900",
      "Title": "Mrs",
      "MainPax": true,
      "isChild": false,
      "Address": "Av. Atlântica",
      "AddressNumber": "1702",
      "City": "Rio de Janeiro",
      "State": "RJ",
      "ZipCode": "22021-001",
      "Email": "[email protected]",
      "PhoneDDI": "55",
      "PhoneDDD": "21",
      "PhoneNumber": "999998888"
    }
  ],
  "Payment": {
    "CreditCard": {
      "Holder": "ANA SOUZA",
      "CardNumber": "4111111111111111",
      "SecurityCode": "123",
      "YearExpiration": 2029,
      "MonthExpiration": 12,
      "Installments": 3,
      "CardOperator": "VISA"
    }
  },
  "SetWaitingPayment": false
}'

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Confirmed",
  "SupplierLocator": "ABC123"
}

FlightPOST

cancelAllFlightServices — Flight

O que faz: Cancela TODOS os serviços de voos associados a uma reserva (BookingId).

Request: Credential + BookingId.

Response: BookingId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

Atenção

Só considere cancelada após confirmação explícita na resposta — se não vier, repita a chamada.

Demais produtos da reserva permanecem inalterados.

URL

https://ws-cliente.cangooroo.net/API/REST/Flight.svc/cancelAllFlightServices

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdnumberrequired
BookingId (number) da reserva.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdnumber*

BookingId (number) da reserva.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Flight.svc/cancelAllFlightServices" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": 1465
}'

Exemplo de response

{
  "BookingId": 1465,
  "Status": "Cancelled"
}

FlightPOST

cancelByService — Flight

O que faz: Cancela UM serviço de voo específico.

Request: Credential + ServiceId (retornado no DoBooking).

Response: ServiceId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

URL

https://ws-cliente.cangooroo.net/API/REST/Flight.svc/cancelByService

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ServiceIdnumberrequired
ServiceId retornado no DoBooking.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ServiceIdnumber*

ServiceId retornado no DoBooking.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Flight.svc/cancelByService" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "ServiceId": 1466
}'

Exemplo de response

{
  "ServiceId": 1466,
  "Status": "Cancelled"
}

Insurance

InsurancePOST

Search — Insurance

O que faz: Busca planos de seguro viagem.

Request: Credential + Criteria { CityId, DateService, NumberOfDays, PassengersAge[] }.

Response: Token (30 min) + InsuranceIds.

Atenção

O Token é único por busca (vinculado à Credential + parâmetros) e expira em 30 minutos. Não reutilize um Token entre tentativas ou fluxos diferentes.

Nota

PassengersAge é a lista de IDADES (uma por passageiro).

URL

https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/search

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

Criteriaobjectrequired

Wrapper oficial da busca de seguro viagem.

Campo	Tipo	Obrigatório	Descrição
CityId	int	Sim	Cidade de destino, obtida no Destination Hierarchy/Autocomplete.
DateService	string (YYYY-MM-DD)	Sim	Início da vigência do seguro.
NumberOfDays	int	Sim	Duração da cobertura em dias.
PassengersAge[]	array<int>	Sim	Idade de cada passageiro.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Criteriaobject*

Wrapper oficial da busca de seguro viagem.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/search" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Criteria": {
    "CityId": 1009709,
    "DateService": "2026-12-20",
    "NumberOfDays": 3,
    "PassengersAge": [
      25,
      20
    ]
  }
}'

Exemplo de response

{
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "Insurances": [
    {
      "InsuranceId": "100",
      "Name": "Plano Europa 60k",
      "TotalPrice": 180,
      "Currency": "BRL"
    }
  ]
}

InsurancePOST

GetBookingConditions — Insurance

O que faz: Retorna condições finais (preço firme, coberturas e políticas) para os planos selecionados.

URL

https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/getBookingConditions

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.
InsuranceIdsarrayrequired
Array com os InsuranceId escolhidos na Search.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

InsuranceIdsarray*

Array com os InsuranceId escolhidos na Search.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/getBookingConditions" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "InsuranceIds": [
    "100"
  ]
}'

Exemplo de response

{
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "Insurances": [
    {
      "InsuranceId": "100",
      "TotalPrice": 180,
      "Currency": "BRL",
      "Firm": true
    }
  ]
}

InsurancePOST

DoBooking — Insurance

O que faz: Emite a apólice de seguro.

Request: InsuranceId é um valor ÚNICO (string). Passengers usa o schema completo do Hotel e o Payment é ACHATADO (Payment.CreditCard).

URL

https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/doBooking

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.
InsuranceIdstringrequired
Plano escolhido, confirmado no GetBookingConditions.

Passengersarrayrequired

Array de passageiros — mesmo schema completo do Hotel. Exatamente um passageiro com MainPax=true.

Passengers[](cada item do array)

Campo	Tipo	Obrigatório	Valores	Descrição
Name	string	Sim	—	Primeiro nome do passageiro.
Surname	string	Sim	—	Sobrenome do passageiro.
Age	int	Sim	—	Idade do passageiro.
Cpf	string	Sim	—	CPF do passageiro (somente dígitos).
Title	enum	Sim	Mr \| Mrs \| Ms	Tratamento do passageiro.
MainPax	bool	Sim	—	Titular da reserva. Exatamente um passageiro com MainPax=true.
isChild	bool	Sim	—	Indica se o passageiro é criança.
Address	string	Sim	—	Logradouro do passageiro.
AddressNumber	string	Sim	—	Número do endereço.
City	string	Sim	—	Cidade.
State	string	Sim	—	Estado / UF.
ZipCode	string	Sim	—	CEP.
Email	string	Sim	—	E-mail de contato.
PhoneDDI	string	Sim	—	Código do país do telefone.
PhoneDDD	string	Sim	—	Código de área do telefone.
PhoneNumber	string	Sim	—	Número do telefone.

Paymentobjectrequired

Bloco de pagamento ACHATADO (sem PaymentConditionId e sem ContractingParty).

Campo	Tipo	Obrigatório	Descrição
CreditCard	object	Sim	Dados do cartão — ver estrutura abaixo.

Payment.CreditCard

Campo	Tipo	Obrigatório	Descrição
Holder	string	Sim	Nome do titular impresso no cartão.
CardNumber	string	Sim	Número do cartão (somente dígitos).
SecurityCode	string	Sim	Código de segurança (CVV).
YearExpiration	int	Sim	Ano de validade (4 dígitos).
MonthExpiration	int	Sim	Mês de validade (1-12).
Installments	int	Sim	Número de parcelas (schema achatado usa Installments).
CardOperator	string	Sim	Bandeira do cartão (ex.: VISA).

SetWaitingPaymentboolean
Se true, cria a reserva com status 'awaiting payment'.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

InsuranceIdstring*

Plano escolhido, confirmado no GetBookingConditions.

Passengersarray*

Array de passageiros — mesmo schema completo do Hotel. Exatamente um passageiro com MainPax=true.

Paymentobject*

Bloco de pagamento ACHATADO (sem PaymentConditionId e sem ContractingParty).

SetWaitingPaymentboolean

Se true, cria a reserva com status 'awaiting payment'.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/doBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "eyJhbGciOiJIUzI1NiIs...",
  "InsuranceId": "100",
  "Passengers": [
    {
      "Name": "Ana",
      "Surname": "Souza",
      "Age": 34,
      "Cpf": "12345678900",
      "Title": "Mrs",
      "MainPax": true,
      "isChild": false,
      "Address": "Av. Atlântica",
      "AddressNumber": "1702",
      "City": "Rio de Janeiro",
      "State": "RJ",
      "ZipCode": "22021-001",
      "Email": "[email protected]",
      "PhoneDDI": "55",
      "PhoneDDD": "21",
      "PhoneNumber": "999998888"
    }
  ],
  "Payment": {
    "CreditCard": {
      "Holder": "ANA SOUZA",
      "CardNumber": "4111111111111111",
      "SecurityCode": "123",
      "YearExpiration": 2029,
      "MonthExpiration": 12,
      "Installments": 3,
      "CardOperator": "VISA"
    }
  },
  "SetWaitingPayment": false
}'

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Confirmed",
  "SupplierLocator": "POL-778"
}

InsurancePOST

CancelAllInsuranceServices — Insurance

O que faz: Cancela TODOS os serviços de seguros associados a uma reserva (BookingId).

Request: Credential + BookingId.

Response: BookingId + Status do cancelamento.

Atenção

Atenção ao 'C' maiúsculo no nome do método: CancelAllInsuranceServices.

Atenção

Só considere cancelada após confirmação explícita na resposta.

Demais produtos da reserva permanecem inalterados.

URL

https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/CancelAllInsuranceServices

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdnumberrequired
BookingId (number) da reserva.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdnumber*

BookingId (number) da reserva.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/CancelAllInsuranceServices" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": 1465
}'

Exemplo de response

{
  "BookingId": 1465,
  "Status": "Cancelled"
}

InsurancePOST

cancelByService — Insurance

O que faz: Cancela UM serviço de seguro específico.

Request: Credential + ServiceId (retornado no DoBooking).

Response: ServiceId + Status do cancelamento.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

URL

https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/cancelByService

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ServiceIdnumberrequired
ServiceId retornado no DoBooking.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ServiceIdnumber*

ServiceId retornado no DoBooking.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Insurance.svc/cancelByService" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "ServiceId": 1466
}'

Exemplo de response

{
  "ServiceId": 1466,
  "Status": "Cancelled"
}

Payment

POST

GetPaymentConditionsByBookingId

O que faz: Retorna as condições de pagamento disponíveis para uma reserva existente.

Response: Métodos aceitos, parcelas mínimas/máximas por bandeira e PaymentConditionId.

O PaymentConditionId é enviado no payBooking ou no bloco Payment inline do DoBooking.

URL

https://ws-cliente.cangooroo.net/API/REST/Payment.svc/GetPaymentConditionsByBookingId

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdstringrequired
Identificador da reserva.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdstring*

Identificador da reserva.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Payment.svc/GetPaymentConditionsByBookingId" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": "CGR-2026-0001"
}'

Exemplo de response

{
  "Conditions": [
    {
      "PaymentConditionId": 12,
      "Method": "CreditCard",
      "Brands": [
        {
          "Brand": "VISA",
          "MinInstallments": 1,
          "MaxInstallments": 10
        },
        {
          "Brand": "MASTER",
          "MinInstallments": 1,
          "MaxInstallments": 6
        }
      ]
    },
    {
      "PaymentConditionId": 20,
      "Method": "Pix",
      "MinInstallments": 1,
      "MaxInstallments": 1
    }
  ]
}

POST

getPaymentConditionByToken

O que faz: Retorna as condições de pagamento a partir do Token do GetBookingConditions — antes de criar a reserva.

Response: Condições e PaymentConditionId para o bloco Payment inline do DoBooking.

URL

https://ws-cliente.cangooroo.net/API/REST/Payment.svc/getPaymentConditionByToken

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
Tokenstringrequired
Token retornado pelo Search. Vinculado à Credential e válido por 30 minutos. Obrigatório em GetBookingConditions e DoBooking. Se o módulo Retoken estiver habilitado, um Token expirado enviado em getBookingConditions (Hotel) dispara automaticamente uma nova busca e devolve novo Token + RoomId — não há endpoint dedicado.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Tokenstring*

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Payment.svc/getPaymentConditionByToken" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Token": "eyJhbGciOiJIUzI1NiIs..."
}'

Exemplo de response

{
  "Conditions": [
    {
      "PaymentConditionId": 12,
      "Method": "CreditCard",
      "Brands": [
        {
          "Brand": "VISA",
          "MinInstallments": 1,
          "MaxInstallments": 10
        }
      ]
    }
  ]
}

POST

payBooking

O que faz: Paga uma reserva EXISTENTE (fluxo com SetWaitingPayment: true no DoBooking).

Request: Credential + CreditCard + ContractingParty + campos de comissionamento (RetainCommission, SmartCommissionValue).

URL

https://ws-cliente.cangooroo.net/API/REST/Payment.svc/payBooking

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdstringrequired
Identificador da reserva a pagar.
ServicesIdarray
Se omitido, paga todos os serviços; se informado, paga apenas os serviços listados.

ContractingPartyobjectrequired

Dados do titular da compra (todos os campos obrigatórios).

Campo	Tipo	Obrigatório	Descrição
PersonName	string	Sim	Nome completo do titular da compra.
CPF	string	Sim	CPF do titular.
Email	string	Sim	E-mail do titular.
Address	string	Sim	Logradouro.
AddressComplement	string	Sim	Complemento do endereço.
AddressNumber	string	Sim	Número do endereço.
CityName	string	Sim	Cidade.
CountryCode	string	Sim	País (ISO 3166-1 alpha-2).
DistrictName	string	Sim	Bairro.
PhoneNumber	string	Sim	Número do telefone.
PhoneNumberDDD	string	Sim	Código de área.
PhoneNumberDDI	string	Sim	Código do país.
ReceiveCreditCardReceipt	string (bool)	Sim	Se o titular recebe o comprovante do cartão.
StateCode	string	Sim	Estado / UF.
ZipCode	string	Sim	CEP.

CreditCardobjectrequired

Dados do cartão (schema Hotel / payBooking — parcelas em NumberPayments).

Campo	Tipo	Obrigatório	Descrição
Holder	string	Sim	Nome do titular impresso no cartão.
CardNumber	string	Sim	Número do cartão (somente dígitos).
SecurityCode	string	Sim	Código de segurança (CVV).
MonthExpiration	int	Sim	Mês de validade (1-12).
YearExpiration	int	Sim	Ano de validade (4 dígitos).
NumberPayments	int	Sim	Número de parcelas (Hotel/payBooking usam NumberPayments, não Installments).
CardOperator	string	Sim	Bandeira do cartão (ex.: VISA).

RetainCommissionboolean
Se true, a comissão da agência fica retida com o operador (a Cangooroo repassa depois).
SmartCommissionValuenumber
Valor de comissão inteligente (override) — consulte a Cangooroo sobre habilitação.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdstring*

Identificador da reserva a pagar.

ServicesIdarray

Se omitido, paga todos os serviços; se informado, paga apenas os serviços listados.

ContractingPartyobject*

Dados do titular da compra (todos os campos obrigatórios).

CreditCardobject*

Dados do cartão (schema Hotel / payBooking — parcelas em NumberPayments).

RetainCommissionboolean

Se true, a comissão da agência fica retida com o operador (a Cangooroo repassa depois).

SmartCommissionValuenumber

Valor de comissão inteligente (override) — consulte a Cangooroo sobre habilitação.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Payment.svc/payBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": "CGR-2026-0001",
  "ServicesId": [
    "SVC-001"
  ],
  "ContractingParty": {
    "PersonName": "Ana Souza",
    "CPF": "12345678900",
    "Email": "[email protected]",
    "Address": "Av. Atlântica",
    "AddressComplement": "Apto 501",
    "AddressNumber": "1702",
    "CityName": "Rio de Janeiro",
    "CountryCode": "BR",
    "DistrictName": "Copacabana",
    "PhoneNumber": "999998888",
    "PhoneNumberDDD": "21",
    "PhoneNumberDDI": "55",
    "ReceiveCreditCardReceipt": "true",
    "StateCode": "RJ",
    "ZipCode": "22021-001"
  },
  "CreditCard": {
    "Holder": "ANA SOUZA",
    "CardNumber": "4111111111111111",
    "SecurityCode": "123",
    "MonthExpiration": 12,
    "YearExpiration": 2029,
    "NumberPayments": 3,
    "CardOperator": "VISA"
  },
  "RetainCommission": false
}'

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "PaymentStatus": "Approved",
  "AuthorizationCode": "AUTH-9f8e"
}

POST

Payment — Charge (abstração da plataforma)

O que faz: Registra a cobrança na nossa plataforma e aciona o payBooking por baixo.

Nota

Endpoint de conveniência da nossa plataforma — não é 1:1 com o contrato Cangooroo.

Atenção

Envie sempre uma idempotencyKey; em caso de timeout, consulte GetPaymentStatus antes de reenviar.

URL

https://ws-cliente.cangooroo.net/API/REST/Payment.svc/charge

Parâmetros

idempotencyKeyuuidrequired
UUID v4 exclusivo desta tentativa. Reenvie o mesmo valor após timeout — NUNCA gere um novo.
BookingIdnumberrequired
BookingId da reserva (retornado no DoBooking).
amountnumberrequired
Valor total a cobrar.
currencystringrequired
ISO 4217 (BRL, USD, EUR).
methodstringrequired
Método: credit_card | pix | bank_slip.

Try it outReferência

idempotencyKeyuuid*

UUID v4 exclusivo desta tentativa. Reenvie o mesmo valor após timeout — NUNCA gere um novo.

BookingIdnumber*

BookingId da reserva (retornado no DoBooking).

amountnumber*

Valor total a cobrar.

currencystring*

ISO 4217 (BRL, USD, EUR).

methodstring*

Método: credit_card | pix | bank_slip.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/Payment.svc/charge" \
  -H "Content-Type: application/json" \
  -d '{
  "idempotencyKey": "b3c1c9a2-8f2d-4a10-9c1f-1d2b6e0a4e77",
  "BookingId": 1465,
  "amount": 5250,
  "currency": "BRL",
  "method": "credit_card"
}'

Exemplo de response

{
  "paymentId": "pay_9f8e",
  "status": "Approved",
  "capturedAt": "2026-11-14T18:22:03"
}

GET

Payment — GetPaymentStatus (abstração da plataforma)

O que faz: Consulta o status atual de um pagamento.

Use em polling (backoff 1s → 30s) após timeout do Charge.

URL

https://ws-cliente.cangooroo.net/API/REST/Payment.svc/status/{paymentId}

Parâmetros

paymentIdstringrequired
Identificador retornado pelo Charge.

Try it outReferência

paymentIdstring*

Identificador retornado pelo Charge.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X GET "https://ws-cliente.cangooroo.net/API/REST/Payment.svc/status/{paymentId}"

Exemplo de response

{
  "paymentId": "pay_9f8e",
  "status": "Approved",
  "amount": 5250,
  "currency": "BRL"
}

ClientBackOffice

POST

authenticate

O que faz: Login dedicado do BackOffice — alternativa a enviar Credential inline em toda chamada.

Response: Sessão utilizável nas demais chamadas do ClientBackOffice.

URL

https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/authenticate

Parâmetros

Usernamestringrequired
Usuário da agência.
Passwordstringrequired
Senha correspondente.

Try it outReferência

Usernamestring*

Usuário da agência.

Passwordstring*

Senha correspondente.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/authenticate" \
  -H "Content-Type: application/json" \
  -d '{
  "Username": "meu_usuario",
  "Password": "minha_senha"
}'

Exemplo de response

{
  "SessionToken": "sess-abc",
  "ExpiresAt": "2026-11-14T22:00:00"
}

GET

GetBookingDetail

O que faz: Fonte-de-verdade para o estado real de uma reserva.

Request: BookingId (retornado pelo DoBooking).

Atenção

Chame após timeout do DoBooking, antes de qualquer nova tentativa.

Requer nível de usuário

Retorna apenas reservas da mesma agência do usuário autenticado. Buscar reserva de outra agência gera [ERR_0247] CangoorooLib_V2.Reserva.Reserva.carregar - Erro ao carregar uma Reserva.

URL

https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/getBookingDetail/{BookingId}

Parâmetros

BookingIdstringrequired
Número da reserva.

Try it outReferência

BookingIdstring*

Número da reserva.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X GET "https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/getBookingDetail/{BookingId}"

Campos da resposta

Campo	Tipo	Descrição
Status	string	Estado real da reserva. Só considere confirmada quando for "Confirmed".
Services[].ServiceId	int	Identificador de cada serviço — usado nos cancelamentos por serviço.

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Confirmed",
  "Product": "hotel",
  "SupplierLocator": "SUP-4a7b",
  "CreatedAt": "2026-11-14T18:20:11",
  "Services": [
    {
      "ServiceId": "SVC-001",
      "ServiceType": "Hotel",
      "Status": "Confirmed"
    }
  ]
}

POST

GetBookingList

O que faz: Lista reservas com múltiplos filtros combinados.

Datas em horário local (sem timezone).
Performance: true acelera a consulta (não busca o nome da operadora e não ordena por ID de reserva).

URL

https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/GetBookingList

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

SearchBookingCriteriaobjectrequired

Wrapper obrigatório dos filtros (mesmo padrão do CangoorooBackOffice.GetBookingList). Não envie filtros soltos na raiz.

Campo	Tipo	Obrigatório	Valores	Descrição
BookingNumber[]	array<string>	Não	—	Lista de números de reserva.
BookingStatus[]	array<enum>	Não	Confirmed \| Pending \| Cancelled \| OnRequest \| Rejected \| WaitingPayment	Status das reservas a retornar.
ServiceTypes[]	array<enum>	Não	Hotel \| Insurance \| Tour \| Transfer \| RentACar \| Flight \| Circuit \| Package	Tipos de serviço a considerar.
PassengerName	string	Não	—	Nome (ou parte) do passageiro.
ExternalReference	string	Não	—	Referência externa registrada pelo parceiro.
InitialBookingDate	string (YYYY-MM-DD)	Não	—	Início do intervalo de data da reserva.
FinalBookingDate	string (YYYY-MM-DD)	Não	—	Fim do intervalo de data da reserva.
InitialServiceDate	string (YYYY-MM-DD)	Não	—	Início do intervalo de data do serviço.
FinalServiceDate	string (YYYY-MM-DD)	Não	—	Fim do intervalo de data do serviço.
InitialUpdateDate	string (YYYY-MM-DD)	Não	—	Início do intervalo de última atualização.
FinalUpdateDate	string (YYYY-MM-DD)	Não	—	Fim do intervalo de última atualização.
CancelationDateStart	string (YYYY-MM-DD)	Não	—	Início do intervalo de data de cancelamento.
CancelationDateEnd	string (YYYY-MM-DD)	Não	—	Fim do intervalo de data de cancelamento.
PaymentDeadlineStart	string (YYYY-MM-DD)	Não	—	Início do intervalo de vencimento de pagamento.
PaymentDeadlineEnd	string (YYYY-MM-DD)	Não	—	Fim do intervalo de vencimento de pagamento.
Performance	bool	Não	—	Quando true, a consulta é mais rápida: não busca o nome da operadora e não ordena os resultados por ID de reserva. Reduz o tempo de resposta em pelo menos metade.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

SearchBookingCriteriaobject*

Wrapper obrigatório dos filtros (mesmo padrão do CangoorooBackOffice.GetBookingList). Não envie filtros soltos na raiz.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/GetBookingList" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "SearchBookingCriteria": {
    "BookingStatus": [
      "Confirmed"
    ],
    "ServiceTypes": [
      "Hotel"
    ],
    "InitialBookingDate": "2026-11-01",
    "FinalBookingDate": "2026-11-30",
    "Performance": true
  }
}'

Exemplo de response

{
  "Total": 42,
  "Bookings": [
    {
      "BookingId": "CGR-2026-0001",
      "Status": "Confirmed",
      "ServiceType": "Hotel",
      "Total": 5250,
      "Currency": "BRL",
      "PassengerName": "Ana Souza"
    }
  ]
}

POST

cancelBooking

O que faz: Cancela TODOS os serviços de uma reserva, independentemente do produto.

Atenção

Só considere cancelada após confirmação explícita na resposta.

Complementa cancelAll*Services (por produto) e cancelByService (por serviço).

URL

https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/cancelBooking

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdstringrequired
Identificador da reserva a cancelar (BookingId retornado pelo DoBooking).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdstring*

Identificador da reserva a cancelar (BookingId retornado pelo DoBooking).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/cancelBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "BookingId": "CGR-2026-0001"
}'

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Cancelled"
}

POST

getLastFXRate

O que faz: Retorna a última taxa de câmbio praticada pela agência para um par de moedas.

Atenção

Os nomes de campo aqui são CurrencyCodeFrom/CurrencyCodeTo — diferentes do CangoorooBackOffice, que usa CurrencyFrom/CurrencyTo. Não reutilize o mesmo tipo entre os dois back-offices.

URL

https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/getLastFXRate

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
CurrencyCodeFromstringrequired
Moeda de origem (ISO 4217).
CurrencyCodeTostringrequired
Moeda de destino (ISO 4217).
ServiceTypenumberrequired
Tipo de serviço — ver valores aceitos abaixo.
ServiceType (enum numérico)(valores aceitos)
Campo Tipo Descrição
0 int Todos os serviços
1 int RentACar
2 int Circuit
3 int Cruise
4 int Hotel
5 int Insurance
6 int Tour
7 int Transfer
8 int TrainTicket
9 int TrainPass
10 int Flight
11 int Package

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

CurrencyCodeFromstring*

Moeda de origem (ISO 4217).

CurrencyCodeTostring*

Moeda de destino (ISO 4217).

ServiceTypenumber*

Tipo de serviço — ver valores aceitos abaixo.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/getLastFXRate" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "CurrencyCodeFrom": "USD",
  "CurrencyCodeTo": "BRL",
  "ServiceType": 0
}'

Exemplo de response

{
  "CurrencyCodeFrom": "USD",
  "CurrencyCodeTo": "BRL",
  "ServiceType": 0,
  "Rate": 5.42,
  "UpdatedAt": "2026-11-14T09:00:00"
}

POST

getIncidents

O que faz: Lista incidentes (tickets) associados a uma reserva ou período.

Incidents são o subsistema de comunicação agência ↔ Cangooroo ↔ fornecedor.

URL

https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/getIncidents

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

Incidentobjectrequired

Wrapper obrigatório dos filtros. Não envie filtros soltos na raiz do request.

Campo	Tipo	Obrigatório	Descrição
BookingId	string	Não	Filtra pelos incidentes de uma reserva.
CreationDateStart	string (YYYY-MM-DD)	Não	Início do intervalo de criação.
CreationDateEnd	string (YYYY-MM-DD)	Não	Fim do intervalo de criação.
IncidentId	string	Não	Identificador de um incidente específico.
Message	string	Não	Busca por conteúdo da mensagem.
SendEmail	bool	Não	Filtra incidentes que dispararam e-mail.
ServiceId	string	Não	Serviço relacionado ao incidente.
Status	string	Não	Status do incidente.
Title	string	Não	Assunto do incidente.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Incidentobject*

Wrapper obrigatório dos filtros. Não envie filtros soltos na raiz do request.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/getIncidents" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Incident": {
    "BookingId": "CGR-2026-0001",
    "CreationDateStart": "2026-11-01",
    "CreationDateEnd": "2026-11-30",
    "IncidentId": "",
    "Message": "",
    "SendEmail": "",
    "ServiceId": "",
    "Status": "Open",
    "Title": ""
  }
}'

Exemplo de response

{
  "Incidents": [
    {
      "IncidentId": 9001,
      "BookingId": "CGR-2026-0001",
      "Status": "Open",
      "Title": "Late check-in",
      "CreatedAt": "2026-11-14T18:22:03"
    }
  ]
}

POST

creatIncident

O que faz: Abre um novo incidente vinculado a uma reserva/serviço.

Request: Os campos vão dentro do wrapper Incident.

Nota

O nome oficial na documentação Cangooroo é creatIncident (sem o segundo 'e').

Atenção

O assunto é Title (não Subject).

URL

https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/creatIncident

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

Incidentobjectrequired

Wrapper obrigatório do incidente. Não envie os campos soltos na raiz do request.

Campo	Tipo	Obrigatório	Descrição
BookingId	string	Sim	Reserva relacionada ao incidente.
Message	string	Sim	Descrição do incidente.
SendEmail	bool	Não	Dispara notificação por e-mail quando true.
ServiceId	string	Não	Serviço específico da reserva.
Title	string	Sim	Assunto curto — substitui o antigo `Subject`.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

Incidentobject*

Wrapper obrigatório do incidente. Não envie os campos soltos na raiz do request.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/creatIncident" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "Incident": {
    "BookingId": "CGR-2026-0001",
    "Message": "Cliente chegará às 23h. Favor comunicar o hotel.",
    "SendEmail": true,
    "ServiceId": "SVC-001",
    "Title": "Late check-in"
  }
}'

Exemplo de response

{
  "IncidentId": 9001,
  "Status": "Open"
}

POST

addIncidentMessage

O que faz: Anexa uma nova mensagem a um incidente existente (thread de conversa).

Request: Os campos vão dentro do wrapper IncidentMessage.

Atenção

O identificador do incidente chama-se OccurrenceId (não IncidentId).

URL

https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/addIncidentMessage

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

IncidentMessageobjectrequired

Wrapper obrigatório da mensagem. Não envie os campos soltos na raiz do request.

Campo	Tipo	Obrigatório	Valores	Descrição
Message	string	Sim	—	Conteúdo da mensagem.
OccurrenceId	string	Sim	—	Identificador do incidente destino.
Title	string	Sim	—	Assunto da mensagem.
Type	enum	Sim	Request \| Occurrence	Tipo da mensagem.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

IncidentMessageobject*

Wrapper obrigatório da mensagem. Não envie os campos soltos na raiz do request.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/ClientBackOffice.svc/addIncidentMessage" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "meu_usuario",
    "Password": "minha_senha"
  },
  "IncidentMessage": {
    "Message": "Hotel confirmou late check-in até 23h30.",
    "OccurrenceId": "9001",
    "Title": "Late check-in",
    "Type": "Occurrence"
  }
}'

Exemplo de response

{
  "IncidentId": 9001,
  "MessageId": 5501
}

CangoorooBackOffice

POST

updateFXRate

O que faz: Atualiza a taxa de câmbio praticada pela operação.

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/updateFXRate

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BranchOfficeIdstring
Filial à qual a taxa se aplica.
ClientIDstring
Agência (client) à qual a taxa se aplica.
CurrencyFromstringrequired
Moeda de origem (ISO 4217).
CurrencyTostringrequired
Moeda de destino (ISO 4217).
ServiceTypenumberrequired
Tipo de serviço (mesmo enum de getLastFXRate) — ver valores aceitos abaixo.
ServiceType (enum numérico)(valores aceitos)
Campo Tipo Descrição
0 int Todos os serviços
1 int RentACar
2 int Circuit
3 int Cruise
4 int Hotel
5 int Insurance
6 int Tour
7 int Transfer
8 int TrainTicket
9 int TrainPass
10 int Flight
11 int Package
SupplierIdstring
Fornecedor ao qual a taxa se aplica.
Valuenumberrequired
Nova taxa de câmbio (substitui o antigo campo Rate).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BranchOfficeIdstring

Filial à qual a taxa se aplica.

ClientIDstring

Agência (client) à qual a taxa se aplica.

CurrencyFromstring*

Moeda de origem (ISO 4217).

CurrencyTostring*

Moeda de destino (ISO 4217).

ServiceTypenumber*

Tipo de serviço (mesmo enum de getLastFXRate) — ver valores aceitos abaixo.

SupplierIdstring

Fornecedor ao qual a taxa se aplica.

Valuenumber*

Nova taxa de câmbio (substitui o antigo campo Rate).

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/updateFXRate" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "BranchOfficeId": "BO-1",
  "ClientID": "AG-42",
  "CurrencyFrom": "USD",
  "CurrencyTo": "BRL",
  "ServiceType": 0,
  "SupplierId": "SUP-10",
  "Value": 5.45
}'

Exemplo de response

{
  "Success": true,
  "UpdatedAt": "2026-11-14T18:30:00"
}

POST

confirmClientPayment

O que faz: Confirma manualmente o pagamento recebido do cliente (agência) para um SERVIÇO.

Request: Credential + ServiceId + ServiceType (não há BookingId, PaidAmount nem Currency).

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

Usado pela retaguarda quando o pagamento não flui pelo gateway automático.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/confirmClientPayment

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ServiceIdstringrequired
Serviço a marcar como pago pelo cliente (retornado em GetBookingDetail).
ServiceTypenumberrequired
Tipo de serviço — ver valores aceitos abaixo.
ServiceType (enum numérico)(valores aceitos)
Campo Tipo Descrição
0 int Todos os serviços
1 int RentACar
2 int Circuit
3 int Cruise
4 int Hotel
5 int Insurance
6 int Tour
7 int Transfer
8 int TrainTicket
9 int TrainPass
10 int Flight
11 int Package

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ServiceIdstring*

Serviço a marcar como pago pelo cliente (retornado em GetBookingDetail).

ServiceTypenumber*

Tipo de serviço — ver valores aceitos abaixo.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/confirmClientPayment" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "ServiceId": "SVC-001",
  "ServiceType": 4
}'

Exemplo de response

{
  "ServiceId": "SVC-001",
  "ClientPaymentStatus": "Confirmed"
}

POST

confirmSupplierPayment

O que faz: Confirma manualmente o pagamento repassado ao fornecedor para um SERVIÇO.

Request: Mesmo contrato do confirmClientPayment: Credential + ServiceId + ServiceType.

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/confirmSupplierPayment

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ServiceIdstringrequired
Serviço cujo repasse ao fornecedor foi efetuado.
ServiceTypenumberrequired
Tipo de serviço (mesmo enum de getLastFXRate) — ver valores aceitos abaixo.
ServiceType (enum numérico)(valores aceitos)
Campo Tipo Descrição
0 int Todos os serviços
1 int RentACar
2 int Circuit
3 int Cruise
4 int Hotel
5 int Insurance
6 int Tour
7 int Transfer
8 int TrainTicket
9 int TrainPass
10 int Flight
11 int Package

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ServiceIdstring*

Serviço cujo repasse ao fornecedor foi efetuado.

ServiceTypenumber*

Tipo de serviço (mesmo enum de getLastFXRate) — ver valores aceitos abaixo.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/confirmSupplierPayment" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "ServiceId": "SVC-001",
  "ServiceType": 4
}'

Exemplo de response

{
  "ServiceId": "SVC-001",
  "SupplierPaymentStatus": "Confirmed"
}

POST

getClientDetail

O que faz: Retorna dados cadastrais de uma agência (client): nome, contatos e condições comerciais.

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/getClientDetail

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ClientIdstringrequired
Identificador da agência.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ClientIdstring*

Identificador da agência.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/getClientDetail" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "ClientId": "AG-42"
}'

Exemplo de response

{
  "ClientId": "AG-42",
  "Name": "Agência Teste",
  "Email": "[email protected]",
  "CommissionRate": 0.1
}

POST

getLastFXRate (licensee)

O que faz: Retorna a última taxa de câmbio registrada para a operação do licensee.

Request: Aceita filtros por BranchOfficeId, ClientID, SupplierId e ServiceType.

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/getLastFXRate

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
CurrencyFromstringrequired
Moeda de origem (ISO 4217).
CurrencyTostringrequired
Moeda de destino (ISO 4217).
ServiceTypenumber
Tipo de serviço — ver valores aceitos abaixo.
ServiceType (enum numérico)(valores aceitos)
Campo Tipo Descrição
0 int Todos os serviços
1 int RentACar
2 int Circuit
3 int Cruise
4 int Hotel
5 int Insurance
6 int Tour
7 int Transfer
8 int TrainTicket
9 int TrainPass
10 int Flight
11 int Package
BranchOfficeIdstring
Filial específica.
ClientIDstring
Agência específica.
SupplierIdstring
Fornecedor específico.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

CurrencyFromstring*

Moeda de origem (ISO 4217).

CurrencyTostring*

Moeda de destino (ISO 4217).

ServiceTypenumber

Tipo de serviço — ver valores aceitos abaixo.

BranchOfficeIdstring

Filial específica.

ClientIDstring

Agência específica.

SupplierIdstring

Fornecedor específico.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/getLastFXRate" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "CurrencyFrom": "USD",
  "CurrencyTo": "BRL",
  "ServiceType": 0
}'

Exemplo de response

{
  "CurrencyFrom": "USD",
  "CurrencyTo": "BRL",
  "Rate": 5.42,
  "UpdatedAt": "2026-11-14T09:00:00"
}

POST

GetBookingList (licensee)

O que faz: Lista reservas do licensee com filtros amplos (SearchBookingCriteria).

Request: Além dos filtros do ClientBackOffice, aceita SupplierLoc (localizador do fornecedor).

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

Performance: true acelera a consulta (não busca o nome da operadora e não ordena por ID de reserva).

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/GetBookingList

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.

SearchBookingCriteriaobjectrequired

Wrapper obrigatório dos filtros de busca de reservas do licensee.

Campo	Tipo	Obrigatório	Valores	Descrição
BookingNumber[]	array<string>	Não	—	Lista de números de reserva.
BookingStatus[]	array<enum>	Não	Confirmed \| Pending \| Cancelled \| OnRequest \| Rejected \| WaitingPayment	Status das reservas a retornar.
ServiceTypes[]	array<enum>	Não	Hotel \| Insurance \| Tour \| Transfer \| RentACar \| Flight \| Circuit \| Package	Tipos de serviço a considerar.
PassengerName	string	Não	—	Nome (ou parte) do passageiro.
ExternalReference	string	Não	—	Referência externa registrada pelo parceiro.
InitialBookingDate	string (YYYY-MM-DD)	Não	—	Início do intervalo de data da reserva.
FinalBookingDate	string (YYYY-MM-DD)	Não	—	Fim do intervalo de data da reserva.
InitialServiceDate	string (YYYY-MM-DD)	Não	—	Início do intervalo de data do serviço.
FinalServiceDate	string (YYYY-MM-DD)	Não	—	Fim do intervalo de data do serviço.
InitialUpdateDate	string (YYYY-MM-DD)	Não	—	Início do intervalo de última atualização.
FinalUpdateDate	string (YYYY-MM-DD)	Não	—	Fim do intervalo de última atualização.
CancelationDateStart	string (YYYY-MM-DD)	Não	—	Início do intervalo de data de cancelamento.
CancelationDateEnd	string (YYYY-MM-DD)	Não	—	Fim do intervalo de data de cancelamento.
PaymentDeadlineStart	string (YYYY-MM-DD)	Não	—	Início do intervalo de vencimento de pagamento.
PaymentDeadlineEnd	string (YYYY-MM-DD)	Não	—	Fim do intervalo de vencimento de pagamento.
Performance	bool	Não	—	Quando true, a consulta é mais rápida: não busca o nome da operadora e não ordena os resultados por ID de reserva. Reduz o tempo de resposta em pelo menos metade.
SupplierLoc	string	Não	—	Localizador do fornecedor (exclusivo do CangoorooBackOffice).

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

SearchBookingCriteriaobject*

Wrapper obrigatório dos filtros de busca de reservas do licensee.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/GetBookingList" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "SearchBookingCriteria": {
    "BookingStatus": [
      "Confirmed"
    ],
    "ServiceTypes": [
      "Hotel"
    ],
    "InitialBookingDate": "2026-11-01",
    "FinalBookingDate": "2026-11-30",
    "Performance": true
  }
}'

Exemplo de response

{
  "Bookings": [
    {
      "BookingId": "CGR-2026-0001",
      "Status": "Confirmed",
      "ClientId": "AG-42",
      "TotalPrice": 5250,
      "Currency": "BRL"
    }
  ]
}

POST

GetBookingDetail (licensee)

O que faz: Retorna detalhes completos de uma reserva na visão do licensee (inclui dados comerciais e de repasse ao fornecedor).

Requer nível de usuário

Só retorna dado com usuário operador (licensee). Usuário de agência recebe erro.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/GetBookingDetail

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdstringrequired
Identificador da reserva.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdstring*

Identificador da reserva.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/GetBookingDetail" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "BookingId": "CGR-2026-0001"
}'

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Confirmed",
  "ClientId": "AG-42",
  "Services": [
    {
      "ServiceId": "SVC-001",
      "ServiceType": "Hotel",
      "Status": "Confirmed"
    }
  ]
}

POST

cancelBooking (licensee)

O que faz: Cancela TODOS os serviços de uma reserva a partir da retaguarda do licensee.

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

Atenção

Se a política de cancelamento já estiver ativa, pode haver multa.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/cancelBooking

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
BookingIdstringrequired
Reserva a cancelar.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

BookingIdstring*

Reserva a cancelar.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/cancelBooking" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "BookingId": "CGR-2026-0001"
}'

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "Status": "Cancelled"
}

POST

cancelBookingByService (licensee)

O que faz: Cancela um serviço específico de uma reserva a partir da retaguarda do licensee.

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/cancelBookingByService

Parâmetros

Credentialobjectrequired
Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.
Campo Tipo Obrigatório Descrição
Username string Sim Usuário da agência/parceiro na Cangooroo.
Password string Sim Senha correspondente ao Username.
ServiceIdstringrequired
Identificador do serviço a cancelar (retornado por GetBookingDetail).
ServiceTypestringrequired
Tipo do serviço: Hotel | Insurance | Tour | Transfer | RentACar | Flight | Circuit | Package.

Try it outReferência

Credentialobject*

Bloco enviado em todas as chamadas dinâmicas. Identifica a agência/parceiro na Cangooroo.

ServiceIdstring*

Identificador do serviço a cancelar (retornado por GetBookingDetail).

ServiceTypestring*

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/cancelBookingByService" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "licensee_user",
    "Password": "licensee_pass"
  },
  "ServiceId": "SVC-001",
  "ServiceType": "Hotel"
}'

Exemplo de response

{
  "BookingId": "CGR-2026-0001",
  "ServiceId": "SVC-001",
  "Status": "Cancelled"
}

POST

SetHotelConfirmationNumber

O que faz: Registra o HCN (Hotel Confirmation Number, número de confirmação do próprio hotel) em um serviço de hotel. Se já houver um HCN, o novo valor substitui o anterior.

Requer nível de usuário

Operação de nível LICENSEE (operador Cangooroo). Usuário de agência recebe erro.

URL

https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/SetHotelConfirmationNumber

Parâmetros

Campo	Tipo	Obrigatório	Descrição
Credential	object	Sim	Credenciais do usuário operadora autorizado a utilizar a API de BackOffice.
BookingId	number	Sim	Identificador da reserva à qual o serviço de hotel pertence.
ServiceId	number	Sim	Identificador do serviço de hotel da reserva.
HotelConfirmationNumber	string	Sim	Número de confirmação emitido pelo próprio hotel (HCN). Substitui o valor existente.
OperatorRemarks	string	Não	Observação interna da operadora, acrescentada ao registrar o HCN.
AgencyRemarks	string	Não	Observação visível para a agência, acrescentada ao registrar o HCN.

Credential

Campo	Tipo	Obrigatório	Descrição
Username	string	Sim	Usuário da agência/parceiro na Cangooroo.
Password	string	Sim	Senha correspondente ao Username.

Try it outReferência

Credentialobject*

Credenciais do usuário operadora autorizado a utilizar a API de BackOffice.

BookingIdnumber*

Identificador da reserva à qual o serviço de hotel pertence.

ServiceIdnumber*

Identificador do serviço de hotel da reserva.

HotelConfirmationNumberstring*

Número de confirmação emitido pelo próprio hotel (HCN). Substitui o valor existente.

OperatorRemarksstring

Observação interna da operadora, acrescentada ao registrar o HCN.

AgencyRemarksstring

Observação visível para a agência, acrescentada ao registrar o HCN.

Edite os parâmetros — o exemplo de código é atualizado ao vivo. Nenhuma chamada real é enviada.

Exemplo de request

curl -X POST "https://ws-cliente.cangooroo.net/API/REST/CangoorooBackOffice.svc/SetHotelConfirmationNumber" \
  -H "Content-Type: application/json" \
  -d '{
  "Credential": {
    "Username": "string",
    "Password": "string"
  },
  "BookingId": 0,
  "ServiceId": 0,
  "HotelConfirmationNumber": "string",
  "OperatorRemarks": "string",
  "AgencyRemarks": "string"
}'

Campos da resposta

Campo	Tipo	Descrição
TotalTime	number	Tempo total informado pela operação.
Token	string	Token retornado pela operação.
TimeSpan	string	Intervalo de tempo informado pela operação.
Error	object	Detalhes de erro e diagnóstico, quando houver.
Messages	array	Mensagens da operação, incluindo avisos sobre falhas de notificação.
SInfo	string	Informação complementar retornada pela operação.
BookingId	number	Identificador da reserva.
ServiceId	number	Identificador do serviço de hotel.
OldHotelConfirmationNumber	string	HCN anterior ao registro.
NewHotelConfirmationNumber	string	HCN após o registro.

Error

Campo	Tipo	Descrição
Server	string	Servidor informado no diagnóstico.
Message	string	Mensagem de erro.
Stacktrace	string	Detalhes técnicos do erro.
TotalTime	number	Tempo total informado no erro.
Code	number	Código de erro.
Token	string	Token informado no erro.
TimeSpan	string	Intervalo de tempo informado no erro.
SupportInfo	string	Informações para suporte.

Messages[]

Campo	Tipo	Descrição
value	string	Valor da mensagem.
content	string	Conteúdo da mensagem.

Exemplo de response

{
  "TotalTime": 0,
  "Token": "string",
  "TimeSpan": "string",
  "Error": {
    "Server": "string",
    "Message": "string",
    "Stacktrace": "string",
    "TotalTime": 0,
    "Code": 0,
    "Token": "string",
    "TimeSpan": "string",
    "SupportInfo": "string"
  },
  "Messages": [
    {
      "value": "string",
      "content": "string"
    }
  ],
  "SInfo": "string",
  "BookingId": 0,
  "ServiceId": 0,
  "OldHotelConfirmationNumber": "string",
  "NewHotelConfirmationNumber": "string"
}

Cache local

Downloads estáticos

Arquivos ZIP com o catálogo estático. Baixe, extraia e importe em seu banco local — atualize semanalmente.

Campo	Tipo	Descrição
0	int	Todos os serviços
1	int	RentACar
2	int	Circuit
3	int	Cruise
4	int	Hotel
5	int	Insurance
6	int	Tour
7	int	Transfer
8	int	TrainTicket
9	int	TrainPass
10	int	Flight
11	int	Package