AutoCompleteRequest

Type, Introduced in version 2.46

Used to execute auto-complete searches.

Properties

Name Type Summary Introduced in
Filter String The string to use when filtering the auto-complete results.
WarehouseIds Int64[] The business key identifiers of the warehouses to include in the auto-complete search or null to only search the session's current warehouse.
Offset Int32? The amount of records to skip in the auto-complete search results.

  • 0 by default
SortIndex Int32? The index of the column in the auto-complete search results to sort by.

  • 0 by default
SortOrder Int32? The order to apply to the auto-complete search results.

  • Ascending: 1
  • Descending: 2

  • Ascending by default
Context String General context information to apply to the auto-complete search.
PageSize Int32? The amount of records to get.

  • 25 by default

Example

{
  "Filter": null,
  "WarehouseIds": null,
  "Offset": null,
  "SortIndex": null,
  "SortOrder": null,
  "Context": null,
  "PageSize": null
}