Retrieve all attributes for entity type
GET
/V1/products/attributes
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/attributes'
Response examples (200)
{
"items": [
{
"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"
}
]
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 42,
"current_page": 42
},
"total_count": 42
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<items type="array">
<item>
<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>
</item>
</items>
<search-criteria>
<filter-groups type="array">
<filter-group>
<filters type="array">
<filter>
<field>string</field>
<value>string</value>
<condition-type>string</condition-type>
</filter>
</filters>
</filter-group>
</filter-groups>
<sort-orders type="array">
<sort-order>
<field>string</field>
<direction>string</direction>
</sort-order>
</sort-orders>
<page-size type="integer">42</page-size>
<current-page type="integer">42</current-page>
</search-criteria>
<total-count type="integer">42</total-count>
</root>
Response examples (401)
{
"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 (401)
<?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>