1. Overview
These services manage all of the common commerce functionality, and also include customizations from installed AddOns. The implementing extension is called ycommercewebservices.
1.2. License information
License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null
1.4. Tags
-
Accommodation Carts : Accommodation Carts Controller
-
Accommodation Offerings : Accommodation Offerings Controller
-
Accommodation Orders : Accommodation Orders Controller
-
Accommodation Search : Accommodation Search Controller
-
Accommodation Suggestions : Accommodation Suggestions Controller
-
Address : Address Controller
-
Addresses : Travel Address Controller
-
Base Sites : Base Sites Controller
-
Base Stores : Base Stores Controller
-
Carts : Carts Controller
-
Catalogs : Catalogs Controller
-
Consents : Transport Consents Controller
-
Countries : Countries Controller
-
Customer Groups : Customer Groups Controller
-
Deal Carts : Deal Carts Controller
-
Deal Search : Deal Search Controller
-
Export : Export Controller
-
Feeds : Feeds Controller
-
Forgotten Passwords : Forgotten Passwords Controller
-
Login Notification : Login Notification Controller
-
Miscs : Miscs Controller
-
Orders : Orders Controller
-
Package Carts Controller : Package Carts Controller
-
Package Search : Package Search Controller
-
Payment Details : Payment Details Controller
-
Payment Modes : Payment Modes Controller
-
Products : Products Controller
-
Promotions : Promotions Controller
-
Return Requests : Order Returns Controller
-
Save Cart : Save Cart Controller
-
Search : Transport Search Controller
-
Special Services : Special Services Controller
-
Stores : Stores Controller
-
Transport Bundles : Transport Bundles Controller
-
Transport Carts : Transport Carts Controller
-
Transport Locations : Transport Locations Controller
-
Transport Offerings : Transport Offerings Controller
-
Transport Orders : Transport Orders Controller
-
Transport Users : Transport Users Controller
-
Travel Base Sites : Travel Base Site Controller
-
Travel Carts : Travel Carts Controller
-
Travel Order Search : Travel Order Search Controller
-
Travel Orders : Travel Orders Controller
-
Travel Users : Travel Users Controller
-
Users : Users Controller
-
Vouchers : Vouchers Controller
2. Security
2.1. oauth2_Password
Type : oauth2
Flow : password
Token URL : https://{oauth2_url}/authorizationserver/oauth/token
| Name |
|---|
basic |
2.2. oauth2_client_credentials
Type : oauth2
Flow : application
Token URL : https://{oauth2_url}/authorizationserver/oauth/token
| Name |
|---|
extended |
3. Resources
3.1. Accommodation Carts
Accommodation Carts Controller
3.1.1. Modifies check in and check out dates against room rates in the cart
POST /{baseSiteId}/users/{userId}/carts/{cartId}/changeStayDates
Description
Applies dates change to all the room stays in the cart, in case of availability of all the selected accommodations and all the selected rate plans.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
updateRoomStaysRequest |
Request body parameter that contains the details required to perform an update room stays. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
No Content |
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
3.1.2. Perform the add room stays to cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/roomStays
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
request |
Request body parameter that contains the details required to perform an add room stay to cart. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.1.3. Deletes a room stay from cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}
Description
Deletes the specified room stay from the cart, if present, and all the associated products.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
roomStayRefNumber |
Room Stay unique identifier - identifies a room stay in the cart |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.1.4. Searches for all available services
GET /{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/accommodationServices
Description
Searches for all available services for the room stays present in the cart with the given ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
roomStayRefNumber |
The room stay reference number for which the services are returned |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
422 |
Unprocessable Entity) |
|
500 |
Server Error |
3.1.5. Returns cancel penalties for a room stay
GET /{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/cancelPenalties
Description
Returns information about the cancel penalties applied to the given room stays according with the selected rate plan
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
roomStayRefNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.1.6. Returns guarantees for a room stay
GET /{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/guarantees
Description
Returns information about the guarantees applied to the given room stays according with the selected rate plan
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
roomStayRefNumber |
The room stay reference number for which the services are returned |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.1.7. Add lead guest details
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/leadGuest
Description
Adds or updates the lead guest details for a room stays in the cart. Also specifies the expected guest occupancy for the given room stay.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
roomStayRefNumber |
Room Stay unique identifier - identifies a room stay in the cart |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
leadGuestDetails |
Request body parameter that contains the details required for a lead guest. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.1.8. Add accommodation service entry to cart
POST /{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
request |
Request body parameter that contains the details required to perform an add room stay to cart. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.1.9. Gets details of an accommodation service entry.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}
Description
Gets the details of an accommodation service cart entry, such as the product added, the quantity in cart, and price information.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryId |
The entry identifier. Each entry in a cart has an entry identifier. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.1.10. Delete accommodation service entry from cart
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryId |
The entry identifier. Each entry in a cart has an entry identifier. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.1.11. Update accommodation service entry to cart
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryId |
The entry identifier. Each entry in a cart has an entry identifier. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
addServiceEntry |
Request body parameter that contains the details required to perform an add service to cart. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.2. Accommodation Offerings
Accommodation Offerings Controller
3.2.1. Returns information about a specific accommodation offering
GET /{baseSiteId}/accommodationOfferings/{accommodationOfferingCode}
Description
Returns detailed information about the given accommodation offering, alongside with the available rates for any room type defined in the property
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
string |
Header |
sap.cx-accept-currency |
Requested Currency for the client |
string |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
accommodationOfferingCode |
Accommodation offering identifier |
string |
Path |
baseSiteId |
Base site identifier |
string |
Query |
checkInDate |
The check in date |
string |
Query |
checkOutDate |
The check out date |
string |
Query |
roomGuestOccupancy |
The guest occupancy per room in form of <qty>-<ptc> comma separated. For example, 2-adult:1-child:1-infant |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.2.2. Returns the list of reviews
GET /{baseSiteId}/accommodationOfferings/{accommodationOfferingCode}/reviews
Description
Returns the list of reviews for a given property proving information about the rating and the user who submitted it
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
accommodationOfferingCode |
Accommodation offering identifier |
string |
Path |
baseSiteId |
Base site identifier |
string |
3.3. Accommodation Orders
Accommodation Orders Controller
3.3.1. Evaluate if stay dates can be amended
POST /{baseSiteId}/users/{userId}/orders/{orderId}/evaluateStayDatesChange
Description
Evaluate if changing the stay dates is possible also in terms of availability and returns pricing indication when allowed.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
checkInDate |
The check in date |
string |
Query |
checkOutDate |
The check out date |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
201 |
Created |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
3.3.2. Cancels the accommodation reservation from the given order
POST /{baseSiteId}/users/{userId}/orders/{orderId}/reservations/accommodationReservation/cancel
Description
Cancel the accommodation reservation, releasing stocks and triggering refund procedure when applicable
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found) |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.3.3. Add a room request
POST /{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
roomStayRefNumber |
Room Stay unique identifier - identifies a room stay in the cart |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
requestMessage |
Request body parameter that contains the details required to add requests. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found) |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.3.4. Gets all room request
GET /{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
roomStayRefNumber |
Room Stay unique identifier - identifies a room stay in the cart |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found) |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.3.5. Removes a room stay request
DELETE /{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests/{requestId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
requestId |
Request identifier |
string |
Path |
roomStayRefNumber |
Room Stay unique identifier - identifies a room stay in the cart |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found) |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.3.6. Allows the user to write a customer review
POST /{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/writeReview
Description
Allows the user to write a customer review for the property for which the booking has been placed and for the specific room stay passed as parameter. The review will be then visible if approved among the reviews for the relative property.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
roomStayRefNumber |
Room Stay unique identifier - identifies a room stay in the cart |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
customerReviewRequest |
Request body parameter that contains the information needed to post a customer review. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.4. Accommodation Search
Accommodation Search Controller
3.4.1. Searches for all the properties in a given location and gives information about availability and prices.
GET /{baseSiteId}/accommodations
Description
Searches for all the properties in a given location and gives information about availability and prices.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
string |
|
Header |
sap.cx-accept-currency |
Requested Currency for the client |
string |
|
Header |
sap.cx-sales-application |
The sales application code |
string |
|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
checkInDate |
The check in date |
string |
|
Query |
checkOutDate |
The check out date |
string |
|
Query |
currentPage |
The page number |
integer(int32) |
|
Query |
destinationLocation |
The destination location code |
string |
|
Query |
filter |
The attribute for which the results are filtered. Multiple filters are allowed. |
string |
|
Query |
pageSize |
The page size |
integer(int32) |
|
Query |
roomGuestOccupancy |
The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant |
string |
|
Query |
sort |
The attribute for which the results are sorted. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
500 |
Server Error |
3.5. Accommodation Suggestions
Accommodation Suggestions Controller
3.5.1. Returns a list of suggestions for the given text
GET /{baseSiteId}/accommodationSuggestions
Description
Returns a list of suggestions for the given text. A suggestion can be a location or a specific property matching the criteria.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
string |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Query |
searchText |
The text to search |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
|
500 |
Server Error |
3.6. Address
Address Controller
3.6.1. Verifies address.
POST /{baseSiteId}/users/{userId}/addresses/verification
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
address |
Address object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.7. Addresses
Travel Address Controller
3.7.1. Creates a new address.
POST /{baseSiteId}/users/{userId}/addresses
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
address |
Address object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.7.2. Get customer’s addresses
GET /{baseSiteId}/users/{userId}/addresses
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error |
3.7.3. Get details of a specific address.
GET /{baseSiteId}/users/{userId}/addresses/{addressId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
addressId |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.7.4. Updates the address
PUT /{baseSiteId}/users/{userId}/addresses/{addressId}
Description
Updates the address. Attributes not provided in the request will be defined again (set to null or default).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
addressId |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
address |
Address object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.7.5. Delete customer’s address.
DELETE /{baseSiteId}/users/{userId}/addresses/{addressId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
addressId |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.7.6. Updates the address.
PATCH /{baseSiteId}/users/{userId}/addresses/{addressId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
addressId |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
address |
Address object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.8. Base Sites
Base Sites Controller
3.8.1. Get all base sites.
GET /basesites
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.9. Base Stores
Base Stores Controller
3.9.1. Get a base store.
GET /{baseSiteId}/basestores/{baseStoreUid}
Description
Returns details of a specific base store based on its identifier. The response contains detailed base store information.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
baseStoreUid |
Base store name |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10. Carts
Carts Controller
3.10.1. Get all customer carts.
GET /{baseSiteId}/users/{userId}/carts
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
currentPage |
Optional pagination parameter in case of savedCartsOnly == true. Default value 0. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20. |
integer(int32) |
|
Query |
savedCartsOnly |
Optional parameter. If the parameter is provided and its value is true, only saved carts are returned. |
boolean |
|
Query |
sort |
Optional sort criterion in case of savedCartsOnly == true. No default value. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.2. Creates a delivery address for the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
address |
Request body parameter that contains details such as the customer’s first name (firstName), the customer’s last name (lastName), the customer’s title (titleCode), the customer’s phone (phone), the country (country.isocode), the first part of the address (line1), the second part of the address (line2), the town (town), the postal code (postalCode), and the region (region.isocode). |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.3. Sets a delivery address for the cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery
Description
Sets a delivery address for the cart. The address country must be placed among the delivery countries of the current base store.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
addressId |
Address identifier |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.4. Deletes the delivery address from the cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.10.5. Get the delivery mode selected for the cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.6. Sets the delivery mode for a cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
deliveryModeId |
Delivery mode identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.7. Deletes the delivery mode from the cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.10.8. Get all delivery modes for the current store and delivery address.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymodes
Description
Returns all delivery modes supported for the current base store and cart delivery address. A delivery address must be set for the cart, otherwise an empty list will be returned.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.9. Adds a product to the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/entries
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
entry |
Request body parameter that contains details such as the product code (product.code), the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name). |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.10. Get cart entries.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.11. Get the details of the cart entries.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer(int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.12. Set quantity and store details of a cart entry.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
Description
Updates the quantity of a single cart entry and the details of the store where the cart entry will be picked up. Attributes not provided in request will be defined again (set to null or default)
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer(int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
entry |
Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.13. Deletes cart entry.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer(int64) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.10.14. Update quantity and store details of a cart entry.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
Description
Updates the quantity of a single cart entry and the details of the store where the cart entry will be picked up.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer(int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
entry |
Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.10.15. Add a product to a cart entry group.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryGroupNumber |
Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order. |
integer(int32) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
entry |
Request body parameter that contains details such as the product code (product.code) and the quantity of product (quantity). |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.16. Delete an entry group.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}
Description
Removes an entry group from an associated cart. The entry group is identified by an entryGroupNumber. The cart is identified by the cartId.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryGroupNumber |
Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.10.17. Enables promotions based on the promotionsId of the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/promotions
Description
Enables a promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
promotionId |
Promotion identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.18. Get information about promotions applied on cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions
Description
Returns information about the promotions applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.19. Get information about promotion applied on cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}
Description
Returns information about a promotion (with a specific promotionId), that has been applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
promotionId |
Promotion identifier (code) |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.20. Disables the promotion based on the promotionsId of the cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}
Description
Disables the promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
promotionId |
Promotion identifier (code) |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.10.21. Applies a voucher based on the voucherId defined for the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
voucherId |
Voucher identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.22. Get a list of vouchers applied to the cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.23. Deletes a voucher defined for the current cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers/{voucherId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Path |
voucherId |
Voucher identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.11. Catalogs
Catalogs Controller
3.11.1. Get a list of catalogs
GET /{baseSiteId}/catalogs
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.11.2. Get a catalog
GET /{baseSiteId}/catalogs/{catalogId}
Description
Returns information about a catalog based on its ID, along with the versions defined for the current base store.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.11.3. Get information about catalog version
GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Path |
catalogVersionId |
Catalog version identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.11.4. Get information about catagory in a catalog version
GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}
Description
Returns information about a specified category that exists in a catalog version available for the current base store.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Path |
catalogVersionId |
Catalog version identifier |
string |
|
Path |
categoryId |
Category identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.12. Consents
Transport Consents Controller
3.12.1. Allows to grant a consent
POST /{baseSiteId}/users/{userId}/consents
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
consentTemplateId |
Consent template ID. |
string |
Query |
consentTemplateVersion |
Consent template version. |
integer(int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.12.2. Withdraws the user consent for a given consent code.
DELETE /{baseSiteId}/users/{userId}/consents/{consentCode}
Description
If the user consent was given, the consent is withdrawn. If consent was already withdrawn then returns consent already withdrawn error. If there is no such consent then returns not found. If the current user is an anonymous user then returns access denied error.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
consentCode |
Consent code. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
422 |
Unprocessable Entity: business rules validation errors |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.12.3. Fetch the list of consents
GET /{baseSiteId}/users/{userId}/consenttemplates
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
3.12.4. Fetch the consent.
GET /{baseSiteId}/users/{userId}/consenttemplates/{consentTemplateId}
Description
If user has not given or withdrawn consent to the template, no given or withdraw date is returned.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
consentTemplateId |
Consent template id. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.13. Countries
Countries Controller
3.13.1. Get a list of countries.
GET /{baseSiteId}/countries
Description
If the value of type equals to shipping, then return shipping countries. If the value of type equals to billing, then return billing countries. If the value of type is not given, return all countries. The list is sorted alphabetically.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
type |
The type of countries. |
enum (SHIPPING, BILLING) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.13.2. Fetch the list of regions for the provided country.
GET /{baseSiteId}/countries/{countyIsoCode}/regions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
countyIsoCode |
An ISO code for a country |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.14. Customer Groups
Customer Groups Controller
3.14.1. Creates a new customer group.
POST /{baseSiteId}/customergroups
Description
Creates a new customer group that is a direct subgroup of a customergroup.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Body |
userGroup |
User group object with id and name. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.14.2. Get all subgroups of a customergroup.
GET /{baseSiteId}/customergroups
Description
Returns all customer groups that are direct subgroups of a customergroup.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
currentPage |
Current page number (starts with 0). |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
Number of customer group returned in one page. |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.14.3. Get a specific customer group.
GET /{baseSiteId}/customergroups/{groupId}
Description
Returns a customer group with a specific groupId.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
groupId |
Group identifier. |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.14.4. Sets members for a user group.
PUT /{baseSiteId}/customergroups/{groupId}/members
Description
Sets members for a user group. The list of existing members is overwritten with a new one.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Body |
members |
List of users to set for customer group. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.14.5. Assigns user(s) to a customer group.
PATCH /{baseSiteId}/customergroups/{groupId}/members
Description
Assigns user(s) to a customer group.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Body |
members |
List of users to assign to customer group. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.14.6. Deletes a user from a customer group.
DELETE /{baseSiteId}/customergroups/{groupId}/members/{userId}
Description
Deletes user from a customer group.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Path |
userId |
User identifier. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.15. Deal Carts
Deal Carts Controller
3.15.1. Perform the add deal to cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/deals
Description
Add a deal to the cart, as a combination of transportation for a return journey, and associated room stays and additional products. Only one deal can be in the cart at the same time.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
addDealToCart |
Request body parameter that contains the details required to perform an add deal to cart. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No content |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable entity: business rules validation errors |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.16. Deal Search
Deal Search Controller
3.16.1. Get a list of deal categories.
GET /{baseSiteId}/dealCategories
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.16.2. Searches for the list of deals for a given category
GET /{baseSiteId}/deals
Description
Search for the deals belonging to the category passed as argument. Details about the deals will be returned and the level will depend on the extent of the fields attribute
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
string |
|
Header |
sap.cx-accept-currency |
Requested Currency for the client |
string |
|
Header |
sap.cx-sales-application |
The sales application code |
string |
|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
dealCategory |
The deal category unique identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.16.3. Searches for the details of a specific deal
GET /{baseSiteId}/deals/{dealId}
Description
Search for the details for a specific deal including a stay in the given accommodation offering and the list of available transportation options, plus an optional set of additional products
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
string |
Header |
sap.cx-accept-currency |
Requested Currency for the client |
string |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
dealId |
The deal unique identifier |
string |
Query |
departureDate |
The departure date |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.16.4. Gets for the available dates of a specific deal
GET /{baseSiteId}/deals/{dealId}/availableDates
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
dealId |
The deal unique identifier |
string |
Query |
endingDate |
The ending date |
string |
Query |
startingDate |
The starting date |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.17. Export
Export Controller
3.17.1. Get a list of product exports.
GET /{baseSiteId}/export/products
Description
Used for product export. Depending on the timestamp parameter, it can return all products or only products modified after the given time.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
catalog |
The catalog to retrieve products from. The catalog must be provided along with the version. |
string |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Query |
timestamp |
When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). |
string |
|
Query |
version |
The catalog version. The catalog version must be provided along with the catalog. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.18. Feeds
Feeds Controller
3.18.1. Get a list of orders with status updates.
GET /{baseSiteId}/feeds/orders/statusfeed
Description
Returns the orders that have changed status. Returns only the elements from the current baseSite that have been updated after the provided timestamp.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
timestamp |
Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.19. Forgotten Passwords
Forgotten Passwords Controller
3.19.1. Generates a token to restore a customer’s forgotten password.
POST /{baseSiteId}/forgottenpasswordtokens
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Query |
userId |
Customer’s user id. Customer user id is case insensitive. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
202 |
Accepted |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.19.2. Reset password after customer’s clicked forgotten password link.
POST /{baseSiteId}/resetpassword
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Body |
resetPassword |
Request body parameter that contains details such as token and new password |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
202 |
Accepted |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.20. Login Notification
Login Notification Controller
3.20.1. Notify about successful login.
POST /{baseSiteId}/users/{userId}/loginnotification
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
202 |
Accepted |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.21. Miscs
Miscs Controller
3.21.1. Get a list of supported payment card types.
GET /{baseSiteId}/cardtypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.21.2. Get a list of shipping countries.
GET /{baseSiteId}/deliverycountries
|
Caution
|
operation.deprecated |
Description
Lists all supported delivery countries for the current store. The list is sorted alphabetically.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.21.3. Get a list of all localized titles.
GET /{baseSiteId}/titles
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.22. Orders
Orders Controller
3.22.1. Get a order.
GET /{baseSiteId}/orders/{code}
Description
Returns details of a specific order based on the order GUID (Globally Unique Identifier) or the order CODE. The response contains detailed order information.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Order GUID (Globally Unique Identifier) or order CODE |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.22.2. Get total number of orders.
HEAD /{baseSiteId}/users/{userId}/orders
Description
In the response header, the "x-total-count" indicates the total number of orders placed by a specified user for a specified base store.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
statuses |
Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.22.3. Cancel an order.
POST /{baseSiteId}/users/{userId}/orders/{code}/cancellation
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
code |
Order code |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
cancellationRequestEntryInputList |
Cancellation request input list for the current order. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23. Package Carts Controller
Package Carts Controller
3.23.1. Perform the add package to cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/packages
Description
Adds a package, consisting in a combination of a transportation and room stays for all the specified travellers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
addPackageToCartRequest |
addPackageToCartRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No content |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.24. Package Search
Package Search Controller
3.24.1. Searches for packages fulfilling the search criteria
GET /{baseSiteId}/packages
Description
Searches for packages, where a package is identified by a combination of a transportation and an accommodation stay for all the specified travellers, fulfilling the search criteria.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
|
Header |
sap.cx-accept-currency |
Requested Currency for the client |
string |
|
Header |
sap.cx-sales-application |
The sales application code |
string |
|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
arrivalLocation |
The arrival location code |
string |
|
Query |
arrivalLocationType |
The arrival location type |
enum (CITY, AIRPORTGROUP) |
|
Query |
cabinPreference |
The cabin Preference |
string |
|
Query |
currentPage |
The page number |
integer(int32) |
|
Query |
departureDate |
The departure date |
string |
|
Query |
departureLocation |
The departure location code |
string |
|
Query |
departureLocationType |
The departure location type |
enum (CITY, AIRPORTGROUP) |
|
Query |
pageSize |
The page size |
integer(int32) |
|
Query |
returnDate |
The return date |
string |
|
Query |
roomGuestOccupancy |
The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant |
string |
|
Query |
transportOfferingType |
The Transport Offering Type |
enum (DIRECT, INDIRECT) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
500 |
Server Error |
3.24.2. Searches for the details of a specific package
GET /{baseSiteId}/packages/{accommodationOfferingCode}
Description
Search for the details for a specific package including a stay in the given accommodation offering and the list of available transportation options.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
string |
Header |
sap.cx-accept-currency |
Requested Currency for the client |
string |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
accommodationOfferingCode |
The accommodation offering code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Query |
arrivalLocation |
The arrival location code |
string |
Query |
arrivalLocationType |
The arrival location type |
string |
Query |
cabinPreference |
The cabin Preference |
string |
Query |
departureDate |
The departure date |
string |
Query |
departureLocation |
The departure location code |
string |
Query |
departureLocationType |
The departure location type |
string |
Query |
returnDate |
The return date |
string |
Query |
roomGuestOccupancy |
The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant |
string |
Query |
transportOfferingType |
The Transport Offering Type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.25. Payment Details
Payment Details Controller
3.25.1. Get customer’s credit card payment details list.
GET /{baseSiteId}/users/{userId}/paymentdetails
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.25.2. Get customer’s credit card payment details.
GET /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.25.3. Updates existing customer’s credit card payment info.
PUT /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
Description
Updates existing customer’s credit card payment info based on the payment info ID. Attributes not given in request will be defined again (set to null or default).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
paymentDetails |
Payment details object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error |
3.25.4. Deletes customer’s credit card payment details.
DELETE /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.25.5. Updates existing customer’s credit card payment details.
PATCH /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
Description
Updates an existing customer’s credit card payment details based on the specified paymentDetailsId. Only those attributes provided in the request will be updated.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
paymentDetails |
Payment details object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.26. Payment Modes
Payment Modes Controller
3.26.1. Gets all available payment modes.
GET /{baseSiteId}/paymentmodes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27. Products
Products Controller
3.27.1. Get products added to the express update feed.
GET /{baseSiteId}/products/expressupdate
Description
Returns products added to the express update feed. Returns only elements updated after the provided timestamp. The queue is cleared using a defined cronjob.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
catalog |
Only products from this catalog are returned. Format: catalogId:catalogVersion |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
timestamp |
Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.2. Get a list of products and additional data
GET /{baseSiteId}/products/search
Description
Returns a list of products and additional data, such as available facets, available sorting, and pagination options. It can also include spelling suggestions. To make spelling suggestions work, you need to make sure that "enableSpellCheck" on the SearchQuery is set to "true" (by default, it should already be set to "true"). You also need to have indexed properties configured to be used for spellchecking.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Query |
query |
Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 |
string |
|
Query |
searchQueryContext |
The context to be used in the search query. |
string |
|
Query |
sort |
Sorting method applied to the return results. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.3. Get a header with total number of products.
HEAD /{baseSiteId}/products/search
Description
In the response header, the "x-total-count" indicates the total number of products satisfying a query.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Query |
query |
Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.27.4. Get a list of available suggestions
GET /{baseSiteId}/products/suggestions
Description
Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
max |
Specifies the limit of results. |
integer(int32) |
|
Query |
term |
Specified term |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.5. Get product details.
GET /{baseSiteId}/products/{productCode}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.6. Get a product reference
GET /{baseSiteId}/products/{productCode}/references
Description
Returns references for a product with a given product code. Reference type specifies which references to return.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
Maximum size of returned results. |
integer(int32) |
|
Query |
referenceType |
Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.7. Creates a new customer review as an anonymous user.
POST /{baseSiteId}/products/{productCode}/reviews
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
review |
Object contains review details like : rating, alias, headline, comment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.8. Get reviews for a product
GET /{baseSiteId}/products/{productCode}/reviews
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
maxCount |
Maximum count of reviews |
integer(int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.9. Get a product’s stock level.
GET /{baseSiteId}/products/{productCode}/stock
Description
Returns a product’s stock levels sorted by distance from the specified location, which is provided using the free-text "location" parameter, or by using the longitude and latitude parameters. The following two sets of parameters are available: location (required), currentPage (optional), pageSize (optional); or longitude (required), latitude (required), currentPage (optional), pageSize(optional).
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
latitude |
Latitude location parameter. |
number(double) |
|
Query |
location |
Free-text location |
string |
|
Query |
longitude |
Longitude location parameter. |
number(double) |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.10. Get header with a total number of product’s stock levels.
HEAD /{baseSiteId}/products/{productCode}/stock
Description
In the response header, the "x-total-count" indicates the total number of a product’s stock levels. The following two sets of parameters are available: location (required); or longitude (required), and latitude (required).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
productCode |
Product identifier |
string |
Query |
latitude |
Latitude location parameter. |
number(double) |
Query |
location |
Free-text location |
string |
Query |
longitude |
Longitude location parameter. |
number(double) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.27.11. Get a product’s stock level for a store
GET /{baseSiteId}/products/{productCode}/stock/{storeName}
Description
Returns a product’s stock level for a particular store (in other words, for a particular point of sale).
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Path |
storeName |
Store identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.28. Promotions
Promotions Controller
3.28.1. Get a list of promotions.
GET /{baseSiteId}/promotions
Description
Returns promotions defined for a current base site. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
promotionGroup |
Only promotions from this group are returned |
string |
|
Query |
type |
Defines what type of promotions should be returned. Values supported for that parameter are: <ul><li>all: All available promotions are returned</li><li>product: Only product promotions are returned</li><li>order: Only order promotions are returned</li></ul> |
enum (all, product, order) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.28.2. Get a promotion based on code
GET /{baseSiteId}/promotions/{code}
Description
Returns details of a single promotion specified by a promotion code. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Promotion identifier (code) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.29. Return Requests
Order Returns Controller
3.29.1. Create an order return request.
POST /{baseSiteId}/users/{userId}/orderReturns
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
returnRequestEntryInputList |
Return request input list for the current order. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.29.2. Gets the user’s return requests history
GET /{baseSiteId}/users/{userId}/orderReturns
Description
Returns order return request data associated with a specified user for a specified base store.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Query |
sort |
Sorting method applied to the return results. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.29.3. Get the details of a return request.
GET /{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}
Description
Returns specific order return request details based on a specific return request code. The response contains detailed order return request information.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
returnRequestCode |
Order return request code |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.29.4. Updates the order return request.
PATCH /{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}
Description
Updates the order return request. Only cancellation of the request is supported by setting the attribute status to CANCELLING. Cancellation of the return request cannot be reverted
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
returnRequestCode |
Order return request code |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
returnRequestModification |
Return request modification object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.30. Save Cart
Save Cart Controller
3.30.1. Explicitly clones a cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/clonesavedcart
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
description |
The description that should be applied to the cloned cart. |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
name |
The name that should be applied to the cloned cart. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.30.2. Flag a cart for deletion.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/flagForDeletion
Description
Flags a cart for deletion (the cart doesn’t have corresponding save cart attributes anymore). The cart is not actually deleted from the database. But with the removal of the saved cart attributes, this cart will be taken care of by the cart removal job just like any other cart.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.30.3. Restore a saved cart.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/restoresavedcart
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.30.4. Explicitly saves a cart.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/save
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
saveCartDescription |
The description that should be applied to the saved cart. |
string |
|
Query |
saveCartName |
The name that should be applied to the saved cart. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.30.5. Get a saved cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/savedcart
Description
Returns a saved cart for an authenticated user. The cart is identified using the "cartId" parameter.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.31. Search
Transport Search Controller
3.31.1. Searches for all available fares
GET /{baseSiteId}/fares
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
string |
Header |
sap.cx-accept-currency |
Requested Currency for the client |
string |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Query |
arrivalLocation |
The arrival location code |
string |
Query |
arrivalLocationType |
The arrival location type |
string |
Query |
cabinPreference |
The cabin Preference |
string |
Query |
departureDate |
The departure date |
string |
Query |
departureLocation |
The departure location code |
string |
Query |
departureLocationType |
The departure location type |
string |
Query |
displayOrder |
The search prococssing display order |
string |
Query |
passengerType |
The list of passenger types along with the quantitiy |
string |
Query |
returnDate |
The return date |
string |
Query |
saveSearch |
Save the current search |
boolean |
Query |
transportOfferingType |
The Transport Offering Type |
string |
Query |
tripType |
The trip type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.32. Special Services
Special Services Controller
3.32.1. Get a list of available special services.
GET /{baseSiteId}/specialServices
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
3.32.2. Adds the special service requests for the current cart and cart traveller.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
travellerId |
Traveller identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
specialServiceRequestId |
Special service request identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.32.3. Get all special service requests for the current cart and traveller.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
travellerId |
Traveller identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.32.4. Remove the special service requests for the current cart and traveller
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests/{specialServiceRequestId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
specialServiceRequestId |
Special service request identifier (code) |
string |
Path |
travellerId |
Traveller identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.32.5. Get all special service requests for the given orderId and traveller.
GET /{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/specialServiceRequests
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order identifier |
string |
Path |
travellerId |
Traveller identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.33. Stores
Stores Controller
3.33.1. Get a list of store locations
GET /{baseSiteId}/stores
Description
Lists all store locations that are near the location specified in a query or based on latitude and longitude.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
accuracy |
Accuracy in meters. |
number(double) |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
latitude |
Coordinate that specifies the north-south position of a point on the Earth’s surface. |
number(double) |
|
Query |
longitude |
Coordinate that specifies the east-west position of a point on the Earth’s surface. |
number(double) |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Query |
query |
Location in natural language i.e. city or country. |
string |
|
Query |
radius |
Radius in meters. Max value: 40075000.0 (Earth’s perimeter). |
number(double) |
|
Query |
sort |
Sorting method applied to the return results. |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.33.2. Get a header with the number of store locations.
HEAD /{baseSiteId}/stores
Description
In the response header, the "x-total-count" indicates the number of all store locations that are near the location specified in a query, or based on latitude and longitude.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
accuracy |
Accuracy in meters. |
number(double) |
|
Query |
latitude |
Coordinate that specifies the north-south position of a point on the Earth’s surface. |
number(double) |
|
Query |
longitude |
Coordinate that specifies the east-west position of a point on the Earth’s surface. |
number(double) |
|
Query |
query |
Location in natural language i.e. city or country. |
string |
|
Query |
radius |
Radius in meters. Max value: 40075000.0 (Earth’s perimeter). |
number(double) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.33.3. Get a list of store locations for a given country
GET /{baseSiteId}/stores/country/{countryIso}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
countryIso |
Country ISO code |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.33.4. Get a list of store locations for a given country and region
GET /{baseSiteId}/stores/country/{countryIso}/region/{regionIso}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
countryIso |
Country ISO code |
string |
|
Path |
regionIso |
Region ISO code |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.33.5. Gets a store location count per country and regions
GET /{baseSiteId}/stores/storescounts
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.33.6. Get a store location
GET /{baseSiteId}/stores/{storeId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
storeId |
Store identifier (currently store name) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.34. Transport Bundles
Transport Bundles Controller
3.34.1. Get the bundle template
GET /{baseSiteId}/catalogs/{catalogId}/transportBundles/{bundleId}
Description
Returns the information about the transport bundle template with the given id. The response will contain the structure of the bundle alongside with the products.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
bundleId |
Bundle template identifier |
string |
Path |
catalogId |
Catalog identifier |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.35. Transport Carts
Transport Carts Controller
3.35.1. Searches for all available ancillaries
GET /{baseSiteId}/users/{userId}/carts/{cartId}/ancillaries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
transportOfferingCodes |
The transport offerings for which the ancillaries are returned |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity) |
|
500 |
Server Error |
3.35.2. Add ancillary entry to cart
POST /{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
ancillaryEntryRQ |
Request body parameter that contains the details required to perform an add ancillary to cart |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.35.3. Get the details of an ancillary entry.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}
Description
Retrieves the details relative to a ancillary entry such as the unique identifier, price information alongside with an indication about the passengers and transport offerings associated.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryId |
The entry identifier. Each entry in a cart has an entry identifier. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.35.4. Deletes ancillary entry.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryId |
The entry identifier. Each entry in a cart has an entry identifier. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.35.5. Updates the specified fields of an ancillary entry in the cart.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryId |
The entry identifier. Each entry in a cart has an entry identifier. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
ancillaryEntryRQ |
Request body parameter that contains details such as the quantity of product (quantity), and the passenger. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable entity: business rules validation errors, e.g., travel restrictions |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.35.6. Perform the add bundle to cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/bounds
Description
Add a fare bundle having the provided bundleTemplateId and the product with the same fareProductCode, for the bound specified by the originDestinationRefNumberand for each traveller already added in the cart.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
addBundleToCart |
Request body parameter that contains the details required to perform an add bundle to cart. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity) |
|
500 |
Server Error |
3.35.7. Perform the remove bound from cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/bounds/{boundId}
Description
Each bundle or an ancillary added to a bound have abound id mapped to them. Removing a bound will remove all the associated bundles and ancillary for the bound
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
boundId |
The bound id. Each entry of a bound have a bound id mapped to it |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error |
3.35.8. Add seat to cart
POST /{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
seatEntryRQ |
Request body parameter that contains the details required to perform an add seat to cart |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.35.9. Get the details of a seat entry.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries/{entryId}
Description
Retrieves the details relative to a seat entry such as the unique identifier, price information alongside with an indication about the passengers and transport offerings associated.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryId |
The entry identifier. Each entry in a cart has an entry identifier. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.35.10. Deletes seat entry.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries/{entryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryId |
The entry identifier. Each entry in a cart has an entry identifier. |
integer(int32) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.35.11. Gets the seat map
GET /{baseSiteId}/users/{userId}/carts/{cartId}/seatmap
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
transportOfferingCodes |
The codes of transport offerings the seatmap will be returned for orders |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
3.35.12. Add travellers to the given cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/travellers
Description
Add the travellers to the given cart to be used to perform add to cart operations. Those travellers can be considered as an abstraction of the physical people travelling and define the passenger type composition of the booking.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
travellerQuantityList |
Request body parameter that contains passenger types and quantities to be associated. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity) |
|
500 |
Server Error |
3.35.13. Get travellers from the given cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/travellers
Description
Get the travellers from the given cart alongside with the information already provided for all of them.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.35.14. Retrieves the traveller information.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
travellerId |
Traveller identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.35.15. Remove a traveller from a cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
travellerId |
Traveller unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.35.16. Updates the traveller information.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
travellerId |
The traveller identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
saveInProfile |
Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile. |
boolean |
Body |
traveller |
Traveller object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.36. Transport Locations
Transport Locations Controller
3.36.1. Get location suggestions for destination
GET /{baseSiteId}/destinationSuggestions
Description
Get location suggestions for destination. If the origin is specified, it returns all the destinations that have a route for that origin.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Query |
origin |
origin |
string |
Query |
searchText |
searchText |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Unprocessable Entity |
3.36.2. Get location suggestions for origin
GET /{baseSiteId}/originSuggestions
Description
Get location suggestions for origin. If the destination is specified, it returns all the origins that have a route for that destination.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Query |
destination |
destination |
string |
Query |
searchText |
searchText |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Unprocessable Entity |
3.37. Transport Offerings
Transport Offerings Controller
3.37.1. Get transport offerings
GET /{baseSiteId}/transportOfferings
Description
Returns the information about the transport offerings having the given number, departure date and travel provider
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Query |
departureDate |
The departure date |
string |
Query |
transportOfferingNumber |
The transport offering number |
string |
Query |
travelProviderCode |
The travel provider code |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.37.2. Get a transport offering
GET /{baseSiteId}/transportOfferings/{transportOfferingCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
transportOfferingCode |
The transport offering code |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.38. Transport Orders
Transport Orders Controller
3.38.1. Cancels the transport reservation from the given order
POST /{baseSiteId}/users/{userId}/orders/{orderId}/reservations/transportReservation/cancel
Description
Cancel the transport reservation, releasing stocks and triggering refund procedure when applicable
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found) |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.38.2. Get travellers from the given order.
GET /{baseSiteId}/users/{userId}/orders/{orderId}/travellers
Description
Get the travellers from the given order alongside with the information already provided for all of them.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.38.3. Retrieves the traveller information.
GET /{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
travellerId |
Traveller identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.38.4. Get advance passenger information.
GET /{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/advancePassengerInformation
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
travellerId |
Traveller unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
3.38.5. Add advance passenger information
PUT /{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/advancePassengerInformation
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
travellerId |
Traveller unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
advancePassengerInfo |
Advance Passenger Information object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found) |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.38.6. Checks in a traveller
POST /{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/checkin
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
travellerId |
Traveller unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
boundIdentifier |
Specifies the bound the check in will be performed for. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found) |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.38.7. Evaluates if a traveller can be removed from the order
POST /{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/evaluateCancel
Description
Evaluates if a traveller can be removed from the order returning information about the total refund if applicable
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
travellerId |
Traveller unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found) |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.39. Transport Users
Transport Users Controller
3.39.1. Delete customer profile.
DELETE /{baseSiteId}/users/{userId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.39.2. Get saved travellers
GET /{baseSiteId}/users/{userId}/savedSearches
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error |
3.39.3. Removes a saved search.
DELETE /{baseSiteId}/users/{userId}/savedSearches/{savedSearchId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
savedSearchId |
Saved Search Identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.39.4. Get saved travellers
GET /{baseSiteId}/users/{userId}/savedTravellers
Description
Retrieves all the saved travellers for specific user. The response contains detailed traveller information.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error |
3.39.5. Delete a saved traveller
DELETE /{baseSiteId}/users/{userId}/savedTravellers/{travellerId}
Description
Deletes a traveller identified by id from the list of saved travellers for the given user.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
travellerId |
Traveller identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.40. Travel Base Sites
Travel Base Site Controller
3.40.1. Get a list of available currencies.
GET /{baseSiteId}/currencies
Description
Lists all available currencies (all usable currencies for the current store). If the list of currencies for a base store is empty, a list of all currencies available in the system is returned.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.40.2. Get a list of available languages.
GET /{baseSiteId}/languages
Description
Lists all available languages (all languages used for a particular store). If the list of languages for a base store is empty, a list of all languages available in the system will be returned.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
3.41. Travel Carts
Travel Carts Controller
3.41.1. Creates or restore a cart for a user
POST /{baseSiteId}/users/{userId}/carts
Description
Creates a new cart or restores an anonymous cart as a user’s cart (if an old Cart Id is given in the request). In case an order identifier is provided a cart will be created from the given order acting as an amendment cart.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-accept-currency |
Requested Currency for the client |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
fromOrderGuid |
Guest existing order unique identifier |
string |
Query |
fromOrderId |
Existing order unique identifier |
string |
Query |
oldCartId |
Anonymous cart GUID that will replace the user cart. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.41.2. Get the reservation details
GET /{baseSiteId}/users/{userId}/carts/{cartId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.41.3. Deletes a cart with a given cart id.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Unprocessable Entity |
|
500 |
Server Error |
3.41.4. Changes currency against the given cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/currency
Description
Sets the currency specified in the request parameter if allowed and recalculates the cart.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
currencyISO |
The ISO code if the currency to be set |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.41.5. Assigns an email to the cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/email
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
email |
Email of the guest user. It will be used during the checkout process. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.41.6. Get payment options
GET /{baseSiteId}/users/{userId}/carts/{cartId}/paymentOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error |
3.41.7. Defines and assigns details of a new credit card payment to the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
paymentDetails |
Request body parameter that contains details such as the name on the card (accountHolderName), the card number (cardNumber), the card type (cardType.code), the month of the expiry date (expiryMonth), the year of the expiry date (expiryYear), whether the payment details should be saved (saved), whether the payment details should be set as default (defaultPaymentInfo), and the billing address (billingAddress.firstName, billingAddress.lastName, billingAddress.titleCode, billingAddress.country.isocode, billingAddress.line1, billingAddress.line2, billingAddress.town, billingAddress.postalCode, billingAddress.region.isocode) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessable entity: business rules validation errors, e.g., travel restrictions |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.41.8. Sets credit card payment details for the cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
paymentDetailsId |
Payment details identifier. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error |
3.41.9. Validate the cart having all the necessary information to place the order
POST /{baseSiteId}/users/{userId}/carts/{cartId}/validate
Description
Validate the cart having all the necessary information to place the order: Cart is not empty, all the passenger have provided their basic profile details, a payment method is associated with the cart
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.42. Travel Order Search
Travel Order Search Controller
3.42.1. Get the details of a specific booking for a specific owner
GET /{baseSiteId}/orders
Description
Returns the details of the booking having the code passed as a parameter with a specific section for each part of the journey. The booking must be associated to the customer having the specified last name. In case additional security has been activated the traveller reference must be passed to retrieve a specific subset of information for the specific traveller.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Query |
lastName |
The customer last name |
string |
Query |
orderId |
The booking reference |
string |
Query |
travellerReference |
The traveller reference |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
3.43. Travel Orders
Travel Orders Controller
3.43.1. Place a travel order
POST /{baseSiteId}/users/{userId}/orders
Description
Validates the consistency of the cart and when successful persist the booking into the system.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
placeOrderRequest |
Request body parameter that contains the details required to perform the place order. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Not Found |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.43.2. Get the booking list for user
GET /{baseSiteId}/users/{userId}/orders
Description
Returns a list with the details of bookings for the given user. The level of information returned is configured via field attribute. The list can be also paginated.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
activeOnly |
When true only the active booking will be returned |
boolean |
|
Query |
currentPage |
Assuming the response arranged in pages, it represents the number of the page to be returned |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
Assuming the response arranged in pages, it represents the number of results to be returned for every page |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
3.43.3. Get the booking details
GET /{baseSiteId}/users/{userId}/orders/{code}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
code |
Order unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.43.4. Cancels the entire order
POST /{baseSiteId}/users/{userId}/orders/{orderId}/cancel
Description
Cancel the entire order, releasing stocks and triggering refund procedure when applicable
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.43.5. Evaluates the cancellation of the entire order
POST /{baseSiteId}/users/{userId}/orders/{orderId}/evaluateCancel
Description
Evaluates if the entire booking can be cancelled, returning information about total refunded amount
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
sap.cx-sales-application |
The sales application code |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
orderId |
Order unique identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
201 |
Created |
No Content |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
422 |
Unprocessable Entity |
|
500 |
Server Error: unexpected condition that prevented it from fulfilling the request |
3.44. Travel Users
Travel Users Controller
3.44.1. Registers a customer
POST /{baseSiteId}/users
Description
Registers a customer. Requires the following parameters: login, password, firstName, lastName, titleCode.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Body |
user |
User’s object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error |
3.44.2. Get customer profile
GET /{baseSiteId}/users/{userId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Languages the client is able to understand, and which locale variant is preferred |
< string > array(multi) |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Server Error |
3.44.3. Updates customer profile
PATCH /{baseSiteId}/users/{userId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
user |
User’s object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
422 |
Unprocessable Entity |
|
500 |
Server Error |
3.44.4. Changes customer’s login name.
PUT /{baseSiteId}/users/{userId}/login
Description
Changes a customer’s login name, the email by default. Requires the customer’s current password.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
newLogin |
Customer’s new login name. Customer login is case insensitive. |
string |
Query |
password |
Customer’s current password. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error |
3.44.5. Changes user’s password
PUT /{baseSiteId}/users/{userId}/password
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
newPassword |
New password. |
string |
Query |
oldPassword |
Old password. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
204 |
No Content |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
500 |
Server Error |
3.45. Users
Users Controller
3.45.1. Updates customer profile
PUT /{baseSiteId}/users/{userId}
Description
Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
user |
User’s object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.45.2. Get all customer groups of a customer.
GET /{baseSiteId}/users/{userId}/customergroups
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.46. Vouchers
Vouchers Controller
3.46.1. Get a voucher based on code.
GET /{baseSiteId}/vouchers/{code}
Description
Returns details of a single voucher that is specified by its voucher identification code.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Voucher identifier (code) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
4. Definitions
4.1. AccommodationCategory
| Name | Schema |
|---|---|
categoryType |
string |
code |
string |
image |
|
name |
string |
4.3. AccommodationInfo
| Name | Schema |
|---|---|
accommodationName |
string |
cardinality |
integer(int32) |
4.4. AccommodationOfferingDetails
| Name | Schema |
|---|---|
dataReference |
|
propertyInfo |
|
roomStays |
< RoomStay > array |
4.5. AccommodationOfferingDetailsDataReference
| Name | Schema |
|---|---|
amenities |
< Amenity > array |
brands |
< Brand > array |
cancelPenalties |
< CancelPenalty > array |
chains |
< Chain > array |
facilities |
< AccommodationFacility > array |
guarantees |
< Guarantee > array |
locations |
< Location > array |
occupancies |
< GuestOccupancy > array |
4.6. AccommodationProduct
| Name | Schema |
|---|---|
categories |
< Category > array |
code |
string |
description |
string |
images |
< Image > array |
name |
string |
4.7. AccommodationProductRestriction
| Name | Schema |
|---|---|
addToCartCriteria |
string |
maxQuantity |
integer(int32) |
minQuantity |
integer(int32) |
4.8. AccommodationReservation
| Name | Schema |
|---|---|
accommodationOfferingCode |
string |
accommodationOfferingName |
string |
bookingStatus |
|
dataReferences |
|
location |
|
roomStays |
< ReservedRoomStay > array |
totalPaid |
|
totalRate |
|
totalRefunded |
|
totalToPay |
4.9. AccommodationSearchResponse
| Name | Schema |
|---|---|
dataReference |
|
paginationInfo |
|
properties |
< Property > array |
searchInfo |
4.10. AccommodationService
| Name | Schema |
|---|---|
basePrice |
|
inclusive |
boolean |
product |
|
quantityAlreadyInCart |
integer(int32) |
ratePlanCode |
string |
restriction |
4.11. AccommodationServiceEntryResponse
| Name | Schema |
|---|---|
basePrice |
|
discounts |
< Discount > array |
entryId |
integer(int32) |
productCode |
string |
quantity |
integer(int32) |
roomStayReferenceNumber |
integer(int32) |
taxes |
< Tax > array |
totalPrice |
4.12. AccommodationSuggestion
| Name | Schema |
|---|---|
code |
string |
locationType |
string |
name |
string |
position |
|
radius |
integer(int32) |
suggestionType |
string |
4.13. AccommodationSuggestionList
| Name | Schema |
|---|---|
suggestions |
< AccommodationSuggestion > array |
4.14. AddBoundToCartRequest
| Name | Schema |
|---|---|
bundleTemplateId |
string |
fareProductCode |
string |
originDestinationRefNumber |
integer(int32) |
transportOfferingCodes |
< string > array |
travelRouteCode |
string |
4.15. AddDealBoundToCart
| Name | Schema |
|---|---|
fareProductCode |
string |
originDestinationRefNumber |
integer(int32) |
transportOfferingCodes |
< string > array |
4.16. AddDealToCart
| Name | Schema |
|---|---|
bounds |
< AddDealBoundToCart > array |
dealId |
string |
departureDate |
string |
4.17. AddPackageToCartRequest
| Name | Schema |
|---|---|
bounds |
< AddBoundToCartRequest > array |
roomStays |
< AddRoomStayToCartRequest > array |
travellers |
< TravellerQuantity > array |
4.18. AddRoomStayToCartRequest
| Name | Schema |
|---|---|
accommodationCode |
string |
accommodationOfferingCode |
string |
checkInDate |
string |
checkOutDate |
string |
ratePlanCode |
string |
4.19. AddServiceEntryRequest
| Name | Schema |
|---|---|
productCode |
string |
quantity |
integer(int64) |
roomStayRefNumber |
integer(int32) |
4.20. Address
Request body fields required and optional to operate on address data. The DTO is in XML or .json format
| Name | Description | Schema |
|---|---|---|
cellphone |
Cellphone number |
string |
companyName |
Company Name |
string |
country |
Country where address is located |
|
defaultAddress |
Boolean flag if address is default |
boolean |
district |
District name |
string |
email |
Email address |
string |
firstName |
First name of the address person |
string |
formattedAddress |
Boolean flag if address is formatted |
string |
id |
Unique id value of the address which is optional while creating new address. While performing other address operations this value is the key |
string |
lastName |
Last name of the address person |
string |
line1 |
First line of the address |
string |
line2 |
Second line of the address |
string |
phone |
Phone number |
string |
postalCode |
Postal code of the address |
string |
region |
Region where address belongs to |
|
shippingAddress |
Boolean flag if address is for shipping |
boolean |
title |
Title of the address person |
string |
titleCode |
Code of the title |
string |
town |
Town, field required |
string |
visibleInAddressBook |
Boolean flag if address is visible in the Address Book |
boolean |
4.21. AddressList
| Name | Schema |
|---|---|
addresses |
< Address > array |
4.22. AddressValidation
Representation of an Address Validation
| Name | Description | Schema |
|---|---|---|
decision |
Decision |
string |
errors |
List of errors |
|
suggestedAddresses |
List of suggested addresses |
< Address > array |
4.23. AdvancePassengerInformation
| Name | Schema |
|---|---|
countryOfIssue |
|
dateOfBirth |
string |
documentNumber |
string |
documentType |
|
expiryDate |
string |
gender |
|
nationality |
4.25. Ancillary
| Name | Schema |
|---|---|
passengerRefUids |
< string > array |
prices |
< AncillaryPricesResponse > array |
product |
|
transportOfferingRefCodes |
< string > array |
travelRestriction |
|
travelRouteRefCode |
string |
4.26. AncillaryDataReference
| Name | Schema |
|---|---|
passengers |
< BasicTraveller > array |
transportOfferings |
< Transport > array |
4.27. AncillaryEntry
Representation of an ancillary entry
| Name | Description | Schema |
|---|---|---|
basePrice |
Base price of order entry item |
|
discounts |
Discounts of order entry item |
< Discount > array |
entryId |
Entry identifier of the order entry |
integer(int32) |
passengers |
Passengers codes in order entry |
< string > array |
productCode |
Product code of ancillary entry |
string |
quantity |
Quantity number of items in order entry |
integer(int32) |
taxes |
Taxes of order entry item |
< Tax > array |
totalPrice |
Total price of order entry item |
|
transportOfferingCodes |
Transport offering codes in order entry |
< string > array |
4.28. AncillaryEntryRequest
| Name | Schema |
|---|---|
productCode |
string |
quantity |
integer(int32) |
transportOfferingCodes |
< string > array |
travelRouteCode |
string |
travellers |
< string > array |
4.29. AncillaryPricesResponse
| Name | Schema |
|---|---|
basePrice |
|
discounts |
|
taxes |
< Tax > array |
4.30. AncillaryResponse
| Name | Schema |
|---|---|
ancillaries |
< Ancillary > array |
dataReferences |
4.31. Award
| Name | Schema |
|---|---|
additionalInfo |
string |
rating |
number(double) |
type |
string |
4.32. BaseOption
Representation of a Base Ooption
| Name | Description | Schema |
|---|---|---|
options |
List of all variant options |
< VariantOption > array |
selected |
Variant option selected |
|
variantType |
Variant type of base option |
string |
4.33. BaseSite
Representation of a Base Site
| Name | Description | Schema |
|---|---|---|
channel |
Channel |
string |
defaultLanguage |
Default language for Basesite |
|
defaultPreviewCatalogId |
Default preview catalog id |
string |
defaultPreviewCategoryCode |
Default preview category code |
string |
defaultPreviewProductCode |
Default preview product code |
string |
locale |
Locale data for Basesite |
string |
name |
Name of Basesite |
string |
stores |
List of Basestores |
< BaseStore > array |
theme |
Theme of Basesite |
string |
uid |
Unique identifier of Basesite |
string |
urlEncodingAttributes |
List of url encoding attributes |
< string > array |
urlPatterns |
List of url patterns |
< string > array |
4.34. BaseSiteList
Representation of a Base Site List
| Name | Description | Schema |
|---|---|---|
baseSites |
List of basesites |
< BaseSite > array |
4.35. BaseStore
Representation of a Base Store
| Name | Description | Schema |
|---|---|---|
createReturnProcessCode |
Create return process code |
string |
currencies |
List of currencies |
< Currency > array |
defaultCurrency |
Default currency |
|
defaultDeliveryOrigin |
Point of service being default delivery origin |
|
defaultLanguage |
Default language |
|
deliveryCountries |
List of delivery countries |
< Country > array |
deliveryModes |
List of delivery modes |
|
expressCheckoutEnabled |
Flag specifying whether the express checkout option is enabled |
boolean |
externalTaxEnabled |
Flag defining is external tax is enabled |
boolean |
languages |
List of languages |
< Language > array |
maxRadiusForPosSearch |
Maximum radius for searching point of service |
number(double) |
name |
Base store name |
string |
paymentProvider |
Payment provider |
string |
pointsOfService |
List of points of service |
< PointOfService > array |
submitOrderProcessCode |
Submit order process code |
string |
4.36. BasicProduct
| Name | Schema |
|---|---|
categories |
< Category > array |
code |
string |
name |
string |
4.41. Breadcrumb
Representation of a Breadcrumb
| Name | Description | Schema |
|---|---|---|
facetCode |
Code of the facet |
string |
facetName |
Name of the facet |
string |
facetValueCode |
Value code of the facet |
string |
facetValueName |
Value name of the facet |
string |
removeQuery |
Remove query |
|
truncateQuery |
Truncate query |
4.42. Cabin
| Name | Schema |
|---|---|
cabinClass |
|
cabinName |
string |
endingRow |
integer(int32) |
rowInfo |
< RowInfo > array |
seatAvailability |
< SeatAvailability > array |
startingRow |
integer(int32) |
upperDeckIndicator |
boolean |
4.44. CancelPenalty
| Name | Schema |
|---|---|
absoluteDeadline |
string |
code |
string |
fixedAmount |
number(double) |
formattedDescription |
string |
percentageAmount |
number(double) |
relativeDeadlineInHours |
integer(int32) |
4.45. CancelPenaltyList
| Name | Schema |
|---|---|
cancelPenalties |
< CancelPenalty > array |
4.46. CancellationRequestEntryInput
Representation of a cancellation request entry input for an order
| Name | Description | Schema |
|---|---|---|
orderEntryNumber |
Order entry number of the cancelled product |
integer(int32) |
quantity |
Quantity of the product which belongs to the order entry and is requested to be cancelled |
integer(int64) |
4.47. CancellationRequestEntryInputList
Representation of a cancellation request entry input list for an order
| Name | Description | Schema |
|---|---|---|
cancellationRequestEntryInputs |
Cancellation request entry inputs which contain information about the order entries which are requested to be cancelled |
< CancellationRequestEntryInput > array |
4.48. CardType
Representation of a Card Type
| Name | Description | Schema |
|---|---|---|
code |
Card type code |
string |
name |
Card type name |
string |
4.49. CardTypeList
Representation of a Card Type List
| Name | Description | Schema |
|---|---|---|
cardTypes |
List of card types |
< CardType > array |
4.50. Cart
Representation of a Cart
| Name | Description | Schema |
|---|---|---|
appliedOrderPromotions |
List of applied order promotions |
< PromotionResult > array |
appliedProductPromotions |
List of applied product promotions |
< PromotionResult > array |
appliedVouchers |
List of applied vouchers |
< Voucher > array |
calculated |
Flag showing if order is calculated |
boolean |
code |
Code number of order |
string |
deliveryAddress |
Delivery address |
|
deliveryCost |
Delivery cost |
|
deliveryItemsQuantity |
Quantity of delivery items |
integer(int64) |
deliveryMode |
Delivery mode information |
|
deliveryOrderGroups |
List of delivery order entries group |
< DeliveryOrderEntryGroup > array |
description |
Description of the cart |
string |
entries |
List of order entries |
< OrderEntry > array |
entryGroups |
List of entry groups |
< EntryGroup > array |
expirationTime |
Date of cart expiration time |
string(date-time) |
guid |
Guest user id identifier |
string |
name |
Name of the cart |
string |
net |
Flag stating iv value is net-value |
boolean |
orderDiscounts |
Order discounts |
|
paymentInfo |
Payment information |
|
pickupItemsQuantity |
Quantity of pickup items |
integer(int64) |
pickupOrderGroups |
List of pickup order entry group |
< PickupOrderEntryGroup > array |
potentialOrderPromotions |
List of potential order promotions for cart |
< PromotionResult > array |
potentialProductPromotions |
List of potential product promotions for cart |
< PromotionResult > array |
productDiscounts |
Product discounts |
|
saveTime |
Date of saving cart |
string(date-time) |
savedBy |
Information about person who saved cart |
|
site |
Site |
string |
store |
Store |
string |
subTotal |
Subtotal price |
|
totalDiscounts |
Total discounts |
|
totalItems |
integer(int32) |
|
totalPrice |
Total price value |
|
totalPriceWithTax |
Total price with tax |
|
totalTax |
Total tax price |
|
totalUnitCount |
Total unit count |
integer(int32) |
user |
User information |
4.51. CartList
Representation of a Cart list
| Name | Description | Schema |
|---|---|---|
carts |
List of carts |
< Cart > array |
4.52. CartModification
Representation of a Cart modification
| Name | Description | Schema |
|---|---|---|
deliveryModeChanged |
Delivery mode changed |
boolean |
entry |
Order entry |
|
quantity |
Final quantity after cart modification |
integer(int64) |
quantityAdded |
Quantity added with cart modification |
integer(int64) |
statusCode |
Status code of cart modification |
string |
statusMessage |
Status message |
string |
4.53. Catalog
Representation of an Catalog
| Name | Description | Schema |
|---|---|---|
catalogVersions |
List of versions of catalog |
< CatalogVersion > array |
id |
Identifier of abstract catalog item |
string |
lastModified |
Date of last modification |
string(date-time) |
name |
Name of abstract catalog item |
string |
url |
Url address of abstract catalog item |
string |
4.54. CatalogList
Representation of a Catalog List
| Name | Description | Schema |
|---|---|---|
catalogs |
List of catalog items |
< Catalog > array |
4.55. CatalogVersion
Representation of a Catalog Version
| Name | Description | Schema |
|---|---|---|
categories |
List of category hierarchies |
< CategoryHierarchy > array |
id |
Identifier of abstract catalog item |
string |
lastModified |
Date of last modification |
string(date-time) |
name |
Name of abstract catalog item |
string |
url |
Url address of abstract catalog item |
string |
4.57. CategoryHierarchy
Representation of a Category Hierarchy
| Name | Description | Schema |
|---|---|---|
id |
Identifier of abstract catalog item |
string |
lastModified |
Date of last modification |
string(date-time) |
name |
Name of abstract catalog item |
string |
subcategories |
List of subcategory hierarchies |
< CategoryHierarchy > array |
url |
Url address of abstract catalog item |
string |
4.59. Classification
Representation of a Classification
| Name | Description | Schema |
|---|---|---|
code |
Code of the classification |
string |
features |
List of features for given classification |
< Feature > array |
name |
Name of the classification |
string |
4.61. ConfigurationInfo
Representation of a Configuration Info
| Name | Description | Schema |
|---|---|---|
configurationLabel |
Label of configuration info |
string |
configurationValue |
Value of configuration info |
string |
configuratorType |
Type of configuration info |
string |
status |
Status of configuration info |
string |
4.62. ConfiguredRate
| Name | Schema |
|---|---|
accommodationInfos |
< AccommodationInfo > array |
dayRates |
< DayRate > array |
totalDiscount |
|
totalRate |
4.63. Consent
Representation of a Consent
| Name | Description | Schema |
|---|---|---|
code |
Code of consent |
string |
consentGivenDate |
Date of consenting |
string(date-time) |
consentWithdrawnDate |
Consent withdrawn date |
string(date-time) |
4.64. ConsentTemplate
Representation of a Consent Template
| Name | Description | Schema |
|---|---|---|
currentConsent |
Current consent |
|
description |
Consent template description |
string |
id |
Consent template identifier |
string |
name |
Consent template name |
string |
version |
Consent template version |
integer(int32) |
4.65. ConsentTemplateList
Representation of a Consent Template List
| Name | Description | Schema |
|---|---|---|
consentTemplates |
List of consent templates |
< ConsentTemplate > array |
4.66. Consignment
Representation of a Consignment
| Name | Description | Schema |
|---|---|---|
code |
Consignment code |
string |
deliveryPointOfService |
Delivery point of service |
|
entries |
List of consignment entries |
< ConsignmentEntry > array |
shippingAddress |
Shipping address |
|
status |
Consignment status |
string |
statusDate |
Consignment status date |
string(date-time) |
statusDisplay |
Consignment status display |
string |
trackingID |
Consignment tracking identifier |
string |
4.67. ConsignmentEntry
Representation of a Consignment Entry
| Name | Description | Schema |
|---|---|---|
orderEntry |
Order entry of Consignment entry |
|
quantity |
Quantity value of Consignment entry |
integer(int64) |
shippedQuantity |
Shipped quantity |
integer(int64) |
4.69. Country
Response body fields which will be returned while fetching the list of countries. The DTO is in XML or .json format
| Name | Description | Schema |
|---|---|---|
isocode |
Country code in iso format |
string |
name |
Name of the country |
string |
4.70. CountryList
List of countries
| Name | Description | Schema |
|---|---|---|
countries |
This is the list of Country fields that should be returned in the response body |
< Country > array |
4.71. Currency
Representation of a Currency
| Name | Description | Schema |
|---|---|---|
active |
Boolean flag whether currency is active |
boolean |
isocode |
Code of the currency in iso format |
string |
name |
Name of the currency |
string |
symbol |
Symbol of the currency |
string |
4.72. CurrencyList
Representation of a Currency List
| Name | Description | Schema |
|---|---|---|
currencies |
List of currencies |
< Currency > array |
4.73. CustomerReview
| Name | Schema |
|---|---|
accommodationName |
string |
comment |
string |
date |
string |
headline |
string |
id |
string |
rating |
number(double) |
userId |
string |
4.74. CustomerReviewList
| Name | Schema |
|---|---|
customerReviews |
< CustomerReview > array |
4.75. CustomerReviewRequest
| Name | Schema |
|---|---|
comment |
string |
headline |
string |
rating |
number(double) |
4.76. DataReferences
| Name | Schema |
|---|---|
amenities |
< Amenity > array |
brands |
< Brand > array |
chains |
< Chain > array |
locations |
< Location > array |
4.78. DayRate
| Name | Schema |
|---|---|
dailyBaseRate |
|
dailyTotalDiscount |
|
dailyTotalRate |
|
dateOfStay |
string |
4.80. DealCategoryList
| Name | Schema |
|---|---|
categories |
< DealCategory > array |
4.81. DealDetailsResponse
| Name | Schema |
|---|---|
additionalProducts |
< DealProduct > array |
dataReferences |
|
dealId |
string |
pricedItineraries |
< PricedItinerary > array |
property |
|
roomStays |
< RoomStay > array |
4.82. DealProduct
| Name | Schema |
|---|---|
basePrice |
|
code |
string |
discounts |
< Discount > array |
name |
string |
quantity |
integer(int32) |
taxes |
< Tax > array |
totalPrice |
4.83. DealSearchResponse
| Name | Schema |
|---|---|
deals |
< DealDetailsResponse > array |
4.84. DeliveryMode
Representation of a Delivery mode
| Name | Description | Schema |
|---|---|---|
code |
Code of the delivery mode |
string |
deliveryCost |
Cost of the delivery |
|
description |
Description of the delivery mode |
string |
name |
Name of the delivery mode |
string |
4.85. DeliveryModeList
Representation of a Delivery mode list
| Name | Description | Schema |
|---|---|---|
deliveryModes |
List of delivery modes |
< DeliveryMode > array |
4.86. DeliveryOrderEntryGroup
Representation of a Delivery Order Entry Group
| Name | Description | Schema |
|---|---|---|
deliveryAddress |
Delivery address for order entry group |
|
entries |
List of order entries |
< OrderEntry > array |
quantity |
Quantity of order entries in a group |
integer(int64) |
totalPriceWithTax |
Total price with tax |
4.89. EntryGroup
Representation of an Entry Group
| Name | Description | Schema |
|---|---|---|
entries |
List of order entries |
< OrderEntry > array |
entryGroupNumber |
Identifier of the entry group |
integer(int32) |
entryGroups |
List of child entry groups |
< EntryGroup > array |
erroneous |
Indicates if the entry group is in an error state |
boolean |
label |
Label for the entry group |
string |
type |
Indicates type of the group, possible values are STANDALONE, CONFIGURABLEBUNDLE or any customer implemented type for any new provider |
string |
4.90. EvaluateCancelBookingResponse
| Name | Schema |
|---|---|
accommodationReservation |
|
transportReservation |
4.92. EvaluateStayDatesResponse
| Name | Schema |
|---|---|
amountToPay |
|
amountToRefund |
|
totalAmount |
4.93. Facet
Representation of a Facet
| Name | Description | Schema |
|---|---|---|
category |
Flag stating if facet is category facet |
boolean |
multiSelect |
Flag stating if facet is multiSelect |
boolean |
name |
Name of the facet |
string |
priority |
Priority value of the facet |
integer(int32) |
topValues |
List of top facet values |
< FacetValue > array |
values |
List of all facet values |
< FacetValue > array |
visible |
Flag stating if facet is visible |
boolean |
4.94. FacetValue
Representation of a Facet Value
| Name | Description | Schema |
|---|---|---|
count |
Count of the facet value |
integer(int64) |
name |
Name of the facet value |
string |
query |
Query of the facet value |
|
selected |
Flag stating if facet value is selected |
boolean |
4.95. FareDetails
| Name | Schema |
|---|---|
discount |
|
fareBasisCode |
string |
fareProduct |
|
tripType |
enum (SINGLE, RETURN, MULTICITY, OPEN_JAW) |
4.96. FareInfo
| Name | Schema |
|---|---|
destinationRefCode |
string |
fareDetails |
< FareDetails > array |
originRefCode |
string |
4.97. FarePricingInfo
| Name | Schema |
|---|---|
bundleType |
|
ptcFareBreakdowns |
< PTCFareBreakdown > array |
4.98. FareProduct
| Name | Schema |
|---|---|
bookingClass |
string |
categories |
< Category > array |
code |
string |
fareBasisCode |
string |
name |
string |
selected |
boolean |
4.99. FareSelection
| Name | Schema |
|---|---|
dataReferences |
|
pricedItineraries |
< PricedItinerary > array |
4.100. FareSelectionDataReferences
| Name | Schema |
|---|---|
locations |
< Location > array |
transportFacilities |
< TransportFacility > array |
transportOfferings |
< TransportOffering > array |
travelRoutes |
< TravelRoute > array |
travelSectors |
< TravelSector > array |
4.101. Feature
Representation of a Feature
| Name | Description | Schema |
|---|---|---|
code |
Code of the feature |
string |
comparable |
Flag defining it feature is comparable |
boolean |
description |
Description of the feature |
string |
featureUnit |
Feature unit |
|
featureValues |
List of feature values |
< FeatureValue > array |
name |
Name of the feature |
string |
range |
Range number of the reature |
boolean |
type |
Type of the feature |
string |
4.102. FeatureUnit
Representation of a Feature Unit
| Name | Description | Schema |
|---|---|---|
name |
Name of the feature unit |
string |
symbol |
Symbol of the feature unit |
string |
unitType |
Type of the feature unit |
string |
4.103. FeatureValue
Representation of a Feature Value
| Name | Description | Schema |
|---|---|---|
value |
Value of the feature |
string |
4.105. FutureStock
Representation of a Future Stock
| Name | Description | Schema |
|---|---|---|
date |
Date of future stock |
string(date-time) |
formattedDate |
Date of future stock expressed in text value |
string |
stock |
Stock information of future stock |
4.106. GeoPoint
Representation of a GeoPoint
| Name | Description | Schema |
|---|---|---|
latitude |
Geopoint latitude |
number(double) |
longitude |
Geopoint longitude |
number(double) |
4.107. GlobalTravelReservation
| Name | Schema |
|---|---|
accommodationReservation |
|
bookingStatusCode |
string |
bookingStatusName |
string |
orderGUID |
string |
orderId |
string |
placedByGuest |
boolean |
transportReservation |
4.108. GlobalTravelReservationList
| Name | Schema |
|---|---|
pagination |
|
reservations |
< GlobalTravelReservation > array |
4.109. Guarantee
| Name | Schema |
|---|---|
absoluteDeadline |
string |
code |
string |
fixedAmount |
number(double) |
longDescription |
string |
percentageAmount |
number(double) |
relativeDeadlineInHours |
integer(int32) |
shortDescription |
string |
typeRefCode |
string |
4.110. GuaranteeList
| Name | Schema |
|---|---|
guarantees |
< Guarantee > array |
4.111. GuestOccupancy
| Name | Schema |
|---|---|
code |
string |
guestType |
|
quantityMax |
integer(int32) |
quantityMin |
integer(int32) |
4.114. Itinerary
| Name | Schema |
|---|---|
duration |
string |
originDestinationOptions |
< OriginDestinationOption > array |
travelRouteRefCode |
string |
tripType |
string |
4.115. ItineraryPricingInfo
| Name | Schema |
|---|---|
available |
boolean |
commercialBundleName |
string |
commercialBundleType |
string |
fareBundleTemplateId |
string |
itineraryIdentifier |
string |
promotional |
boolean |
ptcFareBreakdownDatas |
< PTCFareBreakdown > array |
selected |
boolean |
totalFare |
4.116. Language
Representation of a Language
| Name | Description | Schema |
|---|---|---|
active |
true/false indicator when the language is active |
boolean |
isocode |
iso code of the language |
string |
name |
name of the language |
string |
nativeName |
name the language in native form |
string |
4.117. LanguageList
| Name | Schema |
|---|---|
languages |
< Language > array |
4.118. LeadGuest
| Name | Schema |
|---|---|
arrivalTime |
string |
contactNumber |
string |
email |
string |
firstName |
string |
guestTypeQuantities |
< TravellerQuantity > array |
lastName |
string |
4.119. Location
| Name | Schema |
|---|---|
code |
string |
name |
string |
position |
|
type |
enum (CITY, REGION, COUNTRY, CONTINENT, AIRPORTGROUP, PROPERTY) |
4.120. MemberList
Representation of a Member List
| Name | Description | Schema |
|---|---|---|
members |
List of member |
< Principal > array |
4.121. OfferPricingInfo
| Name | Schema |
|---|---|
bookingBreakdown |
|
bundleIndicator |
integer(int32) |
entryId |
integer(int32) |
product |
|
travelRestriction |
|
travellerBreakdowns |
< TravellerBreakdown > array |
4.122. OpeningSchedule
Representation of an Opening schedule
| Name | Description | Schema |
|---|---|---|
code |
Code of the opening schedule |
string |
name |
Name of the opening schedule |
string |
specialDayOpeningList |
List of special opening days |
< SpecialOpeningDay > array |
weekDayOpeningList |
List of weekday opening days |
< WeekdayOpeningDay > array |
4.123. Order
Representation of an Order
| Name | Description | Schema |
|---|---|---|
appliedOrderPromotions |
List of applied order promotions |
< PromotionResult > array |
appliedProductPromotions |
List of applied product promotions |
< PromotionResult > array |
appliedVouchers |
List of applied vouchers |
< Voucher > array |
calculated |
Flag showing if order is calculated |
boolean |
cancellable |
Boolean flag showing if order is cancellable |
boolean |
code |
Code number of order |
string |
consignments |
List of consignment |
< Consignment > array |
created |
Date of order creation |
string(date-time) |
deliveryAddress |
Delivery address |
|
deliveryCost |
Delivery cost |
|
deliveryItemsQuantity |
Quantity of delivery items |
integer(int64) |
deliveryMode |
Delivery mode information |
|
deliveryOrderGroups |
List of delivery order entries group |
< DeliveryOrderEntryGroup > array |
deliveryStatus |
Order delivery status |
string |
deliveryStatusDisplay |
Order delivery status display |
string |
entries |
List of order entries |
< OrderEntry > array |
entryGroups |
List of entry groups |
< EntryGroup > array |
guestCustomer |
Flag showing if customer is Guest customer |
boolean |
guid |
Guest user id identifier |
string |
net |
Flag stating iv value is net-value |
boolean |
orderDiscounts |
Order discounts |
|
paymentInfo |
Payment information |
|
pickupItemsQuantity |
Quantity of pickup items |
integer(int64) |
pickupOrderGroups |
List of pickup order entry group |
< PickupOrderEntryGroup > array |
productDiscounts |
Product discounts |
|
returnable |
Boolean flag showing if order is returnable |
boolean |
site |
Site |
string |
status |
Status of order |
string |
statusDisplay |
Status display |
string |
store |
Store |
string |
subTotal |
Subtotal price |
|
totalDiscounts |
Total discounts |
|
totalItems |
integer(int32) |
|
totalPrice |
Total price value |
|
totalPriceWithTax |
Total price with tax |
|
totalTax |
Total tax price |
|
unconsignedEntries |
List of unconsigned order entries |
< OrderEntry > array |
user |
User information |
4.124. OrderEntry
Representation of an Order entry
| Name | Description | Schema |
|---|---|---|
basePrice |
Base price of order entry item |
|
cancellableQuantity |
Quantity number of cancellable items in order entry |
integer(int64) |
cancelledItemsPrice |
Total price of cancelled items which belong to the order entry item |
|
configurationInfos |
Configuration info of order entry |
< ConfigurationInfo > array |
deliveryMode |
Delivery mode |
|
deliveryPointOfService |
Point of service associated with order entry |
|
entryNumber |
Entry number of the order entry |
integer(int32) |
product |
Product details of order entry |
|
quantity |
Quantity number of items in order entry |
integer(int64) |
returnableQuantity |
Quantity number of returnable items in order entry |
integer(int64) |
returnedItemsPrice |
Total price of returned items which belong to the order entry item |
|
statusSummaryList |
List of aggregated status information per entry, relevant if the entry is configurable and its configuration contains one or many issues in different severities. Note that configurators typically raise such issues only in case the parent document is changeable. In this case the issues (depending on their severity) need to be fixed before a checkout can be done. This means this segment can be present for a cart entry, for order entries it will always be empty |
< StatusSummary > array |
totalPrice |
Total price of order entry item |
|
updateable |
Flag defining if order entry item is updateable |
boolean |
4.125. OrderEntryList
Representation of an Order entry list consumed
| Name | Description | Schema |
|---|---|---|
orderEntries |
List of order entries |
< OrderEntry > array |
4.126. OrderStatusUpdateElement
Representation of an Order Status Update Element
| Name | Description | Schema |
|---|---|---|
baseSiteId |
BaseSite identifier |
string |
code |
Code of update element of order status |
string |
status |
Status of update element |
string |
4.127. OrderStatusUpdateElementList
Representation of an Order Status Update Element List
| Name | Description | Schema |
|---|---|---|
orderStatusUpdateElements |
List of order status update elements |
< OrderStatusUpdateElement > array |
4.128. OriginDestinationOfferInfo
| Name | Schema |
|---|---|
offerPricingInfos |
< OfferPricingInfo > array |
transportOfferingsRefCodes |
< string > array |
4.129. OriginDestinationOption
| Name | Schema |
|---|---|
originDestinationRefNumber |
integer(int32) |
transportOfferingsRefCodes |
< string > array |
travelRouteRefCode |
string |
4.130. PTCFareBreakdown
| Name | Schema |
|---|---|
fareInfos |
< FareInfo > array |
passengerFare |
|
passengerTypeQuantity |
4.131. PackageDataReferences
| Name | Schema |
|---|---|
amenities |
< Amenity > array |
brands |
< Brand > array |
chains |
< Chain > array |
locations |
< Location > array |
transportFacilities |
< TransportFacility > array |
transportOfferings |
< TransportOffering > array |
travelRoutes |
< TravelRoute > array |
travelSectors |
< TravelSector > array |
4.132. PackageDetailsDataReference
| Name | Schema |
|---|---|
amenities |
< Amenity > array |
brands |
< Brand > array |
cancelPenalties |
< CancelPenalty > array |
chains |
< Chain > array |
facilities |
< AccommodationFacility > array |
guarantees |
< Guarantee > array |
locations |
< Location > array |
occupancies |
< GuestOccupancy > array |
transportFacilities |
< TransportFacility > array |
transportOfferings |
< TransportOffering > array |
travelRoutes |
< TravelRoute > array |
travelSectors |
< TravelSector > array |
4.133. PackageDetailsResponse
| Name | Schema |
|---|---|
dataReference |
|
pricedItineraries |
< PricedItinerary > array |
property |
|
roomStays |
< RoomStay > array |
4.134. PackageSearchResponse
| Name | Schema |
|---|---|
dataReference |
|
packageSolutions |
< PackageSolutions > array |
paginationInfo |
|
pricedItineraries |
< PricedItinerary > array |
properties |
< Property > array |
4.135. PackageSolutions
| Name | Schema |
|---|---|
accommodationOfferingRefCode |
string |
pricedItineraries |
< PricedItineraryReference > array |
4.136. PassengerFare
| Name | Schema |
|---|---|
baseFare |
|
discounts |
< Discount > array |
fees |
< Fee > array |
perPax |
|
taxes |
< Tax > array |
totalFare |
|
wasRate |
4.138. PaymentDetails
Representation of a Payment Details
| Name | Description | Schema |
|---|---|---|
accountHolderName |
Name of account holder |
string |
billingAddress |
Address details to be considered as billing address |
|
cardNumber |
Payment card number |
string |
cardType |
Type of payment card |
|
defaultPayment |
Flag to mark if payment the default one |
boolean |
expiryMonth |
Month of expiration of payment |
string |
expiryYear |
Year of expiration of payment |
string |
id |
Unique identifier of payment detail |
string |
issueNumber |
Issue number |
string |
saved |
Flag to mark if payment is saved one |
boolean |
startMonth |
Start month from which payment is valid |
string |
startYear |
Start year from which payment is valid |
string |
subscriptionId |
Identifier of subscription |
string |
4.139. PaymentDetailsList
Representation of a Payment details list
| Name | Description | Schema |
|---|---|---|
payments |
List of payment details |
< PaymentDetails > array |
4.140. PaymentMode
Representation of a Payment Mode
| Name | Description | Schema |
|---|---|---|
code |
Payment mode code |
string |
description |
Payment mode description |
string |
name |
Payment mode name |
string |
4.141. PaymentModeList
Representation of a Payment Mode List
| Name | Description | Schema |
|---|---|---|
paymentModes |
List of payment modes |
< PaymentMode > array |
4.142. PaymentOption
| Name | Schema |
|---|---|
bookingTimeAmount |
|
checkInPayOff |
|
id |
string |
prepaymentAmount |
|
prepaymentDeadlineInDays |
integer(int32) |
4.143. PaymentOptionList
| Name | Schema |
|---|---|
paymentOptions |
< PaymentOption > array |
4.144. PickupOrderEntryGroup
Representation of a Pickup Order Entry Group
| Name | Description | Schema |
|---|---|---|
deliveryPointOfService |
Delivery point of service |
|
distance |
Distance calculated to pickup place |
number(double) |
entries |
List of order entries |
< OrderEntry > array |
quantity |
Quantity of order entries in a group |
integer(int64) |
totalPriceWithTax |
Total price with tax |
4.145. PlaceOrderRequest
| Name | Schema |
|---|---|
additionalSecurity |
boolean |
cartId |
string |
paymentOptionId |
string |
securityCode |
string |
4.146. PointOfService
Representation of a Point of service
| Name | Description | Schema |
|---|---|---|
address |
Address information of point of service |
|
description |
Description of the point of service |
string |
displayName |
Display name of the point of service |
string |
distanceKm |
Distance to the point of service as number value |
number(double) |
features |
List of features for a given point of service |
< string, string > map |
formattedDistance |
Distance to the point of service as text value |
string |
geoPoint |
Geopoint localization info about point of service |
|
mapIcon |
Image associated with the point of service |
|
name |
Name of the point of service |
string |
openingHours |
Opening hours of point of service |
|
storeContent |
Store content of given point of service |
string |
storeImages |
Collection of images associated with a point of service |
< Image > array |
url |
Url address of the point of service |
string |
4.147. PointOfServiceList
Representation of a Point of Service List
| Name | Description | Schema |
|---|---|---|
pointOfServices |
List of points of service |
< PointOfService > array |
4.148. PointOfServiceStock
Representation of a Point Of Service Stock
| Name | Description | Schema |
|---|---|---|
address |
Address information of point of service |
|
description |
Description of the point of service |
string |
displayName |
Display name of the point of service |
string |
distanceKm |
Distance to the point of service as number value |
number(double) |
features |
List of features for a given point of service |
< string, string > map |
formattedDistance |
Distance to the point of service as text value |
string |
geoPoint |
Geopoint localization info about point of service |
|
mapIcon |
Image associated with the point of service |
|
name |
Name of the point of service |
string |
openingHours |
Opening hours of point of service |
|
stockInfo |
Stock information about point of service |
|
storeContent |
Store content of given point of service |
string |
storeImages |
Collection of images associated with a point of service |
< Image > array |
url |
Url address of the point of service |
string |
4.150. Price
Representation of a Price
| Name | Description | Schema |
|---|---|---|
currencyIso |
Currency iso format |
string |
formattedValue |
Value of price formatted |
string |
maxQuantity |
Maximum quantity of the price value |
integer(int64) |
minQuantity |
Minimum quantity of the price value |
integer(int64) |
priceType |
Type of the price |
enum (BUY, FROM) |
value |
Value of price in BigDecimal format |
number |
4.151. PriceRange
Representation of a Price Range
| Name | Description | Schema |
|---|---|---|
maxPrice |
Maximum value of the Price Range |
|
minPrice |
Minium value of the Price Range |
4.152. PricedItinerary
| Name | Schema |
|---|---|
id |
integer(int32) |
itinerary |
|
itineraryPricingInfos |
< ItineraryPricingInfo > array |
originDestinationRefNumber |
integer(int32) |
4.153. PricedItineraryReference
| Name | Schema |
|---|---|
itineraryPricingInfoRedIds |
< string > array |
pricedItineraryRefId |
string |
4.154. Principal
Representation of a Principal webservice DTO used for defining User data types
| Name | Description | Schema |
|---|---|---|
name |
Name of the user |
string |
uid |
Unique user identifier |
string |
4.155. Product
Representation of a Product
| Name | Description | Schema |
|---|---|---|
availableForPickup |
Flag defining if product is available for pickup |
boolean |
averageRating |
Rating number of average value |
number(double) |
baseOptions |
List of base options related to the product |
< BaseOption > array |
baseProduct |
Information about base product |
string |
categories |
List of categories product belongs to |
< Category > array |
classifications |
List of classifications related to the product |
< Classification > array |
code |
Code of the product |
string |
configurable |
Flag stating if product is configurable |
boolean |
configuratorType |
Configurator type related to the product |
string |
description |
Description of the product |
string |
futureStocks |
List of future stocks |
< FutureStock > array |
images |
List of images linked to product |
< Image > array |
manufacturer |
Data of product manufacturer |
string |
multidimensional |
Flag stating if product is multidimentional |
boolean |
name |
Name of the product |
string |
numberOfReviews |
Number of reviews associated with the product |
integer(int32) |
potentialPromotions |
List of potential promotions related to the product |
< Promotion > array |
price |
Price of the product |
|
priceRange |
Price range assigned to the product |
|
productReferences |
List of product references |
< ProductReference > array |
purchasable |
Flag defining if product is purchasable |
boolean |
reviews |
List of reviews associated with the product |
< Review > array |
stock |
Stock value of the product |
|
summary |
Product summary |
string |
tags |
Tags associated with the product |
< string > array |
url |
Url address of the product |
string |
variantMatrix |
List of variant matrixes associated with the product |
< VariantMatrixElement > array |
variantOptions |
List of variant options related to the product |
< VariantOption > array |
variantType |
Variant type of the product |
string |
volumePrices |
List of volume prices |
< Price > array |
volumePricesFlag |
Flag stating if volume price should be displayed |
boolean |
4.156. ProductExpressUpdateElement
Representation of a Product Express Update Element
| Name | Description | Schema |
|---|---|---|
catalogId |
Catalog identifier |
string |
catalogVersion |
Catalog version |
string |
code |
Code of product express update element |
string |
4.157. ProductExpressUpdateElementList
Representation of a Product Express Update Element List
| Name | Description | Schema |
|---|---|---|
productExpressUpdateElements |
List of product express update element |
< ProductExpressUpdateElement > array |
4.158. ProductList
Representation of a Product List
| Name | Description | Schema |
|---|---|---|
catalog |
Catalog of product list |
string |
currentPage |
Number of current page |
integer(int32) |
products |
List of products |
< Product > array |
totalPageCount |
Total page count |
integer(int32) |
totalProductCount |
Total product count |
integer(int32) |
version |
Version of product list |
string |
4.159. ProductReference
Representation of a Product Reference
| Name | Description | Schema |
|---|---|---|
description |
Reference description |
string |
preselected |
Flag stating if product reference is preselected |
boolean |
quantity |
Reference quantity |
integer(int32) |
referenceType |
Reference type |
string |
target |
Target product |
4.160. ProductReferenceList
Representation of a Product Reference List
| Name | Description | Schema |
|---|---|---|
references |
List of product references |
< ProductReference > array |
4.161. ProductSearchPage
Representation of a Product Search Page
| Name | Description | Schema |
|---|---|---|
breadcrumbs |
List of breadcrumbs info |
< Breadcrumb > array |
categoryCode |
Code of category |
string |
currentQuery |
Current query |
|
facets |
List of facets |
< Facet > array |
freeTextSearch |
Free text search |
string |
keywordRedirectUrl |
Redirect url address keyword |
string |
pagination |
Pagination number |
|
products |
List of products |
< Product > array |
sorts |
List of sorts |
< Sort > array |
spellingSuggestion |
Spelling suggestion |
4.162. Promotion
Representation of a Promotion
| Name | Description | Schema |
|---|---|---|
code |
Code of the promotion |
string |
couldFireMessages |
Message about promotion which is displayed when planning potential promotion. This field has higher priority over promotion description |
< string > array |
description |
Description of the promotion |
string |
enabled |
Boolean flag if promotion is enabled |
boolean |
endDate |
Last date of validity of the promotion |
string(date-time) |
firedMessages |
Message fired while the promotion is active. This is info how much you will get when applying the promotion |
< string > array |
priority |
Priority index as numeric value of the promotion. Higher number means higher priority |
integer(int32) |
productBanner |
Image banner of the promotion |
|
promotionGroup |
Group of the promotion |
string |
promotionType |
Type of the promotion |
string |
restrictions |
List of promotion restrictions |
< PromotionRestriction > array |
startDate |
The initial date of the promotion |
string(date-time) |
title |
Promotion title |
string |
4.163. PromotionList
Representation of a Promotion list
| Name | Description | Schema |
|---|---|---|
promotions |
List of promotions |
< Promotion > array |
4.164. PromotionOrderEntryConsumed
Representation of a Promotion order entry consumed
| Name | Description | Schema |
|---|---|---|
adjustedUnitPrice |
Adjusted unit price for promotion order entry |
number(double) |
code |
Order entry code |
string |
orderEntryNumber |
Order entry number |
integer(int32) |
quantity |
Quantity of promotion order entry |
integer(int64) |
4.165. PromotionRestriction
Representation of a Promotion Restriction
| Name | Description | Schema |
|---|---|---|
description |
Description of the promotion restriction |
string |
restrictionType |
Type of the promotion restriction |
string |
4.166. PromotionResult
Representation of a Promotion result
| Name | Description | Schema |
|---|---|---|
consumedEntries |
List of promotion order entries consumed |
< PromotionOrderEntryConsumed > array |
description |
Description of promotion result |
string |
promotion |
Promotion information for given promotion result |
4.167. PromotionResultList
Representation of a Promotion result list
| Name | Description | Schema |
|---|---|---|
promotions |
List of promotion results |
< PromotionResult > array |
4.168. Property
| Name | Schema |
|---|---|
accommodationOfferingCode |
string |
accommodationOfferingName |
string |
accommodationOfferingTypes |
< string > array |
address |
|
amenityRefCodes |
< string > array |
availabilityStatus |
string |
awards |
< Award > array |
brandRefCode |
string |
chainRefCode |
string |
configuredRate |
|
description |
string |
images |
< Image > array |
locationRefCode |
string |
promoted |
boolean |
propertyInformation |
string |
4.169. RateInfo
| Name | Schema |
|---|---|
baseRate |
|
netPriced |
boolean |
taxes |
< Price > array |
totalDiscount |
|
totalRate |
4.170. RatePlan
| Name | Schema |
|---|---|
availableQuantity |
integer(int32) |
baseRate |
|
cancelPenaltyRefCodes |
< string > array |
categoryType |
string |
code |
string |
formattedDescription |
string |
guaranteeRefCodes |
< string > array |
maxLengthOfStay |
integer(int32) |
mealTypes |
< string > array |
minLengthOfStay |
integer(int32) |
name |
string |
occupancyRefCodes |
< string > array |
rate |
|
ratePlanInclusion |
< RatePlanInclusion > array |
roomRates |
< Product > array |
totalDiscount |
|
totalTax |
4.171. RatePlanInclusion
| Name | Schema |
|---|---|
longDescription |
string |
shortDescription |
string |
4.172. Region
Response body fields which will be returned while fetching the list of country’s regions.
| Name | Description | Schema |
|---|---|---|
countryIso |
Country code in iso format |
string |
isocode |
Country and Region code in iso format |
string |
isocodeShort |
Region code in short iso form |
string |
name |
Name of the region |
string |
4.173. RegionList
List of Regions
| Name | Description | Schema |
|---|---|---|
regions |
This is the list of Region fields that should be returned in the response body |
< Region > array |
4.176. ReservationItem
| Name | Schema |
|---|---|
originDestinationRefNumber |
integer(int32) |
reservationItinerary |
|
reservationPricingInfo |
4.177. ReservationItinerary
| Name | Schema |
|---|---|
duration |
string |
transportOfferingRefCodes |
< string > array |
travelRouteRefCode |
string |
4.178. ReservationPricingInfo
| Name | Schema |
|---|---|
farePricingInfo |
|
originDestinationOfferInfos |
< OriginDestinationOfferInfo > array |
selectedSeats |
< SeatEntry > array |
4.179. ReservedGuest
| Name | Schema |
|---|---|
contactNumber |
string |
email |
string |
firstName |
string |
lastName |
string |
leadIndicator |
string |
4.180. ReservedRoomStay
| Name | Schema |
|---|---|
arrivalTime |
string |
baseRate |
|
checkInDate |
string(date) |
checkOutDate |
string(date) |
guestCounts |
< TravellerQuantity > array |
rate |
|
ratePlanCodes |
< string > array |
reservedGuests |
< ReservedGuest > array |
roomPreferences |
< string > array |
roomStayRefNumber |
integer(int32) |
roomTypes |
< RoomTypeDetails > array |
services |
< ReservedService > array |
specialRequestDetail |
|
totalDiscount |
|
totalTax |
4.181. ReservedService
| Name | Schema |
|---|---|
basePrice |
|
code |
string |
entryId |
integer(int32) |
name |
string |
price |
|
quantity |
integer(int32) |
ratePlanCode |
string |
totalDiscount |
|
totalTax |
4.182. ResetPassword
Representation of a Reset Password
| Name | Description | Schema |
|---|---|---|
newPassword |
new password string which is required to complete process of resetting password |
string |
token |
token value which will be generated as unique string that will be sent with email to allow user for completing reset-password operation |
string |
4.183. ResponseEntity
| Name | Schema |
|---|---|
body |
object |
statusCode |
enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED) |
statusCodeValue |
integer(int32) |
4.184. ReturnRequest
Representation of a return request for an order
| Name | Description | Schema |
|---|---|---|
cancellable |
Boolean flag for whether the return request is cancellable |
boolean |
code |
Return request code |
string |
creationTime |
Date of the return request creation |
string(date-time) |
deliveryCost |
Delivery cost |
|
order |
Order related to the return request |
|
refundDeliveryCost |
Boolean flag for whether there is a delivery cost for refund |
boolean |
returnEntries |
Entries of the return request which contains information about the returned product |
< ReturnRequestEntry > array |
returnLabelDownloadUrl |
URL of the return label |
string |
rma |
Return merchandise authorization number |
string |
status |
Status of return request |
string |
subTotal |
Subtotal price |
|
totalPrice |
Total price |
4.185. ReturnRequestEntry
Representation of a return request entry which contains information about the returned product
| Name | Description | Schema |
|---|---|---|
expectedQuantity |
Quantity which is expected to be returned for this return request entry |
integer(int64) |
orderEntry |
Order entry related to the return request entry |
|
refundAmount |
Refund amount of the entry |
4.186. ReturnRequestEntryInput
Representation of a return request entry input for an order
| Name | Description | Schema |
|---|---|---|
orderEntryNumber |
Order entry number of the returned product |
integer(int32) |
quantity |
Quantity of the product which belongs to the order entry and is requested to be returned |
integer(int64) |
4.187. ReturnRequestEntryInputList
Representation of a return request entry input list for an order
| Name | Description | Schema |
|---|---|---|
orderCode |
Code of the order which return request is related to |
string |
returnRequestEntryInputs |
Return request entry inputs which contain information about the order entries which are requested to be returned |
< ReturnRequestEntryInput > array |
4.188. ReturnRequestList
Representation of an Order Return Request List
| Name | Description | Schema |
|---|---|---|
pagination |
Pagination items |
|
returnRequests |
List of order return requests |
< ReturnRequest > array |
sorts |
List of sorts |
< Sort > array |
4.189. ReturnRequestModification
Representation of modifications for a return request
| Name | Description | Schema |
|---|---|---|
status |
Status of the return request |
enum (CANCELLING) |
4.190. Review
Representation of a Review
| Name | Description | Schema |
|---|---|---|
alias |
Alias name for the review |
string |
comment |
Review comment |
string |
date |
Date of the review |
string(date-time) |
headline |
Review headline |
string |
id |
Identifier of review |
string |
principal |
Person related to the review |
|
rating |
Review rating value |
number(double) |
4.191. ReviewList
Representation of a Review List
| Name | Description | Schema |
|---|---|---|
reviews |
List of reviews |
< Review > array |
4.192. RoomStay
| Name | Schema |
|---|---|
checkInDate |
string(date) |
checkOutDate |
string(date) |
ratePlans |
< RatePlan > array |
roomTypes |
< RoomTypeDetails > array |
4.194. RoomStayRequestList
| Name | Schema |
|---|---|
roomStayRequests |
< RoomStayRequest > array |
4.195. RoomTypeDetails
| Name | Schema |
|---|---|
bedType |
string |
categories |
< AccommodationCategory > array |
code |
string |
description |
string |
facilityRefCodes |
< string > array |
images |
< Image > array |
name |
string |
occupancyRefCodes |
< string > array |
roomLocation |
string |
roomView |
string |
sizeMeasurement |
string |
stock |
|
summary |
string |
4.196. RowInfo
| Name | Schema |
|---|---|
rowNum |
integer(int32) |
seatInfo |
< SeatInfo > array |
4.197. SaveCartResult
Representation of a Save Cart Result
| Name | Description | Schema |
|---|---|---|
savedCartData |
Cart data information for saved cart |
4.198. SavedSearch
| Name | Schema |
|---|---|
arrivalLocation |
string |
arrivalLocationName |
string |
arrivalLocationType |
string |
cabinClass |
string |
departureDate |
string |
departureLocation |
string |
departureLocationName |
string |
departureLocationType |
string |
id |
string |
passengerTypes |
< TravellerQuantity > array |
returnDate |
string |
tripType |
string |
4.199. SavedSearchListRS
| Name | Schema |
|---|---|
savedSearches |
< SavedSearch > array |
4.201. SearchQuery
Representation of a Search Query
| Name | Description | Schema |
|---|---|---|
value |
Value of search query |
string |
4.202. SearchState
Representation of a Search State
| Name | Description | Schema |
|---|---|---|
query |
Query of search state |
|
url |
Url address of search state |
string |
4.203. SeatAvailability
| Name | Schema |
|---|---|
availabilityIndicator |
string |
seatNumber |
string |
4.204. SeatEntry
| Name | Schema |
|---|---|
entryId |
integer(int32) |
seatNumber |
string |
transportOfferingRefCode |
string |
travellerRefUid |
string |
4.205. SeatEntryRequest
| Name | Schema |
|---|---|
seatId |
string |
transportOfferingCode |
string |
travellers |
< string > array |
4.206. SeatEntryResponse
| Name | Schema |
|---|---|
basePrice |
|
discounts |
< Discount > array |
entryId |
integer(int32) |
seatId |
string |
taxes |
< Tax > array |
totalPrice |
|
transportOfferingCode |
string |
travellers |
< string > array |
4.207. SeatFeature
| Name | Schema |
|---|---|
seatFeatureDescription |
string |
seatFeaturePosition |
string |
seatFeatureType |
string |
4.208. SeatInfo
| Name | Schema |
|---|---|
seatFeatures |
< SeatFeature > array |
seatNumber |
string |
seatUid |
string |
totalFare |
4.209. SeatMap
| Name | Schema |
|---|---|
seatMapCode |
string |
seatMapDetails |
|
selectedSeats |
< SelectedSeat > array |
transportOfferingCode |
string |
4.210. SeatMapDetail
| Name | Schema |
|---|---|
cabin |
< Cabin > array |
4.211. SeatMapResponse
| Name | Schema |
|---|---|
seatMap |
< SeatMap > array |
4.212. SelectedSeat
| Name | Schema |
|---|---|
passenger |
|
seatNumber |
string |
transportOfferingCode |
string |
4.213. ServicesSearchResponse
| Name | Schema |
|---|---|
roomStayReferenceNumber |
integer(int32) |
serviceList |
< AccommodationService > array |
4.214. Sort
Representation a Sort option
| Name | Description | Schema |
|---|---|---|
code |
Code of Sort |
string |
name |
Name of Sort |
string |
selected |
Flag stating when Sort is selected |
boolean |
4.215. SpecialOpeningDay
Representation of a special opening day
| Name | Description | Schema |
|---|---|---|
closed |
Flag stating if special opening day is closed |
boolean |
closingTime |
Closing time of opening day |
|
comment |
Comment field |
string |
date |
Date of special opening day |
string(date-time) |
formattedDate |
Text representation of the date of special opening day |
string |
name |
Name of the special opening day event |
string |
openingTime |
Starting time of opening day |
4.216. SpecialRequestDetail
| Name | Schema |
|---|---|
remarks |
< Remark > array |
specialServiceRequests |
< SpecialServiceRequest > array |
4.217. SpecialServiceRequest
Representation of a Special Service Request
| Name | Schema |
|---|---|
code |
string |
name |
string |
4.218. SpecialServiceRequestList
| Name | Schema |
|---|---|
specialServiceRequests |
< SpecialServiceRequest > array |
4.219. SpellingSuggestion
Representation of a Spell Checker Suggestion
| Name | Description | Schema |
|---|---|---|
query |
Query for spelling suggestion |
string |
suggestion |
Spelling suggestion |
string |
4.220. StatusSummary
Representation of a status summary, an aggregated view on issues for a specific status or severity. These issues are attached to configurations of products or order entries
| Name | Description | Schema |
|---|---|---|
numberOfIssues |
Number of issues per status |
integer(int32) |
status |
Status or severity indicator, can be one of ERROR, WARNING, INFO or SUCCESS |
string |
4.222. Stock
Representation of a Stock
| Name | Description | Schema |
|---|---|---|
isValueRounded |
Indicate whether Stock level value is rounded |
boolean |
stockLevel |
Stock level expressed as number |
integer(int64) |
stockLevelStatus |
Status of stock level |
string |
4.224. StoreCount
Representation of a Store Count
| Name | Description | Schema |
|---|---|---|
count |
Count |
integer(int32) |
isoCode |
Iso code of store |
string |
name |
Name of store count |
string |
storeCountDataList |
List of store counts |
< StoreCount > array |
type |
Type of store count |
string |
4.225. StoreCountList
Representation of a Store Count List
| Name | Description | Schema |
|---|---|---|
countriesAndRegionsStoreCount |
List of store counts |
< StoreCount > array |
4.226. StoreFinderSearchPage
Representation of a Store finder search page
| Name | Description | Schema |
|---|---|---|
boundEastLongitude |
Bound east longitude |
number(double) |
boundNorthLatitude |
Bound north latitude |
number(double) |
boundSouthLatitude |
Bound south latitude |
number(double) |
boundWestLongitude |
Bound west longitude |
number(double) |
locationText |
Location text |
string |
pagination |
Pagination |
|
sorts |
List of sortings |
< Sort > array |
sourceLatitude |
Source latitude |
number(double) |
sourceLongitude |
Source longitude |
number(double) |
stores |
List of stores |
< PointOfService > array |
4.227. StoreFinderStockSearchPage
Representation of a Store Finder Stock Search Page
| Name | Description | Schema |
|---|---|---|
boundEastLongitude |
Bound to east longitude |
number(double) |
boundNorthLatitude |
Bound to north latitude |
number(double) |
boundSouthLatitude |
Bound to south latitude |
number(double) |
boundWestLongitude |
Bound to west longitude |
number(double) |
locationText |
Location text |
string |
pagination |
Pagination |
|
product |
Product |
|
sorts |
List of sorts |
< Sort > array |
sourceLatitude |
Source latitude |
number(double) |
sourceLongitude |
Source longitude |
number(double) |
stores |
List of stores |
< PointOfServiceStock > array |
4.228. Suggestion
Representation of a Suggestion
| Name | Description | Schema |
|---|---|---|
value |
Suggestion value |
string |
4.229. SuggestionList
Representation of a Suggestion List
| Name | Description | Schema |
|---|---|---|
suggestions |
List of suggestions |
< Suggestion > array |
4.232. Time
Representation of a Time
| Name | Description | Schema |
|---|---|---|
formattedHour |
Formatted hour |
string |
hour |
Hour part of the time data |
integer(int32) |
minute |
Minute part of the time data |
integer(int32) |
4.233. Title
Representation of a Title
| Name | Description | Schema |
|---|---|---|
code |
Title code |
string |
name |
Title name |
string |
4.234. TitleList
Representation of a Title List
| Name | Description | Schema |
|---|---|---|
titles |
List of titles |
< Title > array |
4.235. TotalFare
| Name | Schema |
|---|---|
basePrice |
|
discountPrice |
|
discounts |
< Discount > array |
extrasPrice |
|
fees |
< Fee > array |
taxPrice |
|
taxes |
< Tax > array |
totalBaseExtrasPrice |
|
totalFees |
|
totalPrice |
|
wasRate |
4.237. TransportDetailsDataReferences
| Name | Schema |
|---|---|
locations |
< Location > array |
transportFacilities |
< TransportFacility > array |
transportVehicles |
< TransportVehicleInfo > array |
travelProviders |
< TravelProvider > array |
travelSectors |
< TravelSector > array |
4.238. TransportFacility
| Name | Schema |
|---|---|
code |
string |
locationRefCode |
string |
name |
string |
4.239. TransportLocationSuggestionResponse
| Name | Schema |
|---|---|
locations |
< TransportLocations > array |
4.240. TransportLocations
| Name | Schema |
|---|---|
location |
|
subLocations |
< Location > array |
4.241. TransportOffering
| Name | Schema |
|---|---|
arrivalTime |
string |
arrivalTimeZoneId |
string |
code |
string |
departureTime |
string |
departureTimeZoneId |
string |
destinationLocationCity |
string |
destinationLocationCountry |
string |
destinationTerminal |
|
duration |
string |
number |
string |
originLocationCity |
string |
originLocationCountry |
string |
originTerminal |
|
sectorRefCode |
string |
status |
|
stopLocationsFacilitiesRefCodes |
< string > array |
transportVehicleRefCode |
string |
travelProviderRefCode |
string |
type |
string |
updatedDepartureTime |
string(date-time) |
4.243. TransportOfferingList
| Name | Schema |
|---|---|
dataReferences |
|
transportOfferings |
< TransportOffering > array |
4.245. TransportReservation
| Name | Schema |
|---|---|
additionalSecurity |
boolean |
bookingStatusCode |
string |
bookingStatusName |
string |
dataReferences |
|
offerPricingInfos |
< OfferPricingInfo > array |
reservationItems |
< ReservationItem > array |
salesApplication |
string |
totalFare |
|
totalPaid |
|
totalToPay |
4.246. TransportReservationDataReference
| Name | Schema |
|---|---|
locations |
< Location > array |
transportFacilities |
< TransportFacility > array |
transportOfferings |
< TransportOffering > array |
travelRoutes |
< TravelRoute > array |
travelSectors |
< TravelSector > array |
travellers |
< Traveller > array |
4.248. TravelBundleTemplate
| Name | Schema |
|---|---|
bundleType |
|
childTemplates |
< TravelBundleTemplate > array |
id |
string |
name |
string |
products |
< BasicProduct > array |
4.250. TravelReason
Representation of a Traveller Reason
| Name | Schema |
|---|---|
code |
string |
name |
string |
4.251. TravelRestriction
| Name | Schema |
|---|---|
addToCartCriteria |
string |
effectiveDate |
string(date-time) |
expireDate |
string(date-time) |
passengerTypes |
< string > array |
travellerMaxOfferQty |
integer(int32) |
travellerMinOfferQty |
integer(int32) |
tripMaxOfferQty |
integer(int32) |
tripMinOfferQty |
integer(int32) |
4.252. TravelRoute
| Name | Schema |
|---|---|
code |
string |
destinationFacilityRefCode |
string |
name |
string |
originFacilityRefCode |
string |
travelSectorRefCodes |
< string > array |
4.253. TravelSector
| Name | Schema |
|---|---|
code |
string |
destinationFacilityRefCode |
string |
originFacilityRefCode |
string |
4.254. Traveller
Representation of a Traveller
| Name | Description | Schema |
|---|---|---|
booker |
Flag to mark if traveller the booker |
boolean |
info |
Traveller information |
|
label |
Label of traveller |
string |
specialRequestDetail |
Special service request |
|
type |
Type of traveller |
|
uid |
Unique identifier traveller |
string |
4.255. Traveller DocumentTypeInfo
Representation of a Traveller Document Type Info
| Name | Schema |
|---|---|
code |
string |
name |
string |
4.256. TravellerBreakdown
| Name | Schema |
|---|---|
fareBasisCodes |
< string > array |
passengerFare |
|
quantity |
integer(int32) |
travellerRefUid |
string |
4.257. TravellerInfo
Representation of a Traveller Info
| Name | Schema |
|---|---|
apisType |
string |
documentCountryOfIssue |
|
documentExpiryDate |
string(date-time) |
documentNumber |
string |
documentType |
|
email |
string |
firstName |
string |
gender |
|
lastName |
string |
membershipNumber |
string |
nationality |
|
title |
|
travelReason |
|
type |
4.258. TravellerInfoType
Representation of a Traveller Info Type
| Name | Schema |
|---|---|
code |
string |
name |
string |
4.260. TravellerQuantityList
| Name | Schema |
|---|---|
travellers |
< TravellerQuantity > array |
4.261. TravellerType
Representation of a Traveller Type
| Name | Schema |
|---|---|
code |
string |
name |
string |
4.262. TravellersList
List of Travellers
| Name | Description | Schema |
|---|---|---|
travellers |
List of Travellers |
< Traveller > array |
4.264. User
Representation of an User
| Name | Description | Schema |
|---|---|---|
currency |
User preferred currency |
|
customerId |
Customer identifier |
string |
deactivationDate |
Deactivation date |
string(date-time) |
defaultAddress |
User address |
|
displayUid |
User identifier |
string |
firstName |
User first name |
string |
language |
User preferred language |
|
lastName |
User last name |
string |
name |
Name of the user |
string |
title |
User title |
string |
titleCode |
User title code |
string |
uid |
Unique user identifier |
string |
4.265. UserGender
Representation of a UserGender
| Name | Schema |
|---|---|
code |
string |
name |
string |
4.266. UserGroup
Representation of an User Group
| Name | Description | Schema |
|---|---|---|
members |
List of members |
< Principal > array |
membersCount |
Number of members |
integer(int32) |
name |
Name of the user |
string |
subGroups |
List of subgroups |
< UserGroup > array |
uid |
Unique user identifier |
string |
4.267. UserGroupList
Representation of an User Group List
| Name | Description | Schema |
|---|---|---|
currentPage |
Current page |
integer(int32) |
numberOfPages |
Number of pages |
integer(int32) |
pageSize |
Page size |
integer(int32) |
totalNumber |
Total number |
integer(int32) |
userGroups |
List of user groups |
< UserGroup > array |
4.268. UserSignUp
Representation of an UserSignUp. Consists of fields required to register new customer
| Name | Description | Schema |
|---|---|---|
firstName |
first name of the user |
string |
lastName |
last name of the user |
string |
password |
user password |
string |
titleCode |
string |
|
uid |
user id, unique string required to create new user. It can be email |
string |
4.269. VariantCategory
Representation of a Variant Category
| Name | Description | Schema |
|---|---|---|
hasImage |
Flag if varian category has image assigned |
boolean |
name |
Variant category name |
string |
priority |
Priority number of variant category |
integer(int32) |
4.270. VariantMatrixElement
Representation of a Variant Matrix Element
| Name | Description | Schema |
|---|---|---|
elements |
List of elements with the type of variant matrix element |
< VariantMatrixElement > array |
isLeaf |
boolean |
|
parentVariantCategory |
Parent variant category for variant matrix element |
|
variantOption |
Variant option for variant matrix element |
|
variantValueCategory |
Variant value category for variant matrix element |
4.271. VariantOption
Representation of a Variant Option
| Name | Description | Schema |
|---|---|---|
code |
Code of the variant option |
string |
priceData |
Price data information of the variant option |
|
stock |
Stock value of the variant option |
|
url |
Url address of the variant option |
string |
variantOptionQualifiers |
List of variant option qualifiers |
< VariantOptionQualifier > array |
4.272. VariantOptionQualifier
Representation of a Variant Option Qualifier
| Name | Description | Schema |
|---|---|---|
image |
Image associated with variant option qualifier |
|
name |
Name of variant option qualifier |
string |
qualifier |
Qualifier |
string |
value |
Value of variant option qualifier |
string |
4.273. VariantValueCategory
Representation of a Variant Value Category
| Name | Description | Schema |
|---|---|---|
name |
Name of the variant value category |
string |
sequence |
Sequence number of variant value category |
integer(int32) |
superCategories |
Parent category of variant value category |
< VariantCategory > array |
4.274. Voucher
Representation of a Voucher
| Name | Description | Schema |
|---|---|---|
appliedValue |
Applied value when using this voucher |
|
code |
The identifier of the Voucher. This is the first part of voucher code which holds first 3 letters, like: 123 |
string |
currency |
Currency of the voucher |
|
description |
Description of the voucher |
string |
freeShipping |
Specifies if the order this voucher is applied to is shipped for free (true) or not (false). Defaults to false. |
boolean |
name |
Name of the voucher |
string |
value |
Value of the voucher. Example of such value is: 15.0d |
number(double) |
valueFormatted |
Formatted value of the voucher |
string |
valueString |
The value of the voucher to display. Example: 15.0% |
string |
voucherCode |
Voucher code, is the holder for keeping specific occasional voucher related to business usage. It can be generated and looks like: 123-H8BC-Y3D5-34AL |
string |
4.275. VoucherList
Representation of a Voucher List
| Name | Description | Schema |
|---|---|---|
vouchers |
List of vouchers |
< Voucher > array |
4.276. WeekdayOpeningDay
Representation of a Weekday Opening Day
| Name | Description | Schema |
|---|---|---|
closed |
Flag stating if weekday opening day is closed |
boolean |
closingTime |
Closing time of opening day |
|
openingTime |
Starting time of opening day |
|
weekDay |
Text representation of week day opening day |
string |
4.277. deprecatedPagination
Representation of a search results pagination
| Name | Description | Schema |
|---|---|---|
currentPage |
The current page number. The first page is number zero (0), the second page is number one (1), and so on |
integer(int32) |
pageSize |
The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results |
integer(int32) |
sort |
The selected sort code |
string |
totalPages |
The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults. |
integer(int32) |
totalResults |
The total number of matched results across all pages |
integer(int64) |
4.278. error
Error message
| Name | Description | Schema |
|---|---|---|
errorCode |
Error code |
string |
exceptionMessage |
string |
|
language |
Example : |
string |
message |
Descriptive, human readable error message. |
string |
position |
Example : |
integer(int32) |
reason |
Additional classification specific for each error type e.g. 'noStock'. |
string |
subject |
Identifier of the related object e.g. '1'. |
string |
subjectType |
Type of the object related to the error e.g. 'entry'. |
string |
type |
Type of the error e.g. 'LowStockError'. |
string |
4.280. pagination
Pagination info
| Name | Description | Schema |
|---|---|---|
count |
Number of elements on this page |
integer(int32) |
hasNext |
Indicates if there is next page |
boolean |
hasPrevious |
Indicates if there is previous page |
boolean |
page |
Current page number |
integer(int32) |
totalCount |
Total number of elements |
integer(int64) |
totalPages |
Total number of pages |
integer(int32) |