> For the complete documentation index, see [llms.txt](https://docs.rishvi.co.uk/linnworks/llms.txt).
> Use it to discover all available pages before exploring further.

# IOSS Note

Automatically add marketplace IOSS or tax ID details from selected Linnworks orders into order notes, helping teams keep tax information visible during order processing and fulfilment.

Marketplace IOSS and tax identification details are often required during international order processing, customs handling, and fulfilment checks. When this information is stored only in order extended properties, teams may need to open each order manually to confirm whether the required tax information is available.

The *IOSS Note* macro helps make this information easier to access by checking selected Linnworks orders for marketplace IOSS or tax ID extended properties and adding those values into the order notes.

This macro looks for the following order extended properties:

- **MARKETPLACE\_IOSS**

- **MARKETPLACE\_TAXID**

When either value is found, the macro creates an order note containing the available tax information. This helps fulfilment, customer service, and operations teams quickly view the required marketplace tax details directly from the order notes.

> Keep marketplace IOSS and tax ID information visible by automatically copying it from order extended properties into 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 allows it to be selected in the Rule Engine.

This setup can be adjusted anytime based on your operational requirements.

### **Steps to Configure**

<Tabs>
  <Tab title="Step 1">
    **Go to Apps > Macro Configuration and click + Add new configuration.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779254427126-xnza8d4jt7f-pasted-image-1779254422343.png?fm=auto&auto=compress%2Cformat" width="1368" height="568" alt="" priority={true} fetchPriority="high" />

  </Tab>

  <Tab title="Step 2">
    **Select the IOSSNote macro and click Create Configuration.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255349979-3xuzhiu50oa-pasted-image-1779255343849.png?fm=auto&auto=compress%2Cformat" width="1210" height="554" alt="" style="width: 1210px; height: auto; cursor: pointer;" priority={true} fetchPriority="high" />

    This creates a new configuration where the macro can be enabled and used by the Rule Engine.
  </Tab>

  <Tab title="Step 3">
    **In the Macro Configuration screen, add the configuration name.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255396428-pbpqa125bgh-pasted-image-1779255391035.png?fm=auto&auto=compress%2Cformat" width="814" height="634" alt="" />

    This macro uses the selected order IDs provided by the Rule Engine. No additional custom parameter values are required.
  </Tab>

  <Tab title="Step 4">
    **Make sure to enable the macro to continue with the Rule Engine configuration.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255416638-n30iuoh78ib-pasted-image-1779255411112.png?fm=auto&auto=compress%2Cformat" width="1476" height="30" alt="" />

    <Callout kind="warning" collapsed="false">
      **Note:** If the macro is not enabled, it will not appear in the **Action** value list when setting up the rule.
    </Callout>
  </Tab>

  <Tab title="Step 5">
    **Go to Orders > Rules engine and click + Add new rule.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255464957-si7u81jpj-pasted-image-1779255459336.png?fm=auto&auto=compress%2Cformat" width="1536" height="680" alt="" />

  </Tab>

  <Tab title="Step 6">
    **Enter the rule name and click Create.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255486217-c4vo4pux2bq-pasted-image-1779255481662.png?fm=auto&auto=compress%2Cformat" width="362" height="218" alt="" style="width: 362px; height: auto; cursor: pointer; margin: 0 auto;" />

  
  </Tab>

  <Tab title="Step 7">
    **Click Add new, select Condition, set the condition as required, and save it.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255549614-n5fdqtc3fcl-pasted-image-1779255545314.png?fm=auto&auto=compress%2Cformat" width="1536" height="358" alt="" style="width: 1536px; height: auto; cursor: pointer;" />

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255563116-gmjdmjbvza-pasted-image-1779255557496.png?fm=auto&auto=compress%2Cformat" width="722" height="410" alt="" />

    Choose the condition that identifies the orders where IOSS or marketplace tax information should be added to the order notes.
  </Tab>

  <Tab title="Step 8">
  **Add the macro action and click Save.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255637877-c9qq4ele2wg-pasted-image-1779255632540.png?fm=auto&auto=compress%2Cformat" width="747" height="157" alt="" />

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255655533-ij4xhs1lbdp-pasted-image-1779255650074.png?fm=auto&auto=compress%2Cformat" width="739" height="303" alt="" />

    In the **Add action** window, enter the **Action name**, for example:

    `IOSSNote`

    - Set **Action type** to:

      `Execute a macro`

    - In **Action value**, select:

      `IOSSNote`

    - Click **Save**

    <Callout kind="warning" collapsed="false">
      **Note:** If the macro is not enabled, it will not appear in the **Action** value list when setting up the rule.
    </Callout>
  </Tab>

  <Tab title="Step 9">
    **Review the saved rule setup.**

    <Image src="https://blob-cdn.documentation.ai/org-87fb0951-1e07-4f5d-a887-8a7327c7777d/doc-98941d2e-0032-424f-8414-3034ac5fa6ee/1779255748421-inr2f9gizxc-pasted-image-1779255741706.png?fm=auto&auto=compress%2Cformat" width="1524" height="701" alt="" />

    - Verify the condition and action are connected correctly

    - Click **Save** in the bottom-right corner to save the rule
  </Tab>
</Tabs>

Marketplace IOSS and tax ID details can be important for order handling, especially when marketplace tax information needs to be visible during fulfilment. This macro helps reduce manual checks by copying the relevant extended property values into the order notes.

<Columns cols="2">
  <Card title="Reduce Manual Order Checks" icon="alarm-check" horizontal="false" target="_self">
    Eliminates the need to manually open each selected order and check extended properties for marketplace IOSS or tax ID values.
  </Card>

  <Card title="Improve Tax Information Visibility" icon="boxes" horizontal="false" target="_self">
    Adds marketplace tax details into the order notes so they are easier to view during order processing.
  </Card>

  <Card title="Support Fulfilment Review" icon="bell" horizontal="false" target="_self">
    Helps warehouse, dispatch, and operations teams quickly identify relevant marketplace tax information.
  </Card>

  <Card title="Use Existing Order Data" icon="bar-chart-big-icon" horizontal="false" target="_self">
    Uses the order extended properties already stored against the order in Linnworks.
  </Card>

  <Card title="Save Operational Time" icon="lucide-fast-forward" horizontal="false" target="_self">
    Allows teams to apply notes automatically instead of copying IOSS or tax ID values manually.
  </Card>

  <Card title="Update Only When Tax Data Exists" icon="lucide-message-circle-x" horizontal="false" target="_self">
    The macro creates a note only when the selected order contains a matching marketplace IOSS or tax ID extended property.
  </Card>
</Columns>

### How It Works

The macro checks each selected order and creates an order note only when marketplace IOSS or marketplace tax ID information is found.

<Steps>
  <Step title="Step 1" icon="airplay-icon" title-type="p">
    The macro starts execution and writes **Macro Start** to the log.
  </Step>

  <Step title="Step 2" icon="airplay-icon" title-type="p">
    It loops through each order ID provided in the **OrderIds** parameter.
  </Step>

  <Step title="Step 3" icon="airplay-icon" title-type="p">
    For each order, the macro retrieves the order details using the Linnworks Orders API.
  </Step>

  <Step title="Step 4" icon="airplay-icon" title-type="p">
    It checks the order extended properties for names matching **MARKETPLACE\_IOSS** or **MARKETPLACE\_TAXID**.
  </Step>

  <Step title="Step 5" icon="airplay-icon" title-type="p">
    If one or more matching extended properties are found, the macro creates a note starting with **MARKETPLACE\_IOSS :**.
  </Step>

  <Step title="Step 6" icon="airplay-icon" title-type="p">
    The macro appends the matching extended property values to the note.
  </Step>

  <Step title="Step 7" icon="airplay-icon" title-type="p">
    The macro saves the note against the order with **Internal** set to **false** and **CreatedBy** set to **IOSS Note Macro**.
  </Step>

  <Step title="Step 8" icon="airplay-icon" title-type="p">
    The macro logs any errors and writes **Macro Finished** when execution ends.
  </Step>
</Steps>

### **Usage of App**

This macro is designed to run against selected orders through the Rule Engine. It is useful when orders need marketplace IOSS or tax ID values copied from extended properties into order notes.

<Card title="OrderIds" horizontal="false" target="_self">
  Defines the Linnworks order IDs that should be processed. Only these selected orders are checked for marketplace IOSS or tax ID extended properties.
</Card>

<Card title="MARKETPLACE_IOSS" horizontal="false" target="_self">
  The macro checks for this extended property name and adds its value to the order note when found.
</Card>

<Card title="MARKETPLACE_TAXID" horizontal="false" target="_self">
  The macro also checks for this extended property name and adds its value to the order note when found.
</Card>

<Card title="Order Note Creation" horizontal="false" target="_self">
  When matching extended properties are found, the macro creates an order note containing the available marketplace tax values.
</Card>

<Card title="Execution Logging" horizontal="false" target="_self">
  The macro records the start, errors, and completion of the process using the macro logger.
</Card>

### **Key Points to Remember**

- The macro processes only the order IDs provided in **OrderIds**

- The macro checks order extended properties for **MARKETPLACE\_IOSS** and **MARKETPLACE\_TAXID**

- A note is created only when at least one matching extended property is found

- The note starts with **MARKETPLACE\_IOSS :**

- Matching extended property values are added to the note text

- The note is created with **Internal** set to **false**

- The note creator is set as **IOSS Note Macro**

- The macro does not add a note when no matching extended property exists

- The macro does not include duplicate-note checking logic

Once the macro is running, it helps make marketplace tax information easier to see directly from order notes.

### **What You Can Expect**

- **Marketplace IOSS values are added to order notes**\
  Orders with a **MARKETPLACE\_IOSS** extended property receive a note containing the value

- **Marketplace tax ID values are added to order notes**\
  Orders with a **MARKETPLACE\_TAXID** extended property also have the value added to the note

- **Orders without matching properties are skipped**\
  If no matching extended property exists, the macro does not create a note for that order

- **Notes are visible as non-internal notes**\
  The macro creates the note with **Internal** set to **false**

- **Execution is logged**\
  The macro records when it starts, finishes, and if an error occurs

### **Overall Impact**

This macro improves visibility of marketplace tax information, reduces manual checking of extended properties, and helps teams access IOSS or marketplace tax ID values directly from the order notes.

### What To Do After the Macro Runs

After the macro has completed, review the selected orders if needed to confirm that the IOSS or marketplace tax ID information has been added to the order notes.

### **Steps to Follow**

<Steps>
  <Step title="Step 1" title-type="p">
    Open Linnworks and locate the orders processed by the rule.
  </Step>

  <Step title="Step 2" title-type="p">
    Open an affected order and review the order notes.
  </Step>

  <Step title="Step 3" title-type="p">
    Confirm that the note starts with **MARKETPLACE\_IOSS :**.
  </Step>

  <Step title="Step 4" title-type="p">
    Confirm that the expected IOSS or marketplace tax ID value has been added to the note.
  </Step>

  <Step title="Step 5" title-type="p">
    Continue with normal order processing, fulfilment, customs review, or dispatch handling.
  </Step>
</Steps>

### **Why This Matters**

Keeping marketplace tax details visible helps:

- Reduce manual extended property checks

- Improve order review accuracy

- Make IOSS and tax ID values easier to find

- Support fulfilment and dispatch workflows

- Help teams process relevant marketplace orders more efficiently

### Best Practices

To get the most value from this macro, use it with rule conditions that target orders where marketplace tax data is expected.

### **Recommended Guidelines**

- **Use clear rule conditions**\
  Configure the Rule Engine so the macro runs only for orders where IOSS or marketplace tax ID data is relevant.

- **Review sample orders after setup**\
  Confirm that the note is created correctly before using the macro across a larger order set.

- **Avoid repeated rule execution where possible**\
  The macro code does not include duplicate-note checking, so repeated execution may create repeated notes depending on how the order is processed.

- **Check extended property names carefully**\
  The macro only checks for **MARKETPLACE\_IOSS** and **MARKETPLACE\_TAXID**.

- **Use before fulfilment review**\
  Run the macro before dispatch or customs-related order checks so the tax information is visible in the notes.

### **Troubleshooting**

<Card title="No note was created" horizontal="false" target="_self">
  Confirm that the order has an extended property named **MARKETPLACE\_IOSS** or **MARKETPLACE\_TAXID**.
</Card>

<Card title="Macro is not visible in the Rule Engine" horizontal="false" target="_self">
  Confirm that the macro configuration has been created and enabled in **Apps > Macro Configuration**.
</Card>

<Card title="Tax value is missing from the note" horizontal="false" target="_self">
  Check whether the extended property exists and contains a value on the order.
</Card>

<Card title="Duplicate notes appear" horizontal="false" target="_self">
  Review the rule setup to ensure the macro is not being triggered repeatedly for the same order.
</Card>

<Card title="Rule did not run" horizontal="false" target="_self">
  Confirm that the rule condition matches the order and that the rule has been saved and enabled.
</Card>

### **Summary**

The *IOSS Note* macro checks selected Linnworks orders for marketplace IOSS and marketplace tax ID extended properties. When matching values are found, it creates an order note containing those values so the information is easier to access during order processing.

This helps teams reduce manual checks, improve tax information visibility, and support smoother fulfilment workflows.
