CSV Catalog Format Details
The CSV Catalog format is a list of columns separated using commas, and products are defined on with each new line. The first line is mandatory, and reserved for the headers, which is a comma separated list of Product Fields.
To copy, hover over the Template box and click the "Clipboard" button
vendorSku,name,brand,msrp,defaultCost,language,isVisible,images,description,additionalDescription,manufacturerSku,gtinUpc,gtinEan,gtinIsbn,gtinItf14,groupID,color,size variation:,attribute:,shippingHeight,shippingLength,shippingWidth,shippingWeight,customCategories,googleCategory
12345-1058,TDF Pro Frameset,TDF,199.99,79.00,en,true/false,https://c1.staticflickr.com/2/1368/5098190130_74c7f355bb_b.jpg https://s0.geograph.org.uk/geophotos/05/65/36/5653610_43500d35.jpg,"The TDF Pro Frameset has a race-specific geometry that's optimized for long-distance timed events on diverse terrain. With a carbon fiber fork, it's waiting to be built up exactly how you want it.",<ul><li>"Features the same carbon fiber seatpost found on our TDF-4"</li><li>"Geometry specially designed for long-distance races"</li><li>"The frame is constructed from carbon fiber and it features a race-specific geometry"</li></ul>,12345-1058,989676375934,1234567894567,989676375934,989676375934,106261,Matte Black/Charcoal/Blue,58,variation value,attribute value,30 in,39 in,6.9996 in,11.02 lb,Race,Bike
Header Name | Required | Example | Note |
---|---|---|---|
vendorSku | Yes | 12345-1058 | |
name | Yes | TDF Pro Frameset | |
brand | Yes | TDF | |
msrp | Yes | 199.99 | |
defaultCost | Yes | 79.00 | |
language | Yes | en | Click the language link to the left for instructions on how to upload Catalogs with multiple languages |
isVisible | No | true/false | Defaults to true |
images | No* | https://c1.staticflickr.com/2/1368/5098190130_74c7f355bb_b.jpg https://s0.geograph.org.uk/geophotos/05/65/36/5653610_43500d35.jpg | Strongly Recommended, multiple images are allowed, separated with a sp a ce between each image url |
description | No | "The TDF Pro Frameset has a race-specific geometry that's optimized for long-distance timed events on diverse terrain. With a carbon fiber fork, it's waiting to be built up exactly how you want it." | Be sure to include "Quotes" around your description if they include commas , |
additionalDescription | No | "<ul><li>Features the same carbon fiber seatpost found on our TDF-4</li><li>Geometry specially designed for long-distance races</li><li>The frame is constructed from carbon fiber and it features a race-specific geometry</li></ul>" | Be sure to include "Quotes" around your additionalDescription if they include commas , |
manufacturerSku | No | 19GKN-46013 | A string field, 255 character limit. |
gtinUpc | No | 989676375934 | 12 Digits |
gtinEan | No | 1234567894567 | 13 Digits |
gtinIsbn | No | 989676375934 | 10 or 13-Digits |
gtinItf14 | No | 989676375934 | 14 Digits |
groupID | No* | 106261 | Required if specifying variation: (i.e. Color/Size) |
color | No | Matte Black/Charcoal/Blue | |
size | No | 58 | |
variation: | No | variation value | |
attribute: | No | attribute value | |
shippingHeight | No | 30 in | |
shippingLength | No | 39 in | |
shippingWidth | No | 6.9996 in | |
shippingWeight | No | 11.02 lb | |
customCategories | No | Race | |
googleCategory | No | Bike |
vendorSku: Required
The vendorSku
(stock keeping unit) is a non-standardized code used to identify a specific product or variant from a vendor or distributor. Retailers often use the vendorSku
to find and order a specific product from a specific vendor.
Examples
-
APL-IPHONE-XS-BLK-256
-
95418-7148
Minimum requirements
-
Every product and variant in your catalog must have a unique
vendorSku
. -
vendorSku
is NOT case-sensitive: ABC123 = abc123
Code example
vendorSku,
95418-7148,
name: Required
The name
attribute is what retail staff, the shop owner, and end-consumers refer to the product as in everyday conversation. It is displayed to retailers in the product catalog and end-consumers shopping online.
Examples
-
iPhone XS
-
Men's Diverge E5 Sport
Minimum requirements
-
Every product and variant must have a name
-
Describe the name in a human readable way
-
Avoid using ALL CAPS or oDD-formATing that is not easy to read
-
Avoid describing the brand name and option values
*Ex. Apple iPhone XS - Black - 256MB
Code example
name,
"iPhone XS",
brand: Required
The brand
or sub-brand to which this item is sold under.
Examples
- Apple
- Specialized
- Nike
- Nike SB
- NikeLab
Minimum requirements
brand
is a required field for all products and variations.
Code example
brand,
"Apple",
msrp: Required
MSRP
is the Manufacturer's Suggested Retail Price. This is typically used as the starting point for Sale Price for a Retailer.
Examples
- 199.99
- 75
- 1.99
- 0.00
Minimum Requirements
msrp
is a required field for every product and variation. If no MSRP, specify0.00
- no Currency Symbols ($, £, €)
- numbers and periods(.) only
Exceptions:
Distributors may not receive MSRP
's from their suppliers. If this is the case, you may specify MSRP as 0.00
explicitly.
Code Example
msrp,
199.99,
Remember
Providing MSRP's is crucial to a Retailers ability to quickly and efficiently sell your brands products. Include this pricing info whenever possible.
defaultCost: Required
defaultCost
is the price at which a Retailer purchases the product from the Vendor
Examples
- 12.59
- 23
- 1.18
Minimum Requirements
defaultCost
is a required field for every product and variation- no Currency Symbols ($, £, €)
- numbers and periods(.) only
*Code Example**
defaultCost,
12.59,
language: Required
Use language
to specify the language of the product information you're providing. You can also upload the same product in multiple languages.
Examples
- fr
- en
- es
Minimum requirements
- You must upload an entire Catalog with proper verbiage in the desired language
- Must be a valid ISO 639-1 code (See Examples above)
Code example
language,
en,
language,
fr,
language,
es,
Multiple Languages
If you have a Catalog you wish to list with multiple languages, you will need to provide us 2 near identical Catalog files.
Example:
The first catalog file will haveen
in thelanguage
column
The second catalog file will havefr
in thelanguage
column.Do not specify multiple languages in a single file, this will result in an error
isVisible
The isVisible Boolean field is used to mark whether an item in your Catalog is visible to all Retailers viewing your Catalog List. This is particularly useful when items become unavailable, but require the ability to review historical data for those items marked false
.
Item data persists in Lightspeed even when marked as false
, so simply updating with true
will allow items to display again.
- The default mode is set to
true
for all items - this value is not required to upload items.
Code Example
isVisible,
true/false,
images
Use images
to upload the photograph, image or graphic that represents this product or variation.
Examples
Field Minimum requirements
- Minimum 1 image per product/variation
- Maximum 12 images per product/variation
- Upload high quality images
- If your product is available in several colors, upload a specific image for each color variation so that each color has its own image.
- Include the http or https in your image URL
- Be consistent with the dimensions of your images to create a uniform experience
- Separate each image with a space
Code example
images,
"https://media.specialized.com/mixed_media/BRD-3528_PDP_Hero_1440x810.jpg https://media.specialized.com/mixed_media/BRD-3528_PDP_Hero_1040x600.jpg",
description
Use description
to explain basic details about what the product is.
Examples
- "With the Diverge Sport, you'll be prepared for anything, from smooth tarmac to the loosest, roughest tracks out there. It's packed with all the same technologies as its pricier cousins, only its spec places an emphasis on reliable performance, not components so flashy you'll be eating nothing but Top Ramen® for months."
Minimum requirements
description
is required for every product and variation- HTML markup is not accepted in the description field
Line Breaks
To add a Line Break to your Description, add the following to your csv:
description,
<div>Hello,</div><div><p>This is</p><p>another line!</p></div>,
Code example
description,
"With the Diverge Sport, you'll be prepared for anything, from smooth tarmac to the loosest, roughest tracks out there. It's packed with all the same technologies as its pricier cousins, only its spec places an emphasis on reliable performance, not components so flashy you'll be eating nothing but top ramen for months.",
additionalDescription
Use additionalDescription
to explain specific details about your product.
Examples
- Our Premium E5 aluminum frameset features our comfortable, yet confidence-inspiring, Open Road Geometry. Front & rear thru-axles are also included, making this Diverge the ultimate tool for your next adventure.
- The lightweight FACT carbon fork is plenty stiff, aiding in handling, rigidity, and an overall light weight.
- The Praxis Alba 2D is an incredibly stiff crankset with supreme ramping for precise shifts between the rings.
This is displayed in the catalog as
- Our Premium E5 aluminum frameset features our comfortable, yet confidence-inspiring, Open Road Geometry. Front & rear thru-axles are also included, making this Diverge the ultimate tool for your next adventure.
-The lightweight FACT carbon fork is plenty stiff, aiding in handling, rigidity, and an overall light weight. - The Praxis Alba 2D is an incredibly stiff crankset with supreme ramping for precise shifts between the rings.
Minimum requirements
additionalDescription
is an optional field- Supported HTML tags:
strong, em, ul, ol, li, br, sub, sup, div, span, dl, dt, dd, table, tbody, thead, tr, th, td, img
Code Example
additionalDescription,
"<ul><li>Super Retina HD display</li><li>5.8‑inch (diagonal) all‑screen OLED Multi‑Touch display</li><li>HDR display</li></ul>",
Line Break Example:
additionalDescription,
<div>Hello,</div><div><p>This is</p><p>another line!</p></div>,
manufacturerSku
The manufacturerSku
(stock keeping unit) is a non-standardized code used to identify a specific product or variant from a brand or manufacturer. Retailers often use the manufacturerSku
to find and order a specific product from a brand.
Examples
- APL-IPHONE-XS-BLK-256
- 95418-7148
Minimum requirements
manufacturerSku
is NOT case-sensitive: ABC123 = abc123
Code example
manufacturerSku,
APL-IPHONE-XS-BLK-256,
Gtin Specifications
Global trade identification number (GTIN), is a standardized identification code used in barcodes to identify a specific product or variation. The standardization of GTIN allows vendors and retailers to identify a unique product sold anywhere on earth. No two products have the same GTIN.
GTIN variations
GTIN type | Description |
---|---|
UPC | Used in North America, UPC is a 12-digit number like 323456789012. 8-digit UPC-E codes should be converted to 12-digit codes |
EAN | Used in Europe, EAN is a 13-digit number like 3001234567892 |
ISBN | Used for books, ISBN is a 10 or 13-digit number like 1455582344 or 978-1455582341. If you have both, only include the 13-digit number. ISBN-10 are deprecated and should be converted to ISBN-13 |
ITF-14 | Used for multipacks, GTIN-14 is a 14-digit number like 10856435001702 |
The following gtin fields are supported. Each has their own specific formats.
gtinUpc
must be between 8 and 12 charactersgtinEan
must be 13 charactersgtinItf14
must be 14 charactersgtinIsbn
must be between 10 and 13 characters (not including the dashes)
Minimum requirements
- All
gtin
types are an optional field - A
gtin
must be unique for every product and variation in your catalog (two different products cannot have the samegtin
) - A
gtin
must be included for any physical products that will be sold in-store or shipped to customers - If you sell the exact same product that another vendor also sells, make sure you are using the same
gtin
.
Code example
gtinUpc, gtinEan, gtinItf14, gtinIsbn,
323456789012, 3001234567892, 10856435001702, 978-3-16-148410-0,
groupID
groupID
is used to display a group of variations together in the product catalog. All variations in your file that have the same group_id will display in the product catalog as a product with multiple options to choose from.
color
andsize
are reserved Variation headers, and do not requirevariation:
to be added at the beginning
Examples
- APL-IPHONE-XS
- 95418
Minimum requirements
groupID
is NOT case-sensitive: ABC123 = abc123
Code Example
groupID, color, size, 3rdAttribute
APL-IPHONE-XS, "Black", "256GB", "Optional"
variation:
The following fields specify the variant headers. You should specify a whole new line for each product variant A variation
is a product that represents a specific combination of available options (such as size or color). A variation must specify a groupID
Examples
color
- a reserved word (Does not requirevariation:
)size
- a reserved word (Does not requirevariation:
)variation:material
variation:multiple word example
Minimum requirements
- a
variation
must always include agroupID
Code Example
groupID, color, size, variation:material,
APL-IPHONE-XS, "Black", "256GB", "Aluminum"
attribute:
The detailed specifications of a product. This describes the technical details of the product. Attributes are displayed as a list in the product details of the catalog. Attributes are included as attribute:
, where everything after the colon :
, is some custom name like crankset
.
Examples
attribute:Chainrings
: 48/32Tattribute:Talk time (wireless)
: Up to 20 hours
Code example
attribute:crankset, attribute:Chainrings,
"Praxis Alba 2d", "48/32T",
Shipping Specifications
Use Shipping Specification to help retailers determine the shipping costs for the product during checkout. This is typically the shippingHeight
, shippingLength
, shippingWidth
and shippingWeight
of the product in its shipping form, often within a package. We currently only accept cm
and in
for dimensional units.
The following fields are supported
shippingHeight
shippingLength
shippingWidth
shippingWeight
Examples
- 21 in
- 39 cm
Minimum requirements
- Submit units of measurement in
cm
orin
- Minimum value = 0
- Maximum value = 500
- Weight uses units of measurement in
g
,kg
,oz
, orlbs
only
Code example
shippingHeight, shippingLength, shippingWidth, shippingWeight,
21 in, 21 in, 21 in, 19 oz,
customCategories
Used primarily for navigation and ease of discovery within the product catalog, customCategories
classifies a group of similar products together. A product or variation will be placed in each category you list in your file. Navigating on the front-end, this results in the customer being able to find your product in each of those categories.
Examples
- Jackets
- Pants
- Accessories
- Boots
- Bindings
- Boards
Minimum requirements
- Double quote the entire list
- use commas within the double quotes to separate multiple categories
- List them in the order of navigation (like a website) from top to bottom.
Code example
customCategories,
"bikes, road bikes, adventure & gravel bikes, men's diverge",
Updated about 4 years ago