Api.Wrapi

GetQuoteByShortCode

This resource is used to manage baskets in HAPI.

The following routes are available for this service:
GET	/checkout/quote/code/{shortcode}	Retrieve a quote from the WRAPI cache.

**GetQuoteByShortCode** Parameters:
Name	Parameter	Data Type	Required	Description
ShortCode	path	string	Yes	The WRAPI short url code to retrieve a cached quote

**WrapiOrder** Parameters:
Name	Parameter	Data Type	Required	Description
Contents	form	Order	No

**Order** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Number	form	string	No
Currency	form	string	No
Language	form	string	No
Status	form	string	No
ProcessingStatus	form	string	No
CustomerId	form	string	No
Product	form	Product	No
Travellers	form	Traveller[]	No
Attributes	form	Attribute[]	No
Price	form	Price	No
PaymentCondition	form	PaymentCondition	No
Customer	form	Customer	No
Payment	form	Payment	No
CardFullId	form	string	No

**Product** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Reference	form	string	No
Number	form	string	No
Status	form	string	No
BookOptions	form	BookOptions	No
Provider	form	Provider	No
Travellers	form	List<TravellerSummary>	No
Services	form	List<Service>	No

**BookOptions** Parameters:
Name	Parameter	Data Type	Required
Book	form	Book	No
Option	form	Option	No
Quote	form	Quote	No

**Book** Parameters:
Name	Parameter	Data Type	Required	Description
Allowed	form	bool	No

**Option** Parameters:
Name	Parameter	Data Type	Required
Allowed	form	bool	No
SetTo	form	string	No
Validity	form	Validity	No
ExtendValidity	form	ExtendValidity	No

**Validity** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	string	No

**ExtendValidity** Parameters:
Name	Parameter	Data Type	Required	Description
Allowed	form	bool	No
Date	form	string	No

**Quote** Parameters:
Name	Parameter	Data Type	Required	Description
Allowed	form	bool	No

**Provider** Parameters:
Name	Parameter	Data Type	Required
Source	form	ProviderType	No
Code	form	string	No
Catalogue	form	string	No
Brand	form	string	No
Program	form	string	No
Currency	form	string	No

**TravellerSummary** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Reference	form	int	No
Price	form	Price	No

**Price** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	decimal	No
Currency	form	string	No

**Service** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
ParentId	form	string	No
Reference	form	string	No
Status	form	string	No
Travellers	form	List<TravellerSummary>	No
Destination	form	Destination	No

**Destination** Parameters:
Name	Parameter	Data Type	Required	Description
Location	form	Location	No
Country	form	DestinationCountry	No

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**Long** Parameters:
Name	Parameter	Data Type	Required	Description
Text	form	string[]	No

**DestinationCountry** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**Traveller** Parameters:
Name	Parameter	Data Type	Required
Salutation	form	string	No
Title	form	string	No
WrapiTitle	form	string	No
Gender	form	string	No
FirstName	form	string	No
LastName	form	string	No
DateOfBirth	form	string	No
TravellerType	form	TravellerType	No
CalculatedAge	form	int	No
Allocated	form	bool	No

**Attribute** Parameters:
Name	Parameter	Data Type	Required	Description
AttributeId	form	string	No
AttributeRef	form	string	No

**Price** Parameters:
Name	Parameter	Data Type	Required	Description
Sell	form	Sell	No

**Sell** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	decimal	No
Currency	form	string	No

**PaymentCondition** Parameters:
Name	Parameter	Data Type	Required
OpenAmount	form	ConditionSell	No
Immediately	form	Immediately	No
Conditions	form	List<Condition>	No
AllowedPaymentMethods	form	AllowedPaymentMethods	No

**ConditionSell** Parameters:
Name	Parameter	Data Type	Required
NullableAmount	form	string	No
Amount	form	decimal	No
Currency	form	string	No

**Immediately** Parameters:
Name	Parameter	Data Type	Required	Description
PaymentAmount	form	ConditionSell	No
Percent	form	decimal	No

**Condition** Parameters:
Name	Parameter	Data Type	Required
DueDate	form	DateTime	No
PaymentAmount	form	ConditionSell	No
Percent	form	decimal	No

**AllowedPaymentMethods** Parameters:
Name	Parameter	Data Type	Required	Description
PaymentMethods	form	PaymentMethod[]	No

**PaymentMethod** Parameters:
Name	Parameter	Data Type	Required	Description
CreditCard	form	CreditCard	No

**CreditCard** Parameters:
Name	Parameter	Data Type	Required	Description
CardBrand	form	string	No

**Customer** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Number	form	string	No
Salutation	form	string	No
Title	form	string	No
WrapiTitle	form	string	No
Gender	form	string	No
FirstName	form	string	No
LastName	form	string	No
DateOfBirth	form	string	No
Language	form	string	No
Address	form	Address	No
Phone	form	Phone	No
EmergencyContact	form	Phone	No
Email	form	Email	No
Insurance	form	bool	No
Advertising	form	List<AdvertisingOption>	No
Comments	form	string	No
AdditionalInformation	form	string	No

**Address** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
AddressId	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
PostCode	form	string	No
City	form	string	No
Country	form	Country	No

**Country** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**Phone** Parameters:
Name	Parameter	Data Type	Required	Description
Country	form	string	No
Number	form	string	No

**Email** Parameters:
Name	Parameter	Data Type	Required	Description
Address	form	string	No

**AdvertisingOption** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No
OptOut	form	bool	No

**Payment** Parameters:
Name	Parameter	Data Type	Required
Amount	form	PaymentAmount	No
Date	form	DateTime	No
Detail	form	PaymentDetail	No

**PaymentAmount** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	decimal?	No
currency	form	string	No

**PaymentDetail** Parameters:
Name	Parameter	Data Type	Required	Description
CreditCard	form	PaymentDetailCreditCard	No

**PaymentDetailCreditCard** Parameters:
Name	Parameter	Data Type	Required	Description
CardBrand	form	string	No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /checkout/quote/code/{shortcode} HTTP/1.1 
Host: wrapi-api.dev.hotelplan.co.uk 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"contents":{"id":"String","number":"String","currency":"String","language":"String","status":"String","processingStatus":"String","customerId":"String","product":{"id":"String","reference":"String","number":"String","status":"String","bookOptions":{"book":{"allowed":false},"option":{"allowed":false,"setTo":"String","validity":{"date":"String"},"extendValidity":{"allowed":false,"date":"String"}},"quote":{"allowed":false}},"provider":{"source":"Hub","code":"String","catalogue":"String","brand":"String","program":"String","currency":"String"},"travellers":[{"id":"String","reference":0,"price":{"amount":0,"currency":"String"}}],"services":[{"id":"String","parentId":"String","reference":"String","status":"String","travellers":[{"id":"String","reference":0,"price":{"amount":0,"currency":"String"}}],"destination":{"location":{"code":"String","description":{"text":["String"]}},"country":{"code":"String","description":{"text":["String"]}}}}]},"travellers":[{"salutation":"String","title":"String","wrapiTitle":"String","gender":"String","firstName":"String","lastName":"String","dateOfBirth":"String","travellerType":"Infant","calculatedAge":0,"id":"String","reference":0,"price":{"amount":0,"currency":"String"}}],"attributes":[{"attributeId":"String","attributeRef":"String"}],"price":{"sell":{"amount":0,"currency":"String"}},"paymentCondition":{"openAmount":{"nullableAmount":"String","amount":0,"currency":"String"},"immediately":{"paymentAmount":{"nullableAmount":"String","amount":0,"currency":"String"},"percent":0},"conditions":[{"dueDate":"0001-01-01T00:00:00.0000000","paymentAmount":{"nullableAmount":"String","amount":0,"currency":"String"},"percent":0}],"allowedPaymentMethods":{"paymentMethods":[{"creditCard":{"cardBrand":"String"}}]}},"customer":{"id":"String","number":"String","salutation":"String","title":"String","wrapiTitle":"String","gender":"String","firstName":"String","lastName":"String","dateOfBirth":"String","language":"String","address":{"type":"String","addressId":"String","addressLine1":"String","addressLine2":"String","postCode":"String","city":"String","country":{"code":"String","description":{"text":["String"]}}},"phone":{"country":"String","number":"String"},"emergencyContact":{"country":"String","number":"String"},"email":{"address":"String"},"insurance":false,"advertising":[{"type":"String","optOut":false}],"comments":"String","additionalInformation":"String"},"payment":{"amount":{"amount":0,"currency":"String"},"date":"0001-01-01T00:00:00.0000000","detail":{"creditCard":{"cardBrand":"String"}}},"cardFullId":"String"}}