The third-party system implements the order inquiry method according to the definition of the interface and transfers it into service. The system will call in a real time manner the order inquiry service from the third party to obtained detailed order information.
POST http://{vendor's host}/searchOrder
O: Optional; R: Required; SR: Special Required
Name | Type | O/R/SR | Limitation | Description | Example |
---|---|---|---|---|---|
OrderId |
String |
O |
64 |
Search the order by OTA order id or order id in third party system |
21544874 |
TaoBaoOrderId |
long |
R |
|
Search the order by taobao order id, this will take precedence over "OrderId". |
524148745 |
IncludeDetail |
boolean |
R |
|
When the vaule is true, the response will include the order details. |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SearchOrderRequest> <AuthenticationToken> <Username>********</Username> <RequestTimestamp>32423532523</RequestTimestamp> <Signature>ae7e12812dc83aa255e6dd6eba8aa6e2</Signature> </AuthenticationToken> <TaoBaoOrderId>3254254325432</TaoBaoOrderId> <OrderId>3254254325432</OrderId> <IncludeDetail>true</IncludeDetail> </SearchOrderRequest>
Name | Type | O/R/SR | Limitation | Description | Example |
---|---|---|---|---|---|
TaoBaoOrderId |
long |
R |
|
taobao order id |
1387784033263 |
OrderId |
String |
R |
64 |
taobao order id or order id in third party system |
21544874 |
PMSOrderId |
String |
O |
64 |
hotel confirmation code in PMS system |
21544874 |
OrderStatus |
String |
R |
See status list definition |
Status of third party system order |
CONFIRMED |
TotalPrice |
Decimal |
O |
|
The total price of this order。If OrderStatus is "CONFIRMED" or "CANCELLED", TotalPrice is required |
34.54 |
CurrencyCode |
String |
O |
See currency list definition |
The CurrencyCode code of the price。If OrderStatus is "CONFIRMED" or "CANCELLED", CurrencyCode is required |
CNY |
Hotel |
|
O |
This node is the same as the node named "Hotel" in RoomAvailabilityResponse. Only when the "IncludeDetail" node is true, it will return the room type information plus the rate information. |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SearchOrderResponse> <ResponseTimestamp>32423532523</ResponseTimestamp> <TaoBaoOrderId>32542543254326351988</TaoBaoOrderId> <OrderId>325425432</OrderId> <OrderStatus>Confirmed</OrderStatus> <TotalPrice>1234.34</TotalPrice> <CurrencyCode>CNY</CurrencyCode> <Hotel> <Name>测试</Name> <EnglishName>test</EnglishName> <Address>dsfdsf-234-234</Address> <CityCode>dsf</CityCode> <HotelCode>10021918</HotelCode> <CheckIn>2017-07-29</CheckIn> <CheckOut>2017-07-30</CheckOut> <RoomTypes> <RoomType> <RoomTypeCode>VIP</RoomTypeCode> <RoomTypeName>测试房型</RoomTypeName> <RoomTypeEnglishName>test room</RoomTypeEnglishName> <MaxRoomOccupancy>4</MaxRoomOccupancy> <RateInfos> <RateInfo> <RateKey>VIP</RateKey> <RateCode>VIP</RateCode> <RateName>测试rate</RateName> <RateEnglishName>test rate</RateEnglishName> <Allotment>5</Allotment> <Refundable>true</Refundable> <Board> <BoardCode>American</BoardCode> <BoardCount>2</BoardCount> </Board> <PaymentType>1</PaymentType> <CurrencyCode>CNY</CurrencyCode> <TotalBasePrice>1260</TotalBasePrice> <TotalPrice>1234.34</TotalPrice> <TotalTaxAndFee>324.34</TotalTaxAndFee> <CancelPolicyInfos> <CancelPolicyInfo> <CancelTime>16:00:00</CancelTime> <StartWindowHours>0</StartWindowHours> <NightCount>1</NightCount> <TimeZone>-08:00</TimeZone> <CurrencyCode>CNY</CurrencyCode> </CancelPolicyInfo> <CancelPolicyInfo> <CancelTime>16:00:00</CancelTime> <StartWindowHours>48</StartWindowHours> <NightCount>0</NightCount> <TimeZone>-08:00</TimeZone> <CurrencyCode>CNY</CurrencyCode> </CancelPolicyInfo> <CancelPolicyInfo> <CancelTime>16:00:00</CancelTime> <StartWindowHours>72</StartWindowHours> <Amount>1000</Amount> <TimeZone>-08:00</TimeZone> <CurrencyCode>CNY</CurrencyCode> </CancelPolicyInfo> </CancelPolicyInfos> <HotelFees> <HotelFee> <Type>MandatoryFee</Type> <Amount>345</Amount> </HotelFee> <CurrencyCode>CNY</CurrencyCode> </HotelFees> <RateComments> <RateComment>drop the key at the gate</RateComment> <RateComment>dinner can not be served</RateComment> </RateComments> <PaxPriceRooms> <PaxPriceRoom> <RoomIndex>1</RoomIndex> <Adults>2</Adults> <Children>2</Children> <ChildrenAges> <Age>10</Age> <Age>10</Age> </ChildrenAges> <DailyInfos> <DailyInfo> <Day>2016-12-24</Day> <Price>17800</Price> <BasePrice>17000</BasePrice> <TaxAndFee>2345</TaxAndFee> <CurrencyCode>CNY</CurrencyCode> </DailyInfo> <DailyInfo> <Day>2016-12-25</Day> <Price>46050</Price> <BasePrice>46000</BasePrice> <TaxAndFee>2345</TaxAndFee> <CurrencyCode>CNY</CurrencyCode> </DailyInfo> </DailyInfos> </PaxPriceRoom> <PaxPriceRoom> <RoomIndex>2</RoomIndex> <Adults>2</Adults> <Children>0</Children> <DailyInfos> <DailyInfo> <Day>2016-12-24</Day> <Price>17800</Price> <BasePrice>17000</BasePrice> <TaxAndFee>2345</TaxAndFee> <CurrencyCode>CNY</CurrencyCode> </DailyInfo> <DailyInfo> <Day>2016-12-25</Day> <Price>46050</Price> <BasePrice>46000</BasePrice> <TaxAndFee>2345</TaxAndFee> <CurrencyCode>CNY</CurrencyCode> </DailyInfo> </DailyInfos> </PaxPriceRoom> </PaxPriceRooms> </RateInfo> </RateInfos> </RoomType> </RoomTypes> </Hotel> </SearchOrderResponse>