Catalog - Import

Catalog Import is a job that gives a supplier the ability to import sample data into Loupe

File Structure

The file structure for Catalog Import is simple. Each row in the file corresponds to a single sample. If a sample contains multiple repeated fields or objects (described below) then those are repeated as columns in the file, like in the example below.

File Template

Here is the Catalog Import file template with example data.

File Protocols

Here is a list of protocols in the file that affect the data in Loupe.

• Edit - To edit a field’s value in Loupe simply enter valid data in that field. Any valid data will overwrite the existing data in Loupe, with the exception of ‘null’ as noted below.
• Delete - To delete a field’s value in Loupe, then you must enter null in that field in the file.
• Ignore - To ignore a field simply leave the field blank / empty in the file. Doing so will not affect the field’s value in Loupe.

Required Fields

Catalog Import has a small set of required fields that must be used for every sample loaded to Loupe. Here is the list of all required fields.

• variant_code
• sell_method
• list_price
• list_price_currency_code
• global_type
• type
• size
• size_measurement
• size_unit_of_measure

Non-Repeatable Fields

Most fields for a sample are not repeatable. Meaning they can only have one value. Here is a list of all non-repeatable fields.

• master_style_code
• master_style_name
• model_code
• model_name
• style_code
• style_name
• variant_name
• privacy
• barcode
• gold_lock
• gold_lock_currency_code
• silver_lock
• silver_lock_currency_code
• platinum_lock
• platinum_lock_currency_code
• palladium_lock
• palladium_lock_currency_code
• design_element
• design_theme
• look

Repeatable Fields

There are a few fields that are repeatable by adding a number to the end of the field. For example, you can import multiple images by simply adding a number to the end of the image field name, like ‘variant_image_file_name_1’, ‘variant_image_file_name_2’, etc. Here is a list of all repeatable fields. Just replace the ‘N’ with the number you want to use.

• variant_image_file_name_N
• alternative_barcode_N
• collection_code_N

Repeatable Objects

A repeatable object is like a repeatable field, but it is a full set of data that can be repeated. Repeatable objects also have their own required fields. Each repeatable object has a prefix with a number that can be incremented just like a repeatable field. For example, you can import multiple stones into Loupe by using ‘stone_1’, ‘stone_2’, etc. as the prefix. Then after the prefix you give the field name suffix, like ‘type’, ‘sub_type’, etc. In between the prefix and suffix you simply enter a period. So full repeatable object examples can include ‘stone_1.type’, ‘stone_1.placement’, and ‘stone_2.colour’. Here is a list of all repeatable objects. Just replace the ‘N’ with the number you want to use.

Stones

• stone_N.id
• stone_N.type - Required
• stone_N.sub_type - Required
• stone_N.total_carat_weight - Required
• stone_N.placement
• stone_N.colour
• stone_N.grade
• stone_N.cut
• stone_N.shape
• stone_N.size
• stone_N.quantity
• stone_N.treatment
• stone_N.certificate_type
• stone_N.country_of_origin
• stone_N.carat_weight
• stone_N.external_reference
• stone_N.internal_reference
• stone_N.calculation
• stone_N.price
• stone_N.price_currency
• stone_N.setting_type
• stone_N.setting_method
• stone_N.size_minimum
• stone_N.size_maximum
• stone_N.quantity_minimum
• stone_N.quantity_maximum
• stone_N.carat_weight_minimum
• stone_N.carat_weight_maximum

Core Materials

• cm_N.id
• cm_N.type
• cm_N.sub_type
• cm_N.metal_title
• cm_N.colour
• cm_N.nickel_content
• cm_N.metal_loss
• cm_N.invoiced_metal_title_including_loss
• cm_N.net_metal_weight