Application

Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.

Promotion usage

This event will be generated where there is any action done on promotion_usage

Events

application/promotion_usage/update/v1

# this event is triggered when promotion_usage is updated

Promotion Usage/promotion_usage/update/v1

this event is triggered when promotion_usage is updated

Payload

Properties

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Properties

category

string

Required

category of the event. If it is at sales channel level or company level

created_timestamp

integer

Required

event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Required

Properties

promotion_usage

object

Required

Properties

app_id

string

Required

ID of the application (sales channel) where promotion is used

user_id

string

Required

User's _id for which promotion usage count event is triggered

_version

integer

Required

Document version key. Since event throughput is high, event generation order might be different and latest event might get triggered first. Doc version can be used to discard old event data.

usage_count

integer

Required

Total order count for current user during the promotional period

promotion_id

string

Required

ID of the promotion

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "promotion_usage"
78      ],
79      "properties": {
80        "promotion_usage": {
81          "type": "object",
82          "required": [
83            "promotion_id",
84            "usage_count",
85            "user_id",
86            "app_id",
87            "_version"
88          ],
89          "properties": {
90            "app_id": {
91              "type": "string",
92              "description": "ID of the application (sales channel) where promotion is used"
93            },
94            "user_id": {
95              "type": "string",
96              "description": "User's _id for which promotion usage count event is triggered"
97            },
98            "_version": {
99              "type": "integer",
100              "description": "Document version key. Since event throughput is high, event generation order might be different and latest event might get triggered first. Doc version can be used to discard old event data."
101            },
102            "usage_count": {
103              "type": "integer",
104              "description": "Total order count for current user during the promotional period"
105            },
106            "promotion_id": {
107              "type": "string",
108              "description": "ID of the promotion"
109            }
110          }
111        }
112      }
113    }
114  }
115}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "megatron.43891ecb-3187-4405-bf99-89ceea8b9104"
5    ],
6    "name": "promotion_usage",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711531216651,
10    "id": "5FcBBAtYvCCAIYqM7m1mt1Ii9E/7Ur5bV4bRwbxvQoc=",
11    "category": "application"
12  },
13  "company_id": 5842,
14  "application_id": "6523fa5f41f4eb4c10a1d869",
15  "contains": [
16    "promotion_usage"
17  ],
18  "payload": {
19    "promotion_usage": {
20      "user_id": "65d73a6c2ef8415265228bb2",
21      "app_id": "6523fa5f41f4eb4c10a1d869",
22      "promotion_id": "66002a96b7a27a70b821e3f2",
23      "usage_count": 1,
24      "_version": 1
25    }
26  }
27}

« promotion/create/v1

refund/refund_initiated/v1 »