Help
Print
For instructions on how to save an Excel file to CSV (comma delimited) format using Microsoft Office Excel please check out this link: https://support.microsoft.com/en-us/office/save-a-workbook-to-text-format-txt-or-csv-3e9a9d6c-70da-4255-aa28-fcacf1f081e6
Note - fields with an * must have a value supplied. For optional fields leave the value as empty or NULL.
code
This is a string which must contain a unique code. You can use your own code, or you can leave the field blank (or NULL) and a code will be auto generated. When products are uploaded, they will be matched against this code.
first_name*
A string representing the account owners first name (e.g Bob).
surname*
A string representing the account owners surname (e.g Smith).
company
A string representing the company the account belongs too (e.g 'Bob's Shoe Ltd'
address
A string representing the account owners address (e.g:
54 Test Street
Los Angeles, CA 90063).
notes
Note - fields with an * must have a value supplied. For optional fields leave the value as empty or NULL.
sku
This is a string which must contain a unique code. You can use your own code, or you can leave the field blank (or NULL) and a code will be auto generated.
Defaults to 1 (Consignment) if left empty or NULL.
size
A string representing the size of a product (e.g M or 12).
consignor_percent
A number representing the split % the products account owner should receive on sale of this item (e.g 50), if the product is of type Consignment. If left blank or NULL the % will default to the account's default split.
terms_id
A number indicating the default terms for this product if it does not sell. If empty or NULL will default to the account owners default terms.
1 = Donate
expires_date
A string representing the date this item will be set as expires. Important - It must exactly match the date format specified in your store settings, or conversion to UTC (how we store it in the database) will fail, or the days/month will be the wrong way around!
surcharges
Importing Data
If you already have some data in csv (or Excel) format that you want to get into ConsignHQ you can use our csv templates to easily import data. Categories, Brands, Accounts (your Consignors) and Products (your Inventory) can be uploaded via CSV files.
First you'll need a .csv file on your computer with the data you want to import. The format of this file will differ depending on the type of data you are importing, see the sections below for some example templates.
You can use Excel or Google Sheets to create CSV files, or to convert existing Excel files, if you wish. You'll just need to choose 'Save as CSV (comma delimited)' (or a similar option depending on the version you use) when you Save As or Export your Excel file.
You can use Excel or Google Sheets to create CSV files, or to convert existing Excel files, if you wish. You'll just need to choose 'Save as CSV (comma delimited)' (or a similar option depending on the version you use) when you Save As or Export your Excel file.
For instructions on how to save an Excel file to CSV (comma delimited) format using Microsoft Office Excel please check out this link: https://support.microsoft.com/en-us/office/save-a-workbook-to-text-format-txt-or-csv-3e9a9d6c-70da-4255-aa28-fcacf1f081e6
Our import feature is particularly useful if you are migrating data from a different system into ConsignHQ.
Import Categories
Categories (for example 'jackets, shoes') can be imported by going to the Categories screen.
Click 'Import CSV'. A dialog will appear. Press 'Select CSV' and choose a .csv file from your computer that you have previously exported/saved from Excel or a different system. Then press 'Upload'.
Wait a few seconds and the categories will then be automatically created in the system. If a category already exists it will be ignored. The screen will display a report of succesfully imported rows (or an error if the file, or row, is not in the correct format).
The format of the csv file is very simple. The first line should contain the column header 'name', and subsequent lines should contain the name of the category you wish to import.
Click here to download category .csv example
The example template includes some common fashion categories. The easiest way to view the template file will be to open it in Excel or Google Sheets (just makes sure to export/save it as .csv if you make any changes).
Click 'Import CSV'. A dialog will appear. Press 'Select CSV' and choose a .csv file from your computer that you have previously exported/saved from Excel or a different system. Then press 'Upload'.
Wait a few seconds and the categories will then be automatically created in the system. If a category already exists it will be ignored. The screen will display a report of succesfully imported rows (or an error if the file, or row, is not in the correct format).
The format of the csv file is very simple. The first line should contain the column header 'name', and subsequent lines should contain the name of the category you wish to import.
Click here to download category .csv example
The example template includes some common fashion categories. The easiest way to view the template file will be to open it in Excel or Google Sheets (just makes sure to export/save it as .csv if you make any changes).
Import Brands
Brands (for example 'adidas', 'nike'), can be imported by going to the Brands screen.
Click 'Import CSV'. A dialog will appear. Press 'Select CSV' and choose a .csv file from your computer that you have previously exported/saved from Excel or a different system. Then press 'Upload'.
Wait a few seconds and the brands will then be automatically created in the system. If a brand already exists it will be ignored. The screen will display a report of succesfully imported rows (or an error if the file, or row, is not in the correct format).
The format of the csv file is very simple. The first line should contain the column header 'name', and subsequent lines should contain the name of the category you wish to import.
Click 'Import CSV'. A dialog will appear. Press 'Select CSV' and choose a .csv file from your computer that you have previously exported/saved from Excel or a different system. Then press 'Upload'.
Wait a few seconds and the brands will then be automatically created in the system. If a brand already exists it will be ignored. The screen will display a report of succesfully imported rows (or an error if the file, or row, is not in the correct format).
The format of the csv file is very simple. The first line should contain the column header 'name', and subsequent lines should contain the name of the category you wish to import.
Click here to download brand .csv example
The example template includes some common fashion categories. The easiest way to view the template file will be to open it in Excel or Google Sheets (just makes sure to export/save it as .csv if you make any changes).
The example template includes some common fashion categories. The easiest way to view the template file will be to open it in Excel or Google Sheets (just makes sure to export/save it as .csv if you make any changes).
Import Accounts (Consignors)
Accounts(for example your consignors), can be imported by going to the Accounts screen.
Click 'Import CSV'. A dialog will appear. Press 'Select CSV' and choose a .csv file from your computer that you have previously exported/saved from Excel or a different system. Then press 'Upload'.
Wait a few seconds and the accounts will then be automatically created in the system. If an account already exists it will be ignored. The screen will display a report of succesfully imported rows (or an error if the file, or row, is not in the correct format).
Click 'Import CSV'. A dialog will appear. Press 'Select CSV' and choose a .csv file from your computer that you have previously exported/saved from Excel or a different system. Then press 'Upload'.
Wait a few seconds and the accounts will then be automatically created in the system. If an account already exists it will be ignored. The screen will display a report of succesfully imported rows (or an error if the file, or row, is not in the correct format).
Click here to download account .csv example
The example template includes demo rows. The easiest way to view the template file will be to open it in Excel or Google Sheets (just makes sure to export/save it as .csv if you make any changes).
Description of fields:
The CSV must contain the following fields, in the same order as in the template. You must have all field names in the first row (even the not required ones).
The example template includes demo rows. The easiest way to view the template file will be to open it in Excel or Google Sheets (just makes sure to export/save it as .csv if you make any changes).
Description of fields:
The CSV must contain the following fields, in the same order as in the template. You must have all field names in the first row (even the not required ones).
Note - fields with an * must have a value supplied. For optional fields leave the value as empty or NULL.
code
This is a string which must contain a unique code. You can use your own code, or you can leave the field blank (or NULL) and a code will be auto generated. When products are uploaded, they will be matched against this code.
first_name*
A string representing the account owners first name (e.g Bob).
surname*
A string representing the account owners surname (e.g Smith).
company
A string representing the company the account belongs too (e.g 'Bob's Shoe Ltd'
particularly useful for recording where non consignment stock came from.
mobile_phone
The accounts mobile phone number.
home_phone
The accounts landline phone number.
bank
The bank account # to make payouts to for this account.
Note - ConsignHQ doesn't currently handle payouts directly into a bank account, this field is only stored for informational purposes so you can refer to it when flagging a balance as paid.
email*
The accounts email address. This is where notifications on sale of a Consignors products will go.
split
A number representing the consignor split % this account should receive on sale of their consignment items, e.g 50. If left blank or NULL then their split % will default to the store default.
notifications*
A number (1 for yes, 0 for no) or boolean (True, False) indicating if this account should recieve email notifications automatically when their consignment products sell.
balance*
A decimal number (e.g 150.40) representing the start balance on the account. Usually this will be 0 for new accounts. Do not include currency symbol.
inventory_type_id*
A number indicating the default inventory type (when adding products) for this account.
1 = Consignment
mobile_phone
The accounts mobile phone number.
home_phone
The accounts landline phone number.
bank
The bank account # to make payouts to for this account.
Note - ConsignHQ doesn't currently handle payouts directly into a bank account, this field is only stored for informational purposes so you can refer to it when flagging a balance as paid.
email*
The accounts email address. This is where notifications on sale of a Consignors products will go.
split
A number representing the consignor split % this account should receive on sale of their consignment items, e.g 50. If left blank or NULL then their split % will default to the store default.
notifications*
A number (1 for yes, 0 for no) or boolean (True, False) indicating if this account should recieve email notifications automatically when their consignment products sell.
balance*
A decimal number (e.g 150.40) representing the start balance on the account. Usually this will be 0 for new accounts. Do not include currency symbol.
inventory_type_id*
A number indicating the default inventory type (when adding products) for this account.
1 = Consignment
2 = Buy Outright
3 = Retail
terms_id*
A number indicating the default terms on consignment inventory that does not sell.
1 = Donate
3 = Retail
terms_id*
A number indicating the default terms on consignment inventory that does not sell.
1 = Donate
2 = Return to Consignor
3 = Other
3 = Other
address
A string representing the account owners address (e.g:
54 Test Street
Los Angeles, CA 90063).
notes
A string containing any note/description you would like to store against this account.
Import Products (Inventory)
Products (your inventory), can be imported by going to the Products screen.
Click 'Import CSV'. A dialog will appear. Press 'Select CSV' and choose a .csv file from your computer that you have previously exported/saved from Excel or a different system. Then press 'Upload'.
Wait a few seconds and the products will then be automatically created in the system. If an account already exists it will be ignored. The screen will display a report of succesfully imported rows (or an error if the file, or row, is not in the correct format).
Click 'Import CSV'. A dialog will appear. Press 'Select CSV' and choose a .csv file from your computer that you have previously exported/saved from Excel or a different system. Then press 'Upload'.
Wait a few seconds and the products will then be automatically created in the system. If an account already exists it will be ignored. The screen will display a report of succesfully imported rows (or an error if the file, or row, is not in the correct format).
Click here to download product .csv example
The example template includes demo rows. The easiest way to view the template file will be to open it in Excel or Google Sheets (just makes sure to export/save it as .csv if you make any changes).
The example template includes demo rows. The easiest way to view the template file will be to open it in Excel or Google Sheets (just makes sure to export/save it as .csv if you make any changes).
Description of fields:
The CSV must contain the following fields, in the same order as in the template. You must have all field names in the first row (even the not required ones).
The CSV must contain the following fields, in the same order as in the template. You must have all field names in the first row (even the not required ones).
Note - fields with an * must have a value supplied. For optional fields leave the value as empty or NULL.
sku
This is a string which must contain a unique code. You can use your own code, or you can leave the field blank (or NULL) and a code will be auto generated.
upc
This is an optional string containing the UPC or EAN. Useful if a product already has a barcode, as this field is also matched (as well as the SKU) when scanning products at checkout.
title*
A string representing the label/product name used to identify the item throughout the system and reports; by default the title displays on product tags that are printed.
tag_price
A decimal number representing how much the item should sell for (e.g 100.50). Do not include currency symbol. This is what displays as the price on any product tags. If you have not set the price yet you can leave it blank or NULL. It can be overriden at the checkout.
cost_per
A decimal number representing the cost price of a product (e.g what it cost you to buy from a supplier). Only relevant (and required) on Buy Now or Retail inventory.
category
A string representing the category the product belongs too (e.g 'Shoes'). If the category does not exist it will be automatically created.
This is an optional string containing the UPC or EAN. Useful if a product already has a barcode, as this field is also matched (as well as the SKU) when scanning products at checkout.
title*
A string representing the label/product name used to identify the item throughout the system and reports; by default the title displays on product tags that are printed.
tag_price
A decimal number representing how much the item should sell for (e.g 100.50). Do not include currency symbol. This is what displays as the price on any product tags. If you have not set the price yet you can leave it blank or NULL. It can be overriden at the checkout.
cost_per
A decimal number representing the cost price of a product (e.g what it cost you to buy from a supplier). Only relevant (and required) on Buy Now or Retail inventory.
category
A string representing the category the product belongs too (e.g 'Shoes'). If the category does not exist it will be automatically created.
brand
A string representing the bran the product belongs too (e.g 'Adidas'. If the brand does not exist it will be automatically created.
condition
A string indicating the products condition. Valid values are one of:
Preloved
Resale
Used
New
Excellent
Good
Poor
qty*
The number of active items (e.g available for sale) for this product. For consignment products this will usually be 1.
account_code*
A string indicating what Account (e.g consignor) the product belongs to. If you are also importing Accounts this field will match the accounts 'code' field. Note - the account must be imported/added first.
type_id
A string representing the bran the product belongs too (e.g 'Adidas'. If the brand does not exist it will be automatically created.
condition
A string indicating the products condition. Valid values are one of:
Preloved
Resale
Used
New
Excellent
Good
Poor
qty*
The number of active items (e.g available for sale) for this product. For consignment products this will usually be 1.
account_code*
A string indicating what Account (e.g consignor) the product belongs to. If you are also importing Accounts this field will match the accounts 'code' field. Note - the account must be imported/added first.
type_id
A number indicating the inventory type for this product.
1 = Consignment
1 = Consignment
2 = Buy Outright
3 = Retail
3 = Retail
Defaults to 1 (Consignment) if left empty or NULL.
size
A string representing the size of a product (e.g M or 12).
consignor_percent
A number representing the split % the products account owner should receive on sale of this item (e.g 50), if the product is of type Consignment. If left blank or NULL the % will default to the account's default split.
terms_id
A number indicating the default terms for this product if it does not sell. If empty or NULL will default to the account owners default terms.
1 = Donate
2 = Return to Consignor
3 = Other
3 = Other
expires_date
A string representing the date this item will be set as expires. Important - It must exactly match the date format specified in your store settings, or conversion to UTC (how we store it in the database) will fail, or the days/month will be the wrong way around!
surcharges
A list of strings containing the names of taxes & surcharges to apply by default when this product sells. Surcharges/taxes are matched on names (and must already exist in ConsignHQ, they will not be created automatically). For example "Sales Tax, Buyers Fee" would apply both those surcharges to the product.
locations
A list of strings containing the names of location to apply by default when this product sells. Locations are matched on names (and must already exist in ConsignHQ, they will not be created automatically). For example "Shelve 1, Market Lane" will tag the product with both of those locations.
notes
A string containing any note/description you would like to store against this product.
FROGED