Coupon Object

A loyalty coupon is created when a customer redeems their loyalty points for a reward. Creating a loyalty coupon also creates a corresponding "reference" coupon with the Coupons API.

Properties
idstringRead-onlyformat GUID
Loyalty coupon ID.
accountIdstringRead-onlyformat GUID
Loyalty account ID of the customer that redeemed points for a coupon.
memberIdDeprecatedstringRead-onlydeprecated - use memberId insteadformat GUID
Member ID of the customer that redeemed points for a coupon.
memberIdstringRead-onlyformat GUID
Member ID of the customer that redeemed points for a coupon.
transactionIdstringRead-onlyformat GUID
Transaction ID for the transaction that created a coupon.
couponReferenceobjectRead-only
Reference coupon information for the corresponding coupon that is created along with the loyalty coupon.
statusstringRead-only
6 enum supported values:
UNKNOWNPENDINGACTIVEAPPLIEDFAILEDARCHIVED
Loyalty coupon status. This status relates to the corresponding coupon that is created at the same time as the loyalty coupon and is included in couponReference.
  • "ACTIVE": The reference coupon is active and available to the customer.
  • "APPLIED": The reference coupon was applied and is no longer available for use.
  • "ARCHIVED": The reference coupon was deleted.
  • "FAILED": The reference coupon was created but something went wrong when redeeming points from the loyalty account.
  • "PENDING": The refence coupon was created but the loyalty points have not been redeemed yet.
rewardNamestringRead-onlyminLength 1maxLength 50
Name of reward that was redeemed to create this coupon.
revisionintegerformat uint64
Revision number, which increments by 1 each time the loyalty coupon is updated. To prevent conflicting changes, the current `revision`` must be passed when updating the loyalty coupon.
createdDatestringRead-onlyformat date-time
Date and time the loyalty coupon was created.
updatedDatestringRead-onlyformat date-time
Date and time the loyalty coupon was last updated.
Was this helpful?
Yes
No
PostRedeem Points For Coupon
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Redeems a customer's loyalty points for a loyalty reward and creates a loyalty coupon.

Creating a loyalty coupon also creates a corresponding "reference" coupon with the Coupons API. The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon are linked and the loyalty coupon's status reflects the current state of the reference coupon.

Check which loyalty rewards a site has available with List Rewards.

Note: This endpoint requires visitor or member authentication.

Endpoint
POST
https://www.wixapis.com/loyalty-coupons/v1/coupons
Event TriggersThis method triggers the following events:
Coupon Created
Was this helpful?
Yes
No
PostRedeem Current Member Points For Coupon
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Redeems a current customer's loyalty points for a loyalty reward and creates a loyalty coupon.

Creating a loyalty coupon also creates a corresponding "reference" coupon with the Coupons API. The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon are linked and the loyalty coupon's status reflects the current state of the reference coupon.

Check which loyalty rewards a site has available with List Rewards.

Note: This endpoint requires visitor or member authentication.

Endpoint
POST
https://www.wixapis.com/loyalty-coupons/v1/coupons/redeem-my-coupon
Event TriggersThis method triggers the following events:
Coupon Created
Was this helpful?
Yes
No
GetGet Loyalty Coupon
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a loyalty coupon.

Note: This endpoint requires visitor or member authentication.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Manage Loyalty
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/loyalty-coupons/v1/coupons/{loyaltyCouponId}
Was this helpful?
Yes
No
GetGet Current Member Coupons
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the loyalty coupons for the currently logged-in member.

Note: This endpoint requires visitor or member authentication.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Manage Loyalty
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/loyalty-coupons/v1/coupons/my-coupons
Was this helpful?
Yes
No
PostQuery Loyalty Coupon
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of loyalty coupons, given the provided paging, filtering, and sorting.

Note: This endpoint requires visitor or member authentication.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Manage Loyalty
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/loyalty-coupons/v1/coupons/query
Was this helpful?
Yes
No
DeleteDelete Loyalty Coupon
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes a loyalty coupon.

The deletion of a loyalty coupon does not impact the functionality of the corresponding coupon itself.

Note: This endpoint requires visitor or member authentication.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Loyalty
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/loyalty-coupons/v1/coupons/{id}
Event TriggersThis method triggers the following events:
Coupon Deleted
Was this helpful?
Yes
No
Coupon Created
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a loyalty coupon is created.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Manage Loyalty
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.loyalty.v1.coupon.
slugstring
Event name. Expected created.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
createdEventobject
Event information.
Was this helpful?
Yes
No
Coupon Deleted
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a loyalty coupon is deleted.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Manage Loyalty
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.loyalty.v1.coupon.
slugstring
Event name. Expected deleted.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
deletedEventstruct
Event information.
Was this helpful?
Yes
No