@mercurjs/docs 2.2.1 → 2.3.0-canary.1

package/content/user-guide/vendor/onboarding.mdx

@@ -0,0 +1,79 @@
+---
+title: "Complete Your Onboarding"
+sidebarTitle: "Onboarding"
+description: "Set up your store step by step when you first join the marketplace."
+---
+
+> Run the setup wizard the first time you create a store.
+
+## Overview
+
+Onboarding is the short setup wizard you run the first time you create a store. It has four steps: "Store Details", "Address", "Company Details", and "Payment Details". The address, company, and payment steps can be skipped and completed later from your store settings.
+
+You reach onboarding after accepting an invitation or creating a new store. You can also start it for an additional store by clicking your store name in the upper left corner and choosing "Add new store".
+
+## Step 1: Store Details
+
+Enter the essentials for your store:
+
+1. Enter a "Name".
+2. Enter an "Email". This is the public contact email for your store.
+3. Optionally enter a "Handle". The handle becomes the URL slug for your store. Leave it empty to generate one from the name.
+4. Select a "Currency".
+5. Click "Continue".
+
+{/* screenshot: /onboarding wizard, Store Details step */}
+
+<Warning>
+  The currency cannot be changed after the store is created. Choose carefully.
+</Warning>
+
+## Step 2: Address
+
+Enter your business address:
+
+1. Enter a "Name" for the address, for example Headquarters.
+2. Enter the "Address", and optionally "Apartment, suite, etc.", "Postal Code", and "City".
+3. Select a "Country", and optionally enter a "State".
+4. Click "Continue", or click "Skip" to add this later.
+
+{/* screenshot: /onboarding wizard, Address step */}
+
+## Step 3: Company Details
+
+Enter your business details if you are registering as a company:
+
+1. Optionally enter "Company", "Registration number", and "Tax ID".
+2. Click "Continue", or click "Skip".
+
+{/* screenshot: /onboarding wizard, Company Details step */}
+
+## Step 4: Payment Details
+
+Tell the marketplace how you want to receive payouts:
+
+1. Select a "Country".
+2. Enter the "Account name".
+3. Enter your bank details. These depend on your country:
+   - For the United States: "Account number" and "ACH routing number".
+   - For other countries: "IBAN", "Account number", and "SWIFT / BIC".
+4. Click "Complete setup", or click "Skip".
+
+{/* screenshot: /onboarding wizard, Payment Details step */}
+
+## After onboarding
+
+Your store account is created with a "Pending" status while the marketplace reviews it. You are notified by email once the review is done. In the meantime, you can select your store and continue setting it up. If any required information is still missing, a "Complete profile" block shows what is needed.
+
+{/* screenshot: Application submitted confirmation screen */}
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Store" href="/user-guide/vendor/stores">
+    Edit your store details, address, and time off later.
+  </Card>
+  <Card title="Submit a product" href="/user-guide/vendor/products/how-tos/submit-a-product">
+    Add your first product to the catalog.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/orders/how-tos/fulfill-an-order.mdx

@@ -0,0 +1,49 @@
+---
+title: "Fulfill an Order"
+sidebarTitle: "Fulfill an order"
+description: "Prepare the items in an order to be sent to the customer."
+---
+
+> Reserve and prepare an order's items from one of your stock locations.
+
+## Overview
+
+Fulfilling an order prepares its items to be sent. You choose which location to fulfill from, which items and quantities to include, and whether to notify the customer.
+
+## Step 1: Open the order
+
+1. Go to "Orders" in the sidebar.
+2. Open the order you want to fulfill.
+
+{/* screenshot: /orders/:id detail page with Unfulfilled Items */}
+
+## Step 2: Start fulfillment
+
+1. In the "Unfulfilled Items" section, open the actions menu.
+2. Choose "Fulfill items".
+
+## Step 3: Choose location and items
+
+In the window that opens:
+
+1. Choose the location you are fulfilling the items from.
+2. Choose the items and quantities to fulfill.
+3. Optionally choose a different shipping method, and choose whether to notify the customer.
+
+{/* screenshot: Create Fulfillment modal */}
+
+## Step 4: Create the fulfillment
+
+Click "Create Fulfillment".
+
+<Note>
+  The location you choose must have stock for the selected items. If it does not, add an inventory level for that location first.
+</Note>
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Ship an order" href="/user-guide/vendor/orders/how-tos/ship-an-order">
+    Mark the fulfilled items as shipped and add tracking.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/orders/how-tos/mark-an-order-as-delivered.mdx

@@ -0,0 +1,33 @@
+---
+title: "Mark an Order as Delivered"
+sidebarTitle: "Mark as delivered"
+description: "Record that the customer has received a shipped order."
+---
+
+> Close the loop on a shipment once it reaches the customer.
+
+## Overview
+
+When the customer has received a shipped order, you can record it as delivered. This keeps the order's status accurate for you and the customer.
+
+## Step 1: Open the order
+
+1. Go to "Orders" in the sidebar.
+2. Open the order and find the shipped fulfillment.
+
+{/* screenshot: /orders/:id detail page with a shipped fulfillment */}
+
+## Step 2: Mark as delivered
+
+1. Click "Mark as delivered".
+2. Confirm the action.
+
+{/* screenshot: Mark as delivered confirmation */}
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Process a return" href="/user-guide/vendor/orders/how-tos/process-a-return">
+    Handle a return if the customer sends items back.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/orders/how-tos/process-a-return.mdx

@@ -0,0 +1,42 @@
+---
+title: "Process a Return"
+sidebarTitle: "Process a return"
+description: "Create a return for an order and receive the items back into stock."
+---
+
+> Take items back from a customer and adjust your inventory.
+
+## Overview
+
+Processing a return has two parts: you create the return for the items the customer is sending back, then you receive those items when they arrive. Receiving lets you record how many came back and how many were damaged, and adjusts your inventory automatically.
+
+## Step 1: Create the return
+
+1. Go to "Orders" in the sidebar and open the order.
+2. In the order summary, open the actions menu and choose to create a return.
+3. Select the items and quantities being returned, then confirm.
+
+{/* screenshot: Create return modal */}
+
+## Step 2: Receive the items
+
+When the items arrive back:
+
+1. Open the order and find the return.
+2. Choose "Receive items".
+3. Enter how many items you received, and how many of them are damaged.
+4. Choose whether to notify the customer, then confirm.
+
+{/* screenshot: Receive items for return modal */}
+
+<Note>
+  Inventory levels are adjusted automatically based on the quantities you enter when receiving.
+</Note>
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Refund an order" href="/user-guide/vendor/orders/how-tos/refund-an-order">
+    Return money to the customer for the returned items.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/orders/how-tos/refund-an-order.mdx

@@ -0,0 +1,38 @@
+---
+title: "Refund an Order"
+sidebarTitle: "Refund an order"
+description: "Return money to the customer for a captured payment."
+---
+
+> Give the customer some or all of their money back.
+
+## Overview
+
+You can refund a customer from the order's payment section once the payment has been captured. A refund returns money to the customer's original payment method.
+
+## Step 1: Open the order
+
+1. Go to "Orders" in the sidebar.
+2. Open the order you want to refund.
+
+{/* screenshot: /orders/:id detail page, Payment section */}
+
+## Step 2: Create a refund
+
+1. In the payment section, open the actions menu and choose "Create refund".
+2. In the side window, enter the amount to refund and an optional reason.
+3. Save to issue the refund.
+
+{/* screenshot: Create refund drawer */}
+
+<Note>
+  Refunds are available once a payment has been captured and the order is not already fully refunded.
+</Note>
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Process a return" href="/user-guide/vendor/orders/how-tos/process-a-return">
+    Refunds often go together with taking items back.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/orders/how-tos/ship-an-order.mdx

@@ -0,0 +1,40 @@
+---
+title: "Ship an Order"
+sidebarTitle: "Ship an order"
+description: "Mark fulfilled items as shipped and add tracking for the customer."
+---
+
+> Record that a fulfillment has been sent, and give the customer a tracking number.
+
+## Overview
+
+Once items are fulfilled, mark them as shipped and add tracking so the customer can follow the delivery. This creates a shipment against the fulfillment.
+
+## Step 1: Open the order
+
+1. Go to "Orders" in the sidebar.
+2. Open the order and find the fulfillment you want to ship.
+
+{/* screenshot: /orders/:id detail page with a fulfillment */}
+
+## Step 2: Mark as shipped
+
+Click "Mark as shipped" on the fulfillment.
+
+## Step 3: Add tracking
+
+In the "Mark Fulfillment as Shipped" window:
+
+1. Optionally add a "Tracking number" and a "Tracking URL".
+2. Choose whether to "Send notification" to the customer.
+3. Confirm to create the shipment.
+
+{/* screenshot: Mark Fulfillment as Shipped modal */}
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Mark an order as delivered" href="/user-guide/vendor/orders/how-tos/mark-an-order-as-delivered">
+    Record delivery once the customer receives the order.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/orders/overview.mdx

@@ -0,0 +1,31 @@
+---
+title: "Orders"
+sidebarTitle: "Overview"
+description: "Fulfill, ship, refund, and handle returns for the orders you receive."
+---
+
+> Everything you do after a customer buys one of your offers.
+
+When a customer buys one of your offers, the order appears in your "Orders" list. From an order's detail page you prepare and ship the items, keep the customer informed, and handle refunds or returns.
+
+You manage orders from "Orders" in the sidebar. Click an order to open its detail page.
+
+## How-tos
+
+<CardGroup cols={2}>
+  <Card title="Fulfill an order" href="/user-guide/vendor/orders/how-tos/fulfill-an-order">
+    Prepare the items to be sent.
+  </Card>
+  <Card title="Ship an order" href="/user-guide/vendor/orders/how-tos/ship-an-order">
+    Mark items as shipped and add tracking.
+  </Card>
+  <Card title="Mark an order as delivered" href="/user-guide/vendor/orders/how-tos/mark-an-order-as-delivered">
+    Record that the customer received the order.
+  </Card>
+  <Card title="Refund an order" href="/user-guide/vendor/orders/how-tos/refund-an-order">
+    Return money to the customer.
+  </Card>
+  <Card title="Process a return" href="/user-guide/vendor/orders/how-tos/process-a-return">
+    Create a return and receive the items back.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/overview.mdx

@@ -1,23 +1,34 @@
 ---
 title: "Vendor Panel"
-description: "What sellers do in the Vendor Panel — no technical knowledge required."
+description: "What sellers do in the Vendor Panel, with no technical knowledge required."
 ---
 
-<Note>
-  This guide is being written. The outline below is the intended structure.
-</Note>
+The Vendor Panel is where you run your store. You set up your store, list products, sell them through offers, and process the orders that come in.
 
-## What you can do here
+## Areas
 
-Manage products, process orders, configure shipping, track payouts, and complete onboarding.
-
-## Common tasks
-
-Links to the per-area guides as they are added.
+<CardGroup cols={2}>
+  <Card title="Onboarding" href="/user-guide/vendor/onboarding">
+    Set up your store step by step when you first join.
+  </Card>
+  <Card title="Store" href="/user-guide/vendor/stores">
+    Manage your store details, address, and time off.
+  </Card>
+  <Card title="Products" href="/user-guide/vendor/products/overview">
+    Submit products to the marketplace catalog.
+  </Card>
+  <Card title="Offers" href="/user-guide/vendor/offers/overview">
+    List a product for sale with your SKU, price, and stock.
+  </Card>
+  <Card title="Orders" href="/user-guide/vendor/orders/overview">
+    Fulfill, ship, refund, and handle returns.
+  </Card>
+</CardGroup>
 
 ## Next steps
 
 <CardGroup cols={2}>
-  <Card title="Stores" href="/rc/user-guide/vendor/stores" />
-  <Card title="Admin Panel" href="/rc/user-guide/admin/overview" />
+  <Card title="Admin Panel" href="/user-guide/admin/overview">
+    See the marketplace from an operator's point of view.
+  </Card>
 </CardGroup>

package/content/user-guide/vendor/products/how-tos/edit-a-product.mdx

@@ -0,0 +1,44 @@
+---
+title: "Edit a Product"
+sidebarTitle: "Edit a product"
+description: "Change a published product and track the update request."
+---
+
+> Update a product's details. Changes to a published product go live once the operator approves them.
+
+## Overview
+
+You edit a product from its detail page. Editing a published product creates an update request that the marketplace operator reviews. Your changes take effect on the storefront once approved.
+
+## Step 1: Open the product
+
+1. Go to "Products" in the sidebar.
+2. Choose the product from the list.
+
+{/* screenshot: /products/:id detail page */}
+
+## Step 2: Edit a section
+
+1. Click the icon in the section header you want to change, for example the general details.
+2. Choose "Edit".
+3. Update the fields in the side window, then click "Save".
+
+{/* screenshot: Edit product drawer */}
+
+## Step 3: Track the request
+
+After you submit an edit to a published product, the product detail page shows a panel with the pending update. While it is pending, you can click "Cancel" to withdraw the request. Once the operator approves it, the changes appear on the storefront.
+
+{/* screenshot: Product detail page showing the pending update panel */}
+
+<Note>
+  You are notified of the operator's decision. If changes are requested, revise the product and submit again.
+</Note>
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Submit a product" href="/user-guide/vendor/products/how-tos/submit-a-product">
+    Add a brand-new product to the catalog.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/products/how-tos/submit-a-product.mdx

@@ -0,0 +1,63 @@
+---
+title: "Submit a Product"
+sidebarTitle: "Submit a product"
+description: "Create a new product and send it to the marketplace for approval."
+---
+
+> Add a new product to the catalog. It goes live once the operator approves it.
+
+## Overview
+
+Creating a product is a four-step form: "Details", "Organize", "Attributes", and "Variants". When you submit it, the product is created with a "Proposed" status and sent to the marketplace operator for review.
+
+## Step 1: Start a new product
+
+1. Go to "Products" in the sidebar.
+2. Click "Create".
+
+{/* screenshot: /products list with Create button */}
+
+## Step 2: Enter the details
+
+In the "Details" step, enter the core information for the product, such as its title, handle, and description.
+
+{/* screenshot: Create product wizard, Details tab */}
+
+## Step 3: Organize the product
+
+In the "Organize" step, assign the product to a category, and set any collection, type, or tags that apply.
+
+{/* screenshot: Create product wizard, Organize tab */}
+
+## Step 4: Fill in attributes
+
+In the "Attributes" step, fill in the marketplace attributes. Attributes marked as required by the marketplace must have a value before you can submit.
+
+{/* screenshot: Create product wizard, Attributes tab */}
+
+## Step 5: Add variants and submit
+
+In the "Variants" step, define any variations such as size or color. If the product has none, a single default variant is created for you.
+
+When you are done, click "Publish" to submit the product. You can also click "Save draft" to keep working on it later.
+
+{/* screenshot: Create product wizard, Variants tab with footer buttons */}
+
+## What happens next
+
+The product is created with a "Proposed" status and sent for review. You can already create offers for it, but they only appear on the storefront once the product is approved and the offers have stock levels and prices set. You are notified of the outcome.
+
+<Note>
+  If the operator requests changes, the product shows what needs updating so you can revise and resubmit it.
+</Note>
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Create an offer" href="/user-guide/vendor/offers/how-tos/create-an-offer">
+    List the product for sale once it is approved.
+  </Card>
+  <Card title="Edit a product" href="/user-guide/vendor/products/how-tos/edit-a-product">
+    Change a product after it is published.
+  </Card>
+</CardGroup>

package/content/user-guide/vendor/products/overview.mdx

@@ -0,0 +1,22 @@
+---
+title: "Products"
+sidebarTitle: "Overview"
+description: "Submit products to the shared marketplace catalog and track their approval."
+---
+
+> How products reach the catalog: you submit them, the operator reviews them, then you sell them through offers.
+
+Products live in a shared marketplace catalog. When you create or edit a product, it is submitted for the marketplace operator to review. Once approved, you sell it by creating an offer against it.
+
+You manage products from "Products" in the sidebar. Each product shows a status, such as "Draft", "Proposed", "Published", or "Rejected".
+
+## How-tos
+
+<CardGroup cols={2}>
+  <Card title="Submit a product" href="/user-guide/vendor/products/how-tos/submit-a-product">
+    Create a new product and send it for approval.
+  </Card>
+  <Card title="Edit a product" href="/user-guide/vendor/products/how-tos/edit-a-product">
+    Change a product and track the update request.
+  </Card>
+</CardGroup>