Tourmind Hotel Distribution API - TMS API (2.0)

Download OpenAPI specification: Download

TMS API.

Overall Overview

Welcome to the TourMind Developer Documentation. This guide provides all the information you need to integrate TourMind into your applications. Whether you are looking for hotel booking processes or AI-powered solutions, we've got you covered.

Key Features

• Hotel APIs: Provides a comprehensive suite of APIs designed for streamlined hotel reservation processes.
• TourMind AI APIs: Leverages advanced algorithms for room matching, room mapping, and rate prediction, enhancing pricing strategies and optimize inventory utilization rate.

Technical Specifications

• All communications from agents to the TourMind API are conducted via HTTP POST.
• The format of request payloads is based on JSON.
• All requests should accept GZIP encoding, and all responses are returned in GZIP format.
• All requests include a common request header, which contains authentication information.

API Development Process

Changelog

Version	Date	Description
v1.0.1	2023.05.01	Initial API documentation.
v2.0.1	2023.05.25	Adjustments to hotel API fields.
v2.0.2	2026.03.19	Add Query Bookings endpoint; add new fields to Retrieve Booking response (HotelCode, RoomCount, CheckIn, CheckOut, PaxRooms, Contact, ContactPhone, BookingTime).
v2.0.3	2026.08.14	Align the Prebook MealType table with Search; document that the first guest of each PaxRoom is the primary guest.

Authorization

1. Common Request Field

All requests require a common field named RequestHeader, in which account information must be provided. example:

{
    "AgentCode": "your agent code",
    "UserName": "your username",
    "Password": "your password",
    "RequestTime": "2018-07-26T09:51:32.999Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
}

2. Http Header

Please add the following two items to the Http header:

• X-Agent-Code: your agent code
• X-Username: your username

3. Test Environment Credential

API Test Credential
AgentCode	tms_test
UserName	tms_test
Password	tms_test

Availability & Booking

Search

Search hotel room rates and available inventory for a specific property, enabling users to view detailed room availability and pricing information.

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/HotelDetail
Request method	POST

Request Fields

CheckIn: string

Check-in date, format: “2006-01-02”.

CheckOut: string

Check-out date, format: “2006-01-02”.

HotelCodes[]: integer

TourMind hotel IDs; up to 20 IDs are supported in this request.

IsDailyPrice: boolean

If true, daily price information will be included in the response. Default: false.

Nationality: string

Nationality.

Adults: integer

Number of adults per room.

Children: integer

Number of children per room.

ChildrenAges[]: integer

Children's ages; the count of the array must equal the number of children.

RoomCount: integer

Room count.

Timeout: integer

request timeout, millisecond

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

Response Fields

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

CheckIn: string

Check-in date, format: “2006-01-02”.

CheckOut: string

Check-out date, format: “2006-01-02”.

HotelCode: string

Hotel code.

BedTypeDesc: string

Bed type description.

BedTypeDescCN: string

Bed type description in Chinese.

Name: string

Aggregated room type name, cleaner and easier to display, recommended. Note: in rare cases, it may differ from the sub-room name in RateInfo.

NameCN: string

Aggregated room type name in Chinese, cleaner and easier to display, recommended. Note: in rare cases, it may differ from the sub-room name in RateInfo.

Allotment: integer

Available room inventory count.

Amount: number

Cancellation charge amount.

CurrencyCode: string

Currency for the cancellation charge amount.

EndDateTime: string

Cancellation policy window end, format: “2006-01-02“. Base on the hotel's local time.

From: string

Specific start time, format: "2006-01-02 15:04:05". Base on the hotel's local time.

StartDateTime: string

Cancellation policy window start, format: "2006-01-02". Base on the hotel's local time.

To: string

Specific end time, format: "2006-01-02 15:04:05". Base on the hotel's local time.

CurrencyCode: string

Currency code.

Count: integer

this is daily inventory count

Date: string

Date, format: "2006-01-02"

Price: number

Price for 1 room per night.

InvoiceInfo: integer

Invoice information: 1: Hotel invoice, 2: TourMind invoice

MealCount: integer

Number of free meals offered.

MealType: string

Meal type

MealType	Description
1	No Breakfast
2	Breakfast
3	Lunch
4	Dinner
5	Lunch and Dinner
6	HalfBoard
7	FullBoard
8	AllInclusive
9	SelfCatering

Name: string

Sub-room name, i.e. the original room name from the supplier/hotel system. More accurate than the aggregated name in RoomType, but results in more static room entries. In rare cases, sub-rooms may be incorrectly mapped to their parent room type.

NameCN: string

Sub-room name in Chinese, i.e. the original room name from the supplier/hotel system. More accurate than the aggregated name in RoomType, but results in more static room entries. In rare cases, sub-rooms may be incorrectly mapped to their parent room type.

RateCode: string

Rate identifier for a sellable product; this code is unique across all TourMind hotels.

Refundable: boolean

TotalPrice: number

Total price; this is the total amount charged.

bedTypeDesc: string

Bed type description.

bedTypeDescCN: string

Bed type description in Chinese.

RoomTypeCode: string

TourMind room type code, which is a unique identifier across all TourMind hotels.

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

Body parameters

{
  "CheckIn": "2018-08-25",
  "CheckOut": "2018-08-26",
  "HotelCodes": [
    8268393
  ],
  "Nationality": "CN",
  "PaxRooms": [
    {
      "Adults": 4,
      "Children": 0,
      "ChildrenAges": [],
      "RoomCount": 2
    }
  ],
  "Timeout": 6000,
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  }
}

Responses

{
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "Hotels": [
    {
      "CheckIn": "2018-08-25",
      "CheckOut": "2018-08-26",
      "HotelCode": "740650",
      "RoomTypes": [
        {
          "Name": "Suite 3 bedrooms",
          "NameCN": "Triple Room",
          "RateInfos": [
            {
              "Allotment": 2,
              "CancelPolicyInfos": [
                {}
              ],
              "CurrencyCode": "CNY",
              "DailyPriceInfo": [
                {}
              ],
              "MealInfo": {
                "MealCount": 2,
                "MealType": "breakfast"
              },
              "Name": "SUITE THREE BEDROOMS",
              "RateCode": "13800206",
              "TotalPrice": 688.88
            }
          ],
          "RoomTypeCode": "4613"
        }
      ]
    }
  ],
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}

Prebook

Check the availability and price of a specific room rate selected, usually requested when the user selects a room to book and submits a booking.

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/CheckRoomRate
Request method	POST

Request Fields

CheckIn: string

Check-in date, format: “2006-01-02”.

CheckOut: string

Check-out date, format: “2006-01-02”.

HotelCodes[]: integer

TourMind Hotel ID; only one ID is required in this request.

Nationality: string

Nationality.

Adults: integer

Number of adults per room.

Children: integer

Number of children per room.

ChildrenAges[]: integer

Children's ages; the count of the array must equal the number of children.

RoomCount: integer

Room count.

RateCode: string

TourMind Rate ID.

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

TotalPrice: number

Total price returned from the SearchResponse.

Response Fields

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

CheckIn: string

Check-in date, format: “2006-01-02”.

CheckOut: string

Check-out date, format: “2006-01-02”.

HotelCode: string

Hotel code.

BedTypeDesc: string

Bed type description.

BedTypeDescCN: string

Bed type description in Chinese.

Name: string

Aggregated room type name, cleaner and easier to display, recommended. Note: in rare cases, it may differ from the sub-room name in RateInfo.

NameCN: string

Aggregated room type name in Chinese, cleaner and easier to display, recommended. Note: in rare cases, it may differ from the sub-room name in RateInfo.

Allotment: integer

Available room inventory count.

Amount: number

Cancellation charge amount.

CurrencyCode: string

Currency for the cancellation charge amount.

EndDateTime: string

Cancellation policy window end, format: “2006-01-02“. Base on the hotel's local time.

From: string

Specific start time, format: "2006-01-02 15:04:05". Base on the hotel's local time.

StartDateTime: string

Cancellation policy window start, format: "2006-01-02". Base on the hotel's local time.

To: string

Specific end time, format: "2006-01-02 15:04:05". Base on the hotel's local time.

CurrencyCode: string

Currency code.

Count: integer

this is daily inventory count

Date: string

Date, format: "2006-01-02"

Price: number

Price of a specific date.

InvoiceInfo: integer

Invoice information: 1: Hotel invoice, 2: TourMind invoice

MealCount: integer

Number of free meals offered.

MealType: string

Meal type

MealType	Description
1	No Breakfast
2	Breakfast
3	Lunch
4	Dinner
5	Lunch and Dinner
6	HalfBoard
7	FullBoard
8	AllInclusive
9	SelfCatering

Name: string

Sub-room name, i.e. the original room name from the supplier/hotel system. More accurate than the aggregated name in RoomType, but results in more static room entries. In rare cases, sub-rooms may be incorrectly mapped to their parent room type.

NameCN: string

Sub-room name in Chinese, i.e. the original room name from the supplier/hotel system. More accurate than the aggregated name in RoomType, but results in more static room entries. In rare cases, sub-rooms may be incorrectly mapped to their parent room type.

RateCode: string

Rate identifier for a sellable product; this code is unique across all TourMind hotels.

Refundable: boolean

TotalPrice: number

Total price; this is the total amount charged.

bedTypeDesc: string

Bed type description.

bedTypeDescCN: string

Bed type description in Chinese.

RoomTypeCode: string

TourMind room type code, which is a unique identifier across all TourMind hotels.

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

Body parameters

{
  "CheckIn": "2018-08-25",
  "CheckOut": "2018-08-26",
  "HotelCodes": [
    8268393
  ],
  "Nationality": "CN",
  "PaxRooms": [
    {
      "Adults": 4,
      "Children": 0,
      "ChildrenAges": [],
      "RoomCount": 2
    }
  ],
  "RateCode": "13800206",
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  },
  "TotalPrice": 688.88
}

Responses

{
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "Hotels": [
    {
      "CheckIn": "2018-08-25",
      "CheckOut": "2018-08-26",
      "HotelCode": "740650",
      "RoomTypes": [
        {
          "Name": "Suite 3 bedrooms",
          "NameCN": "Triple Room",
          "RateInfos": [
            {
              "Allotment": 2,
              "CancelPolicyInfos": [
                {}
              ],
              "CurrencyCode": "CNY",
              "DailyPriceInfo": [
                {}
              ],
              "MealInfo": {
                "MealCount": 2,
                "MealType": "breakfast"
              },
              "Name": "SUITE THREE BEDROOMS",
              "RateCode": "13800206",
              "TotalPrice": 688.88
            }
          ],
          "RoomTypeCode": "4613"
        }
      ]
    }
  ],
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}

Booking

Note: If the request times out, returns a PENDING status, or returns an error, please poll the Retrieve Booking API to obtain the final status of the booking.

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/CreateOrder
Request method	POST

Request Fields

AgentRefID: string

Unique agent reference ID to identify a booking; maximum length is 128 characters. Note! Reserving with the same AgentRefID will not create a new reservation; instead, the original reservation information will be returned.

CheckIn: string

Check-in date, format: “2006-01-02”.

CheckOut: string

Check-out date, format: “2006-01-02”.

Email: string

Email of the booking contact.

FirstName: string

First Name of the booking contact.

LastName: string

Last Name of the booking contact.

PhoneNo: string

Phone number of the booking contact.

CurrencyCode: string

Currency code.

HotelCode: integer

TourMind Hotel ID; only one ID is required in this request.

Adults: integer

Children: integer

ChildrenAges[]: integer

Children's ages; the count of the array must equal the number of children.

FirstName: string

LastName: string

Type: string

ADU represents Adult, CHI represents Child.

RoomCount: integer

RateCode: string

TourMind Rate ID.

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

SpecialRequest: string

Special customer requests.

TotalPrice: number

Total price for the booking returned from the CheckRoomRateResponse.

Response Fields

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

OrderStatus: string

Order status.

OrderStatus	Description
PENDING	Booking confirmation pending.
CONFIRMED	Booking confirmed.
CANCELLED	Booking cancelled.
FAILED	Booking confirmation failed.

ReservationID: string

Tourmind order ID

ReservationID: string

Tourmind order ID

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

Body parameters

{
  "AgentRefID": "213415",
  "CheckIn": "2018-08-15",
  "CheckOut": "2018-08-18",
  "ContactInfo": {
    "Email": "xxx@google.com",
    "FirstName": "Tom",
    "LastName": "Lee",
    "PhoneNo": "1521777777"
  },
  "CurrencyCode": "CNY",
  "HotelCode": 235113,
  "PaxRooms": [
    {
      "Adults": 2,
      "Children": 0,
      "ChildrenAges": [],
      "PaxNames": [
        {
          "FirstName": "Tom",
          "LastName": "Lee",
          "Type": "ADU"
        }
      ],
      "RoomCount": 1
    }
  ],
  "RateCode": "2132151",
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  },
  "SpecialRequest": "Non-smoking room",
  "TotalPrice": 88.88
}

Responses

{
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "OrderInfo": {
    "OrderStatus": "CONFIRMED",
    "ReservationID": "10470379"
  },
  "ReservationID": "10470379",
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}

Cancel

Send a cancel request to cancel refundable and pending bookings.

Note: If the request times out or returns an error, please poll the Retrieve Booking API to obtain the final status of the booking.

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/CancelOrder
Request method	POST

Request Fields

AgentRefID: string

Agent reference ID provided in the CreateOrder request by the agent; maximum length is 128.

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

Response Fields

CancelFee: number

Cancellation penalty fee charged.

CurrencyCode: string

Currency code for the charge amount.

OrderStatus: string

Order status.

OrderStatus	Description
PENDING	Booking confirmation pending.
CONFIRMED	Booking confirmed.
CANCELLED	Booking cancelled.
FAILED	Booking confirmation failed.

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

Body parameters

{
  "AgentRefID": "213415",
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  }
}

Responses

{
  "CancelResult": {
    "CancelFee": 42,
    "CurrencyCode": "CNY",
    "OrderStatus": "CANCELLED"
  },
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}

Retrieve Booking

Retrieve booking to check its status in the booking process.

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/SearchOrder
Request method	POST

Request Fields

AgentRefID: string

Agent reference ID provided in the CreateOrder request; maximum length is 128.

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

Response Fields

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

AgentRefID: string

Agent reference ID;

CurrencyCode: string

Currency code.

HotelConfirmationNo: string

Hotel confirmation number.

OrderStatus: string

Order status.

OrderStatus	Description
PENDING	Booking confirmation pending.
CONFIRMED	Booking confirmed.
CANCELLED	Booking cancelled.
FAILED	Booking confirmation failed.

ReservationID: string

Tourmind order ID

TotalPrice: number

Total price of the booking.

HotelCode: integer

Tourmind hotel ID.

RoomCount: integer

Number of rooms.

CheckIn: string

Check-in date. Format YYYY-MM-DD.

CheckOut: string

Check-out date. Format YYYY-MM-DD.

Adults: integer

Children: integer

ChildrenAges[]: integer

Children's ages; the count of the array must equal the number of children.

FirstName: string

LastName: string

Type: string

ADU represents Adult, CHI represents Child.

RoomCount: integer

Contact: string

Contact person name.

ContactPhone: string

Contact phone number.

BookingTime: string

Booking creation time.

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

Body parameters

{
  "AgentRefID": "21345555",
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  }
}

Responses

{
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "OrderInfo": {
    "AgentRefID": "213415",
    "CurrencyCode": "CNY",
    "HotelConfirmationNo": "10470374",
    "OrderStatus": "CANCELLED",
    "ReservationID": "10470374",
    "TotalPrice": 888.89,
    "HotelCode": 0,
    "RoomCount": 0,
    "CheckIn": "2020-01-01",
    "CheckOut": "2020-01-02",
    "PaxRooms": [
      {
        "Adults": 2,
        "Children": 0,
        "ChildrenAges": [],
        "PaxNames": [
          {
            "FirstName": "Tom",
            "LastName": "Lee",
            "Type": "ADU"
          }
        ],
        "RoomCount": 1
      }
    ],
    "BookingTime": "2020-01-03 12:00:00"
  },
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}

Query Bookings

Query bookings by date range with pagination. Use this endpoint to retrieve a list of orders filtered by check-in date, check-out date, or booking date. The actual API endpoint is POST /v2/SearchOrder (same URL as Retrieve Booking, but with different request parameters).

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/SearchOrder
Request method	POST

Request Fields

DateType: string

Date type for date range query. Possible values: CheckIn (check-in date), CheckOut (check-out date), Booking (booking date).

From: string

Start date for the query range. Format YYYY-MM-DD. The date span (To minus From) must be <= 31 days.

To: string

End date for the query range. Format YYYY-MM-DD. The date span (To minus From) must be <= 31 days.

Page: integer

Page number for pagination. Must be >= 1.

PageSize: integer

Number of results per page. Must be between 1 and 500.

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

Response Fields

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

AgentRefID: string

Agent reference ID;

CurrencyCode: string

Currency code.

HotelConfirmationNo: string

Hotel confirmation number.

OrderStatus: string

Order status.

OrderStatus	Description
PENDING	Booking confirmation pending.
CONFIRMED	Booking confirmed.
CANCELLED	Booking cancelled.
FAILED	Booking confirmation failed.

ReservationID: string

Tourmind order ID

TotalPrice: number

Total price of the booking.

HotelCode: integer

Tourmind hotel ID.

RoomCount: integer

Number of rooms.

CheckIn: string

Check-in date. Format YYYY-MM-DD.

CheckOut: string

Check-out date. Format YYYY-MM-DD.

Adults: integer

Children: integer

ChildrenAges[]: integer

Children's ages; the count of the array must equal the number of children.

FirstName: string

LastName: string

Type: string

ADU represents Adult, CHI represents Child.

RoomCount: integer

Contact: string

Contact person name.

ContactPhone: string

Contact phone number.

BookingTime: string

Booking creation time.

Page: integer

Current page number.

PageSize: integer

Page size.

Total: integer

Total number of orders matching the query.

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

Body parameters

{
  "DateType": "CheckIn",
  "From": "2024-01-01",
  "To": "2024-01-31",
  "Page": 1,
  "PageSize": 50,
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  }
}

Responses

{
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "OrderList": {
    "OrderList": [
      {
        "AgentRefID": "213415",
        "CurrencyCode": "CNY",
        "HotelConfirmationNo": "10470374",
        "OrderStatus": "CANCELLED",
        "ReservationID": "10470374",
        "TotalPrice": 888.89,
        "HotelCode": 0,
        "RoomCount": 0,
        "CheckIn": "2020-01-01",
        "CheckOut": "2020-01-02",
        "PaxRooms": [
          {
            "Adults": 2,
            "Children": 0,
            "ChildrenAges": [],
            "PaxNames": [
              {
                "FirstName": "Tom",
                "LastName": "Lee",
                "Type": "ADU"
              }
            ],
            "RoomCount": 1
          }
        ],
        "BookingTime": "2020-01-03 12:00:00"
      }
    ],
    "Page": 1,
    "PageSize": 50,
    "Total": 100
  },
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}

Static Data

MealCode

Meal code

MealCode	Description
1	No Breakfast
2	Breakfast
3	Lunch
4	Dinner
5	Lunch and Dinner
6	HalfBoard
7	FullBoard
8	AllInclusive
9	SelfCatering

Hotel List

Retrieve static data for hotels.

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/HotelStaticList
Request method	POST

Request Fields

CountryCode: string

Country code.

HotelIds[]: integer

Identifiers for specific hotels..

Lang: string

Language, e.g. zh-CN, en-US.

PageIndex: any

PageIndex needs to accommodate both string and integer types. [1 or '1']

PageSize: integer

Items per page. Max 200.

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

Response Fields

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

Address: string

Hotel address.

Address_CN: string

Hotel address in Chinese.

name: string

Amenity name.

name: string

Amenity name.

CityCode: string

City code.,Matched region ID.

CityName: string

City name.

CityNameCN: string

City name in Chinese.

CountryCode: string

Country code.，ISO 3166-1 alpha-2, e.g., China: CN.

Attractions: string

Distances to nearby attractions and airports.

BusinessAmenities: string

Description of the hotel's business amenities.

Headline: string

Short headline of the hotel's location.

Location: string

Description of the hotel's location and nearby landmarks.

Rooms: string

Description of the hotel's rooms.

HotelId: string

TourMind hotel ID.

caption: string

category: integer

hero_image: boolean

Latitude: string

Latitude.

Longitude: string

Longitude.

Name: string

Hotel name.

Name_CN: string

Hotel name in Chinese.

Phone: string

Hotel phone number.

StarRating: string

Hotel star rating.

PageCount: integer

Total number of pages.

TotalCount: integer

Total number of records.

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

Body parameters

{
  "CountryCode": "CN",
  "HotelIds": [],
  "Lang": "zh-CN",
  "Pagination": {
    "PageIndex": 1,
    "PageSize": 10
  },
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  }
}

Responses

{
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "HotelStaticListResult": {
    "Hotels": [
      {
        "Address": "3007 Santa Monica Blvd, 90404",
        "AmenitiesHotel": [
          {
            "name": "Golfing nearby"
          }
        ],
        "AmenitiesRoom": [
          {
            "name": "Golfing nearby"
          }
        ],
        "CityCode": "14209",
        "CityName": "ShangHai",
        "CityNameCN": "Shanghai",
        "CountryCode": "CN",
        "Description": {
          "Attractions": "Qijang Park - 1 km / 0.6 mi. Xingzhong Plaza - 1 km / 0.6 mi.",
          "BusinessAmenities": "Featured amenities include a business center, limo/town car service, and express check-in.",
          "Headline": "In Zhongshan (West District)",
          "Location": "You'll be centrally located in Zhongshan, within a 15-minute walk of Qijang Park and Xingzhong Plaza.",
          "Rooms": "Make yourself at home in one of the 362 air-conditioned rooms featuring refrigerators and LCD televisions."
        },
        "HotelId": "739315",
        "Images": [
          {
            "links": {}
          }
        ],
        "Latitude": "34.03644",
        "Longitude": "-118.47048",
        "Name": "Days Inn Santa Monica/Los Angeles",
        "Phone": "1523333333",
        "StarRating": "5"
      }
    ],
    "Pagination": {
      "PageCount": 1,
      "TotalCount": 10
    }
  },
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}

Region List

Retrieve the list of regions.

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/RegionList
Request method	POST

Request Fields

CountryCode: string

Country code.

PageIndex: any

PageIndex needs to accommodate both string and integer types. [1 or '1']

PageSize: integer

Items per page. Max 200.

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

Response Fields

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

CountryCode: string

ISO 3166-1 alpha-2, e.g., China: CN.,

Name: string

Region name.

NameCN: string

Region name in Chinese. (Nullable.)

RegionID: string

TourMind region ID.

RegionNameLong: string

Region name

RegionNameLongCN: string

Full region name in Chinese.

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

Body parameters

{
  "CountryCode": "CN",
  "Pagination": {
    "PageIndex": 1,
    "PageSize": 10
  },
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  }
}

Responses

{
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "RegionListResult": {
    "Regions": [
      {
        "CountryCode": "231",
        "Name": "ShangHai",
        "NameCN": "Shanghai",
        "RegionID": "21312541",
        "RegionNameLong": "Shanghai, China",
        "RegionNameLongCN": "Shanghai, China"
      }
    ]
  },
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}

Hotel Room Type List

Retrieve the list of room information of sepecific hotels.

API Call Schema

Name	Value
Request URL	http://developers.tourmind.cn/v2/RoomStaticList
Request method	POST

Request Fields

HotelCode: integer

Hotel ID.

AgentCode: string

Unique code for the agent provided by TourMind.

Password: string

Password for the API request.

RequestTime: string

Request timestamp in ISO 8601 format with millisecond precision, e.g., "2006-01-02T15:04:05.123Z".

TransactionID: string

Identifier for tracing API requests, such as using a GUID.

UserName: string

Username for the API request.

Response Fields

ErrorCode: string

Error code.

ErrorCode	Description
101	No payload in the request.
102	Invalid format of the request.
103	Request data validation failed.
104	Service error.
105	API user authentication error; invalid AgentCode, Username, or Password.

ErrorMessage: string

Error message.

ResponseTime: string

Response timestamp, format: “2006-01-02 15:04:05”.

TransactionID: string

This value must match the TransactionID in the request..

BedTypeDesc: string

Bed type description.

BedTypeDescCN: string

Bed type description in Chinese.

MaxOccupancy: integer

Maximum occupancy of the room type.

RoomTypeCode: string

Room type code.

RoomTypeName: string

Room type name.

RoomTypeNameCN: string

Room type name in Chinese.

Body parameters

{
  "HotelCode": 235113,
  "RequestHeader": {
    "AgentCode": "tms_test",
    "Password": "tms_test",
    "RequestTime": "2018-07-26T09:51:32.123Z",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "UserName": "tms_test"
  }
}

Responses

{
  "Error": {
    "ErrorCode": "101",
    "ErrorMessage": "invaild param"
  },
  "ResponseHeader": {
    "ResponseTime": "2018-07-26 09:51:32",
    "TransactionID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  },
  "RoomTypes": [
    {}
  ]
}

Certification

Please complete all test cases in the Test Cases document.

Attachments

Information Questionnaire.(Click to Download.)

Test Cases.(Click to Download.)