Shipping Delivery Note
Automatically prepend configured text to Linnworks order notes created by Customer_Message, helping teams highlight customer delivery notes during order review, fulfilment, and dispatch.
Customer messages can contain important information that needs to be visible during order handling. If these notes are not clearly marked, warehouse, customer service, or dispatch teams may miss important customer instructions.
The Append Customer Message Note macro helps make customer message notes easier to identify by adding configured text to the beginning of each matching note.
This macro checks selected Linnworks orders, finds order notes created by Customer_Message, and prepends the configured AppendNote value if the note does not already start with that value.
Highlight customer message notes by automatically adding a consistent prefix to matching order notes.
Configure the Macro
Once the app is installed, you need to create a macro configuration so the system knows which macro to run and what text should be added to customer message notes.
This setup can be adjusted anytime based on your operational requirements.
Steps to Configure
Go to Apps > Macro Configuration and click + Add new configuration.
Select the ShippingDeliveryNote macro and click Create Configuration.
This creates a new configuration where you can define the required parameter value.
In the Macro Configuration screen, add the configuration name and parameter value.
Configure the required parameter:
- AppendNote
Example value:
DELIVERY NOTE:
Note: Include any required spacing, punctuation, or separator in the AppendNote value. The macro adds the value directly before the existing note text.
Make sure to enable the macro to continue with the Rule Engine configuration.
Note: If the macro is not enabled, it will not appear in the Action value list when setting up the rule.
Go to Orders > Rules engine and click + Add new rule.
Enter the rule name and click Create.
Click Add new, select Condition, set the condition as required, and save it.
Use conditions that target orders where delivery or customer message notes should be highlighted.
Add the macro action and click Save.
In the Add action window, enter the Action name, for example:
ShippingDeliveryNote
-
Set Action type to:
Execute a macro -
In Action value, select:
ShippingDeliveryNote -
Click Save
Note: If the macro is not enabled, it will not appear in the Action value list when setting up the rule.
Review the saved rule setup and save the rule.
-
Verify the condition and action are connected correctly
-
Click Save in the bottom-right corner to save the rule
Customer message notes can be important for order handling, especially when customers provide delivery instructions, product requests, or fulfilment-related comments. This macro helps make those notes easier to identify by applying a consistent prefix.
Highlight Customer Messages
Adds configured text to the beginning of notes created by Customer_Message.
Reduce Missed Instructions
Helps teams quickly identify customer-provided information during order review.
Avoid Duplicate Prefixes
Checks whether the note already starts with the configured AppendNote value before updating it.
Process Selected Orders
Runs only against the order IDs provided by the Rule Engine.
Improve Dispatch Awareness
Makes customer messages more visible before picking, packing, or dispatch.
Simple Configuration
Requires only one configurable value: AppendNote.
How It Works
The macro checks each selected order, finds notes created by Customer_Message, and prepends the configured text when required.
Step 1
The macro starts execution and writes Macro Start to the log.
Step 2
It loops through each order ID provided in the OrderIds parameter.
Step 3
For each order, the macro retrieves the order details using the Linnworks Orders API.
Step 4
If the order exists, the macro writes the order number to the log.
Step 5
The macro retrieves order notes where CreatedBy equals Customer_Message.
Step 6
If matching notes are found, the macro checks each note to see whether it already starts with the configured AppendNote value.
Step 7
If a note does not already start with AppendNote, the macro prepends the configured value to the note text.
Step 8
The macro saves the updated note list back to the order.
Step 9
The macro logs any errors and writes Macro Finished when execution ends.
Usage of App
This macro is designed to update selected order notes automatically through the Rule Engine. It is useful when customer message notes need to be clearly marked for operational visibility.
OrderIds
Defines the Linnworks order IDs that should be processed. Only these selected orders are checked.
AppendNote
Defines the text that should be added to the beginning of matching customer message notes.
Customer_Message Notes
The macro only updates notes where CreatedBy equals Customer_Message.
Duplicate Prefix Check
The macro checks whether each note already starts with AppendNote before applying the prefix.
Execution Logging
The macro records start, order number, errors, and completion status using the macro logger.
Example Parameter Value
Use a value that clearly identifies the note as a delivery message.
DELIVERY NOTE:
Example result:
DELIVERY NOTE: Please leave the parcel with reception.
Important: The macro does not automatically add a space between AppendNote and the existing note. Add a trailing space in the parameter value if required.
Key Points to Remember
-
The macro processes only the order IDs provided in OrderIds
-
The macro is intended to run from the Rule Engine
-
The macro only updates notes created by Customer_Message
-
CreatedBy must match Customer_Message
-
The configured AppendNote value is added directly to the start of the note
-
The macro does not add spacing automatically
-
Notes already starting with AppendNote are not updated again
-
The macro logs the order number for each processed order
-
Orders without matching customer message notes are skipped
-
The macro saves the updated notes after processing matching notes
Important: Configure the AppendNote value carefully. If the text changes later, notes using the old prefix may be updated again because they no longer start with the new value.
What You Can Expect
-
Customer message notes are prefixed
Matching notes created by Customer_Message receive the configured prefix. -
Existing prefixed notes are skipped
If the note already starts with the configured AppendNote, it is not changed. -
Orders without matching notes are not changed
If no notes created by Customer_Message exist, the macro does not update the order. -
Execution is logged
The macro records when it starts, which order number is processed, errors, and when it finishes.
Overall Impact
This macro improves delivery note visibility by marking relevant customer message notes with a consistent prefix. It helps fulfilment, dispatch, and customer service teams identify customer-provided information more quickly during order processing.
What To Do After the Macro Runs
After the macro has completed, review the processed orders if needed to confirm that customer message notes were updated correctly.
Steps to Follow
Step 1
Open Linnworks and locate the orders processed by the rule.
Step 2
Open an affected order and review the order notes.
Step 3
Confirm that notes created by Customer_Message now start with the configured AppendNote value.
Step 4
Confirm that notes already starting with the configured value were not duplicated.
Step 5
Continue with normal order review, picking, packing, or dispatch processing.
Why This Matters
Highlighting delivery or customer message notes helps:
-
Reduce missed customer instructions
-
Improve order review visibility
-
Support fulfilment accuracy
-
Help dispatch teams identify special instructions
-
Keep customer message handling consistent
Best Practices
To get the most value from this macro, use a clear and consistent prefix.
Recommended Guidelines
-
Use a clear prefix
Choose a value such as DELIVERY NOTE:, SHIPPING NOTE:, or CUSTOMER DELIVERY MESSAGE: so the note is easy to identify. -
Include spacing if needed
Add a trailing space after the prefix if you want separation between the prefix and the original note. -
Keep the prefix consistent
Avoid changing AppendNote often, because the macro checks only whether the note starts with the current configured value. -
Use targeted rule conditions
Configure the Rule Engine so the macro runs only when customer message notes are expected. -
Review sample orders first
Test the macro on a small number of orders before using it across a wider workflow.
Troubleshooting
No note was updated
Confirm that the order has notes where CreatedBy equals Customer_Message.
Prefix was added without spacing
Add a trailing space to the AppendNote parameter value.
Prefix was added again after changing the value
This can happen if the note starts with an older prefix and no longer starts with the current AppendNote value.
Macro is not visible in the Rule Engine
Confirm that the macro configuration has been created and enabled in Apps > Macro Configuration.
Order was skipped
Confirm that the order exists and contains matching notes created by Customer_Message.
Summary
The Append Customer Message Note macro checks selected Linnworks orders for notes created by Customer_Message. When matching notes are found, it prepends the configured AppendNote value unless the note already starts with that value.
This helps make customer messages or delivery instructions easier to identify during order review, fulfilment, and dispatch.
Last updated 5 days ago
Built with Documentation.AI