You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
getOrders
Endpoint for fetching filtered, sorted, and paginated user orders. By default, it uses the getOrdersDefaultQuery GraphQL query
Signature
export declare function getOrders(
context: SetupContext,
params: GetOrdersParams,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<any>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Required | GetOrdersParams | Search and pagination options |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions |
Returns
User orders data