We recommend the below order of execution for usage of Tineri APIs
1) Sign In
2) Countries
3) Images
4) Admins
5) Users
6) Travellers
7) Guides
8) Suppliers
9) Hotels
10) Experiences
11) Meals
12) Transports
13) Brands
14) Internal Users
15) Points Of Interests
16) Bookings
17) Booking Days
18) Schedule Messages
19) Documents
20) Welcome Emails
This Api returns the token which along with the Email is required to be passed to all other API requests
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
String | Yes | Yes | Email Id of an existing Tineri Admin | johndoe@mail.com | |
password | String | Yes | No | Password used to login into Tineri CMS | password |
This Api endpoint can be used to check whether a session is still valid. It requires the combination string "Email:Token" to be passed in the Authorization Header
This Api endpoint can be used to get a list of all country names present in Tineri
These Api endpoints can be used to create or update an existing Tineri Images in the Media Library
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_image_id | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
content | String | No | No | Image in base64 format | Base64 Content |
url | String | No | No | URL of the Image | https://tinericms.com/images/no-image.jpg |
type | String | Yes | No | Type of the Image (Explained Below) | Tineri Tip |
It is mandatory to send either URL or Base64 content in the REST request; If both are sent Base64 will be used to create the Image
Type Of Images
Types of Images are used to group similar images together in the Media Library
Type can only be set during creation and cannot be changed during update
Type | Description |
---|---|
Booking Header | This type stores images in 768x431 dimensions in Landscape format and can be used for Accommodation/Hotel,Experiences,Meals,Bookings and Booking Days |
Booking Background | This type stores images in 768x1024 dimensions in Portrait format and can be used only for Booking Homescreen Image |
Hotel | This type stores images in 768x431 dimensions in Landscape format and can be used for Accommodation/Hotel,Experiences,Meals,Bookings and Booking Days |
Experience | This type stores images in 768x431 dimensions in Landscape format and can be used for Accommodation/Hotel,Experiences,Meals,Bookings and Booking Days |
Day Trip Background | This type stores images in 768x431 dimensions in Landscape format and can be used for Accommodation/Hotel,Experiences,Meals,Bookings and Booking Days |
Meal | This type stores images in 768x431 dimensions in Landscape format and can be used for Accommodation/Hotel,Experiences,Meals,Bookings and Booking Days |
Tineri Tip | This type stores images in 373x200 dimensions in Landscape format and can be used only for Tineri Tip Images |
This Api endpoint can be used to get a list of all existing Tineri Images of a sepcified type
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
type | String | Yes | No | Type of the Image | Tineri Tip |
This Api endpoint can be used to get details of a Tineri Image
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_image_id | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
These Api endpoints can be used to create or update an existing Tineri Admin
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_admin_id | String | Yes | Yes | Id of the Admin present in your booking system | admin_2 |
String | Yes | Yes | Email of the Admin | johndoe@email.com | |
job_title | String | No | No | Job Title of the Admin | Project Manager |
department | String | No | No | Department of the Admin | Sales |
preferred_language | String | No | No | Accepts one of 5 languages assigned in your Company Profile including Mandatory Language | Mandarin |
gender | String | No | No | Admin's Gender | Male |
firstname | String | Yes | No | Admin's First Name | John |
lastname | String | No | No | Admin's Last Name | Doe |
phone | String | No | No | Admin's Contact Number | 1234567890 |
phone_info | String | No | No | Admin description to show along with Phone | Phone Info |
dob | String | No | No | Admin's Date Of Birth (DD-MM-YYYY) | 21-12-1995 |
avatar[content] | String | No | No | Admin's Image in base64 format | Base64 Content |
avatar[url] | String | No | No | Admin's Image in URL format | https://tinericms.com/images/no-image.jpg |
This Api endpoint can be used to get a list of all existing Tineri Admins
This Api endpoint can be used to get details of a Tineri Admin
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_admin_id | String | Yes | Yes | Id of the Admin present in your booking system | admin_2 |
This Api endpoint can be used to delete a Tineri Admin
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_admin_id | String | Yes | Yes | Id of the Admin present in your booking system | admin_2 |
force_delete | Boolean | No | No | Set this to true if Admin is owner of any Booking(s) | true |
These Api endpoints can be used to create or update an existing Tineri User
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_user_id | String | Yes | Yes | Id of the User present in your booking system | admin_2 |
String | Yes | Yes | Email of the User | johndoe@email.com | |
job_title | String | No | No | Job Title of the User | Project Manager |
department | String | No | No | Department of the User | Sales |
preferred_language | String | No | No | Accepts one of 5 languages assigned in your Company Profile including Mandatory Language | Mandarin |
gender | String | No | No | User's Gender | Male |
firstname | String | Yes | No | User's First Name | John |
lastname | String | No | No | User's Last Name | Doe |
phone | String | No | No | User's Contact Number | 1234567890 |
phone_info | String | No | No | User description to show along with Phone | Phone Info |
dob | String | No | No | User's Date Of Birth (DD-MM-YYYY) | 21-12-1995 |
brands | Array | No | No | External Brand ID's present in your Booking System | [{"external_brand_id":"brand1"}, {"external_brand_id":"brand2"}] |
show_all_bookings | Boolean | No | No | Set this Flag to True if you want user to see all bookings of the selected Brand(s) | true |
avatar[content] | String | No | No | User's Image in base64 format | Base64 Content |
avatar[url] | String | No | No | User's Image in URL format | https://tinericms.com/images/no-image.jpg |
Note:
'show_all_bookings' parameter will only be used if the user is associated to brand(s)
This Api endpoint can be used to get a list of all existing Tineri Users
This Api endpoint can be used to get details of a Tineri User
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_user_id | String | Yes | Yes | Id of the User present in your booking system | user_2 |
This Api endpoint can be used to delete a Tineri User
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_user_id | String | Yes | Yes | Id of the User present in your booking system | user_2 |
force_delete | Boolean | No | No | Set this to true if User is owner of any Booking(s) | true |
This Api resource can be used to create or update an existing Tineri Traveller
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_traveller_id | String | Yes | Yes | Id of the Traveller present in your booking system | traveller_2 |
String | Yes | Yes | Email of the Traveller | johndoe@email.com | |
address | String | No | No | Traveller's Address | Address |
city | String | No | No | Traveller's City of residence | Margao |
province | String | No | No | Traveller's Province/State | Goa |
country | String | No | No | Traveller's Country | India |
preferred_language | String | No | No | Accepts one of 5 languages assigned in your Company Profile including Mandatory Language | Mandarin |
gender | String | No | No | Traveller's Gender | Male |
firstname | String | Yes | No | Traveller's First Name | John |
lastname | String | No | No | Traveller's Last Name | Doe |
title | String | No | No | Traveller's Title | Mr |
phone | String | No | No | Traveller's Contact Number | 1234567890 |
dob | String | No | No | Traveller's Date Of Birth (DD-MM-YYYY) | 21-12-1995 |
avatar[content] | String | No | No | Traveller's Image in base64 format | Base64 Content |
avatar[url] | String | No | No | Traveller's Image in URL format | https://tinericms.com/images/no-image.jpg |
This Api endpoint can be used to get a list of all existing Tineri Travellers
This Api endpoint can be used to get details of a Tineri Traveller
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_traveller_id | String | Yes | Yes | Id of the Traveller present in your booking system | traveller_2 |
This Api endpoint can be used to delete a Tineri Traveller
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_traveller_id | String | Yes | Yes | Id of the Traveller present in your booking system | traveller_2 |
force_delete | Boolean | No | No | Set this to true if Traveller is associated to any Booking(s) | true |
This Api resource can be used to create or update an existing Tineri Guide
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_guide_id | String | Yes | Yes | Id of the Guide present in your booking system | guide_2 |
String | Yes | Yes | Email of the Guide | johndoe@email.com | |
address | String | No | No | Guide's Address | Address |
city | String | No | No | Guide's City of residence | Margao |
province | String | No | No | Guide's Province/State | Goa |
country | String | No | No | Guide's Country | India |
preferred_language | String | No | No | Accepts one of 5 languages assigned in your Company Profile including Mandatory Language | Mandarin |
gender | String | No | No | Guide's Gender | Male |
firstname | String | Yes | No | Guide's First Name | John |
lastname | String | No | No | Guide's Last Name | Doe |
phone | String | No | No | Guide's Contact Number | 1234567890 |
dob | String | No | No | Guide's Date Of Birth (DD-MM-YYYY) | 21-12-1995 |
title | String | No | No | Guide's Title | Mr |
experience | String | No | No | Guide's Experience in Years | 5 Years |
languages | String | No | No | Langauges Known to the Guide | English,Spanish,Portugese |
description | String | No | No | Description about the Guide | Any Text/Html |
tineri_tip_description | String | No | No | Description about the Guide to be added the corrensponding Tineri Tip | Any Text/Html |
avatar[content] | String | No | No | Guide's Image in base64 format | Base64 Content |
avatar[url] | String | No | No | Guide's Image in URL format | https://tinericms.com/images/no-image.jpg |
tineri_tip_image[external_image_id] | String | Yes | Yes | Id of the image present in your booking system | image_1 |
tineri_tip_image[content] | String | No | No | Image for Guide's Tineri Tip in base64 format | Base64 Content |
tineri_tip_image[url] | String | No | No | Image for Guide's Tineri Tip in URL format | https://tinericms.com/images/no-image.jpg |
This Api endpoint can be used to get a list of all existing Tineri Guides
This Api endpoint can be used to get details of a Tineri Guide
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_guide_id | String | Yes | Yes | Id of the Guide present in your booking system | guide_2 |
This Api endpoint can be used to delete a Tineri Guide
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_guide_id | String | Yes | Yes | Id of the Guide present in your booking system | guide_2 |
force_delete | Boolean | No | No | Set this to true if Guide is associated to any Booking(s) | true |
This Api resource can be used to create or update an existing Tineri Supplier/Useful Contact
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_supplier_id | String | Yes | Yes | Id of the Supplier present in your booking system | supplier_2 |
String | Yes | Yes | Email of the Supplier | johndoe@email.com | |
address | String | No | No | Supplier's Address | Address |
city | String | No | No | Supplier's City of residence | Margao |
province | String | No | No | Supplier's Province/State | Goa |
country | String | No | No | Supplier's Country | India |
primary_contact | String | Yes | No | Supplier's Primary Contact Number | 1234567890 |
supplier_type | String | No | No | Supplier's Category/Type | Food and Beverage |
supplier_name | String | Yes | No | Supplier's Fullname | John Doe |
secondary_contact | String | No | No | Supplier's Secondary Contact Number | 1234567890 |
description | String | No | No | Description about the Supplier | Any Text/Html |
tineri_tip_description | String | No | No | Description about the Supplier to be added the corrensponding Tineri Tip | Any Text/Html |
avatar[content] | String | No | No | Supplier's Image in base64 format | Base64 Content |
avatar[url] | String | No | No | Supplier's Image in URL format | https://tinericms.com/images/no-image.jpg |
tineri_tip_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
tineri_tip_image[content] | String | No | No | Image for Supplier's Tineri Tip in base64 format | Base64 Content |
tineri_tip_image[url] | String | No | No | Image for Supplier's Tineri Tip in URL format | https://tinericms.com/images/no-image.jpg |
This Api endpoint can be used to get a list of all existing Tineri Suppliers/Useful Contacts
This Api endpoint can be used to get details of a Tineri Supplier
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_supplier_id | String | Yes | Yes | Id of the Supplier present in your booking system | supplier_2 |
This Api endpoint can be used to delete a Tineri Supplier
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_supplier_id | String | Yes | Yes | Id of the Supplier present in your booking system | supplier_2 |
force_delete | Boolean | No | No | Set this to true if Supplier is associated to any Booking Day(s) | true |
This Api resource can be used to create or update an existing Tineri Hotel/Accomodation
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_hotel_id | String | Yes | Yes | Id of the Hotel present in your booking system | traveller_2 |
name | String | Yes | No | Name of the Hotel | Hotel Casa Del Sol |
address | String | Yes | No | Hotel's Address | Address |
city | String | No | No | Hotel's City | Margao |
province | String | No | No | Hotel's Province/State | Goa |
country | String | Yes | No | Hotel's Country | India |
local_language_address | String | No | No | Hotel's Full Address in Local Language | 〒106-0044東京都港区東麻布1-8-1 東麻布ISビル4F |
hotel_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
hotel_image[content] | String | No | No | Hotel's Image in base64 format | Base64 Content |
hotel_image[url] | String | No | No | Hotel's Image in URL format | https://tinericms.com/images/no-image.jpg |
additional_hotel_images | Array | No | No | Additional Hotel Image content | Array Of Hashes (external_image_id,content/url) |
hotel_contacts_array | Array | No | No | Array containing Hotel Contacts | Array of Hashes |
hotel_contact[email] | String | No | No | Email of Hotel Contact | johndoe@mail.com |
hotel_contact[profile][firstname] | String | No | No | First Name of Hotel Contact | John |
hotel_contact[profile][lastname] | String | No | No | Last Name of Hotel Contact | Doe |
hotel_contact[profile][phone] | String | No | No | Contact number of Hotel Contact | 1234567890 |
description | String | No | No | Description about the Hotel | Any Text/Html |
tineri_tip_description | String | No | No | Description about the Hotel to be added the corrensponding Tineri Tip | Any Text/Html |
tineri_tip_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
tineri_tip_image[content] | String | No | No | Image for Hotel's Tineri Tip in base64 format | Base64 Content |
tineri_tip_image[url] | String | No | No | Image for Hotel's Tineri Tip in URL format | https://tinericms.com/images/no-image.jpg |
enable_poi | Boolean | No | No | If this is enabled then a POI will be created for the Hotel by fetching the coordinates of the full address | false |
This Api endpoint can be used to get a list of all existing Tineri Hotels/Accommodation
This Api endpoint can be used to get details of a Tineri Hotel
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_hotel_id | String | Yes | Yes | Id of the Hotel present in your booking system | hotel_2 |
This Api endpoint can be used to delete a Tineri Hotel
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_hotel_id | String | Yes | Yes | Id of the Hotel present in your booking system | hotel_2 |
This Api resource can be used to create or update an existing Tineri Experiences
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_experience_id | String | Yes | Yes | Id of the Experience present in your booking system | exp_2 |
name | String | Yes | No | Name of the Experience | Experience Casa Del Sol |
address | String | No | No | Experience's Address | Address |
city | String | No | No | Experience's City | Margao |
province | String | No | No | Experience's Province/State | Goa |
country | String | Yes | No | Experience's Country | India |
local_language_address | String | No | No | Experience's Full Address in Local Language | 〒106-0044東京都港区東麻布1-8-1 東麻布ISビル4F |
experience_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
experience_image[content] | String | No | No | Experience's Image in base64 format | Base64 Content |
experience_image[url] | String | No | No | Experience's Image in URL format | https://tinericms.com/images/no-image.jpg |
additional_experience_images | Array | No | No | Additional Experience Image content | Array Of Hashes (external_image_id,content/url)) |
description | String | No | No | Description about the Experience | Any Text/Html |
tineri_tip_description | String | No | No | Description about the Experience to be added the corrensponding Tineri Tip | Any Text/Html |
tineri_tip_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
tineri_tip_image[content] | String | No | No | Image for Experience's Tineri Tip in base64 format | Base64 Content |
tineri_tip_image[url] | String | No | No | Image for Experience's Tineri Tip in URL format | https://tinericms.com/images/no-image.jpg |
enable_poi | Boolean | No | No | If this is enabled then a POI will be created for the Experience by fetching the coordinates of the full address | false |
This Api endpoint can be used to get a list of all existing Tineri Experiences
This Api endpoint can be used to get details of a Tineri Experience
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_experience_id | String | Yes | Yes | Id of the Experience present in your booking system | experience_2 |
This Api endpoint can be used to delete a Tineri Experience
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_experience_id | String | Yes | Yes | Id of the Experience present in your booking system | experience_2 |
This Api resource can be used to create or update an existing Tineri Meals
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_meal_id | String | Yes | Yes | Id of the Meal present in your booking system | meal_2 |
name | String | Yes | No | Name of the Meal | Breakfast |
address | String | No | No | Meal's Address | Address |
local_language_address | String | No | No | Meal's Full Address in Local Language | 〒106-0044東京都港区東麻布1-8-1 東麻布ISビル4F |
city | String | No | No | Meal's City | Margao |
province | String | No | No | Meal's Province/State | Goa |
country | String | Yes | No | Meal's Country | India |
meal_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
meal_image[content] | String | No | No | Meal's Image in base64 format | Base64 Content |
meal_image[url] | String | No | No | Meal's Image in URL format | https://tinericms.com/images/no-image.jpg |
additional_meal_images | Array | No | No | Additional Meal Image content | Array Of Hashes (external_image_id,content/url)) |
description | String | No | No | Description about the Meal | Any Text/Html |
tineri_tip_description | String | No | No | Description about the Meal to be added the corrensponding Tineri Tip | Any Text/Html |
tineri_tip_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
tineri_tip_image[content] | String | No | No | Image for Meal's Tineri Tip in base64 format | Base64 Content |
tineri_tip_image[url] | String | No | No | Image for Meal's Tineri Tip in URL format | https://tinericms.com/images/no-image.jpg |
enable_poi | Boolean | No | No | If this is enabled then a POI will be created for the Meal by fetching the coordinates of the full address | false |
This Api endpoint can be used to get a list of all existing Tineri Meals
This Api endpoint can be used to get details of a Tineri Meal
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_meal_id | String | Yes | Yes | Id of the Meal present in your booking system | meal_2 |
This Api endpoint can be used to delete a Tineri Meal
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_meal_id | String | Yes | Yes | Id of the Meal present in your booking system | meal_2 |
This Api resource can be used to create or update an existing Tineri Transports
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_transport_id | String | Yes | Yes | Id of the Transport present in your booking system | transport_1 |
type | String | Yes | No | Type of the Transport | Train |
name | String | Yes | No | Transport name | Shatabdi |
from | String | Yes | No | From address of the Transport | Delhi |
from_point | String | No | No | Boarding Point of the Transport | Delhi railway station |
from_time | String | No | No | Boarding time of the Transport | 01:30 |
to | String | Yes | No | To address of the Transport | Mumbai |
to_point | String | No | No | Dropping point of the Transport | Mumbai Railway station |
to_time | String | No | No | Dropping Time of the Transport | 18:00 |
This Api endpoint can be used to get a list of all existing Tineri Transportation
This Api endpoint can be used to get details of a Tineri Transportation
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_transport_id | String | Yes | Yes | Id of the Transportation present in your booking system | transport_2 |
This Api endpoint can be used to delete a Tineri Transportation
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_transport_id | String | Yes | Yes | Id of the Transportation present in your booking system | transport_2 |
This Api resource can be used to create or update an existing Tineri Brands
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_brand_id | String | Yes | Yes | Id of the Brand present in your booking system | brand_1 |
name | String | Yes | No | Name of the Brand | Tineri-Tours |
color | String | Yes | No | Hex of Color to be Used in the App for the Brand | #ffffff |
String | Yes | No | Email of the Brand | brand@tineriapp.com | |
phone | String | Yes | No | Contact No. of the Brand | 125684567 | mobile | String | Yes | No | Contact No. of the Brand | 6537896532 |
country | String | No | No | Country of the Brand | India |
address | String | No | No | Address of the Brand | Address |
city | String | No | No | City of the Brand | Mumbai |
province | String | No | No | State/Province of the Brand | Maharashtra |
app_logo[content] | String | No | No | Brand's Logo in base64 format | Base64 Content |
app_logo[url] | String | No | No | Brand's Logo in URL format | https://tinericms.com/images/no-image.jpg |
home_screen_image[content] | String | No | No | Home Screen Image in base64 format | Base64 Content |
home_screen_image[url] | String | No | No | Home Screen Image in URL format | https://tinericms.com/images/no-image.jpg |
website_link | String | No | No | Website URL of the Brand | URL |
facebook_link | String | No | No | Facebook URL of the Brand | URL |
google_link | String | No | No | Google URL of the Brand | URL |
pinterest_link | String | No | No | Pinterest URL of the Brand | URL |
linkedin_link | String | No | No | LinkedIn URL of the Brand | URL |
instagram_link | String | No | No | Instagram URL of the Brand | URL |
youtube_link | String | No | No | YouTube URL of the Brand | URL |
twitter_link | String | No | No | Twitter URL of the Brand | URL |
whatsapp_link | String | No | No | Whatsapp URL of the Brand | URL |
snapchat_link | String | No | No | Snapchat URL of the Brand | URL |
This Api endpoint can be used to get a list of all existing Tineri Brands
This Api endpoint can be used to get details of a Tineri Brand
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_brand_id | String | Yes | Yes | Id of the Brand present in your booking system | brand_2 |
This Api endpoint can be used to delete a Tineri Brand
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_brand_id | String | Yes | Yes | Id of the Brand present in your booking system | brand_2 |
This Api endpoint can be used to get a list of all existing Tineri Users which are created using the UI and do not have external id's
This Api endpoint can get details of a Tineri User
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
String | Yes | Yes | Email of the User | johndoe@gmail.com |
This Api endpoint can be used to to assign/add external ID to Tineri Users
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
user_id | String | Yes | Yes | Tineri ID of the User | 5cb578fb4689ef0b26000039 |
user[external_id] | String | Yes | Yes | External Id of the User present in your system | trav_10 |
This Api resource can be used to create or update existing Tineri Points Of Interests
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_poi_id | String | Yes | Yes | Id of the POI present in your booking system | poi_1 |
name | String | Yes | Yes | Name of the POI | Wonder:Taj Mahal |
tineri_tip_display_name | String | Yes | Yes | Display name to be used for the Tineri Tip in App | Taj Mahal |
description | String | Yes | No | Description of the POI | Any String/HTML |
countries | Array | Yes | No | Countries of the POI | ["India"] |
location | String | Yes | No | Detailed Location of the POI | Taj Mahal, Agra, India |
location_lat_long | Hash | No | No | Latitude and Longitude of the POI, used to plot in Map | {"lat":"27.171165982","long":"78.038666512"} |
address | String | No | No | Address of the POI | Address |
city | String | No | No | City of the POI | Agra |
province | String | No | No | State/Province of the POI | Delhi |
use_as_tineri_tip_only | Boolean | No | No | If this is set to true, the POI will only be usable as a Tineri Tip and will not be auto-assigned as a POI | false |
poi_category_id | String | No | Yes | POI Category Id obtained from 'list_categories' endpoint | 5dc946af4689ef166c000001 |
header_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
header_image[content] | String | No | No | POI's Image in base64 format | Base64 Content |
header_image[url] | String | No | No | POI's Image in URL format | https://tinericms.com/images/no-image.jpg |
This Api endpoint can be used to get a list of all existing Tineri POI Categories
This Api endpoint can be used to get a list of all Tineri POI's belonging to a specific category.
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
poi_category_id | String | Yes | Yes | POI Category Id obtained from 'list_categories' endpoint | 5dc946af4689ef166c000001 |
This Api endpoint can be used to get details of a Tineri POI
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_poi_id | String | Yes | Yes | Id of the POI present in your booking system | poi_1 |
This Api endpoint can be used to delete a Tineri POI
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_poi_id | String | Yes | Yes | Id of the POI present in your booking system | poi_1 |
This Api resource can be used to create or update an existing Tineri Booking Header
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_booking_id | String | Yes | Yes | Id of the Booking present in your booking system | booking_2 |
name | String | Yes | Yes | Name of the Booking | Wonders Of India |
start_date | String | Yes | No | Date at which the Trip begins (DD-MM-YYYY) | 10-12-2018 |
number_of_nights | String | Yes | No | Number of nights for the entire trip | 5 |
start_point | String | No | No | Place where the Trip is going to Start, used to plot route in Map | Panaji,Goa |
start_point_lat_long | Hash | No | No | Latitude and Longitude of the Place where the Trip is going to Start, used to plot route in Map | {"lat":"15.484280","long":"73.823010"} |
intermediate_points | Array | No | No | Places visited during the trip, used to plot route in Map | [Delhi,Jharkhand] |
intermediate_points_lat_long | Array | No | No | Latitude and Longitude of the places visited during the Trip, used to plot route in Map | [{"lat":"28.704060","long":"77.102493"},{"lat":"23.610182","long":"85.279938"}] |
end_point | String | No | No | Place where the Trip is going to End, used to plot route in Map | Kannyakumari |
end_point_lat_long | Hash | No | No | Latitude and Longitude of the Place where the Trip is going to End, used to plot route in Map | {"lat":"8.088306","long":"77.538452"} |
countries | Array | No | No | Countries involved in the entire Trip | [India,Nepal] |
auto_assign_surveys | Boolean | No | No | If kept true, all the related surveys of the associated booking/booking day services will be auto-assigned | true |
map_mode | String | No | No | This is the booking level mode in which map routes will be displayed in the App | Cycling |
external_brand_id | String | No | Yes | Id of the Brand present in your booking system | brand_2 |
owner[external_user_id] | String | No | No | External User ID present in your Booking System | user_1 |
owner[external_admin_id] | String | No | No | External Admin ID present in your Booking System | admin_1 |
additional_owners | Array | No | No | External Admin/User ID present in your Booking System to assign owners | [{"external_admin_id":"admin_1"}, {"external_user_id":"user_1"}] |
emergency_contacts | Array | No | No | External Admin/User ID present in your Booking System to assign emergency contacts | [{"external_admin_id":"admin_1"}, {"external_user_id":"user_1"}] |
pois | Array | No | No | External POI ID present in your Booking System | [{"external_poi_id":"poi_1"}, {"external_poi_id":"poi_2"}] |
description | String | No | No | Textual Description of the entire Trip, Itinerary Details | Any Text/HTML |
status | String | No | No | Status of the Booking | Cancelled |
archive_booking_after_days | String | No | No | Number of Days after which the booking will be archived in the CMS after the trip is commenced | 5 |
internal_notes | String | No | No | Internal Notes for the Booking | Sample |
show_maps_in | String | No | No | Show maps for the booking in Google Maps/ Mapbox in app | Mapbox |
booking_header_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
booking_header_image[content] | String | No | No | Header Image of the Booking in base64 format | Base64 Content |
booking_header_image[url] | String | No | No | Header Image of the Booking in URL format | https://tinericms.com/images/no-image.jpg |
booking_home_screen_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
booking_home_screen_image[content] | String | No | No | Home Screen Image of the Booking in base64 format | Base64 Content |
booking_home_screen_image[url] | String | No | No | Home Screen Image of the Booking in URL format | https://tinericms.com/images/no-image.jpg |
guides_array | Array | No | No | Array of Guides | Array of Hashes |
guides_array[guide] | Hash | No | No | Guide Details | |
guides_array[guide][applicable_on_days] | Array | No | No | Days on which the particular guide is Applicable | ["1","5"] |
travellers_array | Array | No | No | Array of Travellers | Array of Hashes |
travellers_array[traveller] | Hash | No | No | Traveller Details |
Note:
Available Map Modes - Walking,Driving,Cycling
Map Mode feature is only available for Mapbox Map of Manual Map Type.
This Api endpoint can be used to get a list of all existing Tineri Bookings
This Api endpoint can be used to get details of a Tineri Booking
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_booking_id | String | Yes | Yes | Id of the Booking present in your booking system | booking_2 |
This Api resource can be used to get details of Travellers,Guides,Owner,Additional Owners and Emergency Contacts associated to a booking
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_booking_id | String | Yes | Yes | External Id of the Booking present in your Booking System | booking_1 |
This Api endpoint can be used to delete a Tineri Booking
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_booking_id | String | Yes | Yes | Id of the Booking present in your booking system | booking_2 |
This Api resource can be used to create or update existing Tineri Booking Days
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
booking_days | Array | Yes | No | Array of Booking Days | Array of Hashes |
external_booking_id | String | Yes | Yes | Id of the booking present in your booking system | booking_2 |
external_day_id | String | Yes | Yes | Id of the Booking Day present in your booking system | day_2 |
name | String | No | No | Name of the Booking Day | Day 2 |
description | String | No | No | Textual Description of the entire Booking Day | Any Text/HTML |
start_point | String | No | No | Place where the Booking Day is going to Start, used to plot route in Map | Panaji,Goa |
start_point_lat_long | Hash | No | No | Latitude and Longitude of the Place where the Booking is going to Start, used to plot route in Map | {"lat":"15.484280","long":"73.823010"} |
intermediate_points | Array | No | No | Places visited during the Day, used to plot route in Map | [Margao,Vasco] |
intermediate_points_lat_long | Array | No | No | Latitude and Longitude of the Places visited during the Day, used to plot route in Map | [{"lat":"15.280510","long":"73.996559"},{"lat":"42.964310","long":"-2.589860"}] |
end_point | String | No | No | Place where the Day is going to End, used to plot route in Map | Mapusa |
end_point_lat_long | Hash | No | No | Latitude and Longitude of the Place where the Day is going to End, used to plot route in Map | {"lat":"15.600227","long":"73.812500"} |
locations | Array | No | No | Locations involved in the entire Day | [Margao,Vasco,Mapusa] |
map_mode | String | No | No | This is the day level mode in which map routes will be displayed in the App | Driving |
day_header_image[external_image_id] | String | Yes | Yes | Id of the Image present in your booking system | image_2 |
day_header_image[content] | String | No | No | Header Image of the Booking Day in base64 format | Base64 Content |
day_header_image[url] | String | No | No | Header Image of the Booking Day in URL format | https://tinericms.com/images/no-image.jpg |
pois | Array | No | No | External POI ID present in your Booking System | [{"external_poi_id":"poi_1"}, {"external_poi_id":"poi_2"}] |
hotels_array | Array | No | No | Array of Hotels | Array of Hashes |
hotels_array[hotel] | Hash | No | No | Hotel Details | |
experiences_array[experience] | Hash | No | No | Experience Details | |
transports_array[transport] | Hash | No | No | Transport Details | |
transports_array[transport][user_seat_assignment] | Hash | No | No | Transport Seat Assignment Details | HASH |
transports_array[transport][user_seat_assignment][show_seats_to_everyone] | Boolean | No | No | Show seat assignment to everyone | false |
transports_array[transport][user_seat_assignment][traveller_seats] | Array | No | No | Array of users and their assigned seats | [{external_id:"trav_1",role:"traveller",seat:"2A"}, {external_id:"guide_1",role:"guide",seat:"5C"}] |
surveys_array | Array | No | No | Array of Custom Survey Items | ["Food Quality","Transfer Feedback"] |
flights_array | Array | No | No | Array of Flight Numbers | ["DY1102","FR8542"] |
suppliers_array | Array | No | No | Array of Useful Contacts/Suppliers | Array of Hashes |
suppliers_array[supplier] | Hash | No | No | Useful Contact/Supplier Details | |
map_routes | Array | No | No | Array of Hashes each containing a Route (Max Length - 4) | Array of Hashes |
map_routes[name] | String | Yes | No | Name Of the Route | Goa To Mumbai |
map_routes[start_point] | String | Yes | No | Place where the Route is going to Start, used to plot in Map | Goa |
map_routes[start_point_lat_long] | Hash | No | No | Latitude and Longitude of the Place where the Route is going to Start, used to plot route in Map | {"lat":"15.299326","long":"74.123993"} |
map_routes[intermediate_points] | Array | No | No | Places visited during the Route, used to plot in Map | ["Kolhapur","Pune"] |
map_routes[intermediate_points_lat_long] | Array | No | No | Latitude and Longitude of the Route visited during the Day, used to plot route in Map | [{"lat":"16.704987","long":"74.243256"},{"lat":"18.520430","long":"73.856743"}] |
map_routes[end_point] | String | Yes | No | Place where the Route is going to End, used to plot in Map | Mumbai |
map_routes[end_point_lat_long] | Hash | No | No | Latitude and Longitude of the Place where the Route is going to End, used to plot route in Map | {"lat":"19.075983","long":"72.877655"} |
map_routes[color] | String | Yes | No | Hex Code of the color used to plot the route in the Map | #ffd700 |
map_routes[map_mode] | String | No | No | This is the booking level mode in which map routes will be displayed in the App | Cycling |
Note:
Available Map Modes - Walking,Driving,Cycling
Map Mode feature is only available for Mapbox Map of Manual Map Type.
This Api endpoint can be used to get a list of all existing Tineri Booking Days of a specified Booking
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_booking_id | String | Yes | Yes | Id of the Booking present in your booking system | booking_2 |
This Api endpoint can be used to get details of a Tineri Booking Day
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_booking_id | String | Yes | Yes | Id of the Booking present in your booking system | booking_2 |
external_day_id | String | Yes | No | Id of the Booking Day present in your booking system | day_2 |
This Api endpoint can be used to delete a Tineri Booking Day
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_booking_id | String | Yes | Yes | Id of the Booking present in your booking system | booking_2 |
external_day_id | String | Yes | No | Id of the Booking Day present in your booking system | day_2 |
This Api resource can be used to create Single One-to-One Scheduled Message(s)
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
date_time | String | Yes | No | Date Time of the scheduled message(s) in the 24 hour format DD/MM/YYYY HH:MM | 21/12/2019 13:50 |
sender[external_id] | String | Yes | Yes | External Id of sender present in your booking system | admin_1 |
sender[role] | String | Yes | No | Role of the Sender present in Tineri | admin |
receiver[external_id] | String | Yes | Yes | External Id of Receiver present in your booking system | admin_1 |
receiver[role] | String | Yes | No | Role of the Receiver present in Tineri | admin |
messages | Array | Yes | No | Array of Messages Content | ["Hi","Hello"] |
tag | String | No | No | Identifier used to group multiple messages for easier deletion | ident1 |
This Api resource can be used to create Broadcast Scheduled Message(s)
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
date_time | String | Yes | No | Date Time of the scheduled message(s) in the 24 hour format DD/MM/YYYY HH:MM | 21/12/2019 13:50 |
sender[external_id] | String | Yes | Yes | External Id of sender present in your booking system | admin_1 |
sender[role] | String | Yes | No | Role of the Sender present in Tineri | admin |
receivers | Array | Yes | No | Array of Hashes of Receiver external_id's and roles | [{external_id:"trav_1",role:"traveller"}, {external_id:"guide_1",role:"guide"}] |
group_name | String | Yes | No | Name of the broadcast | Broadcast |
messages | Array | Yes | No | Array of Messages Content | ["Hi","Hello"] |
tag | String | No | No | Identifier used to group multiple messages for easier deletion | ident1 |
Note:
Allowed Roles for Sender - admin, user
Allowed Roles for Receiver - admin, user, traveller, guide
Messages can be scheduled minimum 5 minutes in the future
Scheduled Date Time will be considered as UTC (if no time is specified, '00:00' will be used)
This Api endpoint can be used to get details of all Scheduled Messages
This Api resource can be used to update a Scheduled Message
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
message_id | String | Yes | Yes | Tineri Id of the scheduled message | 5cda52f14689ef0e9e000385 |
date_time | String | No | No | Updated Date Time of the scheduled message(s) in the 24 hour format DD/MM/YYYY HH:MM | 21/12/2019 13:50 |
content | String | No | No | Updated Message Content | "Hey" |
This Api endpoint can be used to delete a Scheduled Message
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
message_id | String | Yes | Yes | Tineri Id of the scheduled message | 5cda52f14689ef0e9e000385 |
This Api endpoint can be used to delete multiple Scheduled Message(s)
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
tag | String | Yes | No | Identifier used to group multiple messages for easier deletion | ident1 |
This Api resource can be used to get a list of existing Document Categories
These Api resource can be used to create/update Document(s)
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_document_id | String | Yes | Yes | Id of the Document present in your booking system | doc_1 |
name | String | Yes | No | Name of the Document | John Doe Passport |
document_category_id | String | No | Yes | Category ID obtained from the 'list_categories' endpoint | 5dc143a84689ef42c7000003 |
external_booking_id | String | No | Yes | External Id of the Booking for which this Document is to be displayed | booking_1 |
roles | Array | No | No | Specify User Roles for which this Document is to be displayed | ["traveller","guide"] |
users | Array | No | No | Array of Users | [{external_id:"trav_1",role:"traveller"}, {external_id:"guide_1",role:"guide"}] |
file[name] | String | Yes | No | Full Filename of the document/file along with extension | no-image.jpg |
file[content] | String | No | No | Base 64 Encoded file content | Base64 String |
file[url] | String | No | No | URL of the File/Document | https://tinericms.com/images/no-image.jpg |
Note:
Allowed Roles for document[users] and document[roles] - traveller, guide
When 'document[external_booking_id]' is used the 'document[users]' should belong to the booking
When 'document[document_category_id]' is passed as blank/empty, the documents will be assigned to the default category
How to add a Document for all bookings?
To add a document for all bookings send a POST request to '/api/v2/documents/' with document[roles] = ["traveller","guide"]
How to add a Document for all travellers of a specific booking?
To add a document for all travellers of a specific booking send a POST request to '/api/v2/documents/' with document[external_booking_id] = 'booking_1' which is the external id of the sepicifed booking and document[roles] = ["traveller"]
This Api endpoint can be used to get details of all Documents belonging to a specific category
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
document_category_id | String | Yes | Yes | Category ID obtained from the 'list_categories' endpoint | 5dc143a84689ef42c7000003 |
This Api endpoint can be used to get details of a Document
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_document_id | String | Yes | Yes | Id of the Document present in your booking system | doc_1 |
This Api endpoint can be used to delete a Document
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
external_document_id | String | Yes | Yes | Id of the Document present in your booking system | doc_1 |
This Api resource can be used Send a Welcome Email to Travellers/Guides of a booking
Name | Data Type | Mandatory | Unique | Description | Sample |
---|---|---|---|---|---|
traveller_preferred_language | Boolean | Yes | No | To send the Email using the Preferred Language of the receiver | true |
language | String | No | No | Specify which Language Template to use to send email when traveller_preferred_language is 'false' | English |
external_booking_id | String | Yes | Yes | External Id of the Booking present in your Booking System | booking_1 |
receivers | Array | Yes | No | Array of Users | [{external_id:"trav_1",role:"traveller"}, {external_id:"guide_1",role:"guide"}] |
include_pdf | Boolean | No | No | Send the booking exported as PDF along with the Email as attachment | true |
attachments | Array | No | No | Array of Hashes | Array of Hashes |
attachments[ ][name] | String | Yes | No | Full Filename of the file along with extension | no-image.jpg |
attachments[ ][content] | String | No | No | Base 64 Encoded file content | Base64 String |
attachments[ ][url] | String | No | No | URL of the File | https://tinericms.com/images/no-image.jpg |
Note:
Allowed Roles for email[receivers] - traveller, guide
email[language] is only required if email[traveller_preferred_language] is false
For every hash in email[attachments] either 'content' or 'url' is mandatory