The complete open source platform to run your entire marketplace. Storefront, vendor panel, admin console, and integrations in one enterprise-grade platform you own.
TypeScript b2b-marketplacecomposable-commerceecommerceenterpriseheadless-commercemarketplacemedusamedusajsmulti-vendortypescript
docs: add admin and vendor store user guides
Jakub Sieradzki79e040ef2e67
diff --git a/apps/docs/docs.json b/apps/docs/docs.jsonindex 272fba07c..066789909 100644--- a/apps/docs/docs.json+++ b/apps/docs/docs.json@@ -104,6 +104,23 @@}]},+ {+ "tab": "User Guide",+ "groups": [+ {+ "group": "Admin",+ "pages": [+ "v2/user-guides/admin/stores"+ ]+ },+ {+ "group": "Vendor",+ "pages": [+ "v2/user-guides/vendor/stores"+ ]+ }+ ]+ },{"tab": "Changelog","groups": [diff --git a/apps/docs/images/user-guides/admin/stores/1.png b/apps/docs/images/user-guides/admin/stores/1.pngnew file mode 100644index 000000000..921eb0699Binary files /dev/null and b/apps/docs/images/user-guides/admin/stores/1.png differdiff --git a/apps/docs/images/user-guides/admin/stores/10.png b/apps/docs/images/user-guides/admin/stores/10.pngnew file mode 100644index 000000000..38bcaf98eBinary files /dev/null and b/apps/docs/images/user-guides/admin/stores/10.png differdiff --git a/apps/docs/images/user-guides/admin/stores/11.png b/apps/docs/images/user-guides/admin/stores/11.pngnew file mode 100644index 000000000..f5c9a9586Binary files /dev/null and b/apps/docs/images/user-guides/admin/stores/11.png differdiff --git a/apps/docs/images/user-guides/admin/stores/12.png b/apps/docs/images/user-guides/admin/stores/12.pngnew file mode 100644index 000000000..612b50910Binary files /dev/null and b/apps/docs/images/user-guides/admin/stores/12.png differdiff --git a/apps/docs/images/user-guides/admin/stores/2.png b/apps/docs/images/user-guides/admin/stores/2.pngnew file mode 100644index 000000000..c87e172d1Binary files /dev/null and b/apps/docs/images/user-guides/admin/stores/2.png differdiff --git a/apps/docs/images/user-guides/admin/stores/3.png b/apps/docs/images/user-guides/admin/stores/3.pngnew file mode 100644index 000000000..3f4b81e2dBinary files /dev/null and b/apps/docs/images/user-guides/admin/stores/3.png differdiff --git a/apps/docs/images/user-guides/admin/stores/4.png b/apps/docs/images/user-guides/admin/stores/4.pngnew file mode 100644index 000000000..4b0c252f1Binary files /dev/null and b/apps/docs/images/user-guides/admin/stores/4.png differdiff --git a/apps/docs/images/user-guides/admin/stores/5.png b/apps/docs/images/user-guides/admin/stores/5.pngnew file mode 100644index 000000000..648a2aa92Binary files /dev/null and b/apps/docs/images/user-guides/admin/stores/5.png differdiff --git a/apps/docs/images/user-guides/admin/stores/6.png b/apps/docs/images/user-guides/admin/stores/6.pngnew file mode 100644index 000000000..41c1057e2Binary files /dev/null and b/apps/docs/images/user-guides/admin/stores/6.png differdiff --git a/apps/docs/images/user-guides/admin/stores/7.png b/apps/docs/images/user-guides/admin/stores/7.pngnew file mode 100644index 000000000..3f4cb64a7Binary files /dev/null and b/apps/docs/images/user-guides/admin/stores/7.png differdiff --git a/apps/docs/images/user-guides/admin/stores/8.png b/apps/docs/images/user-guides/admin/stores/8.pngnew file mode 100644index 000000000..dac6e961fBinary files /dev/null and b/apps/docs/images/user-guides/admin/stores/8.png differdiff --git a/apps/docs/images/user-guides/admin/stores/9.png b/apps/docs/images/user-guides/admin/stores/9.pngnew file mode 100644index 000000000..b2f4fb8fcBinary files /dev/null and b/apps/docs/images/user-guides/admin/stores/9.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/1.png b/apps/docs/images/user-guides/vendor/stores/1.pngnew file mode 100644index 000000000..58abbfe4dBinary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/1.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/10.png b/apps/docs/images/user-guides/vendor/stores/10.pngnew file mode 100644index 000000000..3f162a9a8Binary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/10.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/11.png b/apps/docs/images/user-guides/vendor/stores/11.pngnew file mode 100644index 000000000..8eccd2546Binary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/11.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/12.png b/apps/docs/images/user-guides/vendor/stores/12.pngnew file mode 100644index 000000000..2a12fb1cdBinary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/12.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/13.png b/apps/docs/images/user-guides/vendor/stores/13.pngnew file mode 100644index 000000000..f930d4c24Binary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/13.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/14.png b/apps/docs/images/user-guides/vendor/stores/14.pngnew file mode 100644index 000000000..6c0238b1eBinary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/14.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/2.png b/apps/docs/images/user-guides/vendor/stores/2.pngnew file mode 100644index 000000000..0dc01484cBinary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/2.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/3.png b/apps/docs/images/user-guides/vendor/stores/3.pngnew file mode 100644index 000000000..ed1cda373Binary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/3.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/4.png b/apps/docs/images/user-guides/vendor/stores/4.pngnew file mode 100644index 000000000..54be0140cBinary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/4.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/5.png b/apps/docs/images/user-guides/vendor/stores/5.pngnew file mode 100644index 000000000..ac3a6d89fBinary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/5.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/6.png b/apps/docs/images/user-guides/vendor/stores/6.pngnew file mode 100644index 000000000..6628c145fBinary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/6.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/7.png b/apps/docs/images/user-guides/vendor/stores/7.pngnew file mode 100644index 000000000..844591a02Binary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/7.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/8.png b/apps/docs/images/user-guides/vendor/stores/8.pngnew file mode 100644index 000000000..43424db56Binary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/8.png differdiff --git a/apps/docs/images/user-guides/vendor/stores/9.png b/apps/docs/images/user-guides/vendor/stores/9.pngnew file mode 100644index 000000000..9689eddaeBinary files /dev/null and b/apps/docs/images/user-guides/vendor/stores/9.png differdiff --git a/apps/docs/v2/user-guides/admin/stores.mdx b/apps/docs/v2/user-guides/admin/stores.mdxnew file mode 100644index 000000000..a890b976f--- /dev/null+++ b/apps/docs/v2/user-guides/admin/stores.mdx@@ -0,0 +1,214 @@+---+title: "Stores"+---++This guide explains how to manage stores in the Mercur Admin Panel.++## View stores++To view all stores, select **Stores** in the sidebar menu in your panel.++The table shows store details like name, email, status, date and whether the admin featured the store. Use search, filter, and sort to find a specific store.++One vendor can have multiple stores, each displayed separately in the list.++<img src="/images/user-guides/admin/stores/1.png" alt="Stores (1).png" />++## Create store++To create a store:++1. Go to **Stores** in the sidebar.+2. Click the **Create** button.++This opens a form with two steps: **Details** and **Admin**.++## Details step++In the first **Details** step, you can enter the store general information:++- **Name**+- **Email**+- **Handle**. The handle appears in the store storefront URL. It creates a human-readable URL and must be unique across all stores, containing only lowercase letters, numbers, and hyphens. If left blank, Mercur generates a handle from the name.+- **Phone**+- **Currency**. Each store can have only one currency.++Once you're done, click the **Continue** button.++<img src="/images/user-guides/admin/stores/2.png" alt="Create Store (3).png" />++## Admin step++In the second **Admin** step, you assign an admin vendor to manage this store. You can select an existing user or invite a new one. As you type, suggestions will appear: select one or add a new email. Once the store is created, the selected user will receive an email invitation to join.++<img src="/images/user-guides/admin/stores/3.png" alt="Create Store (4).png" />++Once you create the store, it appears on the list with pending status. The store details entered by the admin during creation can be overwritten by the vendor during onboarding. You can block this depending on the onboarding flow you want.++## Store details++To view store details:++1. Go to **Stores** in the sidebar.+2. Choose the store from the list.++This opens the store details page. Here, you can view and edit store details, address, company details, payment details, and access their orders, products, users, and time off.++<img src="/images/user-guides/admin/stores/4.png" alt="Store Details (10).png" />++## Edit store details++To edit store details:++1. Go to **Stores** in the sidebar.+2. Choose the store from the list.+3. Click the icon in the section header.+4. Choose **Edit** from the dropdown.+5. Edit the store details in the side window.++In the side window that opens, you can edit the store:++- Status. There are three statuses: Active, Pending, Inactive. When a store is **Inactive** or **Pending**, their products won't be visible on the storefront.+- Name+- Description+- Handle+- Phone+- Website+- Featured Store Settings. If checked, the store will be highlighted with a special badge for internal use or promotional purposes.+- Media. You can add logo and banner. This media will be visible on the storefront.++Once you're done, click the **Save** button.++<Warning>+ Once the currency is set, it cannot be changed.+</Warning>++<Note>+Once the admin edits store details, the vendor is notified in their panel.+</Note>+<img src="/images/user-guides/admin/stores/5.png" alt="Store Details - Edit Store (3).png" />++## Edit store address++To edit store address:++1. Go to **Stores** in the sidebar.+2. Choose the store from the list.+3. Click the icon in the **Address** header.+4. Choose **Edit** from the dropdown.++In the side window that opens, you can edit:++- Name+- Address+- Apartment, suite, etc.+- Postal Code+- City+- Country+- State++Once you're done, click the **Save** button.++<img src="/images/user-guides/admin/stores/6.png" alt="Store Details - Edit Address (2).png" />++## Edit store company details++To edit company details:++1. Go to **Stores** in the sidebar.+2. Choose the store from the list.+3. Click the icon in the **Company Details** header.+4. Choose **Edit** from the dropdown.++In the side window that opens, you can edit:++- Company+- Registration number+- Tax ID++Once you're done, click the **Save** button.++<img src="/images/user-guides/admin/stores/7.png" alt="Store Details - Edit Company Details (2).png" />++## Edit store payment details++To edit payment details:++1. Go to **Stores** in the sidebar.+2. Choose the store from the list.+3. Click the icon in the **Payment Details** header.+4. Choose **Edit** from the dropdown.+5. Edit payment details in the side window.++For all countries except the United States, provide the following details based on your needs:++- Account name+- IBAN+- Account number+- SWIFT/BIC++For the United States:++- Account name+- Account number+- ACH routing number++Once you're done, click the **Save** button.++<img src="/images/user-guides/admin/stores/8.png" alt="Store Details - Edit Payment Details (2).png" />++## Users++In the **Users** tab, view all store team members who manage the store. You can add new users by selecting existing ones from your base or inviting new members. You can also remove users from the store.++The user added during store creation is the main admin and cannot be removed. This user is marked with an **Admin** badge.++<img src="/images/user-guides/admin/stores/9.png" alt="Store Details - Users (5).png" />++## Add new user++To add a new user:++1. Go to **Stores** in the sidebar.+2. Choose the store from the list.+3. Select the **Users** tab.+4. Click the **Add** button in the section header.++In the form that opens, add:++- Email. As you type, suggestions will appear; select one or add a new email.+- Role. There are five roles:++Available roles:++- Store Administration+- Inventory Management+- Order Management+- Accounting+- Support++Once you're done, click the **Save** button.++<img src="/images/user-guides/admin/stores/10.png" alt="Store Details - Users (4).png" />++## Time off++In the **Time off** tab, view the store's time off. It specifies the period when the store will be unavailable to receive orders. The vendor can specify one time off period and add a note. During this period, the store's products will not be visible on the storefront.++<img src="/images/user-guides/admin/stores/11.png" alt="Store Details (9).png" />++## Store request++The vendor can submit a request to create a new store. Once submitted, the store appears on the list with **Pending** status. On the store details page, a block appears at the top with two actions:++- Confirm+- Reject++You can review the request, make necessary updates, and choose to confirm and publish the store or reject the request. Once confirmed, the store status changes to Active.++<Info>+ Once the admin confirms or rejects the store creation request, the vendor receives an email.+</Info>++<img src="/images/user-guides/admin/stores/12.png" alt="Store Details - Pending - Requested (1).png" />diff --git a/apps/docs/v2/user-guides/vendor/stores.mdx b/apps/docs/v2/user-guides/vendor/stores.mdxnew file mode 100644index 000000000..fa5c78ec1--- /dev/null+++ b/apps/docs/v2/user-guides/vendor/stores.mdx@@ -0,0 +1,225 @@+---+title: Store+---++This guide explains how to manage store in the Mercur Vendor Panel.++## Store setup++You can set up a store in Mercur in three ways:++- **Admin invitation**: The admin invites you to join the platform and set up your first store.+- **Vendor request**: You create a new store in your panel, which the admin then confirms.+- **Vendor self-registration**: When enabled, you can apply to join the platform through the storefront or other available entry points.++## Admin invitation++Once the admin creates the store and invites you, you receive an email with a link to join as the store's admin. After accepting the invitation, you are redirected to the setup page, where you enter your details and set a password. Once completed, click **Continue** to start onboarding.+<img src="/images/user-guides/vendor/stores/1.png" alt="Vendor onboarding start" />++The onboarding setup is customizable depending on marketplace needs and may include:++- Store details+- Address+- Company details+- Payment details+- Subscription plan++<img src="/images/user-guides/vendor/stores/2.png" alt="Vendor onboarding details step" />++Depending on the marketplace configuration, you need to complete all required steps during onboarding or later in the store profile.+The **Complete profile** block shows any missing information required by the marketplace. Once all required information is added, the block disappears.++<img src="/images/user-guides/vendor/stores/3.png" alt="Complete profile block in store details" />++## Vendor request++A vendor can have multiple stores in Mercur. If you already have one, you can create another.++To create a store:++1. Click the store name in the upper-left corner.+2. A menu appears showing your available stores, with the active one selected.+3. Click the **Add new store** button.+4. This opens a new page for store setup.++The setup is customizable based on marketplace needs and may include:++- Store details+- Address+- Company details+- Payment details++After creating the store, you are redirected to the store details page with a **Pending** status.++Depending on the marketplace setup, a **Complete profile** block may appear showing any missing information required by the marketplace. Once all required information is added, the block disappears.++<img src="/images/user-guides/vendor/stores/4.png" alt="Store switcher in the Vendor Panel" />+<img src="/images/user-guides/vendor/stores/5.png" alt="Pending store details page" />++## Vendor self-registration++When the marketplace admin enables self-registration, you can apply to join the platform through the storefront or other entry points. You are then redirected to the registration page to set up an admin account and create the first store.++After creating the store, you are redirected to the store details page with a **Pending** status.++Depending on the marketplace setup, a **Complete profile** block may appear showing any missing information required by the marketplace. Once all required information is added, the block disappears.++<img src="/images/user-guides/vendor/stores/6.png" alt="Vendor registration page" />++## Store details++To view store details:++1. Go to **Settings** in the sidebar.+2. Go to **Store** in the sidebar.++This opens the store details page. Here, you can view and edit store details, address, company details, payment details, time off.++<img src="/images/user-guides/vendor/stores/7.png" alt="Store details page in the Vendor Panel" />++## Edit store details++To edit store details:++1. Go to **Settings** in the sidebar.+2. Go to **Store** in the sidebar.+3. Click the icon in the section header.+4. Choose **Edit** from the dropdown.+5. Edit the store details in the side window.++In the side window that opens, you can edit the store:++- Name+- Description+- Handle+- Phone+- Website+- Media. You can add logo and banner. This media will be visible on the storefront.++<Note>+ A vendor can have only one currency per store. Once set, the vendor cannot change the currency.+</Note>++<img src="/images/user-guides/vendor/stores/8.png" alt="Edit store details drawer" />++## Edit store address++To edit store address:++1. Go to **Settings** in the sidebar.+2. Go to **Store** in the sidebar.+3. Click the icon in the **Address** header.+4. Choose **Edit** from the dropdown.++In the side window that opens, you can edit:++- Name+- Address+- Apartment, suite, etc.+- Postal code+- City+- Country+- State+5. Once you're done, click the **Save** button.+<img src="/images/user-guides/vendor/stores/9.png" alt="Edit store address drawer" />++## Edit store company details++To edit company details:++1. Go to **Settings** in the sidebar.+2. Go to **Store** in the sidebar.+3. Click the icon in the **Company Details** header.+4. Choose **Edit** from the dropdown.++In the side window that opens, you can edit:++- Company+- Registration number+- Tax ID+5. Once you're done, click the **Save** button.++<img src="/images/user-guides/vendor/stores/10.png" alt="Edit store company details drawer" />++## Edit store payment details++To edit payment details:++1. Go to **Settings** in the sidebar.+2. Go to **Store** in the sidebar.+3. Click the icon in the **Payment Details** header.+4. Choose **Edit** from the dropdown.+5. Edit payment details in the side window.++For all countries except the United States, provide the following details based on your needs:++- Account name+- IBAN+- Account number+- SWIFT/BIC++For the United States:++- Account name+- Account number+- ACH routing number++6. Click **Save**.++<img src="/images/user-guides/vendor/stores/11.png" alt="Edit store payment details drawer" />++## Time off++In the **Time off** section, you can manage your store's time off. It specifies when the store will be unavailable to receive orders. You can specify one time off period and add a note. During this period, the store’s products will not be visible on the storefront.++<img src="/images/user-guides/vendor/stores/12.png" alt="Store time off section" />++## Create time off++To create time off:++1. Go to **Settings** in the sidebar.+2. Go to **Store** in the sidebar.+3. Click the **Create** button in the **Time off** section.++In the side window, you can enter:++- First day+- Last day. If you leave this field empty, the store will be closed indefinitely+- Note++4. Once you're done, click the **Save** button.++Once time off expires, it will disappear.++<img src="/images/user-guides/vendor/stores/13.png" alt="Create time off drawer" />++## Edit time off++To edit time off:++1. Go to **Settings** in the sidebar.+2. Go to **Store** in the sidebar.+3. Click the icon in the time off row.+4. Choose **Edit** from the dropdown.+5. In the side window you can edit:++- First day+- Last day. If you leave this field empty, the store will be closed indefinitely.+- Note+++6. Once you're done, click the **Save** button.++<img src="/images/user-guides/vendor/stores/14.png" alt="Edit time off drawer" />++## Delete time off++To delete time off:++1. Go to **Settings** in the sidebar.+2. Go to **Store** in the sidebar.+3. Click the icon in the time off row.+4. Choose **Delete** from the dropdown.