MenuClose
CONTENT MANAGEMENT SYSTEM ONLINE HELP
Members / Customers - API Reference
Members / Customers
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.
End Point URL
https://api.cms-tool.net/webapps/api/member
Data Dictionary
| Key | Definition | Type | Format |
| mbr_name |
Members Name
Name of the member or customers. Primarily their personal contact name (required)
|
text
|
|
| mbr_company |
Company
The company or organisation to which this member belongs, optional in addition to the member name.
|
text
|
|
| mbr_country |
Country
The country where this member lives.
|
text
|
|
| mbr_delivery_address |
Delivery address
Customers preferred delivery address street
|
text
|
|
| mbr_delivery_city |
Delivery city
Customers preferred delivery address city
|
text
|
|
| mbr_delivery_company |
Delivery company
Customers preferred delivery address company
|
text
|
|
| mbr_delivery_country |
Delivery country
Customers preferred delivery address country.
|
text
|
|
| mbr_delivery_email |
Delivery email
Customers preferred delivery address email
|
text
|
|
| mbr_delivery_name |
Delivery name
Customers preferred delivery address contact name
|
text
|
|
| mbr_delivery_phone |
Delivery phone
Customers preferred delivery address phone
|
text
|
|
| mbr_delivery_postcode |
Delivery postcode
Customers preferred delivery address postcode
|
text
|
|
| mbr_delivery_state |
Delivery state
Customers preferred delivery address state
|
text
|
|
| mbr_delivery_suburb |
Delivery suburb
Customers preferred delivery address suburb
|
text
|
|
| mbr_discount |
Discount Rate
A percentage discount rate applied globally to all retail product prices for this customer only
|
text
|
Precision: 5.2
|
| mbr_email |
Email
Members primary email address
|
text
|
|
| mbr_email_accounts |
Accounts Email
Alternative email address just for accounts related messages
|
text
|
|
| mbr_gender |
mbr gender
Gender of the customer, single chracter, eg M or F
|
char
|
|
| mbr_groups_summary |
mbr groups summary
A CSV list of all the groups this customer belongs to
|
text
|
|
| mbr_id |
ID
The primary ID of the member record. System generated serial integer (readonly)
|
text
|
Max Len: 11
|
| mbr_ipaddr |
mbr ipaddr
LEGACY / DELETE
|
text
|
|
| mbr_ipaddress |
mbr ipaddress
IP Address of the user
|
text
|
|
| mbr_jobtitle |
mbr jobtitle
Customers job title
|
text
|
|
| mbr_lang |
mbr lang
Customers preferred language
|
text
|
|
| mbr_level |
mbr level
Security level of the customer, references the mbr_level table, 100 is a general member, 0 do not contact, 200 is an authorised level etc.
|
int
|
|
| mbr_logins |
mbr logins
Count of logins all time
|
int
|
|
| mbr_message_to_member |
mbr message to member
Special use case for a unqiue message to give to this user but not the same as the welcome message.
|
text
|
|
| mbr_mobile |
mbr mobile
Mobile phone number
|
text
|
|
| mbr_notes |
mbr notes
Primary notes field for a customer. this notes field may show as an alert against the customer in mutliple pages
|
text
|
|
| mbr_order_count |
mbr order count
Total order count in customer life cycle
|
int
|
|
| mbr_order_last |
mbr order last
Timestamp of the last order placed by this customer
|
timestamp
|
|
| mbr_order_total |
mbr order total
Total lifecycle customer value
|
text
|
Precision: 12.2
|
| mbr_password |
mbr password
MD5 encrypted password field.
|
text
|
|
| mbr_phone |
mbr phone
Phone number of the customer
|
text
|
|
| mbr_points_balance |
mbr points balance
Loyalty points balance
|
text
|
Precision: 10.2
|
| mbr_postcode |
mbr postcode
Postcode of the primary address
|
text
|
|
| mbr_preferred_card_id |
mbr preferred card id
Preferred credit card ID
|
int
|
|
| mbr_pricegrp |
mbr pricegrp
Price group, blank or price for retail, or priceA,priceB,priceC,priceD,priceE,priceF,priceG
|
text
|
|
| mbr_reference |
mbr reference
Customer Account number, often used to reference a third party system
|
text
|
|
| mbr_referredby |
mbr referredby
Affiliate ID, Integer ID references another member record who is recorded as the affiliate
|
int
|
|
| mbr_sales_rep_id |
mbr sales rep id
References another member record who is the sale representative and who would have administrative access to POS etc
|
int
|
|
| mbr_sechash |
mbr sechash
A short term hash that can be used for a customer to access their account via a one time key sent by email
|
text
|
|
| mbr_sechash_reset |
mbr sechash reset
The date/time that the last hash was generated
|
timestamp
|
|
| mbr_security_group_email |
mbr security group email
An email address that connects multiple member records together, in some systems a customer needs more than 1 account, eg for each currency in unleashed
|
text
|
|
| mbr_source |
mbr source
From where did this customer originate, website, shop, etc
|
text
|
|
| mbr_state |
mbr state
State or Region of the customer address
|
text
|
|
| mbr_statements |
mbr statements
JSON structure representing a history of statements sent to the customer
|
json
|
|
| mbr_suburb |
mbr suburb
Suburb of the primary address
|
text
|
|
| mbr_terms_agreed |
mbr terms agreed
A timestamp when terms and conditions were last agreed
|
timestamp
|
|
| mbr_title |
mbr title
LEGACY / DELETE
|
text
|
|
| mbr_updated |
mbr updated
The date this member record was last updated
|
timestamp
|
|
| mbr_updated_via_api |
mbr updated via api
The date this member record was last updated from an external API
|
timestamp
|
|
| mbr_url |
mbr url
URL to the company website of this person
|
text
|
|
| mbr_welcome |
mbr welcome
A unique welcome message just for this user only, may have confidential data
|
text
|
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