Overview
For certain integrations we may ask that you upload your product list as a CSV file. In order for this data to be correctly recorded, we'll need it listed in a very specific manner; this article will cover the details on how to properly format this information.
Basic Guidelines
The CSV file should be comma delimited, meaning commas are used to separate individual pieces of data. If a description or other value contains a comma, the field should be encased in quotes, like so: "sample, test". Each row, or line, on the sheet should contain the information for one individual product. Additionally, while HTML is allowed in the description field, line endings should be escaped to ensure that each row corresponds to only one item.
The header record for the CSV file should use the field names we'll go over in this article. Values listed as required must have data in them, while values not marked as required may remain empty. Even if a column is completely empty, it's important that it still be included in the file to make sure the data is recorded correctly.
Field Descriptions
In this section we'll cover each column the CSV file needs to contain. The total number of columns in the file should end up being 22. Again, even if you don't have data for a given column, it's necessary that you still include that column in the final file.
- IntegrationID
- Required
- Maximum 100 characters
- This is the unique value or "SKU" for the sellable item from your system. It's the value used to identify the item when orders are sent to your system. It must be unique and invariable. This value will be used as the SKU on the web platform.
- StyleID
- Required
- Maximum 100 characters
- This value is used to group together items which require options like size or color to be selected. These are often called "gridded" or "variable" products. This is the "parent" SKU for each individual option.
- Example: If the StyleID is "Polo1", the polo variants would have integration IDs like "Polo1-Small, Polo1-Large, etc.
- For simple products, or products without options, the StyleID will be the same value as the IntegrationID.
- UPC
- Optional, but recommended
- UPC or EAN codes
- MPN
- Optional
- Maximum 100 characters
- Manufacturers Part Number
- Brand
- Required
- Maximum of 300 characters
- Brand name for the product
- Product Name
- Required
- Maximum of 500 characters
- Short Description
- Required
- Maximum of 3000 characters
- Long Description
- Optional
- QuantityOnHand
- Required
- Must be an integer
- The current inventory value
- Itemweight
- Required
- Numeric value, assumed to be in pounds
- Price
- Required
- Numeric value greater than 0
- The regular selling price used on the website for the item.
- SalePrice
- Required
- Numeric
- The markdown price for the item; should be set to 0 if the item is not on markdown
- SaleStart
- Optional
- Date
- Used for scheduled sales, the date the sale price should start. If no date is provided, the item is assumed to be on sale until an update sets the sale price to 0.
- SaleEnd
- Optional
- Date
- Used for scheduled sales, the date the sale price should end. If no date is provided, the item is assumed to be on sale until an update sets the sale price to 0.
- MSRP
- Optional
- Numeric
- Cost
- Optional
- Numeric
- OptionName & OptionValue
- Optional
- Maximum 100 characters
- Used for variable/gridded products, these provide the options for the customer to select from.
- Example: OptionAName= color, OptionAvalue= red
- All items for a specific variable product must have the same option names in the same order.
- Up to three options can be specified.
- Six rows total, in this order: OptionAName , OptionAValue , OptionBName , OptionBValue , OptionCName , OptionCValue
- DisplayOrder
- Optional
- Integer
- Used to provide items sort order for variable items. If provided, variable items will be sent to the web site in the provided order, and will control order of options in drop down.
This is complicated, so don't worry if you have questions. Feel free to get in touch with your Project Manager, or feel free to submit a support request.