Distribution System API Interface Tickets & Packages Description 2019/06/08 Version : V3.7 DIRECTORY 目录 DOCUMENT INFORMATION ........................................................................................................................................ 7 DOCUMENT MODIFY HISTORY .......................................................................................................................... 7 MAIN CONTENTS AND PURPOSE ..................................................................................................................... 7 CHAPTER 1 OVERVIEW ............................................................................................................................................... 8 1.1 READING OBJECTS ........................................................................................................................................... 8 1.2 BUSINESS TERMS .............................................................................................................................................. 8 1.3 TECHNICAL SPECIFICATIONS ..................................................................................................................... 8 CHAPTER 2 PRODUCT LISTING API ...................................................................................................................... 9 2.1 FUNCTION DESCRIPTION ............................................................................................................................. 9 2.2 FUNCTION ILLUSTRATION ........................................................................................................................... 9 2.3 PARAMETER(S) DEFINITIONS ................................................................................................................. 9 2.3.1 GOAL ......................................................................................................................................................... 10 2.3.2 REQUEST ENDPOINT ......................................................................................................................... 10 2.3.3 REQUESTING PARAMETERS .......................................................................................................... 10 2.3.4 EXAMPLE ................................................................................................................................................. 11 2.4 API CALLBACK PARAMETERS .................................................................................................................... 12 2.4.1 DESCRIPTION ........................................................................................................................................ 12 2.4.2 CALLBACK PARAMETERS ................................................................................................................ 12 2.4.3 EXAMPLE ................................................................................................................................................. 13 CHAPTER 3 PRODUCT DETAILS API ....................................................................................................................... 17 3.1 FUNCTION DESCRIPTION ........................................................................................................................... 17 3.2 FUNCTION ILLUSTRATION ......................................................................................................................... 17 3.3 PARAMETER(S) DEFINITIONS ................................................................................................................... 17 3.3.1 GOAL ......................................................................................................................................................... 17 3.3.2 REQUEST ENDPOINT ......................................................................................................................... 18 3.3.3 REQUESTING PARAMETERS .......................................................................................................... 18 3.3.4 EXAMPLE ................................................................................................................................................. 18 3.4 API CALLBACK DESCRIPTION ............................................................................................................... 18 3.4.1 DESCRIPTION ........................................................................................................................................ 18 CHAPTER 4 BULK PRODUCTS STATUS RETRIEVING ...................................................................................... 27 4.1 FUNCTION DESCRIPTION ....................................................................................................................... 28 4.2 FUNCTION ILLUSTRATION ..................................................................................................................... 28 4.3 PARAMETER(S) DEFINITIONS ............................................................................................................... 28 4.3.1 GOAL ......................................................................................................................................................... 28 4.3.2 REQUEST ENDPOINT ......................................................................................................................... 28 4.3.3 REQUESTING PARAMETERS .......................................................................................................... 28 4.4 API CALLBACK DESCRIPTION .......................................................................................................................... 28 4.4.1 DESCRIPTION ........................................................................................................................................... 28 4.4.2 CALLBACK PARAMETERS ...................................................................................................................... 29 4.4.3 EXAMPLES ................................................................................................................................................. 29 CHAPTER 5 PRODUCT PRICE CALENDAR INTERFACE .................................................................................. 30 5.1 FUNCTION DESCRIPTION ....................................................................................................................... 30 5.2 FUNCTION ILLUSTRATION ..................................................................................................................... 30 5.3 PARAMETER(S) DEFINITIONS ............................................................................................................... 30 5.3.1 GOAL ..................................................................................................................................................... 30 5.3.2 REQUEST ENDPOINT ......................................................................................................................... 30 5.3.3 REQUESTING PARAMETERS .......................................................................................................... 30 5.3.4 EXAMPLE ................................................................................................................................................. 31 5.4 API CALLBACK DESCRIPTION .......................................................................................................................... 31 5.4.1 DESCRIPTION ........................................................................................................................................... 31 5.4.2 CALLBACK PARAMETERS ...................................................................................................................... 31 5.4.3 EXAMPLES ................................................................................................................................................. 31 CHAPTER 6 ORDER SAVING API .............................................................................................................................. 33 6.1 FUNCTION DESCRIPTION ........................................................................................................................... 33 6.2 FUNCTIONAL ILLUSTRATION ................................................................................................................... 33 6.3 PARAMETER(S) DEFINITIONS ................................................................................................................... 33 6.3.1 GOAL ......................................................................................................................................................... 33 6.3.2 REQUEST ENDPOINT ......................................................................................................................... 33 6.3.3 REQUESTING PARAMETERS .......................................................................................................... 33 6.3.4 EXAMPLE ............................................................................................................................................. 35 6.4 API CALLBACK DESCRIPTION ............................................................................................................... 36 6.4.1 DESCRIPTION ........................................................................................................................................ 36 6.4.2 CALLBACK PARAMETERS ................................................................................................................ 36 6.4.3 EXAMPLE ................................................................................................................................................. 37 CHAPTER 7 ORDERING DETAIL API ....................................................................................................................... 38 7.1 FUNCTION DESCRIPTION ........................................................................................................................... 38 7.2 FUNCTION ILLUSTRATION ......................................................................................................................... 38 7.3 PARAMETER(S) DEFINITIONS ................................................................................................................... 38 7.3.1 GOAL ......................................................................................................................................................... 38 7.3.3 REQUESTING PARAMETERS .......................................................................................................... 38 7.3.4 EXAMPLE ................................................................................................................................................. 38 7.4 API CALLBACK DESCRIPTION ................................................................................................................... 38 7.4.1 DESCRIPTION ........................................................................................................................................ 38 7.4.2 CALLBACK PARAMETERS ................................................................................................................ 39 7.4.3 EXAMPLE ................................................................................................................................................. 41 CHAPTER 8 ORDER LISTING API .............................................................................................................................. 44 8.1 FUNCTION DESCRIPTION ........................................................................................................................... 44 8.2 FUNCTION ILLUSTRATION ......................................................................................................................... 44 8.3 PARAMETER(S) DEFINITIONS ................................................................................................................... 44 8.3.1 GOAL ......................................................................................................................................................... 44 8.3.2 REQUEST ENDPOINT ......................................................................................................................... 44 8.3.3 REQUESTING PARAMETERS .......................................................................................................... 44 8.3.4 EXAMPLE ................................................................................................................................................. 45 8.4 API CALLBACK DESCRIPTION ................................................................................................................... 45 8.4.1 DESCRIPTION ........................................................................................................................................ 45 8.4.2 CALLBACK PARAMETERS ................................................................................................................ 45 8.4.3 EXAMPLE ................................................................................................................................................. 46 CHAPTER 9 ORDER PAYMENT CALLBACK API .................................................................................................. 49 9.1 FUNCTION DESCRIPTION ........................................................................................................................... 49 9.2 FUNCTION ILLUSTRATION ......................................................................................................................... 49 9.3 PARAMETER(S) DEFINITIONS ................................................................................................................... 49 9.3.1 GOAL ......................................................................................................................................................... 49 9.3.2 REQUEST ENDPOINT ......................................................................................................................... 49 9.3.3 REQUESTING PARAMETER ............................................................................................................. 49 9.3.4 EXAMPLE ................................................................................................................................................. 49 9.4 API CALLBACK DESCRIPTION ................................................................................................................... 49 9.4.1 DESCRIPTION ........................................................................................................................................ 49 9.4.2 CALLBACK PARAMETERS ................................................................................................................ 50 9.4.3 EXAMPLE ................................................................................................................................................. 50 CHAPTER 10 ORDER CANCELLATION API .......................................................................................................... 51 10.1 FUNCTION DESCRIPTION ......................................................................................................................... 51 10.2 FUNCTION ILLUSTRATION ...................................................................................................................... 51 10.3 PARAMETER(S) DEFINITIONS ................................................................................................................ 51 10.3.1 GOAL ....................................................................................................................................................... 51 10.3.3 REQUESTING PARA METERS ........................................................................................................ 51 10.3.4 EXAMPLE .............................................................................................................................................. 51 10.4 API CALLBACK DESCRIPTION ................................................................................................................. 51 10.4.1 DESCRIPTION ..................................................................................................................................... 51 10.4.2 CALLBACK PARAMETERS .............................................................................................................. 51 10.4.3 EXAMPLE .............................................................................................................................................. 52 CHAPTER 11 PART OF ORDER CANCELLATION API ...................................................................................... 52 11.1 FUNCTION DESCRIPTION ......................................................................................................................... 52 11.2 FUNCTION ILLUSTRATION ...................................................................................................................... 52 11.3 PARAMETER(S) DEFINITIONS ................................................................................................................ 52 11.3.1 GOAL ....................................................................................................................................................... 52 11.3.3 REQUESTING PARAMETERS ........................................................................................................ 53 11.3.4 EXAMPLE .............................................................................................................................................. 53 11.4 API CALLBACK DESCRIPTION ................................................................................................................. 53 11.4.1 DESCRIPTION ..................................................................................................................................... 53 11.4.2 CALLBACK PARAMETERS .............................................................................................................. 53 CHAPTER 12 APPLY ORDER CANCELLATION API ........................................................................................... 60 12.1 FUNCTION DESCRIPTION ......................................................................................................................... 60 12.2 FUNCTION ILLUSTRATION ...................................................................................................................... 60 12.3 PARAMETER(S) DEFINITIONS ................................................................................................................ 60 12.3.1 GOAL ....................................................................................................................................................... 60 12.3.3 REQUESTING PARAMETERS ........................................................................................................ 60 12.3.4 EXAMPLE .............................................................................................................................................. 61 12.4 API CALLBACK DESCRIPTION ................................................................................................................. 61 12.4.1 DESCRIPTION ..................................................................................................................................... 61 12.4.2 CALLBACK PARAMETERS .............................................................................................................. 61 CHAPTER 13 BULK ORDERS STATUS RETRIEVING ......................................................................................... 62 13.1 FUNCTION DESCRIPTION ..................................................................................................................... 62 13.2 FUNCTION ILLUSTRATION .................................................................................................................. 62 13.3 PARAMETER(S) DEFINITIONS ............................................................................................................. 62 13.3.1 GOAL ....................................................................................................................................................... 62 13.3.2 REQUEST ENDPOINT ...................................................................................................................... 62 13.3.3 REQUESTING PARAMETERS ........................................................................................................ 62 13.4 API CALLBACK DESCRIPTION ........................................................................................................................ 62 13.4.1 DESCRIPTION ......................................................................................................................................... 63 13.4.2 CALLBACK PARAMETERS .................................................................................................................... 63 13.4.3 EXAMPLES .............................................................................................................................................. 63 CHAPTER 14 LANDSCAPE API ................................................................................................................................... 64 14.1 FUNCTION DESCRIPTION ......................................................................................................................... 64 14.2 FUNCTION ILLUSTRATION ...................................................................................................................... 64 14.3 PARAMETER(S) DEFINITIONS ................................................................................................................ 64 14.3.1 GOAL ....................................................................................................................................................... 64 14.3.3 REQUESTING PARAMETERS ........................................................................................................ 64 14.3.4 EXAMPLE .............................................................................................................................................. 65 14.4 API CALLBACK DESCRIPTION ................................................................................................................. 65 14.4.1 DESCRIPTION ..................................................................................................................................... 65 14.4.2 CALLBACK PARAMETERS .............................................................................................................. 65 CHAPTER 15 CITY API ................................................................................................................................................... 67 15.1 FUNCTION DESCRIPTION ......................................................................................................................... 67 15.2 FUNCTION ILLUSTRATION ...................................................................................................................... 67 15.3 PARAMETER(S) DEFINITIONS ................................................................................................................ 67 15.3.1 GOAL ....................................................................................................................................................... 67 15.3.3 REQUESTING PARAMETERS ........................................................................................................ 68 15.3.4 EXAMPLE .............................................................................................................................................. 68 15.4 API CALLBACK DESCRIPTION ................................................................................................................. 68 15.4.1 DESCRIPTION ..................................................................................................................................... 68 15.4.2 CALLBACK PARAMETERS .............................................................................................................. 68 CHAPTER 16 LANDSCAPE TAG API ........................................................................................................................ 63 16.1 FUNCTION DESCRIPTION ......................................................................................................................... 63 16.2 FUNCTION ILLUSTRATION ...................................................................................................................... 63 16.3 PARAMETER(S) DEFINITIONS ................................................................................................................ 64 16.3.1 GOAL ....................................................................................................................................................... 64 16.3.3 REQUESTING PARAMETERS ........................................................................................................ 64 16.4 API CALLBACK DESCRIPTION ................................................................................................................. 64 16.4.1 DESCRIPTION ..................................................................................................................................... 64 16.4.2 CALLBACK PARAMETERS .............................................................................................................. 65 CHAPTER 17 RESEND MOBILE API ......................................................................................................................... 67 17.1 FUNCTION DESCRIPTION ......................................................................................................................... 67 17.2 FUNCTION ILLUSTRATION ...................................................................................................................... 67 17.3 PARAMETER(S) DEFINITIONS ................................................................................................................ 67 17.3.1 GOAL ....................................................................................................................................................... 67 17.3.2 REQUEST ENDPOINT ...................................................................................................................... 67 17.3.3 REQUESTING PARAMETERS ........................................................................................................ 67 17.3.4 EXAMPLE .............................................................................................................................................. 67 17.4 API CALLBACK DESCRIPTION ................................................................................................................. 67 17.4.1 DESCRIPTION ..................................................................................................................................... 67 17.4.2 CALLBACK PARAMETERS .............................................................................................................. 68 17.4.3 EXAMPLE .............................................................................................................................................. 68 18 PUSH NOTIFICATION ASYNCHRONOUS ...................................................................................................... 68 18.1 ORDER CONFIRMATION NOT IFICATION ......................................................................................... 68 18.1.1 FUNCTION DESCRIPTION ............................................................................................................ 68 18.1.2 PARAMETER(S) DEFINITIONS .................................................................................................... 68 18.1.3 API CALLBACK DESCRIPTION .................................................................................................... 68 18.1.3.1 DESCRIPTION .................................................................................................................................. 68 18.2 ORDER CANCELLATION NOTIFICATION ........................................................................................... 69 18.2.1 FUNCTION DESCRIPTION ............................................................................................................ 69 18.2.2 PARAMETER(S) DEFINITIONS .................................................................................................... 69 18.2.3 API CALLBACK DESCRIPTION .................................................................................................... 69 18.3 ORDER VERIFICATION NOTIFICATION .............................................................................................. 69 18.3.1 FUNCTION DESCRIPTION ............................................................................................................ 69 18.3.2 PARAMETER(S) DEFINITIONS .................................................................................................... 70 18.3.3 API CALLBACK DESCRIPTION .................................................................................................... 70 18.3.3.1 DESCRIPTION .................................................................................................................................. 70 18.4 ORDER ARRANGEMENT (TICKET NOTIFICATION) NOTIFICATION ..................................... 70 18.4.1 FUNCTION DESCRIPTION ............................................................................................................ 70 18.4.3 API CALLBACK DESCRIPTION .................................................................................................... 71 18.5 RETURN CORRECTION APPLICATION RESULT NOTIFICATION ............................................ 72 18.5.1 FUNCTION DESCRIPTION ............................................................................................................ 72 18.5.2 PARAMETER(S) DEFINITIONS .................................................................................................... 72 18.5.3 API CALLBACK DESCRIPTION .................................................................................................... 72 18.6 PRODUCT UPDATE NOTIFICATION ..................................................................................................... 72 18.6.1 FUNCTION DESCRIPTION ............................................................................................................ 72 18.6.2 PARAMETER(S) DEFINITIONS .................................................................................................... 73 18.6.3 API CALLBACK DESCRIPTION .................................................................................................... 73 DOCUMENT INFORMATION DOCUMENT MODIFY HISTORY The Version Modify Summary Amendment Version Date Number V3.0 20150715 Organize tickets, package API Wang Zhong Xin improved V3.1 20150915 List , add a field to the query fields for Wang Zhong Xin all packaged products, increases the package's API for details, under a single interface xml. The spelling of the API entry is not the same, please see document MAIN CONTENTS AND PURPOSE This document describes the platform ticket package API. It corresponds to distribution channel development programs. CHAPTER 1 OVERVIEW 1.1 READING OBJECTS This API document are capable the web site development, understanding ASP 、 PHP 、 JAVA 、 ASP.NET and other development languages, and xml Data analysis web site development, maintenance, and management. 1.2 BUSINESS TERMS Terminology Explanation Request By HTTP Agreement to transfer data to the receiving process. Notification Server asynchronous notification. According to the data received after the completion of the distribution system. Distribution system servers initiate notice to the merchant's Web site, the result of the processed information which back to the merchant's website simultaneously. Return Go to page for synchronization notifications. According to the data received after the completion of the distribution system, the pages of the current page from the distribution system automatically jump Data Data downlink for downloading data from the server using HTTP GET To Downlink transfer the data. Data Uplink Data uplink to upload data to the server. It is using HTTP POST To transfer the data. Permissions Accounts permission verification registered through distributors in the Verification distribution system ID And password for authentication. Code 1.3 TECHNICAL SPECIFICATIONS Entry Specifications Character set Character set Unicode: UTF-8 Server support data transfer HTTP GET/POST standard Server returns data format XML API Server supports application ASP/ASP.NET 、 PHP 、 JAVA 、 Python 、 Ruby, development language etc CHAPTER 2 PRODUCT LISTING API 2.1 FUNCTION DESCRIPTION Keyword search (Realization of Word) Search by city (Supporting provinces and cities, supports multiple merger) Search by attraction account Attractions in tag search (Supports multiple labels merge) Search by category Specific categories of individual parameter support Search by location (Longitude and latitude + Distance) Filter conditions (Payment, confirmation, delivery methods) Support sorting (According to the recommended value, sales volume, last time) Support page 2.2 FUNCTION ILLUSTRATION 2.3 PARAMETER(S) DEFINITIONS 2.3.1 GOAL Request parameters are operators when API with a data distribution system. Request data provided to the distribution system, so that the data distribution system is based on further processing. 2.3.2 REQUEST ENDPOINT http://distribution domain name/api/list.jsp 2.3.3 REQUESTING PARAMETERS Parameters Parameter Type Parameter description Can name (Length) be empty Common parameters custId Customer ID Long Primary key of the table Not Null apikey Verification String Contact the system Not code operator for availability Null Search parameters keyWrod Keyword String(20) Automatic segmentation Null treeId Product type int 0 Single tickets 1 Package or combined Not ticket Null cityName City name String Supported by province or city name search, search Null multiple areas simultaneously " , "Separate isPay Means of int 0 Offline payment Null payment 1 Online payment isConfirm Confirmation int 0 Indicates that the system form automatically confirms the Null order 1 Manual confirmation isExpress Distribution int Without distribution Null methods Required distribution viewId Attractions String The distribution system account provides the attractions Null account (access see landscape API ) tagIds Attractions Int The distribution system tags provides the attractions tags ( Access to see Null landscape API ) Supports multiple tag query " , "Separate location Location String Format: ( Longitude, information latitude, and radius of Null distance ) Default distance 2 Km pageNum The number of int Default 50 Section, you can pages set up 100 Null displayed pageNo Pages int The default first page Null orderBy Sorting 0 By Price method 1 By Discount 2 By sales Null 3 According to the recommended value 4 Last time is Package Packaged int Whether packaged products products, 0 separate products, 1 packaged products (Remarks isPackage can only pass 0 Null or 1, it is not query packaged products which do not fill directly, packaged products treeId=1 ) 2.3.4 EXAMPLE Sample 1: Search multiple city products ?cityName= Beijing , Tianjin , Shijiazhuang at the same time Sample 2 : Search spa products ?tagIds= 60018 Sample 3 : Search for products that are 5 kilometers from a location ?location= 108.29536000, 22.73270000,5000 2.4 API CALLBACK PARAMETERS 2.4.1 DESCRIPTION Distribution system provides the requested data which are processed and returned to the merchant data to businesses. It is based on these data for further processing. 2.4.2 CALLBACK PARAMETERS Parameters Parameter description The root parameter totalNum Total number of search results status Status 0 failed 1 succeed msg callback message List of parameters productNo Product ID productName Product name img Picture address isOnlinepay Must be paid online payment 0 No 1 Yes ticketCount Number of sold salePrice Sale price cityName City Name cutPrice Online payment by the established price marketPrice Market price express Distribution orderDesc Booking notes priceStartDate Product sales start time priceEndDate Product sales end time viewName Scenic spots name viewLongitude Scenic spots longitude viewLatitude Scenic spots latitude viewAddress Scenic spots address viewId Scenic spots unique identification treeId Product type ( 0 Tickets, 1 Package or packages products 2 independent travel, 3 Lines) isPackage Whether packaged products, 0 separate products, 1 packaged products isCode (Code, shipping) operations 0. need, 1. Do not need is_top Recommended values pubDate Publication or archiving time 2.4.3 EXAMPLE <?xml version="1.0"?> <result> <totalNum> <! [CDATA[2516]]> </totalNum> <status> <! [CDATA[1]]> </status> <products> <product> <productNo> <! [CDATA[18580]]> </productNo> <productName> <! [CDATA[ Suzhou Park tickets for the joy to the world]]> </productName> <img> <! [CDATA[http:// distribution domain name /API/1122/1316080457760.PNG,http:// distribution domain name /API/1122/1316080457760.PNG ]]> </img> <isOnlinepay> <! [CDATA[1]]> </isOnlinepay> <ticketCount> <! [CDATA[653]]> </ticketCount> <salePrice> <! [CDATA[123]]> </salePrice> <cityName> <! [CDATA[ Suzhou]]> </cityName> <cutPrice> <! [CDATA[0]]> </cutPrice> <marketPrice> <! [CDATA[130]]> </marketPrice> <express> <! [CDATA[ no distribution]]> </express> <orderDesc> <! [CDATA[1 to 10 bookings must be made 1 day in advance, 10 or more bookings can be made 1 day in advance to enjoy a lower discount, must be order before 23:00. It is paid by online payments. ]]> </orderDesc> <priceStartDate> <! [CDATA[2012-01-20]]> </priceStartDate> <priceEndDate> <! [CDATA[2012-06-30]]> </priceEndDate> <viewName> <! [CDATA[ Suzhou Park]]> </viewName> <viewLongitude> <! [CDATA[120.54809765075686]]> </viewLongitude> <viewLatitude> <! [CDATA[31.2920695619789]]> </viewLatitude> <viewAddress> <! [CDATA[ Jinshan road, Suzhou New District, Jiangsu, China 87]]> </viewAddress> <viewId> <! [CDATA[szly]]> </viewId> </product> <product> <productNo> <! [CDATA[10141]]> </productNo> <productName> <! [CDATA[ Wuhu special joy to the world tickets are only suitable for self-driving guests]]> </productName> <img> <! [CDATA[http:// distribution domain name /API/1122/1316144821054.jpg]]> </img> <isOnlinepay> <! [CDATA[1]]> </isOnlinepay> <ticketCount> <! [CDATA[1878]]> </ticketCount> <salePrice> <! [CDATA[150]]> </salePrice> <cityName> <! [CDATA[ Wuhu]]> </cityName> <cutPrice> <! [CDATA[0]]> </cutPrice> <marketPrice> <! [CDATA[180]]> </marketPrice> <express> <! [CDATA[ free shipping]]> </express> <orderDesc> <! [CDATA[Book 1 day in advance, must be order before17:00, minimum order is 1, it requires online payment. ]]> </orderDesc> <priceStartDate> <! [CDATA[2011-05-28]]> </priceStartDate> <priceEndDate> <! [CDATA[2012-03-31]]> </priceEndDate> <viewName> <! [CDATA[ Wuhu special joy to the world]]> </viewName> <viewLongitude> <! [CDATA[118.37669]]> </viewLongitude> <viewLatitude> <! [CDATA[31.3769]]> </viewLatitude> <viewAddress> <! [CDATA[ silver road, Wuhu city, Anhui Province]]> </viewAddress> <viewId> <! [CDATA[fangte]]> </viewId> </product> </products> </result> CHAPTER 3 PRODUCT DETAILS API 3.1 FUNCTION DESCRIPTION This API provides detailed display of the product, including description of the product specification, description of the reservation and detailed description of the product; In the product details page can be displayed through the calendar price and can be scheduled (see product price calendar API); In the product details page can display a list of related products to improve the user's conversion rate (see landscape tag API). 3.2 FUNCTION ILLUSTRATION 3.3 PARAMETER(S) DEFINITIONS 3.3.1 GOAL Merchants can submit products distribution systems; distribution systems return the products for more information. 3.3.2 REQUEST ENDPOINT http:// Distribution of domain names /api/detail.jsp 3.3.3 REQUESTING PARAMETERS Parameters Parameter name Type Parameter Whether (Length) description Null Common parameters custId Customer ID Long Primary key of the Not Null table apikey Verification code String Contact the system Not Null operator for availability Search parameters productNo Product ID int Product information Not Null number 3.3.4 EXAMPLE Sample 1: ? productNo =5966213 3.4 API CALLBACK DESCRIPTION 3.4.1 DESCRIPTION The distribution system processes the request data. It is provided by the merchant and returns the detailed contents of the product. The merchant can operate the returned data according to the need. 3.4.2 CALLBACK PARAMETERS 3.4.2.1 CALLBACK PARAMETERS - TICKETS , PACKAGE PRODUCTS DETAILS Parameters Parameter Type Parameter Notes name (Length description range result status API call status Integer Yes 1 succeed, 0 failed msg API callback String No The API call exception will message have this field product productNo Product ID Integer Yes productName Product name String Yes ticketTypeName Ticket types String Yes peopleNum Products Integer Yes contain a number of adult childrenNum Products Integer Yes include number of children img Signage String No imgs Related String No Multiple pictures are pictures separated by commas isOnlinepay Payment Integer Yes 1 online payment (prepaid), 0 Method hotel front desk pay (rebate) isSingle Guest Integer Yes 1 request to enter each guest information information, 0 only need to request enter a guest information startDate Date of first String Yes Format for yyyy-MM-dd visit treeId Self-Tour Integer Yes 0 Tickets 1 Package product type viewName Attractions String Yes name viewAddress Attractions String Yes Address cityName Attractions String Yes home viewId Attractions in String Yes numbers SettlementPrice Distribution Double Yes prices cutPrice Discounted Double No price salePrice Retail price Double Yes marketPrice Market price Double Yes startNum Minimum Integer Yes 0 Unlimited booking number isExpress Support Integer Yes 1 Support, 0 Not support express delivery expressPrice Delivery costs Double No topReason Recommended String No reason isFree Supports free Integer Yes 1 Support, 0 Not support distribution methods startTime Before some String Yes MM:SS reservation startMinute How many int Yes minutes after the reservation to take effect payMinute How many int Yes minutes do not pay automatically cancelled cancelDay How many int Yes Value 0 means cannot return days before the value which is positive. How travel date can many days can refund before be refunded play date? When the value is negative, how many days can refund after play date? validityType Lifetime limit Int Yes 0: The selected play date is valid for the day 1: Visitor's reservation date is valid for several days 2: Visitor's reservation date is valid until the specified date 3: The selected date is delayed for a few days 4: Visitor's selected date is valid until the specified date validityCon Valid for String No Format for yyyy-MM-dd Or specific days or digital date startDay How many int Yes days in advance booking distributionDesc Free of charge String No Need distribution and with support the free distribution instructions of products, the field can has a value orderDesc Reservation String No description businessHours Business hours String No description peoples Product groups String No requirement priceStartDate Prices start String Yes Format for yyyy-MM-dd time priceEndDate Prices end time String Yes Format for yyyy-MM-dd orderPolicy Booking String Yes description content Product String No introduction custField Guest booking String Yes e.g. link_man,link_phone needs to fill in information isConds Whether the Integer Yes 1 Yes, 0 No product has value-added items conds cond condId Value - added Integer Yes product number condTitle Value - added String Yes product name isSync Limit number Integer Yes 0 can be selected number of people individually ,1 must be consistent with order number isGotta Whether it Integer Yes 0 Optional, 1 Required must be purchased isApiece Quotes Integer Yes 1 In accordance with the number of quotes, 2 Charges has nothing to do with the number limit Minimum Integer Yes Requires a minimum of number of several people to purchase people this service marketPrice Market price Double Yes salePrice Retail price Double Yes treeId Value-added Integer Yes 0 Accommodation products 1 Food and beverage 2 Car Rental (Transfer) 3 Entertainment and leisure 4 Shopping 5 Play the project 6 Healthy health 7 Tour guide service 8 Distribution services 9 Travel Insurance 10 Visa services 11 Boarding (Reception) Location 12 Transportation unit Value-added String Yes Such as, Zhang, Item, People, products Night state Product status String Yes 0 online, 1 offline charge_include Price include String No refund_note Refund String No instruction user_note Instruction String No important_note Important String No notice ticketCount Sales volume String No attentCount Following String No quantity custFieldEx Expansion String No custom information required for customer booking is_confirm Whether to string Yes 0 instant confirmation, require 1 manual confirmation manual confirmation treeId Product type Integer Yes 0 ticket, 1 package isCode Issue Integer No Issue ticket (issue code, ticket(issue delivery) operation code, delivery) 0.yes, 1.no cancelRule Refund policy Array No list rule Refund policy Object No days Valid refund Integer No How many days can process date refund after that, negative. hours Valid refund Integer No time cancelMoneyCodex Reseller can String No refund returnMoneyCodex Withdraw by String No supplier agreeForcetg Whether to Integer No 0 Not supported by default, support forced 1 Support refund process after booking completion 3.4.2.2 CALLBACK PARAMETERS - PACKAGED PRODUCT DETAILS Parameters Parameter Type Parameter Notes name (Length description range result status API call status Integer Yes 1 succeed, 0 failed msg API callback String No The API call exception will has message this field product productNo Product ID Integer Yes productName Product name String Yes img Signage String No imgs Related String No Multiple pictures are separated pictures by commas isOnlinepay Payment Integer Yes 1 Online payments (advances), 0 method Hotel front desk pay (rebate) isSingle Guest Integer Yes 1 Enter each guest information information requested, 0 Only need to enter request a guest information startDate The earliest String Yes Format for yyyy-MM-dd date of play treeId Self-tour Integer Yes 0 Tickets 1 Package product type isPackage Whether it is String Yes Tree_id=1 And Is[ackage=1 is package package set, tree_id=1 is the normal set viewName Name of scenic String Yes spot viewAddress Scenic address String No cityName City name String Yes cityId City address String Yes viewId Scenic ID String Yes ticketCount Count String No SettlementPrice Distribution Double Yes prices salePrice Retail price Double Yes marketPrice Market price Double Yes isExpress Whether String Yes Whether support express, 0 Not support support, 1 Support express expressPrice Delivery costs String No isFree Whether Interger Yes 1 Support 0 Not support support free ticket distributionDesc Free ticket String No Need distribution and support delivery the free distribution of products, description the field can had a value orderDesc Booking String Yes description businessHour s Business hours String No topReason Recommended String No reason orderPolicy Merge String No subscription instructions content Product details String No custField Tourists String Yes 1 Enter each guest information required fields requested, 0 Only need to enter a guest information isConds Products have Integer Yes 1 Yes, 0 No enhanced project startTime Before String No MM:SS reservation startMinute Advance String Yes How many minutes must be booking time booked in advance startNum Minimum String No number of bookings startDay Advance String Yes booking days conds cond Enhanced project node condId Value added Integer Yes product number condTitle Value added String Yes product names isSync Limite number Integer Yes 0 can be selected number of people individually ,1 must be consistent with order number isGotta Whether it Integer Yes 0 Optional, 1 Required must be purchased isApiece Quotations Integer Yes 1 in accordance with the number of quotes, 2 charges has nothing to do with the number limit Minimum Integer Yes Requires a minimum of several number of people to purchase this service people marketPrice Market price Double Yes salePrice Retail price Double Yes treeId Value-added Integer Yes 0 Accommodation products 1 Restaurants 2 Car rental ( Shuttle) 3 Recreation and leisure 4 Shopping 5 Attractions 6 Health 7 Tour guide service 8 Distribution services 9 Travel insurance 10 Visa Services 11 Boarding (Reception) Location 12 Traffic unit Value-added String Yes Such as, Zhang, Item, People, products Night packageProducts The parent of the child product associated with the packaged product packageProduct The sub product node associated with the packaged product infoIdNode String Sub products ID infoNameNode String Sub product name numNode integer Contains the quantity treeIdNode integer Product type (0 tickets, 5 hotels) isDateNode interger Play Date: 0, the choice of packaged products, visitors of the day effective, 1, the choice of packaged products, visitors delayed 1 day effective, 2, postponed 2 days effective, 3, delayed 3 days effective, 4, delayed 4 days effective, 5, delayed 5 days effective, -1, not limited to time, Visitors choose the play dates view Id Node String Sub Product ID viewNameNode String Sub-product attractions name viewAddressNode String Sub-product attractions address CHAPTER 4 BULK PRODUCTS STATUS RETRIEVING 4.1 FUNCTION DESCRIPTION Products code support bulk query products status retrieving. (Multiple product numbers are separated by ",") 4.2 FUNCTION ILLUSTRATION Nil 4.3 PARAMETER(S) DEFINITIONS 4.3.1 GOAL Parameter(s) definitions which request data provided by the merchant distribution system when the data is interacted with the distribution system. So that the distribution system can process and base on the data. 4.3.2 REQUEST ENDPOINT http:// Distribution of domain names /api/getProductState.jsp 4.3.3 REQUESTING PARAMETERS Parameters Parameter name Type Parameter Can be (Length) description empty Common parameters custId Customer ID Long Primary key of the Not Null table apikey Verification code String Contact the system Not Null operator for availability Search parameters productNo Product ID String Support Not Null multi-products enquiry by delimiter “,” 4.3.4 EXAMPLE EXAMPLE 1:Get the multiple products status at the same time ?productNo=5970991,10083,5966213 4.4 API CALLBACK DESCRIPTION 4.4.1 DESCRIPTION After the distribution system processes the request data. It is provided by the merchant and will return the data result to the merchant. So that the merchant can process and is according to the data. 4.4.2 CALLBACK PARAMETERS Parameter Parameter Description Root parameter productNo Product ID status Status 0 failed 1 succeed msg callback message productState Products Status 0 active 1 in-active 2 removed 4.4.3 EXAMPLES <?xml version="1.0" encoding="UTF-8"?> <result> <status> <![CDATA[1]]> </status> <products> <product> <productNo> <![CDATA[10083]]> </productNo> <productState> <![CDATA[0]]> </productState> </product> <product> <productNo> <![CDATA[5970991]]> </productNo> <productState> <![CDATA[0]]> </productState> </product> </products> </result> CHAPTER 5 PRODUCT PRICE CALENDAR INTERFACE 5.1 FUNCTION DESCRIPTION This API provides a search by date which returns the current month price list functions. 5.2 FUNCTION ILLUSTRATION 5.3 PARAMETER(S) DEFINITIONS 5.3.1 GOAL The request parameters include the merchant's product number and date to query for the product. 5.3.2 REQUEST ENDPOINT http:// Distribution of domain names /api/price.jsp 5.3.3 REQUESTING PARAMETERS Parameters Parameter name Type Parameter Can be (Length) description empty Common parameters custId Customer ID Long Primary key of the Not Null table apikey Verification code String Contact the system Not Null operator for availability Search parameters productNo Product ID Int Product unique Not Null number travelDate Start Date Date Time format: Null 2011-01-01 endTravelDate End date Date Time format: Null 2011-01-01 5.3.4 EXAMPLE Sample 1: Search scheduled date as a product price calendar on January 1, 2015 ?productNo=5970991&travelDate=2015-01-01 5.4 API CALLBACK DESCRIPTION 5.4.1 DESCRIPTION The distribution system processes the request data provided by the merchant and returns the result data to the merchant for further processing based on the data. 5.4.2 CALLBACK PARAMETERS Parameter Parameter Description Root parameter productNo Product ID status Status 0 failed 1 succeed msg callback message List parameters date Date format is 2015-01-01, no date indicates that product is available for sale on that day. marketPrice Market price. Is the scenic window price or hotel listing price. salePrice Request the retail price, the selling price of tourists. remainNum Number of products remaining, 999 means unlimit. SettlementPrice Price result 5.4.3 EXAMPLES <?xml version="1.0" encoding="UTF-8"?> <result> <productNo> <! [CDATA[10083]]> </productNo> <status> <! [CDATA[1]]> </status> <prices> <price> <date>2012-03-05</date> <marketPrice>90</marketPrice> <salePrice>75</salePrice> <remainNum> <! [CDATA[0]]> </remainNum> < SettlementPrice > Settlement price </ SettlementPrice > </price> Omit ...... </prices> </result> CHAPTER 6 ORDER SAVING API 6.1 FUNCTION DESCRIPTION This API can submit business data processing and save the generated order. 6.2 FUNCTIONAL ILLUSTRATION Nil 6.3 PARAMETER(S) DEFINITIONS 6.3.1 GOAL In the order of merchants, the specific information in xml format submits the distribution system and save the generated order. 6.3.2 REQUEST ENDPOINT http:// Distribution of domain names /api/order.jsp 6.3.3 REQUESTING PARAMETERS Parameters Parameter Type Parameter Whether name (Length) description Null Common parameters custId Customer ID Long Primary key of the Not Null table apikey Verification String Contact the system Not Null code operator for availability Order content (xml) param Uplink String Format: xml Not Null parameter name param Parameters The root node < order>...</ order> travel_date Travel dates Date Travel dates Not Null end_travel_date End time Date End date (Hotel and Null car rental business parameters) arri ved_time Arrival Time Date Time of arrival (Hotel Null and car rental business parameters) info_id Info ID Int Product Not Null identification cust_id Distributor Long The system provides Not Null account a unique ID for the merchant get_type Select shipping Int Ticket delivery, Null method 0 Free, 1 Courier fee order_source_id Order serial string Order number of the See number docking system remarks A (unique) 3E order_memo Visitor notes Clob Order notes Null num Reservation Int Reservation number Not Null number user_id User identity String User identity Null link_man Contact name String The name must use Not Null scenic for validation. link_phone Contact phone StringD Receive order Not Null number messages or electronic codes link_email Contact email String Receiving order or See an electronic ticket remarks l ink_address Delivery String Use express See address remarks linkCode Zip code String Zip code See remarks link_credit_type Contact Int 0 ID card See document type 1 Student card remarks 2 Military ID 3 Passport 4 This account (select this item for children) 5 Hong Kong and Macau pass 6 MTP link_credit_no Contact ID String Certificate number See number ( Enter the child date remarks of birth) param Parameter other contact node <peoples>...</peoples> link_man Contact name String The name must use Not Null scenic for validation. link_credit_type Contact Int 0 ID card See document type 1 Student card remarks 2 Military ID 3 Passport 4 This account ( Select this item for children) 5 Hong Kong and Macau pass 6 MTP link_credit_no Contact ID String Certificate number See number ( Enter child date of remarks birth) param Parameter value node of the project <conds><cond>...</cond></conds> cond_id Value added Int Value added items id Not Null items id num Number of Int Actual number of Not Null value added reservation Package product exclusive node, note that (only treeId=1 And isPackage=1 must require) Param Parameter package node <prods><prod>.....</prod></prods> prod_id Sub products Int ID Not Null ID prod_date Sub products String Play dates Not Null, the play date format is yyyy-MM-dd Notes: △ 1 E link_address 、 linkCode 、 link_credit_type 、 link_credit_no, Fill in, see the contents of the "custField" parameter returned by the Product Details interface. △ 2 E <peoples/> If the return value is "1", it is not null (must be filled in) if the node is filled in, see the contents of the "isSingle" parameter returned by the product details interface. △ 3 E order_source_id You cannot enter, the system will verify after entering, if the same order_source_id will be no longer in the next order.. 6.3.4 EXAMPLE Sample 1 : ¶m=<order><travel_date>2012-04-01</travel_date><info_id>5970991</info_id><user_id></u ser_id><cust_id>1562 </cust_id><get_type>0</get_type><order_source_id> order serial number </order_source_id><order_memo> </order_memo><num>1</num><link_man>%e8%b5%b5%e5%86%9b</link_man><link_phone>15 652667680</link_phone><link_address>< /link_address><link_code></link_code><link_email>33333333@qq.com</link_email><link_credit_ty pe></link_credit_type><link_ credit_no></link_credit_no><peoples></peoples><conds></conds></order> Package looks like: ¶m=<root><travel_date>2015-09-19</travel_date><end_travel_date>2015-09-19</end_travel_ date><info_id>7296194</info_ id><user_id><! [CDATA[xxxx]]></user_id><cust_id>8888</cust_id><get_type>0</get_type><order_memo><! [CDATA[ceshi]]></order_memo><num>1</num><sorder_source_id>134355</order_source_id>< link_man><! [CDATA[ceshi]]></link_man><link_phone><! [CDATA[1355555555]]></link_phone><link_address<! [CDATA[]]></link_address><link_code><! [CDATA[]]></link_code><link_email><! [CDATA[]]></link_email><link_credit_type><! [CDATA[4]]></link_credit_type><link_credit_no><! [CDATA[2003-09-08]]></link_credit_no><details><detail><cond><! [CDATA[2015-09-19]]></cond><num>1</num> <sale_price></sale_price></detail></details><peoples></peoples><prods><prod><prod_id>7221 162</prod_id>< prod_date>2015-09-19</prod_date></prod>....<prod></prod></prods></root> 6.4 API CALLBACK DESCRIPTION 6.4.1 DESCRIPTION Distribution system requests to provide data processing, distribution system returns the order number, order status, order information. 6.4.2 CALLBACK PARAMETERS Parameters Parameter description status Status 0 failed 1 succeed msg callback message order_id Order number order_money Order amount order_state Order status: 0 Indicates wait for manual confirmation 1 Indicates pre- payment 2 Indicates a successful error_state Error callback status code (only status=0, it will has this node) error_msg Error callback message (only status=0, it will has this node) 6.4.3 EXAMPLE <?xml version="1.0" encoding="UTF-8"?> <result> <status> <! [CDATA[1]]> </status> <msg> <! [CDATA[Enter the order successfully! This order requires online payment to be valid! ]]> </msg> <order_id> <! [CDATA[307580]]> </order_id> <order_money> <! [CDATA[1.0]]> </order_money> <order_state> <! [CDATA[1]]> </order_state> </result> CHAPTER 7 ORDERING DETAIL API 7.1 FUNCTION DESCRIPTION This API allows the function of returning order details which is according to the order number.. 7.2 FUNCTION ILLUSTRATION Nil 7.3 PARAMETER(S) DEFINITIONS 7.3.1 GOAL Request parameters is the unique identifier for each order of the order number, the merchant provides the order number to the distribution system, and the distribution system returns the details of the order. 7.3.2 REQUEST ENDPOINT http:// Distribution of domain names /api/orderDetail.jsp 7.3.3 REQUESTING PARAMETERS Parameters Parameter name Type Parameter Whether (Length) description Null Common parameters custId Customer ID Long Primary key of the Not Null table apikey Verification code String Contact the system Not Null operator for availability Search parameters orderId Order number Int Order identification Not Null 7.3.4 EXAMPLE It looks like: ?orderId=33521 7.4 API CALLBACK DESCRIPTION 7.4.1 DESCRIPTION Distribution system is according to the order number. It is provided by the merchant processing, returned to the merchant, including the order status, contact information and other orders, in order to track business orders on time and the corresponding operation. According to xml In the password field cancelState cancelStateTXT cancelState Is the refund request status values cancelStateTXT Refund is Chinese description of status values A total of 6 Status: cancelStateTXT[0]=" -Free cancellation"; cancelStateTXT[1]=" Cancellation pending"; cancelStateTXT[2]=" Cancel your application has passed , Cancelling , You can call cancelOrder Interface to cancel the order without waiting for suppliers directly"; cancelStateTXT[3]=" Cancel your application has passed , Cancellation success"; cancelStateTXT[4]=" Cancellation request was denied , Cancellation failed "; cancelStateTXT[5]=" Cancellation cancel too much, Go manual query"; 7.4.2 CALLBACK PARAMETERS Parameters Parameter description The root parameter status Status 0 failed 1 succeed msg callback message List of parameters orderState Order status: 0 New orders 1 Confirmed 2 Has been successfully 3 Has been canceled 4 Completed isOnlinepay Must be pay online, 0 No, 1 Yes isConfirm If you need confirmation which is valid 0 Not need to confirm 1 Need to confirm getType Ticket delivery 0 Free 1 Courier fee 3 No distribution getPrice Courier charges ( getType ) is 0 、3 Go here 0, Without display freeMemo If ( getType ) 0, That means the take ticket location or the take ticket method. productNo Product identification information productName Product title num Reservation number salePrice Foreign suggested retail price marketPrice Window prices orderMoney Tourists order amount payMoney Tourists the actual paid amount isCancel Whether an order can be cancelled, 0 Do not allow 1 Allow cancelMoney Refund amount ( If you can cancel the actual refund amount , otherwise 0) payUrl Payment URL linkMan Contact name linkPhone Contact phone linkEmail Contact email linkAddress Contact address linkCreditType Contact document type linkCreditNo Contact ID number linkCode Zip code travelDate Play date format: 2011-01-01 orderDate Order date format: 2011-01-01 00:00:00 cancelDate Cancel order date format: 2011-01-01 00:00:00 orderMemo Order remarks Order code information node <codeUrls><codeUrl>...</codeUrl></codeUrls> codeUrl Url codeType 0 text type 1 QR code 2 Pdf 3 url Other contact parameter node <peoples><people>...</people></peoples> link_man Contact name link_credit_type Contact document type 0 ID card 1 Student ID card 2 Military ID 3 Passport 4 This account (select this item for children), 5 Hong Kong and Macau pass 6 MTP link_credit_no Contact ID number Enhanced field descriptions
Enter the password to open this PDF file:
-
-
-
-
-
-
-
-
-
-
-
-