Interface CustomerSearchRequest

interface CustomerSearchRequest {
    limit?: number;
    offset?: number;
    query?: _SearchQuery;
    sort?: SearchSorting[];
}

Index

Properties

limit? offset? query? sort?

Properties

`Optional` `Readonly`limit

limit?: number

The maximum number of search results to be returned.

`Optional` `Readonly`offset

offset?: number

The number of search results to be skipped in the response for pagination.

`Optional` `Readonly`query

query?: _SearchQuery

The Customer search query.

`Optional` `Readonly`sort

sort?: SearchSorting[]

Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.