Api.Wrapi

<back to all web services

GetQuoteById

This resource is used to manage baskets in HAPI.

The following routes are available for this service:
GET/checkout/quote/{id}Retrieve a quote from the WRAPI cache.
GetQuoteById Parameters:
NameParameterData TypeRequiredDescription
IdpathGUIDYesThe WRAPI Id to retrieve a cached quote
WrapiOrder Parameters:
NameParameterData TypeRequiredDescription
ContentsformOrderNo
Order Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NumberformstringNo
CurrencyformstringNo
LanguageformstringNo
StatusformstringNo
ProcessingStatusformstringNo
CustomerIdformstringNo
ProductformProductNo
TravellersformTraveller[]No
AttributesformAttribute[]No
PriceformPriceNo
PaymentConditionformPaymentConditionNo
CustomerformCustomerNo
PaymentformPaymentNo
CardFullIdformstringNo
Product Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ReferenceformstringNo
NumberformstringNo
StatusformstringNo
BookOptionsformBookOptionsNo
ProviderformProviderNo
TravellersformList<TravellerSummary>No
ServicesformList<Service>No
BookOptions Parameters:
NameParameterData TypeRequiredDescription
BookformBookNo
OptionformOptionNo
QuoteformQuoteNo
Book Parameters:
NameParameterData TypeRequiredDescription
AllowedformboolNo
Option Parameters:
NameParameterData TypeRequiredDescription
AllowedformboolNo
SetToformstringNo
ValidityformValidityNo
ExtendValidityformExtendValidityNo
Validity Parameters:
NameParameterData TypeRequiredDescription
DateformstringNo
ExtendValidity Parameters:
NameParameterData TypeRequiredDescription
AllowedformboolNo
DateformstringNo
Quote Parameters:
NameParameterData TypeRequiredDescription
AllowedformboolNo
Provider Parameters:
NameParameterData TypeRequiredDescription
SourceformProviderTypeNo
CodeformstringNo
CatalogueformstringNo
BrandformstringNo
ProgramformstringNo
CurrencyformstringNo
TravellerSummary Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ReferenceformintNo
PriceformPriceNo
Price Parameters:
NameParameterData TypeRequiredDescription
AmountformdecimalNo
CurrencyformstringNo
Service Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ParentIdformstringNo
ReferenceformstringNo
StatusformstringNo
TravellersformList<TravellerSummary>No
DestinationformDestinationNo
Destination Parameters:
NameParameterData TypeRequiredDescription
LocationformLocationNo
CountryformDestinationCountryNo
Location Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
DescriptionformLongNo
Long Parameters:
NameParameterData TypeRequiredDescription
Textformstring[]No
DestinationCountry Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
DescriptionformLongNo
Traveller Parameters:
NameParameterData TypeRequiredDescription
SalutationformstringNo
TitleformstringNo
WrapiTitleformstringNo
GenderformstringNo
FirstNameformstringNo
LastNameformstringNo
DateOfBirthformstringNo
TravellerTypeformTravellerTypeNo
CalculatedAgeformintNo
AllocatedformboolNo
Attribute Parameters:
NameParameterData TypeRequiredDescription
AttributeIdformstringNo
AttributeRefformstringNo
Price Parameters:
NameParameterData TypeRequiredDescription
SellformSellNo
Sell Parameters:
NameParameterData TypeRequiredDescription
AmountformdecimalNo
CurrencyformstringNo
PaymentCondition Parameters:
NameParameterData TypeRequiredDescription
OpenAmountformConditionSellNo
ImmediatelyformImmediatelyNo
ConditionsformList<Condition>No
AllowedPaymentMethodsformAllowedPaymentMethodsNo
ConditionSell Parameters:
NameParameterData TypeRequiredDescription
NullableAmountformstringNo
AmountformdecimalNo
CurrencyformstringNo
Immediately Parameters:
NameParameterData TypeRequiredDescription
PaymentAmountformConditionSellNo
PercentformdecimalNo
Condition Parameters:
NameParameterData TypeRequiredDescription
DueDateformDateTimeNo
PaymentAmountformConditionSellNo
PercentformdecimalNo
AllowedPaymentMethods Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodsformPaymentMethod[]No
PaymentMethod Parameters:
NameParameterData TypeRequiredDescription
CreditCardformCreditCardNo
CreditCard Parameters:
NameParameterData TypeRequiredDescription
CardBrandformstringNo
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NumberformstringNo
SalutationformstringNo
TitleformstringNo
WrapiTitleformstringNo
GenderformstringNo
FirstNameformstringNo
LastNameformstringNo
DateOfBirthformstringNo
LanguageformstringNo
AddressformAddressNo
PhoneformPhoneNo
EmergencyContactformPhoneNo
EmailformEmailNo
InsuranceformboolNo
AdvertisingformList<AdvertisingOption>No
CommentsformstringNo
AdditionalInformationformstringNo
Address Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
AddressIdformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
PostCodeformstringNo
CityformstringNo
CountryformCountryNo
Country Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
DescriptionformLongNo
Phone Parameters:
NameParameterData TypeRequiredDescription
CountryformstringNo
NumberformstringNo
Email Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
AdvertisingOption Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
OptOutformboolNo
Payment Parameters:
NameParameterData TypeRequiredDescription
AmountformPaymentAmountNo
DateformDateTimeNo
DetailformPaymentDetailNo
PaymentAmount Parameters:
NameParameterData TypeRequiredDescription
Amountformdecimal?No
currencyformstringNo
PaymentDetail Parameters:
NameParameterData TypeRequiredDescription
CreditCardformPaymentDetailCreditCardNo
PaymentDetailCreditCard Parameters:
NameParameterData TypeRequiredDescription
CardBrandformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /checkout/quote/{id} HTTP/1.1 
Host: wrapi-api.dev.hotelplan.co.uk 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'WrapiOrder' using the custom 'csv' filter}No parameterless constructor defined for this object.