Product_bundle

Events categorized under product bundle level will be triggered when any action is performed on a product bundle, such as create, update.

Product bundle

This event is generated whenever any action is performed on a Product Bundle.

Events

product_bundle/product_bundle/create/v1

# This event is triggered when a product bundle is created.

product_bundle/product_bundle/update/v1

# This event is triggered when a product bundle is updated.

product_bundle/product_bundle/create/v1

This event is triggered when a product bundle is created.

Payload

Properties

payload

object

Properties

choice

string

Choice of product bundle, whether single or multi.

slug

string

Slug of the product bundle.

created_by

object

User who created the product bundle.

Properties

username

string

Username of the user who created the product bundle.

user_id

string

User ID of the user who created the product bundle.

products

array of object

Products in the product bundle.

Array of Properties

min_quantity

integer

Minimum quantity of the product.

max_quantity

integer

Maximum quantity of the product.

product_uid

integer

Product UID.

created_on

string

| date-time

Timestamp when the product bundle was created.

same_store_assignment

boolean

Flag that indicates if all the products in the bundle are assigned to the same store.

auto_add_to_cart

boolean

Flag that indicates if the product bundle is added to the cart automatically.

auto_select

boolean

Flag that indicates if the product bundle is selected automatically.

logo

string

Logo of the product bundle.

is_active

boolean

Flag that indicates if the product bundle is active or not.

meta

object

Custom Metadata allowing additional data

modified_on

string

| date-time

Timestamp when the product bundle was modified.

page_visibility

array of string

Key used to identify whether the bundle is visible on PDP or not.

Enum

allow_remove

boolean

Flag that indicates if individual products in the bundle can be removed.

company_id

integer

Unique identifier for the company.

name

string

Name of the product bundle.

string

Unique ID of the product bundle.

meta

object

Properties

event

object

Properties

name

string

Name of the event.

type

string

Type of the event, e.g., create, update.

version

string

Version of the event.

company_id

integer

Unique identifier for the company.

trace_id

array of string

Internal trace ID for Fynd Platform services.

created_timestamp

integer

Event generation timestamp in epoch milliseconds.

service

object

Properties

name

string

Name of the service.

Payload Schema JSON

1{
2  "type": "object",
3  "description": "Event emitted when a Product Bundle is created.",
4  "properties": {
5    "payload": {
6      "type": "object",
7      "properties": {
8        "choice": {
9          "type": "string",
10          "description": "Choice of product bundle, whether single or multi."
11        },
12        "slug": {
13          "type": "string",
14          "description": "Slug of the product bundle."
15        },
16        "created_by": {
17          "type": "object",
18          "description": "User who created the product bundle.",
19          "properties": {
20            "username": {
21              "type": "string",
22              "description": "Username of the user who created the product bundle."
23            },
24            "user_id": {
25              "type": "string",
26              "description": "User ID of the user who created the product bundle."
27            }
28          }
29        },
30        "products": {
31          "description": "Products in the product bundle.",
32          "type": "array",
33          "items": {
34            "type": "object",
35            "properties": {
36              "min_quantity": {
37                "type": "integer",
38                "description": "Minimum quantity of the product."
39              },
40              "max_quantity": {
41                "type": "integer",
42                "description": "Maximum quantity of the product."
43              },
44              "product_uid": {
45                "type": "integer",
46                "description": "Product UID."
47              }
48            }
49          }
50        },
51        "created_on": {
52          "type": "string",
53          "format": "date-time",
54          "description": "Timestamp when the product bundle was created."
55        },
56        "same_store_assignment": {
57          "type": "boolean",
58          "description": "Flag that indicates if all the products in the bundle are assigned to the same store."
59        },
60        "auto_add_to_cart": {
61          "type": "boolean",
62          "description": "Flag that indicates if the product bundle is added to the cart automatically."
63        },
64        "auto_select": {
65          "type": "boolean",
66          "description": "Flag that indicates if the product bundle is selected automatically."
67        },
68        "logo": {
69          "type": "string",
70          "description": "Logo of the product bundle."
71        },
72        "is_active": {
73          "type": "boolean",
74          "description": "Flag that indicates if the product bundle is active or not."
75        },
76        "meta": {
77          "type": "object",
78          "description": "Custom Metadata allowing additional data"
79        },
80        "modified_on": {
81          "type": "string",
82          "format": "date-time",
83          "description": "Timestamp when the product bundle was modified."
84        },
85        "page_visibility": {
86          "type": "array",
87          "enum": [
88            "pdp"
89          ],
90          "items": {
91            "type": "string"
92          },
93          "description": "Key used to identify whether the bundle is visible on PDP or not."
94        },
95        "allow_remove": {
96          "type": "boolean",
97          "description": "Flag that indicates if individual products in the bundle can be removed."
98        },
99        "company_id": {
100          "type": "integer",
101          "description": "Unique identifier for the company."
102        },
103        "name": {
104          "type": "string",
105          "description": "Name of the product bundle."
106        },
107        "id": {
108          "type": "string",
109          "description": "Unique ID of the product bundle."
110        }
111      }
112    },
113    "meta": {
114      "type": "object",
115      "properties": {
116        "event": {
117          "type": "object",
118          "properties": {
119            "name": {
120              "type": "string",
121              "description": "Name of the event."
122            },
123            "type": {
124              "type": "string",
125              "description": "Type of the event, e.g., create, update."
126            },
127            "version": {
128              "type": "string",
129              "description": "Version of the event."
130            }
131          }
132        },
133        "company_id": {
134          "type": "integer",
135          "description": "Unique identifier for the company."
136        },
137        "trace_id": {
138          "type": "array",
139          "items": {
140            "type": "string"
141          },
142          "description": "Internal trace ID for Fynd Platform services."
143        },
144        "created_timestamp": {
145          "type": "integer",
146          "description": "Event generation timestamp in epoch milliseconds."
147        },
148        "service": {
149          "type": "object",
150          "properties": {
151            "name": {
152              "type": "string",
153              "description": "Name of the service."
154            }
155          }
156        }
157      }
158    }
159  },
160  "example": {
161    "payload": {
162      "choice": "multi",
163      "slug": "ritik-bun-test1",
164      "created_by": {
165        "username": "rajamishra_gofynd_com_02316",
166        "user_id": "61bb02b3e4a82983f7236aa0"
167      },
168      "products": [
169        {
170          "min_quantity": 1,
171          "max_quantity": 1,
172          "product_uid": 8105847
173        }
174      ],
175      "created_on": "2024-07-28T20:51:22.153597",
176      "same_store_assignment": true,
177      "auto_add_to_cart": true,
178      "auto_select": false,
179      "logo": null,
180      "is_active": true,
181      "meta": {},
182      "modified_on": "2024-07-28T20:51:22.153607",
183      "page_visibility": [
184        "pdp"
185      ],
186      "allow_remove": true,
187      "company_id": 2,
188      "name": "ritik bun test",
189      "id": "66a6af4a31722f262218254c"
190    },
191    "meta": {
192      "event": {
193        "name": "product-bundle",
194        "type": "create",
195        "version": "1"
196      },
197      "company_id": 2,
198      "trace_id": [
199        "silverbolt.2597915a-4d23-11ef-86e4-823cc4225ac5"
200      ],
201      "created_timestamp": 1722199882165,
202      "service": {
203        "name": "silverbolt"
204      }
205    }
206  }
207}

Payload Example

1{}

Was this section helpful?

product_bundle/product_bundle/update/v1

This event is triggered when a product bundle is updated.

Payload

Properties

payload

object

Properties

choice

string

Choice of product bundle, whether single or multi.

slug

string

Slug of the product bundle.

products

array of object

Products in the product bundle.

Array of Properties

min_quantity

integer

Minimum quantity of the product.

max_quantity

integer

Maximum quantity of the product.

product_uid

integer

Product UID.

modified_on

string

| date-time

Timestamp when the product bundle was modified.

same_store_assignment

boolean

Flag that indicates if all the products in the bundle are assigned to the same store.

auto_add_to_cart

boolean

Flag that indicates if the product bundle is added to the cart automatically.

auto_select

boolean

Flag that indicates if the product bundle is selected automatically.

logo

string

Logo of the product bundle.

is_active

boolean

Flag that indicates if the product bundle is active or not.

meta

object

Custom Metadata allowing additional data.

page_visibility

array of string

Key used to identify whether the bundle is visible on PDP or not.

Enum

allow_remove

boolean

Flag that indicates if individual products in the bundle can be removed.

company_id

integer

Unique identifier for the company.

string

ID of the product bundle.

meta

object

Properties

event

object

Properties

name

string

Name of the event.

type

string

Type of the event.

version

string

Version of the event.

company_id

integer

Unique identifier for the company.

trace_id

array of string

Internal trace ID for Fynd Platform services.

created_timestamp

integer

Event generation timestamp in epoch milliseconds.

service

object

Properties

name

string

Name of the service.

Payload Schema JSON

1{
2  "type": "object",
3  "description": "Event emitted when a Product Bundle is updated.",
4  "properties": {
5    "payload": {
6      "type": "object",
7      "properties": {
8        "choice": {
9          "type": "string",
10          "description": "Choice of product bundle, whether single or multi."
11        },
12        "slug": {
13          "type": "string",
14          "description": "Slug of the product bundle."
15        },
16        "products": {
17          "type": "array",
18          "description": "Products in the product bundle.",
19          "items": {
20            "type": "object",
21            "properties": {
22              "min_quantity": {
23                "type": "integer",
24                "description": "Minimum quantity of the product."
25              },
26              "max_quantity": {
27                "type": "integer",
28                "description": "Maximum quantity of the product."
29              },
30              "product_uid": {
31                "type": "integer",
32                "description": "Product UID."
33              }
34            }
35          }
36        },
37        "modified_on": {
38          "type": "string",
39          "format": "date-time",
40          "description": "Timestamp when the product bundle was modified."
41        },
42        "same_store_assignment": {
43          "type": "boolean",
44          "description": "Flag that indicates if all the products in the bundle are assigned to the same store."
45        },
46        "auto_add_to_cart": {
47          "type": "boolean",
48          "description": "Flag that indicates if the product bundle is added to the cart automatically."
49        },
50        "auto_select": {
51          "type": "boolean",
52          "description": "Flag that indicates if the product bundle is selected automatically."
53        },
54        "logo": {
55          "type": "string",
56          "description": "Logo of the product bundle."
57        },
58        "is_active": {
59          "type": "boolean",
60          "description": "Flag that indicates if the product bundle is active or not."
61        },
62        "meta": {
63          "type": "object",
64          "description": "Custom Metadata allowing additional data."
65        },
66        "page_visibility": {
67          "type": "array",
68          "enum": [
69            "pdp"
70          ],
71          "items": {
72            "type": "string"
73          },
74          "description": "Key used to identify whether the bundle is visible on PDP or not."
75        },
76        "allow_remove": {
77          "type": "boolean",
78          "description": "Flag that indicates if individual products in the bundle can be removed."
79        },
80        "company_id": {
81          "type": "integer",
82          "description": "Unique identifier for the company."
83        },
84        "id": {
85          "type": "string",
86          "description": "ID of the product bundle."
87        }
88      }
89    },
90    "meta": {
91      "type": "object",
92      "properties": {
93        "event": {
94          "type": "object",
95          "properties": {
96            "name": {
97              "type": "string",
98              "description": "Name of the event."
99            },
100            "type": {
101              "type": "string",
102              "description": "Type of the event."
103            },
104            "version": {
105              "type": "string",
106              "description": "Version of the event."
107            }
108          }
109        },
110        "company_id": {
111          "type": "integer",
112          "description": "Unique identifier for the company."
113        },
114        "trace_id": {
115          "type": "array",
116          "items": {
117            "type": "string"
118          },
119          "description": "Internal trace ID for Fynd Platform services."
120        },
121        "created_timestamp": {
122          "type": "integer",
123          "description": "Event generation timestamp in epoch milliseconds."
124        },
125        "service": {
126          "type": "object",
127          "properties": {
128            "name": {
129              "type": "string",
130              "description": "Name of the service."
131            }
132          }
133        }
134      }
135    }
136  },
137  "example": {
138    "payload": {
139      "choice": "multi",
140      "slug": "ritik-bun-test1",
141      "products": [
142        {
143          "min_quantity": 1,
144          "max_quantity": 1,
145          "product_uid": 8105847
146        }
147      ],
148      "modified_on": "2024-07-29T04:44:03.030660",
149      "same_store_assignment": true,
150      "auto_add_to_cart": true,
151      "auto_select": false,
152      "logo": "",
153      "is_active": true,
154      "meta": {},
155      "page_visibility": [
156        "pdp"
157      ],
158      "allow_remove": true,
159      "company_id": 2,
160      "id": "66a6b05dba0d2a4e48c9285f"
161    },
162    "meta": {
163      "event": {
164        "name": "product-bundle",
165        "type": "update",
166        "version": "1"
167      },
168      "company_id": 2,
169      "trace_id": [
170        "silverbolt.2e089f7c-4d65-11ef-8d8c-823cc4225ac5"
171      ],
172      "created_timestamp": 1722228243112,
173      "service": {
174        "name": "silverbolt"
175      }
176    }
177  }
178}

Payload Example

1{}

Was this section helpful?