Home > @poq/sdk-sfcc > OrderSearchResult
Document representing an order search result.
Signature:
export declare class OrderSearchResult extends BaseModel<OrderSearchResult>
Extends: BaseModel<OrderSearchResult
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the OrderSearchResult class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| count? | number | (Optional) The number of returned documents. | |
| data? | Array<object> | (Optional) | |
| dbStartRecord? | number | (Optional) The zero-based index of the record that we want to start with, used to optimize special handling | |
| expand? | Array<string> | (Optional) List of expansions to be applied to each search results. Expands are optional | |
| hits? | Array<OrderSearchHit> | (Optional) The sorted array of search hits. This array can be empty. | |
| next? | ResultPage | (Optional) | |
| previous? | ResultPage | (Optional) | |
| query? | object | (Optional) Document representing a query. A query contains a set of objects that define criteria used to select records. A query can contain one of the following: | |
| select? | string | (Optional) The fields that you want to select. | |
| sorts? | Array<Sort> | (Optional) The list of sort clauses configured for the search request. Sort clauses are optional. | |
| start? | number | (Optional) The zero-based index of the first search hit to include in the result. | |
| total? | number | (Optional) The total number of documents. |