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.

Sort configuration

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

Events

application/sort/create/v1

# this event is triggered when sort is created

application/sort/update/v1

# this event is triggered when sort is updated

application/sort/delete/v1

# this event is triggered when sort is deleted

Sort Configuration/sort/create/v1

this event is triggered when sort is created

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

sort

object

Required

Properties

string

Required

UUID of the sort config.

key

string

Required

Slug of the sort attribute.

logo

string

Logo to show for the sort in the configuration.

name

string

Required

Display Name of the Sort config.

app_id

string

Required

Unique ID of the application.

priority

integer

Required

Position of the Sort config.

is_active

boolean

Required

Active status of the sort config.

is_default

boolean

Required

Default sorting values from the system.

default_key

string

Required

The default sort key

display_name

string

Name to be displayed on the storefront in the sorting options.

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        "sort"
78      ],
79      "properties": {
80        "sort": {
81          "type": "object",
82          "required": [
83            "app_id",
84            "id",
85            "key",
86            "is_active",
87            "priority",
88            "is_default",
89            "default_key",
90            "name"
91          ],
92          "properties": {
93            "id": {
94              "type": "string",
95              "description": "UUID of the sort config."
96            },
97            "key": {
98              "type": "string",
99              "description": "Slug of the sort attribute."
100            },
101            "logo": {
102              "type": "string",
103              "description": "Logo to show for the sort in the configuration."
104            },
105            "name": {
106              "type": "string",
107              "description": "Display Name of the Sort config."
108            },
109            "app_id": {
110              "type": "string",
111              "description": "Unique ID of the application."
112            },
113            "priority": {
114              "type": "integer",
115              "description": "Position of the Sort config."
116            },
117            "is_active": {
118              "type": "boolean",
119              "description": "Active status of the sort config."
120            },
121            "is_default": {
122              "type": "boolean",
123              "description": "Default sorting values from the system."
124            },
125            "default_key": {
126              "type": "string",
127              "description": "The default sort key"
128            },
129            "display_name": {
130              "type": "string",
131              "description": "Name to be displayed on the storefront in the sorting options."
132            }
133          },
134          "description": ""
135        }
136      }
137    }
138  }
139}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.49fcd33c-f2bc-11ee-9e0b-3ad0e80209a5"
5    ],
6    "name": "sort",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712260100414,
10    "id": "HCkLSRxDLcW/5viadcRKFRJtOyxjcKqwcNxmYgFGCLI=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "sort"
21  ],
22  "payload": {
23    "sort": {
24      "id": "660f03f6b83b58237cc2e8de",
25      "is_active": true,
26      "key": "latest",
27      "name": "Wilfredo338053264320241948250",
28      "is_default": true,
29      "priority": 2,
30      "default_key": "latest",
31      "logo": "/addsale/misc/default-assets/original/latest-products.png",
32      "app_id": "660edfcaaaaa57fb0b439b31"
33    }
34  }
35}

Sort Configuration/sort/update/v1

this event is triggered when sort 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

sort

object

Required

Properties

string

Required

UUID of the sort config.

key

string

Required

Slug of the sort attribute.

logo

string

Logo to show for the sort in the configuration.

name

string

Required

Display Name of the Sort config.

app_id

string

Required

Unique ID of the application.

priority

integer

Required

Position of the Sort config.

is_active

boolean

Required

Active status of the sort config.

is_default

boolean

Required

Default sorting values from the system.

default_key

string

Required

The default sort key

display_name

string

Name to be displayed on the storefront in the sorting options.

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        "sort"
78      ],
79      "properties": {
80        "sort": {
81          "type": "object",
82          "required": [
83            "app_id",
84            "id",
85            "key",
86            "is_active",
87            "priority",
88            "is_default",
89            "default_key",
90            "name"
91          ],
92          "properties": {
93            "id": {
94              "type": "string",
95              "description": "UUID of the sort config."
96            },
97            "key": {
98              "type": "string",
99              "description": "Slug of the sort attribute."
100            },
101            "logo": {
102              "type": "string",
103              "description": "Logo to show for the sort in the configuration."
104            },
105            "name": {
106              "type": "string",
107              "description": "Display Name of the Sort config."
108            },
109            "app_id": {
110              "type": "string",
111              "description": "Unique ID of the application."
112            },
113            "priority": {
114              "type": "integer",
115              "description": "Position of the Sort config."
116            },
117            "is_active": {
118              "type": "boolean",
119              "description": "Active status of the sort config."
120            },
121            "is_default": {
122              "type": "boolean",
123              "description": "Default sorting values from the system."
124            },
125            "default_key": {
126              "type": "string",
127              "description": "The default sort key"
128            },
129            "display_name": {
130              "type": "string",
131              "description": "Name to be displayed on the storefront in the sorting options."
132            }
133          },
134          "description": ""
135        }
136      }
137    }
138  }
139}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.49fcd33c-f2bc-11ee-9e0b-3ad0e80209a5"
5    ],
6    "name": "sort",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712260100414,
10    "id": "HCkLSRxDLcW/5viadcRKFRJtOyxjcKqwcNxmYgFGCLI=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "sort"
21  ],
22  "payload": {
23    "sort": {
24      "id": "660f03f6b83b58237cc2e8de",
25      "is_active": true,
26      "key": "latest",
27      "name": "Wilfredo338053264320241948250",
28      "is_default": true,
29      "priority": 2,
30      "default_key": "latest",
31      "logo": "/addsale/misc/default-assets/original/latest-products.png",
32      "app_id": "660edfcaaaaa57fb0b439b31"
33    }
34  }
35}

Sort Configuration/sort/delete/v1

this event is triggered when sort is deleted

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

sort

object

Required

Properties

string

Required

UUID of the sort config.

key

string

Required

Slug of the sort attribute.

logo

string

Logo to show for the sort in the configuration.

name

string

Required

Display Name of the Sort config.

app_id

string

Required

Unique ID of the application.

priority

integer

Required

Position of the Sort config.

is_active

boolean

Required

Active status of the sort config.

is_default

boolean

Required

Default sorting values from the system.

default_key

string

Required

The default sort key

display_name

string

Name to be displayed on the storefront in the sorting options.

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        "sort"
78      ],
79      "properties": {
80        "sort": {
81          "type": "object",
82          "required": [
83            "app_id",
84            "id",
85            "key",
86            "is_active",
87            "priority",
88            "is_default",
89            "default_key",
90            "name"
91          ],
92          "properties": {
93            "id": {
94              "type": "string",
95              "description": "UUID of the sort config."
96            },
97            "key": {
98              "type": "string",
99              "description": "Slug of the sort attribute."
100            },
101            "logo": {
102              "type": "string",
103              "description": "Logo to show for the sort in the configuration."
104            },
105            "name": {
106              "type": "string",
107              "description": "Display Name of the Sort config."
108            },
109            "app_id": {
110              "type": "string",
111              "description": "Unique ID of the application."
112            },
113            "priority": {
114              "type": "integer",
115              "description": "Position of the Sort config."
116            },
117            "is_active": {
118              "type": "boolean",
119              "description": "Active status of the sort config."
120            },
121            "is_default": {
122              "type": "boolean",
123              "description": "Default sorting values from the system."
124            },
125            "default_key": {
126              "type": "string",
127              "description": "The default sort key"
128            },
129            "display_name": {
130              "type": "string",
131              "description": "Name to be displayed on the storefront in the sorting options."
132            }
133          },
134          "description": ""
135        }
136      }
137    }
138  }
139}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"
5    ],
6    "name": "sort",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712260082824,
10    "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "sort"
21  ],
22  "payload": {
23    "sort": {
24      "name": "Latest Products",
25      "is_default": true,
26      "key": "latest",
27      "is_active": true,
28      "default_key": "popular",
29      "priority": 1,
30      "logo": "/addsale/misc/default-assets/original/latest-products.png",
31      "app_id": "660edfcaaaaa57fb0b439b31",
32      "id": "660f03f243ec2f1db3288646"
33    }
34  }
35}

« shipment/create/v1

tags/create/v1 »