> 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 # GetReward # Package: rewards # Namespace: LoyaltyRewards # Method link: https://dev.wix.com/docs/api-reference/crm/loyalty-program/rewards/rewards/get-reward.md ## Permission Scopes: Read Loyalty: SCOPE.DC-LOYALTY.READ-LOYALTY ## Introduction Retrieves a reward. --- ## REST API ### Schema ``` Method: getReward Description: Retrieves a reward. URL: https://www.wixapis.com/v1/rewards/{id} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: id Method parameters: param name: id | type: none | required: true Return type: GetRewardResponse - name: reward | type: Reward | description: Retrieved reward. - ONE-OF: - name: discountAmount | type: DiscountAmount | description: Discount details. - name: configsByTier | type: array | description: Discount details for each tier. - name: amount | type: string | description: Discount amount. Must be a positive value. - name: tierId | type: string | description: Tier GUID, or empty if config applies to the base tier. - name: costInPoints | type: integer | description: Amount of points required to redeem the reward. - name: couponReward | type: CouponReward | description: Coupon details. - ONE-OF: - name: fixedAmount | type: FixedAmountDiscount | description: Discount as a fixed amount. - name: configsByTier | type: array | description: Discount details for each tier. - name: tierId | type: string | description: Tier GUID, or empty if config applies to the base tier. - name: costInPoints | type: integer | description: Amount of points required to redeem the reward. - name: amount | type: number | description: Discount amount. - name: percentage | type: PercentageDiscount | description: Discount as a percentage. - name: configsByTier | type: array | description: Discount details for each tier. - name: tierId | type: string | description: Tier GUID, or empty if config applies to the base tier. - name: costInPoints | type: integer | description: Amount of points required to redeem the reward. - name: percentage | type: number | description: Percentage discount. - name: freeShipping | type: FreeShippingDiscount | description: Free shipping. - name: configsByTier | type: array | description: Discount details for each tier. - name: tierId | type: string | description: Tier GUID, or empty if config applies to the base tier. - name: costInPoints | type: integer | description: Amount of points required to redeem the reward. - ONE-OF: - name: minimumSubtotal | type: number | description: Limit the coupon to carts with a subtotal greater than this number. - name: scope | type: CouponScope | description: Specifies the type of line items this coupon applies to. For more information, see [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values.md). - name: namespace | type: string | description: Scope namespace. See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values.md) for valid namespaces. - name: group | type: Group | description: Coupon scope's applied group. See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values.md) for valid groups. - name: name | type: string | description: Name of coupon scope's group. See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values.md) for valid groups. - name: entityId | type: string | description: Entity GUID, if the coupon scope is limited to just 1 item. - name: limitedToOneItem | type: boolean | description: Whether the coupon is limited to 1 item. - name: appliesToSubscriptions | type: boolean | description: Whether the coupon also applies to subscriptions. - name: discountedCycleCount | type: integer | description: Specifies the amount of discounted cycles for a subscription item. Can only be set when `appliesToSubscriptions` is `true` and `scope.namespace` is `pricingPlans`. If `discountedCycleCount` is empty, the coupon applies to all available cycles. - name: id | type: string | description: Reward GUID. - name: name | type: string | description: Reward name. - name: active | type: boolean | description: Whether the reward is active. Default: `FALSE` - name: type | type: RewardType | description: Reward type. - enum: - UNDEFINED: Undefined reward type. - DISCOUNT_AMOUNT: Discount reward. Special flexible reward type used in checkout. - COUPON_REWARD: Coupon reward. [Learn more about coupons](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards). - name: revision | type: string | description: Revision number, which increments by 1 each time the loyalty reward is updated. To prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward. - name: createdDate | type: string | description: Date and time the reward was created. - name: updatedDate | type: string | description: Date and time the reward was last updated. ``` ### Examples ### Get reward ```curl curl -X GET \ 'https://www.wixapis.com/loyalty-rewards/v1/rewards/46d7bbce-6bb4-4174-ae5a-7f44c19f95ce' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.rewards.LoyaltyRewards.getReward(_id) Description: Retrieves a reward. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: _id Method parameters: param name: _id | type: string | description: GUID of the reward to retrieve. | required: true Return type: PROMISE - ONE-OF: - name: discountAmount | type: DiscountAmount | description: Discount details. - name: configsByTier | type: array | description: Discount details for each tier. - name: amount | type: string | description: Discount amount. Must be a positive value. - name: tierId | type: string | description: Tier GUID, or empty if config applies to the base tier. - name: costInPoints | type: integer | description: Amount of points required to redeem the reward. - name: couponReward | type: CouponReward | description: Coupon details. - ONE-OF: - name: fixedAmount | type: FixedAmountDiscount | description: Discount as a fixed amount. - name: configsByTier | type: array | description: Discount details for each tier. - name: tierId | type: string | description: Tier GUID, or empty if config applies to the base tier. - name: costInPoints | type: integer | description: Amount of points required to redeem the reward. - name: amount | type: number | description: Discount amount. - name: percentage | type: PercentageDiscount | description: Discount as a percentage. - name: configsByTier | type: array | description: Discount details for each tier. - name: tierId | type: string | description: Tier GUID, or empty if config applies to the base tier. - name: costInPoints | type: integer | description: Amount of points required to redeem the reward. - name: percentage | type: number | description: Percentage discount. - name: freeShipping | type: FreeShippingDiscount | description: Free shipping. - name: configsByTier | type: array | description: Discount details for each tier. - name: tierId | type: string | description: Tier GUID, or empty if config applies to the base tier. - name: costInPoints | type: integer | description: Amount of points required to redeem the reward. - ONE-OF: - name: minimumSubtotal | type: number | description: Limit the coupon to carts with a subtotal greater than this number. - name: scope | type: CouponScope | description: Specifies the type of line items this coupon applies to. For more information, see [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values.md). - name: namespace | type: string | description: Scope namespace. See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values.md) for valid namespaces. - name: group | type: Group | description: Coupon scope's applied group. See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values.md) for valid groups. - name: name | type: string | description: Name of coupon scope's group. See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values.md) for valid groups. - name: entityId | type: string | description: Entity GUID, if the coupon scope is limited to just 1 item. - name: limitedToOneItem | type: boolean | description: Whether the coupon is limited to 1 item. - name: appliesToSubscriptions | type: boolean | description: Whether the coupon also applies to subscriptions. - name: discountedCycleCount | type: integer | description: Specifies the amount of discounted cycles for a subscription item. Can only be set when `appliesToSubscriptions` is `true` and `scope.namespace` is `pricingPlans`. If `discountedCycleCount` is empty, the coupon applies to all available cycles. - name: _id | type: string | description: Reward GUID. - name: name | type: string | description: Reward name. - name: active | type: boolean | description: Whether the reward is active. Default: `FALSE` - name: type | type: RewardType | description: Reward type. - enum: - UNDEFINED: Undefined reward type. - DISCOUNT_AMOUNT: Discount reward. Special flexible reward type used in checkout. - COUPON_REWARD: Coupon reward. [Learn more about coupons](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards). - name: revision | type: string | description: Revision number, which increments by 1 each time the loyalty reward is updated. To prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward. - name: _createdDate | type: Date | description: Date and time the reward was created. - name: _updatedDate | type: Date | description: Date and time the reward was last updated. ``` ### Examples ### Get reward ```javascript import { rewards } from "@wix/loyalty"; async function getReward() { const response = await rewards.getReward( "46d7bbce-6bb4-4174-ae5a-7f44c19f95ce" ); } /* Promise resolves to: * { * "id": "46d7bbce-6bb4-4174-ae5a-7f44c19f95ce", * "name": "Free shipping", * "requiredPoints": 20, * "active": true, * "type": "COUPON_REWARD", * "couponReward": { "freeShipping": { "configsByTier": [...] } }, * "revision": "1" * } */ ``` ### getReward (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { rewards } from '@wix/loyalty'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { rewards }, // Include the auth strategy and host as relevant }); async function getReward(_id) { const response = await myWixClient.rewards.getReward(_id); }; ``` ---