Skip to content

Commit 9521b78

Browse files
jssql1234yam425chengwen0331GohKoonLoongWANRUIYIN-287456
authored
feat: add documentation for x-store (#80)
* feat: init estore files and category * feat: add xstore setup and link stores guide * fix: update xstore stores and setup images to the latest images * feat: add xstore inventory guide * fix: update inventory images to latest images * feat: add xstore login guide * feat: add xstore payment guide * feat: add images for xstore login and payment guide * feat: add xstore sidemenu & dashboard guide * feat: add xstore settings guide * fix: update xstore settings images to the latest images * feat: add xstore order documentation * fix: changed order image to latest image, fix false content in order and order details * fix: fix dashboard and side menu image path from estore to xstore * fix: fix grammar mistake in x-store * feat(oms): slightly refine wording * fix: change slugs, tags and formatting * fix: remove comments * fix: to kebab case and heading issue * fix: update x-store order's image name to kebab case * fix: remove FAQ from x-store login and payments * fix: update x-store setup and store's image name to kebab case * fix: to kebab case * update: update sidebar position * fix: remove 'Page' from the heading * fix: minor changes on content and added new a image * fix: minor changes on heading and add images * fix: update image and remove html tag * update: update heading naming * fix: fix markdown syntax for login and payments modules * update(dashboard): simplified wording, add more images * fix: remove info banner for getting-started * update(sidemenu): replace image * update: reorder sidebar position * fix: to kebab case --------- Co-authored-by: yam425 <maymaytan0729@gmail.com> Co-authored-by: chengwenn <ch3ngw3n0331@gmail.com> Co-authored-by: Goh Koon Loong <gohkoonloong01@gmail.com> Co-authored-by: WAN RUI YIN <92418711+WANRUIYIN-287456@users.noreply.github.com> Co-authored-by: ikuyaz <zhenseng01@gmail.com> Co-authored-by: dingwei426 <dingwei11111@gmail.com> Co-authored-by: vkloo2010 <vkloo2010@gmail.com> Co-authored-by: Yeu Han <Yeuhanlaw@gmail.com>
1 parent 6d3434f commit 9521b78

186 files changed

Lines changed: 1501 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "X-Store",
3+
"link": {
4+
"type": "generated-index",
5+
"slug": "/integration/x-store-category",
6+
"description": "Omnichannel commerce platform and integrations"
7+
}
8+
}
Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
sidebar_position: 4
3+
title: Dashboard
4+
description: A guide on Dashboard
5+
slug: /integration/xstore/dashboard
6+
tags: ["e-Commerce", "X-Store", "Dashboard"]
7+
---
8+
9+
## Dashboard Overview
10+
11+
The **Dashboard** is the main page where you can see how your stores are doing. It shows you latest information on sales, orders, stock, and if your stores are connected properly.
12+
13+
### Date Filter
14+
15+
![date-filter](../../../static/img/xstore/dashboard/dashboard-1.png)
16+
17+
Pick a time period to see its data. You can choose:
18+
19+
- **Today**
20+
- **Last 3 Days**
21+
- **Last 7 Days**
22+
- **Last 1 Month**
23+
- **Last 2 Months**
24+
- **Last 3 Months** (Default view)
25+
26+
### Choose What to See
27+
28+
![choose-what-to-see](../../../static/img/xstore/dashboard/dashboard-6.png)
29+
30+
Pick what kind of numbers you want to see:
31+
32+
- **Amount**: Show the total money from sales for that time.
33+
- **Total**: Show the total number of sales for that time.
34+
35+
### Chart Types
36+
37+
![chart-types](../../../static/img/xstore/dashboard/dashboard-7.png)
38+
39+
Choose how you want the numbers to look:
40+
41+
- **Bar Chart**: Shows numbers as vertical bars to compare different times.
42+
- **Line Chart**: Shows a line to see if sales are going up or down.
43+
- **Pie Chart**: Shows a circle divided into parts to see which time had more sales.
44+
- **Table**: Shows exact numbers in a list.
45+
46+
## Payments Section
47+
48+
This part shows you the money side of your business.
49+
50+
![payments-section](../../../static/img/xstore/dashboard/dashboard-2.png)
51+
52+
### Main Numbers
53+
54+
- **Total Transactions**: Total number of payments received.
55+
- **Total Transaction Amounts**: Total amount of money from all payments.
56+
- **Avg Amount per Transaction**: The average money made from one sale.
57+
58+
### Payment Chart
59+
60+
A picture showing your payment trends. You can change how it looks using the buttons on the top-right.
61+
62+
**Group by Time**
63+
64+
![group-by-time](../../../static/img/xstore/dashboard/dashboard-8.png)
65+
66+
Choose how to bundle your payment data:
67+
68+
- **Day**: See total money for each day.
69+
- **Week**: See total money for each week.
70+
- **Month**: See total money for each month.
71+
72+
> **Tip**: Try different chart types with different time groups. For example, use a line chart with "Day" to see small changes, or a bar chart with "Month" to see how you did over several months.
73+
74+
## Orders Section
75+
76+
This part shows you how many orders you have and where they come from.
77+
78+
![orders-section](../../../static/img/xstore/dashboard/dashboard-3.png)
79+
80+
### Order Numbers
81+
82+
- **Total Orders**: The total number of orders you have received.
83+
- **To Ship**: How many orders are waiting for you to send out.
84+
- **Orders Today**: How many orders you got today.
85+
86+
87+
### Order Details
88+
89+
![order-details](../../../static/img/xstore/dashboard/dashboard-10.png)
90+
91+
- **Orders by Store**: Shows which individual store (like a specific Lazada or Shopee store) is getting orders.
92+
- **Orders by Status**: Shows all orders status from all the stores.
93+
- **Orders by Region**: Shows which country or area the orders are coming from (like MY or SG).
94+
- **Orders by Platform**: Compare how many orders come from Lazada vs Shopee vs other sites.
95+
96+
![orders-chart](../../../static/img/xstore/dashboard/dashboard-13.png)
97+
98+
- **Orders Chart**: A line or bar showing if you are getting more or fewer orders over time.
99+
100+
## Products Section
101+
102+
Check your stock and how well your items are selling.
103+
104+
![products-section](../../../static/img/xstore/dashboard/dashboard-4.png)
105+
106+
### Stock Numbers
107+
108+
- **Total Products**: How many different types of items you sell.
109+
- **Total Stock Items**: The total count of all items you have ready to sell.
110+
- **Total Variants**: The count of different choices for items (like different sizes or colors).
111+
- **Total Mapped Products**: How many items are correctly linked between your online store and SQL Account.
112+
113+
### Product Info
114+
115+
![product-info](../../../static/img/xstore/dashboard/dashboard-11.png)
116+
117+
- **Top Selling Products**: A list of your most popular items.
118+
- **Top Returned Products**: Items that customers send back most often. This helps you find problems with certain products.
119+
120+
## Stores Section
121+
122+
Manage your different selling channels.
123+
124+
![stores-section](../../../static/img/xstore/dashboard/dashboard-5.png)
125+
126+
### Store Numbers
127+
128+
- **Total Stores**: The total number of online stores you have connected.
129+
- **Active Stores**: How many stores are currently working and sharing data.
130+
131+
### Store Locations
132+
133+
![store-locations](../../../static/img/xstore/dashboard/dashboard-12.png)
134+
135+
- **Stores by Platform**: Shows how many stores you have for Lazada, Shopee, or TikTok and more.
136+
- **Stores by Region**: Shows where your stores are located (like MY, SG, and more).
Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
sidebar_position: 1
3+
title: Getting Started
4+
description: A guide to getting started
5+
slug: /integration/xstore/getting-started
6+
tags: ["e-Commerce", "X-Store", "Getting Started"]
7+
---
8+
9+
## Sign In
10+
11+
If you already have an account, you can [sign in](https://x-store-demo.sql.com.my/login) using one of the following methods:
12+
13+
- **Sign in with Passkey** - Use your registered passkey for quick and secure access
14+
- **Sign in with Email** - Enter your email address and click the verification link to sign in
15+
- **Google Single Sign-On (SSO)** - Sign in with your Google account (Gmail only). Click the Google button, select your Gmail account, and you'll be signed in automatically.
16+
17+
For detailed instructions, please refer to the [sign up section](#sign-up) below.
18+
19+
![login-overview](../../../static/img/xstore/getting-started/login-overview.png)
20+
21+
## Sign Up
22+
23+
If you don't have an account yet, click [sign up here](https://x-store-demo.sql.com.my/register) to create a new account.
24+
25+
### Sign Up with Passkey
26+
27+
Passkeys provide a secure, passwordless way to access your account.
28+
29+
1. Click **Sign up here** on the sign-in page
30+
31+
![signup-overview](../../../static/img/xstore/getting-started/signup-overview.png)
32+
33+
2. Select **Sign up with Passkey**
34+
35+
![passkey-overview](../../../static/img/xstore/getting-started/passkey-overview.png)
36+
37+
3. Enter your **User Name** and **Passkey Name**
38+
39+
:::info
40+
This passkey name will be displayed on your phone as an option during authentication.
41+
:::
42+
43+
4. Click **Sign Up**
44+
45+
![passkey-form](../../../static/img/xstore/getting-started/passkey-form.png)
46+
47+
5. Choose the option:
48+
49+
- iPhone, iPad, or Android device
50+
51+
![passkey-option](../../../static/img/xstore/getting-started/passkey-option.png)
52+
53+
6. Use your smartphone to scan the QR code displayed
54+
55+
:::info
56+
Ensure both **Bluetooth** and **WiFi/Mobile data** are turned on for both your laptop and smartphone.
57+
:::
58+
59+
![passkey-creation](../../../static/img/xstore/getting-started/passkey-creation.png)
60+
61+
7. Complete the passkey registration on your device
62+
63+
8. Once successful, you'll be redirected to the **Company List** page
64+
65+
### Sign Up with Email
66+
67+
For email-based registration:
68+
69+
1. Click **Sign up here** on the sign-in page
70+
71+
![signup-overview](../../../static/img/xstore/getting-started/signup-overview.png)
72+
73+
2. Select **Sign up with Email**
74+
75+
![email-overview](../../../static/img/xstore/getting-started/email-overview.png)
76+
77+
3. Enter your **Name** and **valid email address**
78+
79+
4. Click **Sign Up**
80+
81+
![email-form](../../../static/img/xstore/getting-started/email-form.png)
82+
83+
5. Check your email inbox for a verification link
84+
85+
:::info
86+
The verification link expires in 2 minutes.
87+
:::
88+
89+
![email-action](../../../static/img/xstore/getting-started/email-action.png)
90+
91+
6. Click the **verification link** in the email
92+
93+
![email-link](../../../static/img/xstore/getting-started/email-link.png)
94+
95+
7. Your account is now successfully created
96+
97+
![email-verification](../../../static/img/xstore/getting-started/email-verification.png)
98+
99+
8. Once successful, you'll be redirected to the **Company List** page
100+
101+
## Try Demo
102+
103+
Feel free to explore the available features in X-Store by using **Try Demo** without signing in.
104+
105+
![demo-overview](../../../static/img/xstore/getting-started/demo-overview.png)
106+
107+
## Company List Page
108+
109+
After successful sign-in or sign-up, you'll land on the **Company List** page.
110+
111+
Here you can:
112+
113+
- View all companies you've created
114+
- View companies you've joined
115+
- Create a new company
116+
117+
![company-overview](../../../static/img/xstore/getting-started/company-overview.png)
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
sidebar_position: 6
3+
title: Inventory
4+
description: A guide on inventory
5+
slug: /integration/xstore/inventory
6+
tags: ["e-Commerce", "X-Store", "Inventory"]
7+
---
8+
9+
## Products
10+
11+
### Map Products
12+
13+
1. Go to **Inventory > Products**
14+
15+
![product-overview](../../../static/img/xstore/inventory/product-overview.png)
16+
17+
2. Click the **Map Product Button** to open the **Map Product Dialog**
18+
19+
![map-product](../../../static/img/xstore/inventory/map-product.png)
20+
21+
![map-dialog-overview](../../../static/img/xstore/inventory/map-dialog-overview.png)
22+
23+
:::info
24+
Use the **Filter Button** to narrow your **Platform Products View**, or use the **Search Bar** to find specific e-commerce products and stock items.
25+
:::
26+
27+
3. Select e-commerce products synced from various platforms and then a stock item synced from SQL Account to map them together
28+
29+
![mapping-product-1](../../../static/img/xstore/inventory/mapping-product-1.png)
30+
31+
:::info
32+
**e-commerce Products** are mapped to **Stock Item UOM**.
33+
:::
34+
35+
4. To unmap products, select them and click **Unmap**
36+
37+
![unmap-product-1](../../../static/img/xstore/inventory/unmap-product-1.png)
38+
39+
![unmap-product-2](../../../static/img/xstore/inventory/unmap-product-2.png)
40+
41+
## Stocks
42+
43+
### Map Products to Specific Stock Items
44+
45+
1. Go to **Inventory > Stocks**
46+
47+
![stock-overview](../../../static/img/xstore/inventory/stock-overview.png)
48+
49+
2. Click the icon to view stock details
50+
51+
![view-stock-detail](../../../static/img/xstore/inventory/view-stock-detail.png)
52+
53+
:::info
54+
- **Map Product** can be performed here as well
55+
- **Location Description** and **Code** are fetched from SQL Account
56+
:::
57+
58+
3. Click the **+** icon to open the **Map Product Dialog**
59+
60+
![stock-detail](../../../static/img/xstore/inventory/stock-detail.png)
61+
62+
4. Select the **Platform Product** and click **Map Product** to map it directly to this **Stock Item UOM**
63+
64+
![map-selective-uom](../../../static/img/xstore/inventory/map-selective-uom.png)
65+
66+
:::info
67+
Ensure your store is mapped to the correct stock item location, or mapped items won't appear.
68+
:::
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "Order",
3+
"position": 7,
4+
"link": {
5+
"type": "generated-index",
6+
"slug": "/integration/x-store/orders-category",
7+
"description": "A guide on Order module"
8+
}
9+
}

0 commit comments

Comments
 (0)