API Reference / Data Dictionary

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

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

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.

Each product line of an order can be discounted, so an order can have multiple discounts, but only one per product.

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.

A saleable item, or variant of a parent product.

Invoices, orders, baskets and quotes are all represented by this object, and differentiated by status.

The courier or freight fee rules available for checkout. Each order can only have rule applied

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.

A message is created for every contact us, enquiry form, or custom form.

Group members/customers, each member can belong to unlimited groups. Groups can contain groups

System security levels. Default level is 100 for general users.

View or add notes to a member record

Points are earned and redeemed based on the loyalty points program setup in your eCommerce area. Using the memberpoints endpoint you can view the history of member points for your site and create new entries.

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.

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

Bookings are for appointments, seats, hire items, etc. Not for events.

Use the Event Attendee endpoint to get your event attendee information on your site.

Events have a start/end date and additional information, they might be bookable, or just for informational purposes

Bookings need to be made against a calendar. A resource might be a staff member, a room, a seat, or a hire item.

A list of countries, and some meta data

Generic categories are those that relate to open source categorisations of products for SEO purposes