Gift Voucher Sale
SIHOT.WEB can get a list of all gift voucher services. These can be used to sell in the web.
Then the web can sell a gift voucher.
Operationcode: GET-GIFTVOUCHER-SERVICES
GET-GIFTVOUCHER-SERVICES
Direction
SIHOT.PMS ← SIHOT.WEB
Message
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
<OC>GET-GIFTVOUCHER-SERVICES</OC>
<TN>1</TN>
<ID>1</ID>
</SIHOT-DOCUMENT>
Attributes Message
Element | Description | Data type | Usage |
---|---|---|---|
OC | Operation code | String | Mandatory |
ID | Property number to request for a single hotel | String | Mandatory |
TN | Transaction number | Integer | Mandatory |
Response
<?xml version="1.0" encoding="iso-8859-1"?>
<SIHOT-Document>
<SIHOT-Version>
<Version>9.0.0.0000</Version>
<EXE>D:\\sihot\\sinetres.exe</EXE>
</SIHOT-Version>
<OC>GET-GIFTVOUCHER-SERVICES</OC>
<TN>1</TN>
<ID>1</ID>
<RC>0</RC>
<A-GIFTVOUCHER-SERVICE-LIST>
<GIFTVOUCHER-SERVICE>
<SID>WEL</SID>
<PRICE>15</PRICE>
<DISCOUNT>3</DISCOUNT>
<CURRENCY>EUR</CURRENCY>
<TXT>
<LANG>DE</LANG>
<T>Gutschein Wellness</T>
<DESC>Beschreibung G. Wellness</DESC>
</TXT>
<TXT>
<LANG>EN</LANG>
<T>gift certificate wellness</T>
<DESC>description gc. wellness</DESC>
</TXT>
</GIFTVOUCHER-SERVICE>
<GIFTVOUCHER-SERVICE>
<SID>GLO</SID>
<PRICE>80</PRICE>
<DISCOUNT>5</DISCOUNT>
<CURRENCY>EUR</CURRENCY>
<TXT>
<LANG>DE</LANG>
<T>Gutschein Übernachtung</T>
<DESC>Beschreibung G. Logis</DESC>
</TXT>
<TXT>
<LANG>EN</LANG>
<T>gift certificate lodging</T>
<DESC>description gc lodging</DESC>
</TXT>
</GIFTVOUCHER-SERVICE>
</A-GIFTVOUCHER-SERVICE-LIST>
</SIHOT-Document>
Attributes Response
Attribute | Description | Data type |
---|---|---|
SID | Short form of the gift voucher service | String |
PRICE | Price of the gift voucher service | Decimal |
DISCOUNT | Discount for this price in percent for the gift voucher service | Decimal |
CURRENCY | The currency used for the price. | String |
TXT | Block with comments in different languages | |
LANG | Language code for the description (ISO 639 coded) | String |
T | Short service description | String |
DESC | Long comment of the service. | String |
Operationcode: SELL-GIFTVOUCHER
SELL-GIFTVOUCHER
Direction
SIHOT.PMS ← SIHOT.WEB
Message
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
<OC>SELL-GIFTVOUCHER</OC>
<TN>1</TN>
<ID>1</ID>
<GIFTVOUCHER>
<INVHOLDER>
<COMPANY/>
<NAME>Meiser</NAME>
<NAME2>Claudia</NAME2>
<ADDRESS>2</ADDRESS>
<STREET>Blumenstraße 3</STREET>
<ZIP>80054</ZIP>
<CITY>München</CITY>
<COUNTRY-CODE>DE</COUNTRY-CODE>
<STATE>BY/STATE>
<POST-AREA>ER</POST-AREA>
<LANG>DE</LANG>
<PHONE1>089/987654</PHONE1>
<PHONE2>089/987655</PHONE2>
<FAX1>089/987610</FAX1>
<FAX2>089/987611</FAX2>
<EMAIL1>c@m.com</EMAIL1>
<EMAIL2>grandhotel@sihot.com</EMAIL2>
<MOBIL1>0151/343434</MOBIL1>
<MOBIL2>0163/345345</MOBIL2>
<DOCUMENT-TYPE/>
<DOCUMENT-NUMBER/>
<DOCUMENT-EXPEDITIONCOUNTRY/>
<DOCUMENT-EXPEDITIONDATE/>
</INVHOLDER>
<SID>WEL</SID>
<AMOUNT>15</AMOUNT>
<DISCOUNT-AMOUNT>0.45</DISCOUNT-AMOUNT>
<PAYMENT>
<PAYMENT-SYSTEM>SW</PAYMENT-SYSTEM>
<PAYMENTTYPE>WP</PAYMENTTYPE>
<PAYID>39048723489234789</PAYID>
</PAYMENT>
<COMMENT>Annette Wagner</COMMENT>
<LAYOUT/>
</GIFTVOUCHER>
</SIHOT-DOCUMENT>
Attributes Message
Element | Description | Data type | Usage | ||||||
---|---|---|---|---|---|---|---|---|---|
OC | Operation code | String | Mandatory | ||||||
ID | Property number to sell for a single hotel | String | Mandatory | ||||||
TN | Transaction number | Integer | Mandatory | ||||||
INVHOLDER | Address data of the invoice holder | Mandatory | |||||||
COMPANY | If set, the client is a company and NAME must be empty. | String | Mandatory, if the client is a company, see note below | ||||||
NAME | If set, the client is an individual guest and COMPANY must be empty. | String | Mandatory, if the client is an individual person, see note below | ||||||
NAME2 | First name of the client | String | Optional | ||||||
ADDRESS | Address, e.g.:
This address is equal in SIHOT.WEB and SIHOT.PMS. |
Short | Optional | ||||||
STREET | Road | String | Optional | ||||||
ZIP | Postal Code | String | Optional | ||||||
CITY | Town | String | Optional | ||||||
COUNTRY-CODE | Country of the client (ISO 3166 (A2) coded) | String | Optional | ||||||
STATE | State | String | Optional | ||||||
POST-AREA | Region | String | Optional | ||||||
LANG | Language of the client (ISO 639 coded). | String | Optional | ||||||
PHONE1 | Phone number | String | Optional | ||||||
PHONE2 | Alternative phone number | String | Optional | ||||||
FAX1 | Fax number | String | Optional | ||||||
FAX2 | Alternative fax number | String | Optional | ||||||
EMAIL1 | String | Mandatory | |||||||
EMAIL2 | Alternative e-mail | String | Optional | ||||||
INVOICE-EMAIL | The email address for invoices | String | Optional | ||||||
MOBIL1 | Cell phone number | String | Optional | ||||||
MOBIL2 | Alternative cell phone number | String | |||||||
DOCUMENT-TYPE | String | Optional | |||||||
DOCUMENT-NUMBER | String | Optional | |||||||
DOCUMENT-EXPEDITIONCOUNTRY | String | Optional | |||||||
DOCUMENT-EXPEDITIONDATE | Date | Optional | |||||||
DOCUMENT-EXPIREDATE | Date | Optional | |||||||
SID | Short form of the gift cert service | String | Mandatory | ||||||
AMOUNT | Amount of the gift cert | Decimal | Mandatory | ||||||
DISCOUNT-AMOUNT | Discount amount for the gift cert | Decimal | |||||||
PAYMENT-SYSTEM | Code of external payment system for identification of payment type in SIHOT.PMS (default:”SW”) | String | Optional | ||||||
PAYMENTTYPE | Payment type | String | Mandatory | ||||||
PAYID | Payment id | String | Mandatory | ||||||
COMMENT | Comment for the invoice, e.g. name of the recipient of the gift certificate | ||||||||
LAYOUT | Layout-Info for gift certificate | String |
Response
Error
If an error occurs during the transmission, an error message is sent to SIHOT.PMS:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
<SIHOT-Version>
<Version>9.0.0.0000</Version>
<EXE>D:\\sihot\\sinetres.exe</EXE>
</SIHOT-Version>
<OC>SELL-GIFTVOUCHER</OC>
<TN>1</TN>
<ID>1</ID>
<RC>1</RC>
<MSG>Error Message</MSG>
</SIHOT-DOCUMENT>
Success
The answer from SIHOT.PMS to SIHOT.WEB can look e. g. in such a way, if the transmission was successful:
<?xml version="1.0" encoding="iso-8859-1"?>
<SIHOT-Document>
<SIHOT-Version>
<Version>9.0.0.0000</Version>
<EXE>D:\\sihot\\sinetres.exe</EXE>
</SIHOT-Version>
<OC>SELL-GIFTVOUCHER</OC>
<TN>1</TN>
<ID>1</ID>
<RC>0</RC>
<MSG>OK</MSG>
<GV-NO>4711</GV-NO>
<GV-REF>036E-29A4-DE4A-49B1</GV-REF>
<GV-INVOICE-NO></GV-INVOICE-NO>
</SIHOT-Document>
Attributes Response
Element | Description | Data type |
---|---|---|
GV-NO | Number of the new gift certificate | Unsigned long |
GV-REF | Reference of the new gift certificate | String |
GV-INVOICE-NO | Number of the invoice for the new gift certificate | Unsigned 64bit |