Welcome to Shuup Guide!¶
Contents:
Using the Shuup Admin¶
Sorting and Filtering Tables¶
Different pages in the Shuup Admin may contain a table of different items (such as customers, orders, or products). Rows within this table may be sortable or filterable, depending on the section.
If a column is sortable, you will be able to change the sorting behavior (unsorted, alphabetical, or reverse alphabetical) by clicking the name of the column.
If a column is filterable, a text box or other filter fields will be available to adjust the filters. Rows that do not match the filter will not be displayed.
Products¶
Adding Products¶
The Shuup Admin provides a simple interface for adding products to your shop.
To navigate to the Products section of the Shuup Admin, open the Admin menu and select the Products section under the Products category.
On the Products page, you will see a list of all of the products currently in your shop. In the upper right-hand corner, there is a button labelled New product for creating new products. Clicking this will take you to the new product form, where you can enter information about your new product.
New Product Form¶
Like other Shuup Admin forms, required fields are marked with a red asterisk and missing or invalid fields will be highlighted red upon form submission.
The left side of the form contains a number of sections of the form (shown as tabs), and selecting a tab will present the different fields and options for that section.
Basic Information Tab¶
- Basic Information
- The top section of the form contains most of the basic product information and settings including product name, description, type as well as a product image uploader and selector.
- Current Shop
- The name of this section is the relevant shop’s name (initially Default). It has the default price, font-end visibility and category.
Additional Details Tab¶
Miscellaneous information regarding the product, such as the product’s shipping mode, tax class, barcode information, the product physical dimensions and unit information as wells as the slug and relevant keywords.
Manufacturer¶
Selection choice for the product’s manufacturer.
Shop-Specific Additional Tab¶
The names of this tab are preceded by the relevant shop’s name (initially Default). It strictly contains shop related information such as front-end visibility settings for a specific shop, pricing, suppliers, multiple-purchase settings.
Contact Group Pricing Tab¶
Pricing settings based on contact groups. If a contact belongs to multiple groups, they will be presented the lowest price of the groups to which they belong. These groups are defined in Contacts Settings – Contact Groups
Note
Contact Group pricing is currently not configurable for specific shops.
Contact Group Discount¶
Individual discount amounts for different contact groups. The discount amount may be visible on the storefront. These groups are defined in Contacts Settings – Contact Groups
Saved Product Form¶
Once the product has been successfully saved, additional options will be available from the product edit form.
Attributes Tab¶
See Attributes.
Product Files¶
Product-related file uploader and selector.
Product Images¶
Product image uploader and selector.
Stock Management Tab¶
For stocked product, this should display any stock-related management tasks depending on the product’s supplier settings.
Active Campaigns¶
This section shows all the active campaigns the product is in.
Orders Tab¶
Show recent orders containing the product.
Product Types¶
Product Types define classes products and are used to associate different sets of attributes to a particular product, depending on its product type.
For example, a product of type Book might require specific information such as author, ISBN, publisher, etc., while a product of type Clothing might require size, color, or other custom attributes.
Attributes¶
Shop owners can define their own attributes for Product Types from the Attributes Admin.
- Navigate to the Attributes admin page by clicking Attributes under the Shops category from the Shuup Admin menu.
- Click the New attribute button in the upper right-hand corner
- Enter a name and unique identifier for the attribute, and select the type, visibility mode, and searchability for the attribute
- Select the Product Type page (under the Shops category) from the Shuup Admin menu
- Select the Product Type from the menu
- Under the Attributes tab, check the box next to the attribute name for your new attribute.
Tip
By default, new attributes are displayed on the product page, but there are multiple visibility options that can be selected form the Attributes edit page.
Cross-Selling¶
Adding Cross-Sells¶
Related products can be sold together on Shuup’s storefront by using Shuup’s cross-selling feature. These relationships can be managed from the Shuup Product admin.
To add a relationship for a particular product, navigate to the product’s page and select Manage Cross-Selling from the Actions menu.
Products can be selected by clicking the Select Product button and clicking on the desired product from the product list.
Once the product has been selected, the relationship’s weight can be set.
The relationship weight is used when calculating which products will be displayed together on the shop front. The higher the relationship weight the more likely the products are to be displayed together.
Finally, you can select one of the following relationship types:
- Recommended
- Products are recommended to be bought together.
- Related
- Products are related.
- Computed
- Primarily reserved for use by add-ons.
- Bought With
- Primarily reserved for internal use. These relationships are automatically calculated by automated Shuup tasks, however if these tasks have not been configured by the server administrator, they can be defined manually here.
Note
Only five relationships can be added at once. However, more can be added once these relationships have been saved. This can be repeated as necessary.
Displaying Cross-Sells¶
Once defined in the Product admin, cross-sell relationships can be displayed on the store front using a plugin.
Follow the following steps to display a relationship type on the store front:
- Make sure you are logged in as an administrator and navigate to the store front.
- Navigate to any product page.
- Click on the Edit Page button in the upper right-hand corner of the page.
- Select one of the placeholder boxes.
- Add a new row or new column for your plugin.
- Select Product Cross Sells from the plugin dropdown menu.
- Add a title if desired, select the relationship type, and set the count as the number of products to be displayed at once. You can also select whether or not to hide out-of-stock or unorderable items.
- Save the plugin.
- Publish your changes.
- Click the Exit Edit button in the upper right-hand corner of the page
- Your products should now appear in the placeholder on the product’s page.
Note
Cross-sell relationships are only one-way and must be manually added to any related product you would like to relate back to the original product.
Note
If there are no relationships of the selected type for a particular product, the plugin will not be displayed.
Package Products¶
Package products are used to package a number of related products to be sold as a single product package.
These products are stored a single package parent, which can be linked to multiple package children.
Stock for child products is automatically updated when the package is purchased. Pricing, discounts, etc., of the parent product can be managed like any other product.
To convert a product to a package parent:
Navigate to the parent product’s edit page and select Convert to Package Parent from the Actions dropdown menu.
Click the Browse button to add child products to the package. Enter the quantity of each product to include in the package.
Click Save to save the package’s child product information.
Variation Products¶
Some products may be available to customers in a number of different variations, and customers should be able to choose from these different available options when adding products to their cart.
Shuup provides two different types of product variations, simple variations and variable variations.
Simple Variations¶
Simple variations are general variations that are displayed on the product page as a simple drop-down menu where the user can select from any of the available variation product choices.
Variable Variations¶
Variable variations allow you to define child products based on a specific variable. For example, a product might have variables such as size or colors, with different options for each, and the customer should be able to select from a combination of these options.
To add variable variations:
- Navigate to the parent product’s edit page and select Convert to Variation Parent from the Actions menu.
- Select Variables from the left-hand menu
- Click Add new variable to add a new variable form
- Enter the variable name
- Click Add new value
- Enter names for possible values
- Continue for other variables/values as needed
- When finished, click Save in the toolbar
Once these variables have been added, “child” products can be linked for each combination of variables. For example, if there are 3 size values and 2 color values, there will be 6 child products, one for each size, color combination.
Tip
Names for child products should follow a consistent naming scheme indicating the variable value for each product.
Tip
Variable variations can be converted to simple variations by clicking Convert to simple variation on the Variation view toolbar. However, all variable and value information will be lost.
Managing Variations¶
Once a product has been converted to a simple or variable variation parent, it can be managed by selecting Manage Variations from the Actions menu for either the variation parent’s admin page or the admin page for any of the child variation products.
Multivendor¶
Note
The Multivendor feature is currently only available through a license. For more information, contact support@shuup.com
The Multivendor Addon enables multiple features that facilitate the management of a multivendor marketplace. The marketplace owner can manage several Vendors more easily while vendors can select the products they want to sell, their prices as well as manage their stocks.
User-roles and Permissions¶
Permissions are the basic and Initial configuration all modern application should have. They are created to restrict features to a certain group of users. Shuup restrict the features using Permission Groups. A user can be linked to many permission groups. As the permissions must be explicitly granted (you must check what features are allowed to access), a user will accumulate all the permissions from all the linked permission groups.
- Common user roles for multivendor:
- Admin: (superuser). Superusers has all the permissions and can see all admin modules available.
- Staff: Can see admin modules defined for the staff group. The main role is to manage vendors, products and orders.
- Vendor: Can manage own products and manage vendor order lines, see vendor reports.
These roles are already created in the multivendor environment and can be tweaked to meet the project requirements.
See Permission Groups for more general informations on Permission Groups.
As a Vendor¶
Vendor Registration¶
- From the marketplace home page, navigate to /v/register to access the registration form.
- Fill out the Vendor information part with the name and address of your store, the Owner part is about you and the Login Information will allow you to access the admin Panel of the your store in the marketplace. If need be, you can update those informations later in the Vendor Settings.
- Click Register.
Notifications¶
After the registration, you will receive an email notification confirming that your registration is complete.
Note
You will not be able to log into your account on the marketplace until a marketplace staff member approves your registration.
You will get another email notification when your registration is approved.
Admin Panel¶
From the marketplace home page, navigate to /admin, type in your username and password and click the Login button to access the admin panel. You will be shown your dashboard with a summary of your sales.
Settings¶
Navigate to the Vendor Settings page by clicking Vendor Settings under the Settings category from the Shuup Admin menu.
You can update the name, description and logo of the Vendor and use the tabs on the left-hand side to update the contact address and the opening periods.
Click on the Go to vendor page button to be taken to your vendor page on the store front.
Product Management¶
Navigate to the Vendor Products page by clicking Products under the Products category from the Shuup Admin menu.
On this page, you will find all the products available to the marketplace. To find a product more easily, you can filter them by name. You can manage your stocks, start and stop selling products and set the price. If no price is set, the default price will be used.
Stock Management¶
Stock management is a crucial feature that all e-commerce platforms must have. Shuup is designed to be the more extendable as possible.
To a product be able to be purchased, it must have at least a Supplier set. Suppliers are responsible to return whether a product can be purchased for a given quantity (and other context values such as the current customer).
In the multivendor environment, each Vendor is a Supplier behind the scenes, and the vendor can manage only the products it supplies.
Managing Stocks¶
To manage stocks, go to Product > Products. Pick a product and click on the Stock Management section.
On this management panel it is possible to update stocks, alert limit and disable the stock management for this specific product.
The initial management status is configured per-project. If the stock management is disabled, the product can be purchased unlimitedly – no stocks are checked.
To update stocks, fill the Quantity field and press the Add stock. The purchase price can be optionally filled for future reports. Stock will be incremented if the quantity is a positive number and decremented if the quantity is a negative number.
The alert limit can also be set and when Notifications addon is enabled, it will trigger an event that can be configured send email to users or any other logic.
Stock reports¶
Stocks can be listed in a simple way using a stock report. Go to Reports and select the Vendor Product Report, fill the filters if needed and press the Get Report button.
The report shows the product name, price and the current stock status. Logical stock is the number of products available for sale and Physical stock is the number of products that are physically in stock and they are waiting to be shipped. Both numbers will be equal when all products from their orders are fully shipped.
See Stock Management for more general information about Stock Management.
Orders¶
Navigate to the Vendor Orders page by clicking Vendor Orders under the Orders category from the Shuup Admin menu.
On this page, you will find all the orders that have been made for the vendor. There are multiple filters available to single orders out.
Click on an order to see the order information like the order number and reference, the customer name, email, billing and shipping address as well as the product name, quantity and price.
Depending on your marketplace configuration, it might also be possible to create a shipment, set the tracking code or the order status.
As a Marketplace Staff Member¶
Create a new Vendor¶
- Navigate to the Vendors Management page by clicking Vendor Management under the Settings category from the Shuup Admin menu.
- Click on the + Create new button.
- Fill out the Vendor’s name. You can also add a description, a logo and management users. Make sure the Enabled and Approved checkboxes are selected.
- Click on the Contact Address tab on the left-hand side to fill out the contact name and address.
- You can set up opening periods in the Opening periods tab on the left-hand side.
- Click on the Save button.
The Vendor will receive an email notification for the registration and another one for the approval if the Approved checkbox was selected during the creation process. Vendors can log in their admin panel as soon as they are approved.
See Notifications to set up customized Notifications.
Approving a Vendor¶
- Navigate to the Vendors Management page by clicking Vendor Management under the Settings category from the Shuup Admin menu.
- Select the Vendor you want to approve.
- You can edit the Vendor’s informations such as their name, description logo, contact address and opening periods.
- Select the Approved checkbox.
- Click Save.
The Vendor will receive an email notification once their registration is approved. Vendors can log in their admin panel as soon as they are approved.
See Notifications to set up customized Notifications.
Orders from all Vendors¶
Navigate to the Vendor Orders page by clicking Vendor Orders under the Orders category from the Shuup Admin menu.
On this page, you will find all the orders that have been made for all the vendors in the marketplace. There are multiple filters available to single orders out.
Click on an order to see the order information like the order details, the customer name, email, billing and shipping address as well as the product name, quantity and price.
Depending on your marketplace configuration, it might also be possible to create a shipment, set the tracking code or the order status.
See Orders for more information.
Vendor Reviews¶
Vendor reviews module stores users’ ratings for vendors.
Requirements to a review be visible in the storefront: - Users can only create reviews for vendors of completed orders - The review should be approved by staff users - Xtheme plugin must be placed in placeholder inside the vendor detail view
Creating a vendor review¶
After the user has placed his order and the order is in a completed status, the user can create the review in the Customer Dashboard:
The user must select the star rating also add some comment and check whether he would recommend that vendor to a friend. After that the review will be available for visualization. The user can change the vendor review at any time by submitting the reviews again.
Once the review is sent, it should be approved by a staff user in Admin > Settings > Vendor Reviews:
The staff must select all the reviews he wants to approve/disapprove and select the respective action in Mass Action dropdown:
Done. After the review is approved, it will be visible at the storefront.
Configuring the plugins¶
The module provides a plugin to render the customer ratings in places where a vendor is available in context, like the Vendor Detail page. You must add the Vendor Review Rating plugin and configure it as needed:
After all these configurations, the vendor review module will be working as it should.
Stock Management¶
Stock management is a crucial feature that all e-commerce platforms must have. Shuup is designed to be the more extendable as possible.
To a product be able to be purchased, it must have at least a Supplier set. Suppliers are responsible to return whether a product can be purchased for a given quantity (and other context values such as the current customer).
Managing Suppliers¶
To manage suppliers, go to Shops > Suppliers. Click to create a new supplier or edit the current one if your installation only allows a single supplier to be used.
Suppliers have a module attribute that allows custom implementation of stock handling, like fetching the stock status from an ERP and updating the stocks through an API call.
Shuup has a simple supplier implementation built-in, it keeps the total number of items locally and manages all the events to add/subtract the totals – it is enough for the majority cases.
Besides that, the supplier has flags like Enabled and Approved, they just make the supplier available or not in the platform.
The supplier also has a Stock Managed flag, which dictates whether this supplier actually manages stocks. If that is disabled, products can be unlimited purchased – no stocks check. If the flag is enabled, it is also possible to disable stocks check for specific products. The flag is enabled by default.
Once the supplier is created, it can be attached to products. When the simple supplier module is being used, it provides a nice management view in product admin:
On this management panel it is possible to update stocks, alert limit and disable the management for this specific product.
To update stocks, simple fill the Quantity field and press the Add stock. The purchase price can be optionally filled for future reports. Stock will be incremented if the quantity is a positive number and decremented if the quantity is a negative number.
The alert limit can also be set and when Notifications addon is enabled, it will trigger an event that can be configured send email to users or any other logic.
It is also possible to manage several products at once in Shops > Stock management.
Product Reviews¶
Product reviews module stores users’ ratings for products that were ordered by them.
Requirements to a review be visible in the storefront:
- Users can only create reviews for completed orders.
- The review should be approved by staff users.
- Theme should be configured to show product rating on product card.
- Xtheme plugin must be placed in placeholder inside the product detail view.
Creating a Review¶
After the user has placed his order and the order is in a completed status, the user can create the reviews in customer dashboard:
The user must select the star rating also add some comment and check whether he would recommend that product. After that the review will be available for visualization:
Once the review is sent, it should be approved by a staff user in Admin > Products > Product Reviews:
The staff must select all the reviews he wants to approve/disapprove and select the respective action in Mass Action dropdown:
Done. After the review is approved, it will be visible at the storefront.
Configuring the theme¶
The selected theme should allow showing the product review rating in product card. Go to your theme configuration and check the options. It should provide something like this:
Check that and save.
Configuring the plugins¶
The module provides a plugin to render the customer ratings in places where a product is available in context, like the Product Detail page. You must add the Product Review Rating plugin and configure it as needed:
After all these configurations, the product review module will be working as it should.
Using Themes¶
Installing Themes¶
Shuup Themes (or Xthemes) are downloaded and installed like other addons.
Activating Themes¶
When a shop is first set up, visitors will see the following notice until a theme for the shop has been activated.
To activate a theme, go to the Shuup Admin and click Themes under the Content category from the Shuup Admin menu.
From here, themes can be activated or configured.
Clicking Activate will activate the theme, and by clicking Configure, you can configure any custom theme settings.
Editing a Page¶
To edit a page:
- Log in as an administrative user.
- Navigate to the page on the shop front you want to edit.
- Click the Edit Page button in the upper right-hand corner to enter edit mode.
Once in edit mode, placeholders will appear as blocks surrounded by dotted outlines.
When finished editing, click the Exit Edit button to return to the normal mode.
Placeholders¶
Placeholders define the regions that a plugin may be included on a page. The theme source code defines where in the shop’s pages placeholders will appear.
To edit placeholders, enter edit more and click the placeholder you wish to edit.
See Editing a Page for more information.
Note
Changes to regular placeholders only affect a single page or view.
However, if a placeholder is a global placeholder, any changes will be reflected site-wide. Typically, these are used in areas such as headers or footers.
Refer to your theme documentation regarding which placeholders are global placeholders.
Plugins¶
Shuup Xtheme plugins provide an easy way for merchants to customize their shop frontend.
Shuup comes with a selection of default plugins, or plugins may be provided by themes or addons.
Adding Plugins¶
To add a plugin:
Enter edit mode and click the placeholder to which you want to add plugins.
Click Add new row button to add a new row of cells, or to add a column to an existing row click the new cell button add a column cell.
Blank plugin cells will be labelled as None and existing cells will be labelled with their plugin type. Select the None cell to configure the plugin settings.
Select a plugin from the Plugin dropdown and enter any required plugin settings.
Click the Save Plugin button at the bottom of the Xtheme edit window to save the plugin settings.
Note
While in edit mode, placeholder changes will be visible. However, they will not be visible outside edit mode until they have been published.
Click the Publish Changes button at the top of the Xtheme edit window to save the placeholder settings.
Payment and Shipping¶
In Shuup, payment and shippings choices are associated with particular service providers. These may be provided by Shuup’s build-in carriers or payment process, or may be provided by payment or shipping-related addons.
Service Providers¶
Creating a Payment/Service Provider¶
- Navigate to the Service Providers admin page by clicking Service Providers under the Shops category from the Shuup Admin menu.
Click the New service provider button in the Service Providers admin toolbar.
Select the provider type from the dropdown.
Note
Some classes of providers may require extra fields. If so, these should appear when you select the provider from the dropdown.
Enter the name, logo, enabled status, and any additional fields.
Click Save to create the service provider.
Once saved, click Create payment method or Create shipping method to create a payment or shipping method associated with this payment provider.
See Creating a Payment Method and Creating a Shipping Method.
Payment Methods¶
Creating a Payment Method¶
- Navigate to the Payment Method admin by clicking Payment Methods under the Shops category from the Shuup Admin menu.
Click the New payment method button in the Payment Methods admin toolbar.
Select a payment provider from the payment processor dropdown as well as a payment service from the service dropdown.
Enter the remaining information for the method.
- Click Save to create the payment method.
Shipping Methods¶
Creating a Shipping Method¶
- Navigate to the Shipping Method admin by clicking Shipping Methods under the Shops category from the Shuup Admin menu.
Click the New shipping method button in the Shipping Methods admin toolbar.
Select a shipping provider from the carrier dropdown as well as a shipping service from the service dropdown
Enter the remaining information for the method.
Click Save to create the shipping method.
Behavior Components¶
When a customer checks out, they are presented the choice of any available payment methods for their order.
Whether a particular payment method is applicable to an order depends on its behavior, which is comprised of any number of behavior components.
Behavior components are essentially just individual components that, when taken together, define.
- Whether a payment method is available for an order
- The amount to charge for that payment method, if available
Shuup also ships with the following basic components (although behavior components can also be added by Addons):
- Fixed cost
- Add a fixed cost.
- Waiving cost
- Add a cost that is only applied up to a price limit.
- Weight limits
- Limit availability of the service based on total weight of products.
- Weight-based pricing range
- Add a cost to the order if it is within a specific weight range.
Note
If there are multiple valid weight-based pricing ranges for an order, the cheapest-option will be selected.
Adding a Behavior Component to a Method¶
- Navigate to the Shipping or Payment Methods admin by clicking Shipping Methods or Payment Methods under the Shops category from the Shuup Admin menu.
Select the shipping or payment method to which you want to add behavior components.
Click the Behavior tab on the left-hand side of the screen.
Select behavior component type from the Behavior component type dropdown and press the Add component button to add a blank form for the selected behavior component.
Enter the behavior component settings, repeat as necessary to add more behavior components.
Click Save to save the behavior components for the selected method.
Tax Settings¶
Taxes¶
Creating a New Tax¶
To create a new tax:
Navigate to the Taxes admin page by clicking Taxes under the Settings category from the Shuup Admin menu.
Click the New tax button in the Taxes admin toolbar.
Enter values for new tax, including a tax rate as a percentage (i.e., for a tax rate of 7.5%, enter 7.5 as the tax rate value).
Click Save to save the new tax.
Tax Rules¶
Creating a New Tax Rule¶
Navigate to the Taxes admin page by clicking Tax Rules under the Settings category from the Shuup Admin menu.
Click the New tax rule button in the Tax Rules admin toolbar.
Enter the criteria for the new tax rule.
Click Save to save the new tax rule.
Customer Tax Groups¶
Creating a New Customer Tax Group¶
Navigate to the Taxes admin page by clicking Customer Tax Groups under the Settings category from the Shuup Admin menu.
Click the New customer tax group button in the Tax Groups admin toolbar.
Enter a name for the new tax group.
Click Save to save the new customer tax group.
Tax Classes¶
Creating a New Tax Class¶
Navigate to the Tax Classes admin page by clicking Tax Classes under the Settings category from the Shuup Admin menu.
Click the New tax class button in the Tax Classes admin toolbar.
Enter information for the new tax class.
Click Save to save the new customer tax class.
Display Settings¶
Shop Settings¶
Note
Tax display settings can only be configured for a shop if there are no orders in the system.
Once an order has been placed, you will no longer be able to change the tax display settings.
- Navigate to the Shops admin page by clicking Shops under the Shops category from the Shuup Admin menu.
Select the shop whose tax display settings you would like to modify.
Check or uncheck the Prices include tax field to enable or disable tax display for shop.
Click Save to save the shop settings.
Orders¶
Creating an Order¶
Orders can be made in one of two ways: by a customer through the shop front or by a merchant through the Shuup Admin.
To create an order through the Shuup Admin:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Click the New order button on the Order admin toolbar.
Under the Customer details section, search the customer by name or email to select an existing customer, click the search icon to launch the customer selection popup or leave the field blank to create a new customer along with the order. If a customer is selected, click the bin icon to delete it.
Under the Order contents section, click Add new line to add blank order lines to the order.
These can either be of type product, other, or text/comment.
If adding a product, clicking Select product will launch the product browser window.
Here are the types of lines you can create in an order:
- Product line
A product, quantity, and any pricing or discount information
- Other line
A miscellaneous priced line
- Text/Comment line
A non-priced text line
Optionally, the Quick add product line form can be used to quickly add product lines to the order. For example, this can be used when adding products using a barcode scanning device.
To quick add products:
Enter a product name, sku, or barcode number and select desired product from the dropdown results.
Press the plus button to add the product line to order or press the trash button to clear the input and select a new product.
Select shipping and payment methods for the order from the Shipping and Payment Methods dropdowns.
Click the Proceed button to create the order.
Note
You must select shipping and payment methods for each order.
Note
Method rules, taxes and possible extra discounts are calculated after proceeding.
Editing an Order¶
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order that you wish to edit.
Click Edit Order in the order toolbar.
Make any desired changes to the order contents as done when Creating an Order.
Click the Proceed button to save the order contents.
Order Shipments¶
Creating an Order Shipment¶
To create an order shipment:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order for which you want to create a shipment.
Click Create Shipment in the order toolbar.
For each product, select the quantity of that product to include in the shipment. To easily select all remaining unshipped quantities, click Set All Products To Ship.
Select a product supplier from the dropdown menu.
Click the Create Shipment button to create the shipment.
Printing a Delivery Slip¶
To print a delivery slip for an order shipment:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order which delivery slip you want to print.
If you haven’t already done so, create an order shipment.
Click Printouts tab on the left-hand side of the screen
- Click Get Delivery Slip HTML for the order shipment you would like to print (there will be one available for each shipment).
- You will now be taken to the delivery slip, which you can either print or save to your computer from your browser menu.
Order Payments¶
Creating an Order Payment¶
To create an order payment:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order for which you want to create a payment.
Click Create Payment in the order toolbar.
Enter the amount of the payment in the Payment amount field or click Get Remaining Total to automatically fill will remaining unpaid total.
- Click the Create Payment button to create the payment.
Viewing Order Payments¶
To view all payments for an order:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order whose payments you want to view.
Click the Payments tab on the left-hand side of the screen.
Note
The Payment tab won’t be available unless a payment has been created.
Details will be listed for all payments associated with that order.
Order Refunds¶
Note
Orders can only be refunded once at least one payment has been created for the order.
However, refund amounts are not restricted by existing payment amounts, meaning it is possible to refund more than has been actually paid.
If an order cannot be refunded, it will not be visible in the Actions dropdown menu.
Note
Once a refund has been created, it will appear as a refund line in the Order Contents tab.
To create a partial refund for a particular amount or to refund particular order line amounts:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order for which you want to create a refund.
Click Create Refund in the Actions dropdown in the admin page’s toolbar.
To create a refund for a particular line, select the matching line number from the Line number dropdown field.
When refunding a product line, a field will appear to enter the quantity, as well as whether to restock the refunded products.
Note
A separate refund line will be created if returning both a quantity and an amount for a particular line.
Click the Add More Refunds button to add additional refund forms.
Click the Create Refund to add the entered refund amounts to the order.
To create a full refund for an order:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order for which you want to create a refund.
Click Create Refund in the Actions dropdown in the admin page’s toolbar.
Click the Refund Entire Order button in the admin page’s toolbar.
Review the order and refund amount information. To restock returned products, make sure the Restock products checkbox is selected.
Click the Confirm Refund to create a refund in the full amount.
Canceling an Order¶
Note
Only unpaid and unshipped orders can be canceled.
To cancel an order:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order that you want to cancel.
Click Set Status in the order toolbar.
- Click Canceled in the dropdown menu.
The order will now be marked as canceled in the Orders admin list.
Completing an Order¶
Note
Only fully shipped orders chan be completed.
To set an order as complete:
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order you want to set complete.
Click Set Status in the order toolbar.
- Click Complete in the dropdown menu.
The order will now be marked as completed.
Printing an Order Confirmation¶
Navigate to the Orders admin page by clicking Orders under the Orders category from the Shuup Admin menu.
Select the order whose confirmation you want to print.
Click Printouts tab on the left-hand side of the screen.
- Select Get Order Confirmation HTML from the dropdown menu.
- You will now be taken to the order confirmation, which you can either print or save to your computer from your browser menu.
Customers and Users¶
Users¶
Creating a User¶
Navigate to the Users admin page by clicking Users under the Settings category from the Shuup Admin menu.
Click the New User button on the Users admin toolbar.
Enter a valid username and password for the user as well as any other user information, including the Staff User checkbox. A Staff user has the ability to login in the admin panel.
Then click the Save button in the to create the user account.
Note
Unless they have a Staff status and the Send email confirmation box is checked, a user won’t automatically receive notice that an account has been created for them.
Instead, if you would like to notify a user, send a password-reset email.
Creating a User From a Saved Contact¶
Navigate to the Contacts admin page by clicking Contacts under the Contacts category from the Shuup Admin menu.
Select the contact for which you want to create a user account.
Click the Options button on the Contact admin toolbar and select New User.
Enter the new user’s username and password information and click Save to create the user account, which will now be associated with the selected contact information.
See Creating a User for more information.
Managing User Passwords¶
Changing User Passwords¶
Navigate to the Users admin page by clicking Users under the Settings category from the Shuup Admin menu.
Select the user whose password you want to change.
Click the Actions button on the user admin toolbar and select Change Password from the dropdown menu.
Enter the current and new passwords in the Change User Password form and click Save in the toolbar to save the new password.
Sending Password-Reset Emails¶
Navigate to the Users admin page by clicking Users under the Settings category from the Shuup Admin menu.
Select the user whose password you want to change.
Click the Actions button on the user admin toolbar and select Send Password Reset Email from the dropdown menu.
On the next screen, click Send Reset Email to send the user a password reset email.
Editing User Permissions¶
Warning
Use caution when granting users administrative permissions.
Navigate to the Users admin page by clicking Users under the Settings category from the Shuup Admin menu.
Select the user whose permissions you want to edit.
Click the Actions button on the user admin toolbar and select Edit Permissions from the dropdown menu.
Check the permission levels that want to grant the user and click the Save button to save the user’s permissions.
See Permission Groups for more information on how to create and manage Permission Groups.
Deactivating a User¶
When users are deactivated, they remain in your system however they will no longer be able to log in to their account and by default are not displayed when first opening the Users admin page.
Note
If a user has an associated contact, deactivating the user’s user account will not deactivate their contact, although it will prevent them from logging in, essentially accomplishing the same thing.
See Deactivating a Contact for more information.
To deactivate a user:
Navigate to the Users admin page by clicking Users under the Settings category from the Shuup Admin menu.
Select the user you want to deactivate.
Click the Deactivate User button on the user admin toolbar.
The user will now be deactivated, and the Deactivate User button will be replaced with an Activate User button.
Note
The same steps can be followed to activate a deactivated user.
Permission Groups¶
Permission groups can be used to restrict access to different sections of the Shuup admin for staff-level users. Superusers have unrestricted access to any section.
Creating a Permission Group¶
Navigate to the Permission Groups admin page by clicking Permission Groups under the Shops category from the Shuup Admin menu.
Click the Create New Permission group button on the Permission Group admin toolbar.
Enter a name for the group, select any users that should be members of this group. You can also set the group for a user while editing it.
4. go through all the permissions sections and check the features you want to give permission.
Note
On every permission section, you will see Module permission and Features permissions. If you give the Module permission, it will tell to Shuup that the user can access the module as a whole. Users will be able to access the module through the main menu for example.
You can also give specific features permissions that will enable users to create, delete, list objects and other features that the module provides. You can give permission for the features and have the Module permission disabled at the same time. Disabling the module permission won’t interfere on the feature permission as they are complements of each other.
One example for this is when you want to allow users to create customers while they are creating an order, but you don’t want them to access the customer list through the main menu. On this case you disable the customer module permission and enable the customer edit feature permission.
The buttons Select all permissions and Deselect all permissions will check or uncheck all the permissions which can be helpful when you want to disable just a few permissions for the user.
- Click Save to save the permission group settings.
See Editing User Permissions for more information on how to set specific permissions for a single User.
Contacts¶
Shuup contacts store contact information such as address data, email, or phone numbers, and a contact may or may not be associated with a user account.
Contacts may be one of the two following types:
- Person contact
- Contact associated with a person.
- Company contact
- Contact associated with a company.
One or more person contacts may be members of a company contact.
However, if a user has a contact associated with their account, it must always be a person-type contact, which may then be a member of one or more company contacts.
If a user’s person contact is linked to a company, the company’s contact information will be used when placing orders.
Creating a Contact¶
Navigate to the Contacts admin page by clicking Contacts under the Contacts category from the Shuup Admin menu.
Click the New Person or the New Company button on the Contacts admin toolbar.
Enter all basic details for the contact, including any required fields.
Click the Save button to create the contact.
Editing a Contact¶
Navigate to the Contacts admin page by clicking Contacts under the Contacts category from the Shuup Admin menu.
Select the contact that you want to edit.
Click the Edit button in the contact admin toolbar.
Edit the user’s information.
Click the Addresses tabs on the left-hand side of the screen to enter billing and shipping address information for the contact.
Click Save to save the contact’s information.
See Creating a Contact for more information.
Editing Company Membership¶
Navigate to the Contacts admin page by clicking Contacts under the Contacts category from the Shuup Admin menu.
Select the company contact whose membership you want to edit.
Click the Edit button in the contact admin toolbar.
Under the Members field input, type the name of the person contact you wish to add to the company. When the name appears in the dropdown, click to add to the input field.
Click save to update the company’s memberships.
Creating a Contact From a User Account¶
Navigate to the Users admin page by clicking Users under the Settings category from the Shuup Admin menu.
Select the user whose permissions you want to edit.
Click the Actions button on the user admin toolbar and select Create Contact from the dropdown menu.
Fill in the user’s contact information, including any required fields, then save to create a saved contact for the user.
The contact will now be created and you will be taken to the new contact’s admin page.
Click the user’s username to go back to the user’s admin page.
Deactivating a Contact¶
When contacts are deactivated, they remain in your system however they will no longer be able to log in to their account and by default are not displayed when first opening the Contacts admin page.
Note
If a contact has an associated user, deactivating the user’s contact will not deactivate their user account, although it will prevent them from logging in, essentially accomplishing the same thing.
See Deactivating a User for more information.
To deactivate a contact:
Navigate to the Contacts admin page by clicking Contacts under the Contacts category from the Shuup Admin menu.
Select the contact you want to deactivate.
Click the Deactivate Contact button on the contact admin toolbar.
The contact will now be deactivated, and the Deactivate Contact button will be replaced with an Activate Contact button.
Note
The same steps can be followed to activate a deactivated contact.
Contact Groups¶
In Shuup, contacts can be placed into different contact groups. These groups can then be targetted for campaigns, discount pricing, or custom behaviors.
Creating a Contact Group¶
Navigate to the Contact Groups admin page by clicking Contact Groups under the Contacts category from the Shuup Admin menu.
Click the Create new button in the Contact Groups toolbar.
Select a name for your contact group.
Click the Save button to save your contact group.
Once the contact group has been saved, two new tabs will be automatically added to the group’s admin page–a Members tab and one or more Sales Range tabs.
Editing Group Membership¶
View Contact Group Membership¶
Adding a Contact¶
Navigate to the Contact Groups admin page by clicking Contact Groups under the Contacts category from the Shuup Admin menu.
Select the contact group whose membership you want to edit.
Click the Add Members tab on the left-hand side of the screen.
Click the Select Contact button on an empty row to launch the Contact selector popup.
Select the contact you want to add from the Contact popup selector.
- If there are no blank contact rows, click the Add more button to add a blank contact row.
- Repeat as necessary to add more contacts, then click Save to save the contact group.
Removing a Contact¶
Note
Contacts can only be removed from a contact group via the admin page for each contact you wish to remove.
Navigate to the Contacts admin page by clicking Contacts under the Contacts category from the Shuup Admin menu.
Select the contact that you want to remove from your group.
Click the Edit button in the contact admin toolbar.
- Find the contact group whose membership you wish to edit in the Contact Groups list, click the x button on the contact group, and click Save to update the contact’s group membership.
Creating a Sales Range¶
Contact group sales ranges can be used to automatically assign customer contacts to contact groups based on their sales totals.
This can be useful if you want to target different sales levels for special campaigns or offer special discounts or promotions.
Navigate to the Contact Groups admin page by clicking Contact Groups under the Contacts category from the Shuup Admin menu.
Select the contact group to which you want to add a sales range.
Click the (Shop Name) - Sales Ranges tab on the left-hand side of the screen, where (Shop Name) is the name of the shop to associate with the sales range.
Enter a minimum and maximum value for the group’s sales range.
Note
Leave the maximum value blank to set no maximum for the group.
Set the minimum value to 0 to set no minimum for the group.
Click Save to save the contact group sales range. Contact group membership will automatically update based on customers’ sales totals.
Tip
Try creating a contact group for customers within a sales range value and target them for special discounts and promotions.
Notifications¶
Concept¶
Shuup has a notification system that allow users to handle events triggered by the platform and execute actions for that when a set of configured conditions are met. It can be translated into this phrase: Do an action when an event is triggered if a condition is met. (e.g.: Send an email to the customer when received a new order if the user has a valid email).
Events could include:
- Orders being created
- Shipments being dispatched
- Vendors requesting registration
- Many others
Notifications may be delivered over different channels, such as email. As delivery channels are also pluggable (which requires developed addons that handles the channel), notifications are basically the Actions that will be executed by the platform.
Configuring Notifications¶
To handle a notification, go to Settings > Notifications. Click on New Script.
Select the event you want to handle and give it a name to describe what it is doing, like Send customer email on receive order and make sure Enabled checkbox is checked. Click OK.
After that you should see a blank page with a New Step button. Click on New Step button, a new row will be visible.
The script can have as many steps as you want, you can remove steps and also disable them. You can add conditions to each step to be executed, like checking whether the customer has a valid phone or email before actually sending the email/SMS.
Select the All operation next to the New condition button if you don’t want to add any condition (this will make sure the script will run every time).
To add a new condition, click on New condition button and select the desired one. A form will appear to be configured with all the parameters of the selected condition. Here is an example of Non-Empty condition:
After you configured the condition, click on New action to select how to handle the event.
Select the action type (like Send email). A new form will be rendered to fill all the parameters of the selected action.
In Send Email action, you need to fill the Recipient and the Language of the email to be sent (and other optional fields). As you may ask yourself, how can I know the email of the customer in cases you want to send an email when customer places an order? In these cases, the event will provide “variables” that can be bound to the action parameters. In the Order Received event, for example, it provides a Customer Email variable you can use in the Recipient, so it will use the email that customer entered when placing the order. Each event can provide a different set of variables that can be used in the script.
Some actions may request text contents as parameters. This is the case of Send Email event which requires the merchant to fill the email subject and email body to send to the configured recipient. To configure the email template, click on the language tab and fill the subject and body fields of the email. You may notice a list of variables on the right side. Those strings are special words (variables) that can be used in the email subject or body and they will be replaced by the value it describes when generating the email to be sent.
Make sure to save the email parameters by clicking on Save Changes button and then click on Done button. Save the entire script by clicking Save and the notification is completely configured.
Campaigns¶
Shuup e-commerce platform comes built in with customized and easily extendable campaign management system. Shuup’s modular campaign management structure allows extending the feature to most innovative campaign models and even integrations.
Creating a Campaign¶
- Navigate to the Basket Campaigns admin page by clicking Basket Campaigns under the Campaigns category from the Shuup Admin menu.
- Click the Create a new Basket Campaign button in the admin page toolbar.
Enter general information regarding the campaign, such as the name, public name, basket line text, start/end dates, and any coupons to be associated with the campaign.
Field Use Mandatory Name Name of the campaign (not visible on the shop front-end) Yes Public name Public name of the campaign to be presented in the shop front-end, when the campaign name is displayed Yes Shop Shop selector for multi-shop setup. Shop where the campaign is active Yes Start date and time Setting start date for the campaign using date picker No End date and time Setting end date for the campaign using date picker No Note
If no start date is provided, it will take effect immediately.
If no campaign end date is provided, the campaign will stay in effect indefinitely.
Click Save to create the campaign. Once a campaign has been saved, rules and effects can be added to define its behavior.
Tip
Try setting up a cross-selling basket campaign by offering a discount on one product when a customer purchases a related product.
Rules and Effects¶
Whether or not a campaign be applied to a particular order and how it will be applied depends on its Rules and Effects.
- Rules
- The conditions or criteria that an order must meet before a campaign will be applied. Different rules will be available depending on whether they are being applied to a basket campaign or a catalog campaign.
- Effects
- If a customer’s order meets the requirements of all of the campaign’s rules, any enabled effects will be applied to their order. These are usually discounts applied to the order, such as discounts on the total basket value, discounted or free quantities of a particular product, or other various types of discounts.
- Coupons
- Used to limit usage of a basket campaign to only holders of a valid coupon code.
Adding Rules and Effects¶
Once a campaign has been created, Rules and Effects can be added from the campaign’s admin page.
To add rules and effects:
Click the Rules or Effects tab on the left-hand side of the screen.
Select the rule or effect type from the dropdown menu and click the Add rule or Add effect button below to add a new rule or effect form.
Enter any required values in the rule or effect form, and click Save to attach the rules or effects to the campaign.
Rules¶
The following rules are available to campaigns:
- Basket product count
- Limit to baskets containing at least the specific number of products
- Basket maximum product count
- Limit to baskets containing at most the specific number of products
- Basket total value
- Limit to baskets containing at least the specified total amount
- Undiscounted basket total value
- Limit the campaign to match when it has at least the total value entered here worth of products which doesn’t already have discounts
- Basket maximum total value
- Limit to baskets containing at most the specified total amount
- Products in basket
Limit to baskets containing a certain quantity of the selected product(s)
Note
This rule applies if a basket contains any of the selected products (i.e., a certain amount of product A or a certain amount of product B).
In order to require product A and product B, create a separate rule for product A and product B.
- Contact Group
- Limit to customers belonging to a specific contact group
- Contact
- Limit to selected customer contacts
- Category products in basket
- Limit the campaign to match the products from selected categories
- Day and hour
- Limit the campaign to selected days
Basket Effects¶
Campaign Effects¶
Creating a Coupon Code¶
- Navigate to the Coupons admin page by clicking Coupons under the Campaigns category from the Shuup Admin menu.
- Click Create new Coupon button in the admin page toolbar.
- Either type the desired coupon code you want your customers to enter or click the Generate button to randomly generate a coupon code.
- Enter general information regarding the coupon, such as the usage limit per customer and the over usage limit (or total number of redeemable coupon codes).
Tip
As coupon codes are redeemed through the store, the total number of used coupon codes will be visible through the coupon’s admin page.
Carts¶
When a customer adds a product to their cart, the system created a cart object which is visible from the admin menu by navigating to Orders > Carts.
There you can see a table rendering all the carts ever made by customers. It contains data like the date and time it was created and updated, whether or not it was abandoned, the shop and the product count.
The filter button on the top right corner allows you to filter out carts according to each table column.
Update the Cart Inactivity Delay¶
By default, carts will not be rendered in the table unless they have been inactive for the past 2 hours. It is possible to change the delay of inactivity before the cart is rendered in the Carts table.
- Navigate to the Shops menu by clicking Shops in the Shops category.
- Click on the shop for which you want to add a delay.
- Click the Cart Inactivity Delay tab on the left-hand side of the screen.
- Input the number of hours the cart has to be inactive for before being added to the Carts table. If the number is 0, the carts will be rendered immediately.
- Click Save.