Order System

Table of Contents

The Order System is installed by default, but may need to be installed for addon companies.

Installing Order System

Visit [Settings] > [Company] > [Plugins] > Available.
Click the "Install" button within the Order System plugin listing.
To enable the Order System widget, go to [Billing] > Overview, click the "Manage Widgets" link, and drag the Orders widget from the right to the left.

Order System Overview

Once installed, a new link will appear under [Packages] > Order Forms, where order forms can be managed. In the screen below, two order forms have already been created and they can be managed at this location.

Creating an Order Form

To create an order form, click the "Add Order Form" button in the upper right of the overview and fill out the options. Click "Add Form" to create the order form.

Basic

This section requests some basic information regarding the order form and it's configuration including:

Status – This is the status of this order form, Active to enable the order form or Inactive to disable it.
Name – The name of this order form, this will appear in the heading on front facing pages for this order form.
Label – The label helps make up the URL to this order form, which is displayed next to the field, and must be unique.
Type – This is the type of order form, currently the following three are available: Domain and Other, General, and Client Registration. In most cases, the General type is preferred. This selection will determine what options are displayed for the Template.
Template – Select an order form template. The template controls the look and flow of the order form. Wizard boxes is the default template, and is most widely used.

Basic (Continued)

This section contains some additional options within the Basic section.

Default Client Group – This is the client group users who sign up through this order form will be assigned.
Allow Coupons – Whether or not coupons should be allowed on this order form. If coupons are not allowed, the coupon section on the order form will not be displayed.
Require Manual Review and Approval of All Orders – If this is checked, all orders will need to be approved by a staff member before being provisioned, regardless of any anti-fraud settings.
Force Secure Connection (HTTPS) – If checked, the order form will force https:// URLs.
Require Human Verification Challenge for All Signups – If checked, reCaptcha or AreYouAHuman human verification will be used, depending on the Setting under the Settings tab.
Require Agreement to Terms of Service – If checked, users will be required to agree to the terms of service before checking out.
Terms of Service URL – Enter the URL to your terms of service page. This isn't necessary if "Require Agreement to Terms of Services" isn't checked.

Package Groups & Currencies

These sections determine what Package Groups (And hence Packages) are available through this order form as well as what currencies are accepted.

Assigned Groups & Available Groups – Move Package Groups from the right box (Available Groups) to the left box (Assigned Groups) to make them available on this order form.
Currencies – Select which currencies to accept on this order form. If only one currency is selected, the currency selector will not appear on the order form.

Settings

The Order System supports various settings for human verification, and fraud detection.

Fraud Detection

The Order System supports Fraud Detection through the use of the MaxMind minFraud service. The MaxMind Anti-Fraud component offers a number of configurable options that allow orders to be either rejected outright (no client account created), or flagged for review. When an order is flagged for review it will remain as a Pending order until moved to either the Accepted or Fraud category by a staff user, at which time the client account will be automatically marked as active or fraud.

Human Verification

The Order System supports Human Verification through the use of reCaptcha as well as AreYouAHuman.

Order Emails

Order related email templates can be found under [Settings] > [Company] > [Emails] > Email Templates, in the section labeled "Plugin Templates".

Order Received

The order received email templates allow for the following tags:

Tags	Description	Notes
{order.id}	The system-level order ID
{order.number}	The order number	e.g. "519131eb623b8"
{order.client_id}	The system-level client ID of the client this order belongs to
{order.client_id_code}	The friendly client ID code
{order.client_first_name}	The first name of the client
{order.client_last_name}	The last name of the client
{order.client_company}	The client's company name
{order.client_address1}	The client's primary address
{order.client_email}	The client's email address
{invoice.id}	The system-level invoice ID of the invoice created for this order
{invoice.id_code}	The friendly invoice ID code
{invoice.date_due}	The UTC datetime stamp of the invoice due date	Formatted as "YYYY-MM-DD HH:MM:SS"
{invoice.date_billed}	The UTC datetime stamp of the invoice bill date	Formatted as "YYYY-MM-DD HH:MM:SS"
{invoice.total}	The total amount due on the invoice	e.g. "8.00"
{invoice.paid}	The total amount paid	e.g. "0.00"
{invoice.due}	The remaining amount due	e.g. "8.00"
{invoice.currency}	The currency that the invoice is in	e.g. "USD"

Additional Tags

Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, a dump of the tags are shown below.

The {order} object

stdClass Object
        (
            [id] => 52
            [order_number] => 519131eb623b8
            [order_form_id] => 1
            [invoice_id] => 19983
            [fraud_report] => 
            [status] => pending
            [date_added] => 2013-05-13 18:33:15
            [fraud_status] => 
            [order_form_label] => my_order_form
            [order_form_name] => My Order Form
            [client_id] => 3
            [total] => 8.0000
            [paid] => 0.0000
            [currency] => USD
            [date_closed] => 
            [invoice_id_code] => PD-15695
            [client_id_code] => PD-1501
            [client_first_name] => Mark
            [client_last_name] => Stevens
            [client_company] => Comp Co.
            [client_address1] => 123 Test St.
            [client_email] => user@domain.com
            [services] => Array
                (
                    [0] => stdClass Object
                        (
                            [order_id] => 52
                            [service_id] => 234
                        )

                )

        )

The {invoice} object

The {services} array of objects

Order Received (Mobile)

The ticket received email template allows for the following tags:

Tags	Description	Notes
{order.id}	The system-level order ID
{order.number}	The order number	e.g. "519131eb623b8"
{order.client_id}	The system-level client ID of the client this order belongs to
{order.client_id_code}	The friendly client ID code
{order.client_first_name}	The first name of the client
{order.client_last_name}	The last name of the client
{order.client_company}	The client's company name
{order.client_address1}	The client's primary address
{order.client_email}	The client's email address
{invoice.id}	The system-level invoice ID of the invoice created for this order
{invoice.id_code}	The friendly invoice ID code
{invoice.date_due}	The UTC datetime stamp of the invoice due date	Formatted as "YYYY-MM-DD HH:MM:SS"
{invoice.date_billed}	The UTC datetime stamp of the invoice bill date	Formatted as "YYYY-MM-DD HH:MM:SS"
{invoice.total}	The total amount due on the invoice	e.g. "8.00"
{invoice.paid}	The total amount paid	e.g. "0.00"
{invoice.due}	The remaining amount due	e.g. "8.00"
{invoice.currency}	The currency that the invoice is in	e.g. "USD"