Style Sync Documentation
Style Sync Documentation Style Sync is JOOR’s flat file style integration. A Style Sync integration adds, updates, drops, and deletes styles in your account. A Style Sync integration also allows you to manage linesheets, if you are able to pass through linesheet information from your ERP. The integration can run up to once per hour and pulls files from an FTP server, the credentials for which will be provided by JOOR. Basic Requirements 1. Files must be entirely generated by the ERP and may not be manually altered in any way. 2. File format must be configurable in order to match the requirements of the integration. 3. File name must be specified for the integration to be able to pick up new files. We recommend using the word “style”, along with a timestamp. 4. Files must be automatically sent to JOOR’s FTP server, hosted by BrickFTP. More on BrickFTP’s security technology can be found here. 5. An action code is required for each row, as this tells the integration how to read the contained data. Action codes can be client-specific values that are mapped to the following actions:
● Add – Creates new style ● Update – Updates style data ● Drop – Drops style from the specified (non-custom) linesheet
● Delete – Deletes style entirely from JOOR and all linesheets
6. Files must be in either .txt or .csv format. We recommend using pipe (“|”) as the delimiter, as it is unlikely to appear in the style data.
7. Files must not exceed 20MB. 8. After receiving a finalized file format, we recommend two weeks of testing by placing files on an FTP and reviewing changes on the JOOR website. This helps to ensure all integration functionality is working properly. If any modifications need to be made to the integration after it is live in the production environment, this must first be communicated to your Customer Success Manager. A test file should be sent containing the updated format. This will be reviewed and an additional round of testing in the Sandbox environment will take place. After the JOOR team has approved this modification, the production integration will be updated and the new files may be sent. Prerequisites Before beginning to test the integration, you will need to provide the following information. All fields are optional unless otherwise noted. • Currencies and price labels (required) • Style Tag Names
• Casepack information Tips • Each linesheet can only have one set of delivery dates. If there are multiple deliveries, please indicate this in the linesheet name. • If you wish to use Linesheet Season Name and Linesheet Season Year, you send these in separate columns. • If you wish to deactivate a style from all linesheets to which it is tied to, you should send a Drop record for the style with a blank linesheet name field. • You do not need to send your whole collection each time. You can choose to only send the style/colors that have changed. • To change a color name, you must pass through a Drop/Delete for the old color name and then an Add for the new color name. Please see our Testing Scenarios section for further guide on how to perform this update. • Sizes are excluded from the updates managed through the Action Codes. There are two ways to remove a size: o Send an Update record with all sizes you wish to display. The remaining sizes that are excluded from your file will be marked inactive on JOOR. o Include a Size Active Column in your Style Sync file. If any value is populated in this column for a specific row, the size will remain active. If left blank, the size will be marked inactive. • We are able to process file formats with either: o one size per row (recommended), or o a list of comma separated sizes in a single row • To manage size order display you must either: o include a Size Order column in your Style Sync file or o list sizes in the correct display order Testing Scenarios A list of recommended Style Sync testing scenarios is also available for your reference. You may download it from the Testing Scenarios section of our Style Sync documentation online. Use this list as a guideline as you test different scenarios that are relevant to your business. Once all relevant tests have been executed successfully, your integration should be just about ready to activate on your Production account. Reporting Success and Error report emails are generated every time a file is processed via the integrations. If you and your team wish to receive these report emails, please specify the recipients’ email address/es and we will set them up accordingly. This feature is available on the Production environment. If you wish to receive the email reports during the testing period on Sandbox, please reach out to your dedicated Integrations Manager.
Template Field Name
Required
Value
Max
Description
Action Code
Y
Text
-
The key that tells the integration how to read each row of data.
Linesheet Name
N
Text
100
A descriptive name for the delivery (linesheet) displayed to customers
Linesheet Code
N
Text
100
A code associated with the delivery (linesheet)
start_ship_date
Linesheet Start Ship Date
N
Date (MM/DD/YYYY)
10
The delivery starting date
end_ship_date
Linesheet Complete Ship Date
N
Date (MM/DD/YYYY)
10
The delivery ending date
cancel_date
Linesheet Cancel Date
N
Date (MM/DD/YYYY)
10
The delivery cancel date
season_name
Linesheet Season Name
N
Text
100
The name of the season
Linesheet Season Code
N
Text
25
Code used to signify the season. Recommende d as 3 digit (padded).
Linesheet Season Year
N
Date (YYYY)
4
The year of the season
Linesheet Minimum Delivery Window
N
Integer
-
Required if linesheet start date is provided without end date
Linesheet Style Comments
N
Text
255
Delivery (linesheet)specific comments about the style
JOOR Field Name
action_code
delivery_name
delivery_code
season_code
season_year
minimum_delivery _window
collection_style _comment
style_display_order
Linesheet Style Display Order
N
Integer
10
The order in which the styles are displayed on the linesheet
Style Name
Y
Text
100
The name of the style as it is intended to be displayed
Style Number
Y
Text
45
Code used to signify styles.
Style Description
N
Text
500
Text description for the style
Style Minimum Order Quantity
N
Integer
-
A minimum per style to be bought.
Style Materials
N
Text
125
Description of the material used to construct the style
Style Source of Materials
N
Text
100
Description of the source of the material used to construct the style.
Style Country of Origin
N
Text
100
The country where the style is manufactured.
Style Fabrication
N
Text
150
Description of the fabrication. This field can be used to group linesheets.
Style Fabrication Code
N
Text
45
Code used to signify the fabrication.
Style Silhouette
N
Text
150
Description of the silhouette of the style.
Style Silhouette Code
N
Text
45
Code used to signify the
style_name
style_number
style_description
style_minimum _order_quantity
style_materials
style_source_of _materials
style_country_of _origin
style_fabrication
style_fabrication _code
style_silhouette
style_silhouette _code
silhouette. Style Heel Height
N
Text
45
Description of the height of the heel for footwear
Style Division Name
N
Text
100
The primary division the style belongs to. Required if a division code is provided.
Style Division Code
N
Text
25
Code used to signify the division.
Style Model Height
N
Text
-
The height of the model in the featured style image
Style Measurements
N
Text
255
Description of the general measurements of the style. Field is displayed.
Style Category Gender
N
Text
-
The gender of the item. Available options: Mens, Womens, Unisex, Home, Baby Boys, Baby Girls, Baby Neutral/Acces sories, Girls, Boys
Style Category
N
Text
-
The higher level, JOOR provided category.
Style Subcategory
N
Text
-
The specific, JOOR provided category.
Style Contains Fur
N
Boolean
-
Boolean value that indicates if the style contains fur. File must
style_heel_height
division_name
division_code
style_model_height
style_measurements
style_category _gender
style_category_1
style_category_2
style_contains_fur
contain either “Yes” or “No”. Style Tag Value 1
N
Text
100
The value assigned to the custom style tag. Custom field name must be preset in JOOR before being used with the integration.
Style Tag Value Code 1
N
Text
20
The code associated with the value assigned to the custom style tag.
Color Name
Y
Text
100
The display name of the color.
Color Code
N
Text
100
The client color code. Recommende d as 3 digit (padded).
Individual Size Name
Y
Text
255
The individual sizes available for purchase.
Size Code
N
Text
25
A client specified code or identifier for the size (usually a size run code).
Size Description
N
Text
100
A long description that could include case pack description or size translations.
Size Order
N
Integer
-
The correct display order of each individual size.
Size Active
N
Text
-
Indicates
tag_value_%
tag_value_code_%
color_name
color_code
size_name
size_code
size_description
size_order
size_active
whether size in row is active or inactive. Populate with value if active, leave blank if inactive. UPC
N
Text
100
The universal product code for the designated SKU (Style Number, Color, Size).
Casepack Name
N
Text
128
The client assigned name of the casepack. Must be preloaded into JOOR.
Casepack Quantity
N
Integer
-
The number of units contained in the casepack
Price Type Currency 1
Y
Text
3
The 3-digit currency code associated with the price level.
Price Type Label 1
Y
Text
50
The display name for the price level.
Wholesale Price 1
Y
Decimal
-
The wholesale price value for the price level.
Retail Price 1
N
Decimal
-
The retail price value for the price level.
FTP Image Directory
N
Text
-
The folder on the FTP server from which the image files will be sourced.
Image FTP Filename 1
N
Text
-
The name of the corresponding style-level image file
upc
casepack_name
casepack_quantity
price_type _currency_%
price_type_label_%
wholesale_price_%
suggested_retail _price_%
image_directory
style_image _filename%
placed on the FTP. Image URL 1
N
Text
-
The URL pointing to the corresponding style-level image.
Style Color Image FTP Filename
N
Text
-
The name of the corresponding color-level image file placed on the FTP.
Style Color Image URL
N
Text
-
The URL pointing to the corresponding color-level image.
Style Color Swatch FTP Filename
N
Text
-
The name of the corresponding color-level swatch image file placed on the FTP.
Style Color Swatch URL
N
Text
-
The URL pointing to the corresponding color-level swatch image.
style_image_url_%
style_color_image _filename
style_color_image _url
style_color_swatch _filename
style_color_swatch _url
• Casepack information Tips • Each linesheet can only have one set of delivery dates. If there are multiple deliveries, please indicate this in the linesheet name. • If you wish to use Linesheet Season Name and Linesheet Season Year, you send these in separate columns. • If you wish to deactivate a style from all linesheets to which it is tied to, you should send a Drop record for the style with a blank linesheet name field. • You do not need to send your whole collection each time. You can choose to only send the style/colors that have changed. • To change a color name, you must pass through a Drop/Delete for the old color name and then an Add for the new color name. Please see our Testing Scenarios section for further guide on how to perform this update. • Sizes are excluded from the updates managed through the Action Codes. There are two ways to remove a size: o Send an Update record with all sizes you wish to display. The remaining sizes that are excluded from your file will be marked inactive on JOOR. o Include a Size Active Column in your Style Sync file. If any value is populated in this column for a specific row, the size will remain active. If left blank, the size will be marked inactive. • We are able to process file formats with either: o one size per row (recommended), or o a list of comma separated sizes in a single row • To manage size order display you must either: o include a Size Order column in your Style Sync file or o list sizes in the correct display order Testing Scenarios A list of recommended Style Sync testing scenarios is also available for your reference. You may download it from the Testing Scenarios section of our Style Sync documentation online. Use this list as a guideline as you test different scenarios that are relevant to your business. Once all relevant tests have been executed successfully, your integration should be just about ready to activate on your Production account. Reporting Success and Error report emails are generated every time a file is processed via the integrations. If you and your team wish to receive these report emails, please specify the recipients’ email address/es and we will set them up accordingly. This feature is available on the Production environment. If you wish to receive the email reports during the testing period on Sandbox, please reach out to your dedicated Integrations Manager.
Template Field Name
Required
Value
Max
Description
Action Code
Y
Text
-
The key that tells the integration how to read each row of data.
Linesheet Name
N
Text
100
A descriptive name for the delivery (linesheet) displayed to customers
Linesheet Code
N
Text
100
A code associated with the delivery (linesheet)
start_ship_date
Linesheet Start Ship Date
N
Date (MM/DD/YYYY)
10
The delivery starting date
end_ship_date
Linesheet Complete Ship Date
N
Date (MM/DD/YYYY)
10
The delivery ending date
cancel_date
Linesheet Cancel Date
N
Date (MM/DD/YYYY)
10
The delivery cancel date
season_name
Linesheet Season Name
N
Text
100
The name of the season
Linesheet Season Code
N
Text
25
Code used to signify the season. Recommende d as 3 digit (padded).
Linesheet Season Year
N
Date (YYYY)
4
The year of the season
Linesheet Minimum Delivery Window
N
Integer
-
Required if linesheet start date is provided without end date
Linesheet Style Comments
N
Text
255
Delivery (linesheet)specific comments about the style
JOOR Field Name
action_code
delivery_name
delivery_code
season_code
season_year
minimum_delivery _window
collection_style _comment
style_display_order
Linesheet Style Display Order
N
Integer
10
The order in which the styles are displayed on the linesheet
Style Name
Y
Text
100
The name of the style as it is intended to be displayed
Style Number
Y
Text
45
Code used to signify styles.
Style Description
N
Text
500
Text description for the style
Style Minimum Order Quantity
N
Integer
-
A minimum per style to be bought.
Style Materials
N
Text
125
Description of the material used to construct the style
Style Source of Materials
N
Text
100
Description of the source of the material used to construct the style.
Style Country of Origin
N
Text
100
The country where the style is manufactured.
Style Fabrication
N
Text
150
Description of the fabrication. This field can be used to group linesheets.
Style Fabrication Code
N
Text
45
Code used to signify the fabrication.
Style Silhouette
N
Text
150
Description of the silhouette of the style.
Style Silhouette Code
N
Text
45
Code used to signify the
style_name
style_number
style_description
style_minimum _order_quantity
style_materials
style_source_of _materials
style_country_of _origin
style_fabrication
style_fabrication _code
style_silhouette
style_silhouette _code
silhouette. Style Heel Height
N
Text
45
Description of the height of the heel for footwear
Style Division Name
N
Text
100
The primary division the style belongs to. Required if a division code is provided.
Style Division Code
N
Text
25
Code used to signify the division.
Style Model Height
N
Text
-
The height of the model in the featured style image
Style Measurements
N
Text
255
Description of the general measurements of the style. Field is displayed.
Style Category Gender
N
Text
-
The gender of the item. Available options: Mens, Womens, Unisex, Home, Baby Boys, Baby Girls, Baby Neutral/Acces sories, Girls, Boys
Style Category
N
Text
-
The higher level, JOOR provided category.
Style Subcategory
N
Text
-
The specific, JOOR provided category.
Style Contains Fur
N
Boolean
-
Boolean value that indicates if the style contains fur. File must
style_heel_height
division_name
division_code
style_model_height
style_measurements
style_category _gender
style_category_1
style_category_2
style_contains_fur
contain either “Yes” or “No”. Style Tag Value 1
N
Text
100
The value assigned to the custom style tag. Custom field name must be preset in JOOR before being used with the integration.
Style Tag Value Code 1
N
Text
20
The code associated with the value assigned to the custom style tag.
Color Name
Y
Text
100
The display name of the color.
Color Code
N
Text
100
The client color code. Recommende d as 3 digit (padded).
Individual Size Name
Y
Text
255
The individual sizes available for purchase.
Size Code
N
Text
25
A client specified code or identifier for the size (usually a size run code).
Size Description
N
Text
100
A long description that could include case pack description or size translations.
Size Order
N
Integer
-
The correct display order of each individual size.
Size Active
N
Text
-
Indicates
tag_value_%
tag_value_code_%
color_name
color_code
size_name
size_code
size_description
size_order
size_active
whether size in row is active or inactive. Populate with value if active, leave blank if inactive. UPC
N
Text
100
The universal product code for the designated SKU (Style Number, Color, Size).
Casepack Name
N
Text
128
The client assigned name of the casepack. Must be preloaded into JOOR.
Casepack Quantity
N
Integer
-
The number of units contained in the casepack
Price Type Currency 1
Y
Text
3
The 3-digit currency code associated with the price level.
Price Type Label 1
Y
Text
50
The display name for the price level.
Wholesale Price 1
Y
Decimal
-
The wholesale price value for the price level.
Retail Price 1
N
Decimal
-
The retail price value for the price level.
FTP Image Directory
N
Text
-
The folder on the FTP server from which the image files will be sourced.
Image FTP Filename 1
N
Text
-
The name of the corresponding style-level image file
upc
casepack_name
casepack_quantity
price_type _currency_%
price_type_label_%
wholesale_price_%
suggested_retail _price_%
image_directory
style_image _filename%
placed on the FTP. Image URL 1
N
Text
-
The URL pointing to the corresponding style-level image.
Style Color Image FTP Filename
N
Text
-
The name of the corresponding color-level image file placed on the FTP.
Style Color Image URL
N
Text
-
The URL pointing to the corresponding color-level image.
Style Color Swatch FTP Filename
N
Text
-
The name of the corresponding color-level swatch image file placed on the FTP.
Style Color Swatch URL
N
Text
-
The URL pointing to the corresponding color-level swatch image.
style_image_url_%
style_color_image _filename
style_color_image _url
style_color_swatch _filename
style_color_swatch _url
