{module_order}

Description

Displays Customer's Order History (must be logged in to secure zone).

Syntax

{module_order render="item|collection" filter="all" workflowId="123" sortType="Alphabetical" collection="my_custom_collection_name" template="/folder/template.tpl"}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet.

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • filter - filtering criteria for display and can be one of the following:
    • all - all items
    • workflow - all items in a particular workflow classification
  • workflowID - appears only when selecting "all items in a workflow" as a display criteria
  • sortType- system generated (do not change)
    • Default - Sorts the orders by date
    • Alphabetical - Sorts the orders alphabetically
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

Layouts

Examples

  • {module_order filter="c" workflowID="10044" sortType="Default"} - will display all orders that belong to workflow with ID of 10044, sorting them by date
  • {module_order filter="a" sortType="Alphabetically"} - will display all orders, alphabetically
  • {module_order filter="c" workflowID="10044" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.

Syntax

{module_order,filter,workflowID,SortType}

Parameters

  • filter - filtering criteria for display and can be one of the following:
    • a - all items
    • c - all items in a particular workflow classification
  • workflowID - appears only when selecting "all items in a workflow" as a display criteria
  • SortType- system generated (do not change)
    • Default - Sorts the orders by date
    • Alphabetical - Sorts the orders alphabetically

Layouts

  • the order list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Order list layout reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:
Liquid tag Legacy tag Description
{{amountOutstanding}} {tag_amountoutstanding}Amount outstanding on invoice
{{amountOutstandingActual}} {tag_amountoutstandingactual}Amount of invoice outstanding, only taking into account successful payments (pending payments excluded)
{{amountPaid}} {tag_amountpaid}Amount already paid on invoice
{{amountPaidActual}} {tag_amountpaidactual}Amount of invoice paid with a successful payment (pending payments excluded)
{{assignedTo}} {tag_assignedto}Name of the person whom the order is assigned to
{{awbNumber}} {tag_awbnumber}Tracking number from shipping provider(also known as AWB number). You can edit this information for each order
{{createdate}} {tag_createdate} Create date of the order, e.g. "2014-09-05"
{{invoiceDate}} {tag_invoicedate}Date of Invoice, e.g. "2014-09-05"
{{invoiceNumber}} {tag_invoicenumber}Invoice number
{{invoiceTotal}} {tag_invoicetotal}Total invoice amount
{tag_invoicetotaltaxamount}Total tax associated with order (product tax + shipping tax)
{{lastUpdateDate}} {tag_lastupdatedate}Last update date of the order, e.g. "2014-09-05"
{{id}} {tag_orderid}Order ID (you can use this value to search for the order in the CRM > Search panel)
{{orderName}} {tag_ordername}Name of order
{{orderType}} {tag_ordertype}Type of the order; for example, Invoice or Quote
{{ownerName}} {tag_ownername}Name of the person who owns the order
{{productExtension}} {tag_productextension}Three-letter extension of the file if an e-Product; for example, PDF. Use to render out relevant icon for e-Product (applies to flat listing only; for example, {module_order,a,,flat})
{{productID}} {tag_productid}Displays the internal ID of the product in the order (applies to flat listing only; for example, {module_order,a,,flat})
{{productName}} {tag_productname}Displays the name of the product in the order (applies to flat listing only; for example,{module_order,a,,flat}). Provides a link to download product if e-Product.
{{shippingInstructions}} {tag_shippinginstructions}Any specific shipping instructions that accompany the order
{{status}} {tag_status}Stats of the order
{{trackingUrl}} {tag_trackingurl,Your Text}URL of the shipper to track shipments. You can edit this information for each order
{{workflow}} {tag_workflow}Workflow name assigned to order

Examples

  • {module_order,c,10044,Default} - will display all orders that belong to workflow with ID of 10044, sorting them by date
  • {module_order,a,,Alphabetically} - will display all orders, alphabetically, also displaying every product within each order