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

docs: added dividers + see also section (#2899)

Browse Source
This commit is contained in:
Shahed Nasser
2022-12-26 15:52:08 +02:00
committed by GitHub
parent b0e5769e27
commit b0ebfd6bcf
100 changed files with 1047 additions and 291 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/content/advanced/admin/import-prices.mdx
View File

@@ -15,6 +15,8 @@ Importing prices into a price list removes all existing prices in the price list
:::
---
## Prerequisites
### Medusa Components
@@ -54,6 +56,8 @@ Before importing the prices, you must have a price list to import them to.
You can use the [Create Price List](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/PostPriceListsPriceList) endpoint, or follow the [how-to guide to learn how to create and manage price lists using the Admin API](../backend/price-lists/use-api.mdx).
---
## 1. Upload CSV File
The first step is to upload the CSV file to import prices from.
@@ -106,6 +110,8 @@ curl -L -X POST '<YOUR_SERVER>/admin/uploads' \
This request returns an array of uploads. Each item in the array is an object that includes the properties `url` and `key`. You’ll need the `key` to import the prices next.
---
## 2. Create a Batch Job for Prices Import
To start a new price import, you must create a batch job.
@@ -192,6 +198,8 @@ If you don’t set `dry_run` or you set it to `false`, you don’t need to follo
:::
---
## (Optional) Retrieve Batch Job
After creating the batch job, it will be pre-processed. At this point, the CSV file will be validated, and the number of prices to add are counted.
@@ -253,6 +261,8 @@ Here’s an example of the `result` property:
},
```
---
## 3. Confirm Batch Job
A batch job can be confirmed only once the batch job has the status `pre_processed`. Once you confirm a batch job, the price import will start which will add prices to the price list
@@ -305,7 +315,9 @@ After confirming the batch job, you can check the status while it is processing
- If the status is `failed`, it means an error has occurred during the import. You can check the error in `result.errors`.
- If the status is `completed`, it means the import has finished successfully.
## What’s Next 🚀
---
- Learn more about [Batch Jobs and how they work](../backend/batch-jobs/index.md).
- Check out the [Batch Jobs API Reference](https://docs.medusajs.com/api/admin/#tag/Batch-Job).
## See Also
- [Batch Jobs Overview](../backend/batch-jobs/index.md)
- [Batch Jobs API Reference](https://docs.medusajs.com/api/admin/#tag/Batch-Job)

18
docs/content/advanced/admin/import-products.mdx
View File

@@ -9,6 +9,8 @@ In this document, you’ll learn how to use the Admin APIs to bulk import produc
Using Medusa’s [Batch Job Admin APIs](https://docs.medusajs.com/api/admin/#tag/Batch-Job), you can import products into your Medusa server. This will either add new products or update existing products.
---
## Prerequisites
### Medusa Components
@@ -48,6 +50,8 @@ You must be an authenticated admin user before following along with the steps in
You can learn more about [authenticating as an admin user in the API reference](/api/admin/#section/Authentication).
---
## 1. Upload CSV File
The first step is to upload the CSV file that you want to import products.
@@ -100,6 +104,8 @@ curl -L -X POST '<YOUR_SERVER>/admin/uploads' \
This request returns an array of uploads. Each item in the array is an object that includes the properties `url` and `key`. You’ll need the `key` to import the products next.
---
## 2. Create a Batch Job for Product Import
To start a new product import, you must create a batch job.
@@ -180,6 +186,8 @@ If you don’t set `dry_run` or you set it to `false`, you don’t need to follo
:::
---
## (Optional) Retrieve Batch Job
After creating the batch job, it will be pre-processed. At this point, the CSV file will be validated, and the number of products to add and update, or that are rejected are counted.
@@ -241,6 +249,8 @@ Here’s an example of the `result` property:
},
```
---
## 3. Confirm Batch Job
A batch job can be confirmed only once the batch job has the status `pre_processed`. Once you confirm a batch job, the product import will start which will create or update products on your server.
@@ -293,7 +303,9 @@ After confirming the batch job, you can check the status while it is processing
- If the status is `failed`, it means an error has occurred during the import. You can check the error in `result.errors`.
- If the status is `completed`, it means the import has finished successfully.
## What’s Next
---
- Learn more about [Batch Jobs and how they work](../backend/batch-jobs/index.md).
- Check out the [Batch Jobs API Reference](https://docs.medusajs.com/api/admin/#tag/Batch-Job).
## See Also
- [Batch Jobs Overview](../backend/batch-jobs/index.md)
- [Batch Jobs API Reference](https://docs.medusajs.com/api/admin/#tag/Batch-Job)

18
docs/content/advanced/admin/manage-discounts.mdx
View File

@@ -29,6 +29,8 @@ You can use Medusa’s Admin APIs to achieve more functionalities as well. Check
:::
---
# Prerequisites
### Medusa Components
@@ -47,6 +49,8 @@ You must be an authenticated admin user before following along with the steps in
You can learn more about [authenticating as an admin user in the API reference](/api/admin/#section/Authentication).
---
## Create a Discount
You can create a discount by sending a request to the [Create Discount](/api/admin/#tag/Discount/operation/PostDiscounts) endpoint:
@@ -135,6 +139,8 @@ This request accepts [many request-body parameters](/api/admin/#tag/Discount/ope
This request returns the full `discount` object.
---
## Update Discount
You can update any of the discount’s information, configurations, and conditions by sending a request to the [Update Discount](/api/admin/#tag/Discount/operation/PostDiscountsDiscount) endpoint.
@@ -197,6 +203,8 @@ You can check the [API reference](/api/admin/#tag/Discount/operation/PostDiscoun
This updates the discount’s information and returns the full updated `discount` object in the response.
---
## Manage Conditions
### Create a Condition
@@ -441,6 +449,8 @@ This request accepts as a path parameter the discount ID and the condition ID.
It returns the `discount` object in the response.
---
## Delete Discount
You can delete a discount by sending a request to the [Delete Discount](/api/admin/#tag/Discount/operation/DeleteDiscountsDiscount) endpoint:
@@ -488,7 +498,9 @@ It returns in the response the following fields:
- `object`: A string indicating the type of object deleted. By default, its value is `discount`.
- `deleted`: A boolean value indicating whether the discount was deleted or not.
## What’s Next
---
- Check out more [Admin Discount APIs in the API reference](/api/admin/#tag/Discount).
- Learn how you can [use Discounts on the storefront](../storefront/use-discounts-in-checkout.mdx).
## See Also
- [Discounts API reference](/api/admin/#tag/Discount)
- [Use Discounts on the storefront](../storefront/use-discounts-in-checkout.mdx)

6
docs/content/advanced/admin/manage-regions.mdx
View File

@@ -397,7 +397,7 @@ This request requires the region ID as a path parameter. It deletes the region a
---
## What’s Next
## See Also
- Learn more about [Regions’ architecture](../backend/regions/overview.md).
- Learn [how to use Regions on the storefront](../storefront/use-regions.mdx).
- [Regions Overview](../backend/regions/overview.md)
- [Use Regions on the storefront](../storefront/use-regions.mdx)

8
docs/content/advanced/admin/order-edit.mdx
View File

@@ -605,7 +605,9 @@ Check out what other parameters can be sent in the [API reference](/api/admin/#t
It returns in the response the full Refund object.
## What’s Next
---
- Learn how to [handle order edits on the storefront](../storefront/handle-order-edits).
- Check out more [order edit endpoints in the API reference](/api/admin/#tag/OrderEdit).
## See Also
- [Handle order edits on the storefront](../storefront/handle-order-edits).
- [Order Edits API reference](/api/admin/#tag/OrderEdit).

6
docs/content/advanced/admin/use-customergroups-api.mdx
View File

@@ -468,7 +468,7 @@ When you create or update a price list, you can specify one or more customer gro
---
## What’s Next
## See Also
- Learn more about [Customer Groups](../backend/customer-groups/index.md).
- Learn about [how to use Sales Channels](../backend/sales-channels/manage-admin.mdx).
- [Customer Groups Overview](../backend/customer-groups/index.md).
- [Use Sales Channels Admin APIs](../backend/sales-channels/manage-admin.mdx).