Referral Reward Object


Properties
idstringRead-onlyformat GUID

Referral reward ID.


revisionintegerformat int64

Revision number, which increments by 1 each time the referral reward is updated. To prevent conflicting changes, the current revision must be passed when updating the referral reward.


createdDatestringRead-onlyformat date-time

Date and time the referral reward was created.


updatedDatestringRead-onlyformat date-time

Date and time the referral reward was last updated.


rewardTypestring

Type of reward given.


ONE OF:

rewardedReferringCustomerIdstringRead-onlyformat GUID

ID of the referring customer who received the reward.


rewardedReferredFriendIdstringRead-onlyformat GUID

ID of the referred friend who received the reward.


ONE OF:

couponCoupon

Details of a coupon reward. Present when reward_type is COUPON.


loyaltyPointsLoyaltyPoints

Details of a loyalty points reward. Present when reward_type is LOYALTY_POINTS.

ReferralReward
JSON
{ "referralReward": { "id": "c8c732cf-2ca2-4025-9b1c-3be02f099cdb", "revision": "2", "createdDate": "2024-07-08T11:22:00.728Z", "updatedDate": "2024-07-08T11:27:57.197Z", "rewardType": "COUPON", "rewardedReferringCustomerId": "4fb41de4-da9c-4818-b54f-82c955ecc866", "coupon": { "id": "43fa238a-b464-4a5b-9079-5682a5a1eab7", "code": "6QW1ASGTZ0Q4", "status": "APPLIED", "couponSpecification": { "name": "Your reward", "discountType": "FIXED_AMOUNT", "limitedToOneItem": true, "appliesToSubscriptions": null, "discountedCycleCount": null, "fixedAmountOptions": { "amount": 10 }, "scope": { "namespace": "stores", "group": null } } } } }
Did this help?