You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
autoComplete
Retrieves autocomplete information on customers based on the customer query
This method sends a POST request to the autoComplete endpoint of the Alokai Middleware. In turn, it exchanges data with the autoComplete endpoint exposed by the SAP OCC API Customer Controller.
Signature
export declare function autoComplete<Res extends CustomerSuggestion[] = CustomerSuggestion[]>(
props: AutoCompleteProps,
options?: MethodOptions
): Promise<Res>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
props | Required | AutoCompleteProps | Parameter object which can be used with this method. Refer to its type definition to learn about possible properties. |
options | Optional | MethodOptions | Options that can be passed to additionally configure the request or customize the logic in a plugin. |
Returns
Returns array of customer suggestions
Referenced Types
CustomerSuggestionAutoCompleteProps- MethodOptions
Examples
Requesting autocomplete information on customers based on the customer query
import { sdk } from '~/sdk';
const result = await sdk.commerce.autoComplete({ customerQuery: 'john'});