You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
getShoppingList
Endpoint for retrieving wishlist for a current user. By default, it uses the getShoppingListDefaultQuery GraphQL query
Signature
export declare function getShoppingList(
context: SetupContext,
params?: GetShoppingListParams,
customQuery?: CustomQuery
): Promise<GetShoppingListResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Optional | GetShoppingListParams | Parameters specifying which shopping list to retrieve |
customQuery | Optional | CustomQuery | Custom queries included in the request |
Returns
- User data