Home > @vsf-enterprise/commercetools-api > getOrders

getOrders() function

Endpoint for fetching filtered, sorted, and paginated user orders. By default, it uses the getOrdersDefaultQuery GraphQL query

Signature:

export declare function getOrders(context: Context, params: GetOrdersParams, customQuery?: CustomQuery): Promise<import("@apollo/client/core").ApolloQueryResult<any>>;

Parameters

Parameter	Type	Description
context	Context	Automatically injected context. Refer to Context
params	GetOrdersParams	Search and pagination options
customQuery	CustomQuery	Custom queries included in the request

Returns:

Promise<import("@apollo/client/core").ApolloQueryResult<any>>

User orders data