@gofynd/fdk-client-javascript 0.1.35 → 0.1.37
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.
- package/README.md +1 -1
- package/documentation/application/CART.md +272 -249
- package/documentation/application/CATALOG.md +417 -413
- package/documentation/application/COMMON.md +4 -0
- package/documentation/application/COMMUNICATION.md +4 -0
- package/documentation/application/CONFIGURATION.md +4 -0
- package/documentation/application/CONTENT.md +7 -20
- package/documentation/application/FILESTORAGE.md +85 -0
- package/documentation/application/LEAD.md +6 -2
- package/documentation/application/LOGISTIC.md +427 -101
- package/documentation/application/ORDER.md +292 -288
- package/documentation/application/PAYMENT.md +445 -259
- package/documentation/application/POSCART.md +309 -286
- package/documentation/application/README.md +1 -1
- package/documentation/application/REWARDS.md +153 -160
- package/documentation/application/SHARE.md +4 -0
- package/documentation/application/THEME.md +4 -0
- package/documentation/application/USER.md +4 -0
- package/documentation/platform/ANALYTICS.md +4 -0
- package/documentation/platform/AUDITTRAIL.md +6 -2
- package/documentation/platform/BILLING.md +4 -0
- package/documentation/platform/CART.md +476 -459
- package/documentation/platform/CATALOG.md +4138 -2968
- package/documentation/platform/COMMON.md +4 -0
- package/documentation/platform/COMMUNICATION.md +4 -0
- package/documentation/platform/COMPANYPROFILE.md +258 -206
- package/documentation/platform/CONFIGURATION.md +4 -0
- package/documentation/platform/CONTENT.md +8 -21
- package/documentation/platform/DISCOUNT.md +4 -0
- package/documentation/platform/FILESTORAGE.md +85 -0
- package/documentation/platform/INVENTORY.md +4 -0
- package/documentation/platform/LEAD.md +6 -2
- package/documentation/platform/ORDER.md +6298 -1448
- package/documentation/platform/PARTNER.md +12 -8
- package/documentation/platform/PAYMENT.md +107 -103
- package/documentation/platform/README.md +2 -2
- package/documentation/platform/REWARDS.md +219 -152
- package/documentation/platform/SHARE.md +4 -0
- package/documentation/platform/THEME.md +4 -0
- package/documentation/platform/USER.md +4 -0
- package/documentation/platform/WEBHOOK.md +4 -0
- package/documentation/public/CONFIGURATION.md +4 -0
- package/documentation/public/INVENTORY.md +4 -0
- package/documentation/public/WEBHOOK.md +4 -0
- package/package.json +2 -2
- package/sdk/application/ApplicationAPIClient.js +3 -0
- package/sdk/application/ApplicationClient.d.ts +1 -0
- package/sdk/application/ApplicationClient.js +11 -1
- package/sdk/application/ApplicationConfig.d.ts +1 -0
- package/sdk/application/ApplicationConfig.js +1 -0
- package/sdk/application/ApplicationModels.d.ts +94 -85
- package/sdk/application/ApplicationModels.js +1909 -1792
- package/sdk/application/client/CartApplicationClient.d.ts +36 -36
- package/sdk/application/client/CatalogApplicationClient.d.ts +39 -39
- package/sdk/application/client/CatalogApplicationClient.js +16 -16
- package/sdk/application/client/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/client/CommunicationApplicationClient.d.ts +5 -5
- package/sdk/application/client/ConfigurationApplicationClient.d.ts +17 -17
- package/sdk/application/client/ContentApplicationClient.d.ts +19 -19
- package/sdk/application/client/FileStorageApplicationClient.d.ts +14 -6
- package/sdk/application/client/FileStorageApplicationClient.js +2 -0
- package/sdk/application/client/LeadApplicationClient.d.ts +10 -10
- package/sdk/application/client/LogisticApplicationClient.d.ts +32 -21
- package/sdk/application/client/LogisticApplicationClient.js +62 -27
- package/sdk/application/client/OrderApplicationClient.d.ts +15 -15
- package/sdk/application/client/OrderApplicationClient.js +1 -1
- package/sdk/application/client/PaymentApplicationClient.d.ts +79 -57
- package/sdk/application/client/PaymentApplicationClient.js +66 -0
- package/sdk/application/client/PosCartApplicationClient.d.ts +38 -38
- package/sdk/application/client/RewardsApplicationClient.d.ts +34 -34
- package/sdk/application/client/RewardsApplicationClient.js +77 -77
- package/sdk/application/client/ShareApplicationClient.d.ts +8 -8
- package/sdk/application/client/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/client/UserApplicationClient.d.ts +63 -63
- package/sdk/application/models/CatalogValidator.d.ts +1 -1
- package/sdk/application/models/CatalogValidator.js +2 -2
- package/sdk/application/models/LogisticValidator.d.ts +2 -1
- package/sdk/application/models/LogisticValidator.js +11 -6
- package/sdk/application/models/PaymentValidator.d.ts +2 -0
- package/sdk/application/models/PaymentValidator.js +12 -0
- package/sdk/application/models/RewardsValidator.d.ts +3 -3
- package/sdk/application/models/RewardsValidator.js +12 -12
- package/sdk/common/AxiosHelper.js +1 -1
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/platform/PlatformApplicationClient.d.ts +7962 -6505
- package/sdk/platform/PlatformApplicationClient.js +4377 -3635
- package/sdk/platform/PlatformApplicationModels.d.ts +26 -31
- package/sdk/platform/PlatformApplicationModels.js +5530 -4134
- package/sdk/platform/PlatformClient.d.ts +3495 -2780
- package/sdk/platform/PlatformClient.js +3985 -3108
- package/sdk/platform/PlatformModels.d.ts +354 -273
- package/sdk/platform/PlatformModels.js +5635 -4211
- package/sdk/platform/client/AnalyticsPlatformClient.d.ts +5 -5
- package/sdk/platform/client/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/client/BillingPlatformClient.d.ts +4 -4
- package/sdk/platform/client/CatalogPlatformClient.d.ts +222 -154
- package/sdk/platform/client/CatalogPlatformClient.js +473 -295
- package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +8 -8
- package/sdk/platform/client/ConfigurationPlatformClient.d.ts +9 -9
- package/sdk/platform/client/DiscountPlatformClient.d.ts +4 -4
- package/sdk/platform/client/FileStoragePlatformClient.d.ts +20 -4
- package/sdk/platform/client/FileStoragePlatformClient.js +49 -0
- package/sdk/platform/client/InventoryPlatformClient.d.ts +3 -3
- package/sdk/platform/client/LeadPlatformClient.d.ts +6 -6
- package/sdk/platform/client/OrderPlatformClient.d.ts +557 -131
- package/sdk/platform/client/OrderPlatformClient.js +1551 -247
- package/sdk/platform/client/PaymentPlatformClient.d.ts +4 -4
- package/sdk/platform/client/WebhookPlatformClient.d.ts +2 -2
- package/sdk/platform/models/CatalogValidator.d.ts +26 -22
- package/sdk/platform/models/CatalogValidator.js +109 -72
- package/sdk/platform/models/OrderValidator.d.ts +43 -11
- package/sdk/platform/models/OrderValidator.js +312 -51
- package/sdk/public/client/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/client/InventoryPublicClient.d.ts +7 -7
- package/sdk/public/client/WebhookPublicClient.d.ts +3 -3
- package/tests/common/schema/action-url.json +15 -0
- package/tests/common/schema/url-action.json +16 -0
|
@@ -2,10 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
5
|
+
|
|
5
6
|
##### [Back to Application docs](./README.md)
|
|
6
7
|
|
|
7
8
|
## Cart Methods
|
|
8
9
|
Cart APIs
|
|
10
|
+
|
|
9
11
|
* [getCart](#getcart)
|
|
10
12
|
* [getCartLastModified](#getcartlastmodified)
|
|
11
13
|
* [addItems](#additems)
|
|
@@ -38,6 +40,8 @@ Cart APIs
|
|
|
38
40
|
## Methods with example and description
|
|
39
41
|
|
|
40
42
|
|
|
43
|
+
|
|
44
|
+
|
|
41
45
|
### getCart
|
|
42
46
|
Fetch all items added to the cart
|
|
43
47
|
|
|
@@ -2879,6 +2883,8 @@ Success. Returns an Address object containing a list of address saved in the acc
|
|
|
2879
2883
|
"meta": {},
|
|
2880
2884
|
"user_id": "8b526f521bb14a2593a8b9e3ce8c76b3",
|
|
2881
2885
|
"country_code": "IND",
|
|
2886
|
+
"country_phone_code": "91",
|
|
2887
|
+
"country_iso_code": "IND",
|
|
2882
2888
|
"phone": 9915347757,
|
|
2883
2889
|
"geo_location": {},
|
|
2884
2890
|
"country": "India",
|
|
@@ -3039,6 +3045,8 @@ Success. Returns an Address object containing a list of address saved in the acc
|
|
|
3039
3045
|
"meta": {},
|
|
3040
3046
|
"user_id": "8b526f521bb14a2593a8b9e3ce8c76b3",
|
|
3041
3047
|
"country_code": "IND",
|
|
3048
|
+
"country_phone_code": "91",
|
|
3049
|
+
"country_iso_code": "IND",
|
|
3042
3050
|
"phone": 9915347757,
|
|
3043
3051
|
"geo_location": {},
|
|
3044
3052
|
"country": "India",
|
|
@@ -6130,131 +6138,143 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6130
6138
|
|
|
6131
6139
|
|
|
6132
6140
|
|
|
6133
|
-
#### [
|
|
6141
|
+
#### [CartCurrency](#CartCurrency)
|
|
6134
6142
|
|
|
6135
6143
|
| Properties | Type | Nullable | Description |
|
|
6136
6144
|
| ---------- | ---- | -------- | ----------- |
|
|
6137
|
-
|
|
|
6138
|
-
|
|
|
6139
|
-
| is_applied | boolean | no | |
|
|
6140
|
-
| description | string | no | |
|
|
6145
|
+
| symbol | string | no | |
|
|
6146
|
+
| code | string | no | Currency code defined by ISO 4217:2015 |
|
|
6141
6147
|
|
|
6142
6148
|
---
|
|
6143
6149
|
|
|
6144
6150
|
|
|
6145
6151
|
|
|
6146
6152
|
|
|
6147
|
-
#### [
|
|
6153
|
+
#### [PaymentSelectionLock](#PaymentSelectionLock)
|
|
6148
6154
|
|
|
6149
6155
|
| Properties | Type | Nullable | Description |
|
|
6150
6156
|
| ---------- | ---- | -------- | ----------- |
|
|
6151
|
-
|
|
|
6152
|
-
|
|
|
6153
|
-
|
|
|
6154
|
-
| is_applied | boolean | no | |
|
|
6155
|
-
| message | string | no | |
|
|
6156
|
-
| type | string | no | |
|
|
6157
|
+
| payment_identifier | string | no | |
|
|
6158
|
+
| enabled | boolean | no | |
|
|
6159
|
+
| default_options | string | no | |
|
|
6157
6160
|
|
|
6158
6161
|
---
|
|
6159
6162
|
|
|
6160
6163
|
|
|
6161
6164
|
|
|
6162
6165
|
|
|
6163
|
-
#### [
|
|
6166
|
+
#### [PromiseTimestamp](#PromiseTimestamp)
|
|
6164
6167
|
|
|
6165
6168
|
| Properties | Type | Nullable | Description |
|
|
6166
6169
|
| ---------- | ---- | -------- | ----------- |
|
|
6167
|
-
|
|
|
6168
|
-
|
|
|
6169
|
-
| total | number | no | |
|
|
6170
|
-
| convenience_fee | number | no | |
|
|
6171
|
-
| subtotal | number | no | |
|
|
6172
|
-
| delivery_charge | number | no | |
|
|
6173
|
-
| you_saved | number | no | |
|
|
6174
|
-
| vog | number | no | |
|
|
6175
|
-
| fynd_cash | number | no | |
|
|
6176
|
-
| mrp_total | number | no | |
|
|
6177
|
-
| cod_charge | number | no | |
|
|
6178
|
-
| gst_charges | number | no | |
|
|
6170
|
+
| min | number | no | |
|
|
6171
|
+
| max | number | no | |
|
|
6179
6172
|
|
|
6180
6173
|
---
|
|
6181
6174
|
|
|
6182
6175
|
|
|
6183
6176
|
|
|
6184
6177
|
|
|
6185
|
-
#### [
|
|
6178
|
+
#### [PromiseFormatted](#PromiseFormatted)
|
|
6186
6179
|
|
|
6187
6180
|
| Properties | Type | Nullable | Description |
|
|
6188
6181
|
| ---------- | ---- | -------- | ----------- |
|
|
6189
|
-
|
|
|
6190
|
-
|
|
|
6191
|
-
| key | string | no | |
|
|
6192
|
-
| currency_code | string | no | |
|
|
6193
|
-
| currency_symbol | string | no | |
|
|
6194
|
-
| message | [string] | no | |
|
|
6182
|
+
| min | string | no | |
|
|
6183
|
+
| max | string | no | |
|
|
6195
6184
|
|
|
6196
6185
|
---
|
|
6197
6186
|
|
|
6198
6187
|
|
|
6199
6188
|
|
|
6200
6189
|
|
|
6201
|
-
#### [
|
|
6190
|
+
#### [ShipmentPromise](#ShipmentPromise)
|
|
6202
6191
|
|
|
6203
6192
|
| Properties | Type | Nullable | Description |
|
|
6204
6193
|
| ---------- | ---- | -------- | ----------- |
|
|
6205
|
-
|
|
|
6206
|
-
|
|
|
6207
|
-
| raw | [RawBreakup](#RawBreakup) | no | |
|
|
6208
|
-
| display | [[DisplayBreakup](#DisplayBreakup)] | no | |
|
|
6194
|
+
| timestamp | [PromiseTimestamp](#PromiseTimestamp) | no | |
|
|
6195
|
+
| formatted | [PromiseFormatted](#PromiseFormatted) | no | |
|
|
6209
6196
|
|
|
6210
6197
|
---
|
|
6211
6198
|
|
|
6212
6199
|
|
|
6213
6200
|
|
|
6214
6201
|
|
|
6215
|
-
#### [
|
|
6202
|
+
#### [CouponBreakup](#CouponBreakup)
|
|
6216
6203
|
|
|
6217
6204
|
| Properties | Type | Nullable | Description |
|
|
6218
6205
|
| ---------- | ---- | -------- | ----------- |
|
|
6219
|
-
|
|
|
6220
|
-
|
|
|
6206
|
+
| message | string | no | |
|
|
6207
|
+
| value | number | no | |
|
|
6208
|
+
| code | string | no | |
|
|
6209
|
+
| is_applied | boolean | no | |
|
|
6210
|
+
| uid | string | no | |
|
|
6211
|
+
| type | string | no | |
|
|
6221
6212
|
|
|
6222
6213
|
---
|
|
6223
6214
|
|
|
6224
6215
|
|
|
6225
6216
|
|
|
6226
6217
|
|
|
6227
|
-
#### [
|
|
6218
|
+
#### [LoyaltyPoints](#LoyaltyPoints)
|
|
6228
6219
|
|
|
6229
6220
|
| Properties | Type | Nullable | Description |
|
|
6230
6221
|
| ---------- | ---- | -------- | ----------- |
|
|
6231
|
-
|
|
|
6232
|
-
|
|
|
6222
|
+
| applicable | number | no | |
|
|
6223
|
+
| description | string | no | |
|
|
6224
|
+
| total | number | no | |
|
|
6225
|
+
| is_applied | boolean | no | |
|
|
6233
6226
|
|
|
6234
6227
|
---
|
|
6235
6228
|
|
|
6236
6229
|
|
|
6237
6230
|
|
|
6238
6231
|
|
|
6239
|
-
#### [
|
|
6232
|
+
#### [DisplayBreakup](#DisplayBreakup)
|
|
6240
6233
|
|
|
6241
6234
|
| Properties | Type | Nullable | Description |
|
|
6242
6235
|
| ---------- | ---- | -------- | ----------- |
|
|
6243
|
-
|
|
|
6244
|
-
|
|
|
6236
|
+
| message | [string] | no | |
|
|
6237
|
+
| value | number | no | |
|
|
6238
|
+
| key | string | no | |
|
|
6239
|
+
| currency_symbol | string | no | |
|
|
6240
|
+
| display | string | no | |
|
|
6241
|
+
| currency_code | string | no | |
|
|
6245
6242
|
|
|
6246
6243
|
---
|
|
6247
6244
|
|
|
6248
6245
|
|
|
6249
6246
|
|
|
6250
6247
|
|
|
6251
|
-
#### [
|
|
6248
|
+
#### [RawBreakup](#RawBreakup)
|
|
6252
6249
|
|
|
6253
6250
|
| Properties | Type | Nullable | Description |
|
|
6254
6251
|
| ---------- | ---- | -------- | ----------- |
|
|
6255
|
-
|
|
|
6256
|
-
|
|
|
6257
|
-
|
|
|
6252
|
+
| coupon | number | no | |
|
|
6253
|
+
| total | number | no | |
|
|
6254
|
+
| subtotal | number | no | |
|
|
6255
|
+
| vog | number | no | |
|
|
6256
|
+
| delivery_charge | number | no | |
|
|
6257
|
+
| you_saved | number | no | |
|
|
6258
|
+
| mrp_total | number | no | |
|
|
6259
|
+
| cod_charge | number | no | |
|
|
6260
|
+
| fynd_cash | number | no | |
|
|
6261
|
+
| gst_charges | number | no | |
|
|
6262
|
+
| convenience_fee | number | no | |
|
|
6263
|
+
| discount | number | no | |
|
|
6264
|
+
|
|
6265
|
+
---
|
|
6266
|
+
|
|
6267
|
+
|
|
6268
|
+
|
|
6269
|
+
|
|
6270
|
+
#### [CartBreakup](#CartBreakup)
|
|
6271
|
+
|
|
6272
|
+
| Properties | Type | Nullable | Description |
|
|
6273
|
+
| ---------- | ---- | -------- | ----------- |
|
|
6274
|
+
| coupon | [CouponBreakup](#CouponBreakup) | no | |
|
|
6275
|
+
| loyalty_points | [LoyaltyPoints](#LoyaltyPoints) | no | |
|
|
6276
|
+
| display | [[DisplayBreakup](#DisplayBreakup)] | no | |
|
|
6277
|
+
| raw | [RawBreakup](#RawBreakup) | no | |
|
|
6258
6278
|
|
|
6259
6279
|
---
|
|
6260
6280
|
|
|
@@ -6265,8 +6285,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6265
6285
|
|
|
6266
6286
|
| Properties | Type | Nullable | Description |
|
|
6267
6287
|
| ---------- | ---- | -------- | ----------- |
|
|
6268
|
-
| uid | number | no | |
|
|
6269
6288
|
| name | string | no | |
|
|
6289
|
+
| uid | number | no | |
|
|
6270
6290
|
|
|
6271
6291
|
---
|
|
6272
6292
|
|
|
@@ -6277,10 +6297,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6277
6297
|
|
|
6278
6298
|
| Properties | Type | Nullable | Description |
|
|
6279
6299
|
| ---------- | ---- | -------- | ----------- |
|
|
6300
|
+
| currency_symbol | string | no | |
|
|
6280
6301
|
| marked | number | no | |
|
|
6281
6302
|
| currency_code | string | no | |
|
|
6282
6303
|
| effective | number | no | |
|
|
6283
|
-
| currency_symbol | string | no | |
|
|
6284
6304
|
|
|
6285
6305
|
---
|
|
6286
6306
|
|
|
@@ -6303,15 +6323,15 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6303
6323
|
|
|
6304
6324
|
| Properties | Type | Nullable | Description |
|
|
6305
6325
|
| ---------- | ---- | -------- | ----------- |
|
|
6306
|
-
|
|
|
6307
|
-
| quantity | number | no | |
|
|
6326
|
+
| parent_item_identifiers | string | no | |
|
|
6308
6327
|
| size | string | no | |
|
|
6309
6328
|
| extra_meta | string | no | |
|
|
6310
|
-
| price | [ArticlePriceInfo](#ArticlePriceInfo) | no | |
|
|
6311
|
-
| product_group_tags | [string] | no | |
|
|
6312
6329
|
| store | [BaseInfo](#BaseInfo) | no | |
|
|
6330
|
+
| quantity | number | no | |
|
|
6331
|
+
| seller | [BaseInfo](#BaseInfo) | no | |
|
|
6332
|
+
| product_group_tags | [string] | no | |
|
|
6313
6333
|
| uid | string | no | |
|
|
6314
|
-
|
|
|
6334
|
+
| price | [ArticlePriceInfo](#ArticlePriceInfo) | no | |
|
|
6315
6335
|
| type | string | no | |
|
|
6316
6336
|
|
|
6317
6337
|
---
|
|
@@ -6323,8 +6343,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6323
6343
|
|
|
6324
6344
|
| Properties | Type | Nullable | Description |
|
|
6325
6345
|
| ---------- | ---- | -------- | ----------- |
|
|
6326
|
-
| uid | number | no | Product Category Id |
|
|
6327
6346
|
| name | string | no | |
|
|
6347
|
+
| uid | number | no | Product Category Id |
|
|
6328
6348
|
|
|
6329
6349
|
---
|
|
6330
6350
|
|
|
@@ -6335,9 +6355,9 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6335
6355
|
|
|
6336
6356
|
| Properties | Type | Nullable | Description |
|
|
6337
6357
|
| ---------- | ---- | -------- | ----------- |
|
|
6358
|
+
| aspect_ratio | string | no | |
|
|
6338
6359
|
| secure_url | string | no | |
|
|
6339
6360
|
| url | string | no | |
|
|
6340
|
-
| aspect_ratio | string | no | |
|
|
6341
6361
|
|
|
6342
6362
|
---
|
|
6343
6363
|
|
|
@@ -6372,12 +6392,12 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6372
6392
|
|
|
6373
6393
|
| Properties | Type | Nullable | Description |
|
|
6374
6394
|
| ---------- | ---- | -------- | ----------- |
|
|
6375
|
-
| slug | string | no | Unique product url name generated via product name and other meta data |
|
|
6376
|
-
| brand | [BaseInfo](#BaseInfo) | no | |
|
|
6377
|
-
| name | string | no | |
|
|
6378
6395
|
| categories | [[CategoryInfo](#CategoryInfo)] | no | |
|
|
6396
|
+
| slug | string | no | Unique product url name generated via product name and other meta data |
|
|
6379
6397
|
| images | [[ProductImage](#ProductImage)] | no | |
|
|
6380
6398
|
| action | [ProductAction](#ProductAction) | no | |
|
|
6399
|
+
| brand | [BaseInfo](#BaseInfo) | no | |
|
|
6400
|
+
| name | string | no | |
|
|
6381
6401
|
| uid | number | no | |
|
|
6382
6402
|
| type | string | no | |
|
|
6383
6403
|
|
|
@@ -6386,39 +6406,40 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6386
6406
|
|
|
6387
6407
|
|
|
6388
6408
|
|
|
6389
|
-
#### [
|
|
6409
|
+
#### [ProductPrice](#ProductPrice)
|
|
6390
6410
|
|
|
6391
6411
|
| Properties | Type | Nullable | Description |
|
|
6392
6412
|
| ---------- | ---- | -------- | ----------- |
|
|
6393
|
-
|
|
|
6413
|
+
| selling | number | no | |
|
|
6414
|
+
| currency_symbol | string | no | |
|
|
6415
|
+
| marked | number | no | |
|
|
6416
|
+
| add_on | number | no | |
|
|
6417
|
+
| effective | number | no | |
|
|
6418
|
+
| currency_code | string | no | |
|
|
6394
6419
|
|
|
6395
6420
|
---
|
|
6396
6421
|
|
|
6397
6422
|
|
|
6398
6423
|
|
|
6399
6424
|
|
|
6400
|
-
#### [
|
|
6425
|
+
#### [ProductPriceInfo](#ProductPriceInfo)
|
|
6401
6426
|
|
|
6402
6427
|
| Properties | Type | Nullable | Description |
|
|
6403
6428
|
| ---------- | ---- | -------- | ----------- |
|
|
6404
|
-
|
|
|
6405
|
-
|
|
|
6406
|
-
| marked | number | no | |
|
|
6407
|
-
| currency_code | string | no | |
|
|
6408
|
-
| currency_symbol | string | no | |
|
|
6409
|
-
| selling | number | no | |
|
|
6429
|
+
| base | [ProductPrice](#ProductPrice) | no | |
|
|
6430
|
+
| converted | [ProductPrice](#ProductPrice) | no | |
|
|
6410
6431
|
|
|
6411
6432
|
---
|
|
6412
6433
|
|
|
6413
6434
|
|
|
6414
6435
|
|
|
6415
6436
|
|
|
6416
|
-
#### [
|
|
6437
|
+
#### [Ownership](#Ownership)
|
|
6417
6438
|
|
|
6418
6439
|
| Properties | Type | Nullable | Description |
|
|
6419
6440
|
| ---------- | ---- | -------- | ----------- |
|
|
6420
|
-
|
|
|
6421
|
-
|
|
|
6441
|
+
| payable_category | string | no | promo amount payable category |
|
|
6442
|
+
| payable_by | string | no | promo amount bearable party |
|
|
6422
6443
|
|
|
6423
6444
|
---
|
|
6424
6445
|
|
|
@@ -6429,76 +6450,76 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6429
6450
|
|
|
6430
6451
|
| Properties | Type | Nullable | Description |
|
|
6431
6452
|
| ---------- | ---- | -------- | ----------- |
|
|
6432
|
-
| article_quantity | number | no | Quantity of article on which promotion is applicable |
|
|
6433
6453
|
| promo_id | string | no | Promotion id |
|
|
6434
|
-
| promotion_type | string | no | Promotion type of current promotion |
|
|
6435
|
-
| mrp_promotion | boolean | no | If applied promotion is applied on product MRP or ESP |
|
|
6436
6454
|
| offer_text | string | no | Offer text of current promotion |
|
|
6455
|
+
| mrp_promotion | boolean | no | If applied promotion is applied on product MRP or ESP |
|
|
6437
6456
|
| amount | number | no | Per unit discount amount applied with current promotion |
|
|
6457
|
+
| promotion_type | string | no | Promotion type of current promotion |
|
|
6458
|
+
| article_quantity | number | no | Quantity of article on which promotion is applicable |
|
|
6459
|
+
| ownership | [Ownership](#Ownership) | no | Ownership of promotion |
|
|
6438
6460
|
|
|
6439
6461
|
---
|
|
6440
6462
|
|
|
6441
6463
|
|
|
6442
6464
|
|
|
6443
6465
|
|
|
6444
|
-
#### [
|
|
6466
|
+
#### [ProductAvailability](#ProductAvailability)
|
|
6445
6467
|
|
|
6446
6468
|
| Properties | Type | Nullable | Description |
|
|
6447
6469
|
| ---------- | ---- | -------- | ----------- |
|
|
6448
|
-
|
|
|
6470
|
+
| out_of_stock | boolean | no | |
|
|
6471
|
+
| sizes | [string] | no | |
|
|
6472
|
+
| other_store_quantity | number | no | |
|
|
6473
|
+
| deliverable | boolean | no | |
|
|
6474
|
+
| is_valid | boolean | no | |
|
|
6449
6475
|
|
|
6450
6476
|
---
|
|
6451
6477
|
|
|
6452
6478
|
|
|
6453
6479
|
|
|
6454
6480
|
|
|
6455
|
-
#### [
|
|
6481
|
+
#### [CartProductIdentifer](#CartProductIdentifer)
|
|
6456
6482
|
|
|
6457
6483
|
| Properties | Type | Nullable | Description |
|
|
6458
6484
|
| ---------- | ---- | -------- | ----------- |
|
|
6459
|
-
|
|
|
6460
|
-
| out_of_stock | boolean | no | |
|
|
6461
|
-
| other_store_quantity | number | no | |
|
|
6462
|
-
| sizes | [string] | no | |
|
|
6463
|
-
| deliverable | boolean | no | |
|
|
6485
|
+
| identifier | string | no | Article idenfier generated by cart |
|
|
6464
6486
|
|
|
6465
6487
|
---
|
|
6466
6488
|
|
|
6467
6489
|
|
|
6468
6490
|
|
|
6469
6491
|
|
|
6470
|
-
#### [
|
|
6492
|
+
#### [PromoMeta](#PromoMeta)
|
|
6471
6493
|
|
|
6472
6494
|
| Properties | Type | Nullable | Description |
|
|
6473
6495
|
| ---------- | ---- | -------- | ----------- |
|
|
6474
|
-
| article | [ProductArticle](#ProductArticle) | no | |
|
|
6475
|
-
| discount | string | no | |
|
|
6476
|
-
| product | [CartProduct](#CartProduct) | no | |
|
|
6477
|
-
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
6478
|
-
| parent_item_identifiers | string | no | |
|
|
6479
|
-
| coupon_message | string | no | |
|
|
6480
|
-
| price_per_unit | [ProductPriceInfo](#ProductPriceInfo) | no | |
|
|
6481
|
-
| promotions_applied | [[AppliedPromotion](#AppliedPromotion)] | no | |
|
|
6482
|
-
| promo_meta | [PromoMeta](#PromoMeta) | no | |
|
|
6483
6496
|
| message | string | no | |
|
|
6484
|
-
| key | string | no | |
|
|
6485
|
-
| price | [ProductPriceInfo](#ProductPriceInfo) | no | |
|
|
6486
|
-
| is_set | boolean | no | |
|
|
6487
|
-
| bulk_offer | string | no | |
|
|
6488
|
-
| availability | [ProductAvailability](#ProductAvailability) | no | |
|
|
6489
|
-
| quantity | number | no | |
|
|
6490
6497
|
|
|
6491
6498
|
---
|
|
6492
6499
|
|
|
6493
6500
|
|
|
6494
6501
|
|
|
6495
6502
|
|
|
6496
|
-
#### [
|
|
6503
|
+
#### [CartProductInfo](#CartProductInfo)
|
|
6497
6504
|
|
|
6498
6505
|
| Properties | Type | Nullable | Description |
|
|
6499
6506
|
| ---------- | ---- | -------- | ----------- |
|
|
6500
|
-
|
|
|
6501
|
-
|
|
|
6507
|
+
| parent_item_identifiers | string | no | |
|
|
6508
|
+
| message | string | no | |
|
|
6509
|
+
| coupon_message | string | no | |
|
|
6510
|
+
| key | string | no | |
|
|
6511
|
+
| article | [ProductArticle](#ProductArticle) | no | |
|
|
6512
|
+
| product | [CartProduct](#CartProduct) | no | |
|
|
6513
|
+
| bulk_offer | string | no | |
|
|
6514
|
+
| price_per_unit | [ProductPriceInfo](#ProductPriceInfo) | no | |
|
|
6515
|
+
| quantity | number | no | |
|
|
6516
|
+
| is_set | boolean | no | |
|
|
6517
|
+
| promotions_applied | [[AppliedPromotion](#AppliedPromotion)] | no | |
|
|
6518
|
+
| availability | [ProductAvailability](#ProductAvailability) | no | |
|
|
6519
|
+
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
6520
|
+
| promo_meta | [PromoMeta](#PromoMeta) | no | |
|
|
6521
|
+
| price | [ProductPriceInfo](#ProductPriceInfo) | no | |
|
|
6522
|
+
| discount | string | no | |
|
|
6502
6523
|
|
|
6503
6524
|
---
|
|
6504
6525
|
|
|
@@ -6509,22 +6530,22 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6509
6530
|
|
|
6510
6531
|
| Properties | Type | Nullable | Description |
|
|
6511
6532
|
| ---------- | ---- | -------- | ----------- |
|
|
6512
|
-
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
6513
|
-
| is_valid | boolean | no | |
|
|
6514
|
-
| checkout_mode | string | no | |
|
|
6515
|
-
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
6516
|
-
| last_modified | string | no | |
|
|
6517
|
-
| comment | string | no | |
|
|
6518
|
-
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
6519
|
-
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
6520
|
-
| gstin | string | no | |
|
|
6521
6533
|
| buy_now | boolean | no | |
|
|
6534
|
+
| message | string | no | |
|
|
6535
|
+
| id | string | no | |
|
|
6522
6536
|
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
6537
|
+
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
6538
|
+
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
6523
6539
|
| coupon_text | string | no | |
|
|
6524
|
-
|
|
|
6540
|
+
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
6541
|
+
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
6542
|
+
| gstin | string | no | |
|
|
6525
6543
|
| restrict_checkout | boolean | no | |
|
|
6526
|
-
|
|
|
6527
|
-
|
|
|
6544
|
+
| last_modified | string | no | |
|
|
6545
|
+
| comment | string | no | |
|
|
6546
|
+
| checkout_mode | string | no | |
|
|
6547
|
+
| is_valid | boolean | no | |
|
|
6548
|
+
| delivery_charge_info | string | no | |
|
|
6528
6549
|
|
|
6529
6550
|
---
|
|
6530
6551
|
|
|
@@ -6535,17 +6556,17 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6535
6556
|
|
|
6536
6557
|
| Properties | Type | Nullable | Description |
|
|
6537
6558
|
| ---------- | ---- | -------- | ----------- |
|
|
6538
|
-
|
|
|
6559
|
+
| parent_item_identifiers | string | no | |
|
|
6560
|
+
| item_size | string | no | |
|
|
6539
6561
|
| pos | boolean | no | |
|
|
6540
|
-
| display | string | no | |
|
|
6541
|
-
| article_assignment | string | no | |
|
|
6542
6562
|
| extra_meta | string | no | |
|
|
6563
|
+
| article_assignment | string | no | |
|
|
6543
6564
|
| article_id | string | no | |
|
|
6565
|
+
| seller_id | number | no | |
|
|
6566
|
+
| quantity | number | no | |
|
|
6544
6567
|
| item_id | number | no | |
|
|
6568
|
+
| display | string | no | |
|
|
6545
6569
|
| product_group_tags | [string] | no | |
|
|
6546
|
-
| seller_id | number | no | |
|
|
6547
|
-
| item_size | string | no | |
|
|
6548
|
-
| parent_item_identifiers | string | no | |
|
|
6549
6570
|
| store_id | number | no | |
|
|
6550
6571
|
|
|
6551
6572
|
---
|
|
@@ -6568,10 +6589,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6568
6589
|
|
|
6569
6590
|
| Properties | Type | Nullable | Description |
|
|
6570
6591
|
| ---------- | ---- | -------- | ----------- |
|
|
6571
|
-
| cart | [CartDetailResponse](#CartDetailResponse) | no | |
|
|
6572
|
-
| partial | boolean | no | When adding multiple items check if all added. True if only few are added. |
|
|
6573
6592
|
| message | string | no | |
|
|
6593
|
+
| cart | [CartDetailResponse](#CartDetailResponse) | no | |
|
|
6574
6594
|
| success | boolean | no | True if all items are added successfully. False if partially added or not added. |
|
|
6595
|
+
| partial | boolean | no | When adding multiple items check if all added. True if only few are added. |
|
|
6575
6596
|
|
|
6576
6597
|
---
|
|
6577
6598
|
|
|
@@ -6582,14 +6603,14 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6582
6603
|
|
|
6583
6604
|
| Properties | Type | Nullable | Description |
|
|
6584
6605
|
| ---------- | ---- | -------- | ----------- |
|
|
6585
|
-
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
6586
6606
|
| parent_item_identifiers | string | no | |
|
|
6607
|
+
| item_size | string | no | |
|
|
6587
6608
|
| extra_meta | string | no | |
|
|
6588
6609
|
| article_id | string | no | |
|
|
6610
|
+
| quantity | number | no | |
|
|
6589
6611
|
| item_id | number | no | |
|
|
6612
|
+
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
6590
6613
|
| item_index | number | no | |
|
|
6591
|
-
| item_size | string | no | |
|
|
6592
|
-
| quantity | number | no | |
|
|
6593
6614
|
|
|
6594
6615
|
---
|
|
6595
6616
|
|
|
@@ -6612,8 +6633,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6612
6633
|
|
|
6613
6634
|
| Properties | Type | Nullable | Description |
|
|
6614
6635
|
| ---------- | ---- | -------- | ----------- |
|
|
6615
|
-
| cart | [CartDetailResponse](#CartDetailResponse) | no | |
|
|
6616
6636
|
| message | string | no | |
|
|
6637
|
+
| cart | [CartDetailResponse](#CartDetailResponse) | no | |
|
|
6617
6638
|
| success | boolean | no | True if all items are added successfully. False if partially added or not added. |
|
|
6618
6639
|
|
|
6619
6640
|
---
|
|
@@ -6636,11 +6657,11 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6636
6657
|
|
|
6637
6658
|
| Properties | Type | Nullable | Description |
|
|
6638
6659
|
| ---------- | ---- | -------- | ----------- |
|
|
6639
|
-
|
|
|
6660
|
+
| total_item_count | number | no | |
|
|
6640
6661
|
| total | number | no | |
|
|
6662
|
+
| has_previous | boolean | no | |
|
|
6641
6663
|
| has_next | boolean | no | |
|
|
6642
6664
|
| current | number | no | |
|
|
6643
|
-
| total_item_count | number | no | |
|
|
6644
6665
|
|
|
6645
6666
|
---
|
|
6646
6667
|
|
|
@@ -6651,13 +6672,13 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6651
6672
|
|
|
6652
6673
|
| Properties | Type | Nullable | Description |
|
|
6653
6674
|
| ---------- | ---- | -------- | ----------- |
|
|
6654
|
-
| is_applicable | boolean | no | |
|
|
6655
|
-
| max_discount_value | number | no | |
|
|
6656
|
-
| expires_on | string | no | |
|
|
6657
6675
|
| message | string | no | |
|
|
6658
|
-
| sub_title | string | no | |
|
|
6659
6676
|
| minimum_cart_value | number | no | |
|
|
6677
|
+
| expires_on | string | no | |
|
|
6678
|
+
| is_applicable | boolean | no | |
|
|
6679
|
+
| max_discount_value | number | no | |
|
|
6660
6680
|
| coupon_code | string | no | |
|
|
6681
|
+
| sub_title | string | no | |
|
|
6661
6682
|
| title | string | no | |
|
|
6662
6683
|
| is_applied | boolean | no | |
|
|
6663
6684
|
| coupon_value | number | no | |
|
|
@@ -6694,8 +6715,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6694
6715
|
|
|
6695
6716
|
| Properties | Type | Nullable | Description |
|
|
6696
6717
|
| ---------- | ---- | -------- | ----------- |
|
|
6697
|
-
| uid | number | no | Seller id |
|
|
6698
6718
|
| name | string | no | |
|
|
6719
|
+
| uid | number | no | Seller id |
|
|
6699
6720
|
|
|
6700
6721
|
---
|
|
6701
6722
|
|
|
@@ -6707,10 +6728,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6707
6728
|
| Properties | Type | Nullable | Description |
|
|
6708
6729
|
| ---------- | ---- | -------- | ----------- |
|
|
6709
6730
|
| bulk_effective | number | no | Discounted per unit price for current offer object |
|
|
6710
|
-
| marked | number | no | Original price of product |
|
|
6711
|
-
| currency_code | string | no | Currency code for all amounts |
|
|
6712
6731
|
| currency_symbol | string | no | Currency symbol for currency |
|
|
6732
|
+
| marked | number | no | Original price of product |
|
|
6713
6733
|
| effective | number | no | Current per unit price of product after existing deductions |
|
|
6734
|
+
| currency_code | string | no | Currency code for all amounts |
|
|
6714
6735
|
|
|
6715
6736
|
---
|
|
6716
6737
|
|
|
@@ -6721,12 +6742,12 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6721
6742
|
|
|
6722
6743
|
| Properties | Type | Nullable | Description |
|
|
6723
6744
|
| ---------- | ---- | -------- | ----------- |
|
|
6724
|
-
|
|
|
6745
|
+
| auto_applied | boolean | no | Whether offer discount is auto applied in cart |
|
|
6725
6746
|
| total | number | no | Total price of offer quantity with discount |
|
|
6726
6747
|
| margin | number | no | Percentage value of discount |
|
|
6727
|
-
|
|
|
6728
|
-
| price | [OfferPrice](#OfferPrice) | no | |
|
|
6748
|
+
| best | boolean | no | Is true for best offer from all offers present for all sellers |
|
|
6729
6749
|
| quantity | number | no | Quantity on which offer is applicable |
|
|
6750
|
+
| price | [OfferPrice](#OfferPrice) | no | |
|
|
6730
6751
|
| type | string | no | Offer type |
|
|
6731
6752
|
|
|
6732
6753
|
---
|
|
@@ -6784,28 +6805,30 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6784
6805
|
|
|
6785
6806
|
| Properties | Type | Nullable | Description |
|
|
6786
6807
|
| ---------- | ---- | -------- | ----------- |
|
|
6808
|
+
| geo_location | [GeoLocation](#GeoLocation) | no | |
|
|
6809
|
+
| country_iso_code | string | no | |
|
|
6787
6810
|
| state | string | no | |
|
|
6811
|
+
| is_active | boolean | no | |
|
|
6812
|
+
| country_phone_code | string | no | |
|
|
6813
|
+
| area_code | string | no | |
|
|
6814
|
+
| city | string | no | |
|
|
6788
6815
|
| area | string | no | |
|
|
6789
|
-
| address_type | string | no | |
|
|
6790
|
-
| tags | [string] | no | |
|
|
6791
6816
|
| phone | string | no | |
|
|
6792
6817
|
| meta | string | no | |
|
|
6818
|
+
| area_code_slug | string | no | |
|
|
6793
6819
|
| checkout_mode | string | no | |
|
|
6794
|
-
|
|
|
6795
|
-
| id | string | no | |
|
|
6796
|
-
| address | string | no | |
|
|
6820
|
+
| email | string | no | |
|
|
6797
6821
|
| country_code | string | no | |
|
|
6822
|
+
| id | string | no | |
|
|
6798
6823
|
| country | string | no | |
|
|
6799
|
-
|
|
|
6800
|
-
| email | string | no | |
|
|
6801
|
-
| city | string | no | |
|
|
6802
|
-
| geo_location | [GeoLocation](#GeoLocation) | no | |
|
|
6803
|
-
| area_code_slug | string | no | |
|
|
6804
|
-
| is_active | boolean | no | |
|
|
6805
|
-
| name | string | no | |
|
|
6824
|
+
| address | string | no | |
|
|
6806
6825
|
| landmark | string | no | |
|
|
6807
|
-
|
|
|
6826
|
+
| name | string | no | |
|
|
6808
6827
|
| google_map_point | string | no | |
|
|
6828
|
+
| tags | [string] | no | |
|
|
6829
|
+
| is_default_address | boolean | no | |
|
|
6830
|
+
| address_type | string | no | |
|
|
6831
|
+
| user_id | string | no | |
|
|
6809
6832
|
|
|
6810
6833
|
---
|
|
6811
6834
|
|
|
@@ -6827,8 +6850,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6827
6850
|
|
|
6828
6851
|
| Properties | Type | Nullable | Description |
|
|
6829
6852
|
| ---------- | ---- | -------- | ----------- |
|
|
6830
|
-
| success | boolean | no | |
|
|
6831
6853
|
| is_default_address | boolean | no | |
|
|
6854
|
+
| success | boolean | no | |
|
|
6832
6855
|
| id | string | no | |
|
|
6833
6856
|
|
|
6834
6857
|
---
|
|
@@ -6840,10 +6863,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6840
6863
|
|
|
6841
6864
|
| Properties | Type | Nullable | Description |
|
|
6842
6865
|
| ---------- | ---- | -------- | ----------- |
|
|
6843
|
-
| is_updated | boolean | no | |
|
|
6844
6866
|
| is_default_address | boolean | no | |
|
|
6845
|
-
|
|
|
6867
|
+
| is_updated | boolean | no | |
|
|
6846
6868
|
| success | boolean | no | |
|
|
6869
|
+
| id | string | no | |
|
|
6847
6870
|
|
|
6848
6871
|
---
|
|
6849
6872
|
|
|
@@ -6879,12 +6902,12 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6879
6902
|
|
|
6880
6903
|
| Properties | Type | Nullable | Description |
|
|
6881
6904
|
| ---------- | ---- | -------- | ----------- |
|
|
6882
|
-
| payment_mode | string | no | |
|
|
6883
|
-
| aggregator_name | string | no | |
|
|
6884
6905
|
| payment_identifier | string | no | |
|
|
6906
|
+
| id | string | no | |
|
|
6907
|
+
| aggregator_name | string | no | |
|
|
6908
|
+
| payment_mode | string | no | |
|
|
6885
6909
|
| address_id | string | no | |
|
|
6886
6910
|
| merchant_code | string | no | |
|
|
6887
|
-
| id | string | no | |
|
|
6888
6911
|
|
|
6889
6912
|
---
|
|
6890
6913
|
|
|
@@ -6895,11 +6918,11 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6895
6918
|
|
|
6896
6919
|
| Properties | Type | Nullable | Description |
|
|
6897
6920
|
| ---------- | ---- | -------- | ----------- |
|
|
6898
|
-
| discount | number | no | |
|
|
6899
|
-
| valid | boolean | no | |
|
|
6900
|
-
| display_message_en | string | no | |
|
|
6901
6921
|
| code | string | no | |
|
|
6922
|
+
| valid | boolean | no | |
|
|
6902
6923
|
| title | string | no | |
|
|
6924
|
+
| discount | number | no | |
|
|
6925
|
+
| display_message_en | string | no | |
|
|
6903
6926
|
|
|
6904
6927
|
---
|
|
6905
6928
|
|
|
@@ -6910,9 +6933,9 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6910
6933
|
|
|
6911
6934
|
| Properties | Type | Nullable | Description |
|
|
6912
6935
|
| ---------- | ---- | -------- | ----------- |
|
|
6913
|
-
| coupon_validity | [CouponValidity](#CouponValidity) | no | |
|
|
6914
6936
|
| message | string | no | |
|
|
6915
6937
|
| success | boolean | yes | |
|
|
6938
|
+
| coupon_validity | [CouponValidity](#CouponValidity) | no | |
|
|
6916
6939
|
|
|
6917
6940
|
---
|
|
6918
6941
|
|
|
@@ -6925,14 +6948,14 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6925
6948
|
| ---------- | ---- | -------- | ----------- |
|
|
6926
6949
|
| fulfillment_id | number | no | |
|
|
6927
6950
|
| shipments | number | no | |
|
|
6928
|
-
|
|
|
6929
|
-
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
6951
|
+
| dp_options | string | no | |
|
|
6930
6952
|
| box_type | string | no | |
|
|
6931
|
-
| shipment_type | string | no | |
|
|
6932
6953
|
| dp_id | string | no | |
|
|
6933
|
-
|
|
|
6934
|
-
|
|
|
6954
|
+
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
6955
|
+
| order_type | string | no | |
|
|
6956
|
+
| shipment_type | string | no | |
|
|
6935
6957
|
| promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
6958
|
+
| fulfillment_type | string | no | |
|
|
6936
6959
|
|
|
6937
6960
|
---
|
|
6938
6961
|
|
|
@@ -6943,25 +6966,25 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6943
6966
|
|
|
6944
6967
|
| Properties | Type | Nullable | Description |
|
|
6945
6968
|
| ---------- | ---- | -------- | ----------- |
|
|
6946
|
-
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
6947
6969
|
| shipments | [[ShipmentResponse](#ShipmentResponse)] | no | |
|
|
6948
|
-
|
|
|
6949
|
-
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
6970
|
+
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
6950
6971
|
| gstin | string | no | |
|
|
6951
6972
|
| error | boolean | no | |
|
|
6973
|
+
| checkout_mode | string | no | |
|
|
6974
|
+
| is_valid | boolean | no | |
|
|
6975
|
+
| uid | string | no | |
|
|
6952
6976
|
| buy_now | boolean | no | |
|
|
6953
|
-
| restrict_checkout | boolean | no | |
|
|
6954
6977
|
| message | string | no | |
|
|
6955
6978
|
| id | string | no | |
|
|
6979
|
+
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
6980
|
+
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
6981
|
+
| coupon_text | string | no | |
|
|
6956
6982
|
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
6957
|
-
| is_valid | boolean | no | |
|
|
6958
|
-
| checkout_mode | string | no | |
|
|
6959
6983
|
| last_modified | string | no | |
|
|
6960
|
-
|
|
|
6961
|
-
|
|
|
6962
|
-
| coupon_text | string | no | |
|
|
6984
|
+
| comment | string | no | |
|
|
6985
|
+
| restrict_checkout | boolean | no | |
|
|
6963
6986
|
| delivery_charge_info | string | no | |
|
|
6964
|
-
|
|
|
6987
|
+
| cart_id | number | no | |
|
|
6965
6988
|
|
|
6966
6989
|
---
|
|
6967
6990
|
|
|
@@ -6972,10 +6995,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6972
6995
|
|
|
6973
6996
|
| Properties | Type | Nullable | Description |
|
|
6974
6997
|
| ---------- | ---- | -------- | ----------- |
|
|
6975
|
-
| _id | string | yes | |
|
|
6976
|
-
| first_name | string | yes | |
|
|
6977
6998
|
| last_name | string | yes | |
|
|
6999
|
+
| _id | string | yes | |
|
|
6978
7000
|
| user | string | yes | |
|
|
7001
|
+
| first_name | string | yes | |
|
|
6979
7002
|
|
|
6980
7003
|
---
|
|
6981
7004
|
|
|
@@ -6986,21 +7009,21 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6986
7009
|
|
|
6987
7010
|
| Properties | Type | Nullable | Description |
|
|
6988
7011
|
| ---------- | ---- | -------- | ----------- |
|
|
6989
|
-
| billing_address | string | no | |
|
|
6990
|
-
| payment_mode | string | yes | |
|
|
6991
|
-
| callback_url | string | no | |
|
|
6992
7012
|
| payment_identifier | string | no | |
|
|
6993
|
-
|
|
|
7013
|
+
| ordering_store | number | no | |
|
|
6994
7014
|
| payment_params | string | no | |
|
|
6995
|
-
|
|
|
7015
|
+
| callback_url | string | no | |
|
|
6996
7016
|
| extra_meta | string | no | |
|
|
6997
|
-
|
|
|
7017
|
+
| staff | [StaffCheckout](#StaffCheckout) | no | |
|
|
6998
7018
|
| billing_address_id | string | no | |
|
|
6999
7019
|
| aggregator | string | no | |
|
|
7000
|
-
| merchant_code | string | no | |
|
|
7001
7020
|
| payment_auto_confirm | boolean | no | |
|
|
7002
|
-
|
|
|
7021
|
+
| address_id | string | no | |
|
|
7022
|
+
| delivery_address | string | no | |
|
|
7003
7023
|
| meta | string | no | |
|
|
7024
|
+
| billing_address | string | no | |
|
|
7025
|
+
| payment_mode | string | yes | |
|
|
7026
|
+
| merchant_code | string | no | |
|
|
7004
7027
|
|
|
7005
7028
|
---
|
|
7006
7029
|
|
|
@@ -7011,34 +7034,34 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7011
7034
|
|
|
7012
7035
|
| Properties | Type | Nullable | Description |
|
|
7013
7036
|
| ---------- | ---- | -------- | ----------- |
|
|
7037
|
+
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
7038
|
+
| store_code | string | no | |
|
|
7039
|
+
| store_emps | [string] | no | |
|
|
7014
7040
|
| user_type | string | no | |
|
|
7015
|
-
| cod_message | string | no | |
|
|
7016
7041
|
| success | boolean | no | |
|
|
7042
|
+
| error_message | string | no | |
|
|
7043
|
+
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
7044
|
+
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
7045
|
+
| comment | string | no | |
|
|
7046
|
+
| delivery_charge_info | string | no | |
|
|
7047
|
+
| cart_id | number | no | |
|
|
7048
|
+
| cod_charges | number | no | |
|
|
7049
|
+
| delivery_charges | number | no | |
|
|
7017
7050
|
| gstin | string | no | |
|
|
7018
|
-
|
|
|
7019
|
-
| store_code | string | no | |
|
|
7020
|
-
| restrict_checkout | boolean | no | |
|
|
7051
|
+
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
7021
7052
|
| checkout_mode | string | no | |
|
|
7053
|
+
| is_valid | boolean | no | |
|
|
7022
7054
|
| order_id | string | no | |
|
|
7023
|
-
| store_emps | [string] | no | |
|
|
7024
|
-
| coupon_text | string | no | |
|
|
7025
|
-
| delivery_charges | number | no | |
|
|
7026
7055
|
| uid | string | no | |
|
|
7027
|
-
| id | string | no | |
|
|
7028
|
-
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
7029
|
-
| comment | string | no | |
|
|
7030
|
-
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
7031
|
-
| cod_charges | number | no | |
|
|
7032
7056
|
| buy_now | boolean | no | |
|
|
7033
7057
|
| message | string | no | |
|
|
7034
|
-
|
|
|
7035
|
-
|
|
|
7058
|
+
| cod_message | string | no | |
|
|
7059
|
+
| id | string | no | |
|
|
7060
|
+
| delivery_charge_order_value | number | no | |
|
|
7061
|
+
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
7062
|
+
| coupon_text | string | no | |
|
|
7036
7063
|
| last_modified | string | no | |
|
|
7037
|
-
|
|
|
7038
|
-
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
7039
|
-
| cart_id | number | no | |
|
|
7040
|
-
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
7041
|
-
| delivery_charge_info | string | no | |
|
|
7064
|
+
| restrict_checkout | boolean | no | |
|
|
7042
7065
|
| cod_available | boolean | no | |
|
|
7043
7066
|
|
|
7044
7067
|
---
|
|
@@ -7050,14 +7073,14 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7050
7073
|
|
|
7051
7074
|
| Properties | Type | Nullable | Description |
|
|
7052
7075
|
| ---------- | ---- | -------- | ----------- |
|
|
7053
|
-
|
|
|
7054
|
-
| success | boolean | no | |
|
|
7055
|
-
| order_id | string | no | |
|
|
7056
|
-
| data | string | no | |
|
|
7076
|
+
| message | string | no | |
|
|
7057
7077
|
| cart | [CheckCart](#CheckCart) | no | |
|
|
7078
|
+
| data | string | no | |
|
|
7079
|
+
| callback_url | string | no | |
|
|
7058
7080
|
| app_intercept_url | string | no | |
|
|
7059
7081
|
| payment_confirm_url | string | no | |
|
|
7060
|
-
|
|
|
7082
|
+
| order_id | string | no | |
|
|
7083
|
+
| success | boolean | no | |
|
|
7061
7084
|
|
|
7062
7085
|
---
|
|
7063
7086
|
|
|
@@ -7068,10 +7091,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7068
7091
|
|
|
7069
7092
|
| Properties | Type | Nullable | Description |
|
|
7070
7093
|
| ---------- | ---- | -------- | ----------- |
|
|
7071
|
-
| pick_up_customer_details | string | no | Customer contact details for customer pickup at store |
|
|
7072
7094
|
| comment | string | no | |
|
|
7073
|
-
| checkout_mode | string | no | |
|
|
7074
7095
|
| gstin | string | no | |
|
|
7096
|
+
| checkout_mode | string | no | |
|
|
7097
|
+
| pick_up_customer_details | string | no | Customer contact details for customer pickup at store |
|
|
7075
7098
|
|
|
7076
7099
|
---
|
|
7077
7100
|
|
|
@@ -7104,8 +7127,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7104
7127
|
|
|
7105
7128
|
| Properties | Type | Nullable | Description |
|
|
7106
7129
|
| ---------- | ---- | -------- | ----------- |
|
|
7107
|
-
| id | string | no | Cart uid for generating sharing |
|
|
7108
7130
|
| meta | string | no | Staff, Ordering store or any other data. This data will be used to generate link as well as sent as shared details. |
|
|
7131
|
+
| id | string | no | Cart uid for generating sharing |
|
|
7109
7132
|
|
|
7110
7133
|
---
|
|
7111
7134
|
|
|
@@ -7128,9 +7151,9 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7128
7151
|
|
|
7129
7152
|
| Properties | Type | Nullable | Description |
|
|
7130
7153
|
| ---------- | ---- | -------- | ----------- |
|
|
7154
|
+
| user | string | no | User details of who generated share link |
|
|
7131
7155
|
| created_on | string | no | |
|
|
7132
7156
|
| source | string | no | Share link device and other source information |
|
|
7133
|
-
| user | string | no | User details of who generated share link |
|
|
7134
7157
|
| token | string | no | Short link id |
|
|
7135
7158
|
| meta | string | no | Meta data sent while generating share cart link |
|
|
7136
7159
|
|
|
@@ -7143,25 +7166,25 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7143
7166
|
|
|
7144
7167
|
| Properties | Type | Nullable | Description |
|
|
7145
7168
|
| ---------- | ---- | -------- | ----------- |
|
|
7169
|
+
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
7170
|
+
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
7171
|
+
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
7172
|
+
| comment | string | no | |
|
|
7173
|
+
| delivery_charge_info | string | no | |
|
|
7174
|
+
| cart_id | number | no | |
|
|
7175
|
+
| shared_cart_details | [SharedCartDetails](#SharedCartDetails) | no | |
|
|
7146
7176
|
| gstin | string | no | |
|
|
7147
|
-
|
|
|
7177
|
+
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
7148
7178
|
| checkout_mode | string | no | |
|
|
7149
|
-
|
|
|
7150
|
-
| coupon_text | string | no | |
|
|
7179
|
+
| is_valid | boolean | no | |
|
|
7151
7180
|
| uid | string | no | |
|
|
7152
|
-
| id | string | no | |
|
|
7153
|
-
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
7154
|
-
| comment | string | no | |
|
|
7155
|
-
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
7156
7181
|
| buy_now | boolean | no | |
|
|
7157
7182
|
| message | string | no | |
|
|
7158
|
-
|
|
|
7159
|
-
|
|
|
7183
|
+
| id | string | no | |
|
|
7184
|
+
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
7185
|
+
| coupon_text | string | no | |
|
|
7160
7186
|
| last_modified | string | no | |
|
|
7161
|
-
|
|
|
7162
|
-
| cart_id | number | no | |
|
|
7163
|
-
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
7164
|
-
| delivery_charge_info | string | no | |
|
|
7187
|
+
| restrict_checkout | boolean | no | |
|
|
7165
7188
|
|
|
7166
7189
|
---
|
|
7167
7190
|
|
|
@@ -7185,10 +7208,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7185
7208
|
| Properties | Type | Nullable | Description |
|
|
7186
7209
|
| ---------- | ---- | -------- | ----------- |
|
|
7187
7210
|
| description | string | no | Offer details including T&C |
|
|
7188
|
-
| offer_text | string | no | Offer title |
|
|
7189
|
-
| valid_till | string | no | Datetime ISOString for promotion end date |
|
|
7190
7211
|
| id | string | no | Promotion id |
|
|
7212
|
+
| offer_text | string | no | Offer title |
|
|
7191
7213
|
| promotion_group | string | no | Group of promotion belongs to |
|
|
7214
|
+
| valid_till | string | no | Datetime ISOString for promotion end date |
|
|
7192
7215
|
|
|
7193
7216
|
---
|
|
7194
7217
|
|
|
@@ -7218,27 +7241,15 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7218
7241
|
|
|
7219
7242
|
|
|
7220
7243
|
|
|
7221
|
-
#### [CurrencyInfo](#CurrencyInfo)
|
|
7222
|
-
|
|
7223
|
-
| Properties | Type | Nullable | Description |
|
|
7224
|
-
| ---------- | ---- | -------- | ----------- |
|
|
7225
|
-
| symbol | string | no | |
|
|
7226
|
-
| code | string | no | |
|
|
7227
|
-
|
|
7228
|
-
---
|
|
7229
|
-
|
|
7230
|
-
|
|
7231
|
-
|
|
7232
|
-
|
|
7233
7244
|
#### [LadderPrice](#LadderPrice)
|
|
7234
7245
|
|
|
7235
7246
|
| Properties | Type | Nullable | Description |
|
|
7236
7247
|
| ---------- | ---- | -------- | ----------- |
|
|
7237
|
-
| marked | number | no | Original price of product |
|
|
7238
|
-
| currency_code | string | no | Currency code for all amounts |
|
|
7239
7248
|
| currency_symbol | string | no | Currency symbol for currency |
|
|
7249
|
+
| marked | number | no | Original price of product |
|
|
7240
7250
|
| offer_price | number | no | Discounted per unit price for current offer object |
|
|
7241
7251
|
| effective | number | no | Current per unit price of product after existing deductions |
|
|
7252
|
+
| currency_code | string | no | Currency code for all amounts |
|
|
7242
7253
|
|
|
7243
7254
|
---
|
|
7244
7255
|
|
|
@@ -7265,11 +7276,23 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7265
7276
|
| Properties | Type | Nullable | Description |
|
|
7266
7277
|
| ---------- | ---- | -------- | ----------- |
|
|
7267
7278
|
| description | string | no | Offer details including T&C |
|
|
7268
|
-
| offer_text | string | no | Offer title |
|
|
7269
|
-
| valid_till | string | no | Datetime ISOString for promotion end date |
|
|
7270
|
-
| offer_prices | [[LadderOfferItem](#LadderOfferItem)] | no | |
|
|
7271
7279
|
| id | string | no | Promotion id |
|
|
7280
|
+
| offer_text | string | no | Offer title |
|
|
7272
7281
|
| promotion_group | string | no | Group of promotion belongs to |
|
|
7282
|
+
| offer_prices | [[LadderOfferItem](#LadderOfferItem)] | no | |
|
|
7283
|
+
| valid_till | string | no | Datetime ISOString for promotion end date |
|
|
7284
|
+
|
|
7285
|
+
---
|
|
7286
|
+
|
|
7287
|
+
|
|
7288
|
+
|
|
7289
|
+
|
|
7290
|
+
#### [CurrencyInfo](#CurrencyInfo)
|
|
7291
|
+
|
|
7292
|
+
| Properties | Type | Nullable | Description |
|
|
7293
|
+
| ---------- | ---- | -------- | ----------- |
|
|
7294
|
+
| symbol | string | no | |
|
|
7295
|
+
| code | string | no | |
|
|
7273
7296
|
|
|
7274
7297
|
---
|
|
7275
7298
|
|
|
@@ -7280,8 +7303,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7280
7303
|
|
|
7281
7304
|
| Properties | Type | Nullable | Description |
|
|
7282
7305
|
| ---------- | ---- | -------- | ----------- |
|
|
7283
|
-
| currency | [CurrencyInfo](#CurrencyInfo) | no | |
|
|
7284
7306
|
| available_offers | [[LadderPriceOffer](#LadderPriceOffer)] | no | |
|
|
7307
|
+
| currency | [CurrencyInfo](#CurrencyInfo) | no | |
|
|
7285
7308
|
|
|
7286
7309
|
---
|
|
7287
7310
|
|