Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

event

CouponAppliedEvent


  export function wixMarketing_onCouponApplied(event) {
    const eventId = event.metadata.id
    const entityId = event.data.coupon._id;
  }

  

onCouponApplied example

onCouponApplied

void

CouponCreated


  export function wixMarketing_onCouponCreated(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onCouponCreated example

onCouponCreated

CouponDeleted


  export function wixMarketing_onCouponDeleted(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onCouponDeleted example

onCouponDeleted

CouponUpdated

Triggered when a coupon specification is updated.


  export function wixMarketing_onCouponUpdated(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onCouponUpdated example

onCouponUpdated

velo-events_wix-marketing.v2

BackendEventMetadata

ID of the entity associated with the event.

entityId

string

eventTime

Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.

triggeredByAnonymizeRequest

boolean

BuyXGetY

Number of purchased items required to receive free items.

number

Number of items received for free if required number of items were purchased.

Coupon

ID of the app that created the coupon. Empty if created by the site owner.

appId

Time the coupon was created (UNIX Epoch time in milliseconds).

dateCreated

displayData

DisplayData

expired

How many times this coupon has been used.

numberOfUsages

specification

Specification

CouponApplied

coupon

ID of Wix app that applied the coupon. Supported values:
+ Wix Stores - `1380b703-ce81-ff05-f115-39571d94dfcd`
+ Wix Bookings - `13d21c63-b5ec-5912-8397-c3a5ddb27a97`
+ Wix Events - `140603ad-af8d-84a5-2c80-a0f60cb47351`

wixAppId

ID of the entity that the coupon was applied to (orderId, bookingId, etc.).

wixAppOrderId

data

metadata

entity

formattedPrice

mediaItem

MediaItem

name

Group

Item ID (when the coupon scope is limited to just one item).

Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).

height

width

Scope

Coupon scope's applied group (e.g., event or ticket in Wix Events)

group

Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans)

namespace

Receive free products when making a purchase.

For example, purchase `x` number of products and receive `y` number of products for free.

buyXGetY

fixedPriceAmount

Free shipping.

If `true`, the coupon applies to all items in all `namespaces`.

freeShipping

moneyOffAmount

percentOffRate

Limit the coupon to carts with a subtotal above this number.

minimumSubtotal

Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).

scope

Whether the coupon is currently [active](https://support.wix.com/en/article/wix-stores-activating-and-deactivating-coupons).

Default: `true`

active

Whether the coupon applies to subscription products.

appliesToSubscriptions

Coupon code. Must be unique for all coupons on your site.

Max: 20 characters

code

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.

Min: `1`
Max: `999`

discountedCycleCount

expirationTime

Maximum number of times the coupon can be used per customer.

limitPerCustomer

Whether the coupon is limited to one item.

If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
Coupons with a `bookings` `scope.namespace` are always limited to one item.

limitedToOneItem

startTime

type

Maximum number of times the coupon can be used.

>**Note:** Multiple purchases by the same customer or purchases by different customers are both counted toward `usageLimit`.

onCouponApplied( )