# ShipMonk ### **1. Overview** The **ShipMonk 3PL Integration** in XoroERP enables seamless communication between XoroERP and **ShipMonk’s third-party logistics (3PL)** system.\ This integration ensures **real-time synchronization of products, orders, shipments, and inventory** between both platforms — from order creation in XoroERP to final fulfillment and shipping confirmation by ShipMonk. Through this integration: * Orders are automatically exported from XoroERP to ShipMonk for fulfillment. * ShipMonk sends back shipment updates and Advance Shipping Notices (ASNs) to XoroERP. * Manual data entry is reduced, redundancy is eliminated, and warehouse data flow becomes fully automated and reliable. *** ### **2. Installation** #### **Step 1: Connect to XoroERP Instance** 1. Log in to your **XoroERP** account. 2. Navigate to the **Apps** module from the main dashboard. 3. Click the **3PL Connections** tab. 4. Select **Add 3PL Connection**. 5. Choose **ShipMonk** from the list of available 3PL integrations. #### **Step 2: Install the Integration App** * Click **Install** to add the ShipMonk 3PL integration to your XoroERP instance. * Once installed, the integration will be listed under your active integrations. #### **Step 3: Log In Using Credentials**
After installation, configure the credentials provided by ShipMonk: * **Account Name** * **API Endpoint** * **App Access Token** * **Facility ID** ⚙️ Ensure all credentials are valid and authorized for 3PL data access to enable import/export synchronization. *** ### **3. Workflow** The ShipMonk 3PL integration automates the entire order fulfillment cycle: #### **Step 1: Wave Creation** * Orders are grouped into waves in XoroERP based on allocation rules. * Each wave represents a batch of orders ready for fulfillment. #### **Step 2: Automatic Export to ShipMonk** * Once a wave is ready, orders are automatically exported to ShipMonk for fulfillment. * ShipMonk handles picking, packing, and shipping at its warehouse. #### **Step 3: Shipment Fulfillment** * Orders are fulfilled by ShipMonk. * Shipment details and tracking numbers are sent back to XoroERP automatically. #### **Step 4: Ship Confirmation** * ShipMonk confirms the shipment, updating XoroERP with tracking and completion details. * Orders and waves in XoroERP are updated and closed. #### **Step 5: Invoice Creation** * Post-shipment, invoices are automatically generated in XoroERP. 💡 This workflow ensures **real-time data exchange**, **zero manual reconciliation**, and **full order traceability** between XoroERP and ShipMonk. *** ### **4. Settings** The configuration controls how data is exchanged between **XoroERP** and **ShipMonk**. It allows fine-grained control over what data is exported, how orders are processed, inventory synchronization, and notifications. *** #### 4.1 3PL Data Export Settings
SettingUI ElementDescription
Export Products to ShipMonkCheckboxEnables export of item master data from XoroERP to ShipMonk. If no tags are selected, all products are exported. If specific tags are selected, only tagged items are exported. Ensures ShipMonk’s product catalog remains consistent with XoroERP.
Export Orders to ShipMonkCheckboxEnables export of orders from XoroERP to ShipMonk for fulfillment. Only orders created in selected stores are exported. Helps automate fulfillment and reduce manual data entry.
Block Waves Created via QuickShipCheckboxPrevents waves created via QuickShip in XoroERP from being exported to ShipMonk. Useful for excluding test orders or temporary waves.
*** #### 4.2 Order & Shipment Export Controls
| **Setting** | **UI Element** | **Description** | | ------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Ship Method Name(s) | Text Field | Enter shipping methods to exclude from export. **Example:** `Local Pickup` **Leave blank to allow all shipping methods.** | | Blocked SKU(s) | Text Field | Enter item numbers (SKUs) to exclude from export. **Leave blank to include all SKUs.** | | Allowed Customer(s) | Text Field / Selector | Only orders from the selected customers are exported. **Leave blank to include all customers.** | | Shipment Notification URL | Read-only Field | A unique URL is generated when the account is registered in ShipMonk. ShipMonk uses this URL to send shipment confirmations. **Each account has its own unique URL.** **Sample URL:** `https://shipmonk.xorosoft.io/callback/processImportExportDataCallback?AppUserId=ueVAV%2b5tImVcR2XJyffCwg%3d%3d` | | Disable Multishipment | Checkbox | When enabled, ShipMonk’s shipment confirmation is treated as final. **All wave lines are closed automatically.** **Any remaining order quantities are unallocated.** When disabled, multiple shipment confirmations are allowed and wave lines remain open until fully processed. | *** #### 4.3 Filter Options Fine-tune which orders are exported using filters.
| **Setting** | **UI Element** | **Description** | | ----------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Filter Name | Dropdown | Select the field used to filter orders for export. **Available options:** Ship to Country, Order Date, Source, Order Tags, Ship Service, Order Type. | | Operator | Dropdown | Defines how the selected filter is evaluated. **Available operators:** Contains, Equals, Greater Than, Less Than, Does Not Contain. | | Value | Text Field | Enter a keyword or numeric value based on the selected filter and operator. **Example:** `Order Tag contains ShipMonk` ensures only orders tagged for ShipMonk are exported. | *** #### 4.3 Pricing and Markup Settings
**Default SKU** * Used when shipment confirmation from ShipMonk does not include SKU. * Ensures fulfillment continues without errors. **Shipping Markup** * Adds a percentage-based markup on shipping costs. * Example: “10” → adds 10% markup. **Shipping Markup Order Type** * Apply markup only to specific order types. * Leave blank to apply to all orders. *** #### 4.4 Carrier Mapping Maps **XoroERP Carrier Name → ShipMonk Carrier Name**. Prevents export failures caused by missing or mismatched carrier names between systems.
| **Setting** | **UI Element** | **Description** | | ------------------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Carrier Name | Dropdown | Represents the carrier name as configured in **XoroERP**. This value is used internally for order processing, shipping, and wave execution, and serves as the source carrier when exporting shipment data. | | Third Party Carrier Name | Dropdown | This value is used to map the corresponding carrier in XoroERP, ensuring shipments are exported without carrier mismatches or failures. | | Auto Create Carrier and Ship Services | Checkbox | Automatically creates missing carriers or ship services in XoroERP when received from ShipMonk. Ensures smooth export and synchronization without manual intervention. | *** #### 4.5 ASN (Advanced Shipping Notice) Settings
| **Setting** | **UI Element** | **Description** | | ----------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | Export ASNs to ShipMonk | Checkbox | Enables export of Advance Shipping Notices (ASNs) from XoroERP to ShipMonk. | | Batch Receive Location | Text Field | Defines the default store and location used to receive inventory from ShipMonk. **Format:** `StoreName@LocationName` **Example:** `LA@LA-W` | | Third Party Warehouse | Dropdown | Select the warehouse that represents ShipMonk’s fulfillment center for ASN and inventory receipt processing. | *** #### 4.6 Inventory Sync Settings
**Enable Full Inventory Sync (Checkbox)** * Activates full inventory synchronization from ShipMonk to XoroERP and runs automatically at defined intervals. Checking this setting opens the followig fields -
| **Setting** | **UI Element** | **Description** | | --------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | Inventory Identifier Code | Text Field | Unique identifier used to compare inventory records between XoroERP and ShipMonk. Ensures accurate reconciliation of stock levels across systems. | | Xoro Inventory Level | Dropdown | Selects the inventory metric from XoroERP used for comparison with ShipMonk. **Options:** Available, On Hand, Net Available | | Third Party Inventory Level | Dropdown | Selects the inventory level from ShipMonk used for comparison against XoroERP inventory data. | *** #### 4.7 Import/Export Settings * Schedule automatic data import/export for orders, shipments, ASNs, and inventory. * Options: Recurring or Once per Day * Set start date, hour/minute intervals, and offsets.
*** | **Setting** | **UI Control** | **Description** | **Example / Value** | | ----------- | -------------- | ----------------------------------------------------- | ---------------------------------------- | | Time Zone | Dropdown | Select the operational time zone for synchronization. | (UTC-08:00) Pacific Time (US and Canada) |
| **Setting** | **UI Element** | **Description** | | ------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enable Auto Import/Export | Checkbox | Enables automated data exchange between XoroERP and ShipMonk based on the configured schedule and interval. | | Integration Start Date | Date Picker | Defines the date from which the auto import/export process begins. | | Hour | Dropdown | Specifies the hour at which the auto import/export process starts. | | Min | Dropdown | Specifies the minute at which the auto import/export process starts. | | Auto Import Start Time Offset | Text Field | Applies a negative offset (in minutes) to the auto-import start time. **Example:** If Interval = `30` and Offset = `5`, data is fetched every **25 minutes**. | | Enable Pending Ship Confirmation Sync | Checkbox | Automatically fetches pending shipment confirmations from ShipMonk to ensure shipment data remains up to date. | **Email Notifications**
| **Setting** | **UI Element** | **Description** | | ---------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------- | | Receive Import Error Notifications Immediately | Checkbox | Sends email notifications immediately when an import error occurs. | | Daily Error Email | Checkbox | Sends a daily summary email containing import/export error logs. | | Error Notification Email Addresses | Text Field | Enter one or more email addresses to receive error notifications. **Multiple email addresses must be separated by commas.** | | Exclude Logs | Text Field | Optionally filter or exclude specific log entries using wildcards. **Example:** `error` | *** ### **5. Operations Page** The **Operations Page** in XoroERP allows users to monitor, control, and manually trigger all data synchronization activities between XoroERP and ShipMonk. It provides a centralized interface to manage orders, ASNs, shipment confirmations, SKU synchronization, and logs.
**Header Options** * **Add Account** – Add another ShipMonk account to your XoroERP integration. * **Change Account** – Switch between multiple ShipMonk accounts or update credentials. * **Remove Account** – Disconnect the current ShipMonk integration. * **Settings** – Open configuration parameters for controlling automated import/export. *** #### 5.1 Sync Xoro Data to ShipMonk Automatically push orders, ASNs, and shipment data to ShipMonk. * **Start/End Date:** Specify the date range for data synchronization. * **Search Query:** Filter by order number, ASN, or keyword to narrow down specific records. **Purpose:** Ensures accurate and timely synchronization, either automatically or selectively, between XoroERP and ShipMonk. *** #### 5.2 Orders Manually manage and monitor order exports. **Functions:** * **Run:** Manually push selected orders to ShipMonk. * **Mark as Resolved:** Marks successfully exported orders. * **Mark as Unresolved:** Reopens failed or pending orders for reprocessing. **Filters:** * **Hide Resolved:** Hides completed exports to focus on pending orders. * **Show Errors Only:** Displays only orders that failed to export for quick troubleshooting. **Information Displayed:** * **Order #:** Unique identifier for each order. * **Last Execution Date:** Timestamp of the most recent export attempt. * **Message:** Status update indicating success or failure and error details if any. *** #### 5.3 Ship Confirmations Track shipment confirmations sent by ShipMonk.
**Functions:** * **Run:** Fetch and update shipment confirmations. * **Mark as Resolved:** Marks confirmations as processed. * **Mark as Unresolved:** Reopens confirmations that require attention. **Filters:** * **Hide Resolved:** Hides already processed confirmations. * **Show Errors Only:** Displays only failed shipment confirmations for easy correction. **Search Options:** By Ship Confirmation # or keyword. **Information Displayed:** * **Ship Confirmation #:** Unique identifier for each shipment. * **Last Execution Date:** Timestamp of the latest confirmation. * **Message:** Status or error message from ShipMonk. *** #### 5.4 ASNs View and manage exported Advance Shipping Notices (ASNs). **Functions:** Run, Mark as Resolved, Mark as Unresolved.\ **Filters:** Hide Resolved, Show Errors Only.\ **Search Options:** By ASN # or keyword.\ **Information Displayed:** Order #, Last Execution Date, Message. **Purpose:** Provides visibility into all ASNs exported to ShipMonk and allows manual intervention when needed. *** #### 5.5 ASN Confirmations Monitor acknowledgment responses for previously sent ASNs.
**Functions:** Run, Mark as Resolved, Mark as Unresolved.\ **Search Options:** By ASN Confirmation # or keyword. **Purpose:** Ensures exported ASNs are acknowledged by ShipMonk, keeping shipment and inventory data synchronized. *** #### 5.6 SKU Manage SKU synchronization between XoroERP and ShipMonk. **Functions:** Run, Mark as Resolved, Mark as Unresolved.\ **Information Displayed:** SKU #, Last Execution Date, Message. 💡 **Example:** Updates made to product dimensions in XoroERP automatically sync with ShipMonk to maintain data consistency. *** #### 5.7 Logs Monitor all integration activity including exports, imports, and SKU syncs. **Filters:** Hide Resolved Exports, Show Errors Only.\ **Columns:** Export Date, Type, Keyword, Order Ref#. 💡 **Example:** Apply “Show Errors Only” to quickly identify failed records, correct the issues, and re-run exports. *** ### **6. Summary** The **ShipMonk 3PL Integration** provides a unified, automated bridge between XoroERP and ShipMonk’s logistics platform.\ It enables effortless synchronization of **orders, shipments, ASNs, and inventory**, ensuring accuracy and real-time visibility across systems. With automated scheduling, filter-based control, and built-in error handling, this integration ensures: * Faster fulfillment * Reduced manual errors * Accurate inventory * Transparent 3PL collaboration ⚡ **In essence, the ShipMonk 3PL Integration transforms manual logistics workflows into a seamless, automated, and reliable system within XoroERP.** --- # Agent Instructions: 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://docs.xorosoft.com/xoroerp-1/3pl-connections/shipmonk.md?ask= ``` 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.