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.

Application product price

This event will be generated where there is any action done on application level pricing

Events

application/product-price/create/v1

# This event is triggered when pricing based on price zone or delivery zone is created

application/product-price/update/v1

# This event is triggered when pricing based on price zone or delivery zone is updated

application/product-price/delete/v1

# This event is triggered when pricing based on price zone or delivery zone is deleted

Application Product Price/product-price/create/v1

This event is triggered when pricing based on price zone or delivery zone is created

Payload

Properties

application_id

array of 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

item_code

string

Required

Unique code identifying the item.

brand_uid

integer

Required

Unique identifier for the brand.

item_id

integer

Required

Unique identifier for the item.

product_price

array of object

Required

List of pricing and delivery configurations across zones.

Array of Properties

zone_type

string

Required

Type of zone (e.g., price or delivery).

zone_identifier

string

Required

Identifier for the pricing/delivery zone.

discount_meta

object

Metadata related to discounts applicable to the item.

Properties

start

string

| date-time

Start time for the discount (if applicable).

end

string

| date-time

End time for the discount (if applicable).

timer

boolean

Flag indicating if a discount timer is enabled.

currency_prices

array of object

Required

List of pricing data for different currencies.

Array of Properties

discount

number

Required

Discount amount or percentage.

currency_code

string

Required

ISO currency code (e.g., INR, AED).

currency_symbol

string

Required

Symbol of the currency (e.g., ₹, AED).

marked

object

Required

Marked price range.

Properties

min

number

Required

Minimum marked price.

max

number

Required

Maximum marked price.

effective

object

Required

Effective price range after discount.

Properties

min

number

Required

Minimum effective price.

max

number

Required

Maximum effective price.

selling

object

Required

Final selling price range.

Properties

min

number

Required

Minimum selling price.

max

number

Required

Maximum selling price.

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": "array",
13      "items": {
14        "type": "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        "item_code",
78        "brand_uid",
79        "item_id",
80        "product_price"
81      ],
82      "properties": {
83        "item_code": {
84          "type": "string",
85          "description": "Unique code identifying the item."
86        },
87        "brand_uid": {
88          "type": "integer",
89          "description": "Unique identifier for the brand."
90        },
91        "item_id": {
92          "type": "integer",
93          "description": "Unique identifier for the item."
94        },
95        "product_price": {
96          "type": "array",
97          "description": "List of pricing and delivery configurations across zones.",
98          "items": {
99            "type": "object",
100            "required": [
101              "zone_type",
102              "zone_identifier",
103              "currency_prices"
104            ],
105            "properties": {
106              "zone_type": {
107                "type": "string",
108                "description": "Type of zone (e.g., price or delivery)."
109              },
110              "zone_identifier": {
111                "type": "string",
112                "description": "Identifier for the pricing/delivery zone."
113              },
114              "discount_meta": {
115                "type": "object",
116                "description": "Metadata related to discounts applicable to the item.",
117                "properties": {
118                  "start": {
119                    "type": "string",
120                    "format": "date-time",
121                    "description": "Start time for the discount (if applicable)."
122                  },
123                  "end": {
124                    "type": "string",
125                    "format": "date-time",
126                    "description": "End time for the discount (if applicable)."
127                  },
128                  "timer": {
129                    "type": "boolean",
130                    "description": "Flag indicating if a discount timer is enabled."
131                  }
132                }
133              },
134              "currency_prices": {
135                "type": "array",
136                "description": "List of pricing data for different currencies.",
137                "items": {
138                  "type": "object",
139                  "required": [
140                    "discount",
141                    "currency_code",
142                    "currency_symbol",
143                    "marked",
144                    "effective",
145                    "selling"
146                  ],
147                  "properties": {
148                    "discount": {
149                      "type": "number",
150                      "description": "Discount amount or percentage."
151                    },
152                    "currency_code": {
153                      "type": "string",
154                      "description": "ISO currency code (e.g., INR, AED)."
155                    },
156                    "currency_symbol": {
157                      "type": "string",
158                      "description": "Symbol of the currency (e.g., ₹, AED)."
159                    },
160                    "marked": {
161                      "type": "object",
162                      "description": "Marked price range.",
163                      "required": [
164                        "min",
165                        "max"
166                      ],
167                      "properties": {
168                        "min": {
169                          "type": "number",
170                          "description": "Minimum marked price."
171                        },
172                        "max": {
173                          "type": "number",
174                          "description": "Maximum marked price."
175                        }
176                      }
177                    },
178                    "effective": {
179                      "type": "object",
180                      "description": "Effective price range after discount.",
181                      "required": [
182                        "min",
183                        "max"
184                      ],
185                      "properties": {
186                        "min": {
187                          "type": "number",
188                          "description": "Minimum effective price."
189                        },
190                        "max": {
191                          "type": "number",
192                          "description": "Maximum effective price."
193                        }
194                      }
195                    },
196                    "selling": {
197                      "type": "object",
198                      "description": "Final selling price range.",
199                      "required": [
200                        "min",
201                        "max"
202                      ],
203                      "properties": {
204                        "min": {
205                          "type": "number",
206                          "description": "Minimum selling price."
207                        },
208                        "max": {
209                          "type": "number",
210                          "description": "Maximum selling price."
211                        }
212                      }
213                    }
214                  }
215                }
216              }
217            }
218          }
219        }
220      }
221    }
222  }
223}

Payload Example

1{
2  "application_id": [
3    "625e5411d6a31365b571800a",
4    "*"
5  ],
6  "company_id": 5,
7  "contains": [
8    "product-price"
9  ],
10  "event": {
11    "category": "application",
12    "created_timestamp": 1712143541216,
13    "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",
14    "name": "product-price",
15    "trace_id": [
16      "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"
17    ],
18    "type": "create",
19    "version": "1"
20  },
21  "payload": {
22    "item_code": "TEST1",
23    "brand_uid": 1,
24    "item_id": 7500013,
25    "product_price": [
26      {
27        "zone_type": "price",
28        "zone_identifier": "68020ee6bb20f913edb1f3cb",
29        "discount_meta": {
30          "start": "",
31          "end": "",
32          "timer": true
33        },
34        "currency_prices": [
35          {
36            "discount": 9,
37            "currency_code": "AED",
38            "currency_symbol": "AED",
39            "marked": {
40              "min": 6,
41              "max": 6
42            },
43            "effective": {
44              "min": 5.4,
45              "max": 5.4
46            },
47            "selling": {
48              "min": 5.4,
49              "max": 5.4
50            }
51          }
52        ]
53      },
54      {
55        "zone_type": "delivery",
56        "zone_identifier": "_all_",
57        "discount_meta": {},
58        "currency_prices": [
59          {
60            "discount": 0,
61            "currency_code": "INR",
62            "currency_symbol": "₹",
63            "marked": {
64              "min": 100,
65              "max": 100
66            },
67            "effective": {
68              "min": 100,
69              "max": 100
70            },
71            "selling": {
72              "min": 100,
73              "max": 100
74            }
75          }
76        ]
77      }
78    ]
79  }
80}

Application Product Price/product-price/update/v1

This event is triggered when pricing based on price zone or delivery zone is updated

Payload

Properties

application_id

array of 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

item_code

string

Required

Unique code identifying the item.

brand_uid

integer

Required

Unique identifier for the brand.

item_id

integer

Required

Unique identifier for the item.

product_price

array of object

Required

List of pricing and delivery configurations across zones.

Array of Properties

zone_type

string

Required

Type of zone (e.g., price or delivery).

zone_identifier

string

Required

Identifier for the pricing/delivery zone.

discount_meta

object

Metadata related to discounts applicable to the item.

Properties

start

string

Start time for the discount (if applicable).

end

string

| date-time

End time for the discount (if applicable).

timer

boolean

Flag indicating if a discount timer is enabled.

currency_prices

array of object

Required

List of pricing data for different currencies.

Array of Properties

discount

number

Required

Discount amount or percentage.

currency_code

string

Required

ISO currency code (e.g., INR, AED).

currency_symbol

string

Required

Symbol of the currency (e.g., ₹, AED).

marked

object

Required

Marked price range.

Properties

min

number

Required

Minimum marked price.

max

number

Required

Maximum marked price.

effective

object

Required

Effective price range after discount.

Properties

min

number

Required

Minimum effective price.

max

number

Required

Maximum effective price.

selling

object

Required

Final selling price range.

Properties

min

number

Required

Minimum selling price.

max

number

Required

Maximum selling price.

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": "array",
13      "items": {
14        "type": "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        "item_code",
78        "brand_uid",
79        "item_id",
80        "product_price"
81      ],
82      "properties": {
83        "item_code": {
84          "type": "string",
85          "description": "Unique code identifying the item."
86        },
87        "brand_uid": {
88          "type": "integer",
89          "description": "Unique identifier for the brand."
90        },
91        "item_id": {
92          "type": "integer",
93          "description": "Unique identifier for the item."
94        },
95        "product_price": {
96          "type": "array",
97          "description": "List of pricing and delivery configurations across zones.",
98          "items": {
99            "type": "object",
100            "required": [
101              "zone_type",
102              "zone_identifier",
103              "currency_prices"
104            ],
105            "properties": {
106              "zone_type": {
107                "type": "string",
108                "description": "Type of zone (e.g., price or delivery)."
109              },
110              "zone_identifier": {
111                "type": "string",
112                "description": "Identifier for the pricing/delivery zone."
113              },
114              "discount_meta": {
115                "type": "object",
116                "description": "Metadata related to discounts applicable to the item.",
117                "properties": {
118                  "start": {
119                    "type": "string",
120                    "fromat": "date-time",
121                    "description": "Start time for the discount (if applicable)."
122                  },
123                  "end": {
124                    "type": "string",
125                    "format": "date-time",
126                    "description": "End time for the discount (if applicable)."
127                  },
128                  "timer": {
129                    "type": "boolean",
130                    "description": "Flag indicating if a discount timer is enabled."
131                  }
132                }
133              },
134              "currency_prices": {
135                "type": "array",
136                "description": "List of pricing data for different currencies.",
137                "items": {
138                  "type": "object",
139                  "required": [
140                    "discount",
141                    "currency_code",
142                    "currency_symbol",
143                    "marked",
144                    "effective",
145                    "selling"
146                  ],
147                  "properties": {
148                    "discount": {
149                      "type": "number",
150                      "description": "Discount amount or percentage."
151                    },
152                    "currency_code": {
153                      "type": "string",
154                      "description": "ISO currency code (e.g., INR, AED)."
155                    },
156                    "currency_symbol": {
157                      "type": "string",
158                      "description": "Symbol of the currency (e.g., ₹, AED)."
159                    },
160                    "marked": {
161                      "type": "object",
162                      "description": "Marked price range.",
163                      "required": [
164                        "min",
165                        "max"
166                      ],
167                      "properties": {
168                        "min": {
169                          "type": "number",
170                          "description": "Minimum marked price."
171                        },
172                        "max": {
173                          "type": "number",
174                          "description": "Maximum marked price."
175                        }
176                      }
177                    },
178                    "effective": {
179                      "type": "object",
180                      "description": "Effective price range after discount.",
181                      "required": [
182                        "min",
183                        "max"
184                      ],
185                      "properties": {
186                        "min": {
187                          "type": "number",
188                          "description": "Minimum effective price."
189                        },
190                        "max": {
191                          "type": "number",
192                          "description": "Maximum effective price."
193                        }
194                      }
195                    },
196                    "selling": {
197                      "type": "object",
198                      "description": "Final selling price range.",
199                      "required": [
200                        "min",
201                        "max"
202                      ],
203                      "properties": {
204                        "min": {
205                          "type": "number",
206                          "description": "Minimum selling price."
207                        },
208                        "max": {
209                          "type": "number",
210                          "description": "Maximum selling price."
211                        }
212                      }
213                    }
214                  }
215                }
216              }
217            }
218          }
219        }
220      }
221    }
222  }
223}

Payload Example

1{
2  "application_id": [
3    "625e5411d6a31365b571800a",
4    "*"
5  ],
6  "company_id": 5,
7  "contains": [
8    "product-price"
9  ],
10  "event": {
11    "category": "application",
12    "created_timestamp": 1712143541216,
13    "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",
14    "name": "product-price",
15    "trace_id": [
16      "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"
17    ],
18    "type": "update",
19    "version": "1"
20  },
21  "payload": {
22    "item_code": "TEST1",
23    "brand_uid": 1,
24    "item_id": 7500013,
25    "product_price": [
26      {
27        "zone_type": "price",
28        "zone_identifier": "68020ee6bb20f913edb1f3cb",
29        "discount_meta": {
30          "start": "",
31          "end": "",
32          "timer": true
33        },
34        "currency_prices": [
35          {
36            "discount": 9,
37            "currency_code": "AED",
38            "currency_symbol": "AED",
39            "marked": {
40              "min": 6,
41              "max": 6
42            },
43            "effective": {
44              "min": 5.4,
45              "max": 5.4
46            },
47            "selling": {
48              "min": 5.4,
49              "max": 5.4
50            }
51          }
52        ]
53      },
54      {
55        "zone_type": "delivery",
56        "zone_identifier": "_all_",
57        "discount_meta": {},
58        "currency_prices": [
59          {
60            "discount": 0,
61            "currency_code": "INR",
62            "currency_symbol": "₹",
63            "marked": {
64              "min": 100,
65              "max": 100
66            },
67            "effective": {
68              "min": 100,
69              "max": 100
70            },
71            "selling": {
72              "min": 100,
73              "max": 100
74            }
75          }
76        ]
77      }
78    ]
79  }
80}

Application Product Price/product-price/delete/v1

This event is triggered when pricing based on price zone or delivery zone is deleted

Payload

Properties

application_id

array of 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