Retrieve related attributes based on given attribute set ID

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Magento2 MCP server": {
    "url": "https://magento2.doc.winkelstraat.nl/mcp"
  }
}

Close
GET /V1/products/attribute-sets/{attributeSetId}/attributes

Retrieve related attributes based on given attribute set ID

Path parameters

  • attributeSetId string Required

Responses

  • 200 Success.

    Hide response attributes Show response attributes object
    • extension_attributes object

      ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeInterface

      Hide extension_attributes attribute Show extension_attributes attribute object
      • is_pagebuilder_enabled boolean
    • is_wysiwyg_enabled boolean

      WYSIWYG flag

    • is_html_allowed_on_front boolean

      The HTML tags are allowed on the frontend

    • used_for_sort_by boolean

      It is used for sorting in product listing

    • is_filterable boolean

      It used in layered navigation

    • is_used_in_grid boolean

      It is used in catalog product grid

    • is_visible_in_grid boolean

      It is visible in catalog product grid

    • is_filterable_in_grid boolean

      It is filterable in catalog product grid

    • position integer

      Position

    • apply_to array[string]

      Apply to value for the element

    • is_searchable string

      The attribute can be used in Quick Search

    • is_comparable string

      The attribute can be compared on the frontend

    • is_used_for_promo_rules string

      The attribute can be used for promo rules

    • is_visible_on_front string

      The attribute is visible on the frontend

    • used_in_product_listing string

      The attribute can be used in product listing

    • is_visible boolean

      Attribute is visible on frontend.

    • scope string

      Attribute scope

    • attribute_id integer

      Id of the attribute.

    • attribute_code string Required

      Code of the attribute.

    • frontend_input string Required

      HTML for input element.

    • entity_type_id string Required

      Entity type id

    • is_required boolean Required

      Attribute is required.

    • options array[object]

      Options of the attribute (key => value pairs for select)

      Hide options attributes Show options attributes object

      Created from:

      • label string Required

        Option label

      • value string Required

        Option value

      • sort_order integer

        Option order

      • is_default boolean

        Default

      • store_labels array[object]

        Option label for store scopes

        Hide store_labels attributes Show store_labels attributes object

        Interface AttributeOptionLabelInterface

        • store_id integer

          Store id

        • label string

          Option label

    • is_user_defined boolean

      Current attribute has been defined by a user.

    • default_frontend_label string

      Frontend label for default store

    • frontend_labels array[object] Required

      Frontend label for each store

      Hide frontend_labels attributes Show frontend_labels attributes object

      Interface AttributeFrontendLabelInterface

      • store_id integer

        Store id

      • label string

        Option label

    • note string

      The note attribute for the element.

    • backend_type string

      Backend type.

    • backend_model string

      Backend model

    • source_model string

      Source model

    • default_value string

      Default value for the element.

    • is_unique string

      This is a unique attribute

    • frontend_class string

      Frontend class of attribute

    • validation_rules array[object]

      Validation rules.

      Hide validation_rules attributes Show validation_rules attributes object

      Interface AttributeValidationRuleInterface

      • key string Required

        Object key

      • value string Required

        Object value

    • custom_attributes array[object]

      Custom attributes values.

      Hide custom_attributes attributes Show custom_attributes attributes object

      Interface for custom attribute value.

      • attribute_code string Required

        Attribute code

      • value string Required

        Attribute value

    Hide response attributes Show response attributes object
    • extension_attributes object

      ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeInterface

      Hide extension_attributes attribute Show extension_attributes attribute object
      • is_pagebuilder_enabled boolean
    • is_wysiwyg_enabled boolean

      WYSIWYG flag

    • is_html_allowed_on_front boolean

      The HTML tags are allowed on the frontend

    • used_for_sort_by boolean

      It is used for sorting in product listing

    • is_filterable boolean

      It used in layered navigation

    • is_used_in_grid boolean

      It is used in catalog product grid

    • is_visible_in_grid boolean

      It is visible in catalog product grid

    • is_filterable_in_grid boolean

      It is filterable in catalog product grid

    • position integer

      Position

    • apply_to array[string]

      Apply to value for the element

    • is_searchable string

      The attribute can be used in Quick Search

    • is_comparable string

      The attribute can be compared on the frontend

    • is_used_for_promo_rules string

      The attribute can be used for promo rules

    • is_visible_on_front string

      The attribute is visible on the frontend

    • used_in_product_listing string

      The attribute can be used in product listing

    • is_visible boolean

      Attribute is visible on frontend.

    • scope string

      Attribute scope

    • attribute_id integer

      Id of the attribute.

    • attribute_code string Required

      Code of the attribute.

    • frontend_input string Required

      HTML for input element.

    • entity_type_id string Required

      Entity type id

    • is_required boolean Required

      Attribute is required.

    • options array[object]

      Options of the attribute (key => value pairs for select)

      Hide options attributes Show options attributes object

      Created from:

      • label string Required

        Option label

      • value string Required

        Option value

      • sort_order integer

        Option order

      • is_default boolean

        Default

      • store_labels array[object]

        Option label for store scopes

        Hide store_labels attributes Show store_labels attributes object

        Interface AttributeOptionLabelInterface

        • store_id integer

          Store id

        • label string

          Option label

    • is_user_defined boolean

      Current attribute has been defined by a user.

    • default_frontend_label string

      Frontend label for default store

    • frontend_labels array[object] Required

      Frontend label for each store

      Hide frontend_labels attributes Show frontend_labels attributes object

      Interface AttributeFrontendLabelInterface

      • store_id integer

        Store id

      • label string

        Option label

    • note string

      The note attribute for the element.

    • backend_type string

      Backend type.

    • backend_model string

      Backend model

    • source_model string

      Source model

    • default_value string

      Default value for the element.

    • is_unique string

      This is a unique attribute

    • frontend_class string

      Frontend class of attribute

    • validation_rules array[object]

      Validation rules.

      Hide validation_rules attributes Show validation_rules attributes object

      Interface AttributeValidationRuleInterface

      • key string Required

        Object key

      • value string Required

        Object value

    • custom_attributes array[object]

      Custom attributes values.

      Hide custom_attributes attributes Show custom_attributes attributes object

      Interface for custom attribute value.

      • attribute_code string Required

        Attribute code

      • value string Required

        Attribute value

  • 400 Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/products/attribute-sets/{attributeSetId}/attributes
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/attribute-sets/{attributeSetId}/attributes'
Response examples (200)
[
  {
    "extension_attributes": {
      "is_pagebuilder_enabled": true
    },
    "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": 42,
    "apply_to": [
      "string"
    ],
    "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": 42,
    "attribute_code": "string",
    "frontend_input": "string",
    "entity_type_id": "string",
    "is_required": true,
    "options": [
      {
        "label": "string",
        "value": "string",
        "sort_order": 42,
        "is_default": true,
        "store_labels": [
          {
            "store_id": 42,
            "label": "string"
          }
        ]
      }
    ],
    "is_user_defined": true,
    "default_frontend_label": "string",
    "frontend_labels": [
      {
        "store_id": 42,
        "label": "string"
      }
    ],
    "note": "string",
    "backend_type": "string",
    "backend_model": "string",
    "source_model": "string",
    "default_value": "string",
    "is_unique": "string",
    "frontend_class": "string",
    "validation_rules": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  }
]
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <extension-attributes>
      <is-pagebuilder-enabled type="boolean">true</is-pagebuilder-enabled>
    </extension-attributes>
    <is-wysiwyg-enabled type="boolean">true</is-wysiwyg-enabled>
    <is-html-allowed-on-front type="boolean">true</is-html-allowed-on-front>
    <used-for-sort-by type="boolean">true</used-for-sort-by>
    <is-filterable type="boolean">true</is-filterable>
    <is-filterable-in-search type="boolean">true</is-filterable-in-search>
    <is-used-in-grid type="boolean">true</is-used-in-grid>
    <is-visible-in-grid type="boolean">true</is-visible-in-grid>
    <is-filterable-in-grid type="boolean">true</is-filterable-in-grid>
    <position type="integer">42</position>
    <apply-to type="array">
      <apply-to>string</apply-to>
    </apply-to>
    <is-searchable>string</is-searchable>
    <is-visible-in-advanced-search>string</is-visible-in-advanced-search>
    <is-comparable>string</is-comparable>
    <is-used-for-promo-rules>string</is-used-for-promo-rules>
    <is-visible-on-front>string</is-visible-on-front>
    <used-in-product-listing>string</used-in-product-listing>
    <is-visible type="boolean">true</is-visible>
    <scope>string</scope>
    <attribute-id type="integer">42</attribute-id>
    <attribute-code>string</attribute-code>
    <frontend-input>string</frontend-input>
    <entity-type-id>string</entity-type-id>
    <is-required type="boolean">true</is-required>
    <options type="array">
      <option>
        <label>string</label>
        <value>string</value>
        <sort-order type="integer">42</sort-order>
        <is-default type="boolean">true</is-default>
        <store-labels type="array">
          <store-label>
            <store-id type="integer">42</store-id>
            <label>string</label>
          </store-label>
        </store-labels>
      </option>
    </options>
    <is-user-defined type="boolean">true</is-user-defined>
    <default-frontend-label>string</default-frontend-label>
    <frontend-labels type="array">
      <frontend-label>
        <store-id type="integer">42</store-id>
        <label>string</label>
      </frontend-label>
    </frontend-labels>
    <note>string</note>
    <backend-type>string</backend-type>
    <backend-model>string</backend-model>
    <source-model>string</source-model>
    <default-value>string</default-value>
    <is-unique>string</is-unique>
    <frontend-class>string</frontend-class>
    <validation-rules type="array">
      <validation-rule>
        <key>string</key>
        <value>string</value>
      </validation-rule>
    </validation-rules>
    <custom-attributes type="array">
      <custom-attribute>
        <attribute-code>string</attribute-code>
        <value>string</value>
      </custom-attribute>
    </custom-attributes>
  </root>
</root>
Response examples (400)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (400)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>