...
| Expand |
|---|
|
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. | Code Block |
|---|
| title | The {order} object |
|---|
| collapse | true |
|---|
| 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
)
)
) |
| Code Block |
|---|
| title | The {invoice} object |
|---|
| collapse | true |
|---|
| stdClass Object
(
[id] => 19983
[id_format] => PD-{num}
[id_value] => 15695
[client_id] => 3
[date_billed] => 2013-05-13 18:33:15
[date_due] => 2013-05-13 18:33:15
[date_closed] =>
[date_autodebit] =>
[status] => active
[subtotal] => 8.0000
[total] => 8.0000
[paid] => 0.0000
[previous_due] => 2635.4700
[currency] => USD
[note_public] =>
[note_private] =>
[id_code] => PD-15695
[delivery_date_sent] =>
[due] => 8.0000
[line_items] => Array
(
[0] => stdClass Object
(
[id] => 54940
[invoice_id] => 19983
[service_id] => 234
[description] => Bronze Standard - domain.com
[qty] => 1.0000
[amount] => 8.0000
[subtotal] => 8.00000000
[taxes] => Array
(
)
[taxes_applied] => Array
(
)
[tax_subtotal] => 0
[tax_total] => 0
[total] => 8
[total_w_tax] => 8
)
)
[delivery] => Array
(
[0] => stdClass Object
(
[id] => 20716
[invoice_id] => 19983
[method] => email
[date_sent] =>
)
)
[meta] => Array
(
)
[tax_subtotal] => 0
[tax_total] => 0
[taxes] => Array
(
)
) |
| Code Block |
|---|
| title | The {services} array of objects |
|---|
| collapse | true |
|---|
| Array
(
[0] => stdClass Object
(
[id] => 234
[parent_service_id] =>
[package_group_id] => 1
[id_format] => PD-{num}
[id_value] => 229
[pricing_id] => 22
[client_id] => 3
[module_row_id] => 6
[coupon_id] =>
[qty] => 1
[status] => in_review
[date_added] => 2013-05-13 18:33:14
[date_renews] => 2013-06-13 18:33:14
[date_last_renewed] =>
[date_suspended] =>
[date_canceled] =>
[id_code] => PD-229
[fields] => Array
(
[0] => stdClass Object
(
[key] => cpanel_confirm_password
[value] => password
[serialized] => 0
[encrypted] => 1
)
[1] => stdClass Object
(
[key] => cpanel_domain
[value] => domain.com
[serialized] => 0
[encrypted] => 0
)
[2] => stdClass Object
(
[key] => cpanel_password
[value] => password
[serialized] => 0
[encrypted] => 1
)
[3] => stdClass Object
(
[key] => cpanel_username
[value] => domainco
[serialized] => 0
[encrypted] => 0
)
)
[package_pricing] => stdClass Object
(
[id] => 22
[package_id] => 13
[term] => 1
[period] => month
[price] => 8.0000
[setup_fee] => 0.0000
[cancel_fee] => 0.0000
[currency] => USD
)
[package] => stdClass Object
(
[id] => 13
[id_format] => {num}
[id_value] => 1
[module_id] => 4
[name] => Bronze Standard
[description] =>
[description_html] => <p>
<span style="color:#008000;"><em>Good Value!</em></span></p>
[qty] =>
[module_row] => 6
[module_group] =>
[taxable] => 0
[status] => active
[company_id] => 1
)
[name] => domain.com
)
) |
|
Linking to Order Pages
A link to each order page is displayed in the staff area, under Packages > Order Forms. The order form marked as the default will be available at ~/order/, and all other order forms will have unique links. It's also possible to link directly to a specific package, pricing option, or step. Here are a list of GET variables that can be passed into the order process.
| Variable | Example | Notes |
|---|
| package_id | [URL]&package_id=xx | Applies to the first step, the package selection step, where xx is the Package ID. To determine the Package ID, edit the package in the staff area and copy it from the URL, for example /admin/packages/edit/1/ – In this case, the package_id is 1. |
| pricing_id | [URL]&pricing_id=xx | Applies to the configuration step. Selects a specific price for the package. To determine the Pricing ID, edit the package and view the source for the pricing options. Look for a hidden form field with a name of pricing[id][] and observe it's value. |