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.

Zone

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

Events

application/zone/create/v1

# this event is triggered when zone is created

application/zone/update/v1

# this event is triggered when zone is updated

Zone/zone/create/v1

this event is triggered when zone is created

Payload

Properties

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

zone

object

Required

Properties

zone_id

string

Required

Zone ID

slug

string

Required

Slug of the region associated with the zone

name

string

Required

Canonical name of slug

geo_areas

array of string

Required

Geoarea ids of the zone

regions

array of object

Required

List of Region Data for the created/updated zone

Array of Properties

country

string

Country for specific list of regions

regions

array of string

company_id

integer

Required

Company id of the created/updated zone

product

object

Required

Product type and tags associated with the zone

Properties

values

array of string

Required

List of values of given type associated with the zone

type

string

Required

Type of product category to be selected for zone

Enum

stores

object

Required

Channels associated with the zone

Properties

type

string

Required

Type of store category selected

Enum

values

array of integer

Required

List of Store ids selected

is_active

boolean

Required

Indicates whether the zone is active or not

application_id

string

Required

Application id for the zone

stage

string

Stage of the zone

Enum

overlapping_file_url

string

Nullable

If error in bulk upload then error file url

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "properties": {
69        "zone": {
70          "type": "object",
71          "properties": {
72            "zone_id": {
73              "type": "string",
74              "description": "Zone ID"
75            },
76            "slug": {
77              "type": "string",
78              "description": "Slug of the region associated with the zone"
79            },
80            "name": {
81              "type": "string",
82              "description": "Canonical name of slug"
83            },
84            "geo_areas": {
85              "type": "array",
86              "items": {
87                "type": "string"
88              },
89              "description": "Geoarea ids of the zone"
90            },
91            "regions": {
92              "type": "array",
93              "items": {
94                "type": "object",
95                "properties": {
96                  "country": {
97                    "type": "string",
98                    "description": "Country for specific list of regions"
99                  },
100                  "regions": {
101                    "type": "array",
102                    "items": {
103                      "type": "string",
104                      "description": "List of region ids for the country"
105                    }
106                  }
107                }
108              },
109              "description": "List of Region Data for the created/updated zone"
110            },
111            "company_id": {
112              "type": "integer",
113              "description": "Company id of the created/updated zone"
114            },
115            "product": {
116              "type": "object",
117              "properties": {
118                "values": {
119                  "type": "array",
120                  "items": {
121                    "type": "string"
122                  },
123                  "description": "List of values of given type associated with the zone"
124                },
125                "type": {
126                  "type": "string",
127                  "description": "Type of product category to be selected for zone",
128                  "enum": [
129                    "department",
130                    "category",
131                    "item_id",
132                    "all",
133                    "tag"
134                  ]
135                }
136              },
137              "required": [
138                "values",
139                "type"
140              ],
141              "description": "Product type and tags associated with the zone"
142            },
143            "stores": {
144              "type": "object",
145              "properties": {
146                "type": {
147                  "type": "string",
148                  "description": "Type of store category selected",
149                  "enum": [
150                    "custom",
151                    "all"
152                  ]
153                },
154                "values": {
155                  "type": "array",
156                  "items": {
157                    "type": "integer"
158                  },
159                  "description": "List of Store ids selected"
160                }
161              },
162              "required": [
163                "type",
164                "values"
165              ],
166              "description": "Channels associated with the zone"
167            },
168            "is_active": {
169              "type": "boolean",
170              "description": "Indicates whether the zone is active or not"
171            },
172            "application_id": {
173              "type": "string",
174              "description": "Application id for the zone"
175            },
176            "stage": {
177              "type": "string",
178              "description": "Stage of the zone",
179              "enum": [
180                "failed",
181                "partial",
182                "completed",
183                "in_progress"
184              ]
185            },
186            "overlapping_file_url": {
187              "type": "string",
188              "nullable": true,
189              "description": "If error in bulk upload then error file url"
190            }
191          },
192          "required": [
193            "zone_id",
194            "slug",
195            "name",
196            "company_id",
197            "stores",
198            "product",
199            "is_active",
200            "geo_areas",
201            "regions",
202            "application_id"
203          ]
204        }
205      },
206      "required": [
207        "zone"
208      ]
209    }
210  }
211}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "stormbreaker.0e0ecb4e-f4ae-49c0-ac08-6cab9ca03b05"
5    ],
6    "name": "zone",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711951311,
10    "id": "2WvgiyhP8hNQSLLifA/UHN17yq7nQTRha4B/0tzEzzg=",
11    "category": "company"
12  },
13  "company_id": 18376,
14  "contains": [
15    "zone"
16  ],
17  "payload": {
18    "zone": {
19      "zone_id": "660a4dcf51c9e512f3c78515",
20      "slug": "zone-z2foq",
21      "name": "Zone1",
22      "company_id": 18376,
23      "geo_areas": [
24        "geo_area"
25      ],
26      "stores": {
27        "type": "custom",
28        "values": [
29          49666
30        ]
31      },
32      "product": {
33        "type": "all",
34        "values": []
35      },
36      "regions": [
37        {
38          "country": "country",
39          "regions": [
40            "region"
41          ]
42        }
43      ],
44      "is_active": true,
45      "stage": "completed",
46      "application_id": "660a4dcf51c9e512f3c78515"
47    }
48  }
49}

Zone/zone/update/v1

this event is triggered when zone is updated

Payload

Properties

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

zone

object

Properties

zone_id

string

Required

Zone ID

slug

string

Required

Slug of the region associated with the zone

name

string

Required

Canonical name of slug

geo_areas

array of string

Required

Geoarea ids of the zone

regions

array of object

Required

List of Region Data for the created/updated zone

Array of Properties

country

string

Country for specific list of regions

regions

array of string

company_id

integer

Required

Company id of the created/updated zone

product

object

Required

Product type and tags associated with the zone

Properties

values

array of string

Required

List of values of given type associated with the zone

type

string

Required

Type of product category to be selected for zone

Enum

stores

object

Required

Channels associated with the zone

Properties

type

string

Required

Type of store category selected

Enum

values

array of integer

Required

List of Store ids selected

is_active

boolean

Required

Indicates whether the zone is active or not

application_id

string

Required

Application id for the zone

stage

string

Stage of the zone

Enum

overlapping_file_url

string

Nullable

If error in bulk upload then error file url

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "properties": {
69        "zone": {
70          "type": "object",
71          "properties": {
72            "zone_id": {
73              "type": "string",
74              "description": "Zone ID"
75            },
76            "slug": {
77              "type": "string",
78              "description": "Slug of the region associated with the zone"
79            },
80            "name": {
81              "type": "string",
82              "description": "Canonical name of slug"
83            },
84            "geo_areas": {
85              "type": "array",
86              "items": {
87                "type": "string"
88              },
89              "description": "Geoarea ids of the zone"
90            },
91            "regions": {
92              "type": "array",
93              "items": {
94                "type": "object",
95                "properties": {
96                  "country": {
97                    "type": "string",
98                    "description": "Country for specific list of regions"
99                  },
100                  "regions": {
101                    "type": "array",
102                    "items": {
103                      "type": "string",
104                      "description": "List of region ids for the country"
105                    }
106                  }
107                }
108              },
109              "description": "List of Region Data for the created/updated zone"
110            },
111            "company_id": {
112              "type": "integer",
113              "description": "Company id of the created/updated zone"
114            },
115            "product": {
116              "type": "object",
117              "properties": {
118                "values": {
119                  "type": "array",
120                  "items": {
121                    "type": "string"
122                  },
123                  "description": "List of values of given type associated with the zone"
124                },
125                "type": {
126                  "type": "string",
127                  "description": "Type of product category to be selected for zone",
128                  "enum": [
129                    "department",
130                    "category",
131                    "item_id",
132                    "all",
133                    "tag"
134                  ]
135                }
136              },
137              "required": [
138                "values",
139                "type"
140              ],
141              "description": "Product type and tags associated with the zone"
142            },
143            "stores": {
144              "type": "object",
145              "properties": {
146                "type": {
147                  "type": "string",
148                  "description": "Type of store category selected",
149                  "enum": [
150                    "custom",
151                    "all"
152                  ]
153                },
154                "values": {
155                  "type": "array",
156                  "items": {
157                    "type": "integer"
158                  },
159                  "description": "List of Store ids selected"
160                }
161              },
162              "required": [
163                "type",
164                "values"
165              ],
166              "description": "Channels associated with the zone"
167            },
168            "is_active": {
169              "type": "boolean",
170              "description": "Indicates whether the zone is active or not"
171            },
172            "application_id": {
173              "type": "string",
174              "description": "Application id for the zone"
175            },
176            "stage": {
177              "type": "string",
178              "description": "Stage of the zone",
179              "enum": [
180                "failed",
181                "partial",
182                "completed",
183                "in_progress"
184              ]
185            },
186            "overlapping_file_url": {
187              "type": "string",
188              "nullable": true,
189              "description": "If error in bulk upload then error file url"
190            }
191          },
192          "required": [
193            "zone_id",
194            "slug",
195            "name",
196            "company_id",
197            "stores",
198            "product",
199            "is_active",
200            "geo_areas",
201            "regions",
202            "application_id"
203          ]
204        }
205      }
206    }
207  }
208}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "stormbreaker.e6b4d431-e77c-4f21-aa6c-1972949dd567"
5    ],
6    "name": "zone",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711901438,
10    "id": "ekAHB7u0rNUjGRInx15tFznDERKa15ciwSG/paS0NX8=",
11    "category": "company"
12  },
13  "company_id": 18361,
14  "contains": [
15    "zone"
16  ],
17  "payload": {
18    "zone": {
19      "zone_id": "660a4dcf51c9e512f3c78515",
20      "slug": "zone-z2foq",
21      "name": "Zone1",
22      "company_id": 18376,
23      "geo_areas": [
24        "geo_area"
25      ],
26      "stores": {
27        "type": "custom",
28        "values": [
29          49666
30        ]
31      },
32      "product": {
33        "type": "all",
34        "values": []
35      },
36      "regions": [
37        {
38          "country": "country",
39          "regions": [
40            "region"
41          ]
42        }
43      ],
44      "is_active": true,
45      "stage": "completed",
46      "application_id": "660a4dcf51c9e512f3c78515"
47    }
48  }
49}

« variant/create/v1

category/create/v1 »