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.

Cart price adjustment

This event will be generated where there is any action done on cart-price-adjustment

Events

application/cart-price-adjustment/create/v1

# this event is triggered when cart-price-adjustment is created

application/cart-price-adjustment/update/v1

# this event is triggered when cart-price-adjustment is updated

application/cart-price-adjustment/remove/v1

# this event is triggered when cart-price-adjustment is removed

Cart Price Adjustment/cart-price-adjustment/create/v1

this event is triggered when cart-price-adjustment is created

Payload

Properties

This event is triggered when cart price adjustment is created

application_id

array|string

Required

Application/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

This contains event data like name and type of event.

Properties

meta

object

Additional metadata for the article. It could be any key value object.

allowed_refund

boolean

Indicates if a refund is allowed at article level.

collection

object

Required

Details about the collection and refund process.

Properties

collected_by

string

Required

Who is collecting the amount.

refund_by

string

Required

Specifies who is responsible for processing refunds.

value

number

Required

The value of the adjustment applied.

message

string

Required

Message detailing the reason for the adjustment.

type

string

Required

Defines the type of adjustment (charge, discount, mop).

is_active

boolean

Indicates if the adjustment is currently active.

meta

object

Additional metadata for the adjustment.

allowed_refund

boolean

Indicates if a refund is allowed at cart level.

auto_remove

boolean

When set true then it will remove mop type price adjustment when cart value changed compared to provided in price adjustment.

created_by

string

Unique Identifier of the creator.

Payload Schema JSON

1{
2  "type": "object",
3  "description": "This event is triggered when cart price adjustment is created",
4  "required": [
5    "company_id",
6    "contains",
7    "event",
8    "payload",
9    "application_id"
10  ],
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Application/sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "company ID for which this event is triggered"
22    },
23    "contains": {
24      "type": "array",
25      "description": "This array will have all the keys present at root level of 'payload' object",
26      "items": {
27        "type": "string"
28      }
29    },
30    "event": {
31      "type": "object",
32      "description": "This contains event data like name and type of event.",
33      "required": [
34        "category",
35        "created_timestamp",
36        "id",
37        "name",
38        "trace_id",
39        "type",
40        "version"
41      ],
42      "properties": {
43        "category": {
44          "type": "string",
45          "description": "category of the event. If it is at sales channel level or company level"
46        },
47        "created_timestamp": {
48          "type": "integer",
49          "description": "event generation timestamp in epoch milliseconds"
50        },
51        "id": {
52          "type": "string",
53          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
54        },
55        "name": {
56          "type": "string",
57          "description": "Name of the event"
58        },
59        "trace_id": {
60          "type": "array",
61          "description": "internal trace_id for Fynd Platform services",
62          "items": {
63            "type": "string"
64          }
65        },
66        "type": {
67          "type": "string",
68          "description": "Type/Action of the event. e.g. create/update/delete"
69        },
70        "version": {
71          "type": "string",
72          "description": "Version of the event."
73        }
74      }
75    },
76    "payload": {
77      "type": "object",
78      "description": "The payload data of event.",
79      "required": [
80        "article_ids",
81        "article_level_distribution",
82        "cart_id",
83        "collection",
84        "id",
85        "is_authenticated",
86        "message",
87        "type",
88        "value"
89      ],
90      "properties": {
91        "article_level_distribution": {
92          "type": "boolean",
93          "description": "Whether the distribution is done at the article level or not."
94        },
95        "cart_value": {
96          "type": "number",
97          "description": "The total value of the cart to which the adjustments are applied."
98        },
99        "cart_id": {
100          "type": "string",
101          "description": "The identifier of the cart on which the price adjustment is applied."
102        },
103        "id": {
104          "type": "string",
105          "description": "Unique identifier for the price adjustment."
106        },
107        "is_authenticated": {
108          "type": "boolean",
109          "description": "Indicates whether the cart user is logged in or not."
110        },
111        "article_ids": {
112          "type": "array",
113          "description": "Defines the list of articles you want to apply the injection to.",
114          "items": {
115            "type": "object",
116            "description": "Contains article vise data like id, code and type.",
117            "properties": {
118              "article_id": {
119                "type": "string",
120                "description": "Unique identifier for the article."
121              },
122              "code": {
123                "type": "string",
124                "description": "Code to identify price adjustment on article."
125              },
126              "type": {
127                "type": "string",
128                "description": "Type of price adjustment for the article. Valid options are: - 'discount': discount applied to the article price as promotion. - 'mop': additional mode of payment for article. - 'selling_price': additional discount in selling price of an article. - 'delivery_charge': delivery charge for an article to be added."
129              },
130              "value": {
131                "type": "number",
132                "format": "float",
133                "description": "Value of price adjustment for article."
134              },
135              "meta": {
136                "type": "object",
137                "description": "Additional metadata for the article. It could be any key value object."
138              },
139              "allowed_refund": {
140                "type": "boolean",
141                "description": "Indicates if a refund is allowed at article level."
142              }
143            }
144          }
145        },
146        "collection": {
147          "type": "object",
148          "required": [
149            "collected_by",
150            "refund_by"
151          ],
152          "properties": {
153            "collected_by": {
154              "type": "string",
155              "description": "Who is collecting the amount."
156            },
157            "refund_by": {
158              "type": "string",
159              "description": "Specifies who is responsible for processing refunds."
160            }
161          },
162          "description": "Details about the collection and refund process."
163        },
164        "value": {
165          "type": "number",
166          "description": "The value of the adjustment applied."
167        },
168        "message": {
169          "type": "string",
170          "description": "Message detailing the reason for the adjustment."
171        },
172        "type": {
173          "type": "string",
174          "description": "Defines the type of adjustment (charge, discount, mop)."
175        },
176        "is_active": {
177          "type": "boolean",
178          "description": "Indicates if the adjustment is currently active."
179        },
180        "meta": {
181          "type": "object",
182          "description": "Additional metadata for the adjustment."
183        },
184        "allowed_refund": {
185          "type": "boolean",
186          "description": "Indicates if a refund is allowed at cart level."
187        },
188        "auto_remove": {
189          "type": "boolean",
190          "description": "When set true then it will remove mop type price adjustment when cart value changed compared to provided in price adjustment."
191        },
192        "created_by": {
193          "type": "string",
194          "description": "Unique Identifier of the creator."
195        }
196      }
197    }
198  }
199}

Payload Example

1{
2  "application_id": "5e048673acefbaf1e8487564",
3  "company_id": 61,
4  "contains": [
5    "article_level_distribution",
6    "type",
7    "cart_id",
8    "value",
9    "article_ids",
10    "message",
11    "id",
12    "collection",
13    "created_by",
14    "is_authenticated"
15  ],
16  "event": {
17    "category": "application",
18    "created_timestamp": 1709923681057,
19    "id": "38fCmbF/KKdYVhSZv7YVQ2vI2HgEzWKIAmfGxcyAxD4=",
20    "name": "cart-price-adjustment",
21    "trace_id": [
22      "megatron.7d6d8569-5855-4e3f-983f-1661a086031b"
23    ],
24    "type": "create",
25    "version": "1"
26  },
27  "payload": {
28    "article_ids": [
29      {
30        "article_id": "65c22508d48efa43534b2ff0",
31        "type": "discount",
32        "value": 119.98
33      }
34    ],
35    "article_level_distribution": true,
36    "cart_id": "65eb5d60653540da999a93c8",
37    "collection": {
38      "collected_by": "SELLER",
39      "refund_by": "SELLER"
40    },
41    "created_by": "f87848737e0b7b55b4295eef",
42    "id": "65eb5d613877309818f3b25e",
43    "is_authenticated": true,
44    "message": "Subscription Discount",
45    "type": "mop",
46    "value": 119.98
47  }
48}

Cart Price Adjustment/cart-price-adjustment/update/v1

this event is triggered when cart-price-adjustment is updated

Payload

Properties

This event is triggered when cart price adjustment is updated

application_id

array|string

Required

Application/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

This contains event data like name and type of event.

Properties

meta

object

Additional information you want to pass on article level or cart level.

type

string

Required

Defines the injection type used for charge, discount, or MOP (Mode of Payment).

value

number

Required

The amount applied on the cart.

cart_id

string

Required

The cart ID on which the price adjustment is applied.

message

string

Required

The message to show the text or detail regarding the discount, charge, or MOP, etc.

is_active

boolean

Defines if the injection is active or not.

cart_value

number

Required

Defines the amount of the cart.

collection

object

Required

Defines the amount collection details.

Properties

refund_by

string

Required

Defines who will refund the amount in case of order cancellation/return if allowed_refund is True.

collected_by

string

Required

Defines who is collecting the amount.

article_ids

array of object

Required

Defines the list of articles you want to apply the injection to.

Array of Properties

article_id

string

Unique identifier for the article.

code

string

Code to identify price adjustment on article.

type

string

value

number

| float

Value of price adjustment for article.

meta

object

Additional metadata for the article. It could be any key value object.

allowed_refund

boolean

Indicates if a refund is allowed at article level.

allowed_refund

boolean

Defines who will refund the amount in case of order cancelled/returned if refund is True.

is_authenticated

boolean

Required

Defines if the user is authorized or not.

article_level_distribution

boolean

Required

Defines if the amount is distributed at the article level or not.

Payload Schema JSON

1{
2  "type": "object",
3  "description": "This event is triggered when cart price adjustment is updated",
4  "required": [
5    "company_id",
6    "contains",
7    "event",
8    "payload",
9    "application_id"
10  ],
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Application/sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "company ID for which this event is triggered"
22    },
23    "contains": {
24      "type": "array",
25      "description": "This array will have all the keys present at root level of 'payload' object",
26      "items": {
27        "type": "string"
28      }
29    },
30    "event": {
31      "type": "object",
32      "description": "This contains event data like name and type of event.",
33      "required": [
34        "category",
35        "created_timestamp",
36        "id",
37        "name",
38        "trace_id",
39        "type",
40        "version"
41      ],
42      "properties": {
43        "category": {
44          "type": "string",
45          "description": "category of the event. If it is at sales channel level or company level"
46        },
47        "created_timestamp": {
48          "type": "integer",
49          "description": "event generation timestamp in epoch milliseconds"
50        },
51        "id": {
52          "type": "string",
53          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
54        },
55        "name": {
56          "type": "string",
57          "description": "Name of the event"
58        },
59        "trace_id": {
60          "type": "array",
61          "description": "internal trace_id for Fynd Platform services",
62          "items": {
63            "type": "string"
64          }
65        },
66        "type": {
67          "type": "string",
68          "description": "Type/Action of the event. e.g. create/update/delete"
69        },
70        "version": {
71          "type": "string",
72          "description": "Version of the event."
73        }
74      }
75    },
76    "payload": {
77      "type": "object",
78      "description": "The payload data of event.",
79      "required": [
80        "article_ids",
81        "article_level_distribution",
82        "cart_id",
83        "cart_value",
84        "collection",
85        "id",
86        "is_authenticated",
87        "message",
88        "type",
89        "value"
90      ],
91      "properties": {
92        "id": {
93          "type": "string",
94          "description": "The unique identifier for the price adjustment."
95        },
96        "meta": {
97          "type": "object",
98          "description": "Additional information you want to pass on article level or cart level."
99        },
100        "type": {
101          "type": "string",
102          "description": "Defines the injection type used for charge, discount, or MOP (Mode of Payment)."
103        },
104        "value": {
105          "type": "number",
106          "description": "The amount applied on the cart."
107        },
108        "cart_id": {
109          "type": "string",
110          "description": "The cart ID on which the price adjustment is applied."
111        },
112        "message": {
113          "type": "string",
114          "description": "The message to show the text or detail regarding the discount, charge, or MOP, etc."
115        },
116        "is_active": {
117          "type": "boolean",
118          "description": "Defines if the injection is active or not."
119        },
120        "cart_value": {
121          "type": "number",
122          "description": "Defines the amount of the cart."
123        },
124        "collection": {
125          "type": "object",
126          "required": [
127            "collected_by",
128            "refund_by"
129          ],
130          "properties": {
131            "refund_by": {
132              "type": "string",
133              "description": "Defines who will refund the amount in case of order cancellation/return if allowed_refund is True."
134            },
135            "collected_by": {
136              "type": "string",
137              "description": "Defines who is collecting the amount."
138            }
139          },
140          "description": "Defines the amount collection details."
141        },
142        "article_ids": {
143          "type": "array",
144          "items": {
145            "type": "object",
146            "description": "Contains article vise data like id, code and type.",
147            "properties": {
148              "article_id": {
149                "type": "string",
150                "description": "Unique identifier for the article."
151              },
152              "code": {
153                "type": "string",
154                "description": "Code to identify price adjustment on article."
155              },
156              "type": {
157                "type": "string",
158                "description": "Type of price adjustment for the article. Valid options are: - 'discount': discount applied to the article price as promotion. - 'mop': additional mode of payment for article. - 'selling_price': additional discount in selling price of an article. - 'delivery_charge': delivery charge for an article to be added."
159              },
160              "value": {
161                "type": "number",
162                "format": "float",
163                "description": "Value of price adjustment for article."
164              },
165              "meta": {
166                "type": "object",
167                "description": "Additional metadata for the article. It could be any key value object."
168              },
169              "allowed_refund": {
170                "type": "boolean",
171                "description": "Indicates if a refund is allowed at article level."
172              }
173            }
174          },
175          "description": "Defines the list of articles you want to apply the injection to."
176        },
177        "allowed_refund": {
178          "type": "boolean",
179          "description": "Defines who will refund the amount in case of order cancelled/returned if refund is True."
180        },
181        "is_authenticated": {
182          "type": "boolean",
183          "description": "Defines if the user is authorized or not."
184        },
185        "article_level_distribution": {
186          "type": "boolean",
187          "description": "Defines if the amount is distributed at the article level or not."
188        }
189      }
190    }
191  }
192}

Payload Example

1{
2  "payload": {
3    "cart_id": "644630845625add991225b47",
4    "is_authenticated": true,
5    "article_level_distribution": true,
6    "message": "DMS CART",
7    "value": 5,
8    "collection": {
9      "collected_by": "FYND",
10      "refund_by": "FYND"
11    },
12    "meta": {},
13    "apply_expiry": "2023-06-26-12:34:00",
14    "article_ids": [
15      {
16        "code": "",
17        "article_id": "647ef550a3bba8e197b81c7d",
18        "value": 5,
19        "meta": {},
20        "type": "discount"
21      }
22    ],
23    "type": "discount",
24    "is_active": true,
25    "id": "6499383154769c889deefd28",
26    "cart_value": 100
27  },
28  "contains": [],
29  "event": {
30    "id": "testID",
31    "name": "cart-price-adjustment",
32    "type": "update",
33    "version": "1",
34    "trace_id": [
35      "6730d511bfe14cb0822f872bcf02f21e"
36    ],
37    "created_timestamp": 1686263989,
38    "category": "application"
39  },
40  "company_id": 873,
41  "application_id": "000000000000000000000001"
42}

Cart Price Adjustment/cart-price-adjustment/remove/v1

this event is triggered when cart-price-adjustment is removed

Payload

Properties

This event is triggered when cart price adjustment is removed

application_id

array|string

Required

Application/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

This contains event data like name and type of event.

Properties