Functionality Reference

From Mothership
Jump to: navigation, search

Mothership Admin Area: Functionality Reference.

Note that this is the functionality of a 'typical' Mothership installation. Features may vary depending on which modules are installed.

Login

  • Using unique username and password
    • Forgotten password reset

Dashboard

  • Recent Activity (current user)
    • Last edited page
      • Date/time, Page Title (link)
    • Last edited product
      • Date/time, Product Name (link)
    • Last edited order
      • Date/time, Order ID (link)
  • Content
    • Recently added/edited (all users) x 4
      • Date/time, Page Title (link)
    • Recently deleted (all users) x 4
      • Date/time, Page Title (link)
        • Restore option
  • Popular Products (week)
    • Bar graph: top four products with sales quantity
  • Orders activity (week)
    • Orders in (total)
    • Orders despatched (total)
  • Average order Fulfilment time (hours)
  • Total sales (exc. shipping) by day, graph, last 7 days
  • Blog comments activity
    • Comments in need of approval
    • Comments approved in the last 7 days

Users

  • Search for an existing user by Name or User ID
  • Edit User details:
    • Title, Forename, Surname, Email address
    • User type
    • Billing and Delivery addresses:
      • Address Line 1, 2, 3, 4, Town, Postcode, State (if applicable), Country, Tel,
  • Define groups the User is a member of
  • View User’s order history
  • Log in to website as the selected User
    • Place order with or without payments as this User
  • Add a new User
    • Define password

Note: passwords are encrypted and are not visible or editable by the administrator.

User types and profiles

User profiles allow custom content to be assigned to a user to appear on CMS pages or products.

Packaged types:

  • None
    • No profile fields
  • Team member
    • Job title
    • Biography
    • Profile picture

File Manager

  • Search for an existing File by name
  • Upload multiple Files at once
  • Add meta data to File:
    • Alt text
    • Tags (to aid searching within File Manager)
    • Delete a File

Note: File type, Size, User, Editor, Date Added and Date Edited are stored automatically.

Content

  • Search for an Entry by text content
  • Add a new Entry

Content types are dependent on the configuration of the individual site, these are shown for example purposes only:

  • Page Title
  • Product to sell
  • Products to cross-sell
  • Gallery (image, optional link, optional text per item)
  • Body text, secondary text etc.
    • Switch between WYSIWYG (What You See Is What You Get) and Markdown (simple code mark-up) editors
  • Date
  • Author
  • Define Publish settings
    • Save draft as unpublished
    • Make the Entry visible on the website immediately
    • Set start (and end) dates/times for automated future publishing
  • Set Entry attributes:
    • URL Segment (text that appears in the browser address bar after the domain)
    • Include/exclude Entry from site search results
    • Include/exclude Entry from site navigation menus
    • Include/exclude Entry from index/listing pages
    • Define User-types who can access the Entry:
    • Inherit access from parent Entry
    • Everybody
    • Only people who aren’t logged in
    • Only people who are logged in
    • Only specific User groups*

Note: User Groups are defined by the individual site configuration

  • Define the Entry’s position within the site
  • Change the order of Entries*

Note: blog/news posts are ordered by date by default.

  • Set Entry meta data:
    • Page title (will appear in browser and third-party search results)
    • Meta Description (information about the page, as used in Google search results)
  • Edit an Entry
    • Including all the parameters shown above

Products

  • Add a new product
    • Define basic product attributes:
      • Name
      • Brand
      • Category
      • Variants (e.g. sizes, colours) Note: the ‘matrix’ of multiple variants is created automatically on the fly.
      • Retail Price
      • RRP
      • Cost Price
      • Product Type (based on site set-up)
      • Description
    • Define further product attributes (mostly optional):
      • Display name
      • Sort name (to override alphabetised listing)
      • Short Description
      • Export Description
      • Weight Grams
      • Notes
      • Country of Manufacturer
    • Define product details (mostly optional):
      • Year
      • Care instructions
      • Sizing information
      • Features
      • Season
      • Fabric
    • Set product pricing (Note: prices are set globally for the product during initial product creation but can be overridden at the SKU level):
      • Retail Price
      • RRP
      • Cost Price
    • Tax
      • Tax strategy (inclusive or exclusive) is set site-wide
      • Tax rates are set to a product type in the config
      • Export value
    • Define individual Product Units (SKUs):
      • SKU code
      • Variant names and values eg colours, sizes
      • Override prices (optional)
        • Retail, RRP, Cost
      • Override weight (grams)
      • Set product ‘visibility’ on site (On/Off)
      • Edit barcode (automatically generated on unit creation)
    • Set stock levels per SKU and Location
      • Default stock locations (Note: Additional stock locations can be added):
        • Web
        • Bin
        • Hold
    • Define Product Images:
      • Image (selected from uploaded Files)
      • Image type (e.g. ‘default’, ‘reference’ etc. dependent on site configuration)
      • Set images for specific Product Options (e.g. colourway):
        • Option Name
        • Option Value
    • Remove Option image
  • Upload CSV
    • Download template CSV
    • Upload CSV with data to several new products at once
    • Options to create new product pages based on recently created products (requires some extra setup)
      • Set shop parent page
      • Group product pages by category, brand, or under selected shop parent page
      • Options to create pages per product or based on a set variant
  • Edit product
    • Including all the parameters shown above
  • Print barcodes
    • For all units in location
      • Select location
    • Manually
      • Enter number of barcodes required per SKU
    • Define print offset (by X number of already-printed labels on sheet)
  • Delete Product

Orders

  • Dashboard
    • Orders activity (week)
      • Orders in (total)
      • Orders despatched (total)
    • Average order Fulfilment time (hours)
    • Total sales (exc. shipping) by day, graph, last 7 days
  • Search by Order ID
  • List All Orders (Displays: Order ID; Creation Date; User Name; Order Status; Shipping Method; Total Gross)
  • List Shipped Orders (Displays: Order ID; Creation Date; User Name; Order Status; Shipping Method; Total Gross)
  • Inspect Order details:
    • Overview:
      • Billing Total
      • Pre-tax sub total
      • Discount
      • Shipping Cost
      • Grand Total
      • Currency
        • Conversion Rate (if applicable)
      • Delivery Address:
        • Name
        • Email Address
        • Address line 1, 2, 3, 4
        • Town
        • Postcode
        • Country
        • Telephone Number
    • Order Creation summary:
      • User name
      • Creation date/dime
      • User email address
    • Item Summary:
      • Item product name
      • Item Net
      • Item Discount
      • Item Tax
      • Item Gross
      • Sub Total
      • Order Shipping Cost
      • Grand Total
      • Cancel item (Note: only available pre-shipping)
      • Item details:
        • Brand, Product Name
        • Net
        • Discount
        • Gross
        • Prices (Retail, RRP, Cost)
        • SKU code
        • Barcode number
        • Weight
    • Processing Details
      • Created date/time
      • Created by (User)
      • Current Status code
    • Status History (Note: history logs all statuses during order lifetime)
      • Status
      • Updated at date/time
      • Updated by (User name)
    • Addresses
      • Delivery
        • Name
        • Email Address
        • Address line 1, 2, 3, 4
        • Town
        • Postcode
        • Telephone
      • Billing
        • Name
        • Email Address
        • Address line 1, 2, 3, 4
        • Town
        • Postcode
        • Telephone
    • Payment details
      • Method
      • Refunds
      • Merchant reference
    • Dispatches
      • Delivery type
      • Date and Time
      • Shipping details:
        • Shipped by (User)
        • Shipped date/time
        • Courier Shipment Code
        • Cost
        • Weight (grams)
    • Items summary
      • Product Brand, Name, Colour, Size
      • Net
      • Discount
      • Tax
      • Gross
    • Notes
      • Add note:
        • Notify Customer (checkbox)
    • Documents
      • Document type (e.g. packing slip)
        • Re-print document
      • Creation date/time
    • View Returns (on this order)
      • Item Brand, Name, Colour, Size
        • Reason
        • Resolution
        • Balance
        • Status
        • Return Created by (User)
        • Option to process Return from this screen.

Returns

  • Search by Return ID
  • List Returns:
    • Awaiting
    • Received
    • Awaiting Payment
    • Pending Refund
    • Pending Exchange
    • Completed
    • Rejected
      • Return ID
      • Order ID
      • Item
      • Created date/time
      • User
      • Resolution (Refund, Exchange)
      • Status
      • Balance
      • Payee (e.g. Customer/Vendor)
  • Receive items
    • Date/time
    • Notify Customer (pre-formatted, editable email)
      • Edit email
  • Select destination for received item:
    • Bin, Web, Hold etc. (Note: stock locations dependent on site configuration.)
  • Make payment:
    • Refund - partial or full amount
  • Process exchange
    • Set replacement item ‘ready for despatch’
  • Reject return
    • Date/time
    • Notify Customer (pre-formatted, editable email)
      • Edit email

Discounts

Discount codes

  • Search for an existing discount
  • List all active discounts
  • List all inactive discounts
  • Add a new discount code:
    • Name
    • Description
    • Code (i.e. text string)
    • Start date/time
    • End date/time
    • Define benefits:
      • Percentage discount amount (e.g. 10%) OR Fixed Discount Amount (e.g. £10)
      • Free shipping
    • Define discount criteria
      • Applies to whole order or specific products:
        • Chosen products
      • Order threshold
      • Define eligible users
        • Default: all customers
        • Enter email addresses
  • Edit an existing discount code
    • With all options as above
  • View log of discounted orders
    • Individual order details
      • Order ID, Date, User Name, Total Discount, Total Gross,
    • Grand total discount applied
    • Grand total gross

Bundles

  • View all bundles
  • Add a new bundle
    • Set name
    • Set start date
    • Set end date
    • Set price (for each registered currency)
    • Set image
    • Set whether it can work in conjunction with discount codes
    • Add product(s)
      • Select product
      • Select product option name and value
      • Select quantity
    • Remove product

Vouchers

  • All Vouchers listing
    • ID (voucher code)
    • Creation date/time
    • Initial value
    • Balance
    • Expiry date
  • Search for an existing Voucher ID
    • Display Voucher details
    • Display Voucher usage
    • Invalidate Voucher
  • Create a new Voucher
    • Currency (based on site-wide configuration)
    • Voucher value
    • Valid from/to date/time (Note: vouchers without dates do not expire.)

Reports

Discounts & Vouchers

Note: all reports are sortable by all column headings. Note: all reports can be downloaded in CSV format.

  • Discount Summary
    • Code
    • Description
    • Creation date/time
    • Expiry date/time
    • Type (e.g. fixed or %)
    • Free Shipping
    • Currency
    • Total Income
    • Total Shipping
    • Total Applied Discount
    • Total Number of Orders
    • Status
  • Voucher Summary
    • Voucher Code
    • Originating Order ID
    • Created By
    • Creation date/time
    • Expiry date/time
    • Currency
    • Initial Value
    • Used Amount
    • Balance
    • Status

Transactions

  • Payments & Refunds (Note: Filterable by start/end date/time, Transaction type)
    • Date
    • Created By
    • Currency
    • Method
    • Amount
    • Type (e.g. Payment, Refund)
    • Order ID
    • Related return Order ID (if applicable)

Sales

Note: All sales reports are filterable by Currency, Start/end date/time, Source (e.g. Web, EPOS), Sale type (e.g. Order, Return, Exchange, Shipping)

  • By Day
    • Date
    • Currency
    • Net
    • Tax
    • Gross
  • By Item
    • Date
    • Order ID
    • Return ID (if applicable)
    • Source (e.g. shop, web)
    • Type (e.g. order, exchange, shipping income)
    • Product Name
    • Product Options (e.g. colour, size)
    • Currency
    • Net
    • Tax
    • Gross
  • By Location
    • Country
    • Currency
    • Net
    • Tax
    • Gross
  • By Month
    • Date
    • Currency
    • Net
    • Tax
    • Gross
  • By Order
    • Order ID
    • Date
    • User name
    • Source (e.g. shop, web)
    • Currency
    • Net
    • Tax
    • Gross
    • Country
  • By Product
    • Product
    • Options (e.g. size, colour)
    • Currency
    • Net
    • Tax
    • Gross
    • Transactions
  • By Unit
    • Product
    • Option
    • Currency
    • Net
    • Tax
    • Gross
    • Transactions
  • By User (customer)
    • User Name
    • Email
    • Currency
    • Net
    • Tax
    • Gross

Logs

  • Search Terms (all time)
    • Search Term
    • Frequency

Products

  • Stock Summary (Note: available for any entered date.)
    • Category
    • Product Name
    • Options
    • Stock Level

Users

  • User Summary
    • Email
    • Forename
    • Surname
    • Address lines 1-4
    • Town
    • Postcode
    • State
    • Country
    • Creation date

Refer a Friend

Ability to create rewards for users who refer others to the site. This module is not packaged by default.

  • Set reward
  • View referred users
  • View current settings

Reward types

  • No reward
    • Set name
    • Set email message
  • Discount reward
    • Set name
    • Set email message
    • Set minimum order value for referred user to trigger discount
    • Set time limit
    • Set discount type (percentage or set amount)
    • Set percentage of discount
    • Set amount of discount