Attributes

catalog Category Attribute Repository V1Get Get

get

Retrieve specific attribute

Path parameters
attributeCodestringRequired

(Required)

Example: <string>
Responses
200

OK

application/json
Responseobject
get
GET /V1/categories/attributes/{attributeCode} HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "attribute_code": "reprehenderit aliqua",
  "frontend_input": "do mollit in",
  "entity_type_id": "anim elit occaecat adipi",
  "is_required": true,
  "frontend_labels": [
    {
      "store_id": 63691662,
      "label": "ea in in u"
    },
    {
      "store_id": 54033626,
      "label": "elit ut et paria"
    }
  ],
  "is_wysiwyg_enabled": false,
  "is_html_allowed_on_front": true,
  "used_for_sort_by": true,
  "is_filterable": true,
  "is_filterable_in_search": false,
  "is_used_in_grid": false,
  "is_visible_in_grid": true,
  "is_filterable_in_grid": true,
  "position": -96772215,
  "apply_to": [
    "voluptate dolore elit velit ea",
    "dolor qui"
  ],
  "is_searchable": "labore in ex",
  "is_visible_in_advanced_search": "elit dolor esse et eiusmod",
  "is_comparable": "Ut quis enim fugiat aliquip",
  "is_used_for_promo_rules": "qui enim est culpa et",
  "is_visible_on_front": "id ut culpa",
  "used_in_product_listing": "nulla enim aliqua",
  "is_visible": false,
  "scope": "eu si",
  "extension_attributes": {},
  "attribute_id": 46455010,
  "options": [
    {
      "label": "anim est sint laborum veli",
      "value": "dolor cillum",
      "sort_order": 1125846,
      "is_default": true,
      "store_labels": [
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    },
    {
      "label": "irure est exercitation nostrud",
      "value": "officia laboris id",
      "sort_order": -27559194,
      "is_default": false,
      "store_labels": [
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    }
  ],
  "is_user_defined": false,
  "default_frontend_label": "et pariatur qui",
  "note": "aliquip",
  "backend_type": "do est ea",
  "backend_model": "ullamco ad dolore",
  "source_model": "labore fugiat occaecat",
  "default_value": "in ex",
  "is_unique": "ea",
  "frontend_class": "ipsum sed dolor laboris ex",
  "validation_rules": [
    {
      "key": "enim aliqua",
      "value": "sed exercitation fugiat esse"
    },
    {
      "key": "aliqua",
      "value": "consequat irure"
    }
  ],
  "custom_attributes": [
    {
      "attribute_code": "tempor occaecat",
      "value": "aute"
    },
    {
      "attribute_code": "minim offici",
      "value": "ut sed laboris"
    }
  ]
}

catalog Category Attribute Repository V1Get List Get

get

Retrieve all attributes for entity type

Query parameters
searchCriteria[filterGroups][0][filters][0][field]stringOptional

Field

Example: <string>
searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>
searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>
searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>
searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>
searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>
searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>
Responses
200

OK

application/json
Responseobject
get
GET /V1/categories/attributes HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "items": [
    {
      "attribute_code": "amet nisi",
      "frontend_input": "ut eiusmod minim ea in",
      "entity_type_id": "velit nostrud culpa anim",
      "is_required": true,
      "frontend_labels": [
        {
          "store_id": 11827887,
          "label": "nostrud Excepteur enim"
        },
        {
          "store_id": 95918133,
          "label": "magna cillum consequat sint"
        }
      ],
      "is_wysiwyg_enabled": false,
      "is_html_allowed_on_front": false,
      "used_for_sort_by": true,
      "is_filterable": true,
      "is_filterable_in_search": true,
      "is_used_in_grid": false,
      "is_visible_in_grid": false,
      "is_filterable_in_grid": true,
      "position": -15713483,
      "apply_to": [
        "non magna consequat anim",
        "nulla sunt in"
      ],
      "is_searchable": "dolor tempor mollit",
      "is_visible_in_advanced_search": "Ut ipsum cillum proident",
      "is_comparable": "in elit",
      "is_used_for_promo_rules": "ea",
      "is_visible_on_front": "voluptate aliqua",
      "used_in_product_listing": "sunt",
      "is_visible": false,
      "scope": "esse dolor in irure anim",
      "extension_attributes": {},
      "attribute_id": -67100497,
      "options": [
        {
          "label": "ad ut",
          "value": "al",
          "sort_order": -40754294,
          "is_default": false,
          "store_labels": [
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            },
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            }
          ]
        },
        {
          "label": "magna ipsum dolor nostru",
          "value": "Excepteur in",
          "sort_order": -84633086,
          "is_default": true,
          "store_labels": [
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            },
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            }
          ]
        }
      ],
      "is_user_defined": false,
      "default_frontend_label": "lab",
      "note": "minim",
      "backend_type": "ad voluptate officia",
      "backend_model": "sunt cupidatat aliqua in",
      "source_model": "sit Duis occaecat",
      "default_value": "cillum et ipsum Lorem",
      "is_unique": "sint esse",
      "frontend_class": "commodo pariatur",
      "validation_rules": [
        {
          "key": "veniam ipsum",
          "value": "adipisicing incididunt exercitation"
        },
        {
          "key": "nisi",
          "value": "ad nulla occaecat voluptate"
        }
      ],
      "custom_attributes": [
        {
          "attribute_code": "eu incididunt velit",
          "value": "dolor in"
        },
        {
          "attribute_code": "nulla",
          "value": "velit dolor et cupidatat consequat"
        }
      ]
    },
    {
      "attribute_code": "dolor labore",
      "frontend_input": "ullamco adipisicing in officia",
      "entity_type_id": "tempor dolore dolo",
      "is_required": true,
      "frontend_labels": [
        {
          "store_id": 31029934,
          "label": "dolor Ut elit eu"
        },
        {
          "store_id": -42456621,
          "label": "qui"
        }
      ],
      "is_wysiwyg_enabled": false,
      "is_html_allowed_on_front": true,
      "used_for_sort_by": false,
      "is_filterable": true,
      "is_filterable_in_search": true,
      "is_used_in_grid": false,
      "is_visible_in_grid": true,
      "is_filterable_in_grid": false,
      "position": 62510740,
      "apply_to": [
        "culpa Excepteur amet velit",
        "cupidatat"
      ],
      "is_searchable": "voluptate in reprehenderit Lorem et",
      "is_visible_in_advanced_search": "nostrud sint",
      "is_comparable": "ut non exercit",
      "is_used_for_promo_rules": "velit Lorem",
      "is_visible_on_front": "nulla sunt",
      "used_in_product_listing": "cillum anim",
      "is_visible": false,
      "scope": "est deserunt esse velit officia",
      "extension_attributes": {},
      "attribute_id": 31109666,
      "options": [
        {
          "label": "eu voluptate",
          "value": "non magna incididunt Ut",
          "sort_order": -4407226,
          "is_default": false,
          "store_labels": [
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            },
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            }
          ]
        },
        {
          "label": "voluptate officia cupidatat eiusmod commodo",
          "value": "eu anim Excepteur deserunt",
          "sort_order": -97052230,
          "is_default": false,
          "store_labels": [
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            },
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            }
          ]
        }
      ],
      "is_user_defined": true,
      "default_frontend_label": "non labore reprehenderit qui",
      "note": "nisi Excepteur ut in",
      "backend_type": "et",
      "backend_model": "sed",
      "source_model": "pariatur ",
      "default_value": "eu proident irure quis",
      "is_unique": "cillum officia ipsum",
      "frontend_class": "ex cillum",
      "validation_rules": [
        {
          "key": "est in officia",
          "value": "quis velit Lorem"
        },
        {
          "key": "elit ut amet",
          "value": "aute occaecat in irure eu"
        }
      ],
      "custom_attributes": [
        {
          "attribute_code": "elit enim",
          "value": "minim incididunt dolor sit elit"
        },
        {
          "attribute_code": "aute sint ea nulla aliquip",
          "value": "sit consectetur in aliqua"
        }
      ]
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "anim elit Duis in",
            "value": "mollit aliqua",
            "condition_type": "ea Duis"
          },
          {
            "field": "exercitation dolore",
            "value": "in dolore",
            "condition_type": "velit"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "officia cillum",
            "value": "qui non ut consequat culpa",
            "condition_type": "ut pariatur"
          },
          {
            "field": "veniam elit",
            "value": "irure",
            "condition_type": "reprehende"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "dolor elit in ut",
        "direction": "in ex"
      },
      {
        "field": "cillum labore",
        "direction": "pariatur ani"
      }
    ],
    "page_size": 95832027,
    "current_page": -3064819
  },
  "total_count": 9479057
}