How can we help?
Follow
SmartBook Orders API

Description

The SmartBook Orders API is used for retrieving both the order details and financial details on SmartBook segments.

The details include the data regarding the package that the user originally selected to book, at the time when the user submitted the book request before SmartBook logic started.

GetSmartBookData

Request

POST http://services.travolutionary.com/BookingServices/OrdersService.svc HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "urn:IOrdersService/GetSmartBookData"
Host: services.carsolize.com
Content-Length: 561
Expect: 100-continue
Connection: Keep-Alive 

 

Body of the Request

Field Name Description Type Possible Values M/O
Credentials

Will be provided by Travolutionary Support team upon set-up, or by creating a new user in the B2B/Backoffice system.

- Password

- UserName

 String  - M
 FromDate The date from which the orders will be detailed.  System.DateTime  - M
RecordsToSkip Will skip the set number of orders from the starting date Int32    
ServiceType The SmartBook feature is currently available only for the Hotels service IsuBe.Base.Enum.ServiceType Hotels M
ToDate The date up to which the orders will be detailed.   System.DateTime  - M

 

Response

Field Name Description
Errors If any error occurs during the service response, it will be returned in its dedicated field
SmartBookSegmentInfo
 OriginalPackageContractId The Supplier Contract ID set for the supplier account, through which the user originally requested to book, before SmartBook logic started.
 OriginalPackageContractName Alias for the Supplier Contract, through which the user originally requested to book, before SmartBook logic started.
 OriginalPackageProfit Calculated profit of the markup and commission values applied to the package which the user originally requested to book, before SmartBook logic started.
 SegmentId The SegmentID of this booking.
 SmartBookDeltaProfit

The profit delta gained by SmartBook for this booking, after SmartBook logic applied.

Calculated as the following:

Profit after SmartBook logic applied - OriginalPackageProfit (pre SmartBook).

Note:

Negative delta profit represents a decrease in the profit comparing to the "OriginalPackageProfit".

Meaning that SmartBook decreased the profit (within the allowed range) for a purpose of saving a failed booking by rebooking alternative candidates.

 SmartBookTotalProfit

The total profit amount gained by SmartBook for this booking.

Represents the final profit for this booking after SmartBook logic applied.

Calculated as the following:

OriginalPackageProfit (pre SmartBook) + SmartBookDeltaProfit.

SupplierName Supplier name through which the user originally requested to book.

 

GetSegmentSmartBookData

Request

 POST http://services.travolutionary.com/BookingServices/OrdersService.svc HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "urn:IOrdersService/GetSegmentSmartBookData"
Host: carsolizeservices.westeurope.cloudapp.azure.com
Content-Length: 452
Expect: 100-continue

 

Body of the Request

Field Name Description Type Possible Values  M/O
 Credentials  Will be provided by Travolutionary Support team upon set-up, or by creating a new user in the B2B/Backoffice system.

- Password

- UserName

 String -  M
 SegmentId  The queried order's SegmentID  String -  M

 

Response

Field Name Description
 OriginalPackageContractId The Supplier Contract ID set for the supplier account, through which the order was requested and confirmed
 OriginalPackageContractName Alias for the Supplier Contract, through which the order was requested and confirmed
 OriginalPackageProfit Calculated by the markup and commission values applied to the order
 SegmentId The order's SegmentID 
 SmartBookDeltaProfit The profit delta gained by SmartBook for the order
 SmartBookTotalProfit The profit amount gained by SmartBook for the order
SupplierName Supplier name through which the user originally requested to book.

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk