You can use the Style POST API method to create new styles on JOOR.
Endpoint:
- Method: POST
- URI: https://api.jooraccess.com/v2/style-number
Headers
- Accept: application/xml OR application/json
- Content-Type: application/xml OR application/json
- Authorization: OAuth2 [Base64 encoded token]
Request Field Details
Style identifier
Styles are uniquely identified on JOOR by the style identifier field. A style identifier is a client designated ID or key used to identify a particular style. Style number is the most commonly used style identifier. However, some brands identify individual styles by concatenating style number and color name, for example. This will create unique styles (or style cards) on JOOR for each style number/color name combination.
Linesheet Management: delivery_overwrite
A style's linesheets can be managed via the API in four ways.
Overwriting all linesheets is the default option (delivery_overwrite = 1) and will update a style's assigned linesheets to match only those listed in the deliveries section of the call.
Overwriting API created linesheets (delivery_overwrite = 2) will update a style's linesheets to match those of the API call as well, but will not remove the style from any manually (non-API) created linesheets.
The option to add a style to linesheets (delivery_overwrite = 3) will only add a style to linesheets and will not remove the style from any other linesheets previously assigned.
The fourth option (delivery_overwrite = 4) will remove the style from the specified linesheets only.
FIELD NAME | REQ within current node |
VALUE | MAX | DISPLAY | DESCRIPTION |
---|---|---|---|---|---|
+ styles | node : 1-1 | ||||
+ style | node : 1-1 | ||||
style_name | Y | Any String | 100 | Y | The name of the style as it is intended to be displayed. |
style_number | Y | Any String | 45 | Y | Code used to signify styles. |
style_identifier | Y | Any String | 100 | N | A client designated ID or key used to identify a particular style. |
style_description | Highly Recommended | Any string | 500 | Y | Text description for the style. |
made_to_order | N | Boolean | N | Boolean value that indicates if the style has inventory constraints. Can only be used to remove inventory constraints if a style already has inventory loaded. | |
division | X | Any String | 100 | Y | The primary division the style belongs to. Required if a division code is provided. |
division_code | X | Any String | 25 | N | Code used to signify the division. |
style_country_origin | N | Any String | 100 | Y | The country where the style is manufactured. |
fabrication | Highly Recommended | Any String | 150 | Y | Description of the fabrication. This field can be used to group linesheets. |
fabrication_code | N | Any String | 45 | Y | Code used to signify the fabrication. |
measurements | N | Any String | 255 | Y | Description of the general measurements of the style. |
silhouette | Highly Recommended | Any String | 150 | Y | Description of the silhouette. |
silhouette_code | N | Any String | 45 | Y | Code used to signify the silhouette. |
source_of_materials | N | Any String | 100 | Y | Description of the source of the material used to construct the style. |
heel_height | N | Any String | 45 | Y | Description of the height of the heel for footwear. |
contains_fur | Highly Recommended | Boolean | Y | Boolean value that indicates if the style contains fur. | |
delivery_overwrite | N | Integer | 1 | Y | Indicator that determines how linesheets should be managed. |
minimum | N | Integer | 5 | Y | A guideline minimum per style to be bought. |
+ categories | node : 0-1 | ||||
category_id | Y | Integer | N | Joor subcategory ID. A list of category IDs can be found by using the GET Categories API request. | |
+ materials | node : 0-1 | ||||
material | Highly Recommended | Any String | 125 | Y | Description of the material used to construct the style. |
+ prices | node : 0-1 | ||||
+ price | node : 1-n | ||||
price_label | Y | Any String | 50 | Y | Used to delineate between multiple prices of the same currency. |
price_currency | Y | Any String | 3 | Y | The 3 letter ISO designation of the price's currency. |
price_wholesale | Y | Decimal | 5 | Y | The price the retailer will pay for the for the style when ordering. |
price_retail | N | Decimal | 5 | Y | The recommended retail price of the style. |
price_currency_retail | N | Any String | 3 | Y | The 3 letter ISO designation of the retail price currency. |
+ deliveries | node : 0-1 | ||||
+ delivery | node : 1-n | ||||
delivery_name | N | Any String | 100 | Y | A descriptive name for the delivery (linesheet) displayed to customers. |
delivery_code | N | Any String | 100 | Y | A code associated with the delivery (linesheet). |
style_display_order | N | Integer | Y | The order in which the style is displayed within the delivery (linesheet). | |
season_name | N | Any String | 100 | Y | The name of the season. |
season_year | N | Integer | Y | The year of the season. | |
season_code | N | Any String | 25 | Y | Code used to signify the season. Recommended as 3 digit (padded). |
date_delivery_start | X | UTC Datefield | Y | The delivery starting date. | |
date_delivery_end | X | UTC Datefield | Y | The delivery ending date (complete ship date). | |
public | N | 1,0 | 1 | Y | If the field is not provided the default setting = yes. If public = 1 then the Delivery is viewable to connections on the Website. |
+ color_exclusions | node : 0-1 | ||||
+ color_exclusion | node : 1-n | ||||
color_name | Y | Any String | 100 | Y | The display name of the color. |
color_code | Highly Recommended | Any String | 100 | Y | The client color code. Recommended NRF compliant. |
+ colors | node : 1-1 | ||||
+ color | node : 1-n | ||||
color_name | Y | Any String | 100 | Y | The display name of the color. |
color_code | Highly Recommended | Any String | 100 | Y | The client color code. Recommended NRF compliant. |
minimum | N | Integer | 5 | Y | A minimum per color to be bought. |
color_hex | N | String | N | Hexidecimal color number used to represent the color without use of a swatch. (without #) | |
+ sizes | node : 1-1 | ||||
+ size | node : 1-n | ||||
size_name | Y | Any String | 50 | Y | The individual sizes available for purchase. Must not include commas. |
size_code | N | Any String | 25 | Y | A client specified code or identifier for the size (often a size run code). Must not include commas. |
size_description | N | Any String | 100 | Y | A long description that could include case pack description or size translations. |
size_multiplier | N | Integer | Y | Indicates number of items included in a casepack. | |
casepack_id | X | Any String | Y | Casepack ID. (Only required if casepacks are used, contact your Integrations Manager for a list of casepack IDs) | |
+ badges | node : 0-1 | ||||
+ badges | node : 1-n | ||||
badge_name | N | Any String | 255 | Y | A description of the badge, (e.g. Best Seller). |
+ tags | node : 0-1 | ||||
+ tag | node : 1-n | ||||
tag_id | N | Integer | N | The JOOR assigned ID for the style tag. If tag has been pre-created in JOOR, can be sent to add/update tag values to styles. For a list of tag ids please contact your JOOR integrations Manager | |
tag_group | N | Any String | 100 | Y | The group in which the tag resides in JOOR. Required if sending tags without tag_id. |
tag_name | N | Any String | 50 | Y | The name of the tag as specified in JOOR. Required if sending tags without tag_id. |
tag_value | N | Any String | 100 | Y | The value being populated in the style tag. Required if sending tags to JOOR. |
tag_value_code | N | Any String | 45 | Y | The code corresponding to the value being populated in the style tag. |
+ upcs | node : 0-1 | ||||
+ style_upc | node : 1-n | ||||
sku_color_code | N* | Any String | 50 | N | The SKU color code used to make up the UPC. *If upc is included, EITHER sku_color_code or sku_color_name is required. |
sku_color_name | N* | Any String | 50 | N | The SKU color name used to make up the UPC. *If upc is included, EITHER sku_color_code or sku_color_name is required. |
sku_size | N | Any String | 50 | N | The SKU size name (size_name) used to make the UPC. |
upc | Highly Recommended | Any String | 100 | N | The universal product code for the designated SKU (Style Number, Color, Size). |
Response Field Details
FIELD NAME | TYPE | DESCRIPTION |
---|---|---|
+ styles_created | node | |
+ response | node | |
code | Integer | success/error code |
log_id | Any String | correlation id |
+ style_created | node | |
style_number | Any String | The Original style number provided by the client |
style_identifier | Any String | Client designated ID used to uniquely identify styles created on JOOR. |
style_id | ID | The JOOR unique identifier for the styles that were created |
Request Example
<?xml version="1.0" encoding="UTF-8"?>
<styles>
<style>
<style_name>Test Style 1 sleeveless top</style_name>
<style_number>Test Style 1</style_number>
<style_identifier>Test Style 1</style_identifier>
<style_description>This is a sleeveless top.</style_description>
<made_to_order>True</made_to_order>
<division>W.E</division>
<division_code>W.E</division_code>
<style_country_origin>Italy</style_country_origin>
<fabrication>50% Wool/ 40% Acrylic/ 10% Alpaca</fabrication>
<fabrication_code></fabrication_code>
<silhouette>Slim</silhouette>
<silhouette_code>SLM</silhouette_code>
<measurements></measurements>
<source_of_materials>CN</source_of_materials>
<heel_height>N/A</heel_height>
<contains_fur>False</contains_fur>
<badges>
<badge>
<badge_name>Best Seller</badge_name>
</badge>
</badges>
<minimum>200</minimum>
<categories>
<category_id>2</category_id>
</categories>
<materials>
<material>54% POLYAMIDE 32% COTON 14% POLYESTER</material>
</materials>
<prices>
<price>
<price_label>LUCY</price_label>
<price_currency>GBP</price_currency>
<price_wholesale>53.00</price_wholesale>
<price_retail>145.00</price_retail>
<price_currency_retail>GBP</price_currency_retail>
</price>
<price>
<price_label>EXPORT-WW</price_label>
<price_currency>EUR</price_currency>
<price_wholesale>68.50</price_wholesale>
<price_retail>0.00</price_retail>
<price_currency_retail>EUR</price_currency_retail>
</price>
<price>
<price_label>EUROPE</price_label>
<price_currency>EUR</price_currency>
<price_wholesale>63.00</price_wholesale>
<price_retail>0.00</price_retail>
<price_currency_retail>EUR</price_currency_retail>
</price>
<price>
<price_label>EXPORT-CN</price_label>
<price_currency>EUR</price_currency>
<price_wholesale>72.50</price_wholesale>
<price_retail>0.00</price_retail>
<price_currency_retail>EUR</price_currency_retail>
</price>
<price>
<price_label>EXPORT-US</price_label>
<price_currency>USD</price_currency>
<price_wholesale>95.00</price_wholesale>
<price_retail>0.00</price_retail>
<price_currency_retail>USD</price_currency_retail>
</price>
</prices>
<deliveries>
<delivery>
<delivery_name>Summer '16 Basic Women</delivery_name>
<delivery_code>S16</delivery_code>
<style_display_order>25</style_display_order>
<date_delivery_start>2016-01-15T00:00:00.0000000-04:00</date_delivery_start>
<date_delivery_end>2016-03-31T00:00:00.0000000-04:00</date_delivery_end>
<public>0</public>
<season_name>Summer</season_name>
<season_year>2016</season_year>
<season_code>S2016</season_code>
<color_exclusions>
<color_exclusion>
<color_name>Combo 1</color_name>
<color_code>C1</color_code>
</color_exclusion>
</color_exclusions>
</delivery>
</deliveries>
<colors>
<color>
<color_name>Combo 1</color_name>
<color_code>C1</color_code>
<minimum>0</minimum>
</color>
<color>
<color_name>Combo 2</color_name>
<color_code>C2</color_code>
<minimum>0</minimum>
</color>
</colors>
<sizes>
<size>
<size_name>34</size_name>
<size_code>34</size_code>
<size_description>34</size_description>
</size>
<size>
<size_name>36</size_name>
<size_code>36</size_code>
<size_description>36</size_description>
</size>
<size>
<size_name>38</size_name>
<size_code>38</size_code>
<size_description>38</size_description>
</size>
<size>
<size_name>40</size_name>
<size_code>40</size_code>
<size_description>40</size_description>
</size>
<size>
<size_name>42</size_name>
<size_code>42</size_code>
<size_description>42</size_description>
</size>
<size>
<size_name>44</size_name>
<size_code>44</size_code>
<size_description>44</size_description>
</size>
<size>
<size_name>C11</size_name>
<size_multiplier>5</size_multiplier>
<casepack_id>1</casepack_id>
</size>
</sizes>
<tags>
<tag>
<tag_id>906</tag_id>
<tag_value>Acid</tag_value>
<tag_value_code>ACIDCODE</tag_value_code>
</tag>
<tag>
<tag_group>Attributes</tag_group>
<tag_name>Wash</tag_name>
<tag_value>Raw</tag_value>
</tag>
</tags>
<upcs>
<style_upc>
<sku_color_name>Combo 2</sku_color_name>
<sku_size>42</sku_size>
<upc>5414855153807</upc>
</style_upc>
<style_upc>
<sku_color_code>C2</sku_color_code>
<sku_size>40</sku_size>
<upc>5414855153791</upc>
</style_upc>
<style_upc>
<sku_color_code>C2</sku_color_code>
<sku_size>34</sku_size>
<upc>5414855153760</upc>
</style_upc>
<style_upc>
<sku_color_code>C2</sku_color_code>
<sku_size>44</sku_size>
<upc>5414855153814</upc>
</style_upc>
<style_upc>
<sku_color_code>C2</sku_color_code>
<sku_size>36</sku_size>
<upc>5414855153777</upc>
</style_upc>
<style_upc>
<sku_color_code>C2</sku_color_code>
<sku_size>38</sku_size>
<upc>5414855153784</upc>
</style_upc>
<style_upc>
<sku_color_code>C1</sku_color_code>
<sku_size>44</sku_size>
<upc>5414855153753</upc>
</style_upc>
<style_upc>
<sku_color_code>C1</sku_color_code>
<sku_size>40</sku_size>
<upc>5414855153739</upc>
</style_upc>
<style_upc>
<sku_color_code>C1</sku_color_code>
<sku_size>38</sku_size>
<upc>5414855153722</upc>
</style_upc>
<style_upc>
<sku_color_code>C1</sku_color_code>
<sku_size>34</sku_size>
<upc>5414855153708</upc>
</style_upc>
<style_upc>
<sku_color_code>C1</sku_color_code>
<sku_size>36</sku_size>
<upc>5414855153715</upc>
</style_upc>
<style_upc>
<sku_color_code>C1</sku_color_code>
<sku_size>42</sku_size>
<upc>5414855153746</upc>
</style_upc>
</upcs>
</style>
</styles>
{
"styles": {
"style": {
"style_name": "Test Style 1 sleeveless top",
"style_number": "Test Style 1",
"style_identifier": "Test Style 1",
"style_description": "This is a sleeveless top.",
"made_to_order": "True",
"division": "W.E",
"division_code": "W.E",
"style_country_origin": "Italy",
"measurements": "",
"fabrication": "50% Wool/ 40% Acrylic/ 10% Alpaca",
"fabrication_code": "",
"silhouette": "Slim",
"silhouette_code": "SLM",
"source_of_materials": "CN",
"heel_height": "N/A",
"contains_fur": "False",
"best_seller": "True",
"minimum": "200",
"categories": [
2
],
"materials": [
"54% POLYAMIDE 32% COTON 14% POLYESTER"
],
"prices": [
{
"price_label": "LUCY",
"price_currency": "GBP",
"price_wholesale": 53,
"price_retail": 145,
"price_currency_retail": "GBP"
},
{
"price_label": "EUROPE",
"price_currency": "EUR",
"price_wholesale": 63,
"price_retail": 0,
"price_currency_retail": "EUR"
},
{
"price_label": "EXPORT-WW",
"price_currency": "EUR",
"price_wholesale": 68.5,
"price_retail": 0,
"price_currency_retail": "EUR"
},
{
"price_label": "EXPORT-CN",
"price_currency": "EUR",
"price_wholesale": 72.5,
"price_retail": 0,
"price_currency_retail": "EUR"
},
{
"price_label": "EXPORT-US",
"price_currency": "USD",
"price_wholesale": 95,
"price_retail": 0,
"price_currency_retail": "USD"
}
],
"deliveries": [
{
"delivery_name": "Summer '16 Basic Women",
"delivery_code": "S16",
"style_display_order": 25,
"season_name": "Summer",
"season_year": "2016",
"season_code": "S2016",
"date_cancel": "",
"date_delivery_start": "2016-01-15",
"date_delivery_end": "2016-03-31",
"public": "0",
"style_comments": "",
"color_exclusions": [
{
"color_name": "Combo 1",
"color_code": "C1"
}
]
}
],
"colors": [
{
"color_name": "Combo 1",
"color_code": "C1",
"color_image": "",
"color_hex": "",
"minimum": "0"
},
{
"color_name": "Combo 2",
"color_code": "C2",
"color_image": "",
"color_hex": "",
"minimum": "0"
}
],
"sizes": [
{
"size_name": "34",
"size_code": "34",
"size_description": "34",
"size_multiplier": ""
},
{
"size_name": "36",
"size_code": "36",
"size_description": "36",
"size_multiplier": ""
},
{
"size_name": "38",
"size_code": "38",
"size_description": "38",
"size_multiplier": ""
},
{
"size_name": "40",
"size_code": "40",
"size_description": "40",
"size_multiplier": ""
},
{
"size_name": "42",
"size_code": "42",
"size_description": "42",
"size_multiplier": ""
},
{
"size_name": "44",
"size_code": "44",
"size_description": "44",
"size_multiplier": ""
},
{
"size_name": "C11",
"size_code": "C11",
"size_description": "C11",
"size_multiplier": "5",
"casepack_id": "1"
}
],
"tags": [
{
"tag_id": "906",
"tag_value": "Acid",
"tag_value_code": "ACIDCODE"
},
{
"tag_group": "Attributes",
"tag_name": "Wash",
"tag_value": "Raw"
}
],
"badges": [
{
"badge_name": "Best Seller"
}
],
"upcs": [
{
"sku_color_code": "C2",
"sku_size": "38",
"upc": "5414855153784"
},
{
"sku_color_code": "C2",
"sku_size": "36",
"upc": "5414855153777"
},
{
"sku_color_code": "C2",
"sku_size": "44",
"upc": "5414855153814"
},
{
"sku_color_code": "C2",
"sku_size": "34",
"upc": "5414855153760"
},
{
"sku_color_code": "C2",
"sku_size": "40",
"upc": "5414855153791"
},
{
"sku_color_code": "C2",
"sku_size": "42",
"upc": "5414855153807"
},
{
"sku_color_code": "C1",
"sku_size": "42",
"upc": "5414855153746"
},
{
"sku_color_code": "C1",
"sku_size": "36",
"upc": "5414855153715"
},
{
"sku_color_code": "C1",
"sku_size": "34",
"upc": "5414855153708"
},
{
"sku_color_code": "C1",
"sku_size": "38",
"upc": "5414855153722"
},
{
"sku_color_code": "C1",
"sku_size": "40",
"upc": "5414855153739"
},
{
"sku_color_code": "C1",
"sku_size": "44",
"upc": "5414855153753"
}
]
}
}
}
Response Example
<?xml version="1.0" encoding="UTF-8"?>
<styles_created>
<response>
<code>0</code>
<log_id>d06da7dc-9b45-4e0c-9317-167763644cda</log_id>
</response>
<style_created>
<style_number>Test Style 1</style_number>
<style_identifier>Test Style 1</style_identifier>
<style_id>1749110</style_id>
</style_created>
</styles_created>
{
"styles_created": {
"response": {
"code": "0",
"comment": "",
"log_id": "fbadb5dd-640d-4400-be08-02fd6983ed35"
},
"style_created": [
{
"style_number": "Test Style 1",
"style_identifier": "Test Style 1",
"style_id": "1749115"
}
]
}
}