> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Method name: queryLoyaltyCoupons() # Method package: wixLoyaltyV2 # Method menu location: wixLoyaltyV2 --> coupons --> queryLoyaltyCoupons # Method Link: https://dev.wix.com/docs/velo/apis/wix-loyalty-v2/coupons/query-loyalty-coupons.md # Method Description: Retrieves a list of loyalty coupons, with the specified paging, filtering, and sorting. |PROPERTY |SUPPORTED FILTERS & SORTING |:---:|:---:| |`accountId`|[`eq()`](/loyalty-coupons-query-builder/eq),[`ne()`](/loyalty-coupons-query-builder/ne),[`exists()`](/loyalty-coupons-query-builder/exists),[`in()`](/loyalty-coupons-query-builder/in),[`hasSome()`](/loyalty-coupons-query-builder/has-some),[`startsWith()`](/loyalty-coupons-query-builder/starts-with),[`gt()`](/loyalty-coupons-query-builder/gt),[`lt()`](/loyalty-coupons-query-builder/lt),[`le()`](/loyalty-coupons-query-builder/le),[`ge()`](/loyalty-coupons-query-builder/ge),[`ascending()`](/loyalty-coupons-query-builder/ascending),[`descending()`](/loyalty-coupons-query-builder/descending)| |`memberId`|[`eq()`](/loyalty-coupons-query-builder/eq),[`ne()`](/loyalty-coupons-query-builder/ne),[`exists()`](/loyalty-coupons-query-builder/exists),[`in()`](/loyalty-coupons-query-builder/in),[`hasSome()`](/loyalty-coupons-query-builder/has-some),[`startsWith()`](/loyalty-coupons-query-builder/starts-with),[`gt()`](/loyalty-coupons-query-builder/gt),[`lt()`](/loyalty-coupons-query-builder/lt),[`le()`](/loyalty-coupons-query-builder/le),[`ge()`](/loyalty-coupons-query-builder/ge),[`ascending()`](/loyalty-coupons-query-builder/ascending),[`descending()`](/loyalty-coupons-query-builder/descending)| |`transactionId`|[`eq()`](/loyalty-coupons-query-builder/eq),[`ne()`](/loyalty-coupons-query-builder/ne),[`exists()`](/loyalty-coupons-query-builder/exists),[`in()`](/loyalty-coupons-query-builder/in),[`hasSome()`](/loyalty-coupons-query-builder/has-some),[`startsWith()`](/loyalty-coupons-query-builder/starts-with),[`gt()`](/loyalty-coupons-query-builder/gt),[`lt()`](/loyalty-coupons-query-builder/lt),[`le()`](/loyalty-coupons-query-builder/le),[`ge()`](/loyalty-coupons-query-builder/ge),[`ascending()`](/loyalty-coupons-query-builder/ascending),[`descending()`](/loyalty-coupons-query-builder/descending)| |`couponReference`|[`eq()`](/loyalty-coupons-query-builder/eq),[`ne()`](/loyalty-coupons-query-builder/ne),[`exists()`](/loyalty-coupons-query-builder/exists),[`in()`](/loyalty-coupons-query-builder/in),[`hasSome()`](/loyalty-coupons-query-builder/has-some),[`ascending()`](/loyalty-coupons-query-builder/ascending),[`descending()`](/loyalty-coupons-query-builder/descending)| |`status`|[`eq()`](/loyalty-coupons-query-builder/eq),[`ne()`](/loyalty-coupons-query-builder/ne),[`exists()`](/loyalty-coupons-query-builder/exists),[`in()`](/loyalty-coupons-query-builder/in),[`hasSome()`](/loyalty-coupons-query-builder/has-some),[`ascending()`](/loyalty-coupons-query-builder/ascending),[`descending()`](/loyalty-coupons-query-builder/descending)| |`rewardName`|[`eq()`](/loyalty-coupons-query-builder/eq),[`ne()`](/loyalty-coupons-query-builder/ne),[`exists()`](/loyalty-coupons-query-builder/exists),[`in()`](/loyalty-coupons-query-builder/in),[`hasSome()`](/loyalty-coupons-query-builder/has-some),[`startsWith()`](/loyalty-coupons-query-builder/starts-with),[`gt()`](/loyalty-coupons-query-builder/gt),[`lt()`](/loyalty-coupons-query-builder/lt),[`le()`](/loyalty-coupons-query-builder/le),[`ge()`](/loyalty-coupons-query-builder/ge),[`ascending()`](/loyalty-coupons-query-builder/ascending),[`descending()`](/loyalty-coupons-query-builder/descending)| |`_createdDate`|[`eq()`](/loyalty-coupons-query-builder/eq),[`ne()`](/loyalty-coupons-query-builder/ne),[`exists()`](/loyalty-coupons-query-builder/exists),[`in()`](/loyalty-coupons-query-builder/in),[`hasSome()`](/loyalty-coupons-query-builder/has-some),[`lt()`](/loyalty-coupons-query-builder/lt),[`le()`](/loyalty-coupons-query-builder/le),[`gt()`](/loyalty-coupons-query-builder/gt),[`ge()`](/loyalty-coupons-query-builder/ge),[`ascending()`](/loyalty-coupons-query-builder/ascending),[`descending()`](/loyalty-coupons-query-builder/descending)| |`_updatedDate`|[`eq()`](/loyalty-coupons-query-builder/eq),[`ne()`](/loyalty-coupons-query-builder/ne),[`exists()`](/loyalty-coupons-query-builder/exists),[`in()`](/loyalty-coupons-query-builder/in),[`hasSome()`](/loyalty-coupons-query-builder/has-some),[`lt()`](/loyalty-coupons-query-builder/lt),[`le()`](/loyalty-coupons-query-builder/le),[`gt()`](/loyalty-coupons-query-builder/gt),[`ge()`](/loyalty-coupons-query-builder/ge),[`ascending()`](/loyalty-coupons-query-builder/ascending),[`descending()`](/loyalty-coupons-query-builder/descending)| # Method Code Examples: *** Note: do not assume any prop names or enum values other than the ones in the example. ## Query loyalty coupons ```javascript import { coupons } from "wix-loyalty.v2"; import { webMethod, Permissions } from "wix-web-module"; import { elevate } from "wix-auth"; /* Sample query value: * * { * "query": { * "fieldsets": [], * "fields": [], * "sort": [], * "filter": { * "couponReference.name": { * "$eq": "10% off all events" * }, * "rewardName": { * "$startsWith": "10%" * } * } * } * } */ const elevatedQueryLoyaltyCoupons = elevate(coupons.queryLoyaltyCoupons); export const queryLoyaltyCoupons = webMethod( Permissions.Anyone, async (query) => { try { const result = await elevatedQueryLoyaltyCoupons(query); return result; } catch (error) { console.error(error); // Handle the error } }, ); /* Promise resolves to: * * { * "loyaltyCoupons": [ * { * "_id": "56826083-0c4a-4e62-88e3-c6978482bde9", * "accountId": "d0dc5ba3-4a10-4cfc-b304-c976d8ac7303", * "memberIdDeprecated": "7d368843-6f0c-4037-8d0e-b7e36a8a0c32", * "transactionId": "33490644-0f84-44e4-aa55-738b203fa4bd", * "couponReference": { * "couponId": "a6df2aeb-50fc-4b15-b18d-765be38a6513", * "code": "6QLGQ9RNNR9R", * "name": "10% off all events", * "specification": { * "name": null, * "type": "PERCENT_OFF_RATE", * "limitedToOneItem": false, * "appliesToSubscriptions": null, * "discountedCycleCount": null, * "percentOffRate": 10, * "scope": {"name": "ticket", "entityId": null, "namespace": "events"} * }, * "deleted": null * }, * "status": "ACTIVE", * "rewardName": "10% off all events", * "revision": "2", * "_createdDate": "2024-06-12T08:29:56.594Z", * "_updatedDate": "2024-06-12T08:29:56.851Z", * "memberId": "7d368843-6f0c-4037-8d0e-b7e36a8a0c32" * }, * { * "_id": "6fb2cdc0-863f-4b4b-b76d-a73608654aee", * "accountId": "d0dc5ba3-4a10-4cfc-b304-c976d8ac7303", * "memberIdDeprecated": "7d368843-6f0c-4037-8d0e-b7e36a8a0c32", * "transactionId": "0b24afeb-2964-4bb2-a5ab-b32e04128c20", * "couponReference": { * "couponId": "27d5d44d-eb61-4533-8f72-01177097e470", * "code": "6QLGLVTGVH8A", * "name": "10% off all events", * "specification": { * "name": null, * "type": "PERCENT_OFF_RATE", * "limitedToOneItem": false, * "appliesToSubscriptions": null, * "discountedCycleCount": null, * "percentOffRate": 10, * "scope": {"name": "ticket", "entityId": null, "namespace": "events"} * }, * "deleted": null * }, * "status": "ACTIVE", * "rewardName": "10% off all events", * "revision": "2", * "_createdDate": "2024-06-12T08:14:16.884Z", * "_updatedDate": "2024-06-12T08:14:17.403Z", * "memberId": "7d368843-6f0c-4037-8d0e-b7e36a8a0c32" * } * ] * } */ ``` ## Query loyalty coupons (dashboard page code) ```javascript import { coupons } from "wix-loyalty.v2"; /* Sample query value: * * { * "query": { * "fieldsets": [], * "fields": [], * "sort": [], * "filter": { * "couponReference.name": { * "$eq": "10% off all events" * }, * "rewardName": { * "$startsWith": "10%" * } * } * } * } */ async function queryLoyaltyCoupons(query) { try { const result = await coupons.queryLoyaltyCoupons(query); return result; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to: * * { * "loyaltyCoupons": [ * { * "_id": "56826083-0c4a-4e62-88e3-c6978482bde9", * "accountId": "d0dc5ba3-4a10-4cfc-b304-c976d8ac7303", * "memberIdDeprecated": "7d368843-6f0c-4037-8d0e-b7e36a8a0c32", * "transactionId": "33490644-0f84-44e4-aa55-738b203fa4bd", * "couponReference": { * "couponId": "a6df2aeb-50fc-4b15-b18d-765be38a6513", * "code": "6QLGQ9RNNR9R", * "name": "10% off all events", * "specification": { * "name": null, * "type": "PERCENT_OFF_RATE", * "limitedToOneItem": false, * "appliesToSubscriptions": null, * "discountedCycleCount": null, * "percentOffRate": 10, * "scope": {"name": "ticket", "entityId": null, "namespace": "events"} * }, * "deleted": null * }, * "status": "ACTIVE", * "rewardName": "10% off all events", * "revision": "2", * "_createdDate": "2024-06-12T08:29:56.594Z", * "_updatedDate": "2024-06-12T08:29:56.851Z", * "memberId": "7d368843-6f0c-4037-8d0e-b7e36a8a0c32" * }, * { * "_id": "6fb2cdc0-863f-4b4b-b76d-a73608654aee", * "accountId": "d0dc5ba3-4a10-4cfc-b304-c976d8ac7303", * "memberIdDeprecated": "7d368843-6f0c-4037-8d0e-b7e36a8a0c32", * "transactionId": "0b24afeb-2964-4bb2-a5ab-b32e04128c20", * "couponReference": { * "couponId": "27d5d44d-eb61-4533-8f72-01177097e470", * "code": "6QLGLVTGVH8A", * "name": "10% off all events", * "specification": { * "name": null, * "type": "PERCENT_OFF_RATE", * "limitedToOneItem": false, * "appliesToSubscriptions": null, * "discountedCycleCount": null, * "percentOffRate": 10, * "scope": {"name": "ticket", "entityId": null, "namespace": "events"} * }, * "deleted": null * }, * "status": "ACTIVE", * "rewardName": "10% off all events", * "revision": "2", * "_createdDate": "2024-06-12T08:14:16.884Z", * "_updatedDate": "2024-06-12T08:14:17.403Z", * "memberId": "7d368843-6f0c-4037-8d0e-b7e36a8a0c32" * } * ] * } */ ``` ---