Creating a Plugin Rule in Neuro

To create a plugin rule, follow these steps:

1. Navigate to the store where the plugin is installed.

2. Locate the plugin and click the Edit button on the right-hand side.

3. Scroll down to the Rules section and click Add Rule.

4. Enter the required details and click Save.

5. Activate the rule by ticking the Is Active checkbox.

Example Plugin Rules

Excluding Single Item Orders by SKU

To exclude orders with a single item based on SKUs:

• Rule Name: Provide a descriptive name.

• Condition: Line Item SKU

• Operator: Exists

• Condition Value: List SKUs, including Kit, Bundle, and Group SKUs, separated by commas.

• Action: Update Order Sync Status

• Action Value: Excluded

Excluding Orders by Total Item Quantities

To exclude orders based on total item quantity:

• Rule Name: Provide a clear description of the rule’s purpose.

• Condition: Total Order Item Quantity

• Operator: Choose an operator (e.g., "Greater than" to exclude orders exceeding a specific quantity).

• Condition Value: Input the total quantity threshold (e.g., 10 to exclude orders with more than 10 items).

• Action: Update Order Sync Status

• Action Value: Excluded

Tagging Orders by Order Item SKU

• Rule Name: Provide a description outlining the purpose of this rule.

• Condition: Line Item SKU

• Operator: Exists

• Condition Value: Enter the Kit, Bundle, and Group Item names to include them. Separate the SKUs with commas if you intend to add more than one.

• Action: Add Tag

• Action Value: Enter the keyword to be used as a tag for your orders in this field.

Multiple tags can be added to an order. If a Product SKU is part of more than one order tagging rule, those tags will be applied to all orders containing that product.

Tagging Orders by SKU

To tag orders based on SKU:

• Rule Name: Describe the rule’s function.

• Condition: Line Item SKU

• Operator: Exists

• Condition Value: List Kit, Bundle, and Group SKUs (comma-separated for multiple entries).

• Action: Add Tag

• Action Value: Enter the keyword to be used as a tag.

Note: Multiple tags can be applied to an order. If a product SKU matches multiple tagging rules, all relevant tags will be assigned.

Tagging Orders by Channel

To tag all orders received from a specific channel:

• Rule Name: Define the rule’s objective.

• Condition: Channel Name

• Operator: Equals

• Condition Value: Select the channel from the dropdown.

• Action: Add Tag

• Action Value: Specify the tag keyword.

Understanding Order States

Plugin Sync Status

• In Progress: Plugin rules are currently being applied.

• Pending: The order is queued for plugin transmission; stock control applies.

• Excluded: The order was not sent due to plugin rules or insufficient stock.

• Failed: An error occurred during transmission.

• Synced: The order was successfully transmitted to the plugin.

Order Sync Status

• In Progress: The plugin is applying order rules.

• Pending: The order awaits plugin transmission; stock control applies.

• Excluded: The order was not sent due to rules or insufficient stock.

• Failed: Transmission error encountered.

• Synced: The order was successfully transmitted.

• Updated: The order update was received and applied.

Resending Excluded Orders

To resend excluded orders:

1. Navigate to Orders from the left-side menu.

2. Select your store from the Store dropdown.

3. Click Sync Status to filter excluded orders.

4. Choose Excluded, then click Add to apply the filter.

5. In the Actions section, click Resend to resend the order.

6. Alternatively, open order details using the pen icon and click Resend Order

Checking Product Stock Quantities

To review product stock levels:

1. Navigate to Products from the left-side menu.

2. Select the store for which you wish to check stock.

3. View stock levels under Quantities/API Quantity.

4. Check the last synchronisation timestamp under Plugin Products > Updated At.

5. The Quantity field reflects the total from the plugin. Check the Product Stock Quantities

Sending Excluded Orders via Webhooks

To direct excluded orders to another system via webhooks:

1. Navigate to Store and click Edit Details under Actions.

2. Open the Webhooks tab and click + Add.

3. Fill in the webhook details:

   • Event: Select "orders.excluded".

   • Method: Choose an API method (GET, POST, PUT, DELETE, PATCH).

   • Interval (minutes): Set the frequency for webhook execution.

   • Number of Items To Be Sent: Define the batch size.

   • URL: Enter the destination URL.

   • Order Statuses: Choose statuses to send (e.g., Unpaid, Shipped, Refunded).

   • Include/Exclude Country Codes: Specify countries to include or exclude.

   • Include/Exclude SKUs: Define SKUs to include or omit.

   • Requires Authorisation: Enable and enter the auth header and key if required.

   • Enable Webhook: Activate the webhook upon creation.

   • + Add New Header: Add custom header key-value pairs if needed.

4. Click Save to finalise the webhook setup.

Next Steps & Support

Need help? Explore more of our documentation, or contact support.