# Plugin Features

#### <span style="color: rgb(0, 51, 102);">**Overview**</span>

This document details what you can accomplish after installing a plugin in your store. Please note that not all features are available for every plugin. You will learn about configuring plugin rules and understanding and processing orders.

#### <span style="color: rgb(0, 51, 102);">**Adding a Plugin Rule**</span>

1. <span data-preserver-spaces="true">Navigate to the store where you installed your plugin, locate the plugin, and click the edit button on the right-hand side.</span>
2. In the details section, scroll down the page and locate the "Add Rule" button within the "Rules" section.
3. Fill in the required details and select the "Save" button. Then, activate your rule by ticking the "Is Active" button at the top of the page. Some popular plugin rule examples are below.

[![](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_KB_ShipBob02.webp?t=1709912281)](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_KB_ShipBob02.webp?t=1709912281)

##### <span style="color: rgb(0, 51, 102);">**Excluding Single Item Orders by Order Item SKUs**</span>

<span data-preserver-spaces="true">To omit orders with single items based on order item SKUs, adhere to the steps below and designate the fields as directed below.</span>

<span data-preserver-spaces="true">The instructions describe fields lacking specific input requirements, whereas fields that involve selection from dropdown lists present their options directly without additional explanation.</span>

- **<span data-preserver-spaces="true">Rule Name: </span>**<span data-preserver-spaces="true">Provide a description outlining the purpose of this rule.</span>
- **<span data-preserver-spaces="true">Condition:</span>**<span data-preserver-spaces="true"> Line Item SKU</span>
- **<span data-preserver-spaces="true">Operator:</span>**<span data-preserver-spaces="true"> Exists</span>
- **<span data-preserver-spaces="true">Condition Value:</span>**<span data-preserver-spaces="true"> Input the items' SKUs. Include the Kit, Bundle, and Group Item SKUs if you want to exclude them. If multiple SKUs are entered, separate them with commas.</span>
- **<span data-preserver-spaces="true">Action:</span>**<span data-preserver-spaces="true"> Update Order Sync Status</span>
- **<span data-preserver-spaces="true">Action Value:</span>**<span data-preserver-spaces="true"> Excluded</span>

[![image-1709909509194.png](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/scaled-1680-/8l6iJ5CTwb3aoqVC-image-1709909509194.png)](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/8l6iJ5CTwb3aoqVC-image-1709909509194.png)

##### <span style="color: rgb(0, 51, 102);">**Excluding Orders by Total Item Quantities**</span>

<span data-preserver-spaces="true">To exclude orders based on total order item quantities, adhere to the instructions below and configure the fields as directed below.</span>

<span data-preserver-spaces="true">The instructions describe fields lacking specific input requirements, whereas fields that involve selection from dropdown lists present their options directly without additional explanation.</span>

- **<span data-preserver-spaces="true">Rule Name:</span>**<span data-preserver-spaces="true"> Specify a description clarifying the purpose of this rule.</span>
- **<span data-preserver-spaces="true">Condition:</span>**<span data-preserver-spaces="true"> Total Order Item Quantity</span>
- **<span data-preserver-spaces="true">Operator:</span>**<span data-preserver-spaces="true"> Choose the desired operator. For instance, if you intend to exclude orders with a total quantity surpassing 10, select the "Greater than" operator.</span>
- **<span data-preserver-spaces="true">Condition Value:</span>**<span data-preserver-spaces="true"> Enter the total quantity for excluding orders. In the provided example, input 10.</span>
- **<span data-preserver-spaces="true">Action:</span>**<span data-preserver-spaces="true"> Update Order Sync Status</span>
- **<span data-preserver-spaces="true">Action Value:</span>**<span data-preserver-spaces="true"> Excluded</span>

[![image-1709910106504.png](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/scaled-1680-/4MMEydoYJRum8z25-image-1709910106504.png)](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/4MMEydoYJRum8z25-image-1709910106504.png)

##### <span style="color: rgb(0, 51, 102);">**Tagging Orders by Order Item SKU**</span>

<span data-preserver-spaces="true">To tag orders based on order item SKUs, follow the instructions below and configure the fields as specified below.</span>

<span data-preserver-spaces="true">The instructions describe fields lacking specific input requirements, whereas fields that involve selection from dropdown lists present their options directly without additional explanation.</span>

- **<span data-preserver-spaces="true">Rule Name: </span>**<span data-preserver-spaces="true">Provide a description outlining the purpose of this rule.</span>
- **<span data-preserver-spaces="true">Condition:</span>**<span data-preserver-spaces="true"> Line Item SKU</span>
- **<span data-preserver-spaces="true">Operator:</span>**<span data-preserver-spaces="true"> Exists</span>
- **<span data-preserver-spaces="true">Condition Value:</span>**<span data-preserver-spaces="true"> Enter the Kit, Bundle, and Group Item names to include them. Separate the SKUs with commas if you intend to add more than one.</span>
- **<span data-preserver-spaces="true">Action:</span>**<span data-preserver-spaces="true"> Add Tag</span>
- **<span data-preserver-spaces="true">Action Value:</span>**<span data-preserver-spaces="true"> Enter the keyword to be used as a tag for your orders in this field.</span>

<p class="callout info"><span data-preserver-spaces="true">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.</span></p>

[![image-1709910719891.png](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/scaled-1680-/zPv45BgBq4hvdwFg-image-1709910719891.png)](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/zPv45BgBq4hvdwFg-image-1709910719891.png)

##### <span style="color: rgb(0, 51, 102);">**Tagging All Orders Received from a Channel**</span>

To tag all orders received from a channel, follow the instructions below and configure the fields accordingly.

<span data-preserver-spaces="true">The instructions describe fields lacking specific input requirements, whereas fields that involve selection from dropdown lists present their options directly without additional explanation.</span>

- **<span data-preserver-spaces="true">Rule Name:</span>**<span data-preserver-spaces="true"> Provide a description explaining the purpose of this rule.</span>
- **<span data-preserver-spaces="true">Condition:</span>**<span data-preserver-spaces="true"> Channel Name</span>
- **<span data-preserver-spaces="true">Operator:</span>**<span data-preserver-spaces="true"> Equals</span>
- **<span data-preserver-spaces="true">Condition Value:</span>**<span data-preserver-spaces="true"> Select the channel from the dropdown list.</span>
- **<span data-preserver-spaces="true">Action:</span>**<span data-preserver-spaces="true"> Add Tag</span>
- **<span data-preserver-spaces="true">Action Value: </span>**<span data-preserver-spaces="true">Enter the keyword you want to use as a tag for your orders in this field.</span>

[![image-1709911550437.png](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/scaled-1680-/jJdChTwqxxTFvvux-image-1709911550437.png)](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/jJdChTwqxxTFvvux-image-1709911550437.png)

#### <span style="color: rgb(0, 51, 102);">**Understanding Order States**</span>

##### <span style="color: rgb(0, 51, 102);">**Plugin Sync Status**</span>

- **<span data-preserver-spaces="true">In Progress:</span>**<span data-preserver-spaces="true"> Currently implementing plugin order rules.</span>
- **<span data-preserver-spaces="true">Pending:</span>**<span data-preserver-spaces="true"> The order is in the queue for plugin transmission; stock control is applied to order items.</span>
- **<span data-preserver-spaces="true">Excluded:</span>**<span data-preserver-spaces="true"> The order hasn't been sent to the plugin, either due to plugin rules or insufficient stock.</span>
- **<span data-preserver-spaces="true">Failed:</span>**<span data-preserver-spaces="true"> An error occurred while attempting to send the order to the plugin.</span>
- **<span data-preserver-spaces="true">Synced:</span>**<span data-preserver-spaces="true"> The order has been successfully transmitted to the plugin.</span>

##### <span style="color: rgb(0, 51, 102);">**Order Sync Status**</span>

- **<span data-preserver-spaces="true">In Progress:</span>**<span data-preserver-spaces="true"> Ongoing application of plugin order rules.</span>
- **<span data-preserver-spaces="true">Pending:</span>**<span data-preserver-spaces="true"> The order is queued for plugin transmission; stock control is applied to order items.</span>
- **<span data-preserver-spaces="true">Excluded:</span>**<span data-preserver-spaces="true"> The order is not sent to the plugin due to plugin rules or insufficient stock.</span>
- **<span data-preserver-spaces="true">Failed:</span>**<span data-preserver-spaces="true"> An error was encountered while attempting to send the order to the plugin.</span>
- **<span data-preserver-spaces="true">Synced:</span>**<span data-preserver-spaces="true"> The order has been successfully transmitted to the plugin.</span>
- **<span data-preserver-spaces="true">Updated:</span>**<span data-preserver-spaces="true"> The order update was received from the channel and successfully applied.</span>

#### <span style="color: rgb(0, 51, 102);">**Resending Excluded Orders**</span>

Follow the below steps to resend the excluded orders:

1. Navigate to the "Orders" option on the left side of the screen.
2. Choose your store with the plugin from the "Store" dropdown menu.
3. Click the "Sync Status" button to view excluded orders specifically.
4. Opt for "Excluded" and press "Add" to filter and present only the excluded orders.
5. Within the "Actions" section, utilise the "Resend" button to resend the excluded order.
6. Alternatively, select the pen icon to reveal order details, and then use the "Resend Order" button within the details for the same purpose.

[![](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_KB_ShipBob03.webp)](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_KB_ShipBob03.webp)

#### <span style="color: rgb(0, 51, 102);">**Checking the Product Stock Quantities**</span>

<span data-preserver-spaces="true">For a comprehensive view of product stock quantities, proceed as follows:</span>

1. <span data-preserver-spaces="true">Access the "Products" page by selecting "Products" from the left-side menu.</span>
2. <span data-preserver-spaces="true">Choose the specific store for which you wish to review product quantities.</span>
3. <span data-preserver-spaces="true">Observe the product quantities from the plugin under "Plugin Quantities," noting the synchronisation time under "Plugin Quantity Synced At." The "Quantity" field represents the sum of quantities received from the plugin and the Despatch Cloud WMS system.</span>

**[![image-1710159510625.png](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/scaled-1680-/EdZtlyB9y9fEUs6O-image-1710159510625.png)](https://documentation.despatchcloud.com/uploads/images/gallery/2024-03/EdZtlyB9y9fEUs6O-image-1710159510625.png)**

#### <span style="color: rgb(0, 51, 102);">**Sending Excluded Orders to Another System Using Webhooks**</span>

<span data-preserver-spaces="true">Ensure a webhook is created exclusively for the "order.excluded" event to direct excluded orders to your intended system. Other webhooks may send order data to the plugin and the alternate system.</span>

1. <span data-preserver-spaces="true">Navigate to the "Store" button on the left-hand screen, followed by clicking the "Edit Details" button under the "Actions" section.</span>
2. <span data-preserver-spaces="true">Proceed to the "Webhooks" tab, then click the "+ Add" button to initiate a new webhook.</span>
3. <span data-preserver-spaces="true">Fill in the details:</span>
    - **<span data-preserver-spaces="true">Event:</span>**<span data-preserver-spaces="true"> Choose "orders.excluded" from the dropdown list.</span>
    - **<span data-preserver-spaces="true">Method:</span>**<span data-preserver-spaces="true"> Select the appropriate method for the receiving API/System: \[GET, POST, PUT, DELETE, PATCH\].</span>
    - **<span data-preserver-spaces="true">Interval (minutes):</span>**<span data-preserver-spaces="true"> Define the frequency of webhook triggers.</span>
    - **<span data-preserver-spaces="true">Number of Items To Be Sent:</span>**<span data-preserver-spaces="true"> Specify the quantity of items to be transmitted.</span>
    - **<span data-preserver-spaces="true">URL:</span>**<span data-preserver-spaces="true"> Enter the destination URL.</span>
    - **<span data-preserver-spaces="true">Order Statuses:</span>**<span data-preserver-spaces="true"> For transfer, select the desired order status: \[Unpaid, Unshipped, Partially Shipped, Shipped, Cancelled, Refunded, Unfulfillable\].</span>
    - **<span data-preserver-spaces="true">Include Country Codes:</span>**<span data-preserver-spaces="true"> Only receive orders for specified country codes.</span>
    - **<span data-preserver-spaces="true">Exclude Country Codes:</span>**<span data-preserver-spaces="true"> Omit orders for designated country codes.</span>
    - **<span data-preserver-spaces="true">Include SKUs:</span>**<span data-preserver-spaces="true"> Receive orders with specified SKUs.</span>
    - **<span data-preserver-spaces="true">Exclude SKUs:</span>**<span data-preserver-spaces="true"> Exclude orders with defined SKUs.</span>
    - **<span data-preserver-spaces="true">Requires Authorization:</span>**<span data-preserver-spaces="true"> Toggle on to input an authorisation header and key.</span>
    - **<span data-preserver-spaces="true">Enable Webhook:</span>**<span data-preserver-spaces="true"> Activate the webhook immediately upon creation.</span>
    - **<span data-preserver-spaces="true">+ Add New Header:</span>**<span data-preserver-spaces="true"> Allows adding a custom header key and value.</span>

<span data-preserver-spaces="true">Upon specifying all details, save and create the webhook using the "Save" button.</span>

[![](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_KB_ShipBob04.webp)](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_KB_ShipBob04.webp)