MenuClose
CONTENT MANAGEMENT SYSTEM ONLINE HELP
Enquiries - API Reference
Enquiries
A message is created for every contact us, enquiry form, or custom form.
End Point URL
https://api.cms-tool.net/webapps/api/message
API Parameters and Filters
| Name | Description | Example | Optional | Data type |
| data | The JSON you would like to POST. This can be POST content also |
{
}
|
Yes | json object |
| id | Search a specific message by it's id | id=123 | Yes | int |
|
mbr_id |
Search messages which were posted by a mbr_id | mbr_id=1234 | Yes | int |
|
postedAfter |
Search messages which were posted after the time provided. |
postedAfter="2021-01-01" |
Yes | string |
|
postedBefore |
Search messages which were posted before the time provided. |
postedBefore="2021-12-31" |
Yes | string |
|
orderby |
Sort the results by latest date. |
orderby = "date" |
Yes | string |
| forum_info_id or info_id | Messages on a specific blog | forum_info_id=123123 | Yes | int |
| forum_pid or pid | Messages on a specific product | pid=123123 | Yes | int |
| msg_group_id | Forum posts from a specific group | msg_group_id=1234 | Yes | int |
| msg_re | Replies to existing comments | msg_re=123 | Yes | int |
Data Dictionary
| Key | Definition | Type | Format |
Usage Instructions and Examples
Create a new Message Post
To create a new message use POST method and do not provide any Message Id.
Provide the mbr_id if known or member email address as mbr_from.
Example if mbr_id is known:
{
"mbr_id" : 12345,
"from_name": "Example Name",
"subject": "Subject of the post",
"body": "Example post body",
"page": 123
}
Example if mbr_id not known:
{
"submitter" : "example@email.com",
"from_name": "Example Name",
"subject": "Subject of the post",
"body": "Example post body",
"page": 123
}
Sample Object
{"submitter":"testemail@test.co.nz",}
"from_phone":"021123123",
"subject":"Make a Booking 2021-12-14 15:00:00",
"mbr_id":1234,
"msgid":1413,
"posted_by_mbr_id":1234,
"closed_by_mbr_id":0,
"from_name":"John",
"body":"No comment was provided with booking ID:123",
"msg_debug":" ",
"re_eventid":0,
"submitted":"2021-12-13 13:43:52.0",
"re_info_id":0,
"re_bookingid":123,
"id":1413,
"page":2222,
"re_pid":1234,
"re_listing_id":0,
"msg_net_score":0,
"cid":1234
API End Points
Content
Blog pages are usually presented as a list udner a primary page. Individual blog pages do not appear on the menu, only in lists. The blog engine also powers FAQ and gallery type pages
EndPoint: https://api.cms-tool.net/webapps/api/blog
A website is made up of the primary navigational pages that create the primary menu, as well as hidden pages and member only pages. Pages can contain pages in a treelike structure, however, this excludes sub pages which are defined as blogs or products
EndPoint: https://api.cms-tool.net/webapps/api/page
Ecommerce
Categories are used to group products. Products can belong in up to 8 categories.
Categories can also form a tree, with Category parent ID = 0 being the parent level category.
The term group is synomous with category, so many elements are prefixed with the word group.
EndPoint: https://api.cms-tool.net/webapps/api/category
Each product line of an order can be discounted, so an order can have multiple discounts, but only one per product.
EndPoint: https://api.cms-tool.net/webapps/api/discount
The available payment methods at checkout. An order can only have 1 payment method, but the admin can change the payment method, and take part payments.
EndPoint: https://api.cms-tool.net/webapps/api/paymentop
A saleable item, or variant of a parent product.
EndPoint: https://api.cms-tool.net/webapps/api/product
Invoices, orders, baskets and quotes are all represented by this object, and differentiated by status.
EndPoint: https://api.cms-tool.net/webapps/api/basket
The courier or freight fee rules available for checkout. Each order can only have rule applied
EndPoint: https://api.cms-tool.net/webapps/api/shipping
Members
Bulk emails represent a newsletter that will be sent to a bulk audience via a mailing list. Alternatively, a bulk email is a sequence within a campaign.
EndPoint: https://api.cms-tool.net/webapps/api/bulkemail
A message is created for every contact us, enquiry form, or custom form.
EndPoint: https://api.cms-tool.net/webapps/api/message
Group members/customers, each member can belong to unlimited groups. Groups can contain groups
EndPoint: https://api.cms-tool.net/webapps/api/membergroups
System security levels. Default level is 100 for general users.
EndPoint: https://api.cms-tool.net/webapps/api/reference/memberlevel
Members or customers or users are the same thing. These are anyone who has purchased, enquired, or who has permission to login, or receive newsletters. This excludes administrative users.
EndPoint: https://api.cms-tool.net/webapps/api/member
A blog comment or product review uses the same engine. Each record may have a rating, as well as an optional comment, and is linked to an object and the person who posted it
EndPoint: https://api.cms-tool.net/webapps/api/comments
Other
Bookings are for appointments, seats, hire items, etc. Not for events.
EndPoint: https://api.cms-tool.net/webapps/api/booking
Use the Event Attendee endpoint to get your event attendee information on your site.
EndPoint: https://api.cms-tool.net/webapps/api/eventAttendee
Events have a start/end date and additional information, they might be bookable, or just for informational purposes
EndPoint: https://api.cms-tool.net/webapps/api/event
Reference
A list of countries, and some meta data
EndPoint: https://api.cms-tool.net/webapps/api/reference/countries
EndPoint: https://api.cms-tool.net/webapps/api/reference/currencies
EndPoint: https://api.cms-tool.net/webapps/api/reference/fx
Generic categories are those that relate to open source categorisations of products for SEO purposes
EndPoint: https://api.cms-tool.net/webapps/api/reference/categories
EndPoint: https://api.cms-tool.net/webapps/api/reference/postcodes