Mark Note As External
Convert internal order notes into external notes for specific orders by updating note visibility using predefined filters.
Overview
The RIS-SM-1022 – MarkNoteAsExternal macro updates order notes by converting internal (hidden) notes into external (visible) notes.
It operates on filtered orders and ensures that important notes become accessible to external systems or users.
Use this macro carefully, as it converts all internal notes to external without selective filtering.
Purpose
This macro:
- Retrieves order notes
- Identifies internal notes
- Converts them into external notes
- Updates note visibility automatically
👉 In short:
Make internal notes visible externally.
When It Runs
Used for note visibility correction
Typically runs:
- Manually triggered
- During order correction workflows
- When external visibility of notes is required
Parameters
No input parameters required
Note:
The macro uses predefined filters:
- Source = BIGCOMMERCE
- Specific Location ID (hardcoded in code)
How It Works
Fetch Open Orders
Retrieve open orders from a specific location.
Filter Orders
Select orders where:
- Source = BIGCOMMERCE
Retrieve Notes
Fetch all notes associated with the selected order.
Identify Internal Notes
Check for notes where Internal = true.
Convert to External
Update notes by setting:
- Internal = false
Save Updates
Save updated notes back to the order using the API.
Log Execution
Track execution progress and updates.
Final Result
- Internal notes converted to external notes
- Notes become visible to external systems/users
- Targeted orders updated successfully
Usefulness
This macro is highly beneficial for:
- Fixing incorrectly marked internal notes
- Improving communication transparency
- Making notes visible to customers or sales channels
- Supporting manual data correction workflows
- Enhancing operational visibility
Important Notes
- Works only for filtered orders (Source & Location based)
- Converts all internal notes (no selective filtering)
- No validation of note content
- Overwrites existing note visibility
- Uses hardcoded filters (not dynamic)
Example Scenario
Key Insight
Converting internal notes to external improves visibility and communication but should be used carefully to avoid exposing sensitive information.
Last updated today
Built with Documentation.AI