Getting 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 Note 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 Note Tags
Assuming you have access to the Note objects, the object itself will be a list type, so the object must be looped. The tags and/or sub-object tags should be nested within the loop.
The following are implementations of the Note object that give access to the Note tags: GenericNotes, InvoiceNotes, ShippingNotes, GraphicNotes, PressNotes, FinishingNotes, OutsourcedNotes
Here is a chart displaying these use cases.
Syntax | Example | |
<!-- {{#each Notes}} --> {{TagName}} <br /> <!-- {{/each}} --> | <!-- {{#each ShippingNotes}} --> {{Notes}} <br /> <!-- {{/each}} --> | |
<!-- {{#each Notes}} --> {{TagName.SubObjectTagName}} <br /> <!-- {{/each}} --> | <!-- {{#each InvoiceNotes}} --> {{CreatedByEmployee.Name}} <br /> <!-- {{/each}} --> |
Overview
Tag Name | Description | Type | Additional Sub Object |
CreatedByEmployee | The name of the employee who created the note. | Employee Tags | |
CreatedByEmployeeId | The id of the employee who created the note. | Guid | |
CreatedDate | The date the note was created. | Date/Time | |
CustomerId | The id of the customer. | Guid | |
Id | The id of the note. | Guid | |
Label | The label that has been selected on the note. | Text | |
Notes | The content that has been input on the note. | Text | |
NoteTypes | The type(s) that have selected on the note. | List | |
OrderId | The id of the order. | Guid | |
OrderItemId | The id of the order item. | Guid |