Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "attribute_set": {
        "name": "Apparel",
        "product_levels": [
            {
                "name": "Style",
                "product_level": {
                    "name": "Color"
                }
            }
        ]
    }
  }

response:
  {
    "id": 6,
    "name": "Apparel",
    "product_level_count": 2,
    "product_levels": [
      {
        "id": 5,
        "name": "Style"
      },
      {
        "id": 6,
        "name": "Color"
      }
    ]
  }

Params

Param name Description
attribute_set
required

Validations:

  • Must be a Hash

attribute_set[name]
required

Name of the attribute set (unique)

Validations:

  • Must be a String

attribute_set[product_levels]
optional , nil allowed

List of product levels that the attribute set has

Validations:

  • Must be an Array of nested elements

attribute_set[product_levels][name]
required

Name of the product level

Validations:

  • Must be a String

attribute_set[product_levels][include_media]
optional , nil allowed

Allow images to be included at this level

Validations:

  • Must be one of: true, false, 1, 0.

attribute_set[product_levels][include_price]
optional , nil allowed

Allow prices to be included at this level

Validations:

  • Must be one of: true, false, 1, 0.

attribute_set[product_levels][include_category]
optional , nil allowed

Allow categories to be included at this level

Validations:

  • Must be one of: true, false, 1, 0.

attribute_set[product_levels][include_inventory]
optional , nil allowed

Allow inventories to be included at this level

Validations:

  • Must be one of: true, false, 1, 0.

attribute_set[product_levels][include_dimension]
optional , nil allowed

Allow dimensions to be included at this level

Validations:

  • Must be one of: true, false, 1, 0.

attribute_set[product_levels][product_level]
optional , nil allowed

Child product level. It accepts the params of a product level

Validations:

  • Must be a Hash

attribute_set[product_levels][attribute_definition_ids]
optional , nil allowed

List of attribute definition IDs that the product level has. Do not provide if ‘attribute_definitions’ is provided

Validations:

  • Must be an array of Integer

attribute_set[product_levels][attribute_definitions]
optional

List of attribute definitions that the product level has. Do not provide if ‘attribute_definition_ids’ is provided

Validations:

  • Must be an Array of nested elements

attribute_set[product_levels][attribute_definitions][code]
required

Code of the attribute definition

Validations:

  • Must be a String