> For the complete documentation index, see [llms.txt](https://rishvi.gitbook.io/rishviappdocuments/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rishvi.gitbook.io/rishviappdocuments/ioss-note.md).

# IOSS Note

<figure><img src="/files/mBx58S9KLJTDN5z4Ko0h" alt=""><figcaption></figcaption></figure>

The IOSS Note macro is designed to streamline the process of adding notes to open orders based on the presence of specific extended properties related to IOSS (Import One Stop Shop). It checks whether an open order has an extended property associated with IOSS or containing a number. If the condition is met, the macro concatenates a note and saves it as a note for that order.

This guide provides a step-by-step explanation of how to install and set up the macro in Linnworks.

### Start using the macro

There are three steps you need to complete to start using the macro:

1. Install the application.
   * Go to *Apps > Application Store > IOSS Note >* click Install and follow the on-screen instructions until the installation is complete.
2. Configure the macro.
3. Configure the rule in the *Rules Engine* screen.

#### Configure the macro

Once the IOSS Note  app is installed:

1. &#x20;Go to *Apps > Macro Configuration* and click  <mark style="color:purple;">+ Add new configuration.</mark>

<figure><img src="/files/Y6KbMoalQqywbzc7oUYy" alt=""><figcaption></figcaption></figure>

2. Select the IOSS Note  macro and click  <mark style="color:purple;">Create Configuration.</mark> <mark style="color:purple;">.</mark>

<figure><img src="/files/mVcPJFr6mFaVaZTPWgln" alt=""><figcaption></figcaption></figure>

3. In the *Macro Configuration* screen, specify the below details and click *Save*:

<figure><img src="/files/YiATm5uEZMRvLmsh1keR" alt=""><figcaption></figcaption></figure>

4. Make sure to enable the macro to continue with the *Rules Engine* configuration.

<figure><img src="/files/KxBBXEwknPxQS5CHUEK9" alt=""><figcaption></figcaption></figure>

**Functionality:**

1. **Parameter Input**:
   * `OrderIds`: List of OrderIds for which the IOSS note needs to be checked and potentially added.
2. **Rules Engine Integration**:
   * The macro operates within a rules engine environment, enabling scheduled checks or event-triggered actions based on specified criteria.
3. **Note Concatenation**:
   * It scans each order in the provided list to check for the presence of an order extended property related to IOSS or containing a number.
   * If such a property is found, the macro generates a note containing relevant information.
4. **Note Saving**:
   * After creating the note, the macro saves it as a note for the corresponding order.
5. **Logging and Error Handling**:
   * The macro includes logging mechanisms to track its actions and handle any errors encountered during the process.

**Usage:**

* **Parameters:**
  * `OrderIds`: List of OrderIds for which the presence of IOSS-related extended properties needs to be checked.
* **Execution:**
  * The macro is executed within a rules engine environment, either scheduled to run at specific intervals or triggered by predefined events.
  * It takes the list of OrderIds as input and processes each order sequentially.
  * For each order, it checks for the presence of IOSS-related extended properties and generates a note accordingly.
  * The note is then saved for the corresponding order.
* **Outcome:**
  * Orders with relevant IOSS-related extended properties have notes appended to them, providing additional context or information for further processing.
  * The macro enhances the efficiency of order management processes by automatically adding notes based on specific criteria, reducing manual effort and potential oversights.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rishvi.gitbook.io/rishviappdocuments/ioss-note.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.