@gofynd/fdk-client-javascript 1.0.3 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. package/README.md +31 -2
  2. package/index.d.ts +4 -4
  3. package/index.js +9 -10
  4. package/package.json +14 -14
  5. package/sdk/APIClient.d.ts +11 -0
  6. package/sdk/APIClient.js +35 -0
  7. package/sdk/Client.d.ts +6 -0
  8. package/sdk/Client.js +17 -0
  9. package/sdk/Config.d.ts +9 -0
  10. package/sdk/Config.js +17 -0
  11. package/sdk/application/Cart/CartApplicationClient.js +29 -28
  12. package/sdk/application/Cart/CartApplicationModel.js +3 -1
  13. package/sdk/application/Catalog/CatalogApplicationClient.js +43 -42
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +1 -1
  15. package/sdk/application/Common/CommonApplicationClient.js +5 -4
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -5
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.js +21 -20
  18. package/sdk/application/Content/ContentApplicationClient.js +26 -25
  19. package/sdk/application/Content/ContentApplicationModel.js +1 -0
  20. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -5
  21. package/sdk/application/Lead/LeadApplicationClient.js +10 -9
  22. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -3
  23. package/sdk/application/Logistic/LogisticApplicationClient.js +11 -12
  24. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -1
  25. package/sdk/application/Order/OrderApplicationClient.js +15 -14
  26. package/sdk/application/Order/OrderApplicationModel.js +9 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.js +42 -41
  28. package/sdk/application/PosCart/PosCartApplicationClient.js +30 -29
  29. package/sdk/application/PosCart/PosCartApplicationModel.js +3 -1
  30. package/sdk/application/Rewards/RewardsApplicationClient.js +11 -10
  31. package/sdk/application/Share/ShareApplicationClient.js +10 -9
  32. package/sdk/application/Theme/ThemeApplicationClient.js +7 -6
  33. package/sdk/application/User/UserApplicationClient.js +38 -37
  34. package/sdk/common/AxiosHelper.js +17 -6
  35. package/sdk/constructUrl.d.ts +5 -0
  36. package/sdk/constructUrl.js +13 -0
  37. package/sdk/index.d.ts +3 -0
  38. package/sdk/index.js +5 -0
  39. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -1
  40. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  41. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  42. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  43. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -2
  44. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +1 -0
  45. package/sdk/platform/Billing/BillingPlatformClient.js +3 -2
  46. package/sdk/platform/Billing/BillingPlatformValidator.js +1 -0
  47. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +27 -0
  48. package/sdk/platform/Cart/CartPlatformApplicationClient.js +177 -1
  49. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +3 -0
  50. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +17 -1
  51. package/sdk/platform/Cart/CartPlatformModel.js +7 -3
  52. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +3 -1
  53. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +1 -1
  54. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  55. package/sdk/platform/Catalog/CatalogPlatformClient.js +6 -9
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +7 -7
  57. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -1
  58. package/sdk/platform/Common/CommonPlatformClient.js +7 -18
  59. package/sdk/platform/Common/CommonPlatformValidator.js +1 -0
  60. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3 -1
  61. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -1
  62. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  63. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  64. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +5 -4
  65. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +1 -0
  66. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -1
  67. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +1 -1
  68. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +9 -8
  69. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +1 -0
  70. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  71. package/sdk/platform/Content/ContentPlatformApplicationClient.js +3 -62
  72. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +0 -1
  73. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +1 -7
  74. package/sdk/platform/Content/ContentPlatformModel.js +1 -0
  75. package/sdk/platform/Discount/DiscountPlatformClient.js +3 -2
  76. package/sdk/platform/Discount/DiscountPlatformValidator.js +1 -0
  77. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +3 -3
  78. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +27 -5
  79. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +1 -1
  80. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +3 -3
  81. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -6
  82. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +1 -0
  83. package/sdk/platform/Inventory/InventoryPlatformClient.js +3 -2
  84. package/sdk/platform/Inventory/InventoryPlatformValidator.js +1 -0
  85. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +3 -1
  86. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +1 -1
  87. package/sdk/platform/Lead/LeadPlatformClient.js +4 -3
  88. package/sdk/platform/Lead/LeadPlatformValidator.js +1 -0
  89. package/sdk/platform/Order/OrderPlatformApplicationClient.js +3 -1
  90. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +1 -1
  91. package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
  92. package/sdk/platform/Order/OrderPlatformClient.js +16 -3
  93. package/sdk/platform/Order/OrderPlatformModel.js +1 -0
  94. package/sdk/platform/Order/OrderPlatformValidator.js +1 -0
  95. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  96. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  97. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
  98. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +14 -14
  99. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +1 -1
  100. package/sdk/platform/Payment/PaymentPlatformClient.js +3 -2
  101. package/sdk/platform/Payment/PaymentPlatformValidator.js +1 -0
  102. package/sdk/platform/PlatformClient.d.ts +13 -9
  103. package/sdk/platform/PlatformClient.js +13 -9
  104. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +4 -4
  105. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +36 -17
  106. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +1 -1
  107. package/sdk/platform/Share/SharePlatformApplicationClient.js +3 -1
  108. package/sdk/platform/Share/SharePlatformApplicationValidator.js +1 -1
  109. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +3 -1
  110. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +1 -1
  111. package/sdk/platform/User/UserPlatformApplicationClient.js +3 -1
  112. package/sdk/platform/User/UserPlatformApplicationValidator.js +1 -1
  113. package/sdk/platform/Webhook/WebhookPlatformClient.js +3 -2
  114. package/sdk/platform/Webhook/WebhookPlatformValidator.js +1 -0
  115. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -0
  116. package/sdk/public/Inventory/InventoryPublicClient.js +2 -0
  117. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  118. package/.github/workflows/on_create_release.yml +0 -23
  119. package/.github/workflows/on_merge_main.yml +0 -38
  120. package/.github/workflows/on_pull_request.yml +0 -35
  121. package/.prettierrc +0 -5
  122. package/documentation/application/CART.md +0 -8771
  123. package/documentation/application/CATALOG.md +0 -8690
  124. package/documentation/application/COMMON.md +0 -325
  125. package/documentation/application/COMMUNICATION.md +0 -387
  126. package/documentation/application/CONFIGURATION.md +0 -2212
  127. package/documentation/application/CONTENT.md +0 -2629
  128. package/documentation/application/FILESTORAGE.md +0 -442
  129. package/documentation/application/LEAD.md +0 -1549
  130. package/documentation/application/LOGISTIC.md +0 -689
  131. package/documentation/application/ORDER.md +0 -2937
  132. package/documentation/application/PAYMENT.md +0 -4475
  133. package/documentation/application/POSCART.md +0 -9375
  134. package/documentation/application/README.md +0 -21
  135. package/documentation/application/REWARDS.md +0 -554
  136. package/documentation/application/SHARE.md +0 -635
  137. package/documentation/application/THEME.md +0 -5517
  138. package/documentation/application/USER.md +0 -3798
  139. package/documentation/platform/ANALYTICS.md +0 -1012
  140. package/documentation/platform/AUDITTRAIL.md +0 -493
  141. package/documentation/platform/BILLING.md +0 -1889
  142. package/documentation/platform/CART.md +0 -4711
  143. package/documentation/platform/CATALOG.md +0 -20522
  144. package/documentation/platform/COMMON.md +0 -325
  145. package/documentation/platform/COMMUNICATION.md +0 -4970
  146. package/documentation/platform/COMPANYPROFILE.md +0 -1646
  147. package/documentation/platform/CONFIGURATION.md +0 -6316
  148. package/documentation/platform/CONTENT.md +0 -8364
  149. package/documentation/platform/DISCOUNT.md +0 -767
  150. package/documentation/platform/FILESTORAGE.md +0 -945
  151. package/documentation/platform/INVENTORY.md +0 -1136
  152. package/documentation/platform/LEAD.md +0 -4394
  153. package/documentation/platform/ORDER.md +0 -6525
  154. package/documentation/platform/PARTNER.md +0 -193
  155. package/documentation/platform/PAYMENT.md +0 -3138
  156. package/documentation/platform/README.md +0 -27
  157. package/documentation/platform/REWARDS.md +0 -919
  158. package/documentation/platform/SHARE.md +0 -513
  159. package/documentation/platform/THEME.md +0 -35446
  160. package/documentation/platform/USER.md +0 -2174
  161. package/documentation/platform/WEBHOOK.md +0 -485
  162. package/documentation/public/CONFIGURATION.md +0 -325
  163. package/documentation/public/INVENTORY.md +0 -508
  164. package/documentation/public/WEBHOOK.md +0 -246
  165. package/jest.config.d.ts +0 -4
  166. package/jest.config.js +0 -6
  167. package/tests/application/catalog.spec.js +0 -54
  168. package/tests/common/action-url.spec.js +0 -35
  169. package/tests/common/schema/action-url.json +0 -178
  170. package/tests/common/schema/url-action.json +0 -683
  171. package/tests/common/url-action.spec.js +0 -48
  172. package/tests/helpers/cookie.helper.js +0 -31
  173. package/tests/helpers/oauth.helper.js +0 -43
  174. package/tests/platform/catalog.spec.js +0 -49
  175. package/tests/public/location.spec.js +0 -39
@@ -1,4711 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
- ##### [Back to Platform docs](./README.md)
7
-
8
- ## Cart Methods
9
- Cart APIs
10
-
11
- * [addItems](#additems)
12
- * [checkCartServiceability](#checkcartserviceability)
13
- * [checkoutCart](#checkoutcart)
14
- * [createCoupon](#createcoupon)
15
- * [createPromotion](#createpromotion)
16
- * [fetchAndvalidateCartItems](#fetchandvalidatecartitems)
17
- * [getAbandonedCart](#getabandonedcart)
18
- * [getAbandonedCartDetails](#getabandonedcartdetails)
19
- * [getCouponById](#getcouponbyid)
20
- * [getCoupons](#getcoupons)
21
- * [getPromotionById](#getpromotionbyid)
22
- * [getPromotions](#getpromotions)
23
- * [updateCart](#updatecart)
24
- * [updateCoupon](#updatecoupon)
25
- * [updateCouponPartially](#updatecouponpartially)
26
- * [updatePromotion](#updatepromotion)
27
- * [updatePromotionPartially](#updatepromotionpartially)
28
-
29
-
30
-
31
- ## Methods with example and description
32
-
33
-
34
-
35
-
36
- ### addItems
37
- Add items to abandoned cart
38
-
39
-
40
-
41
- ```javascript
42
- // Promise
43
- const promise = client.application("<APPLICATION_ID>").cart.addItems({ cartId : value,
44
- body : value,
45
- b : value });
46
-
47
- // Async/Await
48
- const data = await client.application("<APPLICATION_ID>").cart.addItems({ cartId : value,
49
- body : value,
50
- b : value });
51
- ```
52
-
53
-
54
-
55
-
56
-
57
- | Argument | Type | Required | Description |
58
- | --------- | ----- | -------- | ----------- |
59
- | cartId | string | yes | Current Cart _id |
60
- | b | boolean | no | |
61
- | body | [AddCartRequest](#AddCartRequest) | yes | Request body |
62
-
63
-
64
- Use this API to add items to the abandoned cart.
65
-
66
- *Returned Response:*
67
-
68
-
69
-
70
-
71
- [AddCartDetailResponse](#AddCartDetailResponse)
72
-
73
- Success. Returns a cart object as shown below. Refer `AddCartDetailResponse` for more details.
74
-
75
-
76
-
77
-
78
- <details>
79
- <summary><i>&nbsp; Examples:</i></summary>
80
-
81
-
82
- <details>
83
- <summary><i>&nbsp; Product has been added to your cart</i></summary>
84
-
85
- ```json
86
- {
87
- "value": {
88
- "message": "Product has been added to your cart",
89
- "success": true,
90
- "cart": {
91
- "breakup_values": {
92
- "display": [
93
- {
94
- "display": "MRP Total",
95
- "key": "mrp_total",
96
- "value": 17486,
97
- "currency_code": "INR"
98
- },
99
- {
100
- "display": "Discount",
101
- "key": "discount",
102
- "value": -3540,
103
- "currency_code": "INR"
104
- },
105
- {
106
- "display": "Subtotal",
107
- "key": "subtotal",
108
- "value": 13946,
109
- "currency_code": "INR"
110
- },
111
- {
112
- "display": "Total",
113
- "key": "total",
114
- "value": 13946,
115
- "currency_code": "INR"
116
- }
117
- ],
118
- "raw": {
119
- "cod_charge": 0,
120
- "convenience_fee": 0,
121
- "coupon": 0,
122
- "delivery_charge": 0,
123
- "discount": -3540,
124
- "fynd_cash": 0,
125
- "gst_charges": 1529.96,
126
- "mrp_total": 17486,
127
- "subtotal": 13946,
128
- "total": 13946,
129
- "vog": 12416.04,
130
- "you_saved": 0
131
- },
132
- "loyalty_points": {
133
- "total": 0,
134
- "applicable": 0,
135
- "is_applied": false,
136
- "description": "Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."
137
- },
138
- "coupon": {
139
- "type": "cash",
140
- "code": "",
141
- "uid": null,
142
- "value": 0,
143
- "is_applied": false,
144
- "message": "Sorry! Invalid Coupon"
145
- }
146
- },
147
- "items": [
148
- {
149
- "key": "751083_10",
150
- "parent_item_identifiers": {
151
- "identifier": "ZASFF",
152
- "parent_item_id": 7501190,
153
- "parent_item_size": "OS"
154
- },
155
- "article": {
156
- "type": "article",
157
- "uid": "612_9_SE61201_19100302_10",
158
- "size": "10",
159
- "seller": {
160
- "uid": 612,
161
- "name": "SSR ENTERPRISE"
162
- },
163
- "store": {
164
- "uid": 4431,
165
- "name": "Motilal Nagar 1, Goregaon"
166
- },
167
- "quantity": 4,
168
- "price": {
169
- "base": {
170
- "marked": 3999,
171
- "effective": 2399,
172
- "currency_code": "INR"
173
- },
174
- "converted": {
175
- "marked": 3999,
176
- "effective": 2399,
177
- "currency_code": "INR"
178
- }
179
- }
180
- },
181
- "price": {
182
- "base": {
183
- "add_on": 4798,
184
- "marked": 7998,
185
- "effective": 4798,
186
- "selling": 4798,
187
- "currency_code": "INR"
188
- },
189
- "converted": {
190
- "add_on": 4798,
191
- "marked": 7998,
192
- "effective": 4798,
193
- "selling": 4798,
194
- "currency_code": "INR"
195
- }
196
- },
197
- "availability": {
198
- "sizes": [
199
- "10"
200
- ],
201
- "other_store_quantity": 2,
202
- "out_of_stock": false,
203
- "deliverable": true,
204
- "is_valid": true
205
- },
206
- "product": {
207
- "type": "product",
208
- "uid": 751083,
209
- "name": "Carson 2",
210
- "slug": "puma-carson-2-751083-6ad98d",
211
- "brand": {
212
- "uid": 9,
213
- "name": "Puma"
214
- },
215
- "categories": [
216
- {
217
- "uid": 165,
218
- "name": "Outdoor Sports Shoes"
219
- }
220
- ],
221
- "images": [
222
- {
223
- "aspect_ratio": "16:25",
224
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/9_19100302/1_1542807042296.jpg",
225
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/9_19100302/1_1542807042296.jpg"
226
- }
227
- ],
228
- "action": {
229
- "type": "product",
230
- "url": "https://api.addsale.com/platform/content/v1/products/puma-carson-2-751083-6ad98d/",
231
- "query": {
232
- "product_slug": [
233
- "puma-carson-2-751083-6ad98d"
234
- ]
235
- }
236
- }
237
- },
238
- "coupon_message": "",
239
- "quantity": 2,
240
- "message": "",
241
- "bulk_offer": {},
242
- "discount": "41% OFF"
243
- },
244
- {
245
- "key": "246228_S",
246
- "article": {
247
- "type": "article",
248
- "uid": "46_235_TM62_M11029ONDSXNS_S",
249
- "size": "S",
250
- "seller": {
251
- "uid": 46,
252
- "name": "RELIANCE BRANDS LIMITED"
253
- },
254
- "store": {
255
- "uid": 4550,
256
- "name": "VR Mall"
257
- },
258
- "quantity": 1,
259
- "price": {
260
- "base": {
261
- "marked": 4490,
262
- "effective": 4490,
263
- "currency_code": "INR"
264
- },
265
- "converted": {
266
- "marked": 4490,
267
- "effective": 4490,
268
- "currency_code": "INR"
269
- }
270
- }
271
- },
272
- "price": {
273
- "base": {
274
- "add_on": 4490,
275
- "marked": 4490,
276
- "effective": 4490,
277
- "selling": 4490,
278
- "currency_code": "INR"
279
- },
280
- "converted": {
281
- "add_on": 4490,
282
- "marked": 4490,
283
- "effective": 4490,
284
- "selling": 4490,
285
- "currency_code": "INR"
286
- }
287
- },
288
- "availability": {
289
- "sizes": [
290
- "L",
291
- "M",
292
- "S",
293
- "XL",
294
- "XXL"
295
- ],
296
- "other_store_quantity": 0,
297
- "out_of_stock": false,
298
- "deliverable": true,
299
- "is_valid": true
300
- },
301
- "product": {
302
- "type": "product",
303
- "uid": 246228,
304
- "name": "Blue Solid T-Shirt",
305
- "slug": "superdry-blue-solid-t-shirt-2",
306
- "brand": {
307
- "uid": 235,
308
- "name": "Superdry"
309
- },
310
- "categories": [
311
- {
312
- "uid": 192,
313
- "name": "T-Shirts"
314
- }
315
- ],
316
- "images": [
317
- {
318
- "aspect_ratio": "16:25",
319
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/235_M11029ONDSXNS/1.jpg",
320
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/235_M11029ONDSXNS/1.jpg"
321
- }
322
- ],
323
- "action": {
324
- "type": "product",
325
- "url": "https://api.addsale.com/platform/content/v1/products/superdry-blue-solid-t-shirt-2/",
326
- "query": {
327
- "product_slug": [
328
- "superdry-blue-solid-t-shirt-2"
329
- ]
330
- }
331
- }
332
- },
333
- "coupon_message": "",
334
- "quantity": 1,
335
- "message": "",
336
- "bulk_offer": {},
337
- "discount": ""
338
- },
339
- {
340
- "key": "443175_S",
341
- "article": {
342
- "type": "article",
343
- "uid": "162_207_1271_LJ03LBLUDN88_S",
344
- "size": "S",
345
- "seller": {
346
- "uid": 162,
347
- "name": "GO FASHION INDIA PRIVATE LIMITED"
348
- },
349
- "store": {
350
- "uid": 5784,
351
- "name": "Vega City mall"
352
- },
353
- "quantity": 3,
354
- "price": {
355
- "base": {
356
- "marked": 1599,
357
- "effective": 1599,
358
- "currency_code": "INR"
359
- },
360
- "converted": {
361
- "marked": 1599,
362
- "effective": 1599,
363
- "currency_code": "INR"
364
- }
365
- }
366
- },
367
- "price": {
368
- "base": {
369
- "add_on": 1599,
370
- "marked": 1599,
371
- "effective": 1599,
372
- "selling": 1599,
373
- "currency_code": "INR"
374
- },
375
- "converted": {
376
- "add_on": 1599,
377
- "marked": 1599,
378
- "effective": 1599,
379
- "selling": 1599,
380
- "currency_code": "INR"
381
- }
382
- },
383
- "availability": {
384
- "sizes": [
385
- "XL",
386
- "M",
387
- "L",
388
- "S"
389
- ],
390
- "other_store_quantity": 8,
391
- "out_of_stock": false,
392
- "deliverable": true,
393
- "is_valid": true
394
- },
395
- "product": {
396
- "type": "product",
397
- "uid": 443175,
398
- "name": "Light Blue Denim Jeggings",
399
- "slug": "go-colors-light-blue-denim-jeggings-443175-3c688c",
400
- "brand": {
401
- "uid": 207,
402
- "name": "Go Colors"
403
- },
404
- "categories": [
405
- {
406
- "uid": 267,
407
- "name": "Jeggings"
408
- }
409
- ],
410
- "images": [
411
- {
412
- "aspect_ratio": "16:25",
413
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/207_LJ03LBLUDN88/1_1512382513548.jpg",
414
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/207_LJ03LBLUDN88/1_1512382513548.jpg"
415
- }
416
- ],
417
- "action": {
418
- "type": "product",
419
- "url": "https://api.addsale.com/platform/content/v1/products/go-colors-light-blue-denim-jeggings-443175-3c688c/",
420
- "query": {
421
- "product_slug": [
422
- "go-colors-light-blue-denim-jeggings-443175-3c688c"
423
- ]
424
- }
425
- }
426
- },
427
- "coupon_message": "",
428
- "quantity": 1,
429
- "message": "",
430
- "bulk_offer": {},
431
- "discount": ""
432
- },
433
- {
434
- "key": "778937_OS",
435
- "article": {
436
- "type": "article",
437
- "uid": "686_963_IC68601_PWUPC01977_OS",
438
- "size": "OS",
439
- "seller": {
440
- "uid": 686,
441
- "name": "INDUS CORPORATION"
442
- },
443
- "store": {
444
- "uid": 5059,
445
- "name": "Vidyaranyapura Main Road"
446
- },
447
- "quantity": 3,
448
- "price": {
449
- "base": {
450
- "marked": 3399,
451
- "effective": 3059,
452
- "currency_code": "INR"
453
- },
454
- "converted": {
455
- "marked": 3399,
456
- "effective": 3059,
457
- "currency_code": "INR"
458
- }
459
- }
460
- },
461
- "price": {
462
- "base": {
463
- "add_on": 3059,
464
- "marked": 3399,
465
- "effective": 3059,
466
- "selling": 3059,
467
- "currency_code": "INR"
468
- },
469
- "converted": {
470
- "add_on": 3059,
471
- "marked": 3399,
472
- "effective": 3059,
473
- "selling": 3059,
474
- "currency_code": "INR"
475
- }
476
- },
477
- "availability": {
478
- "sizes": [
479
- "OS"
480
- ],
481
- "other_store_quantity": 2,
482
- "out_of_stock": false,
483
- "deliverable": true,
484
- "is_valid": true
485
- },
486
- "product": {
487
- "type": "product",
488
- "uid": 778937,
489
- "name": "Colourful Carnival Bouncer",
490
- "slug": "fisher-price-colourful-carnival-bouncer-778937-fafa1f",
491
- "brand": {
492
- "uid": 963,
493
- "name": "Fisher-Price"
494
- },
495
- "categories": [
496
- {
497
- "uid": 576,
498
- "name": "Cradles"
499
- }
500
- ],
501
- "images": [
502
- {
503
- "aspect_ratio": "16:25",
504
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/963_PWUPC01977/1_1545308400588.jpg",
505
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/963_PWUPC01977/1_1545308400588.jpg"
506
- }
507
- ],
508
- "action": {
509
- "type": "product",
510
- "url": "https://api.addsale.com/platform/content/v1/products/fisher-price-colourful-carnival-bouncer-778937-fafa1f/",
511
- "query": {
512
- "product_slug": [
513
- "fisher-price-colourful-carnival-bouncer-778937-fafa1f"
514
- ]
515
- }
516
- }
517
- },
518
- "coupon_message": "",
519
- "quantity": 1,
520
- "message": "",
521
- "bulk_offer": {},
522
- "discount": "11% OFF"
523
- }
524
- ],
525
- "delivery_charge_info": "",
526
- "coupon_text": "View all offers",
527
- "buy_now": false,
528
- "cart_id": 7927,
529
- "uid": "7927",
530
- "gstin": null,
531
- "checkout_mode": "self",
532
- "last_modified": "Tue, 03 Sep 2019 06:00:43 GMT",
533
- "restrict_checkout": false,
534
- "is_valid": true
535
- },
536
- "result": {}
537
- }
538
- }
539
- ```
540
- </details>
541
-
542
- <details>
543
- <summary><i>&nbsp; Sorry, item is out of stock</i></summary>
544
-
545
- ```json
546
- {
547
- "value": {
548
- "message": "Sorry, item is out of stock",
549
- "success": false,
550
- "cart": {
551
- "breakup_values": {
552
- "raw": {
553
- "cod_charge": 0,
554
- "convenience_fee": 0,
555
- "coupon": 0,
556
- "delivery_charge": 0,
557
- "discount": -202000,
558
- "fynd_cash": 0,
559
- "gst_charges": 4804.71,
560
- "mrp_total": 302899,
561
- "subtotal": 100899,
562
- "total": 100899,
563
- "vog": 96094.29,
564
- "you_saved": 0
565
- },
566
- "coupon": {
567
- "type": "cash",
568
- "code": "",
569
- "uid": null,
570
- "value": 0,
571
- "is_applied": false,
572
- "message": "Sorry! Invalid Coupon"
573
- },
574
- "display": [
575
- {
576
- "display": "MRP Total",
577
- "key": "mrp_total",
578
- "value": 302899,
579
- "currency_code": "INR"
580
- },
581
- {
582
- "display": "Discount",
583
- "key": "discount",
584
- "value": -202000,
585
- "currency_code": "INR"
586
- },
587
- {
588
- "display": "Subtotal",
589
- "key": "subtotal",
590
- "value": 100899,
591
- "currency_code": "INR"
592
- },
593
- {
594
- "display": "Total",
595
- "key": "total",
596
- "value": 100899,
597
- "currency_code": "INR"
598
- }
599
- ],
600
- "loyalty_points": {
601
- "total": 0,
602
- "applicable": 0,
603
- "is_applied": false,
604
- "description": "Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."
605
- }
606
- },
607
- "items": [
608
- {
609
- "bulk_offer": {},
610
- "discount": "67% OFF",
611
- "parent_item_identifiers": {
612
- "identifier": "ZASFF",
613
- "parent_item_id": 7501190,
614
- "parent_item_size": "OS"
615
- },
616
- "article": {
617
- "type": "article",
618
- "uid": "604_902_SSTC60401_636BLUE_1",
619
- "size": "1",
620
- "seller": {
621
- "uid": 604,
622
- "name": "SHRI SHANTINATH TRADING COMPANY"
623
- },
624
- "store": {
625
- "uid": 4579,
626
- "name": "Gandhi Nagar"
627
- },
628
- "quantity": 108,
629
- "price": {
630
- "base": {
631
- "marked": 2999,
632
- "effective": 999,
633
- "currency_code": "INR"
634
- },
635
- "converted": {
636
- "marked": 2999,
637
- "effective": 999,
638
- "currency_code": "INR"
639
- }
640
- }
641
- },
642
- "coupon_message": "",
643
- "key": "707569_1",
644
- "availability": {
645
- "sizes": [
646
- "1",
647
- "8",
648
- "7",
649
- "2",
650
- "9",
651
- "5",
652
- "3",
653
- "6"
654
- ],
655
- "other_store_quantity": 7,
656
- "out_of_stock": false,
657
- "deliverable": true,
658
- "is_valid": true
659
- },
660
- "product": {
661
- "type": "product",
662
- "uid": 707569,
663
- "name": "Blue and Gold Printed Ethnic Set",
664
- "slug": "aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a",
665
- "brand": {
666
- "uid": 902,
667
- "name": ""
668
- },
669
- "categories": [
670
- {
671
- "uid": 525,
672
- "name": ""
673
- }
674
- ],
675
- "images": [
676
- {
677
- "aspect_ratio": "16:25",
678
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg",
679
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"
680
- }
681
- ],
682
- "action": {
683
- "type": "product",
684
- "url": "https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/",
685
- "query": {
686
- "product_slug": [
687
- "aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"
688
- ]
689
- }
690
- }
691
- },
692
- "price": {
693
- "base": {
694
- "add_on": 100899,
695
- "marked": 302899,
696
- "effective": 100899,
697
- "selling": 100899,
698
- "currency_code": "INR"
699
- },
700
- "converted": {
701
- "add_on": 100899,
702
- "marked": 302899,
703
- "effective": 100899,
704
- "selling": 100899,
705
- "currency_code": "INR"
706
- }
707
- },
708
- "message": "",
709
- "quantity": 101
710
- }
711
- ],
712
- "delivery_charge_info": "",
713
- "coupon_text": "View all offers",
714
- "buy_now": false,
715
- "cart_id": 54,
716
- "uid": "54",
717
- "gstin": null,
718
- "checkout_mode": "self",
719
- "restrict_checkout": false,
720
- "is_valid": false,
721
- "last_modified": "Tue, 03 Sep 2019 09:55:40 GMT"
722
- },
723
- "result": {}
724
- }
725
- }
726
- ```
727
- </details>
728
-
729
- </details>
730
-
731
-
732
-
733
-
734
-
735
-
736
-
737
-
738
-
739
- ---
740
-
741
-
742
- ### checkCartServiceability
743
- Check Pincode Serviceability
744
-
745
-
746
-
747
- ```javascript
748
- // Promise
749
- const promise = client.application("<APPLICATION_ID>").cart.checkCartServiceability({ body : value });
750
-
751
- // Async/Await
752
- const data = await client.application("<APPLICATION_ID>").cart.checkCartServiceability({ body : value });
753
- ```
754
-
755
-
756
-
757
-
758
-
759
- | Argument | Type | Required | Description |
760
- | --------- | ----- | -------- | ----------- |
761
- | body | [OpenApiCartServiceabilityRequest](#OpenApiCartServiceabilityRequest) | yes | Request body |
762
-
763
-
764
- Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address`
765
-
766
- *Returned Response:*
767
-
768
-
769
-
770
-
771
- [OpenApiCartServiceabilityResponse](#OpenApiCartServiceabilityResponse)
772
-
773
- Cart details with pincode validity information at item level
774
-
775
-
776
-
777
-
778
- <details>
779
- <summary><i>&nbsp; Examples:</i></summary>
780
-
781
-
782
- <details>
783
- <summary><i>&nbsp; Valid pincode</i></summary>
784
-
785
- ```json
786
- {
787
- "value": {
788
- "items": [
789
- {
790
- "quantity": 1,
791
- "message": "",
792
- "coupon_message": "",
793
- "product": {
794
- "type": "product",
795
- "uid": 803140,
796
- "name": "Green Solid T-Shirt",
797
- "slug": "celio-green-solid-t-shirt-803140-dd9e2c",
798
- "brand": {
799
- "uid": 44,
800
- "name": "celio"
801
- },
802
- "categories": [
803
- {
804
- "uid": 192,
805
- "name": "T-Shirts"
806
- }
807
- ],
808
- "images": [
809
- {
810
- "aspect_ratio": "16:25",
811
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg",
812
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg"
813
- }
814
- ],
815
- "action": {
816
- "type": "product",
817
- "url": "https://api.addsale.com/platform/content/v1/products/celio-green-solid-t-shirt-803140-dd9e2c/",
818
- "query": {
819
- "product_slug": [
820
- "celio-green-solid-t-shirt-803140-dd9e2c"
821
- ]
822
- }
823
- }
824
- },
825
- "article": {
826
- "type": "article",
827
- "uid": "25_44_A7050_NEMIEL@GREENBRITISH_S",
828
- "size": "S",
829
- "seller": {
830
- "uid": 25,
831
- "name": "CELIO FUTURE FASHION PRIVATE LIMITED"
832
- },
833
- "store": {
834
- "uid": 1486,
835
- "name": "Forum Mall"
836
- },
837
- "quantity": 1,
838
- "price": {
839
- "base": {
840
- "marked": 1299,
841
- "effective": 649.5,
842
- "currency_code": "INR"
843
- },
844
- "converted": {
845
- "marked": 1299,
846
- "effective": 649.5,
847
- "currency_code": "INR"
848
- }
849
- }
850
- },
851
- "key": "803140_S",
852
- "discount": "50% OFF",
853
- "price": {
854
- "base": {
855
- "add_on": 0,
856
- "marked": 1299,
857
- "effective": 649.5,
858
- "selling": 649.5,
859
- "currency_code": "INR"
860
- },
861
- "converted": {
862
- "add_on": 0,
863
- "marked": 1299,
864
- "effective": 649.5,
865
- "selling": 649.5,
866
- "currency_code": "INR"
867
- }
868
- },
869
- "availability": {
870
- "sizes": [
871
- "L",
872
- "XL",
873
- "M",
874
- "S"
875
- ],
876
- "other_store_quantity": 0,
877
- "out_of_stock": false,
878
- "deliverable": true,
879
- "is_valid": true,
880
- "delivery_promise": {
881
- "timestamp": {
882
- "min": 1605306343,
883
- "max": 1605468343
884
- },
885
- "formatted": {
886
- "min": "Sat, 14 Nov",
887
- "max": "Mon, 16 Nov"
888
- }
889
- },
890
- "available_sizes": [
891
- {
892
- "is_available": true,
893
- "display": "L",
894
- "value": "L"
895
- },
896
- {
897
- "is_available": true,
898
- "display": "XXL",
899
- "value": "XXL"
900
- },
901
- {
902
- "is_available": true,
903
- "display": "XL",
904
- "value": "XL"
905
- },
906
- {
907
- "is_available": true,
908
- "display": "M",
909
- "value": "M"
910
- },
911
- {
912
- "is_available": true,
913
- "display": "S",
914
- "value": "S"
915
- },
916
- {
917
- "is_available": false,
918
- "display": "30",
919
- "value": "30"
920
- }
921
- ]
922
- },
923
- "bulk_offer": {}
924
- },
925
- {
926
- "quantity": 1,
927
- "message": "Out of stock. Please remove item",
928
- "coupon_message": "",
929
- "product": {
930
- "type": "product",
931
- "uid": 803140,
932
- "name": "Green Solid T-Shirt",
933
- "slug": "celio-green-solid-t-shirt-803140-dd9e2c",
934
- "brand": {
935
- "uid": 44,
936
- "name": "celio"
937
- },
938
- "categories": [
939
- {
940
- "uid": 192,
941
- "name": "T-Shirts"
942
- }
943
- ],
944
- "images": [
945
- {
946
- "aspect_ratio": "16:25",
947
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg",
948
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg"
949
- }
950
- ],
951
- "action": {
952
- "type": "product",
953
- "url": "https://api.addsale.com/platform/content/v1/products/celio-green-solid-t-shirt-803140-dd9e2c/",
954
- "query": {
955
- "product_slug": [
956
- "celio-green-solid-t-shirt-803140-dd9e2c"
957
- ]
958
- }
959
- }
960
- },
961
- "article": {},
962
- "key": "803140_S",
963
- "discount": "",
964
- "price": {
965
- "base": {
966
- "add_on": 0,
967
- "marked": 1299,
968
- "effective": 1299,
969
- "selling": 1299,
970
- "currency_code": "INR"
971
- },
972
- "converted": {
973
- "add_on": 0,
974
- "marked": 1299,
975
- "effective": 1299,
976
- "selling": 1299,
977
- "currency_code": "INR"
978
- }
979
- },
980
- "availability": {
981
- "sizes": [
982
- "L",
983
- "XXL",
984
- "XL",
985
- "M",
986
- "S"
987
- ],
988
- "other_store_quantity": 0,
989
- "out_of_stock": true,
990
- "deliverable": false,
991
- "is_valid": false,
992
- "delivery_promise": {
993
- "timestamp": {
994
- "min": 1605306343,
995
- "max": 1605468343
996
- },
997
- "formatted": {
998
- "min": "Sat, 14 Nov",
999
- "max": "Mon, 16 Nov"
1000
- }
1001
- },
1002
- "available_sizes": [
1003
- {
1004
- "is_available": true,
1005
- "display": "L",
1006
- "value": "L"
1007
- },
1008
- {
1009
- "is_available": true,
1010
- "display": "XXL",
1011
- "value": "XXL"
1012
- },
1013
- {
1014
- "is_available": true,
1015
- "display": "XL",
1016
- "value": "XL"
1017
- },
1018
- {
1019
- "is_available": true,
1020
- "display": "M",
1021
- "value": "M"
1022
- },
1023
- {
1024
- "is_available": true,
1025
- "display": "S",
1026
- "value": "S"
1027
- },
1028
- {
1029
- "is_available": false,
1030
- "display": "30",
1031
- "value": "30"
1032
- }
1033
- ]
1034
- },
1035
- "bulk_offer": {}
1036
- }
1037
- ],
1038
- "delivery_promise": {
1039
- "timestamp": {
1040
- "min": 1605306343,
1041
- "max": 1605468343
1042
- },
1043
- "formatted": {
1044
- "min": "Sat, 14 Nov",
1045
- "max": "Mon, 16 Nov"
1046
- }
1047
- },
1048
- "is_valid": true
1049
- }
1050
- }
1051
- ```
1052
- </details>
1053
-
1054
- <details>
1055
- <summary><i>&nbsp; Invalid pincode</i></summary>
1056
-
1057
- ```json
1058
- {
1059
- "value": {
1060
- "message": "All of the items in your cart are not deliverable to 800108",
1061
- "is_valid": false,
1062
- "items": [
1063
- {
1064
- "discount": "15% OFF",
1065
- "price": {
1066
- "base": {
1067
- "add_on": 0,
1068
- "marked": 2195,
1069
- "effective": 1866,
1070
- "selling": 1866,
1071
- "currency_code": "INR"
1072
- },
1073
- "converted": {
1074
- "add_on": 0,
1075
- "marked": 2195,
1076
- "effective": 1866,
1077
- "selling": 1866,
1078
- "currency_code": "INR"
1079
- }
1080
- },
1081
- "product": {
1082
- "type": "product",
1083
- "uid": 876245,
1084
- "name": "Brown Sandals",
1085
- "slug": "red-chief-brown-sandals-876245-c92507",
1086
- "brand": {
1087
- "uid": 433,
1088
- "name": ""
1089
- },
1090
- "categories": [
1091
- {
1092
- "uid": 176,
1093
- "name": ""
1094
- }
1095
- ],
1096
- "images": [
1097
- {
1098
- "aspect_ratio": "16:25",
1099
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/433_RC330004/1_1564147181287.jpg",
1100
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/433_RC330004/1_1564147181287.jpg"
1101
- }
1102
- ],
1103
- "action": {
1104
- "type": "product",
1105
- "url": "https://api.addsale.com/platform/content/v1/products/red-chief-brown-sandals-876245-c92507/",
1106
- "query": {
1107
- "product_slug": [
1108
- "red-chief-brown-sandals-876245-c92507"
1109
- ]
1110
- }
1111
- },
1112
- "item_code": "RC330004"
1113
- },
1114
- "bulk_offer": {},
1115
- "key": "876245_6",
1116
- "message": "We are not delivering to 800108",
1117
- "delivery_promise": null,
1118
- "coupon_message": "",
1119
- "availability": {
1120
- "sizes": [
1121
- "7",
1122
- "6",
1123
- "10",
1124
- "8"
1125
- ],
1126
- "other_store_quantity": 21,
1127
- "out_of_stock": false,
1128
- "deliverable": false,
1129
- "is_valid": true,
1130
- "available_sizes": [
1131
- {
1132
- "is_available": false,
1133
- "display": "9",
1134
- "value": "9"
1135
- },
1136
- {
1137
- "is_available": true,
1138
- "display": "10",
1139
- "value": "10"
1140
- },
1141
- {
1142
- "is_available": true,
1143
- "display": "6",
1144
- "value": "6"
1145
- },
1146
- {
1147
- "is_available": true,
1148
- "display": "7",
1149
- "value": "7"
1150
- },
1151
- {
1152
- "is_available": true,
1153
- "display": "8",
1154
- "value": "8"
1155
- }
1156
- ]
1157
- },
1158
- "quantity": 1,
1159
- "article": {
1160
- "type": "article",
1161
- "uid": "304_433_LGPL30402_RC330004_6",
1162
- "size": "6",
1163
- "seller": {
1164
- "uid": 304,
1165
- "name": "LEAYAN GLOBAL PVT. LTD."
1166
- },
1167
- "store": {
1168
- "uid": 9767,
1169
- "name": "Udyog Kunj, Kanpur"
1170
- },
1171
- "quantity": 3,
1172
- "price": {
1173
- "base": {
1174
- "marked": 2195,
1175
- "effective": 1866,
1176
- "currency_code": "INR"
1177
- },
1178
- "converted": {
1179
- "marked": 2195,
1180
- "effective": 1866,
1181
- "currency_code": "INR"
1182
- }
1183
- }
1184
- }
1185
- },
1186
- {
1187
- "discount": "15% OFF",
1188
- "price": {
1189
- "base": {
1190
- "add_on": 0,
1191
- "marked": 2195,
1192
- "effective": 1866,
1193
- "selling": 1866,
1194
- "currency_code": "INR"
1195
- },
1196
- "converted": {
1197
- "add_on": 0,
1198
- "marked": 2195,
1199
- "effective": 1866,
1200
- "selling": 1866,
1201
- "currency_code": "INR"
1202
- }
1203
- },
1204
- "product": {
1205
- "type": "product",
1206
- "uid": 876245,
1207
- "name": "Brown Sandals",
1208
- "slug": "red-chief-brown-sandals-876245-c92507",
1209
- "brand": {
1210
- "uid": 433,
1211
- "name": ""
1212
- },
1213
- "categories": [
1214
- {
1215
- "uid": 176,
1216
- "name": ""
1217
- }
1218
- ],
1219
- "images": [
1220
- {
1221
- "aspect_ratio": "16:25",
1222
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/433_RC330004/1_1564147181287.jpg",
1223
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/433_RC330004/1_1564147181287.jpg"
1224
- }
1225
- ],
1226
- "action": {
1227
- "type": "product",
1228
- "url": "https://api.addsale.com/platform/content/v1/products/red-chief-brown-sandals-876245-c92507/",
1229
- "query": {
1230
- "product_slug": [
1231
- "red-chief-brown-sandals-876245-c92507"
1232
- ]
1233
- }
1234
- },
1235
- "item_code": "RC330004"
1236
- },
1237
- "bulk_offer": {},
1238
- "key": "876245_6",
1239
- "message": "We are not delivering to 800108",
1240
- "coupon_message": "",
1241
- "availability": {
1242
- "sizes": [
1243
- "7",
1244
- "6",
1245
- "10",
1246
- "8"
1247
- ],
1248
- "other_store_quantity": 21,
1249
- "out_of_stock": false,
1250
- "deliverable": false,
1251
- "is_valid": true,
1252
- "available_sizes": [
1253
- {
1254
- "is_available": false,
1255
- "display": "9",
1256
- "value": "9"
1257
- },
1258
- {
1259
- "is_available": true,
1260
- "display": "10",
1261
- "value": "10"
1262
- },
1263
- {
1264
- "is_available": true,
1265
- "display": "6",
1266
- "value": "6"
1267
- },
1268
- {
1269
- "is_available": true,
1270
- "display": "7",
1271
- "value": "7"
1272
- },
1273
- {
1274
- "is_available": true,
1275
- "display": "8",
1276
- "value": "8"
1277
- }
1278
- ]
1279
- },
1280
- "quantity": 1,
1281
- "article": {
1282
- "type": "article",
1283
- "uid": "304_433_LGPL30402_RC330004_6",
1284
- "size": "6",
1285
- "seller": {
1286
- "uid": 304,
1287
- "name": "LEAYAN GLOBAL PVT. LTD."
1288
- },
1289
- "store": {
1290
- "uid": 9767,
1291
- "name": "Udyog Kunj, Kanpur"
1292
- },
1293
- "quantity": 3,
1294
- "price": {
1295
- "base": {
1296
- "marked": 2195,
1297
- "effective": 1866,
1298
- "currency_code": "INR"
1299
- },
1300
- "converted": {
1301
- "marked": 2195,
1302
- "effective": 1866,
1303
- "currency_code": "INR"
1304
- }
1305
- }
1306
- }
1307
- }
1308
- ]
1309
- }
1310
- }
1311
- ```
1312
- </details>
1313
-
1314
- </details>
1315
-
1316
-
1317
-
1318
-
1319
-
1320
-
1321
-
1322
-
1323
-
1324
- ---
1325
-
1326
-
1327
- ### checkoutCart
1328
- Create Fynd order with cart details
1329
-
1330
-
1331
-
1332
- ```javascript
1333
- // Promise
1334
- const promise = client.application("<APPLICATION_ID>").cart.checkoutCart({ body : value });
1335
-
1336
- // Async/Await
1337
- const data = await client.application("<APPLICATION_ID>").cart.checkoutCart({ body : value });
1338
- ```
1339
-
1340
-
1341
-
1342
-
1343
-
1344
- | Argument | Type | Required | Description |
1345
- | --------- | ----- | -------- | ----------- |
1346
- | body | [OpenApiPlatformCheckoutReq](#OpenApiPlatformCheckoutReq) | yes | Request body |
1347
-
1348
-
1349
- Generate Fynd order for cart details send with provided `cart_items`
1350
-
1351
- *Returned Response:*
1352
-
1353
-
1354
-
1355
-
1356
- [OpenApiCheckoutResponse](#OpenApiCheckoutResponse)
1357
-
1358
- Checkout cart and create Fynd order id
1359
-
1360
-
1361
-
1362
-
1363
- <details>
1364
- <summary><i>&nbsp; Example:</i></summary>
1365
-
1366
- ```json
1367
- {
1368
- "success": true,
1369
- "order_id": "FY5E182A9D0A5E405446",
1370
- "message": "Order initiation completed",
1371
- "order_ref_id": null
1372
- }
1373
- ```
1374
- </details>
1375
-
1376
-
1377
-
1378
-
1379
-
1380
-
1381
-
1382
-
1383
-
1384
- ---
1385
-
1386
-
1387
- ### createCoupon
1388
- Create new coupon
1389
-
1390
-
1391
-
1392
- ```javascript
1393
- // Promise
1394
- const promise = client.application("<APPLICATION_ID>").cart.createCoupon({ body : value });
1395
-
1396
- // Async/Await
1397
- const data = await client.application("<APPLICATION_ID>").cart.createCoupon({ body : value });
1398
- ```
1399
-
1400
-
1401
-
1402
-
1403
-
1404
- | Argument | Type | Required | Description |
1405
- | --------- | ----- | -------- | ----------- |
1406
- | body | [CouponAdd](#CouponAdd) | yes | Request body |
1407
-
1408
-
1409
- Create new coupon
1410
-
1411
- *Returned Response:*
1412
-
1413
-
1414
-
1415
-
1416
- [SuccessMessage](#SuccessMessage)
1417
-
1418
- Coupon Created successfully
1419
-
1420
-
1421
-
1422
-
1423
- <details>
1424
- <summary><i>&nbsp; Example:</i></summary>
1425
-
1426
- ```json
1427
- {
1428
- "success": true,
1429
- "message": "Coupon Created"
1430
- }
1431
- ```
1432
- </details>
1433
-
1434
-
1435
-
1436
-
1437
-
1438
-
1439
-
1440
-
1441
-
1442
- ---
1443
-
1444
-
1445
- ### createPromotion
1446
- Create new promotion
1447
-
1448
-
1449
-
1450
- ```javascript
1451
- // Promise
1452
- const promise = client.application("<APPLICATION_ID>").cart.createPromotion({ body : value });
1453
-
1454
- // Async/Await
1455
- const data = await client.application("<APPLICATION_ID>").cart.createPromotion({ body : value });
1456
- ```
1457
-
1458
-
1459
-
1460
-
1461
-
1462
- | Argument | Type | Required | Description |
1463
- | --------- | ----- | -------- | ----------- |
1464
- | body | [PromotionAdd](#PromotionAdd) | yes | Request body |
1465
-
1466
-
1467
- Create new promotion
1468
-
1469
- *Returned Response:*
1470
-
1471
-
1472
-
1473
-
1474
- [PromotionAdd](#PromotionAdd)
1475
-
1476
- Promotion Created successfully
1477
-
1478
-
1479
-
1480
-
1481
- <details>
1482
- <summary><i>&nbsp; Example:</i></summary>
1483
-
1484
- ```json
1485
- {
1486
- "_id": "61dc8dc9adf45b2273a70a6e",
1487
- "application_id": "000000000000000000000001",
1488
- "promo_group": "product",
1489
- "promotion_type": "bogo",
1490
- "date_meta": {
1491
- "modified_on": "2022-01-11T05:47:11.503000+00:00",
1492
- "created_on": "2022-01-10T19:49:29.917000+00:00"
1493
- },
1494
- "discount_rules": [
1495
- {
1496
- "buy_condition": "( rule#1 )",
1497
- "offer": {
1498
- "max_offer_quantity": 2
1499
- },
1500
- "discount_type": "bogo",
1501
- "item_criteria": {
1502
- "item_brand": [
1503
- 2,
1504
- 14,
1505
- 65
1506
- ]
1507
- }
1508
- }
1509
- ],
1510
- "buy_rules": {
1511
- "rule#1": {
1512
- "cart_quantity": {
1513
- "greater_than_equals": 5
1514
- },
1515
- "item_brand": [
1516
- 1,
1517
- 2,
1518
- 14,
1519
- 16,
1520
- 29,
1521
- 39,
1522
- 43,
1523
- 65,
1524
- 73
1525
- ]
1526
- }
1527
- },
1528
- "display_meta": {
1529
- "offer_text": "Test",
1530
- "name": "Test BOGO promo",
1531
- "description": "<p>Test</p>"
1532
- },
1533
- "apply_all_discount": false,
1534
- "apply_exclusive": null,
1535
- "stackable": true,
1536
- "restrictions": {
1537
- "user_id": [],
1538
- "anonymous_users": true,
1539
- "platforms": [
1540
- "web",
1541
- "android",
1542
- "ios"
1543
- ],
1544
- "post_order": {
1545
- "cancellation_allowed": true,
1546
- "return_allowed": true
1547
- },
1548
- "uses": {
1549
- "remaining": {
1550
- "user": 0,
1551
- "total": 0
1552
- },
1553
- "maximum": {
1554
- "user": 0,
1555
- "total": 0
1556
- }
1557
- },
1558
- "payments": []
1559
- },
1560
- "_custom_json": {},
1561
- "author": {
1562
- "created_by": "5",
1563
- "modified_by": "5"
1564
- },
1565
- "_schedule": {
1566
- "start": "2022-01-10T18:45:36.311Z",
1567
- "end": null,
1568
- "published": true,
1569
- "next_schedule": [
1570
- {
1571
- "start": "2022-01-10T18:45:36.311Z",
1572
- "end": null
1573
- }
1574
- ],
1575
- "cron": "",
1576
- "duration": 0
1577
- },
1578
- "apply_priority": 1,
1579
- "visiblility": {
1580
- "pdp": true,
1581
- "coupon_list": false
1582
- },
1583
- "ownership": {
1584
- "payable_by": "",
1585
- "payable_category": "seller"
1586
- },
1587
- "currency": "INR",
1588
- "mode": "promotion",
1589
- "post_order_action": {
1590
- "action_date": null,
1591
- "action_type": ""
1592
- },
1593
- "indexed_criteria": {
1594
- "item_brand": [
1595
- 1,
1596
- 2
1597
- ]
1598
- }
1599
- }
1600
- ```
1601
- </details>
1602
-
1603
-
1604
-
1605
-
1606
-
1607
-
1608
-
1609
-
1610
-
1611
- ---
1612
-
1613
-
1614
- ### fetchAndvalidateCartItems
1615
- Fetch Cart Details
1616
-
1617
-
1618
-
1619
- ```javascript
1620
- // Promise
1621
- const promise = client.application("<APPLICATION_ID>").cart.fetchAndvalidateCartItems({ body : value });
1622
-
1623
- // Async/Await
1624
- const data = await client.application("<APPLICATION_ID>").cart.fetchAndvalidateCartItems({ body : value });
1625
- ```
1626
-
1627
-
1628
-
1629
-
1630
-
1631
- | Argument | Type | Required | Description |
1632
- | --------- | ----- | -------- | ----------- |
1633
- | body | [OpenapiCartDetailsRequest](#OpenapiCartDetailsRequest) | yes | Request body |
1634
-
1635
-
1636
- Get all the details of cart for a list of provided `cart_items`
1637
-
1638
- *Returned Response:*
1639
-
1640
-
1641
-
1642
-
1643
- [OpenapiCartDetailsResponse](#OpenapiCartDetailsResponse)
1644
-
1645
- Cart details with breakup
1646
-
1647
-
1648
-
1649
-
1650
- <details>
1651
- <summary><i>&nbsp; Example:</i></summary>
1652
-
1653
- ```json
1654
- {
1655
- "items": [
1656
- {
1657
- "quantity": 1,
1658
- "message": "",
1659
- "coupon_message": "",
1660
- "product": {
1661
- "type": "product",
1662
- "uid": 803140,
1663
- "name": "Green Solid T-Shirt",
1664
- "slug": "celio-green-solid-t-shirt-803140-dd9e2c",
1665
- "brand": {
1666
- "uid": 44,
1667
- "name": "celio"
1668
- },
1669
- "categories": [
1670
- {
1671
- "uid": 192,
1672
- "name": "T-Shirts"
1673
- }
1674
- ],
1675
- "images": [
1676
- {
1677
- "aspect_ratio": "16:25",
1678
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg",
1679
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg"
1680
- }
1681
- ],
1682
- "action": {
1683
- "type": "product",
1684
- "url": "https://api.addsale.com/platform/content/v1/products/celio-green-solid-t-shirt-803140-dd9e2c/",
1685
- "query": {
1686
- "product_slug": [
1687
- "celio-green-solid-t-shirt-803140-dd9e2c"
1688
- ]
1689
- }
1690
- }
1691
- },
1692
- "article": {
1693
- "type": "article",
1694
- "uid": "25_44_A7050_NEMIEL@GREENBRITISH_S",
1695
- "size": "S",
1696
- "seller": {
1697
- "uid": 25,
1698
- "name": "CELIO FUTURE FASHION PRIVATE LIMITED"
1699
- },
1700
- "store": {
1701
- "uid": 1486,
1702
- "name": "Forum Mall"
1703
- },
1704
- "quantity": 1,
1705
- "price": {
1706
- "base": {
1707
- "marked": 1299,
1708
- "effective": 649.5,
1709
- "currency_code": "INR"
1710
- },
1711
- "converted": {
1712
- "marked": 1299,
1713
- "effective": 649.5,
1714
- "currency_code": "INR"
1715
- }
1716
- }
1717
- },
1718
- "key": "803140_S",
1719
- "discount": "50% OFF",
1720
- "price": {
1721
- "base": {
1722
- "add_on": 0,
1723
- "marked": 1299,
1724
- "effective": 649.5,
1725
- "selling": 649.5,
1726
- "currency_code": "INR"
1727
- },
1728
- "converted": {
1729
- "add_on": 0,
1730
- "marked": 1299,
1731
- "effective": 649.5,
1732
- "selling": 649.5,
1733
- "currency_code": "INR"
1734
- }
1735
- },
1736
- "availability": {
1737
- "sizes": [
1738
- "L",
1739
- "XL",
1740
- "M",
1741
- "S"
1742
- ],
1743
- "other_store_quantity": 0,
1744
- "out_of_stock": false,
1745
- "deliverable": true,
1746
- "is_valid": true,
1747
- "available_sizes": [
1748
- {
1749
- "is_available": true,
1750
- "display": "L",
1751
- "value": "L"
1752
- },
1753
- {
1754
- "is_available": true,
1755
- "display": "XXL",
1756
- "value": "XXL"
1757
- },
1758
- {
1759
- "is_available": true,
1760
- "display": "XL",
1761
- "value": "XL"
1762
- },
1763
- {
1764
- "is_available": true,
1765
- "display": "M",
1766
- "value": "M"
1767
- },
1768
- {
1769
- "is_available": true,
1770
- "display": "S",
1771
- "value": "S"
1772
- },
1773
- {
1774
- "is_available": false,
1775
- "display": "30",
1776
- "value": "30"
1777
- }
1778
- ]
1779
- },
1780
- "bulk_offer": {}
1781
- },
1782
- {
1783
- "quantity": 1,
1784
- "message": "Out of stock. Please remove item",
1785
- "coupon_message": "",
1786
- "product": {
1787
- "type": "product",
1788
- "uid": 803140,
1789
- "name": "Green Solid T-Shirt",
1790
- "slug": "celio-green-solid-t-shirt-803140-dd9e2c",
1791
- "brand": {
1792
- "uid": 44,
1793
- "name": "celio"
1794
- },
1795
- "categories": [
1796
- {
1797
- "uid": 192,
1798
- "name": "T-Shirts"
1799
- }
1800
- ],
1801
- "images": [
1802
- {
1803
- "aspect_ratio": "16:25",
1804
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg",
1805
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg"
1806
- }
1807
- ],
1808
- "action": {
1809
- "type": "product",
1810
- "url": "https://api.addsale.com/platform/content/v1/products/celio-green-solid-t-shirt-803140-dd9e2c/",
1811
- "query": {
1812
- "product_slug": [
1813
- "celio-green-solid-t-shirt-803140-dd9e2c"
1814
- ]
1815
- }
1816
- }
1817
- },
1818
- "article": {},
1819
- "key": "803140_S",
1820
- "discount": "",
1821
- "price": {
1822
- "base": {
1823
- "add_on": 0,
1824
- "marked": 1299,
1825
- "effective": 1299,
1826
- "selling": 1299,
1827
- "currency_code": "INR"
1828
- },
1829
- "converted": {
1830
- "add_on": 0,
1831
- "marked": 1299,
1832
- "effective": 1299,
1833
- "selling": 1299,
1834
- "currency_code": "INR"
1835
- }
1836
- },
1837
- "availability": {
1838
- "sizes": [
1839
- "L",
1840
- "XXL",
1841
- "XL",
1842
- "M",
1843
- "S"
1844
- ],
1845
- "other_store_quantity": 0,
1846
- "out_of_stock": true,
1847
- "deliverable": false,
1848
- "is_valid": false,
1849
- "available_sizes": [
1850
- {
1851
- "is_available": true,
1852
- "display": "L",
1853
- "value": "L"
1854
- },
1855
- {
1856
- "is_available": true,
1857
- "display": "XXL",
1858
- "value": "XXL"
1859
- },
1860
- {
1861
- "is_available": true,
1862
- "display": "XL",
1863
- "value": "XL"
1864
- },
1865
- {
1866
- "is_available": true,
1867
- "display": "M",
1868
- "value": "M"
1869
- },
1870
- {
1871
- "is_available": true,
1872
- "display": "S",
1873
- "value": "S"
1874
- },
1875
- {
1876
- "is_available": false,
1877
- "display": "30",
1878
- "value": "30"
1879
- }
1880
- ]
1881
- },
1882
- "bulk_offer": {}
1883
- }
1884
- ],
1885
- "is_valid": false,
1886
- "breakup_values": {
1887
- "display": [
1888
- {
1889
- "display": "MRP Total",
1890
- "key": "mrp_total",
1891
- "value": 2598,
1892
- "currency_code": "INR"
1893
- },
1894
- {
1895
- "display": "Discount",
1896
- "key": "discount",
1897
- "value": -649,
1898
- "currency_code": "INR"
1899
- },
1900
- {
1901
- "display": "Subtotal",
1902
- "key": "subtotal",
1903
- "value": 1949,
1904
- "currency_code": "INR"
1905
- },
1906
- {
1907
- "display": "Total",
1908
- "key": "total",
1909
- "value": 1949,
1910
- "currency_code": "INR"
1911
- }
1912
- ],
1913
- "raw": {
1914
- "cod_charge": 0,
1915
- "convenience_fee": 0,
1916
- "coupon": 0,
1917
- "delivery_charge": 0,
1918
- "discount": -649.5,
1919
- "fynd_cash": 0,
1920
- "gst_charges": 170.11,
1921
- "mrp_total": 2598,
1922
- "subtotal": 1948.5,
1923
- "total": 1948.5,
1924
- "vog": 1778.39,
1925
- "you_saved": 0
1926
- }
1927
- }
1928
- }
1929
- ```
1930
- </details>
1931
-
1932
-
1933
-
1934
-
1935
-
1936
-
1937
-
1938
-
1939
-
1940
- ---
1941
-
1942
-
1943
- ### getAbandonedCart
1944
- Get with abandoned cart list
1945
-
1946
-
1947
-
1948
- ```javascript
1949
- // Promise
1950
- const promise = client.application("<APPLICATION_ID>").cart.getAbandonedCart({ pageNo : value,
1951
- pageSize : value,
1952
- fromDate : value,
1953
- toDate : value,
1954
- anonymousCart : value,
1955
- lastId : value,
1956
- sortOn : value });
1957
-
1958
- // Async/Await
1959
- const data = await client.application("<APPLICATION_ID>").cart.getAbandonedCart({ pageNo : value,
1960
- pageSize : value,
1961
- fromDate : value,
1962
- toDate : value,
1963
- anonymousCart : value,
1964
- lastId : value,
1965
- sortOn : value });
1966
- ```
1967
-
1968
-
1969
-
1970
-
1971
-
1972
- | Argument | Type | Required | Description |
1973
- | --------- | ----- | -------- | ----------- |
1974
- | pageNo | number | no | |
1975
- | pageSize | number | no | |
1976
- | fromDate | string | no | |
1977
- | toDate | string | no | |
1978
- | anonymousCart | boolean | no | |
1979
- | lastId | string | no | |
1980
- | sortOn | string | no | |
1981
-
1982
-
1983
-
1984
- Get abandoned cart list with pagination
1985
-
1986
- *Returned Response:*
1987
-
1988
-
1989
-
1990
-
1991
- [AbandonedCartResponse](#AbandonedCartResponse)
1992
-
1993
- Abandoned Cart List for sent page_size and page_no
1994
-
1995
-
1996
-
1997
-
1998
- <details>
1999
- <summary><i>&nbsp; Examples:</i></summary>
2000
-
2001
-
2002
- <details>
2003
- <summary><i>&nbsp; Abandoned Cart list for sent filter and page size</i></summary>
2004
-
2005
- ```json
2006
- {
2007
- "value": {
2008
- "message": "Cart fetched successfully !!",
2009
- "success": true,
2010
- "result": {},
2011
- "items": [
2012
- {
2013
- "_id": "62bbe2c4b79692d559ac1f16",
2014
- "uid": 19986,
2015
- "user_id": "600693a01faf8695d70a15df",
2016
- "is_default": true,
2017
- "app_id": "5d64e3500bcad8693a821c0d",
2018
- "articles": [
2019
- {
2020
- "service_item_meta": {
2021
- "product_group_tags": null,
2022
- "products": null
2023
- },
2024
- "parent_item_identifiers": {
2025
- "identifier": null,
2026
- "parent_item_size": null,
2027
- "parent_item_id": null
2028
- },
2029
- "item_id": 7500426,
2030
- "item_size": "SET1",
2031
- "article_id": "5f37d9b71cb7c10001b90ee2",
2032
- "quantity": 2,
2033
- "price_marked": 1000,
2034
- "price_effective": 1,
2035
- "currency_code": "INR",
2036
- "store_id": 10183,
2037
- "company_id": 61,
2038
- "article_assignment": {
2039
- "level": "multi-companies",
2040
- "strategy": "optimal"
2041
- },
2042
- "brand_uid": 85,
2043
- "l3_categories": [
2044
- 466
2045
- ],
2046
- "discount": 99.9,
2047
- "coupon": {
2048
- "amount": 0,
2049
- "currency_code": "INR",
2050
- "article_count": 0
2051
- },
2052
- "referral_credits": {
2053
- "amount": 0,
2054
- "currency_code": "FC"
2055
- },
2056
- "cashback": {
2057
- "amount": 0,
2058
- "currency_code": "FC"
2059
- },
2060
- "bulk_coupon": {
2061
- "margin": 0,
2062
- "discount": 0,
2063
- "code": null
2064
- },
2065
- "promotion": [
2066
- {
2067
- "promo_id": "62bbf355beda57df173122fa",
2068
- "amount": 1,
2069
- "article_quantity": 2,
2070
- "mrp_promotion": false,
2071
- "promotion_type": "amount",
2072
- "discount_rules": [
2073
- {
2074
- "type": "amount",
2075
- "value": 125
2076
- }
2077
- ]
2078
- }
2079
- ],
2080
- "identifiers": {
2081
- "identifier": "pEF2t4GGTKaieox5rsRibw"
2082
- },
2083
- "meta": {},
2084
- "extra_meta": {},
2085
- "payment_methods": []
2086
- }
2087
- ],
2088
- "cart_value": 1,
2089
- "discount": 0,
2090
- "delivery_charges": {
2091
- "amount": 1,
2092
- "currency_code": "INR"
2093
- },
2094
- "coupon": {
2095
- "amount": 0,
2096
- "currency_code": "INR",
2097
- "code": null,
2098
- "type": "cart",
2099
- "uid": null,
2100
- "id": null
2101
- },
2102
- "promotion": {
2103
- "amount": 2,
2104
- "currency_code": "INR",
2105
- "mode": "promotion",
2106
- "promotions": [
2107
- {
2108
- "id": "62bbf355beda57df173122fa",
2109
- "mrp_promo": false,
2110
- "promo_group": "product"
2111
- }
2112
- ]
2113
- },
2114
- "fynd_credits": {
2115
- "amount": 0,
2116
- "currency_code": "FC",
2117
- "auto_applied": true
2118
- },
2119
- "cod_charges": {
2120
- "amount": 0,
2121
- "currency_code": "INR"
2122
- },
2123
- "cashback": {
2124
- "amount": 0,
2125
- "currency_code": "FC",
2126
- "uid": null
2127
- },
2128
- "payments": {},
2129
- "is_archive": false,
2130
- "created_on": "2022-06-28 14:25:15.578000",
2131
- "last_modified": "2022-06-29 13:52:03.313000",
2132
- "expire_at": "2023-06-24 13:52:03.313000",
2133
- "fc_index_map": [
2134
- 0,
2135
- 0
2136
- ],
2137
- "checkout_mode": "self",
2138
- "meta": {
2139
- "shipping_address_id": "62b161cb3ad0eed3e48ec6a9",
2140
- "billing_address_id": "62b161cb3ad0eed3e48ec6a9"
2141
- },
2142
- "comment": "",
2143
- "bulk_coupon_discount": 0,
2144
- "pick_up_customer_details": {},
2145
- "is_active": true,
2146
- "shipments": [],
2147
- "payment_methods": [],
2148
- "buy_now": false
2149
- }
2150
- ],
2151
- "page": {
2152
- "type": "number",
2153
- "has_next": false,
2154
- "item_total": 28,
2155
- "size": 20,
2156
- "page": 2,
2157
- "current": 2,
2158
- "last_id": "62d4ff76d6aec8db897de407"
2159
- }
2160
- }
2161
- }
2162
- ```
2163
- </details>
2164
-
2165
- </details>
2166
-
2167
-
2168
-
2169
-
2170
-
2171
-
2172
-
2173
-
2174
-
2175
- ---
2176
-
2177
-
2178
- ### getAbandonedCartDetails
2179
- Fetch all items added to the cart
2180
-
2181
-
2182
-
2183
- ```javascript
2184
- // Promise
2185
- const promise = client.application("<APPLICATION_ID>").cart.getAbandonedCartDetails({ id : value,
2186
- i : value,
2187
- b : value });
2188
-
2189
- // Async/Await
2190
- const data = await client.application("<APPLICATION_ID>").cart.getAbandonedCartDetails({ id : value,
2191
- i : value,
2192
- b : value });
2193
- ```
2194
-
2195
-
2196
-
2197
-
2198
-
2199
- | Argument | Type | Required | Description |
2200
- | --------- | ----- | -------- | ----------- |
2201
- | id | string | no | |
2202
- | i | boolean | no | |
2203
- | b | boolean | no | |
2204
-
2205
-
2206
-
2207
- Use this API to get details of all the items added to a cart.
2208
-
2209
- *Returned Response:*
2210
-
2211
-
2212
-
2213
-
2214
- [CartDetailResponse](#CartDetailResponse)
2215
-
2216
- Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponse` for more details.
2217
-
2218
-
2219
-
2220
-
2221
- <details>
2222
- <summary><i>&nbsp; Example:</i></summary>
2223
-
2224
- ```json
2225
- {
2226
- "items": [
2227
- {
2228
- "bulk_offer": {},
2229
- "discount": "67% OFF",
2230
- "article": {
2231
- "type": "article",
2232
- "uid": "604_902_SSTC60401_636BLUE_1",
2233
- "size": "1",
2234
- "seller": {
2235
- "uid": 604,
2236
- "name": "SHRI SHANTINATH TRADING COMPANY"
2237
- },
2238
- "store": {
2239
- "uid": 4579,
2240
- "name": "Gandhi Nagar"
2241
- },
2242
- "quantity": 108,
2243
- "price": {
2244
- "base": {
2245
- "marked": 2999,
2246
- "effective": 999,
2247
- "currency_code": "INR"
2248
- },
2249
- "converted": {
2250
- "marked": 2999,
2251
- "effective": 999,
2252
- "currency_code": "INR"
2253
- }
2254
- }
2255
- },
2256
- "coupon_message": "",
2257
- "key": "707569_1",
2258
- "availability": {
2259
- "sizes": [
2260
- "1",
2261
- "8",
2262
- "7",
2263
- "2",
2264
- "9",
2265
- "5",
2266
- "3",
2267
- "6"
2268
- ],
2269
- "other_store_quantity": 107,
2270
- "out_of_stock": false,
2271
- "deliverable": true,
2272
- "is_valid": true
2273
- },
2274
- "product": {
2275
- "type": "product",
2276
- "uid": 707569,
2277
- "name": "Blue and Gold Printed Ethnic Set",
2278
- "slug": "aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a",
2279
- "brand": {
2280
- "uid": 902,
2281
- "name": ""
2282
- },
2283
- "categories": [
2284
- {
2285
- "uid": 525,
2286
- "name": ""
2287
- }
2288
- ],
2289
- "images": [
2290
- {
2291
- "aspect_ratio": "16:25",
2292
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg",
2293
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"
2294
- }
2295
- ],
2296
- "action": {
2297
- "type": "product",
2298
- "url": "https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/",
2299
- "query": {
2300
- "product_slug": [
2301
- "aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"
2302
- ]
2303
- }
2304
- }
2305
- },
2306
- "price": {
2307
- "base": {
2308
- "add_on": 999,
2309
- "marked": 2999,
2310
- "effective": 999,
2311
- "selling": 999,
2312
- "currency_code": "INR"
2313
- },
2314
- "converted": {
2315
- "add_on": 999,
2316
- "marked": 2999,
2317
- "effective": 999,
2318
- "selling": 999,
2319
- "currency_code": "INR"
2320
- }
2321
- },
2322
- "message": "",
2323
- "quantity": 1
2324
- }
2325
- ],
2326
- "buy_now": false,
2327
- "cart_id": 54,
2328
- "uid": "54",
2329
- "breakup_values": {
2330
- "raw": {
2331
- "cod_charge": 0,
2332
- "convenience_fee": 0,
2333
- "coupon": 0,
2334
- "delivery_charge": 0,
2335
- "discount": -2000,
2336
- "fynd_cash": 0,
2337
- "gst_charges": 47.57,
2338
- "mrp_total": 2999,
2339
- "subtotal": 999,
2340
- "total": 999,
2341
- "vog": 951.43,
2342
- "you_saved": 0
2343
- },
2344
- "coupon": {
2345
- "type": "cash",
2346
- "code": "",
2347
- "uid": null,
2348
- "value": 0,
2349
- "is_applied": false,
2350
- "message": "Sorry! Invalid Coupon"
2351
- },
2352
- "display": [
2353
- {
2354
- "display": "MRP Total",
2355
- "key": "mrp_total",
2356
- "value": 2999,
2357
- "currency_code": "INR"
2358
- },
2359
- {
2360
- "display": "Discount",
2361
- "key": "discount",
2362
- "value": -2000,
2363
- "currency_code": "INR"
2364
- },
2365
- {
2366
- "display": "Subtotal",
2367
- "key": "subtotal",
2368
- "value": 999,
2369
- "currency_code": "INR"
2370
- },
2371
- {
2372
- "display": "Total",
2373
- "key": "total",
2374
- "value": 999,
2375
- "currency_code": "INR"
2376
- }
2377
- ],
2378
- "loyalty_points": {
2379
- "total": 0,
2380
- "applicable": 0,
2381
- "is_applied": false,
2382
- "description": "Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."
2383
- }
2384
- },
2385
- "delivery_charge_info": "",
2386
- "coupon_text": "View all offers",
2387
- "gstin": null,
2388
- "checkout_mode": "self",
2389
- "restrict_checkout": false,
2390
- "is_valid": true,
2391
- "last_modified": "Tue, 03 Sep 2019 05:35:59 GMT"
2392
- }
2393
- ```
2394
- </details>
2395
-
2396
-
2397
-
2398
-
2399
-
2400
-
2401
-
2402
-
2403
-
2404
- ---
2405
-
2406
-
2407
- ### getCouponById
2408
- Get with single coupon details or coupon list
2409
-
2410
-
2411
-
2412
- ```javascript
2413
- // Promise
2414
- const promise = client.application("<APPLICATION_ID>").cart.getCouponById({ id : value });
2415
-
2416
- // Async/Await
2417
- const data = await client.application("<APPLICATION_ID>").cart.getCouponById({ id : value });
2418
- ```
2419
-
2420
-
2421
-
2422
-
2423
-
2424
- | Argument | Type | Required | Description |
2425
- | --------- | ----- | -------- | ----------- |
2426
- | id | string | yes | |
2427
-
2428
-
2429
-
2430
- Get single coupon details with `id` in path param
2431
-
2432
- *Returned Response:*
2433
-
2434
-
2435
-
2436
-
2437
- [CouponUpdate](#CouponUpdate)
2438
-
2439
- Coupon object for sent `id`
2440
-
2441
-
2442
-
2443
-
2444
- <details>
2445
- <summary><i>&nbsp; Example:</i></summary>
2446
-
2447
- ```json
2448
- {
2449
- "_id": "5e1d9bec6d6b7e000146c840",
2450
- "validation": {
2451
- "anonymous": true,
2452
- "app_id": [
2453
- "5cd3db5e9d692cfe5302a7ba"
2454
- ],
2455
- "user_registered_after": null
2456
- },
2457
- "rule": [
2458
- {
2459
- "key": 1,
2460
- "max": 1500,
2461
- "min": 3000,
2462
- "value": 50
2463
- }
2464
- ],
2465
- "display_meta": {
2466
- "title": "percent50 title",
2467
- "description": "percent50 description",
2468
- "auto": {
2469
- "title": "",
2470
- "subtitle": ""
2471
- },
2472
- "subtitle": "percent50 subtitle",
2473
- "remove": {
2474
- "title": "",
2475
- "subtitle": ""
2476
- },
2477
- "apply": {
2478
- "title": "percen50 mt",
2479
- "subtitle": "percen50 ms"
2480
- }
2481
- },
2482
- "date_meta": {
2483
- "modified_on": "2020-02-04T14:27:00.577000+00:00",
2484
- "created_on": "2020-01-14T10:46:04.474000+00:00"
2485
- },
2486
- "action": {
2487
- "action_date": null,
2488
- "txn_mode": "coupon"
2489
- },
2490
- "identifiers": {
2491
- "category_id": [
2492
- 465,
2493
- 192,
2494
- 133,
2495
- 134,
2496
- 150,
2497
- 151,
2498
- 155,
2499
- 193,
2500
- 157,
2501
- 191,
2502
- 154,
2503
- 152,
2504
- 417,
2505
- 168,
2506
- 416,
2507
- 167,
2508
- 166,
2509
- 162,
2510
- 161,
2511
- 163,
2512
- 165,
2513
- 160
2514
- ],
2515
- "user_id": [],
2516
- "store_id": [],
2517
- "company_id": []
2518
- },
2519
- "author": {
2520
- "modified_by": "23109086",
2521
- "created_by": "23206328"
2522
- },
2523
- "_schedule": {
2524
- "next_schedule": [
2525
- {
2526
- "start": "2020-01-14T10:45:03.600000+00:00",
2527
- "end": "2020-01-16T10:45:03+00:00"
2528
- }
2529
- ],
2530
- "duration": null,
2531
- "start": "2020-01-14T10:45:03.600000+00:00",
2532
- "end": "2020-01-16T10:45:03+00:00",
2533
- "cron": ""
2534
- },
2535
- "state": {
2536
- "is_public": true,
2537
- "is_display": true,
2538
- "is_archived": false
2539
- },
2540
- "ownership": {
2541
- "payable_category": "seller",
2542
- "payable_by": ""
2543
- },
2544
- "validity": {
2545
- "priority": 0
2546
- },
2547
- "code": "percent50",
2548
- "rule_definition": {
2549
- "calculate_on": "esp",
2550
- "value_type": "percentage",
2551
- "is_exact": false,
2552
- "type": "percentage",
2553
- "scope": [
2554
- "category_id"
2555
- ],
2556
- "auto_apply": false,
2557
- "applicable_on": "quantity",
2558
- "currency_code": "INR"
2559
- },
2560
- "restrictions": {
2561
- "price_range": {
2562
- "max": -1,
2563
- "min": -1
2564
- },
2565
- "uses": {
2566
- "remaining": {
2567
- "app": -1,
2568
- "user": -1,
2569
- "total": -1
2570
- },
2571
- "maximum": {
2572
- "app": -1,
2573
- "user": -1,
2574
- "total": -1
2575
- }
2576
- },
2577
- "post_order": {
2578
- "cancellation_allowed": true,
2579
- "return_allowed": true
2580
- },
2581
- "platforms": [
2582
- "web",
2583
- "android",
2584
- "ios"
2585
- ]
2586
- },
2587
- "type_slug": "percentage_quantity_percentage"
2588
- }
2589
- ```
2590
- </details>
2591
-
2592
-
2593
-
2594
-
2595
-
2596
-
2597
-
2598
-
2599
-
2600
- ---
2601
-
2602
-
2603
- ### getCoupons
2604
- Get with single coupon details or coupon list
2605
-
2606
-
2607
-
2608
- ```javascript
2609
- // Promise
2610
- const promise = client.application("<APPLICATION_ID>").cart.getCoupons({ pageNo : value,
2611
- pageSize : value,
2612
- isArchived : value,
2613
- title : value,
2614
- isPublic : value,
2615
- isDisplay : value,
2616
- typeSlug : value,
2617
- code : value });
2618
-
2619
- // Async/Await
2620
- const data = await client.application("<APPLICATION_ID>").cart.getCoupons({ pageNo : value,
2621
- pageSize : value,
2622
- isArchived : value,
2623
- title : value,
2624
- isPublic : value,
2625
- isDisplay : value,
2626
- typeSlug : value,
2627
- code : value });
2628
- ```
2629
-
2630
-
2631
-
2632
-
2633
-
2634
- | Argument | Type | Required | Description |
2635
- | --------- | ----- | -------- | ----------- |
2636
- | pageNo | number | no | |
2637
- | pageSize | number | no | |
2638
- | isArchived | boolean | no | |
2639
- | title | string | no | |
2640
- | isPublic | boolean | no | |
2641
- | isDisplay | boolean | no | |
2642
- | typeSlug | string | no | |
2643
- | code | string | no | |
2644
-
2645
-
2646
-
2647
- Get coupon list with pagination
2648
-
2649
- *Returned Response:*
2650
-
2651
-
2652
-
2653
-
2654
- [CouponsResponse](#CouponsResponse)
2655
-
2656
- Coupon List for sent page_size and page_no
2657
-
2658
-
2659
-
2660
-
2661
- <details>
2662
- <summary><i>&nbsp; Examples:</i></summary>
2663
-
2664
-
2665
- <details>
2666
- <summary><i>&nbsp; Coupon list for sent filter and page size</i></summary>
2667
-
2668
- ```json
2669
- {
2670
- "value": {
2671
- "items": [
2672
- {
2673
- "_id": "5e1d9bec6d6b7e000146c840",
2674
- "display_meta": {
2675
- "title": "percent50 title"
2676
- },
2677
- "_schedule": {
2678
- "next_schedule": [
2679
- {
2680
- "start": "2020-01-14T10:45:03.600000+00:00",
2681
- "end": "2020-01-16T10:45:03+00:00"
2682
- }
2683
- ],
2684
- "duration": null,
2685
- "start": "2020-01-14T10:45:03.600000+00:00",
2686
- "end": "2020-01-16T10:45:03+00:00",
2687
- "cron": ""
2688
- },
2689
- "state": {
2690
- "is_public": true,
2691
- "is_display": true,
2692
- "is_archived": false
2693
- },
2694
- "ownership": {
2695
- "payable_category": "seller",
2696
- "payable_by": ""
2697
- },
2698
- "code": "percent50",
2699
- "rule_definition": {
2700
- "type": "percentage",
2701
- "scope": [
2702
- "category_id"
2703
- ],
2704
- "applicable_on": "quantity"
2705
- }
2706
- }
2707
- ],
2708
- "page": {
2709
- "has_next": true,
2710
- "size": 10,
2711
- "current": 1,
2712
- "item_total": 30
2713
- }
2714
- }
2715
- }
2716
- ```
2717
- </details>
2718
-
2719
- </details>
2720
-
2721
-
2722
-
2723
-
2724
-
2725
-
2726
-
2727
-
2728
-
2729
- ---
2730
-
2731
-
2732
- ### getPromotionById
2733
- Get with single promotion details or promotion list
2734
-
2735
-
2736
-
2737
- ```javascript
2738
- // Promise
2739
- const promise = client.application("<APPLICATION_ID>").cart.getPromotionById({ id : value });
2740
-
2741
- // Async/Await
2742
- const data = await client.application("<APPLICATION_ID>").cart.getPromotionById({ id : value });
2743
- ```
2744
-
2745
-
2746
-
2747
-
2748
-
2749
- | Argument | Type | Required | Description |
2750
- | --------- | ----- | -------- | ----------- |
2751
- | id | string | yes | |
2752
-
2753
-
2754
-
2755
- Get single promotion details with `id` in path param
2756
-
2757
- *Returned Response:*
2758
-
2759
-
2760
-
2761
-
2762
- [PromotionUpdate](#PromotionUpdate)
2763
-
2764
- Promotion object for sent `id`
2765
-
2766
-
2767
-
2768
-
2769
- <details>
2770
- <summary><i>&nbsp; Example:</i></summary>
2771
-
2772
- ```json
2773
- {
2774
- "_id": "61dc8dc9adf45b2273a70a6e",
2775
- "application_id": "000000000000000000000001",
2776
- "promo_group": "product",
2777
- "promotion_type": "bogo",
2778
- "date_meta": {
2779
- "modified_on": "2022-01-11T05:47:11.503000+00:00",
2780
- "created_on": "2022-01-10T19:49:29.917000+00:00"
2781
- },
2782
- "discount_rules": [
2783
- {
2784
- "buy_condition": "( rule#1 )",
2785
- "offer": {
2786
- "max_offer_quantity": 2
2787
- },
2788
- "discount_type": "bogo",
2789
- "item_criteria": {
2790
- "item_brand": [
2791
- 2,
2792
- 14,
2793
- 65
2794
- ]
2795
- }
2796
- }
2797
- ],
2798
- "buy_rules": {
2799
- "rule#1": {
2800
- "cart_quantity": {
2801
- "greater_than_equals": 5
2802
- },
2803
- "item_brand": [
2804
- 1,
2805
- 2,
2806
- 14,
2807
- 16,
2808
- 29,
2809
- 39,
2810
- 43,
2811
- 65,
2812
- 73
2813
- ]
2814
- }
2815
- },
2816
- "display_meta": {
2817
- "offer_text": "Test",
2818
- "name": "Test BOGO promo",
2819
- "description": "<p>Test</p>"
2820
- },
2821
- "apply_all_discount": false,
2822
- "apply_exclusive": null,
2823
- "stackable": true,
2824
- "restrictions": {
2825
- "user_id": [],
2826
- "anonymous_users": true,
2827
- "platforms": [
2828
- "web",
2829
- "android",
2830
- "ios"
2831
- ],
2832
- "post_order": {
2833
- "cancellation_allowed": true,
2834
- "return_allowed": true
2835
- },
2836
- "uses": {
2837
- "remaining": {
2838
- "user": 0,
2839
- "total": 0
2840
- },
2841
- "maximum": {
2842
- "user": 0,
2843
- "total": 0
2844
- }
2845
- },
2846
- "payments": []
2847
- },
2848
- "_custom_json": {},
2849
- "author": {
2850
- "created_by": "5",
2851
- "modified_by": "5"
2852
- },
2853
- "_schedule": {
2854
- "start": "2022-01-10T18:45:36.311Z",
2855
- "end": null,
2856
- "published": true,
2857
- "next_schedule": [
2858
- {
2859
- "start": "2022-01-10T18:45:36.311Z",
2860
- "end": null
2861
- }
2862
- ],
2863
- "cron": "",
2864
- "duration": 0
2865
- },
2866
- "apply_priority": 1,
2867
- "visiblility": {
2868
- "pdp": true,
2869
- "coupon_list": false
2870
- },
2871
- "ownership": {
2872
- "payable_by": "",
2873
- "payable_category": "seller"
2874
- },
2875
- "currency": "INR",
2876
- "mode": "promotion",
2877
- "post_order_action": {
2878
- "action_date": null,
2879
- "action_type": ""
2880
- },
2881
- "indexed_criteria": {
2882
- "item_brand": [
2883
- 1,
2884
- 2
2885
- ]
2886
- }
2887
- }
2888
- ```
2889
- </details>
2890
-
2891
-
2892
-
2893
-
2894
-
2895
-
2896
-
2897
-
2898
-
2899
- ---
2900
-
2901
-
2902
- ### getPromotions
2903
- Get promotion list
2904
-
2905
-
2906
-
2907
- ```javascript
2908
- // Promise
2909
- const promise = client.application("<APPLICATION_ID>").cart.getPromotions({ pageNo : value,
2910
- pageSize : value,
2911
- q : value,
2912
- isActive : value,
2913
- promoGroup : value,
2914
- promotionType : value,
2915
- fpPanel : value,
2916
- promotionId : value });
2917
-
2918
- // Async/Await
2919
- const data = await client.application("<APPLICATION_ID>").cart.getPromotions({ pageNo : value,
2920
- pageSize : value,
2921
- q : value,
2922
- isActive : value,
2923
- promoGroup : value,
2924
- promotionType : value,
2925
- fpPanel : value,
2926
- promotionId : value });
2927
- ```
2928
-
2929
-
2930
-
2931
-
2932
-
2933
- | Argument | Type | Required | Description |
2934
- | --------- | ----- | -------- | ----------- |
2935
- | pageNo | number | no | |
2936
- | pageSize | number | no | |
2937
- | q | string | no | |
2938
- | isActive | boolean | no | |
2939
- | promoGroup | string | no | |
2940
- | promotionType | string | no | |
2941
- | fpPanel | string | no | |
2942
- | promotionId | string | no | |
2943
-
2944
-
2945
-
2946
- Get promotion list with pagination
2947
-
2948
- *Returned Response:*
2949
-
2950
-
2951
-
2952
-
2953
- [PromotionsResponse](#PromotionsResponse)
2954
-
2955
- Promotion List for sent page_size and page_no
2956
-
2957
-
2958
-
2959
-
2960
- <details>
2961
- <summary><i>&nbsp; Examples:</i></summary>
2962
-
2963
-
2964
- <details>
2965
- <summary><i>&nbsp; Promotion list for sent filter and page size</i></summary>
2966
-
2967
- ```json
2968
- {
2969
- "value": {
2970
- "items": [
2971
- {
2972
- "_id": "61dc8dc9adf45b2273a70a6e",
2973
- "promo_group": "product",
2974
- "date_meta": {
2975
- "modified_on": "2022-01-11T05:47:11.503000+00:00",
2976
- "created_on": "2022-01-10T19:49:29.917000+00:00"
2977
- },
2978
- "display_meta": {
2979
- "name": "Test BOGO promo"
2980
- },
2981
- "author": {
2982
- "created_by": "5",
2983
- "modified_by": "5"
2984
- },
2985
- "_schedule": {
2986
- "start": "2022-01-10T18:45:36.311000+00:00",
2987
- "end": null,
2988
- "published": true,
2989
- "next_schedule": [
2990
- {
2991
- "start": "2022-01-10T18:45:36.311000+00:00",
2992
- "end": null
2993
- }
2994
- ],
2995
- "cron": "",
2996
- "duration": 0
2997
- }
2998
- }
2999
- ],
3000
- "page": {
3001
- "has_next": true,
3002
- "size": 10,
3003
- "current": 1,
3004
- "item_total": 30
3005
- }
3006
- }
3007
- }
3008
- ```
3009
- </details>
3010
-
3011
- </details>
3012
-
3013
-
3014
-
3015
-
3016
-
3017
-
3018
-
3019
-
3020
-
3021
- ---
3022
-
3023
-
3024
- ### updateCart
3025
- Update items in the abandoned cart
3026
-
3027
-
3028
-
3029
- ```javascript
3030
- // Promise
3031
- const promise = client.application("<APPLICATION_ID>").cart.updateCart({ cartId : value,
3032
- body : value,
3033
- b : value });
3034
-
3035
- // Async/Await
3036
- const data = await client.application("<APPLICATION_ID>").cart.updateCart({ cartId : value,
3037
- body : value,
3038
- b : value });
3039
- ```
3040
-
3041
-
3042
-
3043
-
3044
-
3045
- | Argument | Type | Required | Description |
3046
- | --------- | ----- | -------- | ----------- |
3047
- | cartId | string | yes | Current Cart _id |
3048
- | b | boolean | no | |
3049
- | body | [UpdateCartRequest](#UpdateCartRequest) | yes | Request body |
3050
-
3051
-
3052
- <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font> "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font> "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font> item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font> "/content​/v1​/products​/:identifier​/sizes​/price​/"</li> <li> <font color="monochrome">item_index</font> item position in the cart (must be greater than or equal to 0)</li> </ul>
3053
-
3054
- *Returned Response:*
3055
-
3056
-
3057
-
3058
-
3059
- [UpdateCartDetailResponse](#UpdateCartDetailResponse)
3060
-
3061
- Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponse` for more details.
3062
-
3063
-
3064
-
3065
-
3066
- <details>
3067
- <summary><i>&nbsp; Examples:</i></summary>
3068
-
3069
-
3070
- <details>
3071
- <summary><i>&nbsp; Nothing updated</i></summary>
3072
-
3073
- ```json
3074
- {
3075
- "value": {
3076
- "cart": {
3077
- "breakup_values": {
3078
- "raw": {
3079
- "cod_charge": 0,
3080
- "convenience_fee": 0,
3081
- "coupon": 0,
3082
- "delivery_charge": 0,
3083
- "discount": -202000,
3084
- "fynd_cash": 0,
3085
- "gst_charges": 4804.71,
3086
- "mrp_total": 302899,
3087
- "subtotal": 100899,
3088
- "total": 100899,
3089
- "vog": 96094.29,
3090
- "you_saved": 0
3091
- },
3092
- "coupon": {
3093
- "type": "cash",
3094
- "code": "",
3095
- "uid": null,
3096
- "value": 0,
3097
- "is_applied": false,
3098
- "message": "Sorry! Invalid Coupon"
3099
- },
3100
- "display": [
3101
- {
3102
- "display": "MRP Total",
3103
- "key": "mrp_total",
3104
- "value": 302899,
3105
- "currency_code": "INR"
3106
- },
3107
- {
3108
- "display": "Discount",
3109
- "key": "discount",
3110
- "value": -202000,
3111
- "currency_code": "INR"
3112
- },
3113
- {
3114
- "display": "Subtotal",
3115
- "key": "subtotal",
3116
- "value": 100899,
3117
- "currency_code": "INR"
3118
- },
3119
- {
3120
- "display": "Total",
3121
- "key": "total",
3122
- "value": 100899,
3123
- "currency_code": "INR"
3124
- }
3125
- ],
3126
- "loyalty_points": {
3127
- "total": 0,
3128
- "applicable": 0,
3129
- "is_applied": false,
3130
- "description": "Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."
3131
- }
3132
- },
3133
- "items": [
3134
- {
3135
- "bulk_offer": {},
3136
- "discount": "67% OFF",
3137
- "parent_item_identifiers": {
3138
- "identifier": "ZASFF",
3139
- "parent_item_id": 7501190,
3140
- "parent_item_size": "OS"
3141
- },
3142
- "article": {
3143
- "type": "article",
3144
- "uid": "604_902_SSTC60401_636BLUE_1",
3145
- "size": "1",
3146
- "seller": {
3147
- "uid": 604,
3148
- "name": "SHRI SHANTINATH TRADING COMPANY"
3149
- },
3150
- "store": {
3151
- "uid": 4579,
3152
- "name": "Gandhi Nagar"
3153
- },
3154
- "quantity": 108,
3155
- "price": {
3156
- "base": {
3157
- "marked": 2999,
3158
- "effective": 999,
3159
- "currency_code": "INR"
3160
- },
3161
- "converted": {
3162
- "marked": 2999,
3163
- "effective": 999,
3164
- "currency_code": "INR"
3165
- }
3166
- }
3167
- },
3168
- "coupon_message": "",
3169
- "key": "707569_1",
3170
- "availability": {
3171
- "sizes": [
3172
- "1",
3173
- "8",
3174
- "7",
3175
- "2",
3176
- "9",
3177
- "5",
3178
- "3",
3179
- "6"
3180
- ],
3181
- "other_store_quantity": 7,
3182
- "out_of_stock": false,
3183
- "deliverable": true,
3184
- "is_valid": true
3185
- },
3186
- "product": {
3187
- "type": "product",
3188
- "uid": 707569,
3189
- "name": "Blue and Gold Printed Ethnic Set",
3190
- "slug": "aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a",
3191
- "brand": {
3192
- "uid": 902,
3193
- "name": ""
3194
- },
3195
- "categories": [
3196
- {
3197
- "uid": 525,
3198
- "name": ""
3199
- }
3200
- ],
3201
- "images": [
3202
- {
3203
- "aspect_ratio": "16:25",
3204
- "url": "http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg",
3205
- "secure_url": "https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"
3206
- }
3207
- ],
3208
- "action": {
3209
- "type": "product",
3210
- "url": "https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/",
3211
- "query": {
3212
- "product_slug": [
3213
- "aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"
3214
- ]
3215
- }
3216
- }
3217
- },
3218
- "price": {
3219
- "base": {
3220
- "add_on": 100899,
3221
- "marked": 302899,
3222
- "effective": 100899,
3223
- "selling": 100899,
3224
- "currency_code": "INR"
3225
- },
3226
- "converted": {
3227
- "add_on": 100899,
3228
- "marked": 302899,
3229
- "effective": 100899,
3230
- "selling": 100899,
3231
- "currency_code": "INR"
3232
- }
3233
- },
3234
- "message": "",
3235
- "quantity": 101
3236
- }
3237
- ],
3238
- "delivery_charge_info": "",
3239
- "coupon_text": "View all offers",
3240
- "buy_now": false,
3241
- "cart_id": 54,
3242
- "uid": "54",
3243
- "gstin": null,
3244
- "checkout_mode": "self",
3245
- "restrict_checkout": false,
3246
- "is_valid": true,
3247
- "last_modified": "Tue, 03 Sep 2019 10:19:20 GMT"
3248
- },
3249
- "result": {
3250
- "707569_90": {
3251
- "success": true,
3252
- "message": "Nothing updated"
3253
- }
3254
- },
3255
- "message": "Nothing updated",
3256
- "success": true
3257
- }
3258
- }
3259
- ```
3260
- </details>
3261
-
3262
- <details>
3263
- <summary><i>&nbsp; Item updated in the cart</i></summary>
3264
-
3265
- ```json
3266
- {
3267
- "value": {
3268
- "cart": {
3269
- "breakup_values": {
3270
- "raw": {
3271
- "sub_total": 8000,
3272
- "subtotal": 8000,
3273
- "coupon": 0,
3274
- "promotion": -100,
3275
- "delivery_charge": 100,
3276
- "you_saved": 0,
3277
- "fynd_cash": 0,
3278
- "cod_charge": 0,
3279
- "total": 8000,
3280
- "gst_charges": 0,
3281
- "vog": 0,
3282
- "convenience_fee": 0,
3283
- "mrp_total": 20010,
3284
- "discount": -12010
3285
- },
3286
- "coupon": {
3287
- "type": "cash",
3288
- "code": "",
3289
- "uid": null,
3290
- "value": 0,
3291
- "is_applied": false,
3292
- "message": "Sorry! Invalid coupon"
3293
- },
3294
- "loyalty_points": {
3295
- "total": 0,
3296
- "applicable": 0,
3297
- "is_applied": false,
3298
- "description": "Your cashback, reward points, and refund amount get credited to Fynd Cash which can be redeemed while placing an order.",
3299
- "message": "Reward point not applicable with Coupon"
3300
- },
3301
- "display": [
3302
- {
3303
- "display": "MRP Total",
3304
- "key": "mrp_total",
3305
- "original": 20010,
3306
- "attr": "mrp_total",
3307
- "value": 20010,
3308
- "currency_code": "INR",
3309
- "currency_symbol": "₹",
3310
- "message": []
3311
- },
3312
- {
3313
- "display": "Discount",
3314
- "key": "discount",
3315
- "original": -12010,
3316
- "attr": "discount",
3317
- "value": -12010,
3318
- "currency_code": "INR",
3319
- "currency_symbol": "₹",
3320
- "message": []
3321
- },
3322
- {
3323
- "display": "Subtotal",
3324
- "key": "subtotal",
3325
- "original": 8000,
3326
- "attr": "subtotal",
3327
- "value": 8000,
3328
- "currency_code": "INR",
3329
- "currency_symbol": "₹",
3330
- "message": []
3331
- },
3332
- {
3333
- "display": "Promotion",
3334
- "key": "promotion",
3335
- "original": -100,
3336
- "attr": "promotion",
3337
- "value": -100,
3338
- "currency_code": "INR",
3339
- "currency_symbol": "₹",
3340
- "message": []
3341
- },
3342
- {
3343
- "display": "Delivery Charge",
3344
- "key": "delivery_charge",
3345
- "original": 100,
3346
- "attr": "delivery_charge",
3347
- "value": 100,
3348
- "currency_code": "INR",
3349
- "currency_symbol": "₹",
3350
- "message": [
3351
- "Delivery charges applicable ₹100.00 on order upto ₹10,000.00",
3352
- "Free delivery on order above ₹10,000.00"
3353
- ]
3354
- },
3355
- {
3356
- "display": "Total",
3357
- "key": "total",
3358
- "original": 8000,
3359
- "attr": "total",
3360
- "value": 8000,
3361
- "currency_code": "INR",
3362
- "currency_symbol": "₹",
3363
- "message": []
3364
- }
3365
- ]
3366
- },
3367
- "items": [
3368
- {
3369
- "parent_item_identifiers": {
3370
- "identifier": null,
3371
- "parent_item_size": null,
3372
- "parent_item_id": null
3373
- },
3374
- "article": {
3375
- "type": "article",
3376
- "uid": "618c1a6874b93908c98f6d18",
3377
- "size": "XL",
3378
- "product_group_tags": null,
3379
- "seller": {
3380
- "uid": 61,
3381
- "name": "FUCHSIA VINE DESIGNS PRIVATE LIMITED"
3382
- },
3383
- "store": {
3384
- "uid": 11491,
3385
- "name": "Store46"
3386
- },
3387
- "quantity": 200,
3388
- "price": {
3389
- "base": {
3390
- "marked": 2001,
3391
- "effective": 800,
3392
- "selling": 800,
3393
- "currency_code": "INR",
3394
- "currency_symbol": "₹"
3395
- },
3396
- "converted": {
3397
- "marked": 2001,
3398
- "effective": 800,
3399
- "selling": 800,
3400
- "currency_code": "INR",
3401
- "currency_symbol": "INR"
3402
- }
3403
- },
3404
- "extra_meta": {}
3405
- },
3406
- "product": {
3407
- "type": "product",
3408
- "uid": 75252592,
3409
- "name": "Nike Yellow Top",
3410
- "slug": "nike-black-top",
3411
- "brand": {
3412
- "uid": 18,
3413
- "name": "Nike"
3414
- },
3415
- "categories": [
3416
- {
3417
- "uid": 258,
3418
- "name": "Blouson Top"
3419
- }
3420
- ],
3421
- "attributes": {
3422
- "hsn_code": "62040000",
3423
- "short_description": "test description1",
3424
- "essential": "No",
3425
- "item_code": "1304678617",
3426
- "gender": "Women",
3427
- "currency": "INR",
3428
- "media": [
3429
- {
3430
- "url": "https://hdn-1.addsale.com/addsale/products/pictures/item/free/original/oy168nSHP-Nike-Black-Top.jpeg",
3431
- "type": "image"
3432
- }
3433
- ],
3434
- "marketer-address": "Tops Range",
3435
- "marketer-name": "Bandra(W), Link Road",
3436
- "brand_name": "Nike"
3437
- },
3438
- "images": [
3439
- {
3440
- "aspect_ratio": "16:25",
3441
- "url": "https://hdn-1.addsale.com/addsale/products/pictures/item/free/original/oy168nSHP-Nike-Black-Top.jpeg",
3442
- "secure_url": "https://hdn-1.addsale.com/addsale/products/pictures/item/free/original/oy168nSHP-Nike-Black-Top.jpeg"
3443
- }
3444
- ],
3445
- "action": {
3446
- "type": "product",
3447
- "url": "https://api.fyndx0.de/platform/content/v1/products/nike-black-top/",
3448
- "query": {
3449
- "product_slug": [
3450
- "nike-black-top"
3451
- ]
3452
- }
3453
- },
3454
- "item_code": "1304678617",
3455
- "_custom_json": {}
3456
- },
3457
- "message": "",
3458
- "price_per_unit": {
3459
- "base": {
3460
- "marked": 2001,
3461
- "effective": 800,
3462
- "selling_price": 800,
3463
- "currency_code": "INR",
3464
- "currency_symbol": "₹"
3465
- },
3466
- "converted": {
3467
- "marked": 2001,
3468
- "effective": 800,
3469
- "selling_price": 800,
3470
- "currency_code": "INR",
3471
- "currency_symbol": "₹"
3472
- }
3473
- },
3474
- "promo_meta": {},
3475
- "bulk_offer": {},
3476
- "price": {
3477
- "base": {
3478
- "add_on": 8000,
3479
- "marked": 20010,
3480
- "effective": 8000,
3481
- "selling": 8000,
3482
- "currency_code": "INR",
3483
- "currency_symbol": "₹"
3484
- },
3485
- "converted": {
3486
- "add_on": 8000,
3487
- "marked": 20010,
3488
- "effective": 8000,
3489
- "selling": 8000,
3490
- "currency_code": "INR",
3491
- "currency_symbol": "₹"
3492
- }
3493
- },
3494
- "is_set": false,
3495
- "identifiers": {
3496
- "identifier": "SfOmcAtTR4ut4pI_eVU6FQ"
3497
- },
3498
- "discount": "60% OFF",
3499
- "moq": {},
3500
- "availability": {
3501
- "sizes": [
3502
- "S",
3503
- "XL",
3504
- "L"
3505
- ],
3506
- "other_store_quantity": 984,
3507
- "out_of_stock": false,
3508
- "deliverable": true,
3509
- "is_valid": true,
3510
- "available_sizes": [
3511
- {
3512
- "is_available": true,
3513
- "display": "S",
3514
- "value": "S"
3515
- },
3516
- {
3517
- "is_available": true,
3518
- "display": "XL",
3519
- "value": "XL"
3520
- },
3521
- {
3522
- "is_available": false,
3523
- "display": "CLL",
3524
- "value": "CLL"
3525
- },
3526
- {
3527
- "is_available": true,
3528
- "display": "L",
3529
- "value": "L"
3530
- },
3531
- {
3532
- "is_available": false,
3533
- "display": "XLL",
3534
- "value": "XLL"
3535
- },
3536
- {
3537
- "is_available": false,
3538
- "display": "XLLL",
3539
- "value": "XLLL"
3540
- }
3541
- ]
3542
- },
3543
- "quantity": 10,
3544
- "promotions_applied": [
3545
- {
3546
- "promo_id": "62da8b75e951ea5e67b1454b",
3547
- "amount": 10,
3548
- "article_quantity": 10,
3549
- "mrp_promotion": false,
3550
- "promotion_type": "shipping_price",
3551
- "offer_text": "Free shipping 22/07/2"
3552
- }
3553
- ],
3554
- "key": "75252592_XL",
3555
- "delivery_promise": null,
3556
- "coupon_message": ""
3557
- }
3558
- ],
3559
- "cart_id": 22251,
3560
- "id": "62d4ff76d6aec8db897de407",
3561
- "uid": "22251",
3562
- "buy_now": false,
3563
- "gstin": null,
3564
- "comment": "",
3565
- "checkout_mode": "self",
3566
- "restrict_checkout": false,
3567
- "is_valid": true,
3568
- "currency": {
3569
- "code": "INR",
3570
- "symbol": "₹"
3571
- },
3572
- "last_modified": "Mon, 01 Aug 2022 09:33:20 GMT"
3573
- },
3574
- "message": "Item updated in the bag",
3575
- "success": true
3576
- }
3577
- }
3578
- ```
3579
- </details>
3580
-
3581
- </details>
3582
-
3583
-
3584
-
3585
-
3586
-
3587
-
3588
-
3589
-
3590
-
3591
- ---
3592
-
3593
-
3594
- ### updateCoupon
3595
- Update existing coupon configuration
3596
-
3597
-
3598
-
3599
- ```javascript
3600
- // Promise
3601
- const promise = client.application("<APPLICATION_ID>").cart.updateCoupon({ id : value,
3602
- body : value });
3603
-
3604
- // Async/Await
3605
- const data = await client.application("<APPLICATION_ID>").cart.updateCoupon({ id : value,
3606
- body : value });
3607
- ```
3608
-
3609
-
3610
-
3611
-
3612
-
3613
- | Argument | Type | Required | Description |
3614
- | --------- | ----- | -------- | ----------- |
3615
- | id | string | yes | |
3616
- | body | [CouponUpdate](#CouponUpdate) | yes | Request body |
3617
-
3618
-
3619
- Update coupon with id sent in `id`
3620
-
3621
- *Returned Response:*
3622
-
3623
-
3624
-
3625
-
3626
- [SuccessMessage](#SuccessMessage)
3627
-
3628
- Coupon updated successfully
3629
-
3630
-
3631
-
3632
-
3633
- <details>
3634
- <summary><i>&nbsp; Example:</i></summary>
3635
-
3636
- ```json
3637
- {
3638
- "success": true,
3639
- "message": "Coupon Updated"
3640
- }
3641
- ```
3642
- </details>
3643
-
3644
-
3645
-
3646
-
3647
-
3648
-
3649
-
3650
-
3651
-
3652
- ---
3653
-
3654
-
3655
- ### updateCouponPartially
3656
- Update coupon archive state and schedule
3657
-
3658
-
3659
-
3660
- ```javascript
3661
- // Promise
3662
- const promise = client.application("<APPLICATION_ID>").cart.updateCouponPartially({ id : value,
3663
- body : value });
3664
-
3665
- // Async/Await
3666
- const data = await client.application("<APPLICATION_ID>").cart.updateCouponPartially({ id : value,
3667
- body : value });
3668
- ```
3669
-
3670
-
3671
-
3672
-
3673
-
3674
- | Argument | Type | Required | Description |
3675
- | --------- | ----- | -------- | ----------- |
3676
- | id | string | yes | |
3677
- | body | [CouponPartialUpdate](#CouponPartialUpdate) | yes | Request body |
3678
-
3679
-
3680
- Update archive/unarchive and change schedule for coupon
3681
-
3682
- *Returned Response:*
3683
-
3684
-
3685
-
3686
-
3687
- [SuccessMessage](#SuccessMessage)
3688
-
3689
- Coupon updated successfully
3690
-
3691
-
3692
-
3693
-
3694
- <details>
3695
- <summary><i>&nbsp; Examples:</i></summary>
3696
-
3697
-
3698
- <details>
3699
- <summary><i>&nbsp; Archive or Unarchive coupon</i></summary>
3700
-
3701
- ```json
3702
- {
3703
- "value": {
3704
- "success": true,
3705
- "message": "Coupon Updated"
3706
- }
3707
- }
3708
- ```
3709
- </details>
3710
-
3711
- <details>
3712
- <summary><i>&nbsp; Coupon schedule updated successfully</i></summary>
3713
-
3714
- ```json
3715
- {
3716
- "value": {
3717
- "success": true,
3718
- "message": "Coupon schedule updated"
3719
- }
3720
- }
3721
- ```
3722
- </details>
3723
-
3724
- </details>
3725
-
3726
-
3727
-
3728
-
3729
-
3730
-
3731
-
3732
-
3733
-
3734
- ---
3735
-
3736
-
3737
- ### updatePromotion
3738
- Update existing promotion configuration
3739
-
3740
-
3741
-
3742
- ```javascript
3743
- // Promise
3744
- const promise = client.application("<APPLICATION_ID>").cart.updatePromotion({ id : value,
3745
- body : value });
3746
-
3747
- // Async/Await
3748
- const data = await client.application("<APPLICATION_ID>").cart.updatePromotion({ id : value,
3749
- body : value });
3750
- ```
3751
-
3752
-
3753
-
3754
-
3755
-
3756
- | Argument | Type | Required | Description |
3757
- | --------- | ----- | -------- | ----------- |
3758
- | id | string | yes | |
3759
- | body | [PromotionUpdate](#PromotionUpdate) | yes | Request body |
3760
-
3761
-
3762
- Update promotion with id sent in `id`
3763
-
3764
- *Returned Response:*
3765
-
3766
-
3767
-
3768
-
3769
- [PromotionUpdate](#PromotionUpdate)
3770
-
3771
- Promotion updated successfully
3772
-
3773
-
3774
-
3775
-
3776
- <details>
3777
- <summary><i>&nbsp; Example:</i></summary>
3778
-
3779
- ```json
3780
- {
3781
- "_id": "61dc8dc9adf45b2273a70a6e",
3782
- "application_id": "000000000000000000000001",
3783
- "promo_group": "product",
3784
- "promotion_type": "bogo",
3785
- "date_meta": {
3786
- "modified_on": "2022-01-11T05:47:11.503000+00:00",
3787
- "created_on": "2022-01-10T19:49:29.917000+00:00"
3788
- },
3789
- "discount_rules": [
3790
- {
3791
- "buy_condition": "( rule#1 )",
3792
- "offer": {
3793
- "max_offer_quantity": 2
3794
- },
3795
- "discount_type": "bogo",
3796
- "item_criteria": {
3797
- "item_brand": [
3798
- 2,
3799
- 14,
3800
- 65
3801
- ]
3802
- }
3803
- }
3804
- ],
3805
- "buy_rules": {
3806
- "rule#1": {
3807
- "cart_quantity": {
3808
- "greater_than_equals": 5
3809
- },
3810
- "item_brand": [
3811
- 1,
3812
- 2,
3813
- 14,
3814
- 16,
3815
- 29,
3816
- 39,
3817
- 43,
3818
- 65,
3819
- 73
3820
- ]
3821
- }
3822
- },
3823
- "display_meta": {
3824
- "offer_text": "Test",
3825
- "name": "Test BOGO promo",
3826
- "description": "<p>Test</p>"
3827
- },
3828
- "apply_all_discount": false,
3829
- "apply_exclusive": null,
3830
- "stackable": true,
3831
- "restrictions": {
3832
- "user_id": [],
3833
- "anonymous_users": true,
3834
- "platforms": [
3835
- "web",
3836
- "android",
3837
- "ios"
3838
- ],
3839
- "post_order": {
3840
- "cancellation_allowed": true,
3841
- "return_allowed": true
3842
- },
3843
- "uses": {
3844
- "remaining": {
3845
- "user": 0,
3846
- "total": 0
3847
- },
3848
- "maximum": {
3849
- "user": 0,
3850
- "total": 0
3851
- }
3852
- },
3853
- "payments": []
3854
- },
3855
- "_custom_json": {},
3856
- "author": {
3857
- "created_by": "5",
3858
- "modified_by": "5"
3859
- },
3860
- "_schedule": {
3861
- "start": "2022-01-10T18:45:36.311Z",
3862
- "end": null,
3863
- "published": true,
3864
- "next_schedule": [
3865
- {
3866
- "start": "2022-01-10T18:45:36.311Z",
3867
- "end": null
3868
- }
3869
- ],
3870
- "cron": "",
3871
- "duration": 0
3872
- },
3873
- "apply_priority": 1,
3874
- "visiblility": {
3875
- "pdp": true,
3876
- "coupon_list": false
3877
- },
3878
- "ownership": {
3879
- "payable_by": "",
3880
- "payable_category": "seller"
3881
- },
3882
- "currency": "INR",
3883
- "mode": "promotion",
3884
- "post_order_action": {
3885
- "action_date": null,
3886
- "action_type": ""
3887
- },
3888
- "indexed_criteria": {
3889
- "item_brand": [
3890
- 1,
3891
- 2
3892
- ]
3893
- }
3894
- }
3895
- ```
3896
- </details>
3897
-
3898
-
3899
-
3900
-
3901
-
3902
-
3903
-
3904
-
3905
-
3906
- ---
3907
-
3908
-
3909
- ### updatePromotionPartially
3910
- Update promotion publish state and schedule
3911
-
3912
-
3913
-
3914
- ```javascript
3915
- // Promise
3916
- const promise = client.application("<APPLICATION_ID>").cart.updatePromotionPartially({ id : value,
3917
- body : value });
3918
-
3919
- // Async/Await
3920
- const data = await client.application("<APPLICATION_ID>").cart.updatePromotionPartially({ id : value,
3921
- body : value });
3922
- ```
3923
-
3924
-
3925
-
3926
-
3927
-
3928
- | Argument | Type | Required | Description |
3929
- | --------- | ----- | -------- | ----------- |
3930
- | id | string | yes | |
3931
- | body | [PromotionPartialUpdate](#PromotionPartialUpdate) | yes | Request body |
3932
-
3933
-
3934
- Update publish/unpublish and change schedule for promotion
3935
-
3936
- *Returned Response:*
3937
-
3938
-
3939
-
3940
-
3941
- [SuccessMessage](#SuccessMessage)
3942
-
3943
- Promotion updated successfully
3944
-
3945
-
3946
-
3947
-
3948
- <details>
3949
- <summary><i>&nbsp; Examples:</i></summary>
3950
-
3951
-
3952
- <details>
3953
- <summary><i>&nbsp; Publish or Unpublish promotion</i></summary>
3954
-
3955
- ```json
3956
- {
3957
- "value": {
3958
- "success": true,
3959
- "message": "Promotion Updated"
3960
- }
3961
- }
3962
- ```
3963
- </details>
3964
-
3965
- <details>
3966
- <summary><i>&nbsp; Promotion schedule updated successfully</i></summary>
3967
-
3968
- ```json
3969
- {
3970
- "value": {
3971
- "success": true,
3972
- "message": "Promotion schedule updated"
3973
- }
3974
- }
3975
- ```
3976
- </details>
3977
-
3978
- </details>
3979
-
3980
-
3981
-
3982
-
3983
-
3984
-
3985
-
3986
-
3987
-
3988
- ---
3989
-
3990
-
3991
-
3992
- ### Schemas
3993
-
3994
-
3995
- #### [AbandonedCart](#AbandonedCart)
3996
-
3997
- | Properties | Type | Nullable | Description |
3998
- | ---------- | ---- | -------- | ----------- || _id | string | yes | || app_id | string | no | || articles | [string] | yes | || bulk_coupon_discount | number | no | || buy_now | boolean | no | || cart_value | number | no | || cashback | string | yes | || checkout_mode | string | no | || cod_charges | string | no | || comment | string | no | || coupon | string | no | || created_on | string | yes | || delivery_charges | string | no | || discount | number | no | || expire_at | string | yes | || fc_index_map | [number] | no | || fynd_credits | string | no | || gstin | string | no | || is_active | boolean | no | || is_archive | boolean | no | || is_default | boolean | yes | || last_modified | string | yes | || merge_qty | boolean | no | || meta | string | no | || order_id | string | no | || payment_methods | [string] | no | || payment_mode | string | no | || payments | string | no | || pick_up_customer_details | string | no | || promotion | string | no | || shipments | [string] | no | || uid | number | yes | || user_id | string | yes | |
3999
-
4000
- ---
4001
-
4002
- #### [AbandonedCartResponse](#AbandonedCartResponse)
4003
-
4004
- | Properties | Type | Nullable | Description |
4005
- | ---------- | ---- | -------- | ----------- || items | [[AbandonedCart](#AbandonedCart)] | no | || message | string | no | || page | [Page](#Page) | no | || result | string | no | || success | boolean | no | |
4006
-
4007
- ---
4008
-
4009
- #### [ActionQuery](#ActionQuery)
4010
-
4011
- | Properties | Type | Nullable | Description |
4012
- | ---------- | ---- | -------- | ----------- || product_slug | [string] | no | |
4013
-
4014
- ---
4015
-
4016
- #### [AddCartDetailResponse](#AddCartDetailResponse)
4017
-
4018
- | Properties | Type | Nullable | Description |
4019
- | ---------- | ---- | -------- | ----------- || cart | [CartDetailResponse](#CartDetailResponse) | no | || message | string | no | || partial | boolean | no | || success | boolean | no | |
4020
-
4021
- ---
4022
-
4023
- #### [AddCartRequest](#AddCartRequest)
4024
-
4025
- | Properties | Type | Nullable | Description |
4026
- | ---------- | ---- | -------- | ----------- || items | [[AddProductCart](#AddProductCart)] | no | |
4027
-
4028
- ---
4029
-
4030
- #### [AddProductCart](#AddProductCart)
4031
-
4032
- | Properties | Type | Nullable | Description |
4033
- | ---------- | ---- | -------- | ----------- || _custom_json | string | no | || article_assignment | string | no | || article_id | string | no | || display | string | no | || extra_meta | string | no | || item_id | number | no | || item_size | string | no | || parent_item_identifiers | string | no | || pos | boolean | no | || product_group_tags | [string] | no | || quantity | number | no | || seller_id | number | no | || store_id | number | no | |
4034
-
4035
- ---
4036
-
4037
- #### [AppliedPromotion](#AppliedPromotion)
4038
-
4039
- | Properties | Type | Nullable | Description |
4040
- | ---------- | ---- | -------- | ----------- || amount | number | no | || article_quantity | number | no | || mrp_promotion | boolean | no | || offer_text | string | no | || ownership | [Ownership2](#Ownership2) | no | || promo_id | string | no | || promotion_type | string | no | |
4041
-
4042
- ---
4043
-
4044
- #### [ArticlePriceInfo](#ArticlePriceInfo)
4045
-
4046
- | Properties | Type | Nullable | Description |
4047
- | ---------- | ---- | -------- | ----------- || base | [BasePrice](#BasePrice) | no | || converted | [BasePrice](#BasePrice) | no | |
4048
-
4049
- ---
4050
-
4051
- #### [BaseInfo](#BaseInfo)
4052
-
4053
- | Properties | Type | Nullable | Description |
4054
- | ---------- | ---- | -------- | ----------- || name | string | no | || uid | number | no | |
4055
-
4056
- ---
4057
-
4058
- #### [BasePrice](#BasePrice)
4059
-
4060
- | Properties | Type | Nullable | Description |
4061
- | ---------- | ---- | -------- | ----------- || currency_code | string | no | || currency_symbol | string | no | || effective | number | no | || marked | number | no | |
4062
-
4063
- ---
4064
-
4065
- #### [BulkBundleRestriction](#BulkBundleRestriction)
4066
-
4067
- | Properties | Type | Nullable | Description |
4068
- | ---------- | ---- | -------- | ----------- || multi_store_allowed | boolean | yes | |
4069
-
4070
- ---
4071
-
4072
- #### [CartBreakup](#CartBreakup)
4073
-
4074
- | Properties | Type | Nullable | Description |
4075
- | ---------- | ---- | -------- | ----------- || coupon | [CouponBreakup](#CouponBreakup) | no | || display | [[DisplayBreakup](#DisplayBreakup)] | no | || loyalty_points | [LoyaltyPoints](#LoyaltyPoints) | no | || raw | [RawBreakup](#RawBreakup) | no | |
4076
-
4077
- ---
4078
-
4079
- #### [CartCurrency](#CartCurrency)
4080
-
4081
- | Properties | Type | Nullable | Description |
4082
- | ---------- | ---- | -------- | ----------- || code | string | no | || symbol | string | no | |
4083
-
4084
- ---
4085
-
4086
- #### [CartDetailResponse](#CartDetailResponse)
4087
-
4088
- | Properties | Type | Nullable | Description |
4089
- | ---------- | ---- | -------- | ----------- || applied_promo_details | [[AppliedPromotion](#AppliedPromotion)] | no | || breakup_values | [CartBreakup](#CartBreakup) | no | || buy_now | boolean | no | || checkout_mode | string | no | || comment | string | no | || coupon_text | string | no | || currency | [CartCurrency](#CartCurrency) | no | || delivery_charge_info | string | no | || delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | || gstin | string | no | || id | string | no | || is_valid | boolean | no | || items | [[CartProductInfo](#CartProductInfo)] | no | || last_modified | string | no | || message | string | no | || payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | || restrict_checkout | boolean | no | |
4090
-
4091
- ---
4092
-
4093
- #### [CartItem](#CartItem)
4094
-
4095
- | Properties | Type | Nullable | Description |
4096
- | ---------- | ---- | -------- | ----------- || product_id | string | yes | || quantity | number | no | || size | string | yes | |
4097
-
4098
- ---
4099
-
4100
- #### [CartItemMeta](#CartItemMeta)
4101
-
4102
- | Properties | Type | Nullable | Description |
4103
- | ---------- | ---- | -------- | ----------- || group_id | string | no | || primary_item | boolean | no | |
4104
-
4105
- ---
4106
-
4107
- #### [CartProduct](#CartProduct)
4108
-
4109
- | Properties | Type | Nullable | Description |
4110
- | ---------- | ---- | -------- | ----------- || action | [ProductAction](#ProductAction) | no | || brand | [BaseInfo](#BaseInfo) | no | || categories | [[CategoryInfo](#CategoryInfo)] | no | || images | [[ProductImage](#ProductImage)] | no | || name | string | no | || slug | string | no | || type | string | no | || uid | number | no | |
4111
-
4112
- ---
4113
-
4114
- #### [CartProductIdentifer](#CartProductIdentifer)
4115
-
4116
- | Properties | Type | Nullable | Description |
4117
- | ---------- | ---- | -------- | ----------- || identifier | string | no | |
4118
-
4119
- ---
4120
-
4121
- #### [CartProductInfo](#CartProductInfo)
4122
-
4123
- | Properties | Type | Nullable | Description |
4124
- | ---------- | ---- | -------- | ----------- || article | [ProductArticle](#ProductArticle) | no | || availability | [ProductAvailability](#ProductAvailability) | no | || bulk_offer | string | no | || coupon_message | string | no | || delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | || discount | string | no | || identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | || is_set | boolean | no | || key | string | no | || message | string | no | || moq | string | no | || parent_item_identifiers | string | no | || price | [ProductPriceInfo](#ProductPriceInfo) | no | || price_per_unit | [ProductPriceInfo](#ProductPriceInfo) | no | || product | [CartProduct](#CartProduct) | no | || promo_meta | [PromoMeta](#PromoMeta) | no | || promotions_applied | [[AppliedPromotion](#AppliedPromotion)] | no | || quantity | number | no | |
4125
-
4126
- ---
4127
-
4128
- #### [CategoryInfo](#CategoryInfo)
4129
-
4130
- | Properties | Type | Nullable | Description |
4131
- | ---------- | ---- | -------- | ----------- || name | string | no | || uid | number | no | |
4132
-
4133
- ---
4134
-
4135
- #### [CompareObject](#CompareObject)
4136
-
4137
- | Properties | Type | Nullable | Description |
4138
- | ---------- | ---- | -------- | ----------- || equals | number | no | || greater_than | number | no | || greater_than_equals | number | no | || less_than | number | no | || less_than_equals | number | no | |
4139
-
4140
- ---
4141
-
4142
- #### [CouponAction](#CouponAction)
4143
-
4144
- | Properties | Type | Nullable | Description |
4145
- | ---------- | ---- | -------- | ----------- || action_date | string | no | || txn_mode | string | no | |
4146
-
4147
- ---
4148
-
4149
- #### [CouponAdd](#CouponAdd)
4150
-
4151
- | Properties | Type | Nullable | Description |
4152
- | ---------- | ---- | -------- | ----------- || _schedule | [CouponSchedule](#CouponSchedule) | no | || action | [CouponAction](#CouponAction) | no | || author | [CouponAuthor](#CouponAuthor) | no | || code | string | yes | || date_meta | [CouponDateMeta](#CouponDateMeta) | no | || display_meta | [DisplayMeta](#DisplayMeta) | yes | || identifiers | [Identifier](#Identifier) | yes | || ownership | [Ownership](#Ownership) | yes | || restrictions | [Restrictions](#Restrictions) | no | || rule | [[Rule](#Rule)] | yes | || rule_definition | [RuleDefinition](#RuleDefinition) | yes | || state | [State](#State) | no | || tags | [string] | no | || type_slug | string | yes | || validation | [Validation](#Validation) | no | || validity | [Validity](#Validity) | yes | |
4153
-
4154
- ---
4155
-
4156
- #### [CouponAuthor](#CouponAuthor)
4157
-
4158
- | Properties | Type | Nullable | Description |
4159
- | ---------- | ---- | -------- | ----------- || created_by | string | no | || modified_by | string | no | |
4160
-
4161
- ---
4162
-
4163
- #### [CouponBreakup](#CouponBreakup)
4164
-
4165
- | Properties | Type | Nullable | Description |
4166
- | ---------- | ---- | -------- | ----------- || code | string | no | || is_applied | boolean | no | || message | string | no | || type | string | no | || uid | string | no | || value | number | no | |
4167
-
4168
- ---
4169
-
4170
- #### [CouponDateMeta](#CouponDateMeta)
4171
-
4172
- | Properties | Type | Nullable | Description |
4173
- | ---------- | ---- | -------- | ----------- || created_on | string | no | || modified_on | string | no | |
4174
-
4175
- ---
4176
-
4177
- #### [CouponPartialUpdate](#CouponPartialUpdate)
4178
-
4179
- | Properties | Type | Nullable | Description |
4180
- | ---------- | ---- | -------- | ----------- || archive | boolean | no | || schedule | [CouponSchedule](#CouponSchedule) | no | |
4181
-
4182
- ---
4183
-
4184
- #### [CouponSchedule](#CouponSchedule)
4185
-
4186
- | Properties | Type | Nullable | Description |
4187
- | ---------- | ---- | -------- | ----------- || cron | string | no | || duration | number | no | || end | string | no | || next_schedule | [string] | no | || start | string | no | |
4188
-
4189
- ---
4190
-
4191
- #### [CouponsResponse](#CouponsResponse)
4192
-
4193
- | Properties | Type | Nullable | Description |
4194
- | ---------- | ---- | -------- | ----------- || items | [CouponAdd](#CouponAdd) | no | || page | [Page](#Page) | no | |
4195
-
4196
- ---
4197
-
4198
- #### [CouponUpdate](#CouponUpdate)
4199
-
4200
- | Properties | Type | Nullable | Description |
4201
- | ---------- | ---- | -------- | ----------- || _schedule | [CouponSchedule](#CouponSchedule) | no | || action | [CouponAction](#CouponAction) | no | || author | [CouponAuthor](#CouponAuthor) | no | || code | string | yes | || date_meta | [CouponDateMeta](#CouponDateMeta) | no | || display_meta | [DisplayMeta](#DisplayMeta) | yes | || identifiers | [Identifier](#Identifier) | yes | || ownership | [Ownership](#Ownership) | yes | || restrictions | [Restrictions](#Restrictions) | no | || rule | [[Rule](#Rule)] | yes | || rule_definition | [RuleDefinition](#RuleDefinition) | yes | || state | [State](#State) | no | || tags | [string] | no | || type_slug | string | yes | || validation | [Validation](#Validation) | no | || validity | [Validity](#Validity) | yes | |
4202
-
4203
- ---
4204
-
4205
- #### [DiscountOffer](#DiscountOffer)
4206
-
4207
- | Properties | Type | Nullable | Description |
4208
- | ---------- | ---- | -------- | ----------- || code | string | no | || discount_amount | number | no | || discount_percentage | number | no | || discount_price | number | no | || max_discount_amount | number | no | || max_offer_quantity | number | no | || min_offer_quantity | number | no | |
4209
-
4210
- ---
4211
-
4212
- #### [DiscountRule](#DiscountRule)
4213
-
4214
- | Properties | Type | Nullable | Description |
4215
- | ---------- | ---- | -------- | ----------- || buy_condition | string | yes | || discount_type | string | yes | || item_criteria | [ItemCriteria](#ItemCriteria) | yes | || offer | [DiscountOffer](#DiscountOffer) | yes | |
4216
-
4217
- ---
4218
-
4219
- #### [DisplayBreakup](#DisplayBreakup)
4220
-
4221
- | Properties | Type | Nullable | Description |
4222
- | ---------- | ---- | -------- | ----------- || currency_code | string | no | || currency_symbol | string | no | || display | string | no | || key | string | no | || message | [string] | no | || value | number | no | |
4223
-
4224
- ---
4225
-
4226
- #### [DisplayMeta](#DisplayMeta)
4227
-
4228
- | Properties | Type | Nullable | Description |
4229
- | ---------- | ---- | -------- | ----------- || apply | [DisplayMetaDict](#DisplayMetaDict) | no | || auto | [DisplayMetaDict](#DisplayMetaDict) | no | || description | string | no | || remove | [DisplayMetaDict](#DisplayMetaDict) | no | || subtitle | string | no | || title | string | no | |
4230
-
4231
- ---
4232
-
4233
- #### [DisplayMeta1](#DisplayMeta1)
4234
-
4235
- | Properties | Type | Nullable | Description |
4236
- | ---------- | ---- | -------- | ----------- || description | string | no | || name | string | no | || offer_text | string | no | |
4237
-
4238
- ---
4239
-
4240
- #### [DisplayMetaDict](#DisplayMetaDict)
4241
-
4242
- | Properties | Type | Nullable | Description |
4243
- | ---------- | ---- | -------- | ----------- || subtitle | string | no | || title | string | no | |
4244
-
4245
- ---
4246
-
4247
- #### [Identifier](#Identifier)
4248
-
4249
- | Properties | Type | Nullable | Description |
4250
- | ---------- | ---- | -------- | ----------- || article_id | [string] | no | || brand_id | [number] | no | || category_id | [number] | no | || collection_id | [string] | no | || company_id | [number] | no | || exclude_brand_id | [number] | no | || item_id | [number] | no | || store_id | [number] | no | || user_id | [string] | no | |
4251
-
4252
- ---
4253
-
4254
- #### [ItemCriteria](#ItemCriteria)
4255
-
4256
- | Properties | Type | Nullable | Description |
4257
- | ---------- | ---- | -------- | ----------- || all_items | boolean | no | || buy_rules | [string] | no | || cart_quantity | [CompareObject](#CompareObject) | no | || cart_total | [CompareObject](#CompareObject) | no | || item_brand | [number] | no | || item_category | [number] | no | || item_company | [number] | no | || item_exclude_brand | [number] | no | || item_exclude_category | [number] | no | || item_exclude_company | [number] | no | || item_exclude_sku | [string] | no | || item_exclude_store | [number] | no | || item_id | [number] | no | || item_size | [string] | no | || item_sku | [string] | no | || item_store | [number] | no | |
4258
-
4259
- ---
4260
-
4261
- #### [LoyaltyPoints](#LoyaltyPoints)
4262
-
4263
- | Properties | Type | Nullable | Description |
4264
- | ---------- | ---- | -------- | ----------- || applicable | number | no | || description | string | no | || is_applied | boolean | no | || total | number | no | |
4265
-
4266
- ---
4267
-
4268
- #### [MultiTenderPaymentMeta](#MultiTenderPaymentMeta)
4269
-
4270
- | Properties | Type | Nullable | Description |
4271
- | ---------- | ---- | -------- | ----------- || current_status | string | no | || extra_meta | string | no | || order_id | string | no | || payment_gateway | string | no | || payment_id | string | no | |
4272
-
4273
- ---
4274
-
4275
- #### [MultiTenderPaymentMethod](#MultiTenderPaymentMethod)
4276
-
4277
- | Properties | Type | Nullable | Description |
4278
- | ---------- | ---- | -------- | ----------- || amount | number | yes | || meta | [MultiTenderPaymentMeta](#MultiTenderPaymentMeta) | no | || mode | string | yes | || name | string | no | |
4279
-
4280
- ---
4281
-
4282
- #### [OpenapiCartDetailsRequest](#OpenapiCartDetailsRequest)
4283
-
4284
- | Properties | Type | Nullable | Description |
4285
- | ---------- | ---- | -------- | ----------- || cart_items | [CartItem](#CartItem) | no | |
4286
-
4287
- ---
4288
-
4289
- #### [OpenapiCartDetailsResponse](#OpenapiCartDetailsResponse)
4290
-
4291
- | Properties | Type | Nullable | Description |
4292
- | ---------- | ---- | -------- | ----------- || breakup_values | [CartBreakup](#CartBreakup) | no | || is_valid | boolean | no | || items | [[CartProductInfo](#CartProductInfo)] | no | || message | string | no | |
4293
-
4294
- ---
4295
-
4296
- #### [OpenApiCartServiceabilityRequest](#OpenApiCartServiceabilityRequest)
4297
-
4298
- | Properties | Type | Nullable | Description |
4299
- | ---------- | ---- | -------- | ----------- || cart_items | [CartItem](#CartItem) | no | || shipping_address | [ShippingAddress](#ShippingAddress) | yes | |
4300
-
4301
- ---
4302
-
4303
- #### [OpenApiCartServiceabilityResponse](#OpenApiCartServiceabilityResponse)
4304
-
4305
- | Properties | Type | Nullable | Description |
4306
- | ---------- | ---- | -------- | ----------- || breakup_values | [CartBreakup](#CartBreakup) | no | || delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | || is_valid | boolean | no | || items | [[CartProductInfo](#CartProductInfo)] | no | || message | string | no | |
4307
-
4308
- ---
4309
-
4310
- #### [OpenApiCheckoutResponse](#OpenApiCheckoutResponse)
4311
-
4312
- | Properties | Type | Nullable | Description |
4313
- | ---------- | ---- | -------- | ----------- || message | string | no | || order_id | string | yes | || order_ref_id | string | no | || success | boolean | no | |
4314
-
4315
- ---
4316
-
4317
- #### [OpenApiErrorResponse](#OpenApiErrorResponse)
4318
-
4319
- | Properties | Type | Nullable | Description |
4320
- | ---------- | ---- | -------- | ----------- || errors | string | no | || message | string | no | || success | boolean | no | |
4321
-
4322
- ---
4323
-
4324
- #### [OpenApiFiles](#OpenApiFiles)
4325
-
4326
- | Properties | Type | Nullable | Description |
4327
- | ---------- | ---- | -------- | ----------- || key | string | yes | || values | [string] | yes | |
4328
-
4329
- ---
4330
-
4331
- #### [OpenApiOrderItem](#OpenApiOrderItem)
4332
-
4333
- | Properties | Type | Nullable | Description |
4334
- | ---------- | ---- | -------- | ----------- || amount_paid | number | yes | || cashback_applied | number | yes | || cod_charges | number | yes | || coupon_effective_discount | number | yes | || delivery_charges | number | yes | || discount | number | yes | || employee_discount | number | no | || extra_meta | string | no | || files | [[OpenApiFiles](#OpenApiFiles)] | no | || loyalty_discount | number | no | || meta | [CartItemMeta](#CartItemMeta) | no | || payment_methods | [[MultiTenderPaymentMethod](#MultiTenderPaymentMethod)] | yes | || price_effective | number | yes | || price_marked | number | yes | || product_id | number | yes | || quantity | number | no | || size | string | yes | |
4335
-
4336
- ---
4337
-
4338
- #### [OpenApiPlatformCheckoutReq](#OpenApiPlatformCheckoutReq)
4339
-
4340
- | Properties | Type | Nullable | Description |
4341
- | ---------- | ---- | -------- | ----------- || affiliate_order_id | string | no | || billing_address | [ShippingAddress](#ShippingAddress) | yes | || cart_items | [[OpenApiOrderItem](#OpenApiOrderItem)] | yes | || cart_value | number | yes | || cashback_applied | number | yes | || cod_charges | number | yes | || comment | string | no | || coupon | string | no | || coupon_code | string | yes | || coupon_value | number | yes | || currency_code | string | no | || delivery_charges | number | yes | || employee_discount | string | no | || files | [[OpenApiFiles](#OpenApiFiles)] | no | || gstin | string | no | || loyalty_discount | number | no | || order_id | string | no | || payment_methods | [[MultiTenderPaymentMethod](#MultiTenderPaymentMethod)] | yes | || payment_mode | string | no | || shipping_address | [ShippingAddress](#ShippingAddress) | no | |
4342
-
4343
- ---
4344
-
4345
- #### [OperationErrorResponse](#OperationErrorResponse)
4346
-
4347
- | Properties | Type | Nullable | Description |
4348
- | ---------- | ---- | -------- | ----------- || message | string | no | || success | boolean | no | |
4349
-
4350
- ---
4351
-
4352
- #### [Ownership](#Ownership)
4353
-
4354
- | Properties | Type | Nullable | Description |
4355
- | ---------- | ---- | -------- | ----------- || payable_by | string | yes | || payable_category | string | yes | |
4356
-
4357
- ---
4358
-
4359
- #### [Ownership1](#Ownership1)
4360
-
4361
- | Properties | Type | Nullable | Description |
4362
- | ---------- | ---- | -------- | ----------- || payable_by | string | yes | || payable_category | string | yes | |
4363
-
4364
- ---
4365
-
4366
- #### [Ownership2](#Ownership2)
4367
-
4368
- | Properties | Type | Nullable | Description |
4369
- | ---------- | ---- | -------- | ----------- || payable_by | string | no | || payable_category | string | no | |
4370
-
4371
- ---
4372
-
4373
- #### [Page](#Page)
4374
-
4375
- | Properties | Type | Nullable | Description |
4376
- | ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || has_previous | boolean | no | || item_total | number | no | || last_id | string | no | || next_id | string | no | || page | number | no | || size | number | no | || type | string | yes | |
4377
-
4378
- ---
4379
-
4380
- #### [PaymentAllowValue](#PaymentAllowValue)
4381
-
4382
- | Properties | Type | Nullable | Description |
4383
- | ---------- | ---- | -------- | ----------- || max | number | no | |
4384
-
4385
- ---
4386
-
4387
- #### [PaymentAllowValue1](#PaymentAllowValue1)
4388
-
4389
- | Properties | Type | Nullable | Description |
4390
- | ---------- | ---- | -------- | ----------- || max | number | no | |
4391
-
4392
- ---
4393
-
4394
- #### [PaymentModes](#PaymentModes)
4395
-
4396
- | Properties | Type | Nullable | Description |
4397
- | ---------- | ---- | -------- | ----------- || codes | [string] | no | || networks | [string] | no | || types | [string] | no | || uses | [PaymentAllowValue](#PaymentAllowValue) | no | |
4398
-
4399
- ---
4400
-
4401
- #### [PaymentSelectionLock](#PaymentSelectionLock)
4402
-
4403
- | Properties | Type | Nullable | Description |
4404
- | ---------- | ---- | -------- | ----------- || default_options | string | no | || enabled | boolean | no | || payment_identifier | string | no | |
4405
-
4406
- ---
4407
-
4408
- #### [PostOrder](#PostOrder)
4409
-
4410
- | Properties | Type | Nullable | Description |
4411
- | ---------- | ---- | -------- | ----------- || cancellation_allowed | boolean | no | || return_allowed | boolean | no | |
4412
-
4413
- ---
4414
-
4415
- #### [PostOrder1](#PostOrder1)
4416
-
4417
- | Properties | Type | Nullable | Description |
4418
- | ---------- | ---- | -------- | ----------- || cancellation_allowed | boolean | no | || return_allowed | boolean | no | |
4419
-
4420
- ---
4421
-
4422
- #### [PriceRange](#PriceRange)
4423
-
4424
- | Properties | Type | Nullable | Description |
4425
- | ---------- | ---- | -------- | ----------- || max | number | no | || min | number | no | |
4426
-
4427
- ---
4428
-
4429
- #### [ProductAction](#ProductAction)
4430
-
4431
- | Properties | Type | Nullable | Description |
4432
- | ---------- | ---- | -------- | ----------- || query | [ActionQuery](#ActionQuery) | no | || type | string | no | || url | string | no | |
4433
-
4434
- ---
4435
-
4436
- #### [ProductArticle](#ProductArticle)
4437
-
4438
- | Properties | Type | Nullable | Description |
4439
- | ---------- | ---- | -------- | ----------- || _custom_json | string | no | || extra_meta | string | no | || parent_item_identifiers | string | no | || price | [ArticlePriceInfo](#ArticlePriceInfo) | no | || product_group_tags | [string] | no | || quantity | number | no | || seller | [BaseInfo](#BaseInfo) | no | || size | string | no | || store | [BaseInfo](#BaseInfo) | no | || type | string | no | || uid | string | no | |
4440
-
4441
- ---
4442
-
4443
- #### [ProductAvailability](#ProductAvailability)
4444
-
4445
- | Properties | Type | Nullable | Description |
4446
- | ---------- | ---- | -------- | ----------- || available_sizes | [[ProductAvailabilitySize](#ProductAvailabilitySize)] | no | || deliverable | boolean | no | || is_valid | boolean | no | || other_store_quantity | number | no | || out_of_stock | boolean | no | || sizes | [string] | no | |
4447
-
4448
- ---
4449
-
4450
- #### [ProductAvailabilitySize](#ProductAvailabilitySize)
4451
-
4452
- | Properties | Type | Nullable | Description |
4453
- | ---------- | ---- | -------- | ----------- || display | string | no | || is_available | boolean | no | || value | string | no | |
4454
-
4455
- ---
4456
-
4457
- #### [ProductImage](#ProductImage)
4458
-
4459
- | Properties | Type | Nullable | Description |
4460
- | ---------- | ---- | -------- | ----------- || aspect_ratio | string | no | || secure_url | string | no | || url | string | no | |
4461
-
4462
- ---
4463
-
4464
- #### [ProductPrice](#ProductPrice)
4465
-
4466
- | Properties | Type | Nullable | Description |
4467
- | ---------- | ---- | -------- | ----------- || add_on | number | no | || currency_code | string | no | || currency_symbol | string | no | || effective | number | no | || marked | number | no | || selling | number | no | |
4468
-
4469
- ---
4470
-
4471
- #### [ProductPriceInfo](#ProductPriceInfo)
4472
-
4473
- | Properties | Type | Nullable | Description |
4474
- | ---------- | ---- | -------- | ----------- || base | [ProductPrice](#ProductPrice) | no | || converted | [ProductPrice](#ProductPrice) | no | |
4475
-
4476
- ---
4477
-
4478
- #### [PromiseFormatted](#PromiseFormatted)
4479
-
4480
- | Properties | Type | Nullable | Description |
4481
- | ---------- | ---- | -------- | ----------- || max | string | no | || min | string | no | |
4482
-
4483
- ---
4484
-
4485
- #### [PromiseTimestamp](#PromiseTimestamp)
4486
-
4487
- | Properties | Type | Nullable | Description |
4488
- | ---------- | ---- | -------- | ----------- || max | number | no | || min | number | no | |
4489
-
4490
- ---
4491
-
4492
- #### [PromoMeta](#PromoMeta)
4493
-
4494
- | Properties | Type | Nullable | Description |
4495
- | ---------- | ---- | -------- | ----------- || message | string | no | |
4496
-
4497
- ---
4498
-
4499
- #### [PromotionAction](#PromotionAction)
4500
-
4501
- | Properties | Type | Nullable | Description |
4502
- | ---------- | ---- | -------- | ----------- || action_date | string | yes | || action_type | string | yes | |
4503
-
4504
- ---
4505
-
4506
- #### [PromotionAdd](#PromotionAdd)
4507
-
4508
- | Properties | Type | Nullable | Description |
4509
- | ---------- | ---- | -------- | ----------- || _custom_json | string | no | || _schedule | [PromotionSchedule](#PromotionSchedule) | no | || application_id | string | yes | || apply_all_discount | boolean | no | || apply_exclusive | string | no | || apply_priority | number | no | || author | [PromotionAuthor](#PromotionAuthor) | no | || buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | || code | string | no | || currency | string | no | || date_meta | [PromotionDateMeta](#PromotionDateMeta) | no | || discount_rules | [[DiscountRule](#DiscountRule)] | yes | || display_meta | [DisplayMeta1](#DisplayMeta1) | yes | || mode | string | yes | || ownership | [Ownership1](#Ownership1) | yes | || post_order_action | [PromotionAction](#PromotionAction) | no | || promo_group | string | yes | || promotion_type | string | yes | || restrictions | [Restrictions1](#Restrictions1) | no | || stackable | boolean | no | || visiblility | [Visibility](#Visibility) | no | |
4510
-
4511
- ---
4512
-
4513
- #### [PromotionAuthor](#PromotionAuthor)
4514
-
4515
- | Properties | Type | Nullable | Description |
4516
- | ---------- | ---- | -------- | ----------- || created_by | string | no | || modified_by | string | no | |
4517
-
4518
- ---
4519
-
4520
- #### [PromotionDateMeta](#PromotionDateMeta)
4521
-
4522
- | Properties | Type | Nullable | Description |
4523
- | ---------- | ---- | -------- | ----------- || created_on | string | no | || modified_on | string | no | |
4524
-
4525
- ---
4526
-
4527
- #### [PromotionListItem](#PromotionListItem)
4528
-
4529
- | Properties | Type | Nullable | Description |
4530
- | ---------- | ---- | -------- | ----------- || _custom_json | string | no | || _schedule | [PromotionSchedule](#PromotionSchedule) | no | || application_id | string | yes | || apply_all_discount | boolean | no | || apply_exclusive | string | no | || apply_priority | number | no | || author | [PromotionAuthor](#PromotionAuthor) | no | || buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | || code | string | no | || currency | string | no | || date_meta | [PromotionDateMeta](#PromotionDateMeta) | no | || discount_rules | [[DiscountRule](#DiscountRule)] | yes | || display_meta | [DisplayMeta1](#DisplayMeta1) | yes | || mode | string | yes | || ownership | [Ownership1](#Ownership1) | yes | || post_order_action | [PromotionAction](#PromotionAction) | no | || promo_group | string | yes | || promotion_type | string | yes | || restrictions | [Restrictions1](#Restrictions1) | no | || stackable | boolean | no | || visiblility | [Visibility](#Visibility) | no | |
4531
-
4532
- ---
4533
-
4534
- #### [PromotionPartialUpdate](#PromotionPartialUpdate)
4535
-
4536
- | Properties | Type | Nullable | Description |
4537
- | ---------- | ---- | -------- | ----------- || archive | boolean | no | || schedule | [PromotionSchedule](#PromotionSchedule) | no | |
4538
-
4539
- ---
4540
-
4541
- #### [PromotionPaymentModes](#PromotionPaymentModes)
4542
-
4543
- | Properties | Type | Nullable | Description |
4544
- | ---------- | ---- | -------- | ----------- || codes | [string] | no | || type | string | yes | || uses | [PaymentAllowValue1](#PaymentAllowValue1) | no | |
4545
-
4546
- ---
4547
-
4548
- #### [PromotionSchedule](#PromotionSchedule)
4549
-
4550
- | Properties | Type | Nullable | Description |
4551
- | ---------- | ---- | -------- | ----------- || cron | string | no | || duration | number | no | || end | string | no | || next_schedule | [string] | no | || published | boolean | yes | || start | string | yes | |
4552
-
4553
- ---
4554
-
4555
- #### [PromotionsResponse](#PromotionsResponse)
4556
-
4557
- | Properties | Type | Nullable | Description |
4558
- | ---------- | ---- | -------- | ----------- || items | [PromotionListItem](#PromotionListItem) | no | || page | [Page](#Page) | no | |
4559
-
4560
- ---
4561
-
4562
- #### [PromotionUpdate](#PromotionUpdate)
4563
-
4564
- | Properties | Type | Nullable | Description |
4565
- | ---------- | ---- | -------- | ----------- || _custom_json | string | no | || _schedule | [PromotionSchedule](#PromotionSchedule) | no | || application_id | string | yes | || apply_all_discount | boolean | no | || apply_exclusive | string | no | || apply_priority | number | no | || author | [PromotionAuthor](#PromotionAuthor) | no | || buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | || code | string | no | || currency | string | no | || date_meta | [PromotionDateMeta](#PromotionDateMeta) | no | || discount_rules | [[DiscountRule](#DiscountRule)] | yes | || display_meta | [DisplayMeta1](#DisplayMeta1) | yes | || mode | string | yes | || ownership | [Ownership1](#Ownership1) | yes | || post_order_action | [PromotionAction](#PromotionAction) | no | || promo_group | string | yes | || promotion_type | string | yes | || restrictions | [Restrictions1](#Restrictions1) | no | || stackable | boolean | no | || visiblility | [Visibility](#Visibility) | no | |
4566
-
4567
- ---
4568
-
4569
- #### [RawBreakup](#RawBreakup)
4570
-
4571
- | Properties | Type | Nullable | Description |
4572
- | ---------- | ---- | -------- | ----------- || cod_charge | number | no | || convenience_fee | number | no | || coupon | number | no | || delivery_charge | number | no | || discount | number | no | || fynd_cash | number | no | || gst_charges | number | no | || mrp_total | number | no | || subtotal | number | no | || total | number | no | || vog | number | no | || you_saved | number | no | |
4573
-
4574
- ---
4575
-
4576
- #### [Restrictions](#Restrictions)
4577
-
4578
- | Properties | Type | Nullable | Description |
4579
- | ---------- | ---- | -------- | ----------- || bulk_bundle | [BulkBundleRestriction](#BulkBundleRestriction) | no | || coupon_allowed | boolean | no | || ordering_stores | [number] | no | || payments | [String: [PaymentModes](#PaymentModes)] | no | || platforms | [string] | no | || post_order | [PostOrder](#PostOrder) | no | || price_range | [PriceRange](#PriceRange) | no | || user_groups | [number] | no | || uses | [UsesRestriction](#UsesRestriction) | no | |
4580
-
4581
- ---
4582
-
4583
- #### [Restrictions1](#Restrictions1)
4584
-
4585
- | Properties | Type | Nullable | Description |
4586
- | ---------- | ---- | -------- | ----------- || anonymous_users | boolean | no | || order_quantity | number | no | || payments | [[PromotionPaymentModes](#PromotionPaymentModes)] | no | || platforms | [string] | no | || post_order | [PostOrder1](#PostOrder1) | no | || user_groups | [number] | no | || user_id | [string] | no | || user_registered | [UserRegistered](#UserRegistered) | no | || uses | [UsesRestriction1](#UsesRestriction1) | yes | |
4587
-
4588
- ---
4589
-
4590
- #### [Rule](#Rule)
4591
-
4592
- | Properties | Type | Nullable | Description |
4593
- | ---------- | ---- | -------- | ----------- || discount_qty | number | no | || key | number | no | || max | number | no | || min | number | no | || value | number | no | |
4594
-
4595
- ---
4596
-
4597
- #### [RuleDefinition](#RuleDefinition)
4598
-
4599
- | Properties | Type | Nullable | Description |
4600
- | ---------- | ---- | -------- | ----------- || applicable_on | string | yes | || auto_apply | boolean | no | || calculate_on | string | yes | || currency_code | string | no | || is_exact | boolean | no | || scope | [string] | no | || type | string | yes | || value_type | string | yes | |
4601
-
4602
- ---
4603
-
4604
- #### [ShipmentPromise](#ShipmentPromise)
4605
-
4606
- | Properties | Type | Nullable | Description |
4607
- | ---------- | ---- | -------- | ----------- || formatted | [PromiseFormatted](#PromiseFormatted) | no | || timestamp | [PromiseTimestamp](#PromiseTimestamp) | no | |
4608
-
4609
- ---
4610
-
4611
- #### [ShippingAddress](#ShippingAddress)
4612
-
4613
- | Properties | Type | Nullable | Description |
4614
- | ---------- | ---- | -------- | ----------- || address | string | no | || address_type | string | no | || area | string | no | || area_code | string | yes | || area_code_slug | string | no | || city | string | no | || country | string | no | || country_code | string | no | || email | string | no | || landmark | string | no | || meta | string | no | || name | string | no | || phone | number | no | || pincode | number | no | || state | string | no | |
4615
-
4616
- ---
4617
-
4618
- #### [State](#State)
4619
-
4620
- | Properties | Type | Nullable | Description |
4621
- | ---------- | ---- | -------- | ----------- || is_archived | boolean | no | || is_display | boolean | no | || is_public | boolean | no | |
4622
-
4623
- ---
4624
-
4625
- #### [SuccessMessage](#SuccessMessage)
4626
-
4627
- | Properties | Type | Nullable | Description |
4628
- | ---------- | ---- | -------- | ----------- || message | string | no | || success | boolean | no | |
4629
-
4630
- ---
4631
-
4632
- #### [UpdateCartDetailResponse](#UpdateCartDetailResponse)
4633
-
4634
- | Properties | Type | Nullable | Description |
4635
- | ---------- | ---- | -------- | ----------- || cart | [CartDetailResponse](#CartDetailResponse) | no | || message | string | no | || success | boolean | no | |
4636
-
4637
- ---
4638
-
4639
- #### [UpdateCartRequest](#UpdateCartRequest)
4640
-
4641
- | Properties | Type | Nullable | Description |
4642
- | ---------- | ---- | -------- | ----------- || items | [[UpdateProductCart](#UpdateProductCart)] | no | || operation | string | yes | |
4643
-
4644
- ---
4645
-
4646
- #### [UpdateProductCart](#UpdateProductCart)
4647
-
4648
- | Properties | Type | Nullable | Description |
4649
- | ---------- | ---- | -------- | ----------- || _custom_json | string | no | || article_id | string | no | || extra_meta | string | no | || identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | || item_id | number | no | || item_index | number | no | || item_size | string | no | || parent_item_identifiers | string | no | || quantity | number | no | |
4650
-
4651
- ---
4652
-
4653
- #### [UserRegistered](#UserRegistered)
4654
-
4655
- | Properties | Type | Nullable | Description |
4656
- | ---------- | ---- | -------- | ----------- || end | string | no | || start | string | no | |
4657
-
4658
- ---
4659
-
4660
- #### [UsesRemaining](#UsesRemaining)
4661
-
4662
- | Properties | Type | Nullable | Description |
4663
- | ---------- | ---- | -------- | ----------- || app | number | no | || total | number | no | || user | number | no | |
4664
-
4665
- ---
4666
-
4667
- #### [UsesRemaining1](#UsesRemaining1)
4668
-
4669
- | Properties | Type | Nullable | Description |
4670
- | ---------- | ---- | -------- | ----------- || total | number | no | || user | number | no | |
4671
-
4672
- ---
4673
-
4674
- #### [UsesRestriction](#UsesRestriction)
4675
-
4676
- | Properties | Type | Nullable | Description |
4677
- | ---------- | ---- | -------- | ----------- || maximum | [UsesRemaining](#UsesRemaining) | no | || remaining | [UsesRemaining](#UsesRemaining) | no | |
4678
-
4679
- ---
4680
-
4681
- #### [UsesRestriction1](#UsesRestriction1)
4682
-
4683
- | Properties | Type | Nullable | Description |
4684
- | ---------- | ---- | -------- | ----------- || maximum | [UsesRemaining1](#UsesRemaining1) | no | || remaining | [UsesRemaining1](#UsesRemaining1) | no | |
4685
-
4686
- ---
4687
-
4688
- #### [Validation](#Validation)
4689
-
4690
- | Properties | Type | Nullable | Description |
4691
- | ---------- | ---- | -------- | ----------- || anonymous | boolean | no | || app_id | [string] | no | || user_registered_after | string | no | |
4692
-
4693
- ---
4694
-
4695
- #### [Validity](#Validity)
4696
-
4697
- | Properties | Type | Nullable | Description |
4698
- | ---------- | ---- | -------- | ----------- || priority | number | no | |
4699
-
4700
- ---
4701
-
4702
- #### [Visibility](#Visibility)
4703
-
4704
- | Properties | Type | Nullable | Description |
4705
- | ---------- | ---- | -------- | ----------- || coupon_list | boolean | yes | || pdp | boolean | yes | |
4706
-
4707
- ---
4708
-
4709
-
4710
-
4711
-