ReDoc documentation

products/attributes/{attributeCode}

products/attributes/{attributeCode}

get/V1/products/attributes/{attributeCode}

Retrieve specific attribute

Request
path Parameters
attributeCode
required
string
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "extension_attributes": {
    },
  • "is_wysiwyg_enabled": true,
  • "is_html_allowed_on_front": true,
  • "used_for_sort_by": true,
  • "is_filterable": true,
  • "is_filterable_in_search": true,
  • "is_used_in_grid": true,
  • "is_visible_in_grid": true,
  • "is_filterable_in_grid": true,
  • "position": 0,
  • "apply_to": [
    ],
  • "is_searchable": "string",
  • "is_visible_in_advanced_search": "string",
  • "is_comparable": "string",
  • "is_used_for_promo_rules": "string",
  • "is_visible_on_front": "string",
  • "used_in_product_listing": "string",
  • "is_visible": true,
  • "scope": "string",
  • "attribute_id": 0,
  • "attribute_code": "string",
  • "frontend_input": "string",
  • "entity_type_id": "string",
  • "is_required": true,
  • "options": [
    ],
  • "is_user_defined": true,
  • "default_frontend_label": "string",
  • "frontend_labels": [
    ],
  • "note": "string",
  • "backend_type": "string",
  • "backend_model": "string",
  • "source_model": "string",
  • "default_value": "string",
  • "is_unique": "string",
  • "frontend_class": "string",
  • "validation_rules": [
    ],
  • "custom_attributes": [
    ]
}

products/attributes/{attributeCode}

put/V1/products/attributes/{attributeCode}

Save attribute data

Request
path Parameters
attributeCode
required
string
Request Body schema:
required
object (catalog-data-product-attribute-interface)
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "attribute": {
    }
}
Response samples
{
  • "extension_attributes": {
    },
  • "is_wysiwyg_enabled": true,
  • "is_html_allowed_on_front": true,
  • "used_for_sort_by": true,
  • "is_filterable": true,
  • "is_filterable_in_search": true,
  • "is_used_in_grid": true,
  • "is_visible_in_grid": true,
  • "is_filterable_in_grid": true,
  • "position": 0,
  • "apply_to": [
    ],
  • "is_searchable": "string",
  • "is_visible_in_advanced_search": "string",
  • "is_comparable": "string",
  • "is_used_for_promo_rules": "string",
  • "is_visible_on_front": "string",
  • "used_in_product_listing": "string",
  • "is_visible": true,
  • "scope": "string",
  • "attribute_id": 0,
  • "attribute_code": "string",
  • "frontend_input": "string",
  • "entity_type_id": "string",
  • "is_required": true,
  • "options": [
    ],
  • "is_user_defined": true,
  • "default_frontend_label": "string",
  • "frontend_labels": [
    ],
  • "note": "string",
  • "backend_type": "string",
  • "backend_model": "string",
  • "source_model": "string",
  • "default_value": "string",
  • "is_unique": "string",
  • "frontend_class": "string",
  • "validation_rules": [
    ],
  • "custom_attributes": [
    ]
}

products/attributes/{attributeCode}

delete/V1/products/attributes/{attributeCode}

Delete Attribute by id

Request
path Parameters
attributeCode
required
string
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Response samples
true
➔ Next to products/attributes/{attributeCode}/is-filterable