From b2ae04f3e4019ae7014ff71121116c9ca28f2f6a Mon Sep 17 00:00:00 2001 From: Hayden <64056131+hay-kot@users.noreply.github.com> Date: Sat, 15 Oct 2022 17:42:11 -0800 Subject: [PATCH] add docs --- docs/docs/import-csv.md | 46 ++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/docs/import-csv.md b/docs/docs/import-csv.md index 9c5e587..ea32b8f 100644 --- a/docs/docs/import-csv.md +++ b/docs/docs/import-csv.md @@ -23,29 +23,29 @@ Import RefLocation Labels Quantity Name Description Insured Serial Number Model ## CSV Reference -| Column | Type | Description | -| ----------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| ImportRef | String (100) | Future | -| Location | String | This is the location of the item that will be created. These are de-duplicated and won't create another instance when reused. | -| Labels | `;` Separated String | List of labels to apply to the item separated by a `;`, can be existing or new | -| Quantity | Integer | The quantity of items to create | -| Name | String | Name of the item | -| Description | String | Description of the item | -| Insured | Boolean | Whether or not the item is insured | -| Serial Number | String | Serial number of the item | -| Model Number | String | Model of the item | -| Manufacturer | String | Manufacturer of the item | -| Notes | String (1000) | General notes about the product | -| Purchase From | String | Name of the place the item was purchased from | -| Purchase Price | Float64 | | -| Purchase At | Date | Date the item was purchased | -| Lifetime Warranty | Boolean | true or false - case insensitive | -| Warranty Expires | Date | Date in the format | -| Warranty Details | String | Details about the warranty | -| Sold To | String | Name of the person the item was sold to | -| Sold At | Date | Date the item was sold | -| Sold Price | Float64 | | -| Sold Notes | String (1000) | | +| Column | Type | Description | +| ----------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ImportRef | String (100) | Import Refs are unique strings that can be used to deduplicate imports. Before an item is imported, we check the database for a matching ref. If the ref exists, we skip that item. | +| Location | String | This is the location of the item that will be created. These are de-duplicated and won't create another instance when reused. | +| Labels | `;` Separated String | List of labels to apply to the item separated by a `;`, can be existing or new | +| Quantity | Integer | The quantity of items to create | +| Name | String | Name of the item | +| Description | String | Description of the item | +| Insured | Boolean | Whether or not the item is insured | +| Serial Number | String | Serial number of the item | +| Model Number | String | Model of the item | +| Manufacturer | String | Manufacturer of the item | +| Notes | String (1000) | General notes about the product | +| Purchase From | String | Name of the place the item was purchased from | +| Purchase Price | Float64 | | +| Purchase At | Date | Date the item was purchased | +| Lifetime Warranty | Boolean | true or false - case insensitive | +| Warranty Expires | Date | Date in the format | +| Warranty Details | String | Details about the warranty | +| Sold To | String | Name of the person the item was sold to | +| Sold At | Date | Date the item was sold | +| Sold Price | Float64 | | +| Sold Notes | String (1000) | | **Type Key**