Cangooroo backoffice
CangoorooBackoffice contracts
Our Cangooroo Backoffice API provides a set of methods that can be very helpful for process management and automation. This is for the Cangooroo license owner and need to be used for a user attached directly to the Tour Operator.
Below you find a list of available methods:
updateFXRate
Use this method to register a new currency conversion.
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"BranchOfficeId": "?",
"ClientID": "?",
"CurrencyFrom": "?",
"CurrencyTo": "?",
"ServiceType": "?",
"SupplierId": "?",
"Value": "?"
}
Registration can be performed for a specific supplier, customer or branchoffice if informed.
The service type should be informed with one of the options below. If you send the ServiceType with 0 (zero) it will be for all services, but if you send any other the FX for that specific service will be used instead of the general one.
0 = ALL services
1 = Rental car
2 = Circuit
3 = Cruise
4 = Hotel
5 = Insurance
6 = Tour
7 = Transfer
8 = TrainTicket
9 = TrainPass
10 = Flight
11 = Package
We recommend that you always provide a FX rate for all services and after you provide the FX for a specific service. If you update this info regularly we recommend that you do it for all services and then for the specific service youu want.
GetLastFXRate
In this method, retrieve the exchange information registered for the user agency used.
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below, followed by the criteria fields:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"BranchOfficeId": "?",
"ClientID": "?",
"CurrencyFrom": "?",
"CurrencyTo": "?",
"ServiceType": "?",
"SupplierId": "?"
}
GetClientDetail
Use this method to retrieve a client information:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"ClientId": "?"
}
GetBookingList
Use this method to get an list of reservations from the client.
The criteria fields will be used in the search for reservations.
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"SearchBookingCriteria": {
"BookingNumber": [],
"BookingStatus": [],
"CancelationDateEnd": "?",
"CancelationDateStart": "?",
"ExternalReference": "?",
"FinalBookingDate": "?",
"FinalServiceDate": "?",
"FinalUpdateDate": "?",
"InitialBookingDate": "?",
"InitialServiceDate": "?",
"InitialUpdateDate": "?",
"PassengerName": "?",
"PaymentDeadlineEnd": "?",
"PaymentDeadlineStart": "?",
"SupplierLoc": "?",
"ServiceTypes": []
}
}
GetBookingDetail
Use this method to get detailed information about an reservation.
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below followed by the bookingid:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"BookingId": "?"
}
ConfirmClientPayment
Use this method to change your payment status from paid to a service.
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"ServiceId": "?",
"ServiceType": "?"
}
ConfirmSupplierPayment
Use this method to change the supplier's payment status to paid for a service.
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"ServiceId": "?",
"ServiceType": "?"
}
CancelBooking
Use this method to cancel all services in a file (reservation).
CancelBooking Request
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below, followed by bookingid:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"BookingId": ?
}
CancelBooking Response
In the answer of this method the customer can see the status of his reservation and verify that it has been successfully canceled, it is worth noting that if a reservation is canceled after its cancellation policies take effect, the customer may pay a fine for the service.
CancelBookingByService
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
"ServiceId": ?
"ServiceType":?
}
ServiceTypes
There are eight types of service:
Hotel
Insurance
Tour
Transfer
RentACar
Flight
Circuit
Package
CancelBookingByService Response
In the answer of this method the customer can see the status of his reservation and verify that it has been successfully canceled, it is worth noting that if a reservation is canceled after its cancellation policies take effect, the customer may pay a fine for the service.
URL and Examples
SOAP
http://ws-[clientIdentification].cangooroo.net/API/SOAP/CangoorooBackOffice.svc
REST
REST: http://ws-[clientIdentification].cangooroo.net/API/REST/CangoorooBackOffice.svc