Query parameters

• searchCriteria[filterGroups][0][filters][0][field] string

  Field

• searchCriteria[filterGroups][0][filters][0][value] string

  Value

• searchCriteria[filterGroups][0][filters][0][conditionType] string

  Condition type

• searchCriteria[sortOrders][0][field] string

  Sorting field.

• searchCriteria[sortOrders][0][direction] string

  Sorting direction.

• searchCriteria[pageSize] integer

  Page size.

• searchCriteria[currentPage] integer

  Current page.

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  • items array[object] Required
    Hide items attributes Show items attributes object

    • 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_filterable_in_search boolean

      It is used in search results 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_visible_in_advanced_search string

      The attribute can be used in Advanced 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

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Catalog\Api\Data\EavAttributeInterface

    • 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]

      Created from:

      Created from:

      Hide options attributes Show options attributes object

      • label string Required

        Option label

      • value string Required

        Option value

      • sort_order integer

        Option order

      • is_default boolean

        Default

      • store_labels array[object]

        Interface AttributeOptionLabelInterface

        Interface AttributeOptionLabelInterface

        Hide store_labels attributes Show store_labels attributes object

        • 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

      Interface AttributeFrontendLabelInterface

      Interface AttributeFrontendLabelInterface

      Hide frontend_labels attributes Show frontend_labels attributes object

      • 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]

      Interface AttributeValidationRuleInterface

      Interface AttributeValidationRuleInterface

      Hide validation_rules attributes Show validation_rules attributes object

      • key string Required

        Object key

      • value string Required

        Object value

    • custom_attributes array[object]

      Interface for custom attribute value.

      Interface for custom attribute value.

      Hide custom_attributes attributes Show custom_attributes attributes object

      • attribute_code string Required

        Attribute code

      • value string Required

        Attribute value

  • search_criteria object Required

    Search criteria interface.

    Hide search_criteria attributes Show search_criteria attributes object

    • filter_groups array[object] Required

      Groups two or more filters together using a logical OR

      Groups two or more filters together using a logical OR

      Hide filter_groups attribute Show filter_groups attribute object

      • filters array[object]

        Filter which can be used by any methods from service layer.

        Filter which can be used by any methods from service layer.

        Hide filters attributes Show filters attributes object

        • field string Required

          Field

        • value string Required

          Value

        • condition_type string

          Condition type

    • sort_orders array[object]

      Data object for sort order.

      Data object for sort order.

      Hide sort_orders attributes Show sort_orders attributes object

      • field string Required

        Sorting field.

      • direction string Required

        Sorting direction.

    • page_size integer

      Page size.

    • current_page integer

      Current page.

  • total_count integer Required

    Total count.

• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • 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 item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • 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 item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace