{ } API Explorer Support

Documents template design

You can use the tools in this section to create new document templates for the document/delivery notethat will be included in the orders you dispatch.The column headings are: Documents template design

Field Description
Template name The template name describes the content and purpose of the template.
Created on Tells you when the template was created in Avasam.
Default Only one template can be the default. When one entry has this toggled to ‘Yes’, the other templates will toggle to ‘No’.

Add new template

  1. Click on the ‘Add template’ button to begin.
  2. In the ‘Add template’ screen, under ‘Template details’, you can specify the template name. Add template
  3. You will need to set the size of the paper this document is printed on. Select a common option, or select ‘Custom paper size’.
    a. The width of the paper should be entered in the specified units (cm here).
    b. The weight of the paper should also be entered here in the specified units (cm here).
    c. Click ‘Save’ to update. Save button
  4. Select the default font to be used in the template.
  5. Select the default size for that font.
  6. Use the ‘Elements’ section to define other elements of the document.
  • Fields marked with an asterisk (*) are compulsory and must be completed.

Elements

The ‘Elements’ controls allow you add information to the blank document. Some of these will be fixed items, like your logo.

Static field

A Static field can contain text. This can either be fixed text, such as ‘Delivery note’, or it can contain text from a field in the order, such as ‘Order status’.

To create a static text field:

  1. Click on the ‘Static field’ button to the left. This will add a new element into the document.
  2. Click and drag this to the right place on the document.
  3. Resize the area of the element by clicking on the bottom right corner and dragging it out.
  4. Click on the element.An ‘Edit’ option is shown which opens up the control for the field.
Field Description
Field Is the name/reference for the control. It is not editable.
Display text Should be entered if you want this to simply show some fixed text.
Items data Is a dropdown list of fields available from the order. The contents of that field in the order will be used.
Save button Will apply your changes to the element and returns to the document template.

Field

The ‘Logo’ control allows you to show an image on the document.

To add a logo:

  1. Click on the ‘Logo’ button to the left.
  2. Click and drag this to the right place on the document.
  3. Resize the area of the element by clicking on the bottom right corner and dragging it out.
  4. If you click on the element, an ‘Edit’ option is shown. This opens the ‘Upload logo’ window.
    a. Click ‘Select File’ button to find and upload a supported image file.
    b. The ‘Logo’ element will be replaced by a preview of the image.
    c. The ‘Save’button applies the change and returns to the document template. Logo

Customer address

The ‘Customer address’ element allows you to show the customer’s details from the order.

  1. Click on the ‘Customer address’ button to the left. This will add a new element into the document.
  2. Click and drag this to the right place on the document.
  3. Resize the area of the element by clicking on the bottom right corner and dragging.
  4. Click on the element to show an ‘Edit’ option. This opens up the ‘Customer address table configuration’ window. Customer address
Field Description
‘Up’ and ‘down’ arrows Allow you to change the order of the fields.
Visible box I. Controls if the selected field will be shown in the address. Untick it to hide that field.
Header title Tells you the content of that field.
Sample value Gives you an example of a typical entry in that field.
Width Allows you to set (in pixels) how much room is allowed for the information in that field. If the text is too long, it will only show partially.
Alignment control Sets whereabouts in the ‘box’ the information will be placed. Usually centered, it can start at the top right, bottom left, etc.
Border field Toggles whether lines will show between the address fields.
  1. When you have completed the configuration of the address table, click ‘Save’ to finish and return to the template design.

Label

The ‘Label’ element contains a shipping label. When you print the document, it will request a label for the shipping service on that order, and print it as part of the document.

This is referred to as an ‘embedded label’. It is usually used with special paper that has an appropriately sized peel-off section. It reduces the complexity of dispatch, involves less printers and consumables, and saves you having to pair up the label and the document with the correct order during dispatch.

To create an embedded label:

  1. Click on the ‘Label’ button.
  2. Click and drag it to the right place on the document.
  3. Resize the area of the element by clicking on the bottom right corner and dragging.
  • The contents of the label cannot be edited in the template

Order items

The ‘Order items’ control provides a table showing what is in the order.

To add an order summary element:

  1. Click on the ‘Label’ button to the left.
  2. Click and drag it to the right place on the document.
  3. Resize the area of the element by clicking on the bottom right corner and dragging.
  4. Click on the elementto show the ‘Edit’ option. Click this to open up the ‘Items data table configuration’ window. Order items
Field Description
‘Up’ and ‘down’ arrows Allow you to change the order the fields will be shown.
Visible’ box Controls if the selected field will be shown in the address. Untick it to hide the field.
Header title Tells you what the contents of that field is.
Sample value Gives you an example of a typical entry in that field, so you can be sure what to expect.
Width Allows you to set (in pixels) how much room is allowed for the information in that field. If the text is too long, it will only show partially. This allows you to avoid things overlapping and causing confusion or readability problems.
Alignment control Lets you choose whereabouts in the ‘box’ the information will be placed.
Border field Lets you toggle whether lines will show between the address fields.
Sort entry Allows you to choose if the field is sorted in ascending order (red arrow) or descending order (green arrow).
  1. When you have completed the configuration of the address table, click ‘Save’ to finish and return to the template design.
  • Orders will be sorted based on the content of the top field first.
  • In the sort field, where more than one order contains the same value, they will be sorted based on the next field.

Order total

This allows you to display the details of the subtotal, total, shipping charges etc. for the order.

To edit the order total parameters:

  1. Click on the ‘Order total’ button to the left. This will add a new element into the document.
  2. You can click and drag this element to the right place on the document.
  3. You can resize the area of the element by clicking on the bottom right corner and dragging.
  4. If you click on the element, an ‘Edit’ option is shown.
  5. This opens up the ‘Items total table configuration’ window. Order total
Field Description
‘Up’ and ‘down’ arrows Allow you to change the order the fields will be shown.
Visible’ box Controls if the selected field will be shown in the address. Untick it to hide the field.
Header title Tells you what the contents of that field is.
Sample value Gives you an example of a typical entry in that field, so you can be sure what to expect.
Width Allows you to set (in pixels) how much room is allowed for the information in that field. If the text is too long, it will only show partially. This allows you to avoid things overlapping and causing confusion or readability problems.
Alignment control Lets you choose whereabouts in the ‘box’ the information will be placed.
Border field Lets you toggle whether lines will show between the address fields.
Sort entry Allows you to choose if the field is sorted in ascending order (red arrow) or descending order (green arrow).
  1. When you have completed the configuration of the address table, click ‘Save’ to finish and return to the template design.
  • The orders will be sorted based on the content of the top field first.
  • In the sort field, where more than one order contains the same value, they will then be sorted based on the next field.

Changes and updates

If you click on the element, an ‘Edit’ option is shown. This opens up the configuration window, if available (The label element has no edit option). Edit’ option If you make a change, it will show that there are ‘Unsaved changes’. Unsaved changes’

  • You can return to the main page at any time without updating the system by clicking on the ‘Documents template design’ link on the top left, where available, or the ‘Cancel’ button.
  • To save the changes you have made and apply them, click on ‘Save’.

Deleting document templates

To delete a document template:

  1. Locate the template you wish to delete.
  2. To delete the entry, click on the ‘X’ to the right of the entry.
  3. Confirm deletion by clicking ‘OK’. Delete a document template
  4. You will be returned to the list of templates.
  • Click ‘Cancel’ if you change your mind about the deletion.

To print a PDF of the list of document templates:

  1. Click the ‘Print’ button.

Export document templates

You can export and download a list of the document templates using the ‘Export’ option. Select from three file formats:

  1. CSV file.
  2. Acrobat PDF file.
  3. Excel XLS file.