ActivateAuthenticateAmplify
DashboardSupportDeveloper Blog

CSV File Format

Suggest Edits

The EVRYTHNG CLI supports import and export of most common resource types to CSV files using the --to-csv and --from-csv switches. This allows the importing of known data sets of static resources (such as a brand's products, or store locations) into new accounts, as well as exporting existing data for reuse.

See below for details of supported resources, file format requirements, and example files.

Supported Resources

Currently, the following EVRYTHNG resource types are supported for export/import to CSV via the CLI:

See below for notes on how some of these behave when incorporated into a CSV file.

File Format

If data is exported using the --to-csv CLI switch, the resulting CSV file will be compatible with importing. If not, or you are constructing your own CSV file for data import, see the information below to ensure the file is valid for import.

### Basic Requirements

  • All column headers should be valid EVRYTHNG resource property names, such as name, description, tags, etc.
  • Known read-only properties are ignored, such as id, createdAt, etc.
  • Basic string, boolean, or number data types are simply encoded as they appear.
  • Cells that contain a comma must be escaped with double quotes. So City Road, London becomes "City Road, London".
  • There must not be any empty rows or headers.

Special Features

Some data types require special encoding to be included in the CSV file, and are outlined below.

  • Known sub-objects (customFields, identifiers, properties, address) are split into a column per contained property and given a prefix, such as customFields.color, address.countryCode, etc. Columns that contain such prefixes are applied to the whole subobject. So address.city will be added to a place's address property upon import.
  • Known arrays (tags, photos, categories) are encoded as lists separated by a pipe character (|), and decoded into arrays upon import.
  • position is encoded as a coordinate pair using a pipe character, and decoded into the position object upon import.
  • The special column header redirection will be created for Thngs/products with a redirection set, and used to set such a redirection if the --with-redirections switch is specified with the desired short domain.

Example Files

Some example CSV files are shown below for the most common resource types. In addition, files created with the --to-csv switch will also serve as valid example data.

id,createdAt,updatedAt,fn,name,photos,tags,categories,description,customFields.Collar Type,customFields.Pattern,customFields.Sleeve Length,customFields.category,customFields.color_category,customFields.color_shade,customFields.product_type,customFields.sub_category,customFields.Shorts Type,customFields.Gender,customFields.Outerwear Type,customFields.Suit Jacket Style,customFields.Batch No,customFields.Body,customFields.Country of Origin,customFields.Volume,properties.day_hours,properties.diameter_km,properties.temperature_celsius,properties.wind_speed
U4tH9GhbBgPw95aRamnK2fEp,1526397297042,1539611303834,Captain America T-Shirt,Captain America T-Shirt,https://c.76.my/Malaysia/[email protected],,,,Round,Graphic Print,Short Sleeves,"Clothing, Shoes & Accessories",Blue,Aegean,"T-shirts, Tops & Polos",Upper-Body Garments,,,,,,,,,,,,
UHt4tXreeD8RQpwRaGcnyk9b,1526396628072,1539611303834,Shorts,Shorts,https://riverisland.scene7.com/is/image/RiverIsland/412210_main,,,,,Solid,,"Clothing, Shoes & Accessories",Brown,Burly Wood,Shorts,Lower-Body Garments,Bermuda,,,,,,,,,,,
UnQnsQHPVgswQKwRwnPMUham,1526394798562,1539611365226,Suit,Suit,http://thefancydressexperience.co.uk/ekmps/shops/fancydressexp/images/shamrock-stand-out-suit-select-size-medium-chest-38-40-leg-inseam-32.75-8181-p.jpg,suit|patterned,clothing,full-length,,,Military Camouflage,Long Sleeves,"Clothing, Shoes & Accessories",Green,Crocodile,Suits,Upper-Body Garments,,Women *,Casual,Suit Jacket,,,,,,,,
UGQGsBqMMGshY6awwhtQwFqq,1509549260813,1539611303834,Pluto Class Planet,Pluto Class Planet,http://sites.psu.edu/scinews/wp-content/uploads/sites/29024/2015/09/Pluto-Icon-01.png,,,Test updated description,,,,,,,,,,,,,,,,,153.3,2377,,
U3EtU2k3BD8wQpwwR6EMXgKb,1501509769311,1539611303834,Honeysuckle Zombie Brown Ale,Honeysuckle Zombie Brown Ale,http://www.zombiecrawlmiami.com/wp-content/uploads/2014/08/beerZombie-250x237.png,export,,Test updated description,,,,,,,,,,,,,438979,Medium Dark,United Kingdom,500ml,,,,
UGfRNStEVDPat5waamA9gtXr,1498468855054,1539611303834,Atmospheric Evaluator,Atmospheric Evaluator,https://upload.wikimedia.org/wikipedia/commons/1/1b/Anemometer.jpg,,,Test updated description,,,,,,,,,,,,,,,,,,,42,12.3

id,createdAt,updatedAt,name,description,product,customFields.Diameter_km,customFields.DistanceFromSun_10_6_km,customFields.Gravity_m_per_s_2,customFields.LengthOfDay_hours,customFields.Mass_10_24_kg,customFields.MeanTemperature_deg_C,customFields.NumberOfMoons,customFields.OrbitalPeriod_days,customFields.OrbitalVelocity_km_per_s,customFields.RingSystem,customFields.RotationPeriod_hours,properties.humidity_gm3,properties.rainfall_mm,properties.temp_celsius,properties.wind_speed_mph
UmQ3KReRMmsYE6awRDXdQhbh,1509535808844,1539618082711,Pluto,A planet called Pluto.,UGQGsBqMMGshY6awwhtQwFqq,2370,5906.4,0.7,153.3,0.0146,-225,5,90560,4.7,,-153.3,,,,
Um93KRd2qmPYEqRwaEF6esfp,1509535800329,1539618082713,Neptune,A planet called Neptune.,UG9G8eqk63PYhMRawDFHxnyd,49528,4495.1,11,16.1,102,-200,14,59800,5.4,true,16.1,,,,
UGQG5RAdV6PNtrRwwhRdxKpm,1509535795385,1539618082714,Uranus,A planet called Uranus.,UGtGsVqTM9QBYPwwREAkFAcp,51118,2872.5,8.7,17.2,86.8,-195,27,30589,6.8,true,-17.2,,,,
UGQGpwyqqtQehsRwRXa9qcUf,1509535788662,1539618082717,Saturn,A planet called Saturn.,UmtmPB5QegsRQpwaaYfMeh9q,120536,1433.5,9,10.7,568,-140,62,10747,9.7,true,10.7,,,,
Um93pwckV6s7QNwwagwfYbCa,1509535784551,1539618082718,Jupiter,A planet called Jupiter.,UmQ3sB5GfTQntQRwwYMyQyqt,142984,778.6,23.1,9.9,1898,-110,67,4331,13.1,true,9.9,,,,
Um9mKwyAeMP7tNaRahf3ghCt,1509535779840,1539618082719,Mars,A planet called Mars.,UG93PBKUqGPEh6wwwhpyqpRg,6792,227.9,3.7,24.7,0.642,-65,2,687,24.1,,24.6,,,,
U3t3pwSkqmsEYqaRwYNkFdgc,1509535768854,1539618082721,Earth,A planet called Earth.,U3QmPBnQCTt4Q9aaRYMTPqDb,12756,149.6,9.8,24,5.97,15,1,365.2,29.8,,23.9,,,,
Um9GpabcVg8wtKaaREn4aqHq,1509535762335,1539618082722,Venus,A planet called Venus.,UmtGPB44eqsrtrRRahTGAfVq,12104,108.2,8.9,2802,4.87,464,,224.7,35,,-5832.5,,,,
U3tmpRaKMmPEE6wwREHhDdsq,1509535755402,1539618082724,Mercury,A planet called Mercury.,Umt3PBngBDPaQKRRaEWqdghs,4879,57.9,3.7,4222.6,0.33,167,,88,47.4,,1407.6,,,,

id,createdAt,tags,updatedAt,name,description,customFields.serial,customFields.tagId,identifiers.dm,identifiers.globalId,identifiers.qr_code
"U5MfHpn7HtrPN5aRw3G3Mtdg","1539681197756","example|tags","1539681197756","Crate of Beer 10","The more beer the better","132","832473","3128912839",,
"UKqfH5EtwmUQtNaaakKWtnak","1539681151875","example|tags|crate|beer","1539681151875","Crate of Beer 5","Yet more beer","126","478634","478726438","73628hhhd9rhwbfdcj89236478",
"U5qfH5cmUVMqwfawwFt7hckc","1539681065302","example","1539681065302","Crate of Beer 3","A third crate of beer","125","89435","4389743232",,
"UpMWHnQ6nRet4Dwwa2mpxGft","1539681020221","example|tags","1539681020221","Crate of Beer 2","Another crate of beer","124","43879","43897347892",,"https://example.com"
"Up6C3NnaBSFRQgaaRkcEdQdn","1539677600941","example","1539677600941","Crate of Beer","A single crate of beer","123","438297","846428737",,

id,createdAt,tags,updatedAt,name,position,longitude,latitude,description,icon,address.street,address.postalCode,address.city,address.country,address.extension,address.countryCode,customFields.Internet,identifiers.name
U4t8t2BWeDPRQpwwRmDFeHnh,1526659141059,bikepoint,1526662804669,"Rathbone Street, Fitzrovia",,,,,,,,,,,,,"Rathbone Street, Fitzrovia"
UHQsQkBfeD8wQ5aaR3QtMrbg,1526659141850,bikepoint,1526662803897,"Wells Street, Fitzrovia",,,,,,,,,,,,,"Wells Street, Fitzrovia"
Unt8QFDYeg8atKaRw3qsxt2s,1526659175375,bikepoint,1526662770720,"Regent's Row , Haggerston",,,,,,,,,,,,,"Regent's Row , Haggerston"
UHQPtFFWeXPwtKwRaFgwqqYt,1526659205030,bikepoint,1526662741671,"Haggerston Road, Haggerston",,,,,,,,,,,,,"Haggerston Road, Haggerston"
UHQPtFmwBXsRQ5awwGX2hrde,1526659216733,bikepoint,1526662729726,"Ferndale Road, Brixton",,,,,,,,,,,,,"Ferndale Road, Brixton"
Un9CXHXPBDPatKwRakra2Fsh,1526033006891,tier2|warehouse,1526033006891,Shipping Center,-0.016371|51.495131,-0.016371,51.495131,,,Shipping Street,,London,United Kingdom,,,,Shipping Center
UH9fgnDseD8atKaRaF5kdqch,1526033006866,tier2|retailer,1526033006866,Super Denim,-0.079765|51.509674,-0.079765,51.509674,,,Shopping Street,,London,United Kingdom,,,,Super Denim
U4tfDngsBgsaQpwaaGxPBmQq,1526033006858,tier1|factory,1526033006858,Fabrication Center,0.058233|51.499537,0.058233,51.499537,,,Construction Street,,London,United Kingdom,,,,Fabrication Center
UHtWgnDsVDsRtKwwRFcGUtbf,1526033006785,tier1|factory,1526033006785,Denim Factory,0.394949|51.43835,0.394949,51.43835,,,Cloth Street,,London,United Kingdom,,,,Denim Factory
UnQCXHDseDsatpwaRmg8xkDk,1526033006785,tier1|factory,1526033006785,Button Factory,0.394225|51.44283,0.394225,51.44283,,,Industry Street,,London,United Kingdom,,,,Button Factory

Updated over 5 years ago