This guide will show you how to setup integrated shipping labels. These are sticky labels on A4 sheets that allow you to print an invoice and shipping label on the same sheet of paper.
Currently these can only be used with NetDespatch, but we will update this guide as new couriers are added over time.
1. Configuration
To begin setting up integrated labels we must first create two templates. One will act as the integrated label and the other as a fall back when an integrated label is not required.
Click “Configuration” from the Admin Centre to continue.
2. Letters
Navigate to the options menu and click “Template Editor” under Letters.
3. Fall Back Template – Template Editor
We need to create our first template as a fall back for when integrated labels are not required.
Click “New” to begin creating a new template.
4. Fall Back Template – New Template
Now we have a blank space for our new template. Click the <> button as shown above.
5. Fall Back Template – Source Code
An empty source code window will show, which we can fill with the code for our template. Copy the code below and paste it into the source code window and click “Ok”.
6. Fall Back Template – Customising The Template
Now you have your basic label template which will serve as the fall back when an integrated label is not required.
1. Set the language.
2. Select “General” as the category.
3. Name your template “Dispatch Label” as we will be creating triggers later that point specifically to that template.
Click “Save” to finalise your template and go back to the template editor page.
7. Integrated Label Template – New Template
We need to create our second template for the integrated labels.
Click “New” to begin creating a new template.
8. Integrated Label Template – Template Editor
Now we have a blank space for our new template. Click the <> button as shown above.
9. Integrated Label Template – Source Code
An empty source code window will show, which we can fill with the code for our template. Copy the code below and paste it into the source code window and click “Ok”.
10. Integrated Label Template – Customising The Template
Now you have your basic integrated label template which only needs a few small tweaks to make it ready for to use.
1. Set the language.
2. Select “General” as the category.
3. Give your template a clear name as we will be setting up triggers that point towards it.
11. Integrated Label Template – Edit Website
Remember to change your website. You may also want to edit the message to something specific you would like to use.
1. Click the website link.
2. Click the “Insert/edit link and change the link in the “Insert Link” window. Alternatively you can simply type a new web address and not make it an active link, since this is primarily being used for printing.
Click “Save” to finalise your template and go back to the template editor page.
12. Integrated Label Template – How It Looks
Everything you have done so far will give you a document that would print like the example above. If you are happy with that, you can click “Save” on the template editor and you are done.
Bear in mind that the label as shown above won’t look like that on your template, as that information is not generated until the order is booked in with the courier and the merge tag looks for one of those labels for that order, already in the queue and tells it where in the document to place it based on the parameters set.
If you require a very specific layout, the next step will show you how to make some more advanced changes.
13. Integrated Label Template – Editing The Merge Tag
– The following are some advanced customisations for the template. This step is not necessary unless a specific layout is required –
The tag at the bottom of the screen contains parameters that can be changed if you want it to look a certain way.
Currently the merge tag reads:
@Merge.ManualDispatchLabel(S7)
This creates a standard layout as determined by the “S7”.
Three parameters can be used in place of S7 which will alter the position of the label within the document:
@Merge.ManualDispatchLabel(0,-450,0)
In this example we have replaced the “S7” parameter with “0,-450,0”.
The first “0” represents the labels X position measured from the left of the document. A zero in this case means the label is all the way to the left.
“-450” is the Y position as measured from the top of the document. In this case such a parameter places the label at the very bottom of the page.
The second “0” can be used to rotate the label a number of degrees. For example, changing this value to “90” would rotate the label 90 degrees.
Bear in mind that these values are very subjective, so if you are changing them, they will require a bit of trial and error to get right.
If you want to go back to the standard template, simply replace those three variables with S7.
14. Shipping Rules
The next step is setting up a shipping rule for your integrated label. This basically tells Cloud Commerce Pro that you wish to use your integrated label for NetDespatch orders.
In the options panel navigate to the Shipping section and click “Rules”.
15. NetDespatch Rule
1. You most likely have an existing NetDespatch rule setup that can be edited to work with integrated labels. Click “edit” next to the rule and continue to the next step.
2. If you don’t have a NetDespatch rule already, use the next step as a guide to setting up the rule and click “Add New Rule”. You can find a more in depth guide on creating shipping rules here.
16. Label Type
The only thing you need to change is the label type, as shown above. Set this to “Integrated Label” and click save to continue.
17. Template Triggers
Triggers help point the system in certain directions under specific circumstances. So in this case we want to make sure that when a NetDespatch label is going to print, it uses the template we have created.
Navigate back to the options menu and click “Triggers” under Letters.
18. Editing Triggers
There a three triggers we need to set for our integrated label to work correctly.
For each trigger we need to set the template and the method. Remember, if you used a different name for your templates, simply add your personalised version to the trigger rather than the examples used below.
1. DispatchLabel
Template = DispatchLabel
Method = PrintQueue
2. RetailOrderDispatch
Template = [Your Template Name] eg “DispatchNoteNew”
Method = PrintQueue
3. TradeOrderDispatch
Template = [Your Template Name] eg “DispatchNoteNew”
Method = PrintQueue
NOTE: In Order to use Integrated labels, all triggers involved must be producing PDFs. Integrated labels do not work with HTML documents. If you find your triggers are producing HTML documents, contact your project manager as they will need to make that change on your behalf.