@gofynd/fdk-client-javascript 0.1.35 → 0.1.36
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 +256 -239
- package/documentation/application/CATALOG.md +413 -409
- 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 +4 -0
- package/documentation/application/ORDER.md +307 -303
- package/documentation/application/PAYMENT.md +445 -259
- package/documentation/application/POSCART.md +317 -300
- 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 +4 -0
- package/documentation/platform/BILLING.md +4 -0
- package/documentation/platform/CART.md +480 -463
- package/documentation/platform/CATALOG.md +3895 -2942
- package/documentation/platform/COMMON.md +4 -0
- package/documentation/platform/COMMUNICATION.md +4 -0
- package/documentation/platform/COMPANYPROFILE.md +224 -193
- 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 +1 -1
- package/sdk/application/ApplicationModels.d.ts +77 -73
- package/sdk/application/ApplicationModels.js +1751 -1725
- 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 +5 -5
- 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/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 +8600 -7286
- package/sdk/platform/PlatformApplicationClient.js +4338 -3678
- package/sdk/platform/PlatformApplicationModels.d.ts +21 -26
- package/sdk/platform/PlatformApplicationModels.js +5561 -4301
- package/sdk/platform/PlatformClient.d.ts +3448 -2801
- package/sdk/platform/PlatformClient.js +3903 -3108
- package/sdk/platform/PlatformModels.d.ts +352 -278
- package/sdk/platform/PlatformModels.js +5230 -3942
- 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 +209 -150
- package/sdk/platform/client/CatalogPlatformClient.js +441 -294
- 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 +24 -21
- package/sdk/platform/models/CatalogValidator.js +103 -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
|
|
|
@@ -6130,14 +6134,16 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6130
6134
|
|
|
6131
6135
|
|
|
6132
6136
|
|
|
6133
|
-
#### [
|
|
6137
|
+
#### [DisplayBreakup](#DisplayBreakup)
|
|
6134
6138
|
|
|
6135
6139
|
| Properties | Type | Nullable | Description |
|
|
6136
6140
|
| ---------- | ---- | -------- | ----------- |
|
|
6137
|
-
|
|
|
6138
|
-
|
|
|
6139
|
-
|
|
|
6140
|
-
|
|
|
6141
|
+
| display | string | no | |
|
|
6142
|
+
| value | number | no | |
|
|
6143
|
+
| currency_code | string | no | |
|
|
6144
|
+
| currency_symbol | string | no | |
|
|
6145
|
+
| message | [string] | no | |
|
|
6146
|
+
| key | string | no | |
|
|
6141
6147
|
|
|
6142
6148
|
---
|
|
6143
6149
|
|
|
@@ -6148,12 +6154,12 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6148
6154
|
|
|
6149
6155
|
| Properties | Type | Nullable | Description |
|
|
6150
6156
|
| ---------- | ---- | -------- | ----------- |
|
|
6151
|
-
|
|
|
6152
|
-
| uid | string | no | |
|
|
6157
|
+
| type | string | no | |
|
|
6153
6158
|
| code | string | no | |
|
|
6159
|
+
| uid | string | no | |
|
|
6154
6160
|
| is_applied | boolean | no | |
|
|
6161
|
+
| value | number | no | |
|
|
6155
6162
|
| message | string | no | |
|
|
6156
|
-
| type | string | no | |
|
|
6157
6163
|
|
|
6158
6164
|
---
|
|
6159
6165
|
|
|
@@ -6164,34 +6170,32 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6164
6170
|
|
|
6165
6171
|
| Properties | Type | Nullable | Description |
|
|
6166
6172
|
| ---------- | ---- | -------- | ----------- |
|
|
6167
|
-
|
|
|
6168
|
-
| coupon | number | no | |
|
|
6169
|
-
| total | number | no | |
|
|
6173
|
+
| cod_charge | number | no | |
|
|
6170
6174
|
| convenience_fee | number | no | |
|
|
6171
6175
|
| subtotal | number | no | |
|
|
6172
|
-
| delivery_charge | number | no | |
|
|
6173
6176
|
| you_saved | number | no | |
|
|
6174
|
-
|
|
|
6177
|
+
| total | number | no | |
|
|
6175
6178
|
| fynd_cash | number | no | |
|
|
6179
|
+
| delivery_charge | number | no | |
|
|
6180
|
+
| coupon | number | no | |
|
|
6176
6181
|
| mrp_total | number | no | |
|
|
6177
|
-
| cod_charge | number | no | |
|
|
6178
6182
|
| gst_charges | number | no | |
|
|
6183
|
+
| discount | number | no | |
|
|
6184
|
+
| vog | number | no | |
|
|
6179
6185
|
|
|
6180
6186
|
---
|
|
6181
6187
|
|
|
6182
6188
|
|
|
6183
6189
|
|
|
6184
6190
|
|
|
6185
|
-
#### [
|
|
6191
|
+
#### [LoyaltyPoints](#LoyaltyPoints)
|
|
6186
6192
|
|
|
6187
6193
|
| Properties | Type | Nullable | Description |
|
|
6188
6194
|
| ---------- | ---- | -------- | ----------- |
|
|
6189
|
-
|
|
|
6190
|
-
|
|
|
6191
|
-
|
|
|
6192
|
-
|
|
|
6193
|
-
| currency_symbol | string | no | |
|
|
6194
|
-
| message | [string] | no | |
|
|
6195
|
+
| total | number | no | |
|
|
6196
|
+
| applicable | number | no | |
|
|
6197
|
+
| is_applied | boolean | no | |
|
|
6198
|
+
| description | string | no | |
|
|
6195
6199
|
|
|
6196
6200
|
---
|
|
6197
6201
|
|
|
@@ -6202,10 +6206,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6202
6206
|
|
|
6203
6207
|
| Properties | Type | Nullable | Description |
|
|
6204
6208
|
| ---------- | ---- | -------- | ----------- |
|
|
6205
|
-
|
|
|
6209
|
+
| display | [[DisplayBreakup](#DisplayBreakup)] | no | |
|
|
6206
6210
|
| coupon | [CouponBreakup](#CouponBreakup) | no | |
|
|
6207
6211
|
| raw | [RawBreakup](#RawBreakup) | no | |
|
|
6208
|
-
|
|
|
6212
|
+
| loyalty_points | [LoyaltyPoints](#LoyaltyPoints) | no | |
|
|
6209
6213
|
|
|
6210
6214
|
---
|
|
6211
6215
|
|
|
@@ -6248,13 +6252,25 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6248
6252
|
|
|
6249
6253
|
|
|
6250
6254
|
|
|
6255
|
+
#### [CartCurrency](#CartCurrency)
|
|
6256
|
+
|
|
6257
|
+
| Properties | Type | Nullable | Description |
|
|
6258
|
+
| ---------- | ---- | -------- | ----------- |
|
|
6259
|
+
| symbol | string | no | |
|
|
6260
|
+
| code | string | no | Currency code defined by ISO 4217:2015 |
|
|
6261
|
+
|
|
6262
|
+
---
|
|
6263
|
+
|
|
6264
|
+
|
|
6265
|
+
|
|
6266
|
+
|
|
6251
6267
|
#### [PaymentSelectionLock](#PaymentSelectionLock)
|
|
6252
6268
|
|
|
6253
6269
|
| Properties | Type | Nullable | Description |
|
|
6254
6270
|
| ---------- | ---- | -------- | ----------- |
|
|
6255
|
-
| enabled | boolean | no | |
|
|
6256
|
-
| default_options | string | no | |
|
|
6257
6271
|
| payment_identifier | string | no | |
|
|
6272
|
+
| default_options | string | no | |
|
|
6273
|
+
| enabled | boolean | no | |
|
|
6258
6274
|
|
|
6259
6275
|
---
|
|
6260
6276
|
|
|
@@ -6291,8 +6307,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6291
6307
|
|
|
6292
6308
|
| Properties | Type | Nullable | Description |
|
|
6293
6309
|
| ---------- | ---- | -------- | ----------- |
|
|
6294
|
-
| base | [BasePrice](#BasePrice) | no | |
|
|
6295
6310
|
| converted | [BasePrice](#BasePrice) | no | |
|
|
6311
|
+
| base | [BasePrice](#BasePrice) | no | |
|
|
6296
6312
|
|
|
6297
6313
|
---
|
|
6298
6314
|
|
|
@@ -6303,202 +6319,203 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6303
6319
|
|
|
6304
6320
|
| Properties | Type | Nullable | Description |
|
|
6305
6321
|
| ---------- | ---- | -------- | ----------- |
|
|
6306
|
-
|
|
|
6307
|
-
| quantity | number | no | |
|
|
6308
|
-
| size | string | no | |
|
|
6322
|
+
| type | string | no | |
|
|
6309
6323
|
| extra_meta | string | no | |
|
|
6310
|
-
| price | [ArticlePriceInfo](#ArticlePriceInfo) | no | |
|
|
6311
6324
|
| product_group_tags | [string] | no | |
|
|
6312
|
-
|
|
|
6325
|
+
| seller | [BaseInfo](#BaseInfo) | no | |
|
|
6313
6326
|
| uid | string | no | |
|
|
6327
|
+
| store | [BaseInfo](#BaseInfo) | no | |
|
|
6328
|
+
| price | [ArticlePriceInfo](#ArticlePriceInfo) | no | |
|
|
6329
|
+
| size | string | no | |
|
|
6314
6330
|
| parent_item_identifiers | string | no | |
|
|
6315
|
-
|
|
|
6331
|
+
| quantity | number | no | |
|
|
6316
6332
|
|
|
6317
6333
|
---
|
|
6318
6334
|
|
|
6319
6335
|
|
|
6320
6336
|
|
|
6321
6337
|
|
|
6322
|
-
#### [
|
|
6338
|
+
#### [PromoMeta](#PromoMeta)
|
|
6323
6339
|
|
|
6324
6340
|
| Properties | Type | Nullable | Description |
|
|
6325
6341
|
| ---------- | ---- | -------- | ----------- |
|
|
6326
|
-
|
|
|
6327
|
-
| name | string | no | |
|
|
6342
|
+
| message | string | no | |
|
|
6328
6343
|
|
|
6329
6344
|
---
|
|
6330
6345
|
|
|
6331
6346
|
|
|
6332
6347
|
|
|
6333
6348
|
|
|
6334
|
-
#### [
|
|
6349
|
+
#### [CartProductIdentifer](#CartProductIdentifer)
|
|
6335
6350
|
|
|
6336
6351
|
| Properties | Type | Nullable | Description |
|
|
6337
6352
|
| ---------- | ---- | -------- | ----------- |
|
|
6338
|
-
|
|
|
6339
|
-
| url | string | no | |
|
|
6340
|
-
| aspect_ratio | string | no | |
|
|
6353
|
+
| identifier | string | no | Article idenfier generated by cart |
|
|
6341
6354
|
|
|
6342
6355
|
---
|
|
6343
6356
|
|
|
6344
6357
|
|
|
6345
6358
|
|
|
6346
6359
|
|
|
6347
|
-
#### [
|
|
6360
|
+
#### [ProductPrice](#ProductPrice)
|
|
6348
6361
|
|
|
6349
6362
|
| Properties | Type | Nullable | Description |
|
|
6350
6363
|
| ---------- | ---- | -------- | ----------- |
|
|
6351
|
-
|
|
|
6364
|
+
| selling | number | no | |
|
|
6365
|
+
| add_on | number | no | |
|
|
6366
|
+
| marked | number | no | |
|
|
6367
|
+
| currency_code | string | no | |
|
|
6368
|
+
| currency_symbol | string | no | |
|
|
6369
|
+
| effective | number | no | |
|
|
6352
6370
|
|
|
6353
6371
|
---
|
|
6354
6372
|
|
|
6355
6373
|
|
|
6356
6374
|
|
|
6357
6375
|
|
|
6358
|
-
#### [
|
|
6376
|
+
#### [ProductPriceInfo](#ProductPriceInfo)
|
|
6359
6377
|
|
|
6360
6378
|
| Properties | Type | Nullable | Description |
|
|
6361
6379
|
| ---------- | ---- | -------- | ----------- |
|
|
6362
|
-
|
|
|
6363
|
-
|
|
|
6364
|
-
| type | string | no | |
|
|
6380
|
+
| converted | [ProductPrice](#ProductPrice) | no | |
|
|
6381
|
+
| base | [ProductPrice](#ProductPrice) | no | |
|
|
6365
6382
|
|
|
6366
6383
|
---
|
|
6367
6384
|
|
|
6368
6385
|
|
|
6369
6386
|
|
|
6370
6387
|
|
|
6371
|
-
#### [
|
|
6388
|
+
#### [ProductAvailability](#ProductAvailability)
|
|
6372
6389
|
|
|
6373
6390
|
| Properties | Type | Nullable | Description |
|
|
6374
6391
|
| ---------- | ---- | -------- | ----------- |
|
|
6375
|
-
|
|
|
6376
|
-
|
|
|
6377
|
-
|
|
|
6378
|
-
|
|
|
6379
|
-
|
|
|
6380
|
-
| action | [ProductAction](#ProductAction) | no | |
|
|
6381
|
-
| uid | number | no | |
|
|
6382
|
-
| type | string | no | |
|
|
6392
|
+
| other_store_quantity | number | no | |
|
|
6393
|
+
| sizes | [string] | no | |
|
|
6394
|
+
| is_valid | boolean | no | |
|
|
6395
|
+
| deliverable | boolean | no | |
|
|
6396
|
+
| out_of_stock | boolean | no | |
|
|
6383
6397
|
|
|
6384
6398
|
---
|
|
6385
6399
|
|
|
6386
6400
|
|
|
6387
6401
|
|
|
6388
6402
|
|
|
6389
|
-
#### [
|
|
6403
|
+
#### [Ownership](#Ownership)
|
|
6390
6404
|
|
|
6391
6405
|
| Properties | Type | Nullable | Description |
|
|
6392
6406
|
| ---------- | ---- | -------- | ----------- |
|
|
6393
|
-
|
|
|
6407
|
+
| payable_by | string | no | promo amount bearable party |
|
|
6408
|
+
| payable_category | string | no | promo amount payable category |
|
|
6394
6409
|
|
|
6395
6410
|
---
|
|
6396
6411
|
|
|
6397
6412
|
|
|
6398
6413
|
|
|
6399
6414
|
|
|
6400
|
-
#### [
|
|
6415
|
+
#### [AppliedPromotion](#AppliedPromotion)
|
|
6401
6416
|
|
|
6402
6417
|
| Properties | Type | Nullable | Description |
|
|
6403
6418
|
| ---------- | ---- | -------- | ----------- |
|
|
6404
|
-
|
|
|
6405
|
-
|
|
|
6406
|
-
|
|
|
6407
|
-
|
|
|
6408
|
-
|
|
|
6409
|
-
|
|
|
6419
|
+
| amount | number | no | Per unit discount amount applied with current promotion |
|
|
6420
|
+
| promo_id | string | no | Promotion id |
|
|
6421
|
+
| mrp_promotion | boolean | no | If applied promotion is applied on product MRP or ESP |
|
|
6422
|
+
| offer_text | string | no | Offer text of current promotion |
|
|
6423
|
+
| article_quantity | number | no | Quantity of article on which promotion is applicable |
|
|
6424
|
+
| ownership | [Ownership](#Ownership) | no | Ownership of promotion |
|
|
6425
|
+
| promotion_type | string | no | Promotion type of current promotion |
|
|
6410
6426
|
|
|
6411
6427
|
---
|
|
6412
6428
|
|
|
6413
6429
|
|
|
6414
6430
|
|
|
6415
6431
|
|
|
6416
|
-
#### [
|
|
6432
|
+
#### [CategoryInfo](#CategoryInfo)
|
|
6417
6433
|
|
|
6418
6434
|
| Properties | Type | Nullable | Description |
|
|
6419
6435
|
| ---------- | ---- | -------- | ----------- |
|
|
6420
|
-
|
|
|
6421
|
-
|
|
|
6436
|
+
| uid | number | no | Product Category Id |
|
|
6437
|
+
| name | string | no | |
|
|
6422
6438
|
|
|
6423
6439
|
---
|
|
6424
6440
|
|
|
6425
6441
|
|
|
6426
6442
|
|
|
6427
6443
|
|
|
6428
|
-
#### [
|
|
6444
|
+
#### [ProductImage](#ProductImage)
|
|
6429
6445
|
|
|
6430
6446
|
| Properties | Type | Nullable | Description |
|
|
6431
6447
|
| ---------- | ---- | -------- | ----------- |
|
|
6432
|
-
|
|
|
6433
|
-
|
|
|
6434
|
-
|
|
|
6435
|
-
| mrp_promotion | boolean | no | If applied promotion is applied on product MRP or ESP |
|
|
6436
|
-
| offer_text | string | no | Offer text of current promotion |
|
|
6437
|
-
| amount | number | no | Per unit discount amount applied with current promotion |
|
|
6448
|
+
| secure_url | string | no | |
|
|
6449
|
+
| aspect_ratio | string | no | |
|
|
6450
|
+
| url | string | no | |
|
|
6438
6451
|
|
|
6439
6452
|
---
|
|
6440
6453
|
|
|
6441
6454
|
|
|
6442
6455
|
|
|
6443
6456
|
|
|
6444
|
-
#### [
|
|
6457
|
+
#### [ActionQuery](#ActionQuery)
|
|
6445
6458
|
|
|
6446
6459
|
| Properties | Type | Nullable | Description |
|
|
6447
6460
|
| ---------- | ---- | -------- | ----------- |
|
|
6448
|
-
|
|
|
6461
|
+
| product_slug | [string] | no | Contains list of product slug |
|
|
6449
6462
|
|
|
6450
6463
|
---
|
|
6451
6464
|
|
|
6452
6465
|
|
|
6453
6466
|
|
|
6454
6467
|
|
|
6455
|
-
#### [
|
|
6468
|
+
#### [ProductAction](#ProductAction)
|
|
6456
6469
|
|
|
6457
6470
|
| Properties | Type | Nullable | Description |
|
|
6458
6471
|
| ---------- | ---- | -------- | ----------- |
|
|
6459
|
-
|
|
|
6460
|
-
|
|
|
6461
|
-
|
|
|
6462
|
-
| sizes | [string] | no | |
|
|
6463
|
-
| deliverable | boolean | no | |
|
|
6472
|
+
| type | string | no | |
|
|
6473
|
+
| url | string | no | |
|
|
6474
|
+
| query | [ActionQuery](#ActionQuery) | no | |
|
|
6464
6475
|
|
|
6465
6476
|
---
|
|
6466
6477
|
|
|
6467
6478
|
|
|
6468
6479
|
|
|
6469
6480
|
|
|
6470
|
-
#### [
|
|
6481
|
+
#### [CartProduct](#CartProduct)
|
|
6471
6482
|
|
|
6472
6483
|
| Properties | Type | Nullable | Description |
|
|
6473
6484
|
| ---------- | ---- | -------- | ----------- |
|
|
6474
|
-
|
|
|
6475
|
-
|
|
|
6476
|
-
|
|
|
6477
|
-
|
|
|
6478
|
-
|
|
|
6479
|
-
|
|
|
6480
|
-
|
|
|
6481
|
-
|
|
|
6482
|
-
| promo_meta | [PromoMeta](#PromoMeta) | no | |
|
|
6483
|
-
| 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 | |
|
|
6485
|
+
| type | string | no | |
|
|
6486
|
+
| categories | [[CategoryInfo](#CategoryInfo)] | no | |
|
|
6487
|
+
| name | string | no | |
|
|
6488
|
+
| uid | number | no | |
|
|
6489
|
+
| brand | [BaseInfo](#BaseInfo) | no | |
|
|
6490
|
+
| images | [[ProductImage](#ProductImage)] | no | |
|
|
6491
|
+
| slug | string | no | Unique product url name generated via product name and other meta data |
|
|
6492
|
+
| action | [ProductAction](#ProductAction) | no | |
|
|
6490
6493
|
|
|
6491
6494
|
---
|
|
6492
6495
|
|
|
6493
6496
|
|
|
6494
6497
|
|
|
6495
6498
|
|
|
6496
|
-
#### [
|
|
6499
|
+
#### [CartProductInfo](#CartProductInfo)
|
|
6497
6500
|
|
|
6498
6501
|
| Properties | Type | Nullable | Description |
|
|
6499
6502
|
| ---------- | ---- | -------- | ----------- |
|
|
6500
|
-
|
|
|
6501
|
-
|
|
|
6503
|
+
| article | [ProductArticle](#ProductArticle) | no | |
|
|
6504
|
+
| promo_meta | [PromoMeta](#PromoMeta) | no | |
|
|
6505
|
+
| bulk_offer | string | no | |
|
|
6506
|
+
| coupon_message | string | no | |
|
|
6507
|
+
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
6508
|
+
| price_per_unit | [ProductPriceInfo](#ProductPriceInfo) | no | |
|
|
6509
|
+
| availability | [ProductAvailability](#ProductAvailability) | no | |
|
|
6510
|
+
| price | [ProductPriceInfo](#ProductPriceInfo) | no | |
|
|
6511
|
+
| message | string | no | |
|
|
6512
|
+
| is_set | boolean | no | |
|
|
6513
|
+
| promotions_applied | [[AppliedPromotion](#AppliedPromotion)] | no | |
|
|
6514
|
+
| product | [CartProduct](#CartProduct) | no | |
|
|
6515
|
+
| discount | string | no | |
|
|
6516
|
+
| key | string | no | |
|
|
6517
|
+
| parent_item_identifiers | string | no | |
|
|
6518
|
+
| quantity | number | no | |
|
|
6502
6519
|
|
|
6503
6520
|
---
|
|
6504
6521
|
|
|
@@ -6509,22 +6526,22 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6509
6526
|
|
|
6510
6527
|
| Properties | Type | Nullable | Description |
|
|
6511
6528
|
| ---------- | ---- | -------- | ----------- |
|
|
6529
|
+
| delivery_charge_info | string | no | |
|
|
6530
|
+
| buy_now | boolean | no | |
|
|
6531
|
+
| coupon_text | string | no | |
|
|
6532
|
+
| restrict_checkout | boolean | no | |
|
|
6512
6533
|
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
6513
|
-
| is_valid | boolean | no | |
|
|
6514
|
-
| checkout_mode | string | no | |
|
|
6515
6534
|
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
6535
|
+
| is_valid | boolean | no | |
|
|
6536
|
+
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
6537
|
+
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
6516
6538
|
| last_modified | string | no | |
|
|
6539
|
+
| checkout_mode | string | no | |
|
|
6517
6540
|
| comment | string | no | |
|
|
6518
|
-
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
6519
|
-
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
6520
|
-
| gstin | string | no | |
|
|
6521
|
-
| buy_now | boolean | no | |
|
|
6522
|
-
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
6523
|
-
| coupon_text | string | no | |
|
|
6524
|
-
| delivery_charge_info | string | no | |
|
|
6525
|
-
| restrict_checkout | boolean | no | |
|
|
6526
6541
|
| id | string | no | |
|
|
6542
|
+
| gstin | string | no | |
|
|
6527
6543
|
| message | string | no | |
|
|
6544
|
+
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
6528
6545
|
|
|
6529
6546
|
---
|
|
6530
6547
|
|
|
@@ -6535,18 +6552,18 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6535
6552
|
|
|
6536
6553
|
| Properties | Type | Nullable | Description |
|
|
6537
6554
|
| ---------- | ---- | -------- | ----------- |
|
|
6538
|
-
|
|
|
6555
|
+
| extra_meta | string | no | |
|
|
6539
6556
|
| pos | boolean | no | |
|
|
6540
6557
|
| display | string | no | |
|
|
6541
|
-
| article_assignment | string | no | |
|
|
6542
|
-
| extra_meta | string | no | |
|
|
6543
|
-
| article_id | string | no | |
|
|
6544
|
-
| item_id | number | no | |
|
|
6545
6558
|
| product_group_tags | [string] | no | |
|
|
6559
|
+
| item_id | number | no | |
|
|
6560
|
+
| article_assignment | string | no | |
|
|
6546
6561
|
| seller_id | number | no | |
|
|
6562
|
+
| store_id | number | no | |
|
|
6563
|
+
| article_id | string | no | |
|
|
6547
6564
|
| item_size | string | no | |
|
|
6548
6565
|
| parent_item_identifiers | string | no | |
|
|
6549
|
-
|
|
|
6566
|
+
| quantity | number | no | |
|
|
6550
6567
|
|
|
6551
6568
|
---
|
|
6552
6569
|
|
|
@@ -6568,10 +6585,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6568
6585
|
|
|
6569
6586
|
| Properties | Type | Nullable | Description |
|
|
6570
6587
|
| ---------- | ---- | -------- | ----------- |
|
|
6588
|
+
| success | boolean | no | True if all items are added successfully. False if partially added or not added. |
|
|
6571
6589
|
| cart | [CartDetailResponse](#CartDetailResponse) | no | |
|
|
6572
|
-
| partial | boolean | no | When adding multiple items check if all added. True if only few are added. |
|
|
6573
6590
|
| message | string | no | |
|
|
6574
|
-
|
|
|
6591
|
+
| partial | boolean | no | When adding multiple items check if all added. True if only few are added. |
|
|
6575
6592
|
|
|
6576
6593
|
---
|
|
6577
6594
|
|
|
@@ -6582,13 +6599,13 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6582
6599
|
|
|
6583
6600
|
| Properties | Type | Nullable | Description |
|
|
6584
6601
|
| ---------- | ---- | -------- | ----------- |
|
|
6585
|
-
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
6586
|
-
| parent_item_identifiers | string | no | |
|
|
6587
6602
|
| extra_meta | string | no | |
|
|
6588
|
-
|
|
|
6603
|
+
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
6589
6604
|
| item_id | number | no | |
|
|
6590
6605
|
| item_index | number | no | |
|
|
6606
|
+
| article_id | string | no | |
|
|
6591
6607
|
| item_size | string | no | |
|
|
6608
|
+
| parent_item_identifiers | string | no | |
|
|
6592
6609
|
| quantity | number | no | |
|
|
6593
6610
|
|
|
6594
6611
|
---
|
|
@@ -6612,9 +6629,9 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6612
6629
|
|
|
6613
6630
|
| Properties | Type | Nullable | Description |
|
|
6614
6631
|
| ---------- | ---- | -------- | ----------- |
|
|
6632
|
+
| success | boolean | no | True if all items are added successfully. False if partially added or not added. |
|
|
6615
6633
|
| cart | [CartDetailResponse](#CartDetailResponse) | no | |
|
|
6616
6634
|
| message | string | no | |
|
|
6617
|
-
| success | boolean | no | True if all items are added successfully. False if partially added or not added. |
|
|
6618
6635
|
|
|
6619
6636
|
---
|
|
6620
6637
|
|
|
@@ -6636,11 +6653,11 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6636
6653
|
|
|
6637
6654
|
| Properties | Type | Nullable | Description |
|
|
6638
6655
|
| ---------- | ---- | -------- | ----------- |
|
|
6639
|
-
| has_previous | boolean | no | |
|
|
6640
|
-
| total | number | no | |
|
|
6641
6656
|
| has_next | boolean | no | |
|
|
6642
|
-
|
|
|
6657
|
+
| total | number | no | |
|
|
6658
|
+
| has_previous | boolean | no | |
|
|
6643
6659
|
| total_item_count | number | no | |
|
|
6660
|
+
| current | number | no | |
|
|
6644
6661
|
|
|
6645
6662
|
---
|
|
6646
6663
|
|
|
@@ -6651,16 +6668,16 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6651
6668
|
|
|
6652
6669
|
| Properties | Type | Nullable | Description |
|
|
6653
6670
|
| ---------- | ---- | -------- | ----------- |
|
|
6654
|
-
| is_applicable | boolean | no | |
|
|
6655
6671
|
| max_discount_value | number | no | |
|
|
6656
|
-
| expires_on | string | no | |
|
|
6657
|
-
| message | string | no | |
|
|
6658
6672
|
| sub_title | string | no | |
|
|
6659
|
-
|
|
|
6673
|
+
| expires_on | string | no | |
|
|
6660
6674
|
| coupon_code | string | no | |
|
|
6661
|
-
|
|
|
6675
|
+
| minimum_cart_value | number | no | |
|
|
6676
|
+
| is_applicable | boolean | no | |
|
|
6662
6677
|
| is_applied | boolean | no | |
|
|
6663
6678
|
| coupon_value | number | no | |
|
|
6679
|
+
| message | string | no | |
|
|
6680
|
+
| title | string | no | |
|
|
6664
6681
|
|
|
6665
6682
|
---
|
|
6666
6683
|
|
|
@@ -6706,10 +6723,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6706
6723
|
|
|
6707
6724
|
| Properties | Type | Nullable | Description |
|
|
6708
6725
|
| ---------- | ---- | -------- | ----------- |
|
|
6709
|
-
| bulk_effective | number | no | Discounted per unit price for current offer object |
|
|
6710
6726
|
| marked | number | no | Original price of product |
|
|
6711
6727
|
| currency_code | string | no | Currency code for all amounts |
|
|
6712
6728
|
| currency_symbol | string | no | Currency symbol for currency |
|
|
6729
|
+
| bulk_effective | number | no | Discounted per unit price for current offer object |
|
|
6713
6730
|
| effective | number | no | Current per unit price of product after existing deductions |
|
|
6714
6731
|
|
|
6715
6732
|
---
|
|
@@ -6721,13 +6738,13 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6721
6738
|
|
|
6722
6739
|
| Properties | Type | Nullable | Description |
|
|
6723
6740
|
| ---------- | ---- | -------- | ----------- |
|
|
6724
|
-
|
|
|
6725
|
-
| total | number | no | Total price of offer quantity with discount |
|
|
6726
|
-
| margin | number | no | Percentage value of discount |
|
|
6741
|
+
| type | string | no | Offer type |
|
|
6727
6742
|
| auto_applied | boolean | no | Whether offer discount is auto applied in cart |
|
|
6728
6743
|
| price | [OfferPrice](#OfferPrice) | no | |
|
|
6744
|
+
| total | number | no | Total price of offer quantity with discount |
|
|
6745
|
+
| best | boolean | no | Is true for best offer from all offers present for all sellers |
|
|
6729
6746
|
| quantity | number | no | Quantity on which offer is applicable |
|
|
6730
|
-
|
|
|
6747
|
+
| margin | number | no | Percentage value of discount |
|
|
6731
6748
|
|
|
6732
6749
|
---
|
|
6733
6750
|
|
|
@@ -6772,8 +6789,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6772
6789
|
|
|
6773
6790
|
| Properties | Type | Nullable | Description |
|
|
6774
6791
|
| ---------- | ---- | -------- | ----------- |
|
|
6775
|
-
| latitude | number | no | |
|
|
6776
6792
|
| longitude | number | no | |
|
|
6793
|
+
| latitude | number | no | |
|
|
6777
6794
|
|
|
6778
6795
|
---
|
|
6779
6796
|
|
|
@@ -6784,28 +6801,28 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6784
6801
|
|
|
6785
6802
|
| Properties | Type | Nullable | Description |
|
|
6786
6803
|
| ---------- | ---- | -------- | ----------- |
|
|
6804
|
+
| address | string | no | |
|
|
6787
6805
|
| state | string | no | |
|
|
6788
|
-
|
|
|
6789
|
-
|
|
|
6806
|
+
| name | string | no | |
|
|
6807
|
+
| id | string | no | |
|
|
6790
6808
|
| tags | [string] | no | |
|
|
6791
|
-
|
|
|
6809
|
+
| area | string | no | |
|
|
6810
|
+
| google_map_point | string | no | |
|
|
6792
6811
|
| meta | string | no | |
|
|
6793
6812
|
| checkout_mode | string | no | |
|
|
6794
|
-
|
|
|
6795
|
-
| id | string | no | |
|
|
6796
|
-
| address | string | no | |
|
|
6797
|
-
| country_code | string | no | |
|
|
6798
|
-
| country | string | no | |
|
|
6799
|
-
| area_code | string | no | |
|
|
6813
|
+
| user_id | string | no | |
|
|
6800
6814
|
| email | string | no | |
|
|
6801
|
-
|
|
|
6815
|
+
| is_active | boolean | no | |
|
|
6802
6816
|
| geo_location | [GeoLocation](#GeoLocation) | no | |
|
|
6817
|
+
| address_type | string | no | |
|
|
6818
|
+
| area_code | string | no | |
|
|
6819
|
+
| country_code | string | no | |
|
|
6820
|
+
| city | string | no | |
|
|
6803
6821
|
| area_code_slug | string | no | |
|
|
6804
|
-
|
|
|
6805
|
-
| name | string | no | |
|
|
6822
|
+
| phone | string | no | |
|
|
6806
6823
|
| landmark | string | no | |
|
|
6807
|
-
|
|
|
6808
|
-
|
|
|
6824
|
+
| country | string | no | |
|
|
6825
|
+
| is_default_address | boolean | no | |
|
|
6809
6826
|
|
|
6810
6827
|
---
|
|
6811
6828
|
|
|
@@ -6828,8 +6845,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6828
6845
|
| Properties | Type | Nullable | Description |
|
|
6829
6846
|
| ---------- | ---- | -------- | ----------- |
|
|
6830
6847
|
| success | boolean | no | |
|
|
6831
|
-
| is_default_address | boolean | no | |
|
|
6832
6848
|
| id | string | no | |
|
|
6849
|
+
| is_default_address | boolean | no | |
|
|
6833
6850
|
|
|
6834
6851
|
---
|
|
6835
6852
|
|
|
@@ -6841,9 +6858,9 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6841
6858
|
| Properties | Type | Nullable | Description |
|
|
6842
6859
|
| ---------- | ---- | -------- | ----------- |
|
|
6843
6860
|
| is_updated | boolean | no | |
|
|
6844
|
-
| is_default_address | boolean | no | |
|
|
6845
|
-
| id | string | no | |
|
|
6846
6861
|
| success | boolean | no | |
|
|
6862
|
+
| id | string | no | |
|
|
6863
|
+
| is_default_address | boolean | no | |
|
|
6847
6864
|
|
|
6848
6865
|
---
|
|
6849
6866
|
|
|
@@ -6866,9 +6883,9 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6866
6883
|
|
|
6867
6884
|
| Properties | Type | Nullable | Description |
|
|
6868
6885
|
| ---------- | ---- | -------- | ----------- |
|
|
6869
|
-
| billing_address_id | string | no | |
|
|
6870
6886
|
| cart_id | string | no | |
|
|
6871
6887
|
| id | string | no | |
|
|
6888
|
+
| billing_address_id | string | no | |
|
|
6872
6889
|
|
|
6873
6890
|
---
|
|
6874
6891
|
|
|
@@ -6879,11 +6896,11 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6879
6896
|
|
|
6880
6897
|
| Properties | Type | Nullable | Description |
|
|
6881
6898
|
| ---------- | ---- | -------- | ----------- |
|
|
6882
|
-
| payment_mode | string | no | |
|
|
6883
6899
|
| aggregator_name | string | no | |
|
|
6900
|
+
| merchant_code | string | no | |
|
|
6884
6901
|
| payment_identifier | string | no | |
|
|
6885
6902
|
| address_id | string | no | |
|
|
6886
|
-
|
|
|
6903
|
+
| payment_mode | string | no | |
|
|
6887
6904
|
| id | string | no | |
|
|
6888
6905
|
|
|
6889
6906
|
---
|
|
@@ -6895,10 +6912,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6895
6912
|
|
|
6896
6913
|
| Properties | Type | Nullable | Description |
|
|
6897
6914
|
| ---------- | ---- | -------- | ----------- |
|
|
6898
|
-
|
|
|
6915
|
+
| code | string | no | |
|
|
6899
6916
|
| valid | boolean | no | |
|
|
6900
6917
|
| display_message_en | string | no | |
|
|
6901
|
-
|
|
|
6918
|
+
| discount | number | no | |
|
|
6902
6919
|
| title | string | no | |
|
|
6903
6920
|
|
|
6904
6921
|
---
|
|
@@ -6910,9 +6927,9 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6910
6927
|
|
|
6911
6928
|
| Properties | Type | Nullable | Description |
|
|
6912
6929
|
| ---------- | ---- | -------- | ----------- |
|
|
6930
|
+
| success | boolean | yes | |
|
|
6913
6931
|
| coupon_validity | [CouponValidity](#CouponValidity) | no | |
|
|
6914
6932
|
| message | string | no | |
|
|
6915
|
-
| success | boolean | yes | |
|
|
6916
6933
|
|
|
6917
6934
|
---
|
|
6918
6935
|
|
|
@@ -6925,14 +6942,14 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6925
6942
|
| ---------- | ---- | -------- | ----------- |
|
|
6926
6943
|
| fulfillment_id | number | no | |
|
|
6927
6944
|
| shipments | number | no | |
|
|
6928
|
-
| order_type | string | no | |
|
|
6929
|
-
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
6930
|
-
| box_type | string | no | |
|
|
6931
6945
|
| shipment_type | string | no | |
|
|
6946
|
+
| order_type | string | no | |
|
|
6932
6947
|
| dp_id | string | no | |
|
|
6933
6948
|
| dp_options | string | no | |
|
|
6949
|
+
| box_type | string | no | |
|
|
6934
6950
|
| fulfillment_type | string | no | |
|
|
6935
6951
|
| promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
6952
|
+
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
6936
6953
|
|
|
6937
6954
|
---
|
|
6938
6955
|
|
|
@@ -6943,25 +6960,25 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6943
6960
|
|
|
6944
6961
|
| Properties | Type | Nullable | Description |
|
|
6945
6962
|
| ---------- | ---- | -------- | ----------- |
|
|
6963
|
+
| buy_now | boolean | no | |
|
|
6964
|
+
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
6946
6965
|
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
6947
|
-
|
|
|
6948
|
-
|
|
|
6966
|
+
| uid | string | no | |
|
|
6967
|
+
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
6949
6968
|
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
6969
|
+
| last_modified | string | no | |
|
|
6970
|
+
| id | string | no | |
|
|
6950
6971
|
| gstin | string | no | |
|
|
6951
|
-
| error | boolean | no | |
|
|
6952
|
-
| buy_now | boolean | no | |
|
|
6953
|
-
| restrict_checkout | boolean | no | |
|
|
6954
6972
|
| message | string | no | |
|
|
6955
|
-
|
|
|
6956
|
-
|
|
|
6973
|
+
| delivery_charge_info | string | no | |
|
|
6974
|
+
| coupon_text | string | no | |
|
|
6975
|
+
| restrict_checkout | boolean | no | |
|
|
6976
|
+
| shipments | [[ShipmentResponse](#ShipmentResponse)] | no | |
|
|
6977
|
+
| error | boolean | no | |
|
|
6978
|
+
| comment | string | no | |
|
|
6957
6979
|
| is_valid | boolean | no | |
|
|
6958
6980
|
| checkout_mode | string | no | |
|
|
6959
|
-
| last_modified | string | no | |
|
|
6960
6981
|
| cart_id | number | no | |
|
|
6961
|
-
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
6962
|
-
| coupon_text | string | no | |
|
|
6963
|
-
| delivery_charge_info | string | no | |
|
|
6964
|
-
| uid | string | no | |
|
|
6965
6982
|
|
|
6966
6983
|
---
|
|
6967
6984
|
|
|
@@ -6972,10 +6989,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6972
6989
|
|
|
6973
6990
|
| Properties | Type | Nullable | Description |
|
|
6974
6991
|
| ---------- | ---- | -------- | ----------- |
|
|
6975
|
-
| _id | string | yes | |
|
|
6976
|
-
| first_name | string | yes | |
|
|
6977
6992
|
| last_name | string | yes | |
|
|
6993
|
+
| _id | string | yes | |
|
|
6978
6994
|
| user | string | yes | |
|
|
6995
|
+
| first_name | string | yes | |
|
|
6979
6996
|
|
|
6980
6997
|
---
|
|
6981
6998
|
|
|
@@ -6986,21 +7003,21 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
6986
7003
|
|
|
6987
7004
|
| Properties | Type | Nullable | Description |
|
|
6988
7005
|
| ---------- | ---- | -------- | ----------- |
|
|
6989
|
-
| billing_address | string | no | |
|
|
6990
|
-
| payment_mode | string | yes | |
|
|
6991
|
-
| callback_url | string | no | |
|
|
6992
|
-
| payment_identifier | string | no | |
|
|
6993
|
-
| staff | [StaffCheckout](#StaffCheckout) | no | |
|
|
6994
|
-
| payment_params | string | no | |
|
|
6995
|
-
| address_id | string | no | |
|
|
6996
7006
|
| extra_meta | string | no | |
|
|
6997
|
-
| delivery_address | string | no | |
|
|
6998
|
-
| billing_address_id | string | no | |
|
|
6999
7007
|
| aggregator | string | no | |
|
|
7000
7008
|
| merchant_code | string | no | |
|
|
7009
|
+
| payment_identifier | string | no | |
|
|
7010
|
+
| billing_address | string | no | |
|
|
7011
|
+
| address_id | string | no | |
|
|
7012
|
+
| payment_mode | string | yes | |
|
|
7001
7013
|
| payment_auto_confirm | boolean | no | |
|
|
7002
7014
|
| ordering_store | number | no | |
|
|
7015
|
+
| callback_url | string | no | |
|
|
7016
|
+
| delivery_address | string | no | |
|
|
7017
|
+
| billing_address_id | string | no | |
|
|
7018
|
+
| staff | [StaffCheckout](#StaffCheckout) | no | |
|
|
7003
7019
|
| meta | string | no | |
|
|
7020
|
+
| payment_params | string | no | |
|
|
7004
7021
|
|
|
7005
7022
|
---
|
|
7006
7023
|
|
|
@@ -7011,35 +7028,35 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7011
7028
|
|
|
7012
7029
|
| Properties | Type | Nullable | Description |
|
|
7013
7030
|
| ---------- | ---- | -------- | ----------- |
|
|
7014
|
-
|
|
|
7015
|
-
|
|
|
7031
|
+
| buy_now | boolean | no | |
|
|
7032
|
+
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
7016
7033
|
| success | boolean | no | |
|
|
7034
|
+
| uid | string | no | |
|
|
7035
|
+
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
7036
|
+
| id | string | no | |
|
|
7017
7037
|
| gstin | string | no | |
|
|
7018
7038
|
| delivery_charge_order_value | number | no | |
|
|
7019
|
-
|
|
|
7020
|
-
|
|
|
7039
|
+
| cod_message | string | no | |
|
|
7040
|
+
| is_valid | boolean | no | |
|
|
7021
7041
|
| checkout_mode | string | no | |
|
|
7022
|
-
|
|
|
7042
|
+
| cart_id | number | no | |
|
|
7043
|
+
| store_code | string | no | |
|
|
7023
7044
|
| store_emps | [string] | no | |
|
|
7024
|
-
|
|
|
7025
|
-
| delivery_charges | number | no | |
|
|
7026
|
-
| uid | string | no | |
|
|
7027
|
-
| id | string | no | |
|
|
7045
|
+
| error_message | string | no | |
|
|
7028
7046
|
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
7029
|
-
| comment | string | no | |
|
|
7030
7047
|
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
7031
|
-
| cod_charges | number | no | |
|
|
7032
|
-
| buy_now | boolean | no | |
|
|
7033
|
-
| message | string | no | |
|
|
7034
|
-
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
7035
|
-
| is_valid | boolean | no | |
|
|
7036
7048
|
| last_modified | string | no | |
|
|
7037
|
-
|
|
|
7049
|
+
| cod_available | boolean | no | |
|
|
7050
|
+
| delivery_charges | number | no | |
|
|
7051
|
+
| order_id | string | no | |
|
|
7038
7052
|
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
7039
|
-
|
|
|
7040
|
-
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
7053
|
+
| cod_charges | number | no | |
|
|
7041
7054
|
| delivery_charge_info | string | no | |
|
|
7042
|
-
|
|
|
7055
|
+
| coupon_text | string | no | |
|
|
7056
|
+
| restrict_checkout | boolean | no | |
|
|
7057
|
+
| user_type | string | no | |
|
|
7058
|
+
| comment | string | no | |
|
|
7059
|
+
| message | string | no | |
|
|
7043
7060
|
|
|
7044
7061
|
---
|
|
7045
7062
|
|
|
@@ -7050,14 +7067,14 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7050
7067
|
|
|
7051
7068
|
| Properties | Type | Nullable | Description |
|
|
7052
7069
|
| ---------- | ---- | -------- | ----------- |
|
|
7053
|
-
|
|
|
7070
|
+
| cart | [CheckCart](#CheckCart) | no | |
|
|
7054
7071
|
| success | boolean | no | |
|
|
7055
|
-
| order_id | string | no | |
|
|
7056
7072
|
| data | string | no | |
|
|
7057
|
-
|
|
|
7058
|
-
| app_intercept_url | string | no | |
|
|
7073
|
+
| callback_url | string | no | |
|
|
7059
7074
|
| payment_confirm_url | string | no | |
|
|
7060
7075
|
| message | string | no | |
|
|
7076
|
+
| order_id | string | no | |
|
|
7077
|
+
| app_intercept_url | string | no | |
|
|
7061
7078
|
|
|
7062
7079
|
---
|
|
7063
7080
|
|
|
@@ -7068,10 +7085,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7068
7085
|
|
|
7069
7086
|
| Properties | Type | Nullable | Description |
|
|
7070
7087
|
| ---------- | ---- | -------- | ----------- |
|
|
7088
|
+
| gstin | string | no | |
|
|
7089
|
+
| checkout_mode | string | no | |
|
|
7071
7090
|
| pick_up_customer_details | string | no | Customer contact details for customer pickup at store |
|
|
7072
7091
|
| comment | string | no | |
|
|
7073
|
-
| checkout_mode | string | no | |
|
|
7074
|
-
| gstin | string | no | |
|
|
7075
7092
|
|
|
7076
7093
|
---
|
|
7077
7094
|
|
|
@@ -7104,8 +7121,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7104
7121
|
|
|
7105
7122
|
| Properties | Type | Nullable | Description |
|
|
7106
7123
|
| ---------- | ---- | -------- | ----------- |
|
|
7107
|
-
| id | string | no | Cart uid for generating sharing |
|
|
7108
7124
|
| 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. |
|
|
7125
|
+
| id | string | no | Cart uid for generating sharing |
|
|
7109
7126
|
|
|
7110
7127
|
---
|
|
7111
7128
|
|
|
@@ -7116,8 +7133,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7116
7133
|
|
|
7117
7134
|
| Properties | Type | Nullable | Description |
|
|
7118
7135
|
| ---------- | ---- | -------- | ----------- |
|
|
7119
|
-
| token | string | no | Short url unique id |
|
|
7120
7136
|
| share_url | string | no | Short shareable final url |
|
|
7137
|
+
| token | string | no | Short url unique id |
|
|
7121
7138
|
|
|
7122
7139
|
---
|
|
7123
7140
|
|
|
@@ -7128,11 +7145,11 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7128
7145
|
|
|
7129
7146
|
| Properties | Type | Nullable | Description |
|
|
7130
7147
|
| ---------- | ---- | -------- | ----------- |
|
|
7131
|
-
| created_on | string | no | |
|
|
7132
|
-
| source | string | no | Share link device and other source information |
|
|
7133
|
-
| user | string | no | User details of who generated share link |
|
|
7134
7148
|
| token | string | no | Short link id |
|
|
7149
|
+
| user | string | no | User details of who generated share link |
|
|
7150
|
+
| source | string | no | Share link device and other source information |
|
|
7135
7151
|
| meta | string | no | Meta data sent while generating share cart link |
|
|
7152
|
+
| created_on | string | no | |
|
|
7136
7153
|
|
|
7137
7154
|
---
|
|
7138
7155
|
|
|
@@ -7143,25 +7160,25 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7143
7160
|
|
|
7144
7161
|
| Properties | Type | Nullable | Description |
|
|
7145
7162
|
| ---------- | ---- | -------- | ----------- |
|
|
7146
|
-
|
|
|
7147
|
-
|
|
|
7148
|
-
| checkout_mode | string | no | |
|
|
7149
|
-
| shared_cart_details | [SharedCartDetails](#SharedCartDetails) | no | |
|
|
7150
|
-
| coupon_text | string | no | |
|
|
7163
|
+
| buy_now | boolean | no | |
|
|
7164
|
+
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
7151
7165
|
| uid | string | no | |
|
|
7166
|
+
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
7152
7167
|
| id | string | no | |
|
|
7168
|
+
| shared_cart_details | [SharedCartDetails](#SharedCartDetails) | no | |
|
|
7169
|
+
| gstin | string | no | |
|
|
7170
|
+
| is_valid | boolean | no | |
|
|
7171
|
+
| checkout_mode | string | no | |
|
|
7172
|
+
| cart_id | number | no | |
|
|
7153
7173
|
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
7154
|
-
| comment | string | no | |
|
|
7155
7174
|
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
7156
|
-
| buy_now | boolean | no | |
|
|
7157
|
-
| message | string | no | |
|
|
7158
|
-
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
7159
|
-
| is_valid | boolean | no | |
|
|
7160
7175
|
| last_modified | string | no | |
|
|
7161
7176
|
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
7162
|
-
| cart_id | number | no | |
|
|
7163
|
-
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
7164
7177
|
| delivery_charge_info | string | no | |
|
|
7178
|
+
| coupon_text | string | no | |
|
|
7179
|
+
| restrict_checkout | boolean | no | |
|
|
7180
|
+
| comment | string | no | |
|
|
7181
|
+
| message | string | no | |
|
|
7165
7182
|
|
|
7166
7183
|
---
|
|
7167
7184
|
|
|
@@ -7172,8 +7189,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7172
7189
|
|
|
7173
7190
|
| Properties | Type | Nullable | Description |
|
|
7174
7191
|
| ---------- | ---- | -------- | ----------- |
|
|
7175
|
-
| error | string | no | |
|
|
7176
7192
|
| cart | [SharedCart](#SharedCart) | no | |
|
|
7193
|
+
| error | string | no | |
|
|
7177
7194
|
|
|
7178
7195
|
---
|
|
7179
7196
|
|
|
@@ -7184,11 +7201,11 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7184
7201
|
|
|
7185
7202
|
| Properties | Type | Nullable | Description |
|
|
7186
7203
|
| ---------- | ---- | -------- | ----------- |
|
|
7187
|
-
| description | string | no | Offer details including T&C |
|
|
7188
7204
|
| offer_text | string | no | Offer title |
|
|
7189
|
-
| valid_till | string | no | Datetime ISOString for promotion end date |
|
|
7190
|
-
| id | string | no | Promotion id |
|
|
7191
7205
|
| promotion_group | string | no | Group of promotion belongs to |
|
|
7206
|
+
| description | string | no | Offer details including T&C |
|
|
7207
|
+
| id | string | no | Promotion id |
|
|
7208
|
+
| valid_till | string | no | Datetime ISOString for promotion end date |
|
|
7192
7209
|
|
|
7193
7210
|
---
|
|
7194
7211
|
|
|
@@ -7210,8 +7227,8 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7210
7227
|
|
|
7211
7228
|
| Properties | Type | Nullable | Description |
|
|
7212
7229
|
| ---------- | ---- | -------- | ----------- |
|
|
7213
|
-
| message | string | no | |
|
|
7214
7230
|
| success | boolean | no | |
|
|
7231
|
+
| message | string | no | |
|
|
7215
7232
|
|
|
7216
7233
|
---
|
|
7217
7234
|
|
|
@@ -7234,10 +7251,10 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7234
7251
|
|
|
7235
7252
|
| Properties | Type | Nullable | Description |
|
|
7236
7253
|
| ---------- | ---- | -------- | ----------- |
|
|
7254
|
+
| offer_price | number | no | Discounted per unit price for current offer object |
|
|
7237
7255
|
| marked | number | no | Original price of product |
|
|
7238
7256
|
| currency_code | string | no | Currency code for all amounts |
|
|
7239
7257
|
| currency_symbol | string | no | Currency symbol for currency |
|
|
7240
|
-
| offer_price | number | no | Discounted per unit price for current offer object |
|
|
7241
7258
|
| effective | number | no | Current per unit price of product after existing deductions |
|
|
7242
7259
|
|
|
7243
7260
|
---
|
|
@@ -7249,11 +7266,11 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7249
7266
|
|
|
7250
7267
|
| Properties | Type | Nullable | Description |
|
|
7251
7268
|
| ---------- | ---- | -------- | ----------- |
|
|
7252
|
-
|
|
|
7269
|
+
| type | string | no | Offer type |
|
|
7253
7270
|
| max_quantity | number | no | Minimum quantity upto which offer is applicable. If not present that offer is applicable on all quantities |
|
|
7254
7271
|
| min_quantity | number | no | Minimum quantity from which offer is applicable |
|
|
7255
7272
|
| price | [LadderPrice](#LadderPrice) | no | |
|
|
7256
|
-
|
|
|
7273
|
+
| margin | number | no | Percentage value of discount |
|
|
7257
7274
|
|
|
7258
7275
|
---
|
|
7259
7276
|
|
|
@@ -7264,12 +7281,12 @@ Success. Returns a object containing the applicable ladder price offers (if exis
|
|
|
7264
7281
|
|
|
7265
7282
|
| Properties | Type | Nullable | Description |
|
|
7266
7283
|
| ---------- | ---- | -------- | ----------- |
|
|
7267
|
-
| description | string | no | Offer details including T&C |
|
|
7268
7284
|
| offer_text | string | no | Offer title |
|
|
7285
|
+
| promotion_group | string | no | Group of promotion belongs to |
|
|
7286
|
+
| description | string | no | Offer details including T&C |
|
|
7287
|
+
| id | string | no | Promotion id |
|
|
7269
7288
|
| valid_till | string | no | Datetime ISOString for promotion end date |
|
|
7270
7289
|
| offer_prices | [[LadderOfferItem](#LadderOfferItem)] | no | |
|
|
7271
|
-
| id | string | no | Promotion id |
|
|
7272
|
-
| promotion_group | string | no | Group of promotion belongs to |
|
|
7273
7290
|
|
|
7274
7291
|
---
|
|
7275
7292
|
|