Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
9845729
feat: init estore files and category
yam425 Dec 2, 2025
8eae818
feat: add xstore setup and link stores guide
chengwen0331 Dec 4, 2025
7dd40bd
fix: update xstore stores and setup images to the latest images
chengwen0331 Dec 16, 2025
cc005d4
feat: add xstore inventory guide
GohKoonLoong Dec 6, 2025
3d22548
fix: update inventory images to latest images
GohKoonLoong Dec 16, 2025
9cc4d26
feat: add xstore login guide
WANRUIYIN-287456 Dec 2, 2025
23822a2
feat: add xstore payment guide
WANRUIYIN-287456 Dec 3, 2025
f9b7ca6
feat: add images for xstore login and payment guide
WANRUIYIN-287456 Dec 6, 2025
880e979
feat: add xstore sidemenu & dashboard guide
Ikuyaz Dec 8, 2025
2aa6391
feat: add xstore settings guide
dingwei426 Dec 8, 2025
0940ac1
fix: update xstore settings images to the latest images
dingwei426 Dec 16, 2025
aedc6ce
feat: add xstore order documentation
vkloo2010 Dec 8, 2025
74670be
fix: changed order image to latest image, fix false content in order …
vkloo2010 Dec 16, 2025
a2a6eb5
fix: fix dashboard and side menu image path from estore to xstore
yam425 Dec 16, 2025
06b7f8a
fix: fix grammar mistake in x-store
yam425 Jan 2, 2026
5d56a0d
feat(oms): slightly refine wording
LawYeuHan Jan 2, 2026
a2febbf
fix: change slugs, tags and formatting
jssql1234 Jan 5, 2026
74697fb
fix: remove comments
GohKoonLoong Jan 7, 2026
aa21661
fix: to kebab case and heading issue
Ikuyaz Jan 7, 2026
d1ab9ca
fix: update x-store order's image name to kebab case
vkloo2010 Jan 7, 2026
27071dc
fix: remove FAQ from x-store login and payments
WANRUIYIN-287456 Jan 7, 2026
c67d7f3
fix: update x-store setup and store's image name to kebab case
chengwen0331 Jan 8, 2026
b2170c7
fix: to kebab case
dingwei426 Jan 8, 2026
91e8981
update: update sidebar position
yam425 Jan 9, 2026
4506cb9
fix: remove 'Page' from the heading
GohKoonLoong Jan 9, 2026
d4a293c
fix: minor changes on content and added new a image
vkloo2010 Jan 9, 2026
129d4c9
fix: minor changes on heading and add images
chengwen0331 Jan 9, 2026
755aeee
fix: update image and remove html tag
chengwen0331 Jan 10, 2026
75d79ae
update: update heading naming
WANRUIYIN-287456 Jan 9, 2026
4a9848f
fix: fix markdown syntax for login and payments modules
WANRUIYIN-287456 Jan 10, 2026
499fbcc
update(dashboard): simplified wording, add more images
Ikuyaz Jan 9, 2026
2811b6f
fix: remove info banner for getting-started
WANRUIYIN-287456 Jan 12, 2026
607fcf1
update(sidemenu): replace image
Ikuyaz Jan 12, 2026
58e46ec
update: reorder sidebar position
yam425 Jan 12, 2026
07a418b
fix: to kebab case
Ikuyaz Jan 13, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/integration/xstore/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "X-Store",
"link": {
"type": "generated-index",
"slug": "/integration/x-store-category",
"description": "Omnichannel commerce platform and integrations"
}
}
136 changes: 136 additions & 0 deletions docs/integration/xstore/dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
sidebar_position: 4
title: Dashboard
description: A guide on Dashboard
slug: /integration/xstore/dashboard
tags: ["e-Commerce", "X-Store", "Dashboard"]
---

## Dashboard Overview

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.

### Date Filter

![date-filter](../../../static/img/xstore/dashboard/dashboard-1.png)

Pick a time period to see its data. You can choose:

- **Today**
- **Last 3 Days**
- **Last 7 Days**
- **Last 1 Month**
- **Last 2 Months**
- **Last 3 Months** (Default view)

### Choose What to See

![choose-what-to-see](../../../static/img/xstore/dashboard/dashboard-6.png)

Pick what kind of numbers you want to see:

- **Amount**: Show the total money from sales for that time.
- **Total**: Show the total number of sales for that time.

### Chart Types

![chart-types](../../../static/img/xstore/dashboard/dashboard-7.png)

Choose how you want the numbers to look:

- **Bar Chart**: Shows numbers as vertical bars to compare different times.
- **Line Chart**: Shows a line to see if sales are going up or down.
- **Pie Chart**: Shows a circle divided into parts to see which time had more sales.
- **Table**: Shows exact numbers in a list.

## Payments Section

This part shows you the money side of your business.

![payments-section](../../../static/img/xstore/dashboard/dashboard-2.png)

### Main Numbers

- **Total Transactions**: Total number of payments received.
- **Total Transaction Amounts**: Total amount of money from all payments.
- **Avg Amount per Transaction**: The average money made from one sale.

### Payment Chart

A picture showing your payment trends. You can change how it looks using the buttons on the top-right.

**Group by Time**

![group-by-time](../../../static/img/xstore/dashboard/dashboard-8.png)

Choose how to bundle your payment data:

- **Day**: See total money for each day.
- **Week**: See total money for each week.
- **Month**: See total money for each month.

> **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.

## Orders Section

This part shows you how many orders you have and where they come from.

![orders-section](../../../static/img/xstore/dashboard/dashboard-3.png)

### Order Numbers

- **Total Orders**: The total number of orders you have received.
- **To Ship**: How many orders are waiting for you to send out.
- **Orders Today**: How many orders you got today.


### Order Details

![order-details](../../../static/img/xstore/dashboard/dashboard-10.png)

- **Orders by Store**: Shows which individual store (like a specific Lazada or Shopee store) is getting orders.
- **Orders by Status**: Shows all orders status from all the stores.
- **Orders by Region**: Shows which country or area the orders are coming from (like MY or SG).
- **Orders by Platform**: Compare how many orders come from Lazada vs Shopee vs other sites.

![orders-chart](../../../static/img/xstore/dashboard/dashboard-13.png)

- **Orders Chart**: A line or bar showing if you are getting more or fewer orders over time.

## Products Section

Check your stock and how well your items are selling.

![products-section](../../../static/img/xstore/dashboard/dashboard-4.png)

### Stock Numbers

- **Total Products**: How many different types of items you sell.
- **Total Stock Items**: The total count of all items you have ready to sell.
- **Total Variants**: The count of different choices for items (like different sizes or colors).
- **Total Mapped Products**: How many items are correctly linked between your online store and SQL Account.

### Product Info

![product-info](../../../static/img/xstore/dashboard/dashboard-11.png)

- **Top Selling Products**: A list of your most popular items.
- **Top Returned Products**: Items that customers send back most often. This helps you find problems with certain products.

## Stores Section

Manage your different selling channels.

![stores-section](../../../static/img/xstore/dashboard/dashboard-5.png)

### Store Numbers

- **Total Stores**: The total number of online stores you have connected.
- **Active Stores**: How many stores are currently working and sharing data.

### Store Locations

![store-locations](../../../static/img/xstore/dashboard/dashboard-12.png)

- **Stores by Platform**: Shows how many stores you have for Lazada, Shopee, or TikTok and more.
- **Stores by Region**: Shows where your stores are located (like MY, SG, and more).
117 changes: 117 additions & 0 deletions docs/integration/xstore/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
sidebar_position: 1
title: Getting Started
description: A guide to getting started
slug: /integration/xstore/getting-started
tags: ["e-Commerce", "X-Store", "Getting Started"]
---

## Sign In

If you already have an account, you can [sign in](https://x-store-demo.sql.com.my/login) using one of the following methods:

- **Sign in with Passkey** - Use your registered passkey for quick and secure access
- **Sign in with Email** - Enter your email address and click the verification link to sign in
- **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.

For detailed instructions, please refer to the [sign up section](#sign-up) below.

![login-overview](../../../static/img/xstore/getting-started/login-overview.png)

## Sign Up

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.

### Sign Up with Passkey

Passkeys provide a secure, passwordless way to access your account.

1. Click **Sign up here** on the sign-in page

![signup-overview](../../../static/img/xstore/getting-started/signup-overview.png)

2. Select **Sign up with Passkey**

![passkey-overview](../../../static/img/xstore/getting-started/passkey-overview.png)

3. Enter your **User Name** and **Passkey Name**

:::info
This passkey name will be displayed on your phone as an option during authentication.
:::

4. Click **Sign Up**

![passkey-form](../../../static/img/xstore/getting-started/passkey-form.png)

5. Choose the option:

- iPhone, iPad, or Android device

![passkey-option](../../../static/img/xstore/getting-started/passkey-option.png)

6. Use your smartphone to scan the QR code displayed

:::info
Ensure both **Bluetooth** and **WiFi/Mobile data** are turned on for both your laptop and smartphone.
:::

![passkey-creation](../../../static/img/xstore/getting-started/passkey-creation.png)

7. Complete the passkey registration on your device

8. Once successful, you'll be redirected to the **Company List** page

### Sign Up with Email

For email-based registration:

1. Click **Sign up here** on the sign-in page

![signup-overview](../../../static/img/xstore/getting-started/signup-overview.png)

2. Select **Sign up with Email**

![email-overview](../../../static/img/xstore/getting-started/email-overview.png)

3. Enter your **Name** and **valid email address**

4. Click **Sign Up**

![email-form](../../../static/img/xstore/getting-started/email-form.png)

5. Check your email inbox for a verification link

:::info
The verification link expires in 2 minutes.
:::

![email-action](../../../static/img/xstore/getting-started/email-action.png)

6. Click the **verification link** in the email

![email-link](../../../static/img/xstore/getting-started/email-link.png)

7. Your account is now successfully created

![email-verification](../../../static/img/xstore/getting-started/email-verification.png)

8. Once successful, you'll be redirected to the **Company List** page

## Try Demo

Feel free to explore the available features in X-Store by using **Try Demo** without signing in.

![demo-overview](../../../static/img/xstore/getting-started/demo-overview.png)

## Company List Page

After successful sign-in or sign-up, you'll land on the **Company List** page.

Here you can:

- View all companies you've created
- View companies you've joined
- Create a new company

![company-overview](../../../static/img/xstore/getting-started/company-overview.png)
68 changes: 68 additions & 0 deletions docs/integration/xstore/inventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
sidebar_position: 6
title: Inventory
description: A guide on inventory
slug: /integration/xstore/inventory
tags: ["e-Commerce", "X-Store", "Inventory"]
---

## Products

### Map Products

1. Go to **Inventory > Products**

![product-overview](../../../static/img/xstore/inventory/product-overview.png)

2. Click the **Map Product Button** to open the **Map Product Dialog**

![map-product](../../../static/img/xstore/inventory/map-product.png)

![map-dialog-overview](../../../static/img/xstore/inventory/map-dialog-overview.png)

:::info
Use the **Filter Button** to narrow your **Platform Products View**, or use the **Search Bar** to find specific e-commerce products and stock items.
:::

3. Select e-commerce products synced from various platforms and then a stock item synced from SQL Account to map them together

![mapping-product-1](../../../static/img/xstore/inventory/mapping-product-1.png)

:::info
**e-commerce Products** are mapped to **Stock Item UOM**.
:::

4. To unmap products, select them and click **Unmap**

![unmap-product-1](../../../static/img/xstore/inventory/unmap-product-1.png)

![unmap-product-2](../../../static/img/xstore/inventory/unmap-product-2.png)

## Stocks

### Map Products to Specific Stock Items

1. Go to **Inventory > Stocks**

![stock-overview](../../../static/img/xstore/inventory/stock-overview.png)

2. Click the icon to view stock details

![view-stock-detail](../../../static/img/xstore/inventory/view-stock-detail.png)

:::info
- **Map Product** can be performed here as well
- **Location Description** and **Code** are fetched from SQL Account
:::

3. Click the **+** icon to open the **Map Product Dialog**

![stock-detail](../../../static/img/xstore/inventory/stock-detail.png)

4. Select the **Platform Product** and click **Map Product** to map it directly to this **Stock Item UOM**

![map-selective-uom](../../../static/img/xstore/inventory/map-selective-uom.png)

:::info
Ensure your store is mapped to the correct stock item location, or mapped items won't appear.
:::
9 changes: 9 additions & 0 deletions docs/integration/xstore/orders/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "Order",
"position": 7,
"link": {
"type": "generated-index",
"slug": "/integration/x-store/orders-category",
"description": "A guide on Order module"
}
}
Loading