Make Full Text Search and return found Documents

GET /V1/search

Make Full Text Search and return found Documents

Responses

  • 200

    200 Success.

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

      Interface Search Document

      Hide items attributes Show items attributes object
      • id integer Required
      • custom_attributes array[object]

        Interface for custom attribute value.

        Hide custom_attributes attributes Show custom_attributes attributes object
    • aggregations object Required

      Interface Aggregation to get faceted data

      Hide aggregations attributes Show aggregations attributes object
      • buckets array[object] Required

        Interface for facet Bucket

        Hide buckets attributes Show buckets attributes object
        • name string Required

          Field name

        • values array[object] Required

          Interface Aggregation Value

          Hide values attributes Show values attributes object
      • bucket_names array[string] Required

        Document field names

    • search_criteria object Required

      Interface SearchCriteriaInterface

      Hide search_criteria attributes Show search_criteria attributes object
      • request_name string Required
      • filter_groups array[object] Required

        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.

          Hide filters attributes Show filters attributes object
      • sort_orders array[object]

        Data object for sort order.

        Hide sort_orders attributes Show sort_orders attributes object
      • page_size integer

        Page size.

      • current_page integer

        Current page.

    • total_count integer Required

      Total count.
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Hide errors attributes Show errors attributes object
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/search 
curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/search
Response examples (200) 
{
  "items": [
    {
      "id": 42,
      "custom_attributes": [
        {
          "attribute_code": "string",
          "value": "string"
        }
      ]
    }
  ],
  "aggregations": {
    "buckets": [
      {
        "name": "string",
        "values": [
          {
            "value": "string",
            "metrics": [
              "string"
            ]
          }
        ]
      }
    ],
    "bucket_names": [
      "string"
    ]
  },
  "search_criteria": {
    "request_name": "string",
    "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 (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}