@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 Platform docs](./README.md)
|
|
6
7
|
|
|
7
8
|
## Cart Methods
|
|
8
9
|
Cart APIs
|
|
10
|
+
|
|
9
11
|
* [getCoupons](#getcoupons)
|
|
10
12
|
* [createCoupon](#createcoupon)
|
|
11
13
|
* [getCouponById](#getcouponbyid)
|
|
@@ -29,6 +31,8 @@ Cart APIs
|
|
|
29
31
|
## Methods with example and description
|
|
30
32
|
|
|
31
33
|
|
|
34
|
+
|
|
35
|
+
|
|
32
36
|
### getCoupons
|
|
33
37
|
Get with single coupon details or coupon list
|
|
34
38
|
|
|
@@ -3989,73 +3993,63 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
3989
3993
|
|
|
3990
3994
|
|
|
3991
3995
|
|
|
3992
|
-
#### [
|
|
3996
|
+
#### [Ownership](#Ownership)
|
|
3993
3997
|
|
|
3994
3998
|
| Properties | Type | Nullable | Description |
|
|
3995
3999
|
| ---------- | ---- | -------- | ----------- |
|
|
3996
|
-
|
|
|
3997
|
-
|
|
|
3998
|
-
| has_previous | boolean | no | True if more records are present for previous pages. Sent for cursor pagination |
|
|
3999
|
-
| next_id | string | no | Cursor id for next set of records. |
|
|
4000
|
-
| item_total | number | no | Total coupon count in system |
|
|
4001
|
-
| size | number | no | Current request page size |
|
|
4002
|
-
| has_next | boolean | no | True if more records are present for next pages |
|
|
4003
|
-
| page | number | no | Page requested |
|
|
4004
|
-
| last_id | string | no | Last objects id |
|
|
4000
|
+
| payable_by | string | yes | |
|
|
4001
|
+
| payable_category | string | yes | |
|
|
4005
4002
|
|
|
4006
4003
|
---
|
|
4007
4004
|
|
|
4008
4005
|
|
|
4009
4006
|
|
|
4010
4007
|
|
|
4011
|
-
#### [
|
|
4008
|
+
#### [Validity](#Validity)
|
|
4012
4009
|
|
|
4013
4010
|
| Properties | Type | Nullable | Description |
|
|
4014
4011
|
| ---------- | ---- | -------- | ----------- |
|
|
4015
|
-
|
|
|
4016
|
-
| store_id | [number] | no | |
|
|
4017
|
-
| collection_id | [string] | no | |
|
|
4018
|
-
| user_id | [string] | no | |
|
|
4019
|
-
| category_id | [number] | no | |
|
|
4020
|
-
| company_id | [number] | no | |
|
|
4021
|
-
| article_id | [string] | no | |
|
|
4022
|
-
| item_id | [number] | no | |
|
|
4023
|
-
| brand_id | [number] | no | |
|
|
4012
|
+
| priority | number | no | |
|
|
4024
4013
|
|
|
4025
4014
|
---
|
|
4026
4015
|
|
|
4027
4016
|
|
|
4028
4017
|
|
|
4029
4018
|
|
|
4030
|
-
#### [
|
|
4019
|
+
#### [DisplayMetaDict](#DisplayMetaDict)
|
|
4031
4020
|
|
|
4032
4021
|
| Properties | Type | Nullable | Description |
|
|
4033
4022
|
| ---------- | ---- | -------- | ----------- |
|
|
4034
|
-
|
|
|
4023
|
+
| title | string | no | |
|
|
4024
|
+
| subtitle | string | no | |
|
|
4035
4025
|
|
|
4036
4026
|
---
|
|
4037
4027
|
|
|
4038
4028
|
|
|
4039
4029
|
|
|
4040
4030
|
|
|
4041
|
-
#### [
|
|
4031
|
+
#### [DisplayMeta](#DisplayMeta)
|
|
4042
4032
|
|
|
4043
4033
|
| Properties | Type | Nullable | Description |
|
|
4044
4034
|
| ---------- | ---- | -------- | ----------- |
|
|
4045
|
-
|
|
|
4046
|
-
|
|
|
4035
|
+
| remove | [DisplayMetaDict](#DisplayMetaDict) | no | |
|
|
4036
|
+
| subtitle | string | no | |
|
|
4037
|
+
| description | string | no | |
|
|
4038
|
+
| apply | [DisplayMetaDict](#DisplayMetaDict) | no | |
|
|
4039
|
+
| title | string | no | |
|
|
4040
|
+
| auto | [DisplayMetaDict](#DisplayMetaDict) | no | |
|
|
4047
4041
|
|
|
4048
4042
|
---
|
|
4049
4043
|
|
|
4050
4044
|
|
|
4051
4045
|
|
|
4052
4046
|
|
|
4053
|
-
#### [
|
|
4047
|
+
#### [CouponDateMeta](#CouponDateMeta)
|
|
4054
4048
|
|
|
4055
4049
|
| Properties | Type | Nullable | Description |
|
|
4056
4050
|
| ---------- | ---- | -------- | ----------- |
|
|
4057
|
-
|
|
|
4058
|
-
|
|
|
4051
|
+
| created_on | string | no | |
|
|
4052
|
+
| modified_on | string | no | |
|
|
4059
4053
|
|
|
4060
4054
|
---
|
|
4061
4055
|
|
|
@@ -4066,8 +4060,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4066
4060
|
|
|
4067
4061
|
| Properties | Type | Nullable | Description |
|
|
4068
4062
|
| ---------- | ---- | -------- | ----------- |
|
|
4069
|
-
| anonymous | boolean | no | |
|
|
4070
4063
|
| app_id | [string] | no | |
|
|
4064
|
+
| anonymous | boolean | no | |
|
|
4071
4065
|
| user_registered_after | string | no | |
|
|
4072
4066
|
|
|
4073
4067
|
---
|
|
@@ -4075,132 +4069,122 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4075
4069
|
|
|
4076
4070
|
|
|
4077
4071
|
|
|
4078
|
-
#### [
|
|
4079
|
-
|
|
4080
|
-
| Properties | Type | Nullable | Description |
|
|
4081
|
-
| ---------- | ---- | -------- | ----------- |
|
|
4082
|
-
| multi_store_allowed | boolean | yes | |
|
|
4083
|
-
|
|
4084
|
-
---
|
|
4085
|
-
|
|
4086
|
-
|
|
4087
|
-
|
|
4088
|
-
|
|
4089
|
-
#### [PostOrder](#PostOrder)
|
|
4072
|
+
#### [RuleDefinition](#RuleDefinition)
|
|
4090
4073
|
|
|
4091
4074
|
| Properties | Type | Nullable | Description |
|
|
4092
4075
|
| ---------- | ---- | -------- | ----------- |
|
|
4093
|
-
|
|
|
4094
|
-
|
|
|
4076
|
+
| is_exact | boolean | no | |
|
|
4077
|
+
| auto_apply | boolean | no | |
|
|
4078
|
+
| value_type | string | yes | |
|
|
4079
|
+
| scope | [string] | no | |
|
|
4080
|
+
| currency_code | string | no | |
|
|
4081
|
+
| calculate_on | string | yes | |
|
|
4082
|
+
| applicable_on | string | yes | |
|
|
4083
|
+
| type | string | yes | |
|
|
4095
4084
|
|
|
4096
4085
|
---
|
|
4097
4086
|
|
|
4098
4087
|
|
|
4099
4088
|
|
|
4100
4089
|
|
|
4101
|
-
#### [
|
|
4090
|
+
#### [PriceRange](#PriceRange)
|
|
4102
4091
|
|
|
4103
4092
|
| Properties | Type | Nullable | Description |
|
|
4104
4093
|
| ---------- | ---- | -------- | ----------- |
|
|
4105
|
-
|
|
|
4106
|
-
|
|
|
4107
|
-
| user | number | no | |
|
|
4094
|
+
| max | number | no | |
|
|
4095
|
+
| min | number | no | |
|
|
4108
4096
|
|
|
4109
4097
|
---
|
|
4110
4098
|
|
|
4111
4099
|
|
|
4112
4100
|
|
|
4113
4101
|
|
|
4114
|
-
#### [
|
|
4102
|
+
#### [PaymentAllowValue](#PaymentAllowValue)
|
|
4115
4103
|
|
|
4116
4104
|
| Properties | Type | Nullable | Description |
|
|
4117
4105
|
| ---------- | ---- | -------- | ----------- |
|
|
4118
|
-
|
|
|
4119
|
-
| remaining | [UsesRemaining](#UsesRemaining) | no | |
|
|
4106
|
+
| max | number | no | |
|
|
4120
4107
|
|
|
4121
4108
|
---
|
|
4122
4109
|
|
|
4123
4110
|
|
|
4124
4111
|
|
|
4125
4112
|
|
|
4126
|
-
#### [
|
|
4113
|
+
#### [PaymentModes](#PaymentModes)
|
|
4127
4114
|
|
|
4128
4115
|
| Properties | Type | Nullable | Description |
|
|
4129
4116
|
| ---------- | ---- | -------- | ----------- |
|
|
4130
|
-
|
|
|
4131
|
-
|
|
|
4117
|
+
| codes | [string] | no | |
|
|
4118
|
+
| uses | [PaymentAllowValue](#PaymentAllowValue) | no | |
|
|
4119
|
+
| types | [string] | no | |
|
|
4120
|
+
| networks | [string] | no | |
|
|
4132
4121
|
|
|
4133
4122
|
---
|
|
4134
4123
|
|
|
4135
4124
|
|
|
4136
4125
|
|
|
4137
4126
|
|
|
4138
|
-
#### [
|
|
4127
|
+
#### [PostOrder](#PostOrder)
|
|
4139
4128
|
|
|
4140
4129
|
| Properties | Type | Nullable | Description |
|
|
4141
4130
|
| ---------- | ---- | -------- | ----------- |
|
|
4142
|
-
|
|
|
4131
|
+
| return_allowed | boolean | no | |
|
|
4132
|
+
| cancellation_allowed | boolean | no | |
|
|
4143
4133
|
|
|
4144
4134
|
---
|
|
4145
4135
|
|
|
4146
4136
|
|
|
4147
4137
|
|
|
4148
4138
|
|
|
4149
|
-
#### [
|
|
4139
|
+
#### [UsesRemaining](#UsesRemaining)
|
|
4150
4140
|
|
|
4151
4141
|
| Properties | Type | Nullable | Description |
|
|
4152
4142
|
| ---------- | ---- | -------- | ----------- |
|
|
4153
|
-
|
|
|
4154
|
-
|
|
|
4155
|
-
|
|
|
4156
|
-
| types | [string] | no | |
|
|
4143
|
+
| total | number | no | |
|
|
4144
|
+
| app | number | no | |
|
|
4145
|
+
| user | number | no | |
|
|
4157
4146
|
|
|
4158
4147
|
---
|
|
4159
4148
|
|
|
4160
4149
|
|
|
4161
4150
|
|
|
4162
4151
|
|
|
4163
|
-
#### [
|
|
4152
|
+
#### [UsesRestriction](#UsesRestriction)
|
|
4164
4153
|
|
|
4165
4154
|
| Properties | Type | Nullable | Description |
|
|
4166
4155
|
| ---------- | ---- | -------- | ----------- |
|
|
4167
|
-
|
|
|
4168
|
-
|
|
|
4169
|
-
| post_order | [PostOrder](#PostOrder) | no | |
|
|
4170
|
-
| uses | [UsesRestriction](#UsesRestriction) | no | |
|
|
4171
|
-
| coupon_allowed | boolean | no | |
|
|
4172
|
-
| platforms | [string] | no | |
|
|
4173
|
-
| price_range | [PriceRange](#PriceRange) | no | |
|
|
4174
|
-
| payments | [String: [PaymentModes](#PaymentModes)] | no | |
|
|
4175
|
-
| ordering_stores | [number] | no | |
|
|
4156
|
+
| remaining | [UsesRemaining](#UsesRemaining) | no | |
|
|
4157
|
+
| maximum | [UsesRemaining](#UsesRemaining) | no | |
|
|
4176
4158
|
|
|
4177
4159
|
---
|
|
4178
4160
|
|
|
4179
4161
|
|
|
4180
4162
|
|
|
4181
4163
|
|
|
4182
|
-
#### [
|
|
4164
|
+
#### [BulkBundleRestriction](#BulkBundleRestriction)
|
|
4183
4165
|
|
|
4184
4166
|
| Properties | Type | Nullable | Description |
|
|
4185
4167
|
| ---------- | ---- | -------- | ----------- |
|
|
4186
|
-
|
|
|
4187
|
-
| subtitle | string | no | |
|
|
4168
|
+
| multi_store_allowed | boolean | yes | |
|
|
4188
4169
|
|
|
4189
4170
|
---
|
|
4190
4171
|
|
|
4191
4172
|
|
|
4192
4173
|
|
|
4193
4174
|
|
|
4194
|
-
#### [
|
|
4175
|
+
#### [Restrictions](#Restrictions)
|
|
4195
4176
|
|
|
4196
4177
|
| Properties | Type | Nullable | Description |
|
|
4197
4178
|
| ---------- | ---- | -------- | ----------- |
|
|
4198
|
-
|
|
|
4199
|
-
|
|
|
4200
|
-
|
|
|
4201
|
-
|
|
|
4202
|
-
|
|
|
4203
|
-
|
|
|
4179
|
+
| price_range | [PriceRange](#PriceRange) | no | |
|
|
4180
|
+
| payments | [String: [PaymentModes](#PaymentModes)] | no | |
|
|
4181
|
+
| ordering_stores | [number] | no | |
|
|
4182
|
+
| post_order | [PostOrder](#PostOrder) | no | |
|
|
4183
|
+
| user_groups | [number] | no | |
|
|
4184
|
+
| coupon_allowed | boolean | no | |
|
|
4185
|
+
| uses | [UsesRestriction](#UsesRestriction) | no | |
|
|
4186
|
+
| platforms | [string] | no | |
|
|
4187
|
+
| bulk_bundle | [BulkBundleRestriction](#BulkBundleRestriction) | no | |
|
|
4204
4188
|
|
|
4205
4189
|
---
|
|
4206
4190
|
|
|
@@ -4212,80 +4196,81 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4212
4196
|
| Properties | Type | Nullable | Description |
|
|
4213
4197
|
| ---------- | ---- | -------- | ----------- |
|
|
4214
4198
|
| is_display | boolean | no | |
|
|
4215
|
-
| is_public | boolean | no | |
|
|
4216
4199
|
| is_archived | boolean | no | |
|
|
4200
|
+
| is_public | boolean | no | |
|
|
4217
4201
|
|
|
4218
4202
|
---
|
|
4219
4203
|
|
|
4220
4204
|
|
|
4221
4205
|
|
|
4222
4206
|
|
|
4223
|
-
#### [
|
|
4207
|
+
#### [CouponAction](#CouponAction)
|
|
4224
4208
|
|
|
4225
4209
|
| Properties | Type | Nullable | Description |
|
|
4226
4210
|
| ---------- | ---- | -------- | ----------- |
|
|
4227
|
-
|
|
|
4228
|
-
|
|
|
4229
|
-
| discount_qty | number | no | |
|
|
4230
|
-
| min | number | no | |
|
|
4231
|
-
| key | number | no | |
|
|
4211
|
+
| txn_mode | string | no | |
|
|
4212
|
+
| action_date | string | no | |
|
|
4232
4213
|
|
|
4233
4214
|
---
|
|
4234
4215
|
|
|
4235
4216
|
|
|
4236
4217
|
|
|
4237
4218
|
|
|
4238
|
-
#### [
|
|
4219
|
+
#### [CouponSchedule](#CouponSchedule)
|
|
4239
4220
|
|
|
4240
4221
|
| Properties | Type | Nullable | Description |
|
|
4241
4222
|
| ---------- | ---- | -------- | ----------- |
|
|
4242
|
-
|
|
|
4243
|
-
|
|
|
4223
|
+
| duration | number | no | |
|
|
4224
|
+
| cron | string | no | |
|
|
4225
|
+
| end | string | no | |
|
|
4226
|
+
| next_schedule | [string] | no | |
|
|
4227
|
+
| start | string | no | |
|
|
4244
4228
|
|
|
4245
4229
|
---
|
|
4246
4230
|
|
|
4247
4231
|
|
|
4248
4232
|
|
|
4249
4233
|
|
|
4250
|
-
#### [
|
|
4234
|
+
#### [CouponAuthor](#CouponAuthor)
|
|
4251
4235
|
|
|
4252
4236
|
| Properties | Type | Nullable | Description |
|
|
4253
4237
|
| ---------- | ---- | -------- | ----------- |
|
|
4254
|
-
|
|
|
4255
|
-
|
|
|
4238
|
+
| modified_by | string | no | |
|
|
4239
|
+
| created_by | string | no | |
|
|
4256
4240
|
|
|
4257
4241
|
---
|
|
4258
4242
|
|
|
4259
4243
|
|
|
4260
4244
|
|
|
4261
4245
|
|
|
4262
|
-
#### [
|
|
4246
|
+
#### [Identifier](#Identifier)
|
|
4263
4247
|
|
|
4264
4248
|
| Properties | Type | Nullable | Description |
|
|
4265
4249
|
| ---------- | ---- | -------- | ----------- |
|
|
4266
|
-
|
|
|
4267
|
-
|
|
|
4268
|
-
|
|
|
4269
|
-
|
|
|
4270
|
-
|
|
|
4271
|
-
|
|
|
4272
|
-
|
|
|
4273
|
-
|
|
|
4250
|
+
| article_id | [string] | no | |
|
|
4251
|
+
| category_id | [number] | no | |
|
|
4252
|
+
| collection_id | [string] | no | |
|
|
4253
|
+
| company_id | [number] | no | |
|
|
4254
|
+
| user_id | [string] | no | |
|
|
4255
|
+
| item_id | [number] | no | |
|
|
4256
|
+
| exclude_brand_id | [number] | no | |
|
|
4257
|
+
| store_id | [number] | no | |
|
|
4258
|
+
| brand_id | [number] | no | |
|
|
4274
4259
|
|
|
4275
4260
|
---
|
|
4276
4261
|
|
|
4277
4262
|
|
|
4278
4263
|
|
|
4279
4264
|
|
|
4280
|
-
#### [
|
|
4265
|
+
#### [Rule](#Rule)
|
|
4281
4266
|
|
|
4282
4267
|
| Properties | Type | Nullable | Description |
|
|
4283
4268
|
| ---------- | ---- | -------- | ----------- |
|
|
4284
|
-
|
|
|
4285
|
-
|
|
|
4286
|
-
|
|
|
4287
|
-
|
|
|
4288
|
-
|
|
|
4269
|
+
| max | number | no | |
|
|
4270
|
+
| discount_qty | number | no | |
|
|
4271
|
+
| value | number | no | |
|
|
4272
|
+
| min | number | no | |
|
|
4273
|
+
| key | number | no | |
|
|
4289
4274
|
|
|
4290
4275
|
---
|
|
4291
4276
|
|
|
@@ -4296,22 +4281,41 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4296
4281
|
|
|
4297
4282
|
| Properties | Type | Nullable | Description |
|
|
4298
4283
|
| ---------- | ---- | -------- | ----------- |
|
|
4299
|
-
|
|
|
4300
|
-
| identifiers | [Identifier](#Identifier) | yes | |
|
|
4284
|
+
| ownership | [Ownership](#Ownership) | yes | |
|
|
4301
4285
|
| validity | [Validity](#Validity) | yes | |
|
|
4286
|
+
| display_meta | [DisplayMeta](#DisplayMeta) | yes | |
|
|
4302
4287
|
| date_meta | [CouponDateMeta](#CouponDateMeta) | no | |
|
|
4303
|
-
| code | string | yes | |
|
|
4304
|
-
| ownership | [Ownership](#Ownership) | yes | |
|
|
4305
4288
|
| validation | [Validation](#Validation) | no | |
|
|
4289
|
+
| rule_definition | [RuleDefinition](#RuleDefinition) | yes | |
|
|
4290
|
+
| type_slug | string | yes | |
|
|
4306
4291
|
| restrictions | [Restrictions](#Restrictions) | no | |
|
|
4307
|
-
| display_meta | [DisplayMeta](#DisplayMeta) | yes | |
|
|
4308
4292
|
| state | [State](#State) | no | |
|
|
4309
|
-
| tags | [string] | no | |
|
|
4310
|
-
| rule | [[Rule](#Rule)] | yes | |
|
|
4311
|
-
| author | [CouponAuthor](#CouponAuthor) | no | |
|
|
4312
4293
|
| action | [CouponAction](#CouponAction) | no | |
|
|
4313
|
-
| rule_definition | [RuleDefinition](#RuleDefinition) | yes | |
|
|
4314
4294
|
| _schedule | [CouponSchedule](#CouponSchedule) | no | |
|
|
4295
|
+
| author | [CouponAuthor](#CouponAuthor) | no | |
|
|
4296
|
+
| tags | [string] | no | |
|
|
4297
|
+
| identifiers | [Identifier](#Identifier) | yes | |
|
|
4298
|
+
| rule | [[Rule](#Rule)] | yes | |
|
|
4299
|
+
| code | string | yes | |
|
|
4300
|
+
|
|
4301
|
+
---
|
|
4302
|
+
|
|
4303
|
+
|
|
4304
|
+
|
|
4305
|
+
|
|
4306
|
+
#### [Page](#Page)
|
|
4307
|
+
|
|
4308
|
+
| Properties | Type | Nullable | Description |
|
|
4309
|
+
| ---------- | ---- | -------- | ----------- |
|
|
4310
|
+
| current | number | no | Current page no |
|
|
4311
|
+
| last_id | string | no | Last objects id |
|
|
4312
|
+
| has_previous | boolean | no | True if more records are present for previous pages. Sent for cursor pagination |
|
|
4313
|
+
| size | number | no | Current request page size |
|
|
4314
|
+
| has_next | boolean | no | True if more records are present for next pages |
|
|
4315
|
+
| next_id | string | no | Cursor id for next set of records. |
|
|
4316
|
+
| item_total | number | no | Total coupon count in system |
|
|
4317
|
+
| type | string | yes | |
|
|
4318
|
+
| page | number | no | Page requested |
|
|
4315
4319
|
|
|
4316
4320
|
---
|
|
4317
4321
|
|
|
@@ -4322,8 +4326,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4322
4326
|
|
|
4323
4327
|
| Properties | Type | Nullable | Description |
|
|
4324
4328
|
| ---------- | ---- | -------- | ----------- |
|
|
4325
|
-
| page | [Page](#Page) | no | |
|
|
4326
4329
|
| items | [CouponAdd](#CouponAdd) | no | |
|
|
4330
|
+
| page | [Page](#Page) | no | |
|
|
4327
4331
|
|
|
4328
4332
|
---
|
|
4329
4333
|
|
|
@@ -4358,34 +4362,34 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4358
4362
|
|
|
4359
4363
|
| Properties | Type | Nullable | Description |
|
|
4360
4364
|
| ---------- | ---- | -------- | ----------- |
|
|
4361
|
-
|
|
|
4362
|
-
| identifiers | [Identifier](#Identifier) | yes | |
|
|
4365
|
+
| ownership | [Ownership](#Ownership) | yes | |
|
|
4363
4366
|
| validity | [Validity](#Validity) | yes | |
|
|
4367
|
+
| display_meta | [DisplayMeta](#DisplayMeta) | yes | |
|
|
4364
4368
|
| date_meta | [CouponDateMeta](#CouponDateMeta) | no | |
|
|
4365
|
-
| code | string | yes | |
|
|
4366
|
-
| ownership | [Ownership](#Ownership) | yes | |
|
|
4367
4369
|
| validation | [Validation](#Validation) | no | |
|
|
4370
|
+
| rule_definition | [RuleDefinition](#RuleDefinition) | yes | |
|
|
4371
|
+
| type_slug | string | yes | |
|
|
4368
4372
|
| restrictions | [Restrictions](#Restrictions) | no | |
|
|
4369
|
-
| display_meta | [DisplayMeta](#DisplayMeta) | yes | |
|
|
4370
4373
|
| state | [State](#State) | no | |
|
|
4371
|
-
| tags | [string] | no | |
|
|
4372
|
-
| rule | [[Rule](#Rule)] | yes | |
|
|
4373
|
-
| author | [CouponAuthor](#CouponAuthor) | no | |
|
|
4374
4374
|
| action | [CouponAction](#CouponAction) | no | |
|
|
4375
|
-
| rule_definition | [RuleDefinition](#RuleDefinition) | yes | |
|
|
4376
4375
|
| _schedule | [CouponSchedule](#CouponSchedule) | no | |
|
|
4376
|
+
| author | [CouponAuthor](#CouponAuthor) | no | |
|
|
4377
|
+
| tags | [string] | no | |
|
|
4378
|
+
| identifiers | [Identifier](#Identifier) | yes | |
|
|
4379
|
+
| rule | [[Rule](#Rule)] | yes | |
|
|
4380
|
+
| code | string | yes | |
|
|
4381
|
+
|
|
4382
|
+
---
|
|
4383
|
+
|
|
4377
4384
|
|
|
4378
|
-
---
|
|
4379
|
-
|
|
4380
|
-
|
|
4381
4385
|
|
|
4382
4386
|
|
|
4383
4387
|
#### [CouponPartialUpdate](#CouponPartialUpdate)
|
|
4384
4388
|
|
|
4385
4389
|
| Properties | Type | Nullable | Description |
|
|
4386
4390
|
| ---------- | ---- | -------- | ----------- |
|
|
4387
|
-
| archive | boolean | no | Send true to unpublish coupon |
|
|
4388
4391
|
| schedule | [CouponSchedule](#CouponSchedule) | no | |
|
|
4392
|
+
| archive | boolean | no | Send true to unpublish coupon |
|
|
4389
4393
|
|
|
4390
4394
|
---
|
|
4391
4395
|
|
|
@@ -4396,248 +4400,248 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4396
4400
|
|
|
4397
4401
|
| Properties | Type | Nullable | Description |
|
|
4398
4402
|
| ---------- | ---- | -------- | ----------- |
|
|
4399
|
-
| modified_on | string | no | |
|
|
4400
4403
|
| created_on | string | no | |
|
|
4404
|
+
| modified_on | string | no | |
|
|
4401
4405
|
|
|
4402
4406
|
---
|
|
4403
4407
|
|
|
4404
4408
|
|
|
4405
4409
|
|
|
4406
4410
|
|
|
4407
|
-
#### [
|
|
4411
|
+
#### [PaymentAllowValue1](#PaymentAllowValue1)
|
|
4408
4412
|
|
|
4409
4413
|
| Properties | Type | Nullable | Description |
|
|
4410
4414
|
| ---------- | ---- | -------- | ----------- |
|
|
4411
|
-
|
|
|
4412
|
-
| pdp | boolean | yes | |
|
|
4415
|
+
| max | number | no | |
|
|
4413
4416
|
|
|
4414
4417
|
---
|
|
4415
4418
|
|
|
4416
4419
|
|
|
4417
4420
|
|
|
4418
4421
|
|
|
4419
|
-
#### [
|
|
4422
|
+
#### [PromotionPaymentModes](#PromotionPaymentModes)
|
|
4420
4423
|
|
|
4421
4424
|
| Properties | Type | Nullable | Description |
|
|
4422
4425
|
| ---------- | ---- | -------- | ----------- |
|
|
4423
|
-
|
|
|
4424
|
-
|
|
|
4425
|
-
|
|
|
4426
|
-
| min_offer_quantity | number | no | |
|
|
4427
|
-
| max_offer_quantity | number | no | |
|
|
4428
|
-
| discount_amount | number | no | |
|
|
4429
|
-
| discount_percentage | number | no | |
|
|
4426
|
+
| codes | [string] | no | |
|
|
4427
|
+
| uses | [PaymentAllowValue1](#PaymentAllowValue1) | no | |
|
|
4428
|
+
| type | string | yes | |
|
|
4430
4429
|
|
|
4431
4430
|
---
|
|
4432
4431
|
|
|
4433
4432
|
|
|
4434
4433
|
|
|
4435
4434
|
|
|
4436
|
-
#### [
|
|
4435
|
+
#### [PostOrder1](#PostOrder1)
|
|
4437
4436
|
|
|
4438
4437
|
| Properties | Type | Nullable | Description |
|
|
4439
4438
|
| ---------- | ---- | -------- | ----------- |
|
|
4440
|
-
|
|
|
4441
|
-
|
|
|
4442
|
-
| equals | number | no | |
|
|
4443
|
-
| greater_than | number | no | |
|
|
4444
|
-
| greater_than_equals | number | no | |
|
|
4439
|
+
| return_allowed | boolean | no | |
|
|
4440
|
+
| cancellation_allowed | boolean | no | |
|
|
4445
4441
|
|
|
4446
4442
|
---
|
|
4447
4443
|
|
|
4448
4444
|
|
|
4449
4445
|
|
|
4450
4446
|
|
|
4451
|
-
#### [
|
|
4447
|
+
#### [UsesRemaining1](#UsesRemaining1)
|
|
4452
4448
|
|
|
4453
4449
|
| Properties | Type | Nullable | Description |
|
|
4454
4450
|
| ---------- | ---- | -------- | ----------- |
|
|
4455
|
-
|
|
|
4456
|
-
|
|
|
4457
|
-
| item_sku | [string] | no | |
|
|
4458
|
-
| item_exclude_brand | [number] | no | |
|
|
4459
|
-
| item_brand | [number] | no | |
|
|
4460
|
-
| item_company | [number] | no | |
|
|
4461
|
-
| item_exclude_store | [number] | no | |
|
|
4462
|
-
| item_exclude_sku | [string] | no | |
|
|
4463
|
-
| item_exclude_category | [number] | no | |
|
|
4464
|
-
| buy_rules | [string] | no | |
|
|
4465
|
-
| cart_quantity | [CompareObject](#CompareObject) | no | |
|
|
4466
|
-
| item_store | [number] | no | |
|
|
4467
|
-
| cart_total | [CompareObject](#CompareObject) | no | |
|
|
4468
|
-
| item_size | [string] | no | |
|
|
4469
|
-
| item_id | [number] | no | |
|
|
4470
|
-
| item_category | [number] | no | |
|
|
4451
|
+
| total | number | no | |
|
|
4452
|
+
| user | number | no | |
|
|
4471
4453
|
|
|
4472
4454
|
---
|
|
4473
4455
|
|
|
4474
4456
|
|
|
4475
4457
|
|
|
4476
4458
|
|
|
4477
|
-
#### [
|
|
4459
|
+
#### [UsesRestriction1](#UsesRestriction1)
|
|
4478
4460
|
|
|
4479
4461
|
| Properties | Type | Nullable | Description |
|
|
4480
4462
|
| ---------- | ---- | -------- | ----------- |
|
|
4481
|
-
|
|
|
4482
|
-
|
|
|
4483
|
-
| item_criteria | [ItemCriteria](#ItemCriteria) | yes | |
|
|
4484
|
-
| buy_condition | string | yes | |
|
|
4463
|
+
| remaining | [UsesRemaining1](#UsesRemaining1) | no | |
|
|
4464
|
+
| maximum | [UsesRemaining1](#UsesRemaining1) | no | |
|
|
4485
4465
|
|
|
4486
4466
|
---
|
|
4487
4467
|
|
|
4488
4468
|
|
|
4489
4469
|
|
|
4490
4470
|
|
|
4491
|
-
#### [
|
|
4471
|
+
#### [UserRegistered](#UserRegistered)
|
|
4492
4472
|
|
|
4493
4473
|
| Properties | Type | Nullable | Description |
|
|
4494
4474
|
| ---------- | ---- | -------- | ----------- |
|
|
4495
|
-
|
|
|
4496
|
-
|
|
|
4475
|
+
| start | string | no | |
|
|
4476
|
+
| end | string | no | |
|
|
4497
4477
|
|
|
4498
4478
|
---
|
|
4499
4479
|
|
|
4500
4480
|
|
|
4501
4481
|
|
|
4502
4482
|
|
|
4503
|
-
#### [
|
|
4483
|
+
#### [Restrictions1](#Restrictions1)
|
|
4504
4484
|
|
|
4505
4485
|
| Properties | Type | Nullable | Description |
|
|
4506
4486
|
| ---------- | ---- | -------- | ----------- |
|
|
4507
|
-
|
|
|
4508
|
-
|
|
|
4487
|
+
| order_quantity | number | no | |
|
|
4488
|
+
| payments | [[PromotionPaymentModes](#PromotionPaymentModes)] | no | |
|
|
4489
|
+
| post_order | [PostOrder1](#PostOrder1) | no | |
|
|
4490
|
+
| user_groups | [number] | no | |
|
|
4491
|
+
| anonymous_users | boolean | no | |
|
|
4492
|
+
| uses | [UsesRestriction1](#UsesRestriction1) | yes | |
|
|
4493
|
+
| platforms | [string] | no | |
|
|
4494
|
+
| user_id | [string] | no | |
|
|
4495
|
+
| user_registered | [UserRegistered](#UserRegistered) | no | |
|
|
4509
4496
|
|
|
4510
4497
|
---
|
|
4511
4498
|
|
|
4512
4499
|
|
|
4513
4500
|
|
|
4514
4501
|
|
|
4515
|
-
#### [
|
|
4502
|
+
#### [PromotionAction](#PromotionAction)
|
|
4516
4503
|
|
|
4517
4504
|
| Properties | Type | Nullable | Description |
|
|
4518
4505
|
| ---------- | ---- | -------- | ----------- |
|
|
4519
|
-
|
|
|
4520
|
-
|
|
|
4506
|
+
| action_type | string | yes | |
|
|
4507
|
+
| action_date | string | yes | |
|
|
4521
4508
|
|
|
4522
4509
|
---
|
|
4523
4510
|
|
|
4524
4511
|
|
|
4525
4512
|
|
|
4526
4513
|
|
|
4527
|
-
#### [
|
|
4514
|
+
#### [CompareObject](#CompareObject)
|
|
4528
4515
|
|
|
4529
4516
|
| Properties | Type | Nullable | Description |
|
|
4530
4517
|
| ---------- | ---- | -------- | ----------- |
|
|
4531
|
-
|
|
|
4532
|
-
|
|
|
4518
|
+
| greater_than | number | no | |
|
|
4519
|
+
| less_than | number | no | |
|
|
4520
|
+
| equals | number | no | |
|
|
4521
|
+
| less_than_equals | number | no | |
|
|
4522
|
+
| greater_than_equals | number | no | |
|
|
4533
4523
|
|
|
4534
4524
|
---
|
|
4535
4525
|
|
|
4536
4526
|
|
|
4537
4527
|
|
|
4538
4528
|
|
|
4539
|
-
#### [
|
|
4529
|
+
#### [ItemCriteria](#ItemCriteria)
|
|
4540
4530
|
|
|
4541
4531
|
| Properties | Type | Nullable | Description |
|
|
4542
4532
|
| ---------- | ---- | -------- | ----------- |
|
|
4543
|
-
|
|
|
4533
|
+
| item_sku | [string] | no | |
|
|
4534
|
+
| item_exclude_brand | [number] | no | |
|
|
4535
|
+
| item_exclude_company | [number] | no | |
|
|
4536
|
+
| buy_rules | [string] | no | |
|
|
4537
|
+
| item_exclude_store | [number] | no | |
|
|
4538
|
+
| item_brand | [number] | no | |
|
|
4539
|
+
| item_size | [string] | no | |
|
|
4540
|
+
| cart_quantity | [CompareObject](#CompareObject) | no | |
|
|
4541
|
+
| item_id | [number] | no | |
|
|
4542
|
+
| all_items | boolean | no | |
|
|
4543
|
+
| item_company | [number] | no | |
|
|
4544
|
+
| item_exclude_sku | [string] | no | |
|
|
4545
|
+
| cart_total | [CompareObject](#CompareObject) | no | |
|
|
4546
|
+
| item_store | [number] | no | |
|
|
4547
|
+
| item_category | [number] | no | |
|
|
4548
|
+
| item_exclude_category | [number] | no | |
|
|
4544
4549
|
|
|
4545
4550
|
---
|
|
4546
4551
|
|
|
4547
4552
|
|
|
4548
4553
|
|
|
4549
4554
|
|
|
4550
|
-
#### [
|
|
4555
|
+
#### [DiscountOffer](#DiscountOffer)
|
|
4551
4556
|
|
|
4552
4557
|
| Properties | Type | Nullable | Description |
|
|
4553
4558
|
| ---------- | ---- | -------- | ----------- |
|
|
4554
|
-
|
|
|
4555
|
-
|
|
|
4556
|
-
|
|
|
4559
|
+
| discount_price | number | no | |
|
|
4560
|
+
| discount_percentage | number | no | |
|
|
4561
|
+
| max_discount_amount | number | no | |
|
|
4562
|
+
| max_offer_quantity | number | no | |
|
|
4563
|
+
| discount_amount | number | no | |
|
|
4564
|
+
| min_offer_quantity | number | no | |
|
|
4565
|
+
| code | string | no | |
|
|
4557
4566
|
|
|
4558
4567
|
---
|
|
4559
4568
|
|
|
4560
4569
|
|
|
4561
4570
|
|
|
4562
4571
|
|
|
4563
|
-
#### [
|
|
4572
|
+
#### [DiscountRule](#DiscountRule)
|
|
4564
4573
|
|
|
4565
4574
|
| Properties | Type | Nullable | Description |
|
|
4566
4575
|
| ---------- | ---- | -------- | ----------- |
|
|
4567
|
-
|
|
|
4568
|
-
|
|
|
4569
|
-
|
|
|
4570
|
-
|
|
|
4571
|
-
| uses | [UsesRestriction1](#UsesRestriction1) | yes | |
|
|
4572
|
-
| order_quantity | number | no | |
|
|
4573
|
-
| platforms | [string] | no | |
|
|
4574
|
-
| user_registered | [UserRegistered](#UserRegistered) | no | |
|
|
4575
|
-
| payments | [[PromotionPaymentModes](#PromotionPaymentModes)] | no | |
|
|
4576
|
+
| buy_condition | string | yes | |
|
|
4577
|
+
| item_criteria | [ItemCriteria](#ItemCriteria) | yes | |
|
|
4578
|
+
| offer | [DiscountOffer](#DiscountOffer) | yes | |
|
|
4579
|
+
| discount_type | string | yes | |
|
|
4576
4580
|
|
|
4577
4581
|
---
|
|
4578
4582
|
|
|
4579
4583
|
|
|
4580
4584
|
|
|
4581
4585
|
|
|
4582
|
-
#### [
|
|
4586
|
+
#### [DisplayMeta1](#DisplayMeta1)
|
|
4583
4587
|
|
|
4584
4588
|
| Properties | Type | Nullable | Description |
|
|
4585
4589
|
| ---------- | ---- | -------- | ----------- |
|
|
4586
|
-
|
|
|
4587
|
-
|
|
|
4590
|
+
| name | string | no | |
|
|
4591
|
+
| offer_text | string | no | |
|
|
4592
|
+
| description | string | no | |
|
|
4588
4593
|
|
|
4589
4594
|
---
|
|
4590
4595
|
|
|
4591
4596
|
|
|
4592
4597
|
|
|
4593
4598
|
|
|
4594
|
-
#### [
|
|
4599
|
+
#### [Ownership1](#Ownership1)
|
|
4595
4600
|
|
|
4596
4601
|
| Properties | Type | Nullable | Description |
|
|
4597
4602
|
| ---------- | ---- | -------- | ----------- |
|
|
4598
|
-
|
|
|
4599
|
-
|
|
|
4603
|
+
| payable_by | string | yes | |
|
|
4604
|
+
| payable_category | string | yes | |
|
|
4600
4605
|
|
|
4601
4606
|
---
|
|
4602
4607
|
|
|
4603
4608
|
|
|
4604
4609
|
|
|
4605
4610
|
|
|
4606
|
-
#### [
|
|
4611
|
+
#### [Visibility](#Visibility)
|
|
4607
4612
|
|
|
4608
4613
|
| Properties | Type | Nullable | Description |
|
|
4609
4614
|
| ---------- | ---- | -------- | ----------- |
|
|
4610
|
-
|
|
|
4611
|
-
|
|
|
4615
|
+
| pdp | boolean | yes | |
|
|
4616
|
+
| coupon_list | boolean | yes | |
|
|
4612
4617
|
|
|
4613
4618
|
---
|
|
4614
4619
|
|
|
4615
4620
|
|
|
4616
4621
|
|
|
4617
4622
|
|
|
4618
|
-
#### [
|
|
4623
|
+
#### [PromotionSchedule](#PromotionSchedule)
|
|
4619
4624
|
|
|
4620
4625
|
| Properties | Type | Nullable | Description |
|
|
4621
4626
|
| ---------- | ---- | -------- | ----------- |
|
|
4622
|
-
|
|
|
4623
|
-
|
|
|
4624
|
-
|
|
|
4627
|
+
| duration | number | no | |
|
|
4628
|
+
| cron | string | no | |
|
|
4629
|
+
| end | string | no | |
|
|
4630
|
+
| published | boolean | yes | |
|
|
4631
|
+
| next_schedule | [string] | no | |
|
|
4632
|
+
| start | string | yes | |
|
|
4625
4633
|
|
|
4626
4634
|
---
|
|
4627
4635
|
|
|
4628
4636
|
|
|
4629
4637
|
|
|
4630
4638
|
|
|
4631
|
-
#### [
|
|
4639
|
+
#### [PromotionAuthor](#PromotionAuthor)
|
|
4632
4640
|
|
|
4633
4641
|
| Properties | Type | Nullable | Description |
|
|
4634
4642
|
| ---------- | ---- | -------- | ----------- |
|
|
4635
|
-
|
|
|
4636
|
-
|
|
|
4637
|
-
| published | boolean | yes | |
|
|
4638
|
-
| end | string | no | |
|
|
4639
|
-
| duration | number | no | |
|
|
4640
|
-
| next_schedule | [string] | no | |
|
|
4643
|
+
| modified_by | string | no | |
|
|
4644
|
+
| created_by | string | no | |
|
|
4641
4645
|
|
|
4642
4646
|
---
|
|
4643
4647
|
|
|
@@ -4648,27 +4652,27 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4648
4652
|
|
|
4649
4653
|
| Properties | Type | Nullable | Description |
|
|
4650
4654
|
| ---------- | ---- | -------- | ----------- |
|
|
4655
|
+
| _custom_json | string | no | |
|
|
4651
4656
|
| date_meta | [PromotionDateMeta](#PromotionDateMeta) | no | |
|
|
4652
|
-
|
|
|
4653
|
-
|
|
|
4654
|
-
| mode | string | yes | |
|
|
4655
|
-
| discount_rules | [[DiscountRule](#DiscountRule)] | yes | |
|
|
4657
|
+
| promo_group | string | yes | |
|
|
4658
|
+
| restrictions | [Restrictions1](#Restrictions1) | no | |
|
|
4656
4659
|
| apply_priority | number | no | |
|
|
4657
|
-
| application_id | string | yes | |
|
|
4658
|
-
| apply_all_discount | boolean | no | |
|
|
4659
4660
|
| code | string | no | |
|
|
4660
|
-
|
|
|
4661
|
-
|
|
|
4662
|
-
| buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | |
|
|
4663
|
-
| author | [PromotionAuthor](#PromotionAuthor) | no | |
|
|
4661
|
+
| stackable | boolean | no | |
|
|
4662
|
+
| mode | string | yes | |
|
|
4664
4663
|
| post_order_action | [PromotionAction](#PromotionAction) | no | |
|
|
4664
|
+
| discount_rules | [[DiscountRule](#DiscountRule)] | yes | |
|
|
4665
|
+
| buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | |
|
|
4666
|
+
| display_meta | [DisplayMeta1](#DisplayMeta1) | yes | |
|
|
4667
|
+
| currency | string | no | |
|
|
4665
4668
|
| apply_exclusive | string | no | |
|
|
4666
4669
|
| ownership | [Ownership1](#Ownership1) | yes | |
|
|
4667
|
-
|
|
|
4668
|
-
|
|
|
4669
|
-
|
|
|
4670
|
-
| _custom_json | string | no | |
|
|
4670
|
+
| visiblility | [Visibility](#Visibility) | no | |
|
|
4671
|
+
| apply_all_discount | boolean | no | |
|
|
4672
|
+
| promotion_type | string | yes | |
|
|
4671
4673
|
| _schedule | [PromotionSchedule](#PromotionSchedule) | no | |
|
|
4674
|
+
| application_id | string | yes | |
|
|
4675
|
+
| author | [PromotionAuthor](#PromotionAuthor) | no | |
|
|
4672
4676
|
|
|
4673
4677
|
---
|
|
4674
4678
|
|
|
@@ -4679,8 +4683,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4679
4683
|
|
|
4680
4684
|
| Properties | Type | Nullable | Description |
|
|
4681
4685
|
| ---------- | ---- | -------- | ----------- |
|
|
4682
|
-
| page | [Page](#Page) | no | |
|
|
4683
4686
|
| items | [PromotionListItem](#PromotionListItem) | no | |
|
|
4687
|
+
| page | [Page](#Page) | no | |
|
|
4684
4688
|
|
|
4685
4689
|
---
|
|
4686
4690
|
|
|
@@ -4691,27 +4695,27 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4691
4695
|
|
|
4692
4696
|
| Properties | Type | Nullable | Description |
|
|
4693
4697
|
| ---------- | ---- | -------- | ----------- |
|
|
4698
|
+
| _custom_json | string | no | |
|
|
4694
4699
|
| date_meta | [PromotionDateMeta](#PromotionDateMeta) | no | |
|
|
4695
|
-
|
|
|
4696
|
-
|
|
|
4697
|
-
| mode | string | yes | |
|
|
4698
|
-
| discount_rules | [[DiscountRule](#DiscountRule)] | yes | |
|
|
4700
|
+
| promo_group | string | yes | |
|
|
4701
|
+
| restrictions | [Restrictions1](#Restrictions1) | no | |
|
|
4699
4702
|
| apply_priority | number | no | |
|
|
4700
|
-
| application_id | string | yes | |
|
|
4701
|
-
| apply_all_discount | boolean | no | |
|
|
4702
4703
|
| code | string | no | |
|
|
4703
|
-
|
|
|
4704
|
-
|
|
|
4705
|
-
| buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | |
|
|
4706
|
-
| author | [PromotionAuthor](#PromotionAuthor) | no | |
|
|
4704
|
+
| stackable | boolean | no | |
|
|
4705
|
+
| mode | string | yes | |
|
|
4707
4706
|
| post_order_action | [PromotionAction](#PromotionAction) | no | |
|
|
4707
|
+
| discount_rules | [[DiscountRule](#DiscountRule)] | yes | |
|
|
4708
|
+
| buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | |
|
|
4709
|
+
| display_meta | [DisplayMeta1](#DisplayMeta1) | yes | |
|
|
4710
|
+
| currency | string | no | |
|
|
4708
4711
|
| apply_exclusive | string | no | |
|
|
4709
4712
|
| ownership | [Ownership1](#Ownership1) | yes | |
|
|
4710
|
-
|
|
|
4711
|
-
|
|
|
4712
|
-
|
|
|
4713
|
-
| _custom_json | string | no | |
|
|
4713
|
+
| visiblility | [Visibility](#Visibility) | no | |
|
|
4714
|
+
| apply_all_discount | boolean | no | |
|
|
4715
|
+
| promotion_type | string | yes | |
|
|
4714
4716
|
| _schedule | [PromotionSchedule](#PromotionSchedule) | no | |
|
|
4717
|
+
| application_id | string | yes | |
|
|
4718
|
+
| author | [PromotionAuthor](#PromotionAuthor) | no | |
|
|
4715
4719
|
|
|
4716
4720
|
---
|
|
4717
4721
|
|
|
@@ -4722,27 +4726,27 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4722
4726
|
|
|
4723
4727
|
| Properties | Type | Nullable | Description |
|
|
4724
4728
|
| ---------- | ---- | -------- | ----------- |
|
|
4729
|
+
| _custom_json | string | no | |
|
|
4725
4730
|
| date_meta | [PromotionDateMeta](#PromotionDateMeta) | no | |
|
|
4726
|
-
|
|
|
4727
|
-
|
|
|
4728
|
-
| mode | string | yes | |
|
|
4729
|
-
| discount_rules | [[DiscountRule](#DiscountRule)] | yes | |
|
|
4731
|
+
| promo_group | string | yes | |
|
|
4732
|
+
| restrictions | [Restrictions1](#Restrictions1) | no | |
|
|
4730
4733
|
| apply_priority | number | no | |
|
|
4731
|
-
| application_id | string | yes | |
|
|
4732
|
-
| apply_all_discount | boolean | no | |
|
|
4733
4734
|
| code | string | no | |
|
|
4734
|
-
|
|
|
4735
|
-
|
|
|
4736
|
-
| buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | |
|
|
4737
|
-
| author | [PromotionAuthor](#PromotionAuthor) | no | |
|
|
4735
|
+
| stackable | boolean | no | |
|
|
4736
|
+
| mode | string | yes | |
|
|
4738
4737
|
| post_order_action | [PromotionAction](#PromotionAction) | no | |
|
|
4738
|
+
| discount_rules | [[DiscountRule](#DiscountRule)] | yes | |
|
|
4739
|
+
| buy_rules | [String: [ItemCriteria](#ItemCriteria)] | yes | |
|
|
4740
|
+
| display_meta | [DisplayMeta1](#DisplayMeta1) | yes | |
|
|
4741
|
+
| currency | string | no | |
|
|
4739
4742
|
| apply_exclusive | string | no | |
|
|
4740
4743
|
| ownership | [Ownership1](#Ownership1) | yes | |
|
|
4741
|
-
|
|
|
4742
|
-
|
|
|
4743
|
-
|
|
|
4744
|
-
| _custom_json | string | no | |
|
|
4744
|
+
| visiblility | [Visibility](#Visibility) | no | |
|
|
4745
|
+
| apply_all_discount | boolean | no | |
|
|
4746
|
+
| promotion_type | string | yes | |
|
|
4745
4747
|
| _schedule | [PromotionSchedule](#PromotionSchedule) | no | |
|
|
4748
|
+
| application_id | string | yes | |
|
|
4749
|
+
| author | [PromotionAuthor](#PromotionAuthor) | no | |
|
|
4746
4750
|
|
|
4747
4751
|
---
|
|
4748
4752
|
|
|
@@ -4753,8 +4757,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4753
4757
|
|
|
4754
4758
|
| Properties | Type | Nullable | Description |
|
|
4755
4759
|
| ---------- | ---- | -------- | ----------- |
|
|
4756
|
-
| archive | boolean | no | Send true to unpublish promotion |
|
|
4757
4760
|
| schedule | [PromotionSchedule](#PromotionSchedule) | no | |
|
|
4761
|
+
| archive | boolean | no | Send true to unpublish promotion |
|
|
4758
4762
|
|
|
4759
4763
|
---
|
|
4760
4764
|
|
|
@@ -4765,8 +4769,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4765
4769
|
|
|
4766
4770
|
| Properties | Type | Nullable | Description |
|
|
4767
4771
|
| ---------- | ---- | -------- | ----------- |
|
|
4768
|
-
| size | string | yes | |
|
|
4769
4772
|
| product_id | string | yes | |
|
|
4773
|
+
| size | string | yes | |
|
|
4770
4774
|
| quantity | number | no | |
|
|
4771
4775
|
|
|
4772
4776
|
---
|
|
@@ -4785,22 +4789,16 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4785
4789
|
|
|
4786
4790
|
|
|
4787
4791
|
|
|
4788
|
-
#### [
|
|
4792
|
+
#### [CouponBreakup](#CouponBreakup)
|
|
4789
4793
|
|
|
4790
4794
|
| Properties | Type | Nullable | Description |
|
|
4791
4795
|
| ---------- | ---- | -------- | ----------- |
|
|
4792
|
-
|
|
|
4793
|
-
|
|
|
4794
|
-
|
|
|
4795
|
-
|
|
|
4796
|
-
|
|
|
4797
|
-
|
|
|
4798
|
-
| fynd_cash | number | no | |
|
|
4799
|
-
| you_saved | number | no | |
|
|
4800
|
-
| discount | number | no | |
|
|
4801
|
-
| gst_charges | number | no | |
|
|
4802
|
-
| vog | number | no | |
|
|
4803
|
-
| subtotal | number | no | |
|
|
4796
|
+
| message | string | no | |
|
|
4797
|
+
| is_applied | boolean | no | |
|
|
4798
|
+
| uid | string | no | |
|
|
4799
|
+
| value | number | no | |
|
|
4800
|
+
| code | string | no | |
|
|
4801
|
+
| type | string | no | |
|
|
4804
4802
|
|
|
4805
4803
|
---
|
|
4806
4804
|
|
|
@@ -4812,10 +4810,10 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4812
4810
|
| Properties | Type | Nullable | Description |
|
|
4813
4811
|
| ---------- | ---- | -------- | ----------- |
|
|
4814
4812
|
| display | string | no | |
|
|
4813
|
+
| message | [string] | no | |
|
|
4815
4814
|
| currency_symbol | string | no | |
|
|
4816
4815
|
| value | number | no | |
|
|
4817
4816
|
| currency_code | string | no | |
|
|
4818
|
-
| message | [string] | no | |
|
|
4819
4817
|
| key | string | no | |
|
|
4820
4818
|
|
|
4821
4819
|
---
|
|
@@ -4823,30 +4821,36 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4823
4821
|
|
|
4824
4822
|
|
|
4825
4823
|
|
|
4826
|
-
#### [
|
|
4824
|
+
#### [LoyaltyPoints](#LoyaltyPoints)
|
|
4827
4825
|
|
|
4828
4826
|
| Properties | Type | Nullable | Description |
|
|
4829
4827
|
| ---------- | ---- | -------- | ----------- |
|
|
4830
|
-
|
|
|
4831
|
-
| code | string | no | |
|
|
4832
|
-
| uid | string | no | |
|
|
4833
|
-
| value | number | no | |
|
|
4828
|
+
| total | number | no | |
|
|
4834
4829
|
| is_applied | boolean | no | |
|
|
4835
|
-
|
|
|
4830
|
+
| description | string | no | |
|
|
4831
|
+
| applicable | number | no | |
|
|
4836
4832
|
|
|
4837
4833
|
---
|
|
4838
4834
|
|
|
4839
4835
|
|
|
4840
4836
|
|
|
4841
4837
|
|
|
4842
|
-
#### [
|
|
4838
|
+
#### [RawBreakup](#RawBreakup)
|
|
4843
4839
|
|
|
4844
4840
|
| Properties | Type | Nullable | Description |
|
|
4845
4841
|
| ---------- | ---- | -------- | ----------- |
|
|
4842
|
+
| convenience_fee | number | no | |
|
|
4843
|
+
| cod_charge | number | no | |
|
|
4844
|
+
| fynd_cash | number | no | |
|
|
4845
|
+
| subtotal | number | no | |
|
|
4846
|
+
| you_saved | number | no | |
|
|
4847
|
+
| coupon | number | no | |
|
|
4846
4848
|
| total | number | no | |
|
|
4847
|
-
|
|
|
4848
|
-
|
|
|
4849
|
-
|
|
|
4849
|
+
| discount | number | no | |
|
|
4850
|
+
| gst_charges | number | no | |
|
|
4851
|
+
| vog | number | no | |
|
|
4852
|
+
| mrp_total | number | no | |
|
|
4853
|
+
| delivery_charge | number | no | |
|
|
4850
4854
|
|
|
4851
4855
|
---
|
|
4852
4856
|
|
|
@@ -4857,155 +4861,157 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
4857
4861
|
|
|
4858
4862
|
| Properties | Type | Nullable | Description |
|
|
4859
4863
|
| ---------- | ---- | -------- | ----------- |
|
|
4860
|
-
| raw | [RawBreakup](#RawBreakup) | no | |
|
|
4861
|
-
| display | [[DisplayBreakup](#DisplayBreakup)] | no | |
|
|
4862
4864
|
| coupon | [CouponBreakup](#CouponBreakup) | no | |
|
|
4865
|
+
| display | [[DisplayBreakup](#DisplayBreakup)] | no | |
|
|
4863
4866
|
| loyalty_points | [LoyaltyPoints](#LoyaltyPoints) | no | |
|
|
4867
|
+
| raw | [RawBreakup](#RawBreakup) | no | |
|
|
4864
4868
|
|
|
4865
4869
|
---
|
|
4866
4870
|
|
|
4867
4871
|
|
|
4868
4872
|
|
|
4869
4873
|
|
|
4870
|
-
#### [
|
|
4874
|
+
#### [ProductPrice](#ProductPrice)
|
|
4871
4875
|
|
|
4872
4876
|
| Properties | Type | Nullable | Description |
|
|
4873
4877
|
| ---------- | ---- | -------- | ----------- |
|
|
4874
|
-
|
|
|
4875
|
-
|
|
|
4876
|
-
|
|
|
4878
|
+
| add_on | number | no | |
|
|
4879
|
+
| selling | number | no | |
|
|
4880
|
+
| currency_symbol | string | no | |
|
|
4881
|
+
| effective | number | no | |
|
|
4882
|
+
| currency_code | string | no | |
|
|
4883
|
+
| marked | number | no | |
|
|
4877
4884
|
|
|
4878
4885
|
---
|
|
4879
4886
|
|
|
4880
4887
|
|
|
4881
4888
|
|
|
4882
4889
|
|
|
4883
|
-
#### [
|
|
4890
|
+
#### [ProductPriceInfo](#ProductPriceInfo)
|
|
4884
4891
|
|
|
4885
4892
|
| Properties | Type | Nullable | Description |
|
|
4886
4893
|
| ---------- | ---- | -------- | ----------- |
|
|
4887
|
-
|
|
|
4888
|
-
|
|
|
4894
|
+
| converted | [ProductPrice](#ProductPrice) | no | |
|
|
4895
|
+
| base | [ProductPrice](#ProductPrice) | no | |
|
|
4889
4896
|
|
|
4890
4897
|
---
|
|
4891
4898
|
|
|
4892
4899
|
|
|
4893
4900
|
|
|
4894
4901
|
|
|
4895
|
-
#### [
|
|
4902
|
+
#### [PromoMeta](#PromoMeta)
|
|
4896
4903
|
|
|
4897
4904
|
| Properties | Type | Nullable | Description |
|
|
4898
4905
|
| ---------- | ---- | -------- | ----------- |
|
|
4899
|
-
|
|
|
4900
|
-
| uid | number | no | Product Category Id |
|
|
4906
|
+
| message | string | no | |
|
|
4901
4907
|
|
|
4902
4908
|
---
|
|
4903
4909
|
|
|
4904
4910
|
|
|
4905
4911
|
|
|
4906
4912
|
|
|
4907
|
-
#### [
|
|
4913
|
+
#### [Ownership2](#Ownership2)
|
|
4908
4914
|
|
|
4909
4915
|
| Properties | Type | Nullable | Description |
|
|
4910
4916
|
| ---------- | ---- | -------- | ----------- |
|
|
4911
|
-
|
|
|
4917
|
+
| payable_by | string | no | promo amount bearable party |
|
|
4918
|
+
| payable_category | string | no | promo amount payable category |
|
|
4912
4919
|
|
|
4913
4920
|
---
|
|
4914
4921
|
|
|
4915
4922
|
|
|
4916
4923
|
|
|
4917
4924
|
|
|
4918
|
-
#### [
|
|
4925
|
+
#### [AppliedPromotion](#AppliedPromotion)
|
|
4919
4926
|
|
|
4920
4927
|
| Properties | Type | Nullable | Description |
|
|
4921
4928
|
| ---------- | ---- | -------- | ----------- |
|
|
4922
|
-
|
|
|
4923
|
-
|
|
|
4924
|
-
|
|
|
4929
|
+
| promo_id | string | no | Promotion id |
|
|
4930
|
+
| mrp_promotion | boolean | no | If applied promotion is applied on product MRP or ESP |
|
|
4931
|
+
| offer_text | string | no | Offer text of current promotion |
|
|
4932
|
+
| ownership | [Ownership2](#Ownership2) | no | Ownership of promotion |
|
|
4933
|
+
| amount | number | no | Per unit discount amount applied with current promotion |
|
|
4934
|
+
| promotion_type | string | no | Promotion type of current promotion |
|
|
4935
|
+
| article_quantity | number | no | Quantity of article on which promotion is applicable |
|
|
4925
4936
|
|
|
4926
4937
|
---
|
|
4927
4938
|
|
|
4928
4939
|
|
|
4929
4940
|
|
|
4930
4941
|
|
|
4931
|
-
#### [
|
|
4942
|
+
#### [CategoryInfo](#CategoryInfo)
|
|
4932
4943
|
|
|
4933
4944
|
| Properties | Type | Nullable | Description |
|
|
4934
4945
|
| ---------- | ---- | -------- | ----------- |
|
|
4935
|
-
| type | string | no | |
|
|
4936
|
-
| images | [[ProductImage](#ProductImage)] | no | |
|
|
4937
4946
|
| name | string | no | |
|
|
4938
|
-
|
|
|
4939
|
-
| uid | number | no | |
|
|
4940
|
-
| brand | [BaseInfo](#BaseInfo) | no | |
|
|
4941
|
-
| categories | [[CategoryInfo](#CategoryInfo)] | no | |
|
|
4942
|
-
| action | [ProductAction](#ProductAction) | no | |
|
|
4947
|
+
| uid | number | no | Product Category Id |
|
|
4943
4948
|
|
|
4944
4949
|
---
|
|
4945
4950
|
|
|
4946
4951
|
|
|
4947
4952
|
|
|
4948
4953
|
|
|
4949
|
-
#### [
|
|
4954
|
+
#### [BaseInfo](#BaseInfo)
|
|
4950
4955
|
|
|
4951
4956
|
| Properties | Type | Nullable | Description |
|
|
4952
4957
|
| ---------- | ---- | -------- | ----------- |
|
|
4953
|
-
|
|
|
4954
|
-
|
|
|
4955
|
-
| add_on | number | no | |
|
|
4956
|
-
| effective | number | no | |
|
|
4957
|
-
| currency_symbol | string | no | |
|
|
4958
|
-
| currency_code | string | no | |
|
|
4958
|
+
| name | string | no | |
|
|
4959
|
+
| uid | number | no | |
|
|
4959
4960
|
|
|
4960
4961
|
---
|
|
4961
4962
|
|
|
4962
4963
|
|
|
4963
4964
|
|
|
4964
4965
|
|
|
4965
|
-
#### [
|
|
4966
|
+
#### [ActionQuery](#ActionQuery)
|
|
4966
4967
|
|
|
4967
4968
|
| Properties | Type | Nullable | Description |
|
|
4968
4969
|
| ---------- | ---- | -------- | ----------- |
|
|
4969
|
-
|
|
|
4970
|
-
| converted | [ProductPrice](#ProductPrice) | no | |
|
|
4970
|
+
| product_slug | [string] | no | Contains list of product slug |
|
|
4971
4971
|
|
|
4972
4972
|
---
|
|
4973
4973
|
|
|
4974
4974
|
|
|
4975
4975
|
|
|
4976
4976
|
|
|
4977
|
-
#### [
|
|
4977
|
+
#### [ProductAction](#ProductAction)
|
|
4978
4978
|
|
|
4979
4979
|
| Properties | Type | Nullable | Description |
|
|
4980
4980
|
| ---------- | ---- | -------- | ----------- |
|
|
4981
|
-
|
|
|
4981
|
+
| url | string | no | |
|
|
4982
|
+
| query | [ActionQuery](#ActionQuery) | no | |
|
|
4983
|
+
| type | string | no | |
|
|
4982
4984
|
|
|
4983
4985
|
---
|
|
4984
4986
|
|
|
4985
4987
|
|
|
4986
4988
|
|
|
4987
4989
|
|
|
4988
|
-
#### [
|
|
4990
|
+
#### [ProductImage](#ProductImage)
|
|
4989
4991
|
|
|
4990
4992
|
| Properties | Type | Nullable | Description |
|
|
4991
4993
|
| ---------- | ---- | -------- | ----------- |
|
|
4992
|
-
|
|
|
4993
|
-
|
|
|
4994
|
-
|
|
|
4995
|
-
| amount | number | no | Per unit discount amount applied with current promotion |
|
|
4996
|
-
| mrp_promotion | boolean | no | If applied promotion is applied on product MRP or ESP |
|
|
4997
|
-
| promotion_type | string | no | Promotion type of current promotion |
|
|
4994
|
+
| url | string | no | |
|
|
4995
|
+
| secure_url | string | no | |
|
|
4996
|
+
| aspect_ratio | string | no | |
|
|
4998
4997
|
|
|
4999
4998
|
---
|
|
5000
4999
|
|
|
5001
5000
|
|
|
5002
5001
|
|
|
5003
5002
|
|
|
5004
|
-
#### [
|
|
5003
|
+
#### [CartProduct](#CartProduct)
|
|
5005
5004
|
|
|
5006
5005
|
| Properties | Type | Nullable | Description |
|
|
5007
5006
|
| ---------- | ---- | -------- | ----------- |
|
|
5008
|
-
|
|
|
5007
|
+
| name | string | no | |
|
|
5008
|
+
| categories | [[CategoryInfo](#CategoryInfo)] | no | |
|
|
5009
|
+
| slug | string | no | Unique product url name generated via product name and other meta data |
|
|
5010
|
+
| brand | [BaseInfo](#BaseInfo) | no | |
|
|
5011
|
+
| uid | number | no | |
|
|
5012
|
+
| action | [ProductAction](#ProductAction) | no | |
|
|
5013
|
+
| type | string | no | |
|
|
5014
|
+
| images | [[ProductImage](#ProductImage)] | no | |
|
|
5009
5015
|
|
|
5010
5016
|
---
|
|
5011
5017
|
|
|
@@ -5016,11 +5022,22 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5016
5022
|
|
|
5017
5023
|
| Properties | Type | Nullable | Description |
|
|
5018
5024
|
| ---------- | ---- | -------- | ----------- |
|
|
5025
|
+
| deliverable | boolean | no | |
|
|
5026
|
+
| out_of_stock | boolean | no | |
|
|
5019
5027
|
| is_valid | boolean | no | |
|
|
5020
5028
|
| sizes | [string] | no | |
|
|
5021
5029
|
| other_store_quantity | number | no | |
|
|
5022
|
-
|
|
5023
|
-
|
|
5030
|
+
|
|
5031
|
+
---
|
|
5032
|
+
|
|
5033
|
+
|
|
5034
|
+
|
|
5035
|
+
|
|
5036
|
+
#### [CartProductIdentifer](#CartProductIdentifer)
|
|
5037
|
+
|
|
5038
|
+
| Properties | Type | Nullable | Description |
|
|
5039
|
+
| ---------- | ---- | -------- | ----------- |
|
|
5040
|
+
| identifier | string | no | Article idenfier generated by cart |
|
|
5024
5041
|
|
|
5025
5042
|
---
|
|
5026
5043
|
|
|
@@ -5031,10 +5048,10 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5031
5048
|
|
|
5032
5049
|
| Properties | Type | Nullable | Description |
|
|
5033
5050
|
| ---------- | ---- | -------- | ----------- |
|
|
5034
|
-
| effective | number | no | |
|
|
5035
5051
|
| currency_code | string | no | |
|
|
5036
|
-
| currency_symbol | string | no | |
|
|
5037
5052
|
| marked | number | no | |
|
|
5053
|
+
| effective | number | no | |
|
|
5054
|
+
| currency_symbol | string | no | |
|
|
5038
5055
|
|
|
5039
5056
|
---
|
|
5040
5057
|
|
|
@@ -5045,8 +5062,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5045
5062
|
|
|
5046
5063
|
| Properties | Type | Nullable | Description |
|
|
5047
5064
|
| ---------- | ---- | -------- | ----------- |
|
|
5048
|
-
| base | [BasePrice](#BasePrice) | no | |
|
|
5049
5065
|
| converted | [BasePrice](#BasePrice) | no | |
|
|
5066
|
+
| base | [BasePrice](#BasePrice) | no | |
|
|
5050
5067
|
|
|
5051
5068
|
---
|
|
5052
5069
|
|
|
@@ -5057,15 +5074,15 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5057
5074
|
|
|
5058
5075
|
| Properties | Type | Nullable | Description |
|
|
5059
5076
|
| ---------- | ---- | -------- | ----------- |
|
|
5060
|
-
|
|
|
5077
|
+
| parent_item_identifiers | string | no | |
|
|
5078
|
+
| store | [BaseInfo](#BaseInfo) | no | |
|
|
5061
5079
|
| seller | [BaseInfo](#BaseInfo) | no | |
|
|
5062
5080
|
| product_group_tags | [string] | no | |
|
|
5063
5081
|
| size | string | no | |
|
|
5064
|
-
| store | [BaseInfo](#BaseInfo) | no | |
|
|
5065
|
-
| extra_meta | string | no | |
|
|
5066
5082
|
| uid | string | no | |
|
|
5067
5083
|
| quantity | number | no | |
|
|
5068
|
-
|
|
|
5084
|
+
| type | string | no | |
|
|
5085
|
+
| extra_meta | string | no | |
|
|
5069
5086
|
| price | [ArticlePriceInfo](#ArticlePriceInfo) | no | |
|
|
5070
5087
|
|
|
5071
5088
|
---
|
|
@@ -5077,22 +5094,22 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5077
5094
|
|
|
5078
5095
|
| Properties | Type | Nullable | Description |
|
|
5079
5096
|
| ---------- | ---- | -------- | ----------- |
|
|
5080
|
-
|
|
|
5081
|
-
|
|
|
5082
|
-
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
5083
|
-
| promotions_applied | [[AppliedPromotion](#AppliedPromotion)] | no | |
|
|
5097
|
+
| price | [ProductPriceInfo](#ProductPriceInfo) | no | |
|
|
5098
|
+
| parent_item_identifiers | string | no | |
|
|
5084
5099
|
| promo_meta | [PromoMeta](#PromoMeta) | no | |
|
|
5100
|
+
| bulk_offer | string | no | |
|
|
5101
|
+
| message | string | no | |
|
|
5102
|
+
| promotions_applied | [[AppliedPromotion](#AppliedPromotion)] | no | |
|
|
5085
5103
|
| discount | string | no | |
|
|
5104
|
+
| product | [CartProduct](#CartProduct) | no | |
|
|
5086
5105
|
| is_set | boolean | no | |
|
|
5087
5106
|
| quantity | number | no | |
|
|
5088
|
-
| coupon_message | string | no | |
|
|
5089
|
-
| parent_item_identifiers | string | no | |
|
|
5090
|
-
| bulk_offer | string | no | |
|
|
5091
5107
|
| availability | [ProductAvailability](#ProductAvailability) | no | |
|
|
5092
|
-
|
|
|
5093
|
-
|
|
|
5108
|
+
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
5109
|
+
| price_per_unit | [ProductPriceInfo](#ProductPriceInfo) | no | |
|
|
5094
5110
|
| key | string | no | |
|
|
5095
|
-
|
|
|
5111
|
+
| coupon_message | string | no | |
|
|
5112
|
+
| article | [ProductArticle](#ProductArticle) | no | |
|
|
5096
5113
|
|
|
5097
5114
|
---
|
|
5098
5115
|
|
|
@@ -5103,10 +5120,10 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5103
5120
|
|
|
5104
5121
|
| Properties | Type | Nullable | Description |
|
|
5105
5122
|
| ---------- | ---- | -------- | ----------- |
|
|
5106
|
-
| message | string | no | |
|
|
5107
|
-
| is_valid | boolean | no | |
|
|
5108
5123
|
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
5109
5124
|
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
5125
|
+
| is_valid | boolean | no | |
|
|
5126
|
+
| message | string | no | |
|
|
5110
5127
|
|
|
5111
5128
|
---
|
|
5112
5129
|
|
|
@@ -5118,8 +5135,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5118
5135
|
| Properties | Type | Nullable | Description |
|
|
5119
5136
|
| ---------- | ---- | -------- | ----------- |
|
|
5120
5137
|
| success | boolean | no | |
|
|
5121
|
-
| message | string | no | |
|
|
5122
5138
|
| errors | string | no | Contains field name which has error as key and error message as value |
|
|
5139
|
+
| message | string | no | |
|
|
5123
5140
|
|
|
5124
5141
|
---
|
|
5125
5142
|
|
|
@@ -5130,21 +5147,21 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5130
5147
|
|
|
5131
5148
|
| Properties | Type | Nullable | Description |
|
|
5132
5149
|
| ---------- | ---- | -------- | ----------- |
|
|
5133
|
-
| country_code | string | no | |
|
|
5134
5150
|
| name | string | no | |
|
|
5135
|
-
|
|
|
5151
|
+
| landmark | string | no | |
|
|
5152
|
+
| country | string | no | |
|
|
5136
5153
|
| address_type | string | no | |
|
|
5154
|
+
| email | string | no | |
|
|
5155
|
+
| country_code | string | no | |
|
|
5137
5156
|
| area_code | string | yes | |
|
|
5138
|
-
| country | string | no | |
|
|
5139
5157
|
| state | string | no | |
|
|
5140
|
-
|
|
|
5141
|
-
|
|
|
5142
|
-
| email | string | no | |
|
|
5158
|
+
| city | string | no | |
|
|
5159
|
+
| area_code_slug | string | no | |
|
|
5143
5160
|
| meta | string | no | |
|
|
5144
|
-
|
|
|
5161
|
+
| area | string | no | |
|
|
5162
|
+
| phone | number | no | |
|
|
5163
|
+
| address | string | no | |
|
|
5145
5164
|
| pincode | number | no | |
|
|
5146
|
-
| area_code_slug | string | no | |
|
|
5147
|
-
| city | string | no | |
|
|
5148
5165
|
|
|
5149
5166
|
---
|
|
5150
5167
|
|
|
@@ -5155,32 +5172,32 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5155
5172
|
|
|
5156
5173
|
| Properties | Type | Nullable | Description |
|
|
5157
5174
|
| ---------- | ---- | -------- | ----------- |
|
|
5158
|
-
| shipping_address | [ShippingAddress](#ShippingAddress) | yes | |
|
|
5159
5175
|
| cart_items | [CartItem](#CartItem) | no | |
|
|
5176
|
+
| shipping_address | [ShippingAddress](#ShippingAddress) | yes | |
|
|
5160
5177
|
|
|
5161
5178
|
---
|
|
5162
5179
|
|
|
5163
5180
|
|
|
5164
5181
|
|
|
5165
5182
|
|
|
5166
|
-
#### [
|
|
5183
|
+
#### [PromiseTimestamp](#PromiseTimestamp)
|
|
5167
5184
|
|
|
5168
5185
|
| Properties | Type | Nullable | Description |
|
|
5169
5186
|
| ---------- | ---- | -------- | ----------- |
|
|
5170
|
-
| max |
|
|
5171
|
-
| min |
|
|
5187
|
+
| max | number | no | |
|
|
5188
|
+
| min | number | no | |
|
|
5172
5189
|
|
|
5173
5190
|
---
|
|
5174
5191
|
|
|
5175
5192
|
|
|
5176
5193
|
|
|
5177
5194
|
|
|
5178
|
-
#### [
|
|
5195
|
+
#### [PromiseFormatted](#PromiseFormatted)
|
|
5179
5196
|
|
|
5180
5197
|
| Properties | Type | Nullable | Description |
|
|
5181
5198
|
| ---------- | ---- | -------- | ----------- |
|
|
5182
|
-
| max |
|
|
5183
|
-
| min |
|
|
5199
|
+
| max | string | no | |
|
|
5200
|
+
| min | string | no | |
|
|
5184
5201
|
|
|
5185
5202
|
---
|
|
5186
5203
|
|
|
@@ -5191,8 +5208,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5191
5208
|
|
|
5192
5209
|
| Properties | Type | Nullable | Description |
|
|
5193
5210
|
| ---------- | ---- | -------- | ----------- |
|
|
5194
|
-
| formatted | [PromiseFormatted](#PromiseFormatted) | no | |
|
|
5195
5211
|
| timestamp | [PromiseTimestamp](#PromiseTimestamp) | no | |
|
|
5212
|
+
| formatted | [PromiseFormatted](#PromiseFormatted) | no | |
|
|
5196
5213
|
|
|
5197
5214
|
---
|
|
5198
5215
|
|
|
@@ -5203,11 +5220,11 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5203
5220
|
|
|
5204
5221
|
| Properties | Type | Nullable | Description |
|
|
5205
5222
|
| ---------- | ---- | -------- | ----------- |
|
|
5206
|
-
|
|
|
5223
|
+
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
5207
5224
|
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
5208
|
-
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
5209
5225
|
| message | string | no | |
|
|
5210
|
-
|
|
|
5226
|
+
| is_valid | boolean | no | |
|
|
5227
|
+
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
5211
5228
|
|
|
5212
5229
|
---
|
|
5213
5230
|
|
|
@@ -5218,11 +5235,11 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5218
5235
|
|
|
5219
5236
|
| Properties | Type | Nullable | Description |
|
|
5220
5237
|
| ---------- | ---- | -------- | ----------- |
|
|
5238
|
+
| current_status | string | no | |
|
|
5221
5239
|
| payment_id | string | no | |
|
|
5222
5240
|
| order_id | string | no | |
|
|
5223
|
-
| extra_meta | string | no | |
|
|
5224
|
-
| current_status | string | no | |
|
|
5225
5241
|
| payment_gateway | string | no | |
|
|
5242
|
+
| extra_meta | string | no | |
|
|
5226
5243
|
|
|
5227
5244
|
---
|
|
5228
5245
|
|
|
@@ -5234,9 +5251,9 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5234
5251
|
| Properties | Type | Nullable | Description |
|
|
5235
5252
|
| ---------- | ---- | -------- | ----------- |
|
|
5236
5253
|
| name | string | no | Payment mode name |
|
|
5254
|
+
| meta | [MultiTenderPaymentMeta](#MultiTenderPaymentMeta) | no | |
|
|
5237
5255
|
| mode | string | yes | |
|
|
5238
5256
|
| amount | number | yes | Payment amount |
|
|
5239
|
-
| meta | [MultiTenderPaymentMeta](#MultiTenderPaymentMeta) | no | |
|
|
5240
5257
|
|
|
5241
5258
|
---
|
|
5242
5259
|
|
|
@@ -5247,8 +5264,8 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5247
5264
|
|
|
5248
5265
|
| Properties | Type | Nullable | Description |
|
|
5249
5266
|
| ---------- | ---- | -------- | ----------- |
|
|
5250
|
-
| key | string | yes | |
|
|
5251
5267
|
| values | [string] | yes | |
|
|
5268
|
+
| key | string | yes | |
|
|
5252
5269
|
|
|
5253
5270
|
---
|
|
5254
5271
|
|
|
@@ -5272,22 +5289,22 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5272
5289
|
| Properties | Type | Nullable | Description |
|
|
5273
5290
|
| ---------- | ---- | -------- | ----------- |
|
|
5274
5291
|
| payment_methods | [[MultiTenderPaymentMethod](#MultiTenderPaymentMethod)] | yes | |
|
|
5275
|
-
| delivery_charges | number | yes | |
|
|
5276
|
-
| price_marked | number | yes | |
|
|
5277
5292
|
| price_effective | number | yes | |
|
|
5278
|
-
| employee_discount | number | no | |
|
|
5279
|
-
| cashback_applied | number | yes | |
|
|
5280
|
-
| extra_meta | string | no | |
|
|
5281
5293
|
| amount_paid | number | yes | |
|
|
5282
5294
|
| discount | number | yes | |
|
|
5283
|
-
|
|
|
5295
|
+
| coupon_effective_discount | number | yes | |
|
|
5284
5296
|
| loyalty_discount | number | no | |
|
|
5285
|
-
|
|
|
5286
|
-
| files | [[OpenApiFiles](#OpenApiFiles)] | no | |
|
|
5287
|
-
| meta | [CartItemMeta](#CartItemMeta) | no | |
|
|
5297
|
+
| cashback_applied | number | yes | |
|
|
5288
5298
|
| size | string | yes | |
|
|
5299
|
+
| files | [[OpenApiFiles](#OpenApiFiles)] | no | |
|
|
5300
|
+
| quantity | number | no | |
|
|
5289
5301
|
| product_id | number | yes | |
|
|
5290
|
-
|
|
|
5302
|
+
| delivery_charges | number | yes | |
|
|
5303
|
+
| employee_discount | number | no | |
|
|
5304
|
+
| meta | [CartItemMeta](#CartItemMeta) | no | |
|
|
5305
|
+
| extra_meta | string | no | |
|
|
5306
|
+
| cod_charges | number | yes | |
|
|
5307
|
+
| price_marked | number | yes | |
|
|
5291
5308
|
|
|
5292
5309
|
---
|
|
5293
5310
|
|
|
@@ -5299,25 +5316,25 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5299
5316
|
| Properties | Type | Nullable | Description |
|
|
5300
5317
|
| ---------- | ---- | -------- | ----------- |
|
|
5301
5318
|
| payment_methods | [[MultiTenderPaymentMethod](#MultiTenderPaymentMethod)] | yes | |
|
|
5302
|
-
| coupon | string | no | |
|
|
5303
|
-
| order_id | string | no | |
|
|
5304
|
-
| delivery_charges | number | yes | |
|
|
5305
|
-
| affiliate_order_id | string | no | |
|
|
5306
|
-
| billing_address | [ShippingAddress](#ShippingAddress) | yes | |
|
|
5307
|
-
| shipping_address | [ShippingAddress](#ShippingAddress) | no | |
|
|
5308
5319
|
| cart_items | [[OpenApiOrderItem](#OpenApiOrderItem)] | yes | |
|
|
5309
5320
|
| coupon_value | number | yes | |
|
|
5310
|
-
|
|
|
5311
|
-
| gstin | string | no | |
|
|
5321
|
+
| affiliate_order_id | string | no | |
|
|
5312
5322
|
| payment_mode | string | no | |
|
|
5313
|
-
| cart_value | number | yes | |
|
|
5314
|
-
| employee_discount | string | no | |
|
|
5315
|
-
| comment | string | no | |
|
|
5316
|
-
| cashback_applied | number | yes | |
|
|
5317
5323
|
| loyalty_discount | number | no | |
|
|
5318
|
-
|
|
|
5324
|
+
| cashback_applied | number | yes | |
|
|
5319
5325
|
| cod_charges | number | yes | |
|
|
5326
|
+
| billing_address | [ShippingAddress](#ShippingAddress) | yes | |
|
|
5327
|
+
| comment | string | no | |
|
|
5328
|
+
| currency_code | string | no | |
|
|
5329
|
+
| employee_discount | string | no | |
|
|
5330
|
+
| gstin | string | no | |
|
|
5331
|
+
| shipping_address | [ShippingAddress](#ShippingAddress) | no | |
|
|
5320
5332
|
| coupon_code | string | yes | |
|
|
5333
|
+
| coupon | string | no | |
|
|
5334
|
+
| files | [[OpenApiFiles](#OpenApiFiles)] | no | |
|
|
5335
|
+
| delivery_charges | number | yes | |
|
|
5336
|
+
| order_id | string | no | |
|
|
5337
|
+
| cart_value | number | yes | |
|
|
5321
5338
|
|
|
5322
5339
|
---
|
|
5323
5340
|
|
|
@@ -5328,10 +5345,10 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5328
5345
|
|
|
5329
5346
|
| Properties | Type | Nullable | Description |
|
|
5330
5347
|
| ---------- | ---- | -------- | ----------- |
|
|
5348
|
+
| order_id | string | yes | Fynd order id |
|
|
5331
5349
|
| success | boolean | no | |
|
|
5332
5350
|
| message | string | no | |
|
|
5333
5351
|
| order_ref_id | string | no | Order id sent in request |
|
|
5334
|
-
| order_id | string | yes | Fynd order id |
|
|
5335
5352
|
|
|
5336
5353
|
---
|
|
5337
5354
|
|
|
@@ -5342,39 +5359,39 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5342
5359
|
|
|
5343
5360
|
| Properties | Type | Nullable | Description |
|
|
5344
5361
|
| ---------- | ---- | -------- | ----------- |
|
|
5362
|
+
| is_archive | boolean | no | |
|
|
5363
|
+
| payment_methods | [string] | no | |
|
|
5364
|
+
| payment_mode | string | no | |
|
|
5365
|
+
| comment | string | no | |
|
|
5366
|
+
| articles | [string] | yes | |
|
|
5367
|
+
| promotion | string | no | |
|
|
5368
|
+
| is_default | boolean | yes | |
|
|
5369
|
+
| app_id | string | no | |
|
|
5370
|
+
| discount | number | no | |
|
|
5345
5371
|
| coupon | string | no | |
|
|
5372
|
+
| merge_qty | boolean | no | |
|
|
5373
|
+
| cart_value | number | no | |
|
|
5374
|
+
| buy_now | boolean | no | |
|
|
5346
5375
|
| order_id | string | no | |
|
|
5347
|
-
|
|
|
5376
|
+
| _id | string | yes | |
|
|
5348
5377
|
| cashback | string | yes | |
|
|
5349
|
-
| fynd_credits | string | no | |
|
|
5350
|
-
| checkout_mode | string | no | |
|
|
5351
5378
|
| meta | string | no | |
|
|
5352
|
-
| payments | string | no | |
|
|
5353
5379
|
| is_active | boolean | no | |
|
|
5354
|
-
|
|
|
5355
|
-
|
|
|
5356
|
-
|
|
|
5357
|
-
| app_id | string | no | |
|
|
5358
|
-
| created_on | string | yes | |
|
|
5359
|
-
| is_archive | boolean | no | |
|
|
5360
|
-
| payment_methods | [string] | no | |
|
|
5380
|
+
| bulk_coupon_discount | number | no | |
|
|
5381
|
+
| payments | string | no | |
|
|
5382
|
+
| expire_at | string | yes | |
|
|
5361
5383
|
| user_id | string | yes | |
|
|
5384
|
+
| checkout_mode | string | no | |
|
|
5362
5385
|
| pick_up_customer_details | string | no | |
|
|
5363
|
-
| is_default | boolean | yes | |
|
|
5364
|
-
| uid | number | yes | |
|
|
5365
|
-
| buy_now | boolean | no | |
|
|
5366
|
-
| merge_qty | boolean | no | |
|
|
5367
5386
|
| gstin | string | no | |
|
|
5368
|
-
| payment_mode | string | no | |
|
|
5369
|
-
| cart_value | number | no | |
|
|
5370
|
-
| comment | string | no | |
|
|
5371
|
-
| promotion | string | no | |
|
|
5372
5387
|
| shipments | [string] | no | |
|
|
5373
|
-
|
|
|
5374
|
-
|
|
|
5375
|
-
|
|
|
5388
|
+
| last_modified | string | yes | |
|
|
5389
|
+
| created_on | string | yes | |
|
|
5390
|
+
| uid | number | yes | |
|
|
5391
|
+
| fc_index_map | [number] | no | |
|
|
5392
|
+
| delivery_charges | string | no | |
|
|
5393
|
+
| fynd_credits | string | no | |
|
|
5376
5394
|
| cod_charges | string | no | |
|
|
5377
|
-
| bulk_coupon_discount | number | no | |
|
|
5378
5395
|
|
|
5379
5396
|
---
|
|
5380
5397
|
|
|
@@ -5385,36 +5402,36 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5385
5402
|
|
|
5386
5403
|
| Properties | Type | Nullable | Description |
|
|
5387
5404
|
| ---------- | ---- | -------- | ----------- |
|
|
5388
|
-
| result | string | no | |
|
|
5389
|
-
| success | boolean | no | the request success is defined |
|
|
5390
|
-
| page | [Page](#Page) | no | |
|
|
5391
5405
|
| message | string | no | message of the response |
|
|
5406
|
+
| success | boolean | no | the request success is defined |
|
|
5392
5407
|
| items | [[AbandonedCart](#AbandonedCart)] | no | |
|
|
5408
|
+
| result | string | no | |
|
|
5409
|
+
| page | [Page](#Page) | no | |
|
|
5393
5410
|
|
|
5394
5411
|
---
|
|
5395
5412
|
|
|
5396
5413
|
|
|
5397
5414
|
|
|
5398
5415
|
|
|
5399
|
-
#### [
|
|
5416
|
+
#### [CartCurrency](#CartCurrency)
|
|
5400
5417
|
|
|
5401
5418
|
| Properties | Type | Nullable | Description |
|
|
5402
5419
|
| ---------- | ---- | -------- | ----------- |
|
|
5403
|
-
|
|
|
5404
|
-
|
|
|
5405
|
-
| payment_identifier | string | no | |
|
|
5420
|
+
| code | string | no | Currency code defined by ISO 4217:2015 |
|
|
5421
|
+
| symbol | string | no | |
|
|
5406
5422
|
|
|
5407
5423
|
---
|
|
5408
5424
|
|
|
5409
5425
|
|
|
5410
5426
|
|
|
5411
5427
|
|
|
5412
|
-
#### [
|
|
5428
|
+
#### [PaymentSelectionLock](#PaymentSelectionLock)
|
|
5413
5429
|
|
|
5414
5430
|
| Properties | Type | Nullable | Description |
|
|
5415
5431
|
| ---------- | ---- | -------- | ----------- |
|
|
5416
|
-
|
|
|
5417
|
-
|
|
|
5432
|
+
| default_options | string | no | |
|
|
5433
|
+
| enabled | boolean | no | |
|
|
5434
|
+
| payment_identifier | string | no | |
|
|
5418
5435
|
|
|
5419
5436
|
---
|
|
5420
5437
|
|
|
@@ -5425,22 +5442,22 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5425
5442
|
|
|
5426
5443
|
| Properties | Type | Nullable | Description |
|
|
5427
5444
|
| ---------- | ---- | -------- | ----------- |
|
|
5428
|
-
|
|
|
5429
|
-
| is_valid | boolean | no | |
|
|
5430
|
-
| gstin | string | no | |
|
|
5431
|
-
| checkout_mode | string | no | |
|
|
5432
|
-
| id | string | no | |
|
|
5433
|
-
| comment | string | no | |
|
|
5434
|
-
| restrict_checkout | boolean | no | |
|
|
5445
|
+
| breakup_values | [CartBreakup](#CartBreakup) | no | |
|
|
5435
5446
|
| delivery_promise | [ShipmentPromise](#ShipmentPromise) | no | |
|
|
5436
|
-
| coupon_text | string | no | |
|
|
5437
|
-
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
5438
|
-
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
5439
|
-
| delivery_charge_info | string | no | |
|
|
5440
|
-
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
5441
5447
|
| message | string | no | |
|
|
5448
|
+
| id | string | no | |
|
|
5449
|
+
| currency | [CartCurrency](#CartCurrency) | no | |
|
|
5442
5450
|
| last_modified | string | no | |
|
|
5443
|
-
|
|
|
5451
|
+
| payment_selection_lock | [PaymentSelectionLock](#PaymentSelectionLock) | no | |
|
|
5452
|
+
| delivery_charge_info | string | no | |
|
|
5453
|
+
| restrict_checkout | boolean | no | |
|
|
5454
|
+
| buy_now | boolean | no | |
|
|
5455
|
+
| comment | string | no | |
|
|
5456
|
+
| is_valid | boolean | no | |
|
|
5457
|
+
| items | [[CartProductInfo](#CartProductInfo)] | no | |
|
|
5458
|
+
| coupon_text | string | no | |
|
|
5459
|
+
| checkout_mode | string | no | |
|
|
5460
|
+
| gstin | string | no | |
|
|
5444
5461
|
|
|
5445
5462
|
---
|
|
5446
5463
|
|
|
@@ -5452,17 +5469,17 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5452
5469
|
| Properties | Type | Nullable | Description |
|
|
5453
5470
|
| ---------- | ---- | -------- | ----------- |
|
|
5454
5471
|
| display | string | no | |
|
|
5455
|
-
| store_id | number | no | |
|
|
5456
|
-
| seller_id | number | no | |
|
|
5457
|
-
| pos | boolean | no | |
|
|
5458
|
-
| product_group_tags | [string] | no | |
|
|
5459
|
-
| extra_meta | string | no | |
|
|
5460
|
-
| quantity | number | no | |
|
|
5461
5472
|
| parent_item_identifiers | string | no | |
|
|
5462
5473
|
| article_id | string | no | |
|
|
5474
|
+
| article_assignment | string | no | |
|
|
5463
5475
|
| item_size | string | no | |
|
|
5476
|
+
| product_group_tags | [string] | no | |
|
|
5477
|
+
| pos | boolean | no | |
|
|
5478
|
+
| quantity | number | no | |
|
|
5464
5479
|
| item_id | number | no | |
|
|
5465
|
-
|
|
|
5480
|
+
| seller_id | number | no | |
|
|
5481
|
+
| store_id | number | no | |
|
|
5482
|
+
| extra_meta | string | no | |
|
|
5466
5483
|
|
|
5467
5484
|
---
|
|
5468
5485
|
|
|
@@ -5484,10 +5501,10 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5484
5501
|
|
|
5485
5502
|
| Properties | Type | Nullable | Description |
|
|
5486
5503
|
| ---------- | ---- | -------- | ----------- |
|
|
5504
|
+
| partial | boolean | no | When adding multiple items check if all added. True if only few are added. |
|
|
5487
5505
|
| success | boolean | no | True if all items are added successfully. False if partially added or not added. |
|
|
5488
5506
|
| cart | [CartDetailResponse](#CartDetailResponse) | no | |
|
|
5489
5507
|
| message | string | no | |
|
|
5490
|
-
| partial | boolean | no | When adding multiple items check if all added. True if only few are added. |
|
|
5491
5508
|
|
|
5492
5509
|
---
|
|
5493
5510
|
|
|
@@ -5498,14 +5515,14 @@ Success. Updates and returns a cart object as shown below. Refer `UpdateCartDeta
|
|
|
5498
5515
|
|
|
5499
5516
|
| Properties | Type | Nullable | Description |
|
|
5500
5517
|
| ---------- | ---- | -------- | ----------- |
|
|
5501
|
-
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
5502
|
-
| extra_meta | string | no | |
|
|
5503
|
-
| quantity | number | no | |
|
|
5504
5518
|
| parent_item_identifiers | string | no | |
|
|
5505
5519
|
| article_id | string | no | |
|
|
5506
5520
|
| item_size | string | no | |
|
|
5507
|
-
| item_id | number | no | |
|
|
5508
5521
|
| item_index | number | no | |
|
|
5522
|
+
| quantity | number | no | |
|
|
5523
|
+
| item_id | number | no | |
|
|
5524
|
+
| identifiers | [CartProductIdentifer](#CartProductIdentifer) | yes | |
|
|
5525
|
+
| extra_meta | string | no | |
|
|
5509
5526
|
|
|
5510
5527
|
---
|
|
5511
5528
|
|