XML Gate. Order Structure

Home / menu.newsArticles

Go to description of working with orders

Structure of xml order is presented below. The description of tags returned during order viewing is described here.

OrderType Element

Order type. During booking it is necessary to use ‘Touristic’ type

Nested elements:

type – order type.

Country Element

Information about resort country.

Includes nested elements:

id – country id.

name – country name in English.

Summary Element

General information on order

orderId – order id. Not used during booking and preliminary calculation.

creationDate – date and time of order creation. Not used during booking and preliminary calculation.

startDate – tour start date. Not used during booking and preliminary calculation.

endDate – tour end date. Not used during booking and preliminary calculation.

calculated – parameter indicating if the order is calculated or not; ‘false’ – not calculated, ‘true’ – calculated. Not used during booking and preliminary calculation.

confirmed – parameter indicating if the order is confirmed or not; ‘false’- not confirmed, ‘true’ – confirmed. Not used during booking and preliminary calculation.

documentsReady – readiness of the order’s documents; ‘true’ – documents are ready, ‘false’ – not ready. Not used during booking and preliminary calculation.

price – nominal price of the order. Not used during booking and preliminary calculation.

charge – charged for order (how much the agency should pay). Not used during booking and preliminary calculation.

penalty – penalty. Not used during booking and preliminary calculation.

paid - paid. Not used during booking and preliminary calculation.

currency – id of the currency in which the calculation is performed.

agencyRussianName – Russian name of the agency that has booked the order. Not used during booking and preliminary calculation.

agencyName – name of the agency in Latin characters.

percent – commission percent for the order. Not used during booking and preliminary calculation.

managerLogin – login of the manager who has created the order. Not used during booking and preliminary calculation.

updatedDate – date and time of the last order update. Encoded by a special algorithm (returns the number of milliseconds that have passed since January, 1, 1970, 00:00:00 GMT). Not used during booking and preliminary calculation.

Tourist Element

Information about the tourist. Includes elements:

touristId – tourist id in the order.

surname – tourist surname.

name – tourist first name.

gender – id of form of address for the tourist (gender).

birthday – tourist’s birth date.

nationality – id of the country the resident of which is the tourist.

residenceCityId – id of the city of the tourist’s accommodation.

passport_seria – passport series.

passport – passport number.

passport_issue_date – passport issue date.

passport_issuer – organization that have issued the passport.

passport_expiration_date – passport expiration date.

aviaInfoMsg – text message on possibility to print avianote. For example, “Printing is not possible, only after tourists departure.”

genderName –tourist gender. For example, ‘MR’.

eTickets – electronic ticket number. Not used during booking and preliminary calculation.

insuranceNumbers – insurance numbers. Not used during booking and preliminary calculation.

Residence Element

Information about accommodation. Includes nested elements:

serviceId – id of the service within the order.

checkIn – check in date.

checkOut – check out date.

hotel – hotel id.

hotelPansion – id of meal type in the hotel.

hotelRoom – id of room type in the hotel.

hotelStayTypeId – id of the accommodation type in the hotel.

hotelStayType – name of the accommodation type in the hotel.

shortInfo – short text information about the accommodation. Not used during booking and preliminary calculation.

status – service status. Passed as text in Russian. Not used during booking and preliminary calculation.

region – name of the hotel’s region in English.

regionId – region id.

hotelName – hotel name.

hotelTypeName – hotel type (category) name.

pansionName – meal type name.

roomName – room name.

statusEng – service status in English. Not used during booking and preliminary calculation.

note – hotel note. Not used during booking and preliminary calculation.

Transfer Element

Information about the transfer. Includes nested elements:

serviceId – id of the transfer as service within the order.

date – date of transfer execution.

fromId – transfer departure point. Id of the airport or hotel.

toId – transfer destination point. Id of the airport or hotel.

type – transfer type id.

typeName – transfer type name.

flightDeparture – id of the flight for which the transfer is organized. It is necessary to use the value of the ‘flightDeparture’ element from the ‘Ticket’ section.

shortInfo – short text information about the transfer. Not used during booking and preliminary calculation.

status – service status name in Russian. Not used during booking and preliminary calculation.

statusEng – service status in English. Not used during booking and preliminary calculation.

departure_point – name of the transfer departure point in English.

arrival_point – name of the transfer destination point in English.

Ticket Element

Information about plane tickets.

serviceId – id of the tickets as service within the order.

flightDeparture – flight departure id.

seatType – id of the seat type in the aircraft.

food – meal class; not sure where it comes from and if it’s needed.

shortInfo – short text information about the flight.

status – service status in Russian.

flightNumber – flight number.

startDate – flight departure date.

toResortCountry – parameter determining the flight direction – to resort or back. ‘true’ – to resort, ‘false’ – return flight.

statusEng – service status in English.

seat_type – name of the seat type in the aircraft in English.

departure_datetime – departure date and time.

arrival_datetime – arrival date and time.

departure_airport – name of the departure airport in English.

arrival_airport – name of the arrival airport in English.

eTickets – electronic ticket number.

aircraftType – aircraft type name in English. For example, AIRBUS A321.

departureCityId – departure city id.

arrivalCityId – arrival city id.

Insurance Element

Information about insurance. Not usually used during booking and preliminary calculation, but is returned during order viewing.

serviceId – insurance id as service within the order.

from – insurance validity start date.

to – insurance validity end date.

typeId – insurance type id.

type – insurance type name in Latin characters.

shortInfo – short text information about the insurance.

status – insurance service status in Russian.

statusEng – insurance service status in English.

insuranceNumbers – insurance number.

insuranceNevyletFull – insurance description.

polis – insurance policy number.

extrarisk – insurance of extra risks.

Visa Element

Information about the visa for the order. Not used during booking and preliminary calculation.

serviceId – service id.

from – start date.

to – end date.

type – visa type name in Russian.

visaStatus – visa status in Russian.

shortInfo – short information about the visa.

status – service status in Russian.

statusEng – service status in English.

price – visa price.

cityRegistrationId – city id.

cityRegistrationName – name of the city in Russian.

Excursion Element

Information about excursion for the order.

serviceId – service id.

date – date of excursion.

hotel – hotel id.

roomNumber – room number.

adultCount – number of adults in the excursion.

childCount – number of children in the excursion.

infantCount – number of infants in the excursion.

status – service status in Russian

statusEng – service status in English.

price – excursion price.

excursionName – name of excursion in English.

ExtraService Element

Information about extra services for the order.

serviceId – service id.

date – date of service rendering.

type - text. Extra service type.

shortInfo – text description of the extra service.

status – service status in Russian.

statusEng – service status in English.

price – service price.

Comment Element

Comments for the order. Includes nested element:

text – comment text.

ServiceLanguage Element

Service language.

Language – name of the language in English.

ServiceTourist Element

Linking of tourists to services of the order. Includes nested elements.

serviceId – service id.

touristId – tourist id.

ageCategory – name of the tourist’s age category in English. Not used during booking and preliminary calculation.

Example of xml during order viewing:

<?xml version="1.0"?>
<order>
<OrderType>
    <type>Touristic</type>
</OrderType>
<Country>
    <id>5732</id>
    <name>EGYPT</name>
</Country>
<Summary>
    <orderId>12700343</orderId>
    <creationDate>05.12.2012 21:56</creationDate>
    <startDate>07.02.2013</startDate>
    <endDate>13.02.2013</endDate>
    <spoId>10017086</spoId>
    <spo>Spo 14</spo>
    <calculated>false</calculated>
    <confirmed>false</confirmed>
    <released>true</released>
    <documentsReady>true</documentsReady>
    <price>0.0</price>
    <charge>0.0</charge>
    <penalty>0.0</penalty>
    <paid>0.0</paid>
    <currency>5561</currency>
    <agencyRussianName>Тестовое агентство</agencyRussianName>
    <agencyName>TEST</agencyName>
    <percent>9.5</percent>
    <updatedDate>1354737600000</updatedDate>
    <isOnlineChange>false</isOnlineChange>
</Summary>
<Tourist>
    <touristId>28973551</touristId>
    <surname>TESTSECOND</surname>
    <name>TESTSECOND</name>
    <gender>2689</gender>
    <birthday>10.08.1981</birthday>
    <aviaInfoMsg>Printing not possible, only after tourists departure.</aviaInfoMsg>
    <genderName>MRS.</genderName>
    <eTickets></eTickets>
    <insuranceNumbers>28973551 W-912</insuranceNumbers>
</Tourist>
<Tourist>
    <touristId>28973550</touristId>
    <surname>TEST</surname>
    <name>TEST</name>
    <gender>2688</gender>
    <birthday>10.10.1980</birthday>
    <aviaInfoMsg>Printing not possible, only after tourists departure.</aviaInfoMsg>
    <genderName>MR.</genderName>
    <eTickets></eTickets>
    <insuranceNumbers>28343450 W-912</insuranceNumbers>
</Tourist>
<Residence>
    <serviceId>77699384</serviceId>
    <checkIn>07.02.2013</checkIn>
    <checkOut>13.02.2013</checkOut>
    <hotel>40069</hotel>
    <hotelPansion>9009889</hotelPansion>
    <hotelRoom>54202</hotelRoom>
    <hotelStayTypeId>2</hotelStayTypeId>
    <hotelStayType>DBL</hotelStayType>
    <shortInfo>LUNA (07.02 - 13.02.13)</shortInfo>
    <status>Снята</status>
    <levyPercent>1</levyPercent>
    <region>SHARM EL-SHEIKH</region>
    <regionId>5735</regionId>
    <hotelName>LUNA</hotelName>
    <hotelTypeName>3 *</hotelTypeName>
    <pansionName>BB</pansionName>
    <roomName>Standard</roomName>
    <statusEng>Cancel</statusEng>
</Residence>
<Transfer>
    <serviceId>77699386</serviceId>
    <date>13.08.2012</date>
    <fromId>40069</fromId>
    <toId>359</toId>
    <type>3635</type>
    <typeName>G</typeName>
    <flightDeparture>809888</flightDeparture>
    <shortInfo>G (13.02.13) LUNA - SHARM(SSH)</shortInfo>
    <status>Снята</status>
    <levyPercent>1</levyPercent>
    <statusEng>Cancel</statusEng>
    <departure_point>LUNA</departure_point>
    <arrival_point>SHARM-EL-SHEIKH (SSH)</arrival_point>
</Transfer>
<Transfer>
    <serviceId>77699385</serviceId>
    <date>07.08.2012</date>
    <fromId>359</fromId>
    <toId>40069</toId>
    <type>3635</type>
    <typeName>G</typeName>
    <flightDeparture>835619</flightDeparture>
    <shortInfo>G (07.02.13) SHARM(SSH) - LUNA</shortInfo>
    <status>Снята</status>
    <levyPercent>1</levyPercent>
    <statusEng>Cancel</statusEng>
    <departure_point>SHARM-EL-SHEIKH (SSH)</departure_point>
    <arrival_point>LUNA</arrival_point>
</Transfer>
<Ticket>
    <serviceId>77699387</serviceId>
    <flightDeparture>835619</flightDeparture>
    <seatType>3</seatType>
    <food>3</food>
    <jClass>0</jClass>
    <shortInfo>Y7 7601E (07.02) DME - SHARM-EL-SHEIKH (SSH) (12:2</shortInfo>
    <status>Снята</status>
    <levyPercent>1</levyPercent>
    <flightNumber>Y7 7601</flightNumber>
    <startDate>07.02.2013</startDate>
    <toResortCountry>true</toResortCountry>
    <statusEng>Cancel</statusEng>
    <seat_type>Economy</seat_type>
    <departure_datetime>07.02.2013 09:55</departure_datetime>
    <arrival_datetime>07.02.2013 12:25</arrival_datetime>
    <departure_airport>DME</departure_airport>
    <arrival_airport>SHARM-EL-SHEIKH (SSH)</arrival_airport>
    <eTickets></eTickets>
    <aircraftType>B-737-800</aircraftType>
    <departureCityId>345</departureCityId>
    <arrivalCityId>15951</arrivalCityId>
</Ticket>
<Ticket>
    <serviceId>77699388</serviceId>
    <flightDeparture>809888</flightDeparture>
    <seatType>3</seatType>
    <food>3</food>
    <jClass>0</jClass>
    <shortInfo>SU 409E (13.02) SHARM-EL-SHEIKH (SSH) - SVO-C (23:</shortInfo>
    <status>Снята</status>
    <levyPercent>1</levyPercent>
    <flightNumber>SU 409</flightNumber>
    <startDate>13.02.2013</startDate>
    <toResortCountry>false</toResortCountry>
    <statusEng>Cancel</statusEng>
    <seat_type>Economy</seat_type>
    <departure_datetime>13.08.2012 16:40</departure_datetime>
    <arrival_datetime>13.08.2012 23:20</arrival_datetime>
    <departure_airport>SHARM-EL-SHEIKH (SSH)</departure_airport>
    <arrival_airport>SVO-C</arrival_airport>
    <eTickets></eTickets>
    <aircraftType>IL-96</aircraftType>
    <departureCityId>15951</departureCityId>
    <arrivalCityId>345</arrivalCityId>
</Ticket>
<Insurance>
    <serviceId>77699390</serviceId>
    <from>07.08.2012</from>
    <to>13.08.2012</to>
    <typeId>144491</typeId>
    <type>RESO - EGYPT</type>
    <shortInfo>07.08 - 13.08.12</shortInfo>
    <status>Снята</status>
    <statusEng>Cancel</statusEng>
    <levyPercent>1</levyPercent>
    <insuranceNumbers>W-9122sddsds1W-9122212173550</insuranceNumbers>
    <export>IssueReso</export>
    <polis>W-912</polis>
    <extrarisk>UNCONDITIONAL FRANCHISE - 30$</extrarisk>
    <InsuranceNevyletFull>Insurance of expenses arising as a result of either cancellation of the trip abroad or changing of duration of staying abroad</InsuranceNevyletFull>
</Insurance>
<ExtraService>
    <serviceId>77699389</serviceId>
    <date>07.08.2012</date>
    <type>Extra payment for airline </type>
    <shortInfo>Extra payment for avia (07.08.12)</shortInfo>
    <status>Снята</status>
    <statusEng>Cancel</statusEng>
    <price>0.0</price>
    <levyPercent>0</levyPercent>
</ExtraService>
<ServiceLanguage>
    <Language>Russian</Language>
</ServiceLanguage>
<Comment>
    <text>05.12.2012 Online Book: SPO 14 Sh (MOSCOW)</text>
</Comment>
<ServiceTourist>
    <serviceId>77699387</serviceId>
    <touristId>28973550</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699387</serviceId>
    <touristId>28973551</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699386</serviceId>
    <touristId>28973551</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699386</serviceId>
    <touristId>28973550</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699385</serviceId>
    <touristId>28973551</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699385</serviceId>
    <touristId>28973550</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699384</serviceId>
    <touristId>28973550</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699384</serviceId>
    <touristId>28973551</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699390</serviceId>
    <touristId>28973551</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699390</serviceId>
    <touristId>28973550</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699389</serviceId>
    <touristId>28973550</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699389</serviceId>
    <touristId>28973551</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699388</serviceId>
    <touristId>28973551</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
<ServiceTourist>
    <serviceId>77699388</serviceId>
    <touristId>28973550</touristId>
    <ageCategory>Adult</ageCategory>
</ServiceTourist>
</order>

Possible values for service status in the order (English name – Russian name):

Release - Снята
Regret - Отказ
Cancel - Аннуляция
InProgress - В работе
Confirmed - Подтверждена

Fine - Штраф

Options

XML Gate. Order Structure