Get v1 international autocomplete context term

GET /V1/international/autocomplete/{context}/{term}

Path parameters

  • context string Required
  • term string Required

Responses

  • 200 Success.

    Hide response attribute Show response attribute object
    • matches array[object] Required
      Hide matches attributes Show matches attributes object
      • value string Required
      • label string Required
      • description string Required
      • precision string Required
      • context string Required
      • highlights array[object] Required
        Hide highlights attribute Show highlights attribute object
        • offsets array[integer] Required
    Hide response attribute Show response attribute object
    • matches array[object] Required
      Hide matches attributes Show matches attributes object
      • value string Required
      • label string Required
      • description string Required
      • precision string Required
      • context string Required
      • highlights array[object] Required
        Hide highlights attribute Show highlights attribute object
        • offsets array[integer] Required
  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

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

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

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

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/international/autocomplete/{context}/{term}
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/international/autocomplete/{context}/{term}'
Response examples (200)
{
  "matches": [
    {
      "value": "string",
      "label": "string",
      "description": "string",
      "precision": "string",
      "context": "string",
      "highlights": [
        {
          "offsets": [
            42
          ]
        }
      ]
    }
  ]
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <matches type="array">
    <match>
      <value>string</value>
      <label>string</label>
      <description>string</description>
      <precision>string</precision>
      <context>string</context>
      <highlights type="array">
        <highlight>
          <offsets type="array">
            <offset type="integer">42</offset>
          </offsets>
        </highlight>
      </highlights>
    </match>
  </matches>
</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>