Posting data to the Bulk Style API will create a background job that will be processed in the order that jobs are received. The status of a bulk style job can be obtained with a GET request.

📘

Bulk API Email Notifications

Once in Production, the API can send email notifications with the results of the job. Please provide your email address to your Integrations Manager to set up these notifications.

👍

Endpoint

Params

  • Accept: application/xml OR application/json
  • Content-Type: application/xml OR application/json
  • Authorization: OAuth2 [Base64 encoded token]

Request Field Details

FIELD NAME REQ

within current node

VALUE MAX DISPLAY DESCRIPTION
+ bulk_stylesnode : 1-1 (instead of "styles" node)
  + stylenode : 1-n
     Refer to the Styles' unitary structure: same "style" node structure

Response Field Details

FIELD NAME TYPE DESCRIPTION
+ bulk_styles node
  + response node
      code Integer success/error code
  + bulk_styles_jobs node
    + bulk_style_job node
      bulk_styles_job_id Integer A JOOR unique identifier for the bulk styles job
      status String "queued", "started", "finished"
      created Date/Time Job creation date
      modified Date/Time Job last modification date
      style_record_count Integer Number of styles that are in the job
      style_record_progress Integer Style record number, if the job has been started

Request Example

<?xml version="1.0" encoding="UTF-8"?>
<bulk_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>
        <delivery_overwrite>1</delivery_overwrite>
        <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>
    <style>
            ...
        </style>
</bulk_styles>
{
  "bulk_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",
        "delivery_overwrite": "1",
        "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"?>
<bulk_styles>
    <response>
        <code>0</code>
    </response>
    <bulk_styles_jobs>
        <bulk_style_job>
            <bulk_styles_job_id>3</bulk_styles_job_id>
            <status>queued</status>
            <created>2016-07-07T18:10:32+00:00</created>
            <modified>2016-07-07T18:10:32+00:00</modified>
            <style_record_count>2</style_record_count>
            <style_record_progress>0</style_record_progress>
        </bulk_style_job>
    </bulk_styles_jobs>
</bulk_styles>
{
  "bulk_styles": {
    "response": {
      "code": 0
    },
    "bulk_styles_jobs": [
      {
        "bulk_styles_job_id": 4,
        "status": "queued",
        "created": "2016-07-07T18:17:16+00:00",
        "modified": "2016-07-07T18:17:16+00:00",
        "style_record_count": 2,
        "style_record_progress": 0
      }
    ]
  }
}