onCouponUpdated( )

An event that is triggered when a coupon is updated.

Description

The onCouponUpdated() event handler runs when a coupon is updated.

Note: Backend events don't work when previewing your site.

Syntax

function onCouponUpdated(event: CouponEvent): void

onCouponUpdated Parameters

NAME

TYPE

DESCRIPTION

event

CouponEvent

Information about an updated coupon.

Returns

This function does not return anything.

Return Type:

void

An event when a coupon is updated to only apply to a specific product

Copy Code

1// Place this code in the events.js file
2// of your site's Backend section.
3
4export function wixMarketing_onCouponUpdated(event) {
5  const updatedCouponId = event.entity._id;
6  const updatedCouponCode = event.entity.code;
7  const productIdCouponAppliesTo = event.entity.scope.group.entityId;
8}
9
10/* Full event object
11 *
12 *  {
13 *    "metadata": {
14 *      "id": "77aff6e5-974c-49f0-adc1-255363cd5c55",
15 *      "entityId": "03a35393-7835-44b0-af53-6019a484b48b",
16 *      "eventTime": "2021-01-17T11:49:44.606828Z",
17 *      "triggeredByAnonymizeRequest": false
18 *    },
19 *    "entity": {
20 *      "_id": "03a35393-7835-44b0-af53-6019a484b48b",
21 *      "name": "Summer Sale 10% off",
22 *      "code": "SummerSale",
23 *      "startTime": "Wed Jun 30 2021 21:00:00 GMT+0000 (Coordinated Universal Time)",
24 *      "expirationTime": "Tue Aug 31 2021 20:59:59 GMT+0000 (Coordinated Universal Time)",
25 *      "limitPerCustomer": 1,
26 *      "active": true,
27 *      "scope": {
28 *        "namespace": "stores",
29 *        "group": {
30 *          "name": "product",
31 *          "entityId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a"
32 *        }
33 *      },
34 *      "_dateCreated": "Sun Jan 17 2021 11:40:56 GMT+0000 (Coordinated Universal Time)",
35 *      "expired": false,
36 *      "displayData": {
37 *        "name": "Indonesian Blend",
38 *        "formattedPrice": "$35.00",
39 *        "mediaItem": "https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg"
40 *      },
41 *      "limitedToOneItem": false,
42 *      "type": "PercentOff",
43 *      "percentOffRate": 10
44 *    }
45 *  }
46 *
47 */