OmniCart Documentation

Introduction
OmniCart is a highly customizable multi or single vendor marketplace platform that has a clean and efficient
codebase, and makes it extremely easy to set up your own store to start selling your products online.

Before Installation
Upload all the project files outside of your public directory, and only upload the content of 'public' to your public
directory.
When you're done, navigate to https://yourwebpage.com/install to begin the installation process.

Installation

System Checks
Checks the minimum system requirements. Just press 'Continue' if all checks out.

What's your application's name?

Give a name for your application (this will show up in revelant places, like title meta tag for example).
Besides this, you also need to specify what's going to be the default language, and the default currency. Note, that
these will not limit you to this language and currency, they will just be handled as the base.

Base Url
Set your base url, that your website will be reachable at, for ex. https://yourwebpage.com.

Administrator Account
This will be your administrative account for the website. Make sure you use a strong password.

Database Connection Details

Set up the database connection for omnicart.

How would you like to use the platform?

Here you have the option to choose if you would like to start an ecommerce, or a multivendor marketplace
platform.
The reason for this step, is to simply make it easier to start with the desired setup. You can later change this in the
control panel.

Review & Install

That's all. Make sure you review your settings, and begin Installation.
After successful installation, make sure to remove the 'install' folder, and set up the cronjob, by entering the
following in your crontab settings (make sure to replace '/path/to/project' with your project root path):
* * * * * cd /path/to/project && php spark cronjob:run

Setup
General
General Settings > App Settings > General
l Default Language: Defines the base language of your site
l Default Product Currency: The main currency that will be used
l App Name: Defines your site·s name, which is used in specific locations
l Logo: The logo that will be used on your site and emails
l Favicon: The site·s icon
l Enable RSS: If you would like to serve RSS of your products and blog posts
l Copyright Text: The copyright text, which will appear on the bottom of your site

Contact Information
General Settings > App Settings > Contact Details
l These details mostly show up on the contact page and invoices.
l Contact Address: This also shows up on the map on the contact page
l Contact Email: The email address where people can contact you
l Business Name: This is important for the invoices
l TIN: Shows up on the invoices as well
l Contact Text: Shows up on the contact page
l Contact Phone: Shows up on the contact page as well

Social Media
General Settings > App Settings > Social Media
Here you can add your social media urls, which will show up in the footer of your site.

Cookies Consent
General Settings > App Settings > Cookies Consent
To make sure you·re GDPR compliant, you need to enable the GDPR cookie consent, that people can opt out from.
The given text will show up in the cookie consent popup. If the user chooses to opt out, and you have google
analytics enabled, this would be blocked.

Shipping
1 Fulfillment done by vendors (Check General Settings > Preferences > Fulfillment Done By
Vendors)

If this is checked, then every vendor can set their own shipping options, and will be in control of their shipping
prices
1 Fulfillment done by admin (Uncheck General Settings > Preferences > Fulfillment Done By
Vendors)

If unchecked, then vendors will not have control over the shipping options, and all setup will be done by admin
To set up the Shipping Options, go to ·Shipping·, and ·Add Shipping Option·
l Carrier: Choose a carrier that the shipping option is meant for
l Country: The country that the shipping option applies to (you can set up different ones for each
country). If left blank, will count as global.
l State: The state that the shipping option applies to (you can set up different ones for each state). If
 left blank, will count as for the whole country.
l Delivery Time: Just a textual representation of the delivery time.
l Cost/Weight: How much does it cost for every x grams
l Cash On Delivery Cost/Weight: How much does it cost for every x grams if cash on delivery was
selected

Note: Create as many shipping options as you wish, and the platform will automatically do the calculation based on
the location of the buyer and the total weight of the products.

Payment
In the ·Payment Settings· you can configure your payment methods.
For each payment methods you have the following options:
Enable/Disable
Enable/Disable for guests
Display Text: How will the payment method show up
Description Text: You can display additional information for the payment method
For the integrated payment methods you have the following additional information:
Live/Sandbox Mode
Client ID or a similar field that can be found at the payment gateway·s settings
Secret or a similar field that can be found at the payment gateway·s settings

Email
General Settings > App Settings > Email
Mail Protocol to be used by the library
Mail Host that will handle the mailing
Mail Port where the mail host will be listening for the connection
Lastly your Mail Username and your Mail Password
One common service people might want to use for mailing is the Gmail SMTP service. In this case here·s how you
would set this up:
1 Setting up the mail library

Mail Protocol: smtp

Mail Host: smtp.gmail.com
Mail Port: 587

1 Allow less secure devices from this url: https://myaccount.google.com/lesssecureapps

2 Go to your gmail account, and in your settings, go to ·Forwarding and POP/IMAP·
3 Select ·Enable IMAP· and save your settings.

Language
To add additional languages available for your site, on the ·Language· page you can enable/disable additional
languages (RTL is automatically detected)
Currencies
You can most likely skip this part. But in case you would like to modify some values for your currency, you can do
so here.

Theme
You can change your theme under the ·Themes· page.

Maintenance
You can easily put your site under Maintenance Mode under General Settings > Maintenance

Marketplace Specific
General Settings > Preferences
l Enable Marketplace: To enable/disable the marketplace and use the site as an ecommerce site.
l Enable Product Approval: If you would like to approve the products uploaded by the vendors before
they are made available publicly.
l Enable Vendor Approval: If you would like to approve vendors before they can add products and
sell on your website.
l Enable Registrations: You can completely disable user registrations if this is disabled.
l Online Sale: You can disable the cart functionality, and use the site as classified ads through this
option.
l Commission Type: If you would like to set the commission based on percentage of fixed value.
l Commission: The commission amount that will be calculated on each sale.

Pagination Setup
General Settings > Preferences
l Additionally you can also control the following items number that show up on one page:
l Products Per Page
l Blog Posts Per Page
l Product Reviews Per Page
l Shop Reviews Per Page
l User Reviews Per Page
l Blog Post Comments Per Page
l Product Q&A Per Page
l Nr of Related Products

Widgets
Widgets are special blocks in the theme that you can easily update
There are 4 types of widgets available:
l Navbar: Customize your navigation bar·s menu items
l Slider: Change the content of the slider
l Link List: Shows up in the footer, and you can add any links here
l Html: Just a html block that also shows up in the footer for the ·default· theme

Content
Products
Before you can add new products, create at least one category under ·Products > Categories·
After creating your product category(s), you can go ahead to ·Products > Products·, and ·Add Product·.
Here you can set the ·Title·, upload/reorder/delete the product images. (The 1st image is always the main image).
Sale Price defines the selling price
Regular Price defines a higher price than the selling price, which results in a discount that is shown on the website.
Quantity defines how many you have on stock
Category in which the product will show up.
The description of the product that will show up in the ·Description· tab under the product.
Each product can contain multiple tags that describe the product, and later on products can be found by tags.
The above fields are the main fields, but there are some additional things you can set:
Attributes:
These can be defined under ·Products > Attributes· and must be tied to categories under ·Products > Categories >
Edit Category > Attributes·
The attributes show up in the ·Specification· tab, under the product.
Variations:
You can set product variations based on the attributes.
For ex. Let·s say you have an attribute named ·Color·, and the product·s ·Color· attribute contains ·Red· and ·Green·.
Under the ·Variation Attributes· you can specify that you would like to use the ·Color· attribute for variations, and
the system will automatically generate the variations based on the available attributes.
You can specify individual price and quantity for each variation. By default if left empty, will use the main product·s
price and quantity
Note: If variables are enabled, then an additional button will show up on the images, by which you can assign each
image to any of the attributes set for the product.
Shipping:
You can set information related to shipping here. Currently this is where you can set the weight of the product,
which will be used to calculate the shipping price based on the shipping options.
Inventory:
You can set the product·s SKU here, but will be automatically generated if left empty.
Each product can have Reviews and Questions/Answers that can be controlled from ·General Settings > Reviews &
Comments· by ·Enable Product Reviews·, ·Product Review Approval Enabled·, ·Enable Product
Questions/Answers·, ·Product Questions/Answers Approval Enabled·.
Additionally you can also set watermark for the product images under ·General Settings > Watermark·.
Pages
Under the ·Pages· page, you can see all your custom pages, create new ones, and edit existing ones. These pages can
be exposed through the widgets.
Blog Posts
Before you can create Blog Posts, you need to create at least one Blog Category under ·Blog > Categories·
After you have your first blog category, you can go ahead and create your first Blog Post under ·Blog > Posts·
You also have the chance to see all the comments under ·Blog > Comments·.
To enable/disable comments, go to ·General Settings > Reviews & Comments· and set ·Enable Blog Comments·
To enable/disable comments approval, go to ·General Settings > Reviews & Comments· and set ·Blog Comment
Approval Enabled·

Logging

Email Logs
Every sent out email through the site is logged here, so you have the chance to track exactly what emails have been
sent out, and what do they look like.

Exception Logs
Every exception is logged here, therefore if something went wrong for someone, you will be able to notice it here. In
this case please contact support for help.

System

Backups
You can back up your database anytime you would like to at a click of a button, and restore if need to do so. This is
a destructive operation, so be careful how you use it.

Update
If an update comes out for OmniCart, then you can easily update your system, and get the latest improvements.