Configure Magento Channel Integration

This guide details the settings that can be configured for a Magento channel once it has been added to Linnworks 

If the main settings such as site URL, username or API key change you can reset your channel with the new details by clicking on the "test" button and following the re-integration wizard.

Table of Contents


To configure a Magento channel it must already be added to Linnworks

Configure Channel Settings

Click on the pen icon in the channel integration screen for the required Magento integration

Options available


  • Enabled: Tick this option to allow communication between Linnworks and Magento, without this ticked no information will be sent to Magento or received from Magento. When enabled Linnworks will download orders from Magento that have the Status of "Processing" defined on Magento
    • Please check below for the options Use order State and Download pending orders as this affects which orders are downloaded from Magento
  • Site URL: The domain of the Magento site that is integrated
  • API URL: The URL of where the API is - set as /index.php/api/xmlrpc/ as standard
  • Username: The username created for Linnworks to access Magento
  • API Key: The API key created for Linnworks to access Magento
  • Is Multi Location: Enables downloading orders per each Magento Multi store individually. Multi stores are treated as channel locations in Linnworks.
Please Note! If 'Is Multi Location' is enabled, 'Multi Store' and 'Store ID Site' must remain disabled
  • Multi Store: Tick this option if your Magento installation is configured to be a multi store
  • Store Site ID: This is related to the multi store option. If you have a multi store, this should be the Store Site ID of the store that relates to this integration where from the orders are going to be downloaded
  • Test: Used to confirm the supplied credentials work correctly allowing communication between Magento and Linnworks
    • Can be used to re-integrate if the existing integration changes credentials
  • Test Extension: Used to check if the Magento/Linnworks listing extension is working correctly. The values returned are properties of your Magento installation (supports both Tls1 and Tls2 protocols)


  • Update Inventory: Allow Linnworks to submit changes in-stock level to Magento. Linnworks supports multiple stock locations for additional warehouses / fulfillment centres / suppliers. Ensure you set which Linnworks locations are used when submitting changes in-stock level to your channel via the Location Mapping screen accessed from the main Channel Integration screen
  • Price Change: Price Change is designed to speed up the process of updating the sales channel once a Linnworks stock item has had its listing price updated and saved
  • Max Listed: This specifies the maximum level that will be sent to the channel
  • Stock Percentage: This will send a percentage of the currently available stock level to the sales channel
  • End When: This enables you to force the listing to end when the stock level gets to the specified amount as opposed to the default value of zero
    • For more details go to the End When guide. 
  • Do not mark as out-of-stock: Enabling this option will not mark SKUs with 0 available quantity as out-of-stock
  • Work by SKU: By default, Linnworks will use the Linnworks SKU. This has been known to cause issues in some cases when updating product information. If you are experiencing issues with your Magento site, please try disabling this option. This will then force Linnworks to use the 'Product ID' field from Magento to try and match to items in Linnworks
  • Perform Reindex when creating listings (recommended): When listings are created, Magento will be automatically re-indexed
    • The default is for this option to be ticked to give your listings the best chance of being visible on your Magento site
    • When ticked, the listing process may take longer and potentially could result in indexes being corrupted due to add-ons, extensions or non-official builds of Magento
    • When unticked, listings that are created will not appear on the website until you go to your Magento admin back-end and re-index manually
    • If a cron job is set up on your Magento site to automatically reindex this option should be unticked

  Listings is designed to update the listings on the mapping page once every 12 hours, but for any reason, it has not or you require updated listings more regularly, then the Download Listings button here allows you to force the update.

  • Listing Download in Progress: This tick box will tick itself if a Listing Update has begun
  • Listing Download Start Time: This will show the date and time of when the update has begun
  • Last Manual Download: This will show the date and time of when the last manual update was run
  • Listing Download Estimated Completion: This will give you an estimate of when the listings download will be complete – the time can vary depending on server speeds and amount of listings
  • Download Listings: Click on this button to force Linnworks to request an update from the channel for your active listings


  • Despatch Notes: After processing order in Linnworks a despatch notification, Tracking number and the selected Shipping Vendor will be submitted to the channel. This is then compared to a list of couriers on the channel and displayed if it matches a courier. If it doesn't match then "Custom" is displayed on the order. If no tracking number is available, nothing is submitted. When the option is disabled no despatch information will be submitted to Magento
  • Order Sync Date [UTC]: This shows the date and time when Linnworks last synchronised with the channel
  • High volume orders: Tick this option if the channel deals with a high volume of orders, in the thousands, per day. This will then force orders to download in batch once an hour. This reduces the load on the server
    • Please note that if this option is used, orders that are deleted from Linnworks will not be redownloaded, due to the way in which Linnworks will be looking for valid orders to download
  • Use base currency: This will force Linnworks to use the base currency set in Magento, rather than the default Linnworks currency
  • Use order State: By default, Linnworks downloads orders based on the status of the order {pending,processing} on Magento. By ticking this option Linnworks will instead only  download them based on state {new,processing} as defined on Magento
    • Order State is an attribute internal to Magento. It differs to order status, but they can be mapped in the Magento settings
    • Several Status' can be mapped to one state, for example; an order state of payment_review could be mapped to status' of payment_review and fraud
  • Download pending orders: Ticking this option will force Linnworks to also download orders that have the status of 'Pending' on Magento. If the option Use Order State is enabled Linnworks will instead download orders where state is set to "New" on Magento.
  • Pending order from date: Pending orders will only be downloaded from this date or sooner
  • Payment methods to download pending orders: This allows for customisation of when pending orders will be downloaded
    • For instance, if a customer was paying on collection, but the order needed to be picked and packed in advance then payment method "cashondelivery", which by default is mapped as a pending order on Magento, could be set to download in Linnworks.

Please Note! This information can be populated by using the Update Channel Payment option in the Payment Mapping options. Please see guide for more information.

  • Ignore Bundle Child Items: Use this option to ignore bundle child items during order download. Should only be enabled if the bundle parent has a linked SKU to a composite parent in Linnworks with the correct and exactly matching child items. When disabled, bundle child and parent items will be downloaded as separate items.
  • Use Magento tax settings: When enabled Linnworks will use the tax percentage set on the Magento order download while ignoring order tax or country tax currently set on Linnworks itself.
  • Magento email notification on despatch: Enabling this option will instruct Magento to send an email to the customer when the order is processed in Linnworks
  • Raise invoice after despatch: Once the order is complete on Magento, Linnworks will try to raise an invoice. This will trigger any payment capture actions on your payment gateway
  • Capture invoice after raise: This option relates to the use of pre-authorised payments/orders
  • Invoice prefix: This is the prefix given to invoices from this channel, the prefix is assigned when the channel is first integrated and can not be changed

Next Steps

Location Mapping
Inventory Mapping
Payment Mapping
Shipping Mapping
Listing to Magento