|
|
| Line 1: |
Line 1: |
| = ERPNext Webshop: Installation, Bulk Item Management & Setup Guide =
| |
|
| |
|
| This guide outlines the end-to-end process for installing and populating the ERPNext Webshop, ensuring items are correctly categorized, imported, and visually optimized for both internal administration and the customer-facing storefront.
| |
|
| |
| == Sources ==
| |
| * https://docs.frappe.io/erpnext/v13/user/manual/en/ecommerce/set-up-ecommerce
| |
| * https://github.com/frappe/webshop
| |
| * https://docs.frappe.io/erpnext/v13/user/manual/en/ecommerce/website-item
| |
| * https://docs.frappe.io/erpnext/v13/user/manual/en/ecommerce/ecommerce_settings
| |
|
| |
| == Step 1: Install Webshop ==
| |
|
| |
| You can install the Webshop module in two ways:
| |
|
| |
| === Option 1: Via Bench (Self-hosted) ===
| |
| <pre>
| |
| bench get-app https://github.com/frappe/webshop
| |
| bench --site [your-site-name] install-app webshop
| |
| bench restart
| |
| </pre>
| |
|
| |
| === Option 2: Via Frappe Cloud ===
| |
| # Go to the '''Frappe Cloud Dashboard'''.
| |
| # Choose '''Sites''' or '''Server → Application'''.
| |
| # Under '''Apps''', click '''Install App''' and select '''Webshop'''.
| |
|
| |
| == Step 2: Set Up Item Groups ==
| |
|
| |
| You can use the default Item Groups (e.g. ''Products'' or ''Services'') or create new ones.
| |
|
| |
| # Go to '''Item Group List''' and create or edit an Item Group.
| |
| # '''Crucial:''' Check the "'''Show in Website'''" box so the group appears in shop navigation.
| |
| # Configure the Item Group's '''taxes, terms, and conditions''' for accurate pricing and compliance.
| |
|
| |
| == Step 3: Configure Webshop Settings ==
| |
|
| |
| Navigate to: '''Webshop Settings'''
| |
|
| |
| === Display Settings ===
| |
| * Products per Page: '''24''' (recommended)
| |
| * ☑ Enable Variant Selection
| |
| * ☑ Show Price
| |
| * ☑ Show Contact Us Button
| |
| * (Optional) Show Stock Availability
| |
| * (Optional) Show Apply Coupon Code
| |
| * (Optional) Allow items not in stock to be added to cart
| |
|
| |
| === Shopping Cart Settings ===
| |
| * '''Company:''' Comfac Corporation
| |
| * '''Default Customer Group:''' All Customer Groups
| |
| * '''Price List:''' Standard Selling
| |
| * '''Quotation Series:''' <code>SAL-QTN-YYYY.-</code>
| |
| * ☑ Enable Shopping Cart
| |
| * (Optional) Allow Non-Website Items in Cart Quotation
| |
|
| |
| === Checkout Settings ===
| |
| * ☑ Show Price in Quotation
| |
| * ☑ Save Quotations as Draft
| |
| * (Optional) Enable Checkout — activate when payment systems are ready
| |
|
| |
| == Step 4: Bulk Item Creation (Core Item) ==
| |
|
| |
| You must create the '''Item''' entry before the '''Website Item'''.
| |
|
| |
| # Download the '''Item Import Template''' from the Data Import tool.
| |
| # Fill in the template using the critical fields below.
| |
|
| |
| === Critical Item Fields & Defaults ===
| |
|
| |
| {| class="wikitable"
| |
| ! Field !! Required Value / Default !! Note
| |
| |-
| |
| | '''Item Code''' || ''Unique SKU'' || Must be correct; this links all records.
| |
| |-
| |
| | '''Series''' || <code>STO-ITEM-.YYYY.-</code> || Standard naming series.
| |
| |-
| |
| | '''Item Name''' || ''Product Name'' || Display name for the product.
| |
| |-
| |
| | '''Item Group''' || ''Category Name'' || Must match a created Item Group.
| |
| |-
| |
| | '''Default Unit of Measure''' || Unit || Standard UOM.
| |
| |-
| |
| | '''Maintain Stock''' || 1 || Set to 1 for physical goods.
| |
| |-
| |
| | '''Standard Selling Rate''' || ''Price'' || The base price of the item.
| |
| |-
| |
| | '''Description''' || ''Details'' || Internal/Technical description.
| |
| |-
| |
| | '''Brand''' || ''Manufacturer'' || e.g., Dell, Netgate.
| |
| |-
| |
| | '''Default Material Request Type''' || Purchase || Standard procurement flow.
| |
| |-
| |
| | '''Published in Website''' || 1 || '''Mandatory''' for web visibility.
| |
| |-
| |
| | '''UOM (UOMs)''' || Unit || Child table UOM entry.
| |
| |-
| |
| | '''Conversion Factor (UOMs)''' || 1 || Relationship to base UOM.
| |
| |-
| |
| | '''Company (Item Defaults)''' || ''Your Company'' || e.g., Comfac Corporation.
| |
| |-
| |
| | '''Default Warehouse (Item Defaults)''' || ''Warehouse Name'' || e.g., Stores - CC.
| |
| |}
| |
|
| |
| == Step 5: Attaching Item Pictures ==
| |
|
| |
| After the bulk Item upload, attach image files to each record:
| |
|
| |
| # Open the '''Item''' record.
| |
| # Use the '''"Attach File"''' button in the sidebar.
| |
| # Upload high-resolution product images.
| |
| # These attached images are what the Slideshow will eventually "Fetch."
| |
|
| |
| == Step 6: Bulk Website Item Creation ==
| |
|
| |
| The '''Website Item''' is the public face of your product. Use the '''Website Item Import Template'''.
| |
|
| |
| === Critical Website Item Fields ===
| |
|
| |
| {| class="wikitable"
| |
| ! Field !! Required Value / Default !! Note
| |
| |-
| |
| | '''Website Item Name''' || ''Marketing Name'' || The title shown on the webshop.
| |
| |-
| |
| | '''Item Code''' || ''Matching SKU'' || '''Must match exactly''' the code from Step 4.
| |
| |-
| |
| | '''Naming Series''' || <code>WEB-ITM-.####</code> || Standard website item series.
| |
| |-
| |
| | '''Has Variants''' || 0 || Set to 0 for standalone items.
| |
| |-
| |
| | '''Published''' || 1 || Set to 1 to make it live.
| |
| |-
| |
| | '''Item Name''' || ''Internal Name'' || Matches the Core Item name.
| |
| |-
| |
| | '''Item Group''' || ''Category'' || Website category for navigation.
| |
| |-
| |
| | '''Stock UOM''' || Unit || Must match the Core Item UOM.
| |
| |-
| |
| | '''Item Description''' || ''Full Details'' || Long-form text for the item page.
| |
| |-
| |
| | '''Brand''' || ''Manufacturer'' || Displayed for filtering.
| |
| |-
| |
| | '''Image Description''' || ''Alt Text'' || Used for SEO and accessibility.
| |
| |-
| |
| | '''Short Website Description''' || ''Teaser'' || Shown in the grid/list view.
| |
| |-
| |
| | '''Website Description''' || ''Rich Content'' || Detailed marketing description.
| |
| |}
| |
|
| |
| == Step 7: Website Slideshows ==
| |
|
| |
| To provide a premium feel, use the '''Website Slideshow''' feature.
| |
|
| |
| # Navigate to '''Website Slideshow'''.
| |
| # '''Naming Convention:''' Use the '''Website Item Name''' or '''Item Code''' to name the entry.
| |
| # '''Fetch Images:''' Click '''"Fetch attached images from the document"''' — this pulls images attached to the Item record in Step 5.
| |
| # '''Link to Website Item:''' Go to the Website Item record → '''Display Images''' section → select your new Slideshow.
| |
| # The '''Main Picture''' on the shop page is pulled from the primary attached picture on the Website Item entry.
| |
|
| |
| == Step 8: Bulk Editing & Fine-Tuning ==
| |
|
| |
| Only perform bulk editing ''after'' the initial creation has been inspected and verified.
| |
|
| |
| * Use the '''"Update Records"''' mode in the Data Import tool to adjust prices or descriptions.
| |
| * Verify that each item has a unique '''Route''' to avoid 404 errors.
| |
| * Once published, products will appear under <code>/all-products</code> by default.
| |
|
| |
| [[Category:ERPNext]]
| |
| [[Category:Webshop]]
| |
| [[Category:Setup Guides]]
| |
