Skip to content

Commit 0da188a

Browse files
authored
docs: add missing details in product import user guide (medusajs#11527)
1 parent 3281613 commit 0da188a

File tree

1 file changed

+22
-14
lines changed
  • www/apps/user-guide/app/products/import

1 file changed

+22
-14
lines changed

www/apps/user-guide/app/products/import/page.mdx

+22-14
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ When you import the CSV file, Medusa will either create or update products based
2121

2222
### CSV File Format
2323

24-
In the import form, you can download a template CSV file to see the format required for the import. The CSV file can have the following columns:
24+
In the import form, you can download a template CSV file to see the format required for the import.
2525

26-
{/* TODO need updates */}
26+
Each row in the CSV file represents a product variant to create or update. The columns in the CSV file holds the details of the product variant and its associated product. The CSV file can have the following columns:
2727

2828
<Table>
2929
<Table.Header>
@@ -74,8 +74,8 @@ In the import form, you can download a template CSV file to see the format requi
7474
<Table.Cell>The ID of the product type.</Table.Cell>
7575
</Table.Row>
7676
<Table.Row>
77-
<Table.Cell>`Product Category 1`</Table.Cell>
78-
<Table.Cell>The primary category of the product.</Table.Cell>
77+
<Table.Cell>`Product Category *`</Table.Cell>
78+
<Table.Cell>The ID of a product category, where `*` is the number of the category, allowing you to add more than one category. For example, `Product Category 1`. </Table.Cell>
7979
</Table.Row>
8080
<Table.Row>
8181
<Table.Cell>`Product Created At`</Table.Cell>
@@ -87,7 +87,7 @@ In the import form, you can download a template CSV file to see the format requi
8787
</Table.Row>
8888
<Table.Row>
8989
<Table.Cell>`Product Discountable`</Table.Cell>
90-
<Table.Cell>Whether the product can be discounted. Can be `TRUE` or `FALSE`.</Table.Cell>
90+
<Table.Cell>Whether the product can be discounted. Can be `true` or `false`.</Table.Cell>
9191
</Table.Row>
9292
<Table.Row>
9393
<Table.Cell>`Product Height`</Table.Cell>
@@ -99,7 +99,7 @@ In the import form, you can download a template CSV file to see the format requi
9999
</Table.Row>
100100
<Table.Row>
101101
<Table.Cell>`Product Image *`</Table.Cell>
102-
<Table.Cell>The URL of a product image, where `*` is the image's number. For example, `Product Image 1`.</Table.Cell>
102+
<Table.Cell>The URL of a product image, where `*` is the image's number, allowing you to add more than one image. For example, `Product Image 1`.</Table.Cell>
103103
</Table.Row>
104104
<Table.Row>
105105
<Table.Cell>`Product Length`</Table.Cell>
@@ -119,7 +119,11 @@ In the import form, you can download a template CSV file to see the format requi
119119
</Table.Row>
120120
<Table.Row>
121121
<Table.Cell>`Product Tag *`</Table.Cell>
122-
<Table.Cell>The ID of the product's tag, where `*` is the tag's number. For example, `Product Tag 1`.</Table.Cell>
122+
<Table.Cell>The ID of the product's tag, where `*` is the tag's number, allowing you to add more than one tag. For example, `Product Tag 1`.</Table.Cell>
123+
</Table.Row>
124+
<Table.Row>
125+
<Table.Cell>`Product Sales Channel *`</Table.Cell>
126+
<Table.Cell>The ID of a sales channel the product is available in, where `*` is the sales channel's number, allowing you to add more than one sales channel. For example, `Product Sales Channel 1`.</Table.Cell>
123127
</Table.Row>
124128
<Table.Row>
125129
<Table.Cell>`Product Updated At`</Table.Cell>
@@ -133,10 +137,6 @@ In the import form, you can download a template CSV file to see the format requi
133137
<Table.Cell>`Product Width`</Table.Cell>
134138
<Table.Cell>The width of the product.</Table.Cell>
135139
</Table.Row>
136-
<Table.Row>
137-
<Table.Cell>`Shipping Profile Id`</Table.Cell>
138-
<Table.Cell>The ID of the product's shipping profile.</Table.Cell>
139-
</Table.Row>
140140
<Table.Row>
141141
<Table.Cell>`Variant Id`</Table.Cell>
142142
<Table.Cell>The ID for an existing variant to update. The variant must belong to the product specified in the `Product Id` column. If provided, no other variant-related columns are required.</Table.Cell>
@@ -167,11 +167,11 @@ In the import form, you can download a template CSV file to see the format requi
167167
</Table.Row>
168168
<Table.Row>
169169
<Table.Cell>`Variant Manage Inventory`</Table.Cell>
170-
<Table.Cell>Whether Medusa manages the variant's inventory. Can be `TRUE` or `FALSE`.</Table.Cell>
170+
<Table.Cell>Whether Medusa manages the variant's inventory. Can be `true` or `false`.</Table.Cell>
171171
</Table.Row>
172172
<Table.Row>
173173
<Table.Cell>`Variant Allow Backorder`</Table.Cell>
174-
<Table.Cell>Whether the variant allows backorders. Can be `TRUE` or `FALSE`.</Table.Cell>
174+
<Table.Cell>Whether the variant allows backorders. Can be `true` or `false`.</Table.Cell>
175175
</Table.Row>
176176
<Table.Row>
177177
<Table.Cell>`Variant Barcode`</Table.Cell>
@@ -217,6 +217,10 @@ In the import form, you can download a template CSV file to see the format requi
217217
<Table.Cell>`Variant Price *`</Table.Cell>
218218
<Table.Cell>The price of the variant in a currency, where `*` is the currency's ISO code. For example, `Variant Price USD`.</Table.Cell>
219219
</Table.Row>
220+
<Table.Row>
221+
<Table.Cell>`Variant Price [X] Y`</Table.Cell>
222+
<Table.Cell>The price of the variant in a region, where `X` is the region's name, and `Y` is the ISO currency code of the region. For example, `Variant Price Europe [EUR]`.</Table.Cell>
223+
</Table.Row>
220224
<Table.Row>
221225
<Table.Cell>`Variant Product Id`</Table.Cell>
222226
<Table.Cell>The ID of the product the variant belongs to.</Table.Cell>
@@ -227,7 +231,7 @@ In the import form, you can download a template CSV file to see the format requi
227231
</Table.Row>
228232
<Table.Row>
229233
<Table.Cell>`Variant Variant Rank`</Table.Cell>
230-
<Table.Cell>The rank of the variant.</Table.Cell>
234+
<Table.Cell>The rank of the variant among its siblings. Can be `0` or higher.</Table.Cell>
231235
</Table.Row>
232236
<Table.Row>
233237
<Table.Cell>`Variant Weight`</Table.Cell>
@@ -237,6 +241,10 @@ In the import form, you can download a template CSV file to see the format requi
237241
<Table.Cell>`Variant Width`</Table.Cell>
238242
<Table.Cell>The width of the variant.</Table.Cell>
239243
</Table.Row>
244+
<Table.Row>
245+
<Table.Cell>`Shipping Profile Id`</Table.Cell>
246+
<Table.Cell>The ID of the shipping profile that the product belongs to.</Table.Cell>
247+
</Table.Row>
240248
</Table.Body>
241249
</Table>
242250

0 commit comments

Comments
 (0)