asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: general updates and fixes (#13620)

Browse Source
This commit is contained in:
Shahed Nasser
2025-09-30 08:45:30 +03:00
committed by GitHub
parent dda756dfaa
commit f970e1355a
47 changed files with 358 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/user-guide/app/settings/developer/page.mdx
+3 -1
View File
@@ -9,7 +9,9 @@ export const metadata = {
# {metadata.title}
The Developer section in the Medusa Admin's settings is useful for developers building customizations for your Medusa application. If you're unsure about how to use these settings, please consult with your technical team.
The Developer section in the Medusa Admin's settings is useful for developers building customizations for your Medusa application.
If you're unsure about how to use these settings, please consult with your technical team.
## Manage Developer Settings
www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx
+6 -6
View File
@@ -47,7 +47,7 @@ Here, you can see a list of all the publishable API keys you have set up in your
To create a new publishable API key:
1. Go to Settings -> Publishable API Keys.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens, enter the publishable API key's title.
4. Once you're done, click the Save button.
@@ -68,7 +68,7 @@ This opens the publishable API key's details page where you can also manage the
### Publishable API Key Status
You can see the status of the publishable API key at the top right of the first section in the details page. A publishable API key's status can be:
You can see the status of the publishable API key in the header of the first section in the details page. A publishable API key's status can be:
<Table>
<Table.Header>
@@ -107,7 +107,7 @@ To copy a publishable API key:
To edit a publishable API key:
1. Go to the publishable API key's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
3. Choose "Edit" from the dropdown.
4. In the side window that opens, you can edit the publishable API key's title.
5. Once you're done, click the Save button.
@@ -125,7 +125,7 @@ You can manage the sales channels of a publishable API key in its details page.
To add a sales channel to a publishable API key:
1. Go to the publishable API key's details page.
2. Click the "Add" button at the top right of the "Sales Channels" section.
2. Click the "Add" button in the "Sales Channels" section's header.
3. In the list that opens, check the sales channels you want to add the API key to.
4. Once you're done, click the Save button.
@@ -155,7 +155,7 @@ Revoking a publishable API key is irreversible. You can't use the key in request
To revoke a publishable API key:
1. Go to the publishable API key's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
3. Choose "Revoke API key" from the dropdown.
4. Confirm revoking the API key by clicking the "Revoke API key" button in the pop-up.
@@ -172,6 +172,6 @@ Deleting a publishable API key is irreversible.
You can only delete a publishable API key after [revoking it](#revoke-publishable-api-key). To delete a publishable API key:
1. Go to the publishable API key's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
3. Choose "Delete" from the dropdown.
4. Confirm deleting the API key by clicking the Delete button in the pop-up.
www/apps/user-guide/app/settings/developer/secret-api-keys/page.mdx
+5 -5
View File
@@ -49,7 +49,7 @@ When you create a secret API key, you create it for the currently logged-in user
To create a new secret API key for the currently logged-in user:
1. Go to Settings -> Secret API Keys.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens, enter the secret API key's title.
4. Once you're done, click the Save button.
5. You'll get a pop-up with the secret API key. Copy it and store it securely before closing the pop-up, as you won't be able to see it again.
@@ -71,7 +71,7 @@ This opens the secret API key's details page where you can also manage the API k
### Secret API Key Status
You can see the status of the secret API key at the top right of the first section in the details page. A secret API key's status can be:
You can see the status of the secret API key in the header of the first section in the details page. A secret API key's status can be:
<Table>
<Table.Header>
@@ -99,7 +99,7 @@ You can see the status of the secret API key at the top right of the first secti
To edit a secret API key:
1. Go to the secret API key's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
3. Choose "Edit" from the dropdown.
4. In the side window that opens, you can edit the secret API key's title.
5. Once you're done, click the Save button.
@@ -119,7 +119,7 @@ Revoking a secret API key is irreversible. You can't use the key in requests aft
To revoke a secret API key:
1. Go to the secret API key's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
3. Choose "Revoke API key" from the dropdown.
4. Confirm revoking the API key by clicking the "Revoke API key" button in the pop-up.
@@ -136,6 +136,6 @@ Deleting a secret API key is irreversible.
You can only delete a secret API key after [revoking it](#revoke-secret-api-key). To delete a secret API key:
1. Go to the secret API key's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
3. Choose "Delete" from the dropdown.
4. Confirm deleting the API key by clicking the Delete button in the pop-up.
www/apps/user-guide/app/settings/developer/workflows/page.mdx
+61 -29
View File
@@ -19,59 +19,87 @@ In this guide, you'll learn how to view workflow executions in the Medusa Admin.
<Note>
This guide is mainly useful for developers and technical teams building and debugging customizations of a Medusa application.
This guide is primarily useful for developers and technical teams building and debugging customizations of a Medusa application.
</Note>
## What are Workflow Executions?
[Workflows](!docs!/learn/fundamentals/workflows) are a series of steps that perform a task. You build a workflow in your source code to implement custom commerce flows and features.
[Workflows](!docs!/learn/fundamentals/workflows) are a series of steps that perform a task. You build workflows in your source code to implement custom commerce flows and features.
When you execute a workflow, it runs the steps in sequence to complete the task. If you've configured the workflow to have its executions stored in the database as explained in [this technical guide](!docs!/learn/fundamentals/workflows/store-executions), you can view the executions and their details in the Medusa Admin. This is useful to debug workflows and ensure they ran as expected.
When you execute a workflow, Medusa runs the steps in sequence to complete the task. If you've configured the workflow to store its executions in the database as explained in the [Store Workflow Executions guide](!docs!/learn/fundamentals/workflows/store-executions), you can view the workflow's executions and their details in the Medusa Admin. This is useful for debugging workflows and ensuring they run as expected.
---
## View Workflow Executions
To view workflow executions, go to Settings → Workflows. There, you'll find the list of custom and Medusa workflows that have been executed and are stored in the database. You can search through the list to find the one you're looking for.
To view workflow executions, go to Settings → Workflows. There, you'll find a list of custom and Medusa workflows that have been executed and are stored in the database. You can search through the list to find the one you're looking for.
![Workflow executions list](https://res.cloudinary.com/dza7lstvk/image/upload/v1740496862/User%20Guide/Screenshot_2025-02-25_at_5.16.30_PM_fjkbrc.png)
### Workflow Execution Status
In the list, you can view the status of each workflow execution. A workflow's execution status can be:
In the list, you can view the status of each workflow execution. A workflow execution's status can be:
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Status</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>
Status
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>Not Started</Table.Cell>
<Table.Cell>The workflow has been executed, but its steps haven't been invoked yet.</Table.Cell>
<Table.Cell>
Not Started
</Table.Cell>
<Table.Cell>
The workflow has been executed, but its steps haven't been invoked yet.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Invoking</Table.Cell>
<Table.Cell>The workflow execution is currently running, invoking its steps.</Table.Cell>
<Table.Cell>
Invoking
</Table.Cell>
<Table.Cell>
The workflow execution is currently running and invoking its steps.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Done</Table.Cell>
<Table.Cell>The workflow execution has finished successfully.</Table.Cell>
<Table.Cell>
Done
</Table.Cell>
<Table.Cell>
The workflow execution has completed successfully.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Failed</Table.Cell>
<Table.Cell>The workflow execution has failed.</Table.Cell>
<Table.Cell>
Failed
</Table.Cell>
<Table.Cell>
The workflow execution has failed.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Compensating</Table.Cell>
<Table.Cell>The workflow execution is compensating its steps after a failure.</Table.Cell>
<Table.Cell>
Compensating
</Table.Cell>
<Table.Cell>
The workflow execution is compensating its steps after a failure.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Reverted</Table.Cell>
<Table.Cell>The workflow execution has been reverted, which occurs when the workflow ran as part of another workflow and the parent workflow failed.</Table.Cell>
<Table.Cell>
Reverted
</Table.Cell>
<Table.Cell>
The workflow execution has been reverted, which occurs when the workflow runs as part of another workflow and the parent workflow fails.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -85,7 +113,7 @@ To view a workflow execution's details:
1. Go to Settings → Workflows.
2. Click on the workflow execution to view it.
On the workflow execution's page, you'll find multiple sections with the execution's details.
On the workflow execution's page, you'll find multiple sections containing the execution's details.
![Workflow executions details](https://res.cloudinary.com/dza7lstvk/image/upload/v1740496967/User%20Guide/Screenshot_2025-02-25_at_5.22.33_PM_z6al6a.png)
@@ -93,24 +121,28 @@ On the workflow execution's page, you'll find multiple sections with the executi
In the first section, you'll find a summary of the workflow execution, including:
- A badge at the top right indicating its [status](#workflow-execution-status).
- A badge at the top end of the section indicating the [execution's status](#workflow-execution-status).
- The workflow's unique ID, which you specify when you create the workflow.
- The transaction ID, which is a unique identifier for the workflow execution. This is useful for debugging, tracking, and changing step statuses of [long-running workflows](!docs!/learn/fundamentals/workflows/long-running-workflow).
- The workflow's progress which shows a quick overview of the steps that have been executed.
- The workflow's progress, which shows a quick overview of the steps that have been executed.
### Timeline
The timeline diagram shows you the step by step execution of the workflow. You can zoom in and out, and drag and move the mouse to view the entire diagram. You can also click on a step to view its execution details in the [History](#history) section.
The timeline diagram shows you the step-by-step execution of the workflow. You can zoom in and out, and drag the mouse to view the entire diagram. You can also click on a step to view its execution details in the [History](#history) section.
#### Step Status
In the timeline diagram, each step node has a small box at its left whose color indicates its status:
In the timeline diagram, each step node has a small box whose color indicates the step's status:
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Color</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>
Color
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
@@ -143,7 +175,7 @@ In the timeline diagram, each step node has a small box at its left whose color
Gray
</Table.Cell>
<Table.Cell>
The step hasn't been executed yet, or it's been skipped, which can occur if the step is part of a [when condition](!docs!/learn/fundamentals/workflows/conditions).
The step hasn't been executed yet, or it has been skipped, which can occur if the step is part of a [when condition](!docs!/learn/fundamentals/workflows/conditions).
</Table.Cell>
</Table.Row>
</Table.Body>
@@ -155,11 +187,11 @@ The JSON section allows you to view the execution's details as a raw JSON object
### History
The History section shows you the execution of the workflow's steps by order of execution. You can see each step's name with a dot reflecting its status as explained in the [Step Status](#step-status) section.
The History section shows you the execution of the workflow's steps in order of execution. You can see each step's name with a dot reflecting its status as explained in the [Step Status](#step-status) section.
If you click on any executed step, you'll see its details, including:
- **Definition**: the step's configurations which can be passed when you create the step. For example, the step's name, whether it has a compensation function, whether it's asynchronous, etc...
- **Definition**: the step's configurations that can be passed when you create the step. For example, the step's name, whether it has a compensation function, or whether it's asynchronous.
- **Output**: the step's output, which is the result of the step's execution.
- **Compensation Input**: if the workflow failed and the step has a compensation function, you can see the input that the compensation function received.
- **Error**: if the step failed, you can see the error message.
www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx
+15 -15
View File
@@ -37,7 +37,7 @@ Then, during checkout, a customer can only choose shipping options available fro
To create a stock location:
1. Go to Settings → Locations & Shipping.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens:
- Enter the location's name, such as "Main Warehouse".
- Enter the address details. It's only required to enter an address line and choose a country.
@@ -52,7 +52,7 @@ To create a stock location:
To view the details of a location:
1. Go to Settings → Locations.
2. Click on "View details" at the top right of the location's section.
2. Click on "View details" in the header of the location's section.
This opens the location's details page where you can also manage the location.
@@ -65,7 +65,7 @@ This opens the location's details page where you can also manage the location.
To edit a stock location:
1. Open the location's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the location's name and address details.
5. Once you're done, click the Save button.
@@ -87,7 +87,7 @@ So, to create a shipping option for either pick-up or shipping, you need to enab
By default, pick-up and shipping are disabled in a location. To enable either:
1. Go to the location's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Pickup" or "Shipping" section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the header of the "Pickup" or "Shipping" section.
3. Choose Enable from the dropdown.
You can also disable the shipping mode by following the same steps.
@@ -97,7 +97,7 @@ You can also disable the shipping mode by following the same steps.
To ceate a service zone for pick-up or shipping:
1. Go to the location's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Pickup" or "Shipping" section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the header of the "Pickup" or "Shipping" section.
3. Choose "Create service zone" from the dropdown.
4. In the form that opens:
- In the Name field, enter the name of the service zone. For example, "United States".
@@ -119,7 +119,7 @@ To create a shipping option:
1. Go to the location's details page.
2. In the "Pickup" or "Shipping" section, find the service zone you want to add the shipping option to.
3. Click the "Create option" at the right of either "Shipping options", "Pickup options", or "Return options", based on the type of shipping option you're creating.
3. Click the "Create option" next to either "Shipping options", "Pickup options", or "Return options", based on the type of shipping option you're creating.
4. In the form that opens:
- If the shipping option isn't a pick-up option, you can choose the price type. Choose **Fixed** if you want to apply fixed pricing for the shipping option, or **Calculated** if the price should be calculated dynamically during checkout. Calculated prices are useful if you're using a third-party fulfillment provider that calculates prices dynamically.
- If you chose Fixed, you'll set the price in the next step of the form.
@@ -186,7 +186,7 @@ You can manage service zones in pick-up or shipping mode by [creating](#2-create
To edit a service zone in a location:
1. Go to the location's details page.
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to it.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the service zone's name.
5. Once you're done, click the Save button.
@@ -198,7 +198,7 @@ To edit a service zone in a location:
To manage the areas in a service zone:
1. Go to the location's details page.
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to it.
3. Choose "Manage areas" from the dropdown.
4. In the form that opens, manage the areas in the service zone:
- Click the "Manage areas" button.
@@ -219,7 +219,7 @@ Deleting a service zone is irreversible. It will delete all shipping options in
To delete a service zone:
1. Go to the location's details page.
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to it.
3. Choose Delete from the dropdown.
4. Confirm deleting the service zone by clicking the Delete button in the pop-up.
@@ -234,7 +234,7 @@ You can manage shipping options in pick-up and shipping modes by [creating](#cre
To edit a shipping option's details:
1. Go to the location's details page.
2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to it.
3. Choose "Edit option" from the dropdown.
4. In the side window that opens, you can edit the shipping option's price type, name, shipping profile, shipping option type, and whether it's enabled in store for customers to use.
5. Once you're done, click the Save button.
@@ -252,7 +252,7 @@ You can't edit a shipping option's fulfillment provider or fulfillment option af
To edit the prices of shipping options whose price type is Fixed:
1. Go to the location's details page.
2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to it.
3. Choose "Edit prices" from the dropdown.
4. In the [Bulk Editor](../../../tips/bulk-editor/page.mdx) that opens, you can edit the shipping option's price for every currency and region in your store.
- Refer to the [Fixed and Conditional Shipping Option Prices](#fixed-and-conditional-shipping-option-prices) section to learn how to set a conditional price for the shipping option.
@@ -280,7 +280,7 @@ Deleting a shipping option is irreversible.
To delete a shipping option:
1. Go to the location's details page.
2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to it.
3. Choose Delete from the dropdown.
4. Confirm deleting the shipping option by entering its name in the pop-up and clicking the "Delete" button.
@@ -291,7 +291,7 @@ To delete a shipping option:
To change the sales channels associated with a location:
1. Go to the location's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Sales Channels" section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the header of the "Sales Channels" section.
3. Choose Edit from the dropdown.
4. In the list that opens, you can select the sales channels to associate with the location, or unselect the ones you want to remove.
5. Once you're done, click the Save button.
@@ -305,7 +305,7 @@ To change the sales channels associated with a location:
To manage the fulfillment providers available in a location:
1. Go to the location's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Fulfillment Providers" section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the header of the "Fulfillment Providers" section.
3. Choose Edit from the dropdown.
4. In the list that opens, you can select the fulfillment providers to associate with the location, or unselect the ones you want to remove.
5. Once you're done, click the Save button.
@@ -325,6 +325,6 @@ Deleting a location is irreversible and will delete its service zones and shippi
To delete a location:
1. Open the location's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Delete from the dropdown.
4. Confirm deleting the location by entering its name and clicking the Delete button.
www/apps/user-guide/app/settings/locations-and-shipping/shipping-option-types/page.mdx
+4 -4
View File
@@ -53,12 +53,12 @@ To create a shipping option type:
1. Go to Settings → Location & Shipping.
2. In the Shipping Configuration section, click on Shipping Option Types.
3. Click the Create button at the top right.
3. Click the Create button in the main section's header.
4. In the form that opens, enter the following information:
- **Label**: The name of the shipping option type that can be displayed to customers. For example, "Same Day".
- **Code**: A unique identifier for the shipping option type. For example, `same_day`.
- **Description**: A brief description of the shipping option type. This is optional but can be helpful to provide more context about the type. For example, "Delivery within the same day".
5. Once you're done, click the Create button at the bottom right.
5. Once you're done, click the Create button at the bottom.
![Create shipping option type form](https://res.cloudinary.com/dza7lstvk/image/upload/v1756371811/User%20Guide/CleanShot_2025-08-28_at_12.02.05_2x_fg66gh.png)
@@ -82,7 +82,7 @@ This opens the shipping option type's details page, where you can also manage th
To edit the details of a shipping option type:
1. Go to the shipping option type's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> button in the top right corner of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> button in the first section's header.
3. Select "Edit" from the dropdown menu.
4. In the side window that opens, you can edit the shipping option type's label, code, and description.
5. Once you're done, click the Save button.
@@ -102,6 +102,6 @@ Deleting a shipping option type is irreversible.
To delete a shipping option type:
1. Go to the shipping option type's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> button in the top right corner of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> button in the first section's header.
3. Select "Delete" from the dropdown menu.
4. Confirm the deletion of the shipping option type in the pop-up.
www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx
+5 -5
View File
@@ -43,7 +43,7 @@ Here, you can see a list of all the shipping profiles you have set up in your st
To create a shipping profile:
1. Go to Settings → Location & Shipping -> Shipping Profiles.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens:
- In the Name field, enter a name for the shipping profile. For example, "Fragile".
- In the Type field, enter the type of products that belong to the shipping profile. For example, "fragile" or "heavy".
@@ -78,14 +78,14 @@ Metadata is custom data that can be associated with the shipping profile in key-
To edit the shipping profile's metadata:
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon in the "Metadata" section.
2. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Delete row" from the dropdown.
3. Once you're done, click the Save button.
@@ -102,6 +102,6 @@ Deleting a shipping profile is irreversible.
To delete a shipping profile:
1. Go to the shipping profile's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Delete from the dropdown.
4. Confirm the deletion by entering the shipping profile's name in the pop-up and clicking the Delete button.
www/apps/user-guide/app/settings/product-tags/page.mdx
+6 -6
View File
@@ -32,7 +32,7 @@ To view product tags in your store, go to Settings → Product Tags. Here, you c
To create a product tag:
1. Go to Settings → Product Tags.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens, enter a value for the product tag in the Value field. For example, "Digital".
4. Once you're done, click the Create button.
@@ -58,7 +58,7 @@ This opens the product tag's details page where you can also manage the product
To edit the details of a product tag:
1. Go to the product tag's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the product tag's value.
5. Once you're done, click the Save button.
@@ -85,14 +85,14 @@ Metadata is custom data that can be associated with the product tag in key-value
To edit the product tag's metadata:
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon in the "Metadata" section.
2. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Delete row" from the dropdown.
3. Once you're done, click the Save button.
@@ -109,6 +109,6 @@ Deleting a product tag is irreversible.
To delete a product tag:
1. Go to the product tag's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Delete from the dropdown.
4. Confirm the deletion by clicking the Delete button in the pop-up.
www/apps/user-guide/app/settings/product-types/page.mdx
+6 -6
View File
@@ -32,7 +32,7 @@ To view product types in your store, go to Settings → Product Types. Here, you
To create a product type:
1. Go to Settings → Product Types.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens, enter a value for the product type in the Value field. For example, "Digital".
4. Once you're done, click the Create button.
@@ -58,7 +58,7 @@ This opens the product type's details page where you can also manage the product
To edit the details of a product type:
1. Go to the product type's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the product type's value.
5. Once you're done, click the Save button.
@@ -79,14 +79,14 @@ Metadata is custom data that can be associated with the product type in key-valu
To edit the product type's metadata:
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon in the "Metadata" section.
2. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Delete row" from the dropdown.
3. Once you're done, click the Save button.
@@ -103,6 +103,6 @@ Deleting a product type is irreversible.
To delete a product type:
1. Go to the product type's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Delete from the dropdown.
4. Confirm the deletion by clicking the Delete button in the pop-up.
www/apps/user-guide/app/settings/profile/page.mdx
+2 -2
View File
@@ -20,7 +20,7 @@ In this guide, you’ll learn how to view and manage your profile's details and
## View Profile Details
To view your profile details, go to Settings → Profile. You can alternatively click on your name at the bottom right of the sidebar, and choose "Profile settings" from the menu.
To view your profile details, go to Settings → Profile. You can alternatively click on your name at the bottom of the sidebar, and choose "Profile settings" from the menu.
In your profile details page, you can view your profile information such as your name, email, and language settings.
@@ -33,7 +33,7 @@ In your profile details page, you can view your profile information such as your
To edit your profile details and settings:
1. Go to Settings → Profile.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the main section's header.
3. Choose "Edit" from the dropdown.
4. In the side window that opens, you can edit your first and last name, and the Medusa Admin dashboard language. This only changes the language of the admin interface, not the language of the store. It also doesn't change the language for other users in the admin.
5. Once you're done, click the Save button.
www/apps/user-guide/app/settings/regions/page.mdx
+7 -7
View File
@@ -48,7 +48,7 @@ To view regions in your store, go to Settings → Regions. Here, you can see a l
To create a region:
1. Go to Settings → Regions.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens:
- In the Name field, enter a name for the region. For example, "Europe".
- In the Currency field, select the region's currency. A region can only have one currency.
@@ -83,7 +83,7 @@ This opens the region's details page where you can also manage the region.
To edit a region's details:
1. Go to the region's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the region's name, currency, payment providers, and settings for automatic taxes and [tax-inclusive pricing](#tax-inclusive-pricing-for-regions).
5. Once you're done, click the Save button.
@@ -101,7 +101,7 @@ You can manage a region's countries to add or remove them from the region.
To add countries to a region:
1. Go to the region's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Countries" section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the "Countries" section's header.
3. Choose "Add countries" from the dropdown.
4. In the list that opens, check the countries you want to add to the region.
5. Once you're done, click the Add button.
@@ -125,14 +125,14 @@ Metadata is custom data that can be associated with the region in key-value pair
To edit the region's metadata:
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon in the "Metadata" section.
2. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Delete row" from the dropdown.
3. Once you're done, click the Save button.
@@ -149,6 +149,6 @@ Deleting a region is irreversible.
To delete a region from your store:
1. Go to the region's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Delete from the dropdown.
4. Confirm deleting the region by typing the region's name in the pop-up and clicking the Delete button.
www/apps/user-guide/app/settings/return-reasons/page.mdx
+3 -3
View File
@@ -39,7 +39,7 @@ To view return reasons in your store, go to Settings → Return Reasons. Here, y
To create a return reason:
1. Go to Settings → Return Reasons.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens:
- Enter in the Value field a unique identifier for the reason that's used internally. It's recommended to use only lowercase letters and underscores (`_`). For example, "damaged" or "wrong_size".
- Enter in the Label field what is shown to customers or admin users.
@@ -55,7 +55,7 @@ To create a return reason:
To edit a return reason:
1. Go to Settings → Return Reasons.
2. Find the return reason to edit and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. Find the return reason to edit and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in its row.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the return reason's value, label, and description.
5. Once you're done, click the Save button.
@@ -75,6 +75,6 @@ Deleting a return reason is irreversible.
To delete a return reason:
1. Go to Settings → Return Reasons.
2. Find the return reason to delete and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. Find the return reason to delete and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in its row.
3. Choose Delete from the dropdown.
4. Confirm deleting the return reason by clicking the Delete button in the pop-up.
www/apps/user-guide/app/settings/sales-channels/page.mdx
+4 -4
View File
@@ -53,7 +53,7 @@ To view sales channels in your store, go to Settings → Sales Channels. Here, y
To create a sales channel:
1. Go to Settings → Sales Channels.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens:
- In the Name field, enter a name for the sales channel. For example, "Web Storefront".
- In the Description field, enter a description of the sales channel.
@@ -77,7 +77,7 @@ This opens the sales channel's details page where you can also manage the sales
### Sales Channel Status
The status of a sales channel is shown at the top right of the first section in the details page. The status can be either "Enabled" or "Disabled". You can change the status by [editing the sales channel details](#edit-sales-channel-details).
The status of a sales channel is shown in the header of the first section in the details page. The status can be either "Enabled" or "Disabled". You can change the status by [editing the sales channel details](#edit-sales-channel-details).
---
@@ -86,7 +86,7 @@ The status of a sales channel is shown at the top right of the first section in
To edit the details of a sales channel:
1. Go to the sales channel's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the sales channel's name, description, and whether it's enabled.
5. Once you're done, click the Save button.
@@ -134,6 +134,6 @@ Deleting a sales channel is irreversible.
To delete a sales channel:
1. Go to the sales channel's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Delete from the dropdown.
4. Confirm deleting the sales channel by entering the sales channel's name and clicking the "Delete" button in the pop-up.
www/apps/user-guide/app/settings/store/page.mdx
+7 -7
View File
@@ -32,7 +32,7 @@ To view your store's details, go to Settings → Store. There, you can view and
To edit the store’s details:
1. Go to Settings → Store.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Store" section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the "Store" section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the store's name, default currency, default region, default sales channel, and default location. These defaults are used in the storefront if no other values are provided.
5. Once you're done, click the Save button.
@@ -50,10 +50,10 @@ Your store can support multiple currencies, allowing customers to view prices in
To add currencies to your store:
1. Go to Settings → Store.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Currencies" section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the "Currencies" section's header.
3. Choose Add from the dropdown.
4. In the list that opens, check the currencies you want to add to the store.
- To enable [tax-inclusive pricing](#edit-tax-inclusive-setting-for-currency) for a currency, enable the toggle at the currency's right.
- To enable [tax-inclusive pricing](#edit-tax-inclusive-setting-for-currency) for a currency, enable the toggle next to the currency.
5. Once you're done, click the Save button.
![Add currencies to store](https://res.cloudinary.com/dza7lstvk/image/upload/v1739963867/User%20Guide/Screenshot_2025-02-19_at_1.17.37_PM_mjrxng.png)
@@ -68,7 +68,7 @@ In the store's settings, you can also manage a currency's tax-inclusive price se
You can manage whether a currency uses tax-inclusive pricing when adding or editing it. To edit the tax-inclusive setting for a currency:
1. Go to Settings → Store.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the currency you want to edit.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to the currency you want to edit.
3. Choose "Enable tax-inclusive pricing" or "Disable tax-inclusive pricing" from the dropdown, depending on the current setting.
### Remove Currencies
@@ -92,13 +92,13 @@ Metadata is custom data that can be associated with the store in key-value pairs
To edit the store's metadata:
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon in the "Metadata" section.
2. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Delete row" from the dropdown.
3. Once you're done, click the Save button.
www/apps/user-guide/app/settings/tax-regions/page.mdx
+7 -7
View File
@@ -41,7 +41,7 @@ To view tax regions in your store, go to Settings → Tax Regions. Here, you can
To create a tax region:
1. Go to Settings → Tax Regions.
2. Click the Create button at the top right.
2. Click the Create button in the main section's header.
3. In the form that opens:
- In the Country field, select the country that this tax region applies to.
- Under the "Default tax rate" section, you can optionally enter a name, tax rate, and tax code in their respective fields.
@@ -69,7 +69,7 @@ This opens the tax region's details page, where you can also manage the tax regi
To edit a tax region:
1. Go to the tax region's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the tax region's name.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the end of the tax region's row.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the tax region's default tax provider.
5. Once you're done, click the Save button.
@@ -83,7 +83,7 @@ To edit a tax region:
To edit the default tax rate of a region:
1. Go to the tax region's details page.
2. In the first section, you'll find details of the default tax rate, including its tax rate and code. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
2. In the first section, you'll find details of the default tax rate, including its tax rate and code. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its end.
![The icon to click on](https://res.cloudinary.com/dza7lstvk/image/upload/v1739974452/User%20Guide/Screenshot_2025-02-19_at_4.13.51_PM_zclvnp.png)
@@ -122,7 +122,7 @@ To create a tax rate override for a product or product type in a tax region:
To edit a tax rate override:
1. Go to the region's details page.
2. In the "Overrides" section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the override you want to edit.
2. In the "Overrides" section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to the override you want to edit.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the override's name, rate, code, and whether the tax rate should be combined with the default rate. You can also edit the targets of the override.
5. Once you're done, click the Save button.
@@ -140,7 +140,7 @@ Deleting a tax rate override is irreversible.
To delete a tax rate override:
1. Go to the region's details page.
2. In the "Overrides" section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the override you want to delete.
2. In the "Overrides" section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to the override you want to delete.
3. Choose Delete from the dropdown.
4. Confirm deleting the override by clicking the Delete button in the pop-up.
@@ -199,7 +199,7 @@ Deleting a sublevel tax region is irreversible.
To delete a sublevel tax region:
1. Go to the sublevel tax region's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the sublevel tax region's name.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the sublevel tax region's row.
3. Choose Delete from the dropdown.
4. Confirm deleting the sublevel tax region by clicking the Delete button in the pop-up.
@@ -216,6 +216,6 @@ Deleting a tax region is irreversible.
To delete a tax region:
1. Go to the tax region's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the tax region's name.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the tax region's row.
3. Choose Delete from the dropdown.
4. Confirm deleting the tax region by clicking the Delete button in the pop-up.
www/apps/user-guide/app/settings/users/page.mdx
+5 -5
View File
@@ -50,7 +50,7 @@ This opens the user's details page where you can also manage the user.
To edit the details of an admin user:
1. Go to the user's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the user's first and last names.
5. Once done, click the Save button.
@@ -65,14 +65,14 @@ Metadata is custom data that can be associated with the user in key-value pairs.
To edit the user's metadata:
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon in the "Metadata" section.
2. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
- Choose "Delete row" from the dropdown.
3. Once you're done, click the Save button.
@@ -90,6 +90,6 @@ To delete a user from your store:
1. Go to Settings → Users.
2. Find the user in the list and click on it.
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
4. Choose Delete from the dropdown.
4. Confirm deleting the user by entering their name and clicking the "Delete" button in the pop-up.