Price_factory

Events categorised under price factory level will be triggered when any action performed on price factory. e.g. If new price factory is created.

Price factory

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

Events

price_factory/price_factory/create/v1

# this event is triggered when price_factory is created

price_factory/price_factory/update/v1

# this event is triggered when price_factory is updated

price_factory/price_factory/create/v1

this event is triggered when price_factory is created

Payload

Properties

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

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

event

object

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

Properties

price_factory

object

Properties

is_active

boolean

Required

A flag that shows whether a Price Factory is active or not

currency

string

Required

Currency in which the prices of the products are specified

application_id

string

Required

Id of the application in which the Price Factory is created

factory_type_ids

array of string

Required

Ids of the price zones included in the Price Factory

factory_type

string

Required

Type of the Factory

department_ids

array of integer

Required

Ids of the departments that are included in the Price Factory

name

string

Required

The name of the Price Factory

_id

string

Required

Unique identifier for Price Factory

Payload Schema JSON

1{
2  "type": "object",
3  "description": "Event emitted when a Price Factory is created",
4  "properties": {
5    "application_id": {
6      "type": [
7        "array",
8        "string"
9      ],
10      "description": "Application/sales channel ID for which this event is triggered"
11    },
12    "company_id": {
13      "type": "integer",
14      "description": "company ID for which this event is triggered"
15    },
16    "contains": {
17      "type": "array",
18      "description": "This array will have all the keys present at root level of 'payload' object",
19      "items": {
20        "type": "string"
21      }
22    },
23    "event": {
24      "type": "object",
25      "required": [
26        "category",
27        "created_timestamp",
28        "id",
29        "name",
30        "trace_id",
31        "type",
32        "version"
33      ],
34      "properties": {
35        "category": {
36          "type": "string",
37          "description": "category of the event. If it is at sales channel level or company level"
38        },
39        "created_timestamp": {
40          "type": "integer",
41          "description": "event generation timestamp in epoch milliseconds"
42        },
43        "id": {
44          "type": "string",
45          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
46        },
47        "name": {
48          "type": "string",
49          "description": "Name of the event"
50        },
51        "trace_id": {
52          "type": "array",
53          "description": "internal trace_id for Fynd Platform services",
54          "items": {
55            "type": "string"
56          }
57        },
58        "type": {
59          "type": "string",
60          "description": "Type/Action of the event. e.g. create/update/delete"
61        },
62        "version": {
63          "type": "string",
64          "description": "Version of the event."
65        }
66      }
67    },
68    "payload": {
69      "type": "object",
70      "properties": {
71        "price_factory": {
72          "type": "object",
73          "properties": {
74            "is_active": {
75              "type": "boolean",
76              "description": "A flag that shows whether a Price Factory is active or not"
77            },
78            "currency": {
79              "type": "string",
80              "description": "Currency in which the prices of the products are specified"
81            },
82            "application_id": {
83              "type": "string",
84              "description": "Id of the application in which the Price Factory is created"
85            },
86            "factory_type_ids": {
87              "type": "array",
88              "description": "Ids of the price zones included in the Price Factory",
89              "items": {
90                "type": "string"
91              }
92            },
93            "factory_type": {
94              "description": "Type of the Factory",
95              "type": "string"
96            },
97            "department_ids": {
98              "description": "Ids of the departments that are included in the Price Factory",
99              "type": "array",
100              "items": {
101                "type": "integer"
102              }
103            },
104            "name": {
105              "description": "The name of the Price Factory",
106              "type": "string"
107            },
108            "_id": {
109              "description": "Unique identifier for Price Factory",
110              "type": "string"
111            }
112          },
113          "required": [
114            "_id",
115            "currency",
116            "application_id",
117            "factory_type_ids",
118            "department_ids",
119            "name",
120            "is_active",
121            "factory_type"
122          ]
123        }
124      }
125    }
126  },
127  "example": {
128    "payload": {
129      "price_factory": {
130        "is_active": true,
131        "currency": "INR",
132        "application_id": "66264d797ecb4a42e5bcde5d",
133        "factory_type_ids": [
134          "662752b83d8124610028196b",
135          "662a5366772c0622d00262c0",
136          "662a5379dba892d84e6d346b"
137        ],
138        "factory_type": "price_zone",
139        "department_ids": [
140          19
141        ],
142        "name": "Test Price Factory",
143        "_id": "662752b83d8124610028196b"
144      }
145    },
146    "meta": {
147      "event": {
148        "type": "create",
149        "name": "price-factory",
150        "version": "1"
151      },
152      "service": {
153        "name": "silverbolt"
154      },
155      "company_id": 29614,
156      "trace_id": [
157        "silverbolt.d4046446-217e-11ef-a8fd-d26548e01b13"
158      ],
159      "created_timestamp": 1717381607842,
160      "application_id": [
161        "66264d797ecb4a42e5bcde5d"
162      ]
163    }
164  }
165}

Payload Example

1{}

Was this section helpful?

price_factory/price_factory/update/v1

this event is triggered when price_factory is updated

Payload

Properties

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

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

event

object

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

Properties

price_factory

object

Properties

is_active

boolean

Required

A flag that shows whether a Price Factory is active or not

currency

string

Required

Currency in which the prices of the products are specified

application_id

string

Required

Id of the application in which the Price Factory is created

factory_type_ids

array of string

Required

Ids of the price zones included in the Price Factory

factory_type

string

Required

Type of the Factory

department_ids

array of integer

Required

Ids of the departments that are included in the Price Factory

name

string

Required

The name of the Price Factory

_id

string

Required

Unique identifier for Price Factory

Payload Schema JSON

1{
2  "type": "object",
3  "description": "Event emitted when a Price factory is updated",
4  "properties": {
5    "application_id": {
6      "type": [
7        "array",
8        "string"
9      ],
10      "description": "Application/sales channel ID for which this event is triggered"
11    },
12    "company_id": {
13      "type": "integer",
14      "description": "company ID for which this event is triggered"
15    },
16    "contains": {
17      "type": "array",
18      "description": "This array will have all the keys present at root level of 'payload' object",
19      "items": {
20        "type": "string"
21      }
22    },
23    "event": {
24      "type": "object",
25      "required": [
26        "category",
27        "created_timestamp",
28        "id",
29        "name",
30        "trace_id",
31        "type",
32        "version"
33      ],
34      "properties": {
35        "category": {
36          "type": "string",
37          "description": "category of the event. If it is at sales channel level or company level"
38        },
39        "created_timestamp": {
40          "type": "integer",
41          "description": "event generation timestamp in epoch milliseconds"
42        },
43        "id": {
44          "type": "string",
45          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
46        },
47        "name": {
48          "type": "string",
49          "description": "Name of the event"
50        },
51        "trace_id": {
52          "type": "array",
53          "description": "internal trace_id for Fynd Platform services",
54          "items": {
55            "type": "string"
56          }
57        },
58        "type": {
59          "type": "string",
60          "description": "Type/Action of the event. e.g. create/update/delete"
61        },
62        "version": {
63          "type": "string",
64          "description": "Version of the event."
65        }
66      }
67    },
68    "payload": {
69      "type": "object",
70      "properties": {
71        "price_factory": {
72          "type": "object",
73          "properties": {
74            "is_active": {
75              "type": "boolean",
76              "description": "A flag that shows whether a Price Factory is active or not"
77            },
78            "currency": {
79              "type": "string",
80              "description": "Currency in which the prices of the products are specified"
81            },
82            "application_id": {
83              "type": "string",
84              "description": "Id of the application in which the Price Factory is created"
85            },
86            "factory_type_ids": {
87              "type": "array",
88              "description": "Ids of the price zones included in the Price Factory",
89              "items": {
90                "type": "string"
91              }
92            },
93            "factory_type": {
94              "description": "Type of the Factory",
95              "type": "string"
96            },
97            "department_ids": {
98              "description": "Ids of the departments that are included in the Price Factory",
99              "type": "array",
100              "items": {
101                "type": "integer"
102              }
103            },
104            "name": {
105              "description": "The name of the Price Factory",
106              "type": "string"
107            },
108            "_id": {
109              "description": "Unique identifier for Price Factory",
110              "type": "string"
111            }
112          },
113          "required": [
114            "_id",
115            "currency",
116            "application_id",
117            "factory_type_ids",
118            "department_ids",
119            "name",
120            "is_active",
121            "factory_type"
122          ]
123        }
124      }
125    }
126  },
127  "example": {
128    "payload": {
129      "price_factory": {
130        "is_active": true,
131        "currency": "INR",
132        "application_id": "66264d797ecb4a42e5bcde5d",
133        "factory_type_ids": [
134          "662752b83d8124610028196b",
135          "662a5366772c0622d00262c0",
136          "662a5379dba892d84e6d346b"
137        ],
138        "factory_type": "price_zone",
139        "department_ids": [
140          19
141        ],
142        "name": "Test Price Factory",
143        "_id": "662752b83d8124610028196b"
144      }
145    },
146    "meta": {
147      "event": {
148        "type": "update",
149        "name": "price-factory",
150        "version": "1"
151      },
152      "service": {
153        "name": "silverbolt"
154      },
155      "company_id": 29614,
156      "trace_id": [
157        "silverbolt.d4046446-217e-11ef-a8fd-d26548e01b13"
158      ],
159      "created_timestamp": 1717381607842,
160      "application_id": [
161        "66264d797ecb4a42e5bcde5d"
162      ]
163    }
164  }
165}

Payload Example

1{}

Was this section helpful?