Search as you type

Autocompletions are useful by proposing potential completions as the user types his fulltext query into the search box. Also referred to as "Search as you type."

Query Parameters

query string
Keywords to use for autocompletion.
Example: Notebo
max int32
Possible values: >= 1 and <= 100
Default value: 20
Maximum number of completions to return.
Example: 20

Responses

• 200
• 400
• 401
• 429
• default

---

Returns information for autocompletion.

application/json

Schema

Example (from schema)

---

Schema

property name* Autocompletions
Autocompletions for a specific keyword, e.g. the product names, vendors, manufacturers etc. that match the particular keyword.
Array [
text string required
Completed text.
count object
Information about an exact or approximate count.
count integer
Exact or approximate count.
relation string
Possible values: [eq, gte]
Describes whether the count is an exact or an approximate value.
]

[
  {
    "name": [
      {
        "text": "HP Notebook 250 G1"
      },
      {
        "text": "Acer 35,6 cm (14\") Notebooktasche"
      }
    ]
  },
  {
    "manufacturers": [
      {
        "text": "HP",
        "count": {
          "value": 124,
          "relation": "eq"
        }
      },
      {
        "text": "Dell",
        "count": {
          "value": 95,
          "relation": "eq"
        }
      }
    ]
  },
  {
    "categories": [
      {
        "text": "Mobile Computing",
        "count": {
          "value": 332,
          "relation": "eq"
        }
      },
      {
        "text": "Notebooks",
        "count": {
          "value": 271,
          "relation": "eq"
        }
      }
    ]
  }
]

Bad request

application/json

Schema

Example (from schema)

---

Schema

code int32 required

Code to indentify the type of error, typically the HTTP status code.

message string required

Summary of the error in one sentence.

details string[]

More details, e.g. validation errors on individual fields.

{
  "code": 400,
  "message": "Bad request parameters. Please check the parameters for this API request.",
  "details": [
    "Name is missing.",
    "Price is negative."
  ]
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

code int32 required

Code to indentify the type of error, typically the HTTP status code.

message string required

Summary of the error in one sentence.

details string[]

More details, e.g. validation errors on individual fields.

{
  "code": 400,
  "message": "Bad request parameters. Please check the parameters for this API request.",
  "details": [
    "Name is missing.",
    "Price is negative."
  ]
}

Too many requests

application/json

Schema

Example (from schema)

---

Schema

code int32 required

Code to indentify the type of error, typically the HTTP status code.

message string required

Summary of the error in one sentence.

details string[]

More details, e.g. validation errors on individual fields.

{
  "code": 400,
  "message": "Bad request parameters. Please check the parameters for this API request.",
  "details": [
    "Name is missing.",
    "Price is negative."
  ]
}

General error

application/json

Schema

Example (from schema)

---

Schema

code int32 required

Code to indentify the type of error, typically the HTTP status code.

message string required

Summary of the error in one sentence.

details string[]

More details, e.g. validation errors on individual fields.

{
  "code": 400,
  "message": "Bad request parameters. Please check the parameters for this API request.",
  "details": [
    "Name is missing.",
    "Price is negative."
  ]
}

Loading...