create new ticket
check ticket statusGetting Started
If you are new to the HTML document/canned email tag system, you can get an overview of tags, objects and loops here.
Accessing The Order Object
Access to this object is dependent on what document or canned email type you are trying to access the object from. Start by finding the document or canned email type you are working with from the links provided below. Follow the chart for your specified document or canned email type to see if the object is accessible, and if so, where it is located. You may need to use a combination of loops and/or chaining to access this object.
Accessing The Order Tags
Assuming you have access to the Order object, you must do one of the following:
1. Prefix the object's name to the required tag
2. If the tag contains an 'Additional Sub Object', then the tag must prefix the sub-object tag and suffix the object
3. If the tag is a list type, then the tag must be looped. The sub-object tags should be nested within the loop.
4. If the object itself is a list type, then the object must be looped. The tags and/or sub-object tags should be nested within the loop.
5. If the object itself and the sub-object are list types, then both objects must be looped. The sub-sub-objects tags and/or objects should be nested within the loop.
Here is a chart displaying these use cases.
| Syntax | Example | |
1 | {{Order.TagName}} | {{Order.ItemsTotal}} |
2 | {{Order.TagName.SubObjectTagName}} | {{Order.ShippingLocation.City}} |
3 | <!-- {{#each Order.TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Order.GraphicsNotes}} --> {{Notes}} <br /> <!-- {{/each}} --> |
4 | <!-- {{#each Orders}} --> {{TagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Orders}} --> {{Number}} <br /> <!-- {{/each}} --> |
| 5 | <!-- {{#each Orders}} --> <!-- {{#each TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> <!-- {{/each}} --> | <!-- {{#each Orders}} --> <!-- {{#each OrderItems}} --> {{ItemTotal}} <br /> <!-- {{/each}} --> <!-- {{/each}} --> |
Overview
| Tag Name | Description | Type | Additional Sub Object |
| ApprovedTotal | The amount entered on the approved total. | Decimal Value | |
| Barcode | A barcode can be generated to populate the url to the order. | Text | |
| BillingLocation | The tags relating to a location can be accessed for the default billing location input on the order. | Location Tags | |
| Contact | The tags relating to a contact can be accessed for the contact who is set as the contact on the order. | Contact Tags | |
| ContactId | The contact id. | Guid | |
| CSR | The tags relating to a employee can be accessed for the employee who is set as the csr on the order. | Employee Tags | |
| CsrEmployeeId | The id of the employee who is the selected CSR. | Guid | |
| Customer | The tags relating to a customer can be accessed for the customer who is set as the customer on the order. | Customer Tags | |
| CustomerId | The customer id | Guid | |
| DiscountTotal | The total amount of discounts that have been applied to items on the order. | Decimal Value | |
| EntryAllocations | The tags relating to a entries can be accessed for the for entries that been applied to the order. | List | Order Entry Allocation Tags |
| GenericNotes | The tags relating to notes can be accessed for the generic type notes input on the order. | List | Note Tags |
| GraphicTotal | The total amount of graphics that have been applied to items on the order. | Decimal Value | |
| Id | The id of the order. | Guid | |
| InvoiceDate | The date set as the invoice date. | Date/Time | |
| InvoiceDelivery | The invoice delivery that has been selected on the order. | Text | |
| InvoiceDueDate | The date set as the invoice due date. | Date/Time | |
| InvoiceNotes | The tags relating to notes can be accessed for the invoice type notes input on the order. | List | Note Tags |
| InvoiceTotal | The total amount of the order after taxes. | Decimal Total | |
| ItemsPrice | The total amount of the items before graphics and discounts. | Decimal Total | |
| ItemsTotal | The total amount of the items plus graphics and minus discounts. | Decimal Total | |
| Name | The name of the order that has been input on the order. | Text | |
| Number | The system generated order number. | Whole Number | |
| OrderDate | The date set as the order date. | Date/Time | |
| OrderItems | The tags relating to an item can be accessed for the items on the order. | Order Item Tags | |
| OrderPayments | The tags relating to an payment can be accessed for the payments on the order. | Order Payment Tags | |
| OrderStatusUrl | The url to the order status page. | Text | |
| OrderType | The type of the order, values can be order, quote, product, cart or group template. | Text | |
| PaidAmount | The total amount that has been paid or credited on the order. | Decimal Total | |
| PaymentTerms | The payment terms that has been selected on the order. | Text | |
| PayOrderUrl | The url to the pay order page. | Text | |
| PostageTotal | The total postage amount entered on the order. | Decimal Total | |
| PreDiscountPrice | The item price plus graphics. | Decimal Total | |
| PreTaxTotal | The total amount of the items plus graphics, shipping and postage, minus discounts. | Decimal Total | |
| PreviousOrder | The tags relating to the previous order can be accessed for the previous order. | Previous Order Tags | |
| PreviousOrderId | The id of the previous order. | Guid | |
| PurchaseOrderNumber | The purchase order number that has been input on the order. | Text | |
| QuoteApprovalUrl | The url to the quote approval | Text | |
| QuoteDate | The date set as the quote date. | Date/Time | |
| Receiver | The tags relating to a employee can be accessed for the employee who is set as the receiver on the order. | Employee Tags | |
| ReceiverEmplyeeId | The id of the employee who is the selected receiver. | Guid | |
| SalesRep | The tags relating to a employee can be accessed for the employee who is set as the sales rep on the order. | Employee Tags | |
| SalesRepEmployeeId | The id of the employee who is the selected sales rep. | Guid | |
| Shipments | The tags relating to a shipment can be accessed for the shipments input on the order. | List | Shipment Tags |
| ShippingLocation | The tags relating to a location can be accessed for the default shipping location input on the order. | Location Tags | |
| ShippingNotes | The tags relating to notes can be accessed for the shiopnotes input on the order. | List | Note Tags |
| ShippingTotal | The total amount of shipping on the order. | Decimal Total | |
| ShippingType | The shipping type that has been selected on the order. | Shipping Type Tags | |
| Status | The tags relating to statuses can be accessed for the statuses set on the order. | Order Status Tags | |
| Tags | A list of the tag (names) applied to the order.. | List | |
| Taxes | The tags relating to the taxes can be accessed for the tax rates input on the order. | List | Order Tax Tags |
| TaxTotal | The total amount of tax on the order. | Decimal Total | |
| UnpaidAmount | The outstanding balance of the order. | Decimal Total | |
| UrlPath | The url to the order. | Text |