Make Full Text Search and return found Documents
GET
/V1/search
curl \
--request 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 (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<items type="array">
<item>
<id type="integer">42</id>
<custom-attributes type="array">
<custom-attribute>
<attribute-code>string</attribute-code>
<value>string</value>
</custom-attribute>
</custom-attributes>
</item>
</items>
<aggregations>
<buckets type="array">
<bucket>
<name>string</name>
<values type="array">
<value>
<value>string</value>
<metrics type="array">
<metric>string</metric>
</metrics>
</value>
</values>
</bucket>
</buckets>
<bucket-names type="array">
<bucket-name>string</bucket-name>
</bucket-names>
</aggregations>
<search-criteria>
<request-name>string</request-name>
<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 (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>