@gofynd/fdk-client-javascript 1.0.1 → 1.0.3
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/documentation/application/CART.md +5934 -4502
- package/documentation/application/CATALOG.md +6338 -7245
- package/documentation/application/COMMON.md +95 -222
- package/documentation/application/COMMUNICATION.md +106 -186
- package/documentation/application/CONFIGURATION.md +903 -1597
- package/documentation/application/CONTENT.md +562 -1270
- package/documentation/application/FILESTORAGE.md +84 -220
- package/documentation/application/LEAD.md +314 -660
- package/documentation/application/LOGISTIC.md +229 -305
- package/documentation/application/ORDER.md +642 -1137
- package/documentation/application/PAYMENT.md +2285 -3031
- package/documentation/application/POSCART.md +6079 -4642
- package/documentation/application/REWARDS.md +94 -248
- package/documentation/application/SHARE.md +152 -250
- package/documentation/application/THEME.md +952 -1235
- package/documentation/application/USER.md +1228 -1765
- package/documentation/platform/ANALYTICS.md +207 -349
- package/documentation/platform/AUDITTRAIL.md +121 -204
- package/documentation/platform/BILLING.md +865 -1376
- package/documentation/platform/CART.md +2814 -3662
- package/documentation/platform/CATALOG.md +15266 -17619
- package/documentation/platform/COMMON.md +95 -222
- package/documentation/platform/COMMUNICATION.md +1632 -2380
- package/documentation/platform/COMPANYPROFILE.md +572 -957
- package/documentation/platform/CONFIGURATION.md +3050 -4073
- package/documentation/platform/CONTENT.md +3509 -4121
- package/documentation/platform/DISCOUNT.md +140 -236
- package/documentation/platform/FILESTORAGE.md +187 -323
- package/documentation/platform/INVENTORY.md +268 -911
- package/documentation/platform/LEAD.md +2195 -2541
- package/documentation/platform/ORDER.md +3750 -5636
- package/documentation/platform/PARTNER.md +9 -36
- package/documentation/platform/PAYMENT.md +903 -1213
- package/documentation/platform/REWARDS.md +183 -347
- package/documentation/platform/SHARE.md +120 -213
- package/documentation/platform/THEME.md +12956 -13239
- package/documentation/platform/USER.md +975 -1120
- package/documentation/platform/WEBHOOK.md +78 -184
- package/documentation/public/CONFIGURATION.md +95 -222
- package/documentation/public/INVENTORY.md +100 -282
- package/documentation/public/WEBHOOK.md +27 -133
- package/package.json +1 -1
- package/sdk/application/ApplicationConfig.js +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +1058 -547
- package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
- package/sdk/application/Cart/CartApplicationModel.js +489 -886
- package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
- package/sdk/application/Cart/CartApplicationValidator.js +98 -98
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
- package/sdk/application/Catalog/CatalogApplicationClient.js +1545 -949
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
- package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
- package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
- package/sdk/application/Common/CommonApplicationClient.js +76 -36
- package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
- package/sdk/application/Common/CommonApplicationModel.js +83 -160
- package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
- package/sdk/application/Common/CommonApplicationValidator.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
- package/sdk/application/Communication/CommunicationApplicationClient.js +92 -31
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +638 -312
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
- package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
- package/sdk/application/Content/ContentApplicationClient.js +581 -213
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
- package/sdk/application/Content/ContentApplicationModel.js +468 -875
- package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
- package/sdk/application/Content/ContentApplicationValidator.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +121 -59
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
- package/sdk/application/Lead/LeadApplicationClient.js +230 -96
- package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
- package/sdk/application/Lead/LeadApplicationModel.js +267 -474
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
- package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
- package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
- package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
- package/sdk/application/Order/OrderApplicationClient.js +448 -215
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +357 -661
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
- package/sdk/application/Order/OrderApplicationValidator.js +28 -28
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
- package/sdk/application/Payment/PaymentApplicationClient.js +1525 -750
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
- package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
- package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
- package/sdk/application/PosCart/PosCartApplicationClient.js +1137 -606
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
- package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
- package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.js +253 -113
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
- package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
- package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
- package/sdk/application/Share/ShareApplicationClient.js +221 -96
- package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
- package/sdk/application/Share/ShareApplicationModel.js +63 -123
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationValidator.js +12 -12
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +115 -37
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
- package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +280 -280
- package/sdk/application/User/UserApplicationClient.js +1201 -543
- package/sdk/application/User/UserApplicationModel.d.ts +79 -72
- package/sdk/application/User/UserApplicationModel.js +440 -689
- package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
- package/sdk/application/User/UserApplicationValidator.js +89 -89
- package/sdk/common/AxiosHelper.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
- package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
- package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
- package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
- package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
- package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
- package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
- package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
- package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
- package/sdk/platform/Common/CommonPlatformClient.js +80 -37
- package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformModel.js +83 -160
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
- package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
- package/sdk/platform/Content/ContentPlatformModel.js +486 -867
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
- package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
- package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
- package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
- package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
- package/sdk/platform/OAuthClient.js +8 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
- package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
- package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
- package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
- package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
- package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
- package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
- package/sdk/platform/PlatformApplicationClient.js +1584 -13691
- package/sdk/platform/PlatformClient.d.ts +7918 -7666
- package/sdk/platform/PlatformClient.js +8701 -9926
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
- package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
- package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
- package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
- package/sdk/platform/Share/SharePlatformModel.js +60 -118
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
- package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
- package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
- package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
- package/sdk/platform/User/UserPlatformModel.js +440 -689
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
- package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
- package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -38
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
- package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
- package/sdk/public/Inventory/InventoryPublicClient.js +228 -105
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
- package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
- package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
- package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/tests/application/catalog.spec.js +7 -0
|
@@ -9,18 +9,18 @@
|
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
* [cbsOnboardGet](#cbsonboardget)
|
|
12
|
-
* [updateCompany](#updatecompany)
|
|
13
|
-
* [getCompanyMetrics](#getcompanymetrics)
|
|
14
|
-
* [getBrand](#getbrand)
|
|
15
|
-
* [editBrand](#editbrand)
|
|
16
12
|
* [createBrand](#createbrand)
|
|
17
|
-
* [getBrands](#getbrands)
|
|
18
13
|
* [createCompanyBrandMapping](#createcompanybrandmapping)
|
|
19
|
-
* [getLocations](#getlocations)
|
|
20
14
|
* [createLocation](#createlocation)
|
|
15
|
+
* [createLocationBulk](#createlocationbulk)
|
|
16
|
+
* [editBrand](#editbrand)
|
|
17
|
+
* [getBrand](#getbrand)
|
|
18
|
+
* [getBrands](#getbrands)
|
|
19
|
+
* [getCompanyMetrics](#getcompanymetrics)
|
|
21
20
|
* [getLocationDetail](#getlocationdetail)
|
|
21
|
+
* [getLocations](#getlocations)
|
|
22
|
+
* [updateCompany](#updatecompany)
|
|
22
23
|
* [updateLocation](#updatelocation)
|
|
23
|
-
* [createLocationBulk](#createlocationbulk)
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -141,17 +141,17 @@ Company profile object. See example below or refer `GetCompanyProfileSerializerR
|
|
|
141
141
|
---
|
|
142
142
|
|
|
143
143
|
|
|
144
|
-
###
|
|
145
|
-
|
|
144
|
+
### createBrand
|
|
145
|
+
Create a Brand.
|
|
146
146
|
|
|
147
147
|
|
|
148
148
|
|
|
149
149
|
```javascript
|
|
150
150
|
// Promise
|
|
151
|
-
const promise = client.companyProfile.
|
|
151
|
+
const promise = client.companyProfile.createBrand({ body : value });
|
|
152
152
|
|
|
153
153
|
// Async/Await
|
|
154
|
-
const data = await client.companyProfile.
|
|
154
|
+
const data = await client.companyProfile.createBrand({ body : value });
|
|
155
155
|
```
|
|
156
156
|
|
|
157
157
|
|
|
@@ -160,10 +160,10 @@ const data = await client.companyProfile.updateCompany({ body : value });
|
|
|
160
160
|
|
|
161
161
|
| Argument | Type | Required | Description |
|
|
162
162
|
| --------- | ----- | -------- | ----------- |
|
|
163
|
-
| body | [
|
|
163
|
+
| body | [CreateUpdateBrandRequestSerializer](#CreateUpdateBrandRequestSerializer) | yes | Request body |
|
|
164
164
|
|
|
165
165
|
|
|
166
|
-
This API allows to
|
|
166
|
+
This API allows to create a brand associated to a company.
|
|
167
167
|
|
|
168
168
|
*Returned Response:*
|
|
169
169
|
|
|
@@ -172,7 +172,7 @@ This API allows to edit the company profile of the seller account.
|
|
|
172
172
|
|
|
173
173
|
[ProfileSuccessResponse](#ProfileSuccessResponse)
|
|
174
174
|
|
|
175
|
-
Returns a success
|
|
175
|
+
Returns a success response
|
|
176
176
|
|
|
177
177
|
|
|
178
178
|
|
|
@@ -199,34 +199,38 @@ Returns a success message
|
|
|
199
199
|
---
|
|
200
200
|
|
|
201
201
|
|
|
202
|
-
###
|
|
203
|
-
|
|
202
|
+
### createCompanyBrandMapping
|
|
203
|
+
Create a company brand mapping.
|
|
204
204
|
|
|
205
205
|
|
|
206
206
|
|
|
207
207
|
```javascript
|
|
208
208
|
// Promise
|
|
209
|
-
const promise = client.companyProfile.
|
|
209
|
+
const promise = client.companyProfile.createCompanyBrandMapping({ body : value });
|
|
210
210
|
|
|
211
211
|
// Async/Await
|
|
212
|
-
const data = await client.companyProfile.
|
|
212
|
+
const data = await client.companyProfile.createCompanyBrandMapping({ body : value });
|
|
213
213
|
```
|
|
214
214
|
|
|
215
215
|
|
|
216
216
|
|
|
217
217
|
|
|
218
218
|
|
|
219
|
+
| Argument | Type | Required | Description |
|
|
220
|
+
| --------- | ----- | -------- | ----------- |
|
|
221
|
+
| body | [CompanyBrandPostRequestSerializer](#CompanyBrandPostRequestSerializer) | yes | Request body |
|
|
219
222
|
|
|
220
|
-
|
|
223
|
+
|
|
224
|
+
This API allows to create a company brand mapping, for a already existing brand in the system.
|
|
221
225
|
|
|
222
226
|
*Returned Response:*
|
|
223
227
|
|
|
224
228
|
|
|
225
229
|
|
|
226
230
|
|
|
227
|
-
[
|
|
231
|
+
[ProfileSuccessResponse](#ProfileSuccessResponse)
|
|
228
232
|
|
|
229
|
-
|
|
233
|
+
Returns a success response
|
|
230
234
|
|
|
231
235
|
|
|
232
236
|
|
|
@@ -236,28 +240,7 @@ Metrics response object. See example below or refer `MetricsSerializer` for deta
|
|
|
236
240
|
|
|
237
241
|
```json
|
|
238
242
|
{
|
|
239
|
-
"
|
|
240
|
-
"stage": "complete",
|
|
241
|
-
"store": {
|
|
242
|
-
"verified": 1,
|
|
243
|
-
"pending": 1
|
|
244
|
-
},
|
|
245
|
-
"brand": {
|
|
246
|
-
"verified": 1,
|
|
247
|
-
"pending": 1
|
|
248
|
-
},
|
|
249
|
-
"product": {
|
|
250
|
-
"verified": 0,
|
|
251
|
-
"pending": 0
|
|
252
|
-
},
|
|
253
|
-
"company_documents": {
|
|
254
|
-
"verified": 1,
|
|
255
|
-
"pending": 0
|
|
256
|
-
},
|
|
257
|
-
"store_documents": {
|
|
258
|
-
"verified": 0,
|
|
259
|
-
"pending": 2
|
|
260
|
-
}
|
|
243
|
+
"success": true
|
|
261
244
|
}
|
|
262
245
|
```
|
|
263
246
|
</details>
|
|
@@ -273,17 +256,17 @@ Metrics response object. See example below or refer `MetricsSerializer` for deta
|
|
|
273
256
|
---
|
|
274
257
|
|
|
275
258
|
|
|
276
|
-
###
|
|
277
|
-
|
|
259
|
+
### createLocation
|
|
260
|
+
Create a location associated to a company.
|
|
278
261
|
|
|
279
262
|
|
|
280
263
|
|
|
281
264
|
```javascript
|
|
282
265
|
// Promise
|
|
283
|
-
const promise = client.companyProfile.
|
|
266
|
+
const promise = client.companyProfile.createLocation({ body : value });
|
|
284
267
|
|
|
285
268
|
// Async/Await
|
|
286
|
-
const data = await client.companyProfile.
|
|
269
|
+
const data = await client.companyProfile.createLocation({ body : value });
|
|
287
270
|
```
|
|
288
271
|
|
|
289
272
|
|
|
@@ -291,21 +274,20 @@ const data = await client.companyProfile.getBrand({ brandId : value });
|
|
|
291
274
|
|
|
292
275
|
|
|
293
276
|
| Argument | Type | Required | Description |
|
|
294
|
-
| --------- | ----- | -------- | ----------- |
|
|
295
|
-
|
|
|
296
|
-
|
|
277
|
+
| --------- | ----- | -------- | ----------- |
|
|
278
|
+
| body | [LocationSerializer](#LocationSerializer) | yes | Request body |
|
|
297
279
|
|
|
298
280
|
|
|
299
|
-
This API
|
|
281
|
+
This API allows to edit a location associated to a company.
|
|
300
282
|
|
|
301
283
|
*Returned Response:*
|
|
302
284
|
|
|
303
285
|
|
|
304
286
|
|
|
305
287
|
|
|
306
|
-
[
|
|
288
|
+
[ProfileSuccessResponse](#ProfileSuccessResponse)
|
|
307
289
|
|
|
308
|
-
|
|
290
|
+
Returns a success response
|
|
309
291
|
|
|
310
292
|
|
|
311
293
|
|
|
@@ -315,33 +297,66 @@ Brand object. See example below or refer `GetBrandResponseSerializer` for detail
|
|
|
315
297
|
|
|
316
298
|
```json
|
|
317
299
|
{
|
|
318
|
-
"stage": "verified",
|
|
319
|
-
"_custom_json": {},
|
|
320
300
|
"uid": 1,
|
|
321
|
-
"
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
301
|
+
"success": true
|
|
302
|
+
}
|
|
303
|
+
```
|
|
304
|
+
</details>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
---
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
### createLocationBulk
|
|
318
|
+
Create a location asscoiated to a company in bulk.
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
```javascript
|
|
323
|
+
// Promise
|
|
324
|
+
const promise = client.companyProfile.createLocationBulk({ body : value });
|
|
325
|
+
|
|
326
|
+
// Async/Await
|
|
327
|
+
const data = await client.companyProfile.createLocationBulk({ body : value });
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
| Argument | Type | Required | Description |
|
|
335
|
+
| --------- | ----- | -------- | ----------- |
|
|
336
|
+
| body | [BulkLocationSerializer](#BulkLocationSerializer) | yes | Request body |
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
This API allows to create a location associated to a company.
|
|
340
|
+
|
|
341
|
+
*Returned Response:*
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
[ProfileSuccessResponse](#ProfileSuccessResponse)
|
|
347
|
+
|
|
348
|
+
Returns a success response
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<details>
|
|
354
|
+
<summary><i> Example:</i></summary>
|
|
355
|
+
|
|
356
|
+
```json
|
|
357
|
+
{
|
|
358
|
+
"message": "10 stores inserted",
|
|
359
|
+
"success": true
|
|
345
360
|
}
|
|
346
361
|
```
|
|
347
362
|
</details>
|
|
@@ -418,17 +433,17 @@ Returns a success response
|
|
|
418
433
|
---
|
|
419
434
|
|
|
420
435
|
|
|
421
|
-
###
|
|
422
|
-
|
|
436
|
+
### getBrand
|
|
437
|
+
Get a single brand.
|
|
423
438
|
|
|
424
439
|
|
|
425
440
|
|
|
426
441
|
```javascript
|
|
427
442
|
// Promise
|
|
428
|
-
const promise = client.companyProfile.
|
|
443
|
+
const promise = client.companyProfile.getBrand({ brandId : value });
|
|
429
444
|
|
|
430
445
|
// Async/Await
|
|
431
|
-
const data = await client.companyProfile.
|
|
446
|
+
const data = await client.companyProfile.getBrand({ brandId : value });
|
|
432
447
|
```
|
|
433
448
|
|
|
434
449
|
|
|
@@ -436,20 +451,21 @@ const data = await client.companyProfile.createBrand({ body : value });
|
|
|
436
451
|
|
|
437
452
|
|
|
438
453
|
| Argument | Type | Required | Description |
|
|
439
|
-
| --------- | ----- | -------- | ----------- |
|
|
440
|
-
|
|
|
454
|
+
| --------- | ----- | -------- | ----------- |
|
|
455
|
+
| brandId | string | yes | Id of the brand to be viewed. |
|
|
441
456
|
|
|
442
457
|
|
|
443
|
-
|
|
458
|
+
|
|
459
|
+
This API helps to get data associated to a particular brand.
|
|
444
460
|
|
|
445
461
|
*Returned Response:*
|
|
446
462
|
|
|
447
463
|
|
|
448
464
|
|
|
449
465
|
|
|
450
|
-
[
|
|
466
|
+
[GetBrandResponseSerializer](#GetBrandResponseSerializer)
|
|
451
467
|
|
|
452
|
-
|
|
468
|
+
Brand object. See example below or refer `GetBrandResponseSerializer` for details
|
|
453
469
|
|
|
454
470
|
|
|
455
471
|
|
|
@@ -459,8 +475,33 @@ Returns a success response
|
|
|
459
475
|
|
|
460
476
|
```json
|
|
461
477
|
{
|
|
478
|
+
"stage": "verified",
|
|
479
|
+
"_custom_json": {},
|
|
462
480
|
"uid": 1,
|
|
463
|
-
"
|
|
481
|
+
"logo": "http://cdn4.gofynd.com/media/logo/brand/original/4597_40d1ce44d61940d4829a3c54951bd9ee.jpg",
|
|
482
|
+
"warnings": {},
|
|
483
|
+
"_locale_language": {},
|
|
484
|
+
"name": "edited brand",
|
|
485
|
+
"slug_key": "brand-2",
|
|
486
|
+
"banner": {
|
|
487
|
+
"portrait": "http://cdn4.gofynd.com/media/banner_portrait/brand/original/7021_16fc50205c40477daf419b64ec64c64c.jpg",
|
|
488
|
+
"landscape": "http://cdn4.gofynd.com/media/banner/brand/original/7020_f9e91f7d501c4f2985c09bd196ed304d.jpg"
|
|
489
|
+
},
|
|
490
|
+
"created_by": {
|
|
491
|
+
"username": "silverbolt",
|
|
492
|
+
"user_id": "0"
|
|
493
|
+
},
|
|
494
|
+
"modified_by": {
|
|
495
|
+
"username": "917827311650_22960",
|
|
496
|
+
"user_id": "123"
|
|
497
|
+
},
|
|
498
|
+
"verified_by": {
|
|
499
|
+
"username": "917827311650_22960",
|
|
500
|
+
"user_id": "123"
|
|
501
|
+
},
|
|
502
|
+
"synonyms": [
|
|
503
|
+
"xyz"
|
|
504
|
+
]
|
|
464
505
|
}
|
|
465
506
|
```
|
|
466
507
|
</details>
|
|
@@ -625,349 +666,34 @@ Brand object. See example below or refer `CompanyBrandListSerializer` for detail
|
|
|
625
666
|
---
|
|
626
667
|
|
|
627
668
|
|
|
628
|
-
###
|
|
629
|
-
|
|
669
|
+
### getCompanyMetrics
|
|
670
|
+
Get company metrics
|
|
630
671
|
|
|
631
672
|
|
|
632
673
|
|
|
633
674
|
```javascript
|
|
634
675
|
// Promise
|
|
635
|
-
const promise = client.companyProfile.
|
|
676
|
+
const promise = client.companyProfile.getCompanyMetrics();
|
|
636
677
|
|
|
637
678
|
// Async/Await
|
|
638
|
-
const data = await client.companyProfile.
|
|
679
|
+
const data = await client.companyProfile.getCompanyMetrics();
|
|
639
680
|
```
|
|
640
681
|
|
|
641
682
|
|
|
642
683
|
|
|
643
684
|
|
|
644
685
|
|
|
645
|
-
| Argument | Type | Required | Description |
|
|
646
|
-
| --------- | ----- | -------- | ----------- |
|
|
647
|
-
| body | [CompanyBrandPostRequestSerializer](#CompanyBrandPostRequestSerializer) | yes | Request body |
|
|
648
|
-
|
|
649
686
|
|
|
650
|
-
This API allows to
|
|
687
|
+
This API allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified.
|
|
651
688
|
|
|
652
689
|
*Returned Response:*
|
|
653
690
|
|
|
654
691
|
|
|
655
692
|
|
|
656
693
|
|
|
657
|
-
[
|
|
694
|
+
[MetricsSerializer](#MetricsSerializer)
|
|
658
695
|
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
<details>
|
|
665
|
-
<summary><i> Example:</i></summary>
|
|
666
|
-
|
|
667
|
-
```json
|
|
668
|
-
{
|
|
669
|
-
"success": true
|
|
670
|
-
}
|
|
671
|
-
```
|
|
672
|
-
</details>
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
---
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
### getLocations
|
|
686
|
-
Get list of locations
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
```javascript
|
|
691
|
-
// Promise
|
|
692
|
-
const promise = client.companyProfile.getLocations({ storeType : value,
|
|
693
|
-
q : value,
|
|
694
|
-
stage : value,
|
|
695
|
-
pageNo : value,
|
|
696
|
-
pageSize : value,
|
|
697
|
-
locationIds : value });
|
|
698
|
-
|
|
699
|
-
// Async/Await
|
|
700
|
-
const data = await client.companyProfile.getLocations({ storeType : value,
|
|
701
|
-
q : value,
|
|
702
|
-
stage : value,
|
|
703
|
-
pageNo : value,
|
|
704
|
-
pageSize : value,
|
|
705
|
-
locationIds : value });
|
|
706
|
-
```
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
| Argument | Type | Required | Description |
|
|
713
|
-
| --------- | ----- | -------- | ----------- |
|
|
714
|
-
| storeType | string | no | Helps to sort the location list on the basis of location type. |
|
|
715
|
-
| q | string | no | Query that is to be searched. |
|
|
716
|
-
| stage | string | no | to filter companies on basis of verified or unverified companies. |
|
|
717
|
-
| pageNo | number | no | The page number to navigate through the given set of results |
|
|
718
|
-
| pageSize | number | no | Number of items to retrieve in each page. Default is 10. |
|
|
719
|
-
| locationIds | Array<number> | no | Helps to filter stores on the basis of uids. |
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
This API allows to view all the locations associated to a company.
|
|
724
|
-
|
|
725
|
-
*Returned Response:*
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
[LocationListSerializer](#LocationListSerializer)
|
|
731
|
-
|
|
732
|
-
Company profile object. See example below or refer `LocationListSerializer` for details
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
<details>
|
|
738
|
-
<summary><i> Example:</i></summary>
|
|
739
|
-
|
|
740
|
-
```json
|
|
741
|
-
{
|
|
742
|
-
"items": [
|
|
743
|
-
{
|
|
744
|
-
"company": {
|
|
745
|
-
"business_type": "huf",
|
|
746
|
-
"stage": "complete",
|
|
747
|
-
"uid": 1,
|
|
748
|
-
"addresses": [
|
|
749
|
-
{
|
|
750
|
-
"city": "Mumbai Suburban",
|
|
751
|
-
"latitude": 19.058461,
|
|
752
|
-
"longitude": 72.871395,
|
|
753
|
-
"address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
|
|
754
|
-
"country_code": "IN",
|
|
755
|
-
"state": "Maharashtra",
|
|
756
|
-
"country": "India",
|
|
757
|
-
"pincode": 400070,
|
|
758
|
-
"address_type": "office"
|
|
759
|
-
},
|
|
760
|
-
{
|
|
761
|
-
"city": "Mumbai Suburban",
|
|
762
|
-
"latitude": 19.058461,
|
|
763
|
-
"longitude": 72.871395,
|
|
764
|
-
"address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
|
|
765
|
-
"country_code": "IN",
|
|
766
|
-
"state": "Maharashtra",
|
|
767
|
-
"country": "India",
|
|
768
|
-
"pincode": 400070,
|
|
769
|
-
"address_type": "registered"
|
|
770
|
-
}
|
|
771
|
-
],
|
|
772
|
-
"modified_by": {
|
|
773
|
-
"user_id": "-1",
|
|
774
|
-
"username": "silverbolt"
|
|
775
|
-
},
|
|
776
|
-
"company_type": "mbo",
|
|
777
|
-
"created_on": "2021-02-25T15:21:51.526000+00:00",
|
|
778
|
-
"created_by": {
|
|
779
|
-
"user_id": "123",
|
|
780
|
-
"username": "917827311650_22960"
|
|
781
|
-
},
|
|
782
|
-
"modified_on": "2021-02-25T17:44:55.722000+00:00",
|
|
783
|
-
"name": "Cache Company"
|
|
784
|
-
},
|
|
785
|
-
"address": {
|
|
786
|
-
"city": "MUMBAI",
|
|
787
|
-
"latitude": 19.4232024,
|
|
788
|
-
"longitude": 72.8231511,
|
|
789
|
-
"address1": "A/204, SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD",
|
|
790
|
-
"state": "MAHARASHTRA",
|
|
791
|
-
"country": "INDIA",
|
|
792
|
-
"pincode": 401209
|
|
793
|
-
},
|
|
794
|
-
"timing": [
|
|
795
|
-
{
|
|
796
|
-
"closing": {
|
|
797
|
-
"minute": 0,
|
|
798
|
-
"hour": 22
|
|
799
|
-
},
|
|
800
|
-
"opening": {
|
|
801
|
-
"minute": 0,
|
|
802
|
-
"hour": 11
|
|
803
|
-
},
|
|
804
|
-
"open": true,
|
|
805
|
-
"weekday": "monday"
|
|
806
|
-
},
|
|
807
|
-
{
|
|
808
|
-
"closing": {
|
|
809
|
-
"minute": 0,
|
|
810
|
-
"hour": 22
|
|
811
|
-
},
|
|
812
|
-
"opening": {
|
|
813
|
-
"minute": 0,
|
|
814
|
-
"hour": 11
|
|
815
|
-
},
|
|
816
|
-
"open": true,
|
|
817
|
-
"weekday": "tuesday"
|
|
818
|
-
},
|
|
819
|
-
{
|
|
820
|
-
"closing": {
|
|
821
|
-
"minute": 0,
|
|
822
|
-
"hour": 22
|
|
823
|
-
},
|
|
824
|
-
"opening": {
|
|
825
|
-
"minute": 0,
|
|
826
|
-
"hour": 11
|
|
827
|
-
},
|
|
828
|
-
"open": true,
|
|
829
|
-
"weekday": "wednesday"
|
|
830
|
-
},
|
|
831
|
-
{
|
|
832
|
-
"closing": {
|
|
833
|
-
"minute": 0,
|
|
834
|
-
"hour": 22
|
|
835
|
-
},
|
|
836
|
-
"opening": {
|
|
837
|
-
"minute": 0,
|
|
838
|
-
"hour": 11
|
|
839
|
-
},
|
|
840
|
-
"open": true,
|
|
841
|
-
"weekday": "thursday"
|
|
842
|
-
},
|
|
843
|
-
{
|
|
844
|
-
"closing": {
|
|
845
|
-
"minute": 0,
|
|
846
|
-
"hour": 22
|
|
847
|
-
},
|
|
848
|
-
"opening": {
|
|
849
|
-
"minute": 0,
|
|
850
|
-
"hour": 11
|
|
851
|
-
},
|
|
852
|
-
"open": true,
|
|
853
|
-
"weekday": "friday"
|
|
854
|
-
},
|
|
855
|
-
{
|
|
856
|
-
"closing": {
|
|
857
|
-
"minute": 0,
|
|
858
|
-
"hour": 22
|
|
859
|
-
},
|
|
860
|
-
"opening": {
|
|
861
|
-
"minute": 0,
|
|
862
|
-
"hour": 11
|
|
863
|
-
},
|
|
864
|
-
"open": true,
|
|
865
|
-
"weekday": "saturday"
|
|
866
|
-
},
|
|
867
|
-
{
|
|
868
|
-
"closing": {
|
|
869
|
-
"minute": 0,
|
|
870
|
-
"hour": 22
|
|
871
|
-
},
|
|
872
|
-
"opening": {
|
|
873
|
-
"minute": 0,
|
|
874
|
-
"hour": 11
|
|
875
|
-
},
|
|
876
|
-
"open": true,
|
|
877
|
-
"weekday": "sunday"
|
|
878
|
-
}
|
|
879
|
-
],
|
|
880
|
-
"documents": [],
|
|
881
|
-
"display_name": "new store",
|
|
882
|
-
"manager": {
|
|
883
|
-
"name": "Yrf",
|
|
884
|
-
"mobile_no": {
|
|
885
|
-
"country_code": 91,
|
|
886
|
-
"number": "83456774567"
|
|
887
|
-
},
|
|
888
|
-
"email": "gbp@jkl.com"
|
|
889
|
-
},
|
|
890
|
-
"code": "code2",
|
|
891
|
-
"product_return_config": {
|
|
892
|
-
"on_same_store": true
|
|
893
|
-
},
|
|
894
|
-
"created_on": "2021-02-25T15:22:04.913000+00:00",
|
|
895
|
-
"created_by": {
|
|
896
|
-
"user_id": "123",
|
|
897
|
-
"username": "917827311650_22960"
|
|
898
|
-
},
|
|
899
|
-
"name": "location2",
|
|
900
|
-
"gst_credentials": {
|
|
901
|
-
"e_invoice": {
|
|
902
|
-
"enabled": false
|
|
903
|
-
}
|
|
904
|
-
},
|
|
905
|
-
"store_type": "high_street",
|
|
906
|
-
"contact_numbers": [
|
|
907
|
-
{
|
|
908
|
-
"country_code": 91,
|
|
909
|
-
"number": "7208229698"
|
|
910
|
-
}
|
|
911
|
-
],
|
|
912
|
-
"stage": "complete",
|
|
913
|
-
"uid": 2,
|
|
914
|
-
"notification_emails": []
|
|
915
|
-
}
|
|
916
|
-
],
|
|
917
|
-
"page": {
|
|
918
|
-
"current": 1,
|
|
919
|
-
"size": 1,
|
|
920
|
-
"has_previous": false,
|
|
921
|
-
"has_next": false,
|
|
922
|
-
"item_count": 1
|
|
923
|
-
}
|
|
924
|
-
}
|
|
925
|
-
```
|
|
926
|
-
</details>
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
---
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
### createLocation
|
|
940
|
-
Create a location associated to a company.
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
```javascript
|
|
945
|
-
// Promise
|
|
946
|
-
const promise = client.companyProfile.createLocation({ body : value });
|
|
947
|
-
|
|
948
|
-
// Async/Await
|
|
949
|
-
const data = await client.companyProfile.createLocation({ body : value });
|
|
950
|
-
```
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
| Argument | Type | Required | Description |
|
|
957
|
-
| --------- | ----- | -------- | ----------- |
|
|
958
|
-
| body | [LocationSerializer](#LocationSerializer) | yes | Request body |
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
This API allows to edit a location associated to a company.
|
|
962
|
-
|
|
963
|
-
*Returned Response:*
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
[ProfileSuccessResponse](#ProfileSuccessResponse)
|
|
969
|
-
|
|
970
|
-
Returns a success response
|
|
696
|
+
Metrics response object. See example below or refer `MetricsSerializer` for details
|
|
971
697
|
|
|
972
698
|
|
|
973
699
|
|
|
@@ -978,7 +704,27 @@ Returns a success response
|
|
|
978
704
|
```json
|
|
979
705
|
{
|
|
980
706
|
"uid": 1,
|
|
981
|
-
"
|
|
707
|
+
"stage": "complete",
|
|
708
|
+
"store": {
|
|
709
|
+
"verified": 1,
|
|
710
|
+
"pending": 1
|
|
711
|
+
},
|
|
712
|
+
"brand": {
|
|
713
|
+
"verified": 1,
|
|
714
|
+
"pending": 1
|
|
715
|
+
},
|
|
716
|
+
"product": {
|
|
717
|
+
"verified": 0,
|
|
718
|
+
"pending": 0
|
|
719
|
+
},
|
|
720
|
+
"company_documents": {
|
|
721
|
+
"verified": 1,
|
|
722
|
+
"pending": 0
|
|
723
|
+
},
|
|
724
|
+
"store_documents": {
|
|
725
|
+
"verified": 0,
|
|
726
|
+
"pending": 2
|
|
727
|
+
}
|
|
982
728
|
}
|
|
983
729
|
```
|
|
984
730
|
</details>
|
|
@@ -1153,69 +899,323 @@ Brand object. See example below or refer `GetLocationSerializer` for details
|
|
|
1153
899
|
"minute": 0,
|
|
1154
900
|
"hour": 22
|
|
1155
901
|
},
|
|
1156
|
-
"opening": {
|
|
1157
|
-
"minute": 0,
|
|
1158
|
-
"hour": 11
|
|
902
|
+
"opening": {
|
|
903
|
+
"minute": 0,
|
|
904
|
+
"hour": 11
|
|
905
|
+
},
|
|
906
|
+
"open": true,
|
|
907
|
+
"weekday": "saturday"
|
|
908
|
+
},
|
|
909
|
+
{
|
|
910
|
+
"closing": {
|
|
911
|
+
"minute": 0,
|
|
912
|
+
"hour": 22
|
|
913
|
+
},
|
|
914
|
+
"opening": {
|
|
915
|
+
"minute": 0,
|
|
916
|
+
"hour": 11
|
|
917
|
+
},
|
|
918
|
+
"open": true,
|
|
919
|
+
"weekday": "sunday"
|
|
920
|
+
}
|
|
921
|
+
],
|
|
922
|
+
"documents": [],
|
|
923
|
+
"warnings": {},
|
|
924
|
+
"display_name": "new store",
|
|
925
|
+
"manager": {
|
|
926
|
+
"name": "Yrf",
|
|
927
|
+
"mobile_no": {
|
|
928
|
+
"country_code": 91,
|
|
929
|
+
"number": "83456774567"
|
|
930
|
+
},
|
|
931
|
+
"email": "gbp@jkl.com"
|
|
932
|
+
},
|
|
933
|
+
"code": "store1",
|
|
934
|
+
"product_return_config": {
|
|
935
|
+
"on_same_store": true
|
|
936
|
+
},
|
|
937
|
+
"modified_by": {
|
|
938
|
+
"user_id": "-1",
|
|
939
|
+
"username": "silverbolt"
|
|
940
|
+
},
|
|
941
|
+
"created_by": {
|
|
942
|
+
"user_id": "123",
|
|
943
|
+
"username": "917827311650_22960"
|
|
944
|
+
},
|
|
945
|
+
"name": "edited_store",
|
|
946
|
+
"gst_credentials": {
|
|
947
|
+
"e_invoice": {
|
|
948
|
+
"enabled": false
|
|
949
|
+
}
|
|
950
|
+
},
|
|
951
|
+
"verified_by": {
|
|
952
|
+
"user_id": "-1",
|
|
953
|
+
"username": "silverbolt"
|
|
954
|
+
},
|
|
955
|
+
"store_type": "high_street",
|
|
956
|
+
"contact_numbers": [
|
|
957
|
+
{
|
|
958
|
+
"country_code": 91,
|
|
959
|
+
"number": "7208229698"
|
|
960
|
+
}
|
|
961
|
+
],
|
|
962
|
+
"stage": "verified",
|
|
963
|
+
"uid": 1,
|
|
964
|
+
"notification_emails": []
|
|
965
|
+
}
|
|
966
|
+
```
|
|
967
|
+
</details>
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
---
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
### getLocations
|
|
981
|
+
Get list of locations
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
```javascript
|
|
986
|
+
// Promise
|
|
987
|
+
const promise = client.companyProfile.getLocations({ storeType : value,
|
|
988
|
+
q : value,
|
|
989
|
+
stage : value,
|
|
990
|
+
pageNo : value,
|
|
991
|
+
pageSize : value,
|
|
992
|
+
locationIds : value });
|
|
993
|
+
|
|
994
|
+
// Async/Await
|
|
995
|
+
const data = await client.companyProfile.getLocations({ storeType : value,
|
|
996
|
+
q : value,
|
|
997
|
+
stage : value,
|
|
998
|
+
pageNo : value,
|
|
999
|
+
pageSize : value,
|
|
1000
|
+
locationIds : value });
|
|
1001
|
+
```
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
| Argument | Type | Required | Description |
|
|
1008
|
+
| --------- | ----- | -------- | ----------- |
|
|
1009
|
+
| storeType | string | no | Helps to sort the location list on the basis of location type. |
|
|
1010
|
+
| q | string | no | Query that is to be searched. |
|
|
1011
|
+
| stage | string | no | to filter companies on basis of verified or unverified companies. |
|
|
1012
|
+
| pageNo | number | no | The page number to navigate through the given set of results |
|
|
1013
|
+
| pageSize | number | no | Number of items to retrieve in each page. Default is 10. |
|
|
1014
|
+
| locationIds | Array<number> | no | Helps to filter stores on the basis of uids. |
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
This API allows to view all the locations associated to a company.
|
|
1019
|
+
|
|
1020
|
+
*Returned Response:*
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
[LocationListSerializer](#LocationListSerializer)
|
|
1026
|
+
|
|
1027
|
+
Company profile object. See example below or refer `LocationListSerializer` for details
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
<details>
|
|
1033
|
+
<summary><i> Example:</i></summary>
|
|
1034
|
+
|
|
1035
|
+
```json
|
|
1036
|
+
{
|
|
1037
|
+
"items": [
|
|
1038
|
+
{
|
|
1039
|
+
"company": {
|
|
1040
|
+
"business_type": "huf",
|
|
1041
|
+
"stage": "complete",
|
|
1042
|
+
"uid": 1,
|
|
1043
|
+
"addresses": [
|
|
1044
|
+
{
|
|
1045
|
+
"city": "Mumbai Suburban",
|
|
1046
|
+
"latitude": 19.058461,
|
|
1047
|
+
"longitude": 72.871395,
|
|
1048
|
+
"address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
|
|
1049
|
+
"country_code": "IN",
|
|
1050
|
+
"state": "Maharashtra",
|
|
1051
|
+
"country": "India",
|
|
1052
|
+
"pincode": 400070,
|
|
1053
|
+
"address_type": "office"
|
|
1054
|
+
},
|
|
1055
|
+
{
|
|
1056
|
+
"city": "Mumbai Suburban",
|
|
1057
|
+
"latitude": 19.058461,
|
|
1058
|
+
"longitude": 72.871395,
|
|
1059
|
+
"address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
|
|
1060
|
+
"country_code": "IN",
|
|
1061
|
+
"state": "Maharashtra",
|
|
1062
|
+
"country": "India",
|
|
1063
|
+
"pincode": 400070,
|
|
1064
|
+
"address_type": "registered"
|
|
1065
|
+
}
|
|
1066
|
+
],
|
|
1067
|
+
"modified_by": {
|
|
1068
|
+
"user_id": "-1",
|
|
1069
|
+
"username": "silverbolt"
|
|
1070
|
+
},
|
|
1071
|
+
"company_type": "mbo",
|
|
1072
|
+
"created_on": "2021-02-25T15:21:51.526000+00:00",
|
|
1073
|
+
"created_by": {
|
|
1074
|
+
"user_id": "123",
|
|
1075
|
+
"username": "917827311650_22960"
|
|
1076
|
+
},
|
|
1077
|
+
"modified_on": "2021-02-25T17:44:55.722000+00:00",
|
|
1078
|
+
"name": "Cache Company"
|
|
1079
|
+
},
|
|
1080
|
+
"address": {
|
|
1081
|
+
"city": "MUMBAI",
|
|
1082
|
+
"latitude": 19.4232024,
|
|
1083
|
+
"longitude": 72.8231511,
|
|
1084
|
+
"address1": "A/204, SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD",
|
|
1085
|
+
"state": "MAHARASHTRA",
|
|
1086
|
+
"country": "INDIA",
|
|
1087
|
+
"pincode": 401209
|
|
1088
|
+
},
|
|
1089
|
+
"timing": [
|
|
1090
|
+
{
|
|
1091
|
+
"closing": {
|
|
1092
|
+
"minute": 0,
|
|
1093
|
+
"hour": 22
|
|
1094
|
+
},
|
|
1095
|
+
"opening": {
|
|
1096
|
+
"minute": 0,
|
|
1097
|
+
"hour": 11
|
|
1098
|
+
},
|
|
1099
|
+
"open": true,
|
|
1100
|
+
"weekday": "monday"
|
|
1101
|
+
},
|
|
1102
|
+
{
|
|
1103
|
+
"closing": {
|
|
1104
|
+
"minute": 0,
|
|
1105
|
+
"hour": 22
|
|
1106
|
+
},
|
|
1107
|
+
"opening": {
|
|
1108
|
+
"minute": 0,
|
|
1109
|
+
"hour": 11
|
|
1110
|
+
},
|
|
1111
|
+
"open": true,
|
|
1112
|
+
"weekday": "tuesday"
|
|
1113
|
+
},
|
|
1114
|
+
{
|
|
1115
|
+
"closing": {
|
|
1116
|
+
"minute": 0,
|
|
1117
|
+
"hour": 22
|
|
1118
|
+
},
|
|
1119
|
+
"opening": {
|
|
1120
|
+
"minute": 0,
|
|
1121
|
+
"hour": 11
|
|
1122
|
+
},
|
|
1123
|
+
"open": true,
|
|
1124
|
+
"weekday": "wednesday"
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
"closing": {
|
|
1128
|
+
"minute": 0,
|
|
1129
|
+
"hour": 22
|
|
1130
|
+
},
|
|
1131
|
+
"opening": {
|
|
1132
|
+
"minute": 0,
|
|
1133
|
+
"hour": 11
|
|
1134
|
+
},
|
|
1135
|
+
"open": true,
|
|
1136
|
+
"weekday": "thursday"
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"closing": {
|
|
1140
|
+
"minute": 0,
|
|
1141
|
+
"hour": 22
|
|
1142
|
+
},
|
|
1143
|
+
"opening": {
|
|
1144
|
+
"minute": 0,
|
|
1145
|
+
"hour": 11
|
|
1146
|
+
},
|
|
1147
|
+
"open": true,
|
|
1148
|
+
"weekday": "friday"
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"closing": {
|
|
1152
|
+
"minute": 0,
|
|
1153
|
+
"hour": 22
|
|
1154
|
+
},
|
|
1155
|
+
"opening": {
|
|
1156
|
+
"minute": 0,
|
|
1157
|
+
"hour": 11
|
|
1158
|
+
},
|
|
1159
|
+
"open": true,
|
|
1160
|
+
"weekday": "saturday"
|
|
1161
|
+
},
|
|
1162
|
+
{
|
|
1163
|
+
"closing": {
|
|
1164
|
+
"minute": 0,
|
|
1165
|
+
"hour": 22
|
|
1166
|
+
},
|
|
1167
|
+
"opening": {
|
|
1168
|
+
"minute": 0,
|
|
1169
|
+
"hour": 11
|
|
1170
|
+
},
|
|
1171
|
+
"open": true,
|
|
1172
|
+
"weekday": "sunday"
|
|
1173
|
+
}
|
|
1174
|
+
],
|
|
1175
|
+
"documents": [],
|
|
1176
|
+
"display_name": "new store",
|
|
1177
|
+
"manager": {
|
|
1178
|
+
"name": "Yrf",
|
|
1179
|
+
"mobile_no": {
|
|
1180
|
+
"country_code": 91,
|
|
1181
|
+
"number": "83456774567"
|
|
1182
|
+
},
|
|
1183
|
+
"email": "gbp@jkl.com"
|
|
1184
|
+
},
|
|
1185
|
+
"code": "code2",
|
|
1186
|
+
"product_return_config": {
|
|
1187
|
+
"on_same_store": true
|
|
1159
1188
|
},
|
|
1160
|
-
"
|
|
1161
|
-
"
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
"closing": {
|
|
1165
|
-
"minute": 0,
|
|
1166
|
-
"hour": 22
|
|
1189
|
+
"created_on": "2021-02-25T15:22:04.913000+00:00",
|
|
1190
|
+
"created_by": {
|
|
1191
|
+
"user_id": "123",
|
|
1192
|
+
"username": "917827311650_22960"
|
|
1167
1193
|
},
|
|
1168
|
-
"
|
|
1169
|
-
|
|
1170
|
-
"
|
|
1194
|
+
"name": "location2",
|
|
1195
|
+
"gst_credentials": {
|
|
1196
|
+
"e_invoice": {
|
|
1197
|
+
"enabled": false
|
|
1198
|
+
}
|
|
1171
1199
|
},
|
|
1172
|
-
"
|
|
1173
|
-
"
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
"country_code": 91,
|
|
1183
|
-
"number": "83456774567"
|
|
1184
|
-
},
|
|
1185
|
-
"email": "gbp@jkl.com"
|
|
1186
|
-
},
|
|
1187
|
-
"code": "store1",
|
|
1188
|
-
"product_return_config": {
|
|
1189
|
-
"on_same_store": true
|
|
1190
|
-
},
|
|
1191
|
-
"modified_by": {
|
|
1192
|
-
"user_id": "-1",
|
|
1193
|
-
"username": "silverbolt"
|
|
1194
|
-
},
|
|
1195
|
-
"created_by": {
|
|
1196
|
-
"user_id": "123",
|
|
1197
|
-
"username": "917827311650_22960"
|
|
1198
|
-
},
|
|
1199
|
-
"name": "edited_store",
|
|
1200
|
-
"gst_credentials": {
|
|
1201
|
-
"e_invoice": {
|
|
1202
|
-
"enabled": false
|
|
1203
|
-
}
|
|
1204
|
-
},
|
|
1205
|
-
"verified_by": {
|
|
1206
|
-
"user_id": "-1",
|
|
1207
|
-
"username": "silverbolt"
|
|
1208
|
-
},
|
|
1209
|
-
"store_type": "high_street",
|
|
1210
|
-
"contact_numbers": [
|
|
1211
|
-
{
|
|
1212
|
-
"country_code": 91,
|
|
1213
|
-
"number": "7208229698"
|
|
1200
|
+
"store_type": "high_street",
|
|
1201
|
+
"contact_numbers": [
|
|
1202
|
+
{
|
|
1203
|
+
"country_code": 91,
|
|
1204
|
+
"number": "7208229698"
|
|
1205
|
+
}
|
|
1206
|
+
],
|
|
1207
|
+
"stage": "complete",
|
|
1208
|
+
"uid": 2,
|
|
1209
|
+
"notification_emails": []
|
|
1214
1210
|
}
|
|
1215
1211
|
],
|
|
1216
|
-
"
|
|
1217
|
-
|
|
1218
|
-
|
|
1212
|
+
"page": {
|
|
1213
|
+
"current": 1,
|
|
1214
|
+
"size": 1,
|
|
1215
|
+
"has_previous": false,
|
|
1216
|
+
"has_next": false,
|
|
1217
|
+
"item_count": 1
|
|
1218
|
+
}
|
|
1219
1219
|
}
|
|
1220
1220
|
```
|
|
1221
1221
|
</details>
|
|
@@ -1231,19 +1231,17 @@ Brand object. See example below or refer `GetLocationSerializer` for details
|
|
|
1231
1231
|
---
|
|
1232
1232
|
|
|
1233
1233
|
|
|
1234
|
-
###
|
|
1235
|
-
Edit
|
|
1234
|
+
### updateCompany
|
|
1235
|
+
Edit company profile
|
|
1236
1236
|
|
|
1237
1237
|
|
|
1238
1238
|
|
|
1239
1239
|
```javascript
|
|
1240
1240
|
// Promise
|
|
1241
|
-
const promise = client.companyProfile.
|
|
1242
|
-
body : value });
|
|
1241
|
+
const promise = client.companyProfile.updateCompany({ body : value });
|
|
1243
1242
|
|
|
1244
1243
|
// Async/Await
|
|
1245
|
-
const data = await client.companyProfile.
|
|
1246
|
-
body : value });
|
|
1244
|
+
const data = await client.companyProfile.updateCompany({ body : value });
|
|
1247
1245
|
```
|
|
1248
1246
|
|
|
1249
1247
|
|
|
@@ -1251,12 +1249,11 @@ const data = await client.companyProfile.updateLocation({ locationId : value,
|
|
|
1251
1249
|
|
|
1252
1250
|
|
|
1253
1251
|
| Argument | Type | Required | Description |
|
|
1254
|
-
| --------- | ----- | -------- | ----------- |
|
|
1255
|
-
|
|
|
1256
|
-
| body | [LocationSerializer](#LocationSerializer) | yes | Request body |
|
|
1252
|
+
| --------- | ----- | -------- | ----------- |
|
|
1253
|
+
| body | [UpdateCompany](#UpdateCompany) | yes | Request body |
|
|
1257
1254
|
|
|
1258
1255
|
|
|
1259
|
-
This API allows to edit
|
|
1256
|
+
This API allows to edit the company profile of the seller account.
|
|
1260
1257
|
|
|
1261
1258
|
*Returned Response:*
|
|
1262
1259
|
|
|
@@ -1265,7 +1262,7 @@ This API allows to edit a location associated to a company.
|
|
|
1265
1262
|
|
|
1266
1263
|
[ProfileSuccessResponse](#ProfileSuccessResponse)
|
|
1267
1264
|
|
|
1268
|
-
Returns a success
|
|
1265
|
+
Returns a success message
|
|
1269
1266
|
|
|
1270
1267
|
|
|
1271
1268
|
|
|
@@ -1292,17 +1289,19 @@ Returns a success response
|
|
|
1292
1289
|
---
|
|
1293
1290
|
|
|
1294
1291
|
|
|
1295
|
-
###
|
|
1296
|
-
|
|
1292
|
+
### updateLocation
|
|
1293
|
+
Edit a location asscoiated to a company.
|
|
1297
1294
|
|
|
1298
1295
|
|
|
1299
1296
|
|
|
1300
1297
|
```javascript
|
|
1301
1298
|
// Promise
|
|
1302
|
-
const promise = client.companyProfile.
|
|
1299
|
+
const promise = client.companyProfile.updateLocation({ locationId : value,
|
|
1300
|
+
body : value });
|
|
1303
1301
|
|
|
1304
1302
|
// Async/Await
|
|
1305
|
-
const data = await client.companyProfile.
|
|
1303
|
+
const data = await client.companyProfile.updateLocation({ locationId : value,
|
|
1304
|
+
body : value });
|
|
1306
1305
|
```
|
|
1307
1306
|
|
|
1308
1307
|
|
|
@@ -1310,11 +1309,12 @@ const data = await client.companyProfile.createLocationBulk({ body : value });
|
|
|
1310
1309
|
|
|
1311
1310
|
|
|
1312
1311
|
| Argument | Type | Required | Description |
|
|
1313
|
-
| --------- | ----- | -------- | ----------- |
|
|
1314
|
-
|
|
|
1312
|
+
| --------- | ----- | -------- | ----------- |
|
|
1313
|
+
| locationId | string | yes | Id of the location which you want to edit. |
|
|
1314
|
+
| body | [LocationSerializer](#LocationSerializer) | yes | Request body |
|
|
1315
1315
|
|
|
1316
1316
|
|
|
1317
|
-
This API allows to
|
|
1317
|
+
This API allows to edit a location associated to a company.
|
|
1318
1318
|
|
|
1319
1319
|
*Returned Response:*
|
|
1320
1320
|
|
|
@@ -1333,7 +1333,7 @@ Returns a success response
|
|
|
1333
1333
|
|
|
1334
1334
|
```json
|
|
1335
1335
|
{
|
|
1336
|
-
"
|
|
1336
|
+
"uid": 1,
|
|
1337
1337
|
"success": true
|
|
1338
1338
|
}
|
|
1339
1339
|
```
|
|
@@ -1353,676 +1353,291 @@ Returns a success response
|
|
|
1353
1353
|
|
|
1354
1354
|
### Schemas
|
|
1355
1355
|
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
#### [BusinessCountryInfo](#BusinessCountryInfo)
|
|
1356
|
+
|
|
1357
|
+
#### [AddressSerializer](#AddressSerializer)
|
|
1359
1358
|
|
|
1360
1359
|
| Properties | Type | Nullable | Description |
|
|
1361
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1362
|
-
| country_code | string | no | |
|
|
1363
|
-
| country | string | no | |
|
|
1360
|
+
| ---------- | ---- | -------- | ----------- || address1 | string | no | || address2 | string | no | || address_type | string | no | || city | string | no | || country | string | no | || country_code | string | no | || landmark | string | no | || latitude | number | yes | || longitude | number | yes | || pincode | number | no | || state | string | no | |
|
|
1364
1361
|
|
|
1365
1362
|
---
|
|
1366
1363
|
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
#### [SellerPhoneNumber](#SellerPhoneNumber)
|
|
1364
|
+
#### [BrandBannerSerializer](#BrandBannerSerializer)
|
|
1371
1365
|
|
|
1372
1366
|
| Properties | Type | Nullable | Description |
|
|
1373
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1374
|
-
| number | string | yes | |
|
|
1375
|
-
| country_code | number | yes | |
|
|
1367
|
+
| ---------- | ---- | -------- | ----------- || landscape | string | no | || portrait | string | no | |
|
|
1376
1368
|
|
|
1377
1369
|
---
|
|
1378
1370
|
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
#### [ContactDetails](#ContactDetails)
|
|
1371
|
+
#### [BulkLocationSerializer](#BulkLocationSerializer)
|
|
1383
1372
|
|
|
1384
1373
|
| Properties | Type | Nullable | Description |
|
|
1385
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1386
|
-
| emails | [string] | no | |
|
|
1387
|
-
| phone | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
|
|
1374
|
+
| ---------- | ---- | -------- | ----------- || data | [[LocationSerializer](#LocationSerializer)] | no | |
|
|
1388
1375
|
|
|
1389
1376
|
---
|
|
1390
1377
|
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
#### [UserSerializer](#UserSerializer)
|
|
1378
|
+
#### [BusinessCountryInfo](#BusinessCountryInfo)
|
|
1395
1379
|
|
|
1396
1380
|
| Properties | Type | Nullable | Description |
|
|
1397
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1398
|
-
| user_id | string | no | |
|
|
1399
|
-
| contact | string | no | |
|
|
1400
|
-
| username | string | no | |
|
|
1381
|
+
| ---------- | ---- | -------- | ----------- || country | string | no | || country_code | string | no | |
|
|
1401
1382
|
|
|
1402
1383
|
---
|
|
1403
1384
|
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
|
-
#### [Website](#Website)
|
|
1385
|
+
#### [BusinessDetails](#BusinessDetails)
|
|
1408
1386
|
|
|
1409
1387
|
| Properties | Type | Nullable | Description |
|
|
1410
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1411
|
-
| url | string | no | |
|
|
1388
|
+
| ---------- | ---- | -------- | ----------- || website | [Website](#Website) | no | |
|
|
1412
1389
|
|
|
1413
1390
|
---
|
|
1414
1391
|
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
#### [BusinessDetails](#BusinessDetails)
|
|
1392
|
+
#### [CompanyBrandListSerializer](#CompanyBrandListSerializer)
|
|
1419
1393
|
|
|
1420
1394
|
| Properties | Type | Nullable | Description |
|
|
1421
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1422
|
-
| website | [Website](#Website) | no | |
|
|
1395
|
+
| ---------- | ---- | -------- | ----------- || items | [[CompanyBrandSerializer](#CompanyBrandSerializer)] | no | || page | [Page](#Page) | no | |
|
|
1423
1396
|
|
|
1424
1397
|
---
|
|
1425
1398
|
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
#### [GetAddressSerializer](#GetAddressSerializer)
|
|
1399
|
+
#### [CompanyBrandPostRequestSerializer](#CompanyBrandPostRequestSerializer)
|
|
1430
1400
|
|
|
1431
1401
|
| Properties | Type | Nullable | Description |
|
|
1432
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1433
|
-
| country_code | string | no | |
|
|
1434
|
-
| country | string | no | |
|
|
1435
|
-
| pincode | number | no | |
|
|
1436
|
-
| state | string | no | |
|
|
1437
|
-
| landmark | string | no | |
|
|
1438
|
-
| address_type | string | no | |
|
|
1439
|
-
| longitude | number | yes | |
|
|
1440
|
-
| address2 | string | no | |
|
|
1441
|
-
| address1 | string | no | |
|
|
1442
|
-
| latitude | number | yes | |
|
|
1443
|
-
| city | string | no | |
|
|
1402
|
+
| ---------- | ---- | -------- | ----------- || brands | [number] | yes | || company | number | yes | || uid | number | no | |
|
|
1444
1403
|
|
|
1445
1404
|
---
|
|
1446
1405
|
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
#### [Document](#Document)
|
|
1406
|
+
#### [CompanyBrandSerializer](#CompanyBrandSerializer)
|
|
1451
1407
|
|
|
1452
1408
|
| Properties | Type | Nullable | Description |
|
|
1453
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1454
|
-
| url | string | no | |
|
|
1455
|
-
| legal_name | string | no | |
|
|
1456
|
-
| verified | boolean | no | |
|
|
1457
|
-
| type | string | yes | |
|
|
1458
|
-
| value | string | yes | |
|
|
1409
|
+
| ---------- | ---- | -------- | ----------- || brand | [GetBrandResponseSerializer](#GetBrandResponseSerializer) | no | || company | [CompanySerializer](#CompanySerializer) | no | || created_by | [UserSerializer](#UserSerializer) | no | || created_on | string | no | || modified_by | [UserSerializer](#UserSerializer) | no | || modified_on | string | no | || reject_reason | string | no | || stage | string | no | || uid | number | no | || verified_by | [UserSerializer](#UserSerializer) | no | || verified_on | string | no | || warnings | string | no | |
|
|
1459
1410
|
|
|
1460
1411
|
---
|
|
1461
1412
|
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
#### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
|
|
1413
|
+
#### [CompanyDetails](#CompanyDetails)
|
|
1466
1414
|
|
|
1467
1415
|
| Properties | Type | Nullable | Description |
|
|
1468
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1469
|
-
| rate | number | no | |
|
|
1470
|
-
| enable | boolean | no | |
|
|
1471
|
-
| effective_date | string | no | |
|
|
1416
|
+
| ---------- | ---- | -------- | ----------- || socials | [[CompanySocialAccounts](#CompanySocialAccounts)] | no | || website_url | string | no | |
|
|
1472
1417
|
|
|
1473
1418
|
---
|
|
1474
1419
|
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
#### [GetCompanyProfileSerializerResponse](#GetCompanyProfileSerializerResponse)
|
|
1420
|
+
#### [CompanySerializer](#CompanySerializer)
|
|
1479
1421
|
|
|
1480
1422
|
| Properties | Type | Nullable | Description |
|
|
1481
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1482
|
-
| business_info | string | no | |
|
|
1483
|
-
| business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
|
|
1484
|
-
| verified_on | string | no | |
|
|
1485
|
-
| contact_details | [ContactDetails](#ContactDetails) | no | |
|
|
1486
|
-
| stage | string | no | |
|
|
1487
|
-
| company_type | string | yes | |
|
|
1488
|
-
| _custom_json | string | no | |
|
|
1489
|
-
| business_type | string | yes | |
|
|
1490
|
-
| warnings | string | no | |
|
|
1491
|
-
| name | string | no | |
|
|
1492
|
-
| notification_emails | [string] | no | |
|
|
1493
|
-
| created_by | [UserSerializer](#UserSerializer) | no | |
|
|
1494
|
-
| modified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1495
|
-
| franchise_enabled | boolean | no | |
|
|
1496
|
-
| verified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1497
|
-
| mode | string | no | |
|
|
1498
|
-
| business_details | [BusinessDetails](#BusinessDetails) | no | |
|
|
1499
|
-
| modified_on | string | no | |
|
|
1500
|
-
| addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
|
|
1501
|
-
| documents | [[Document](#Document)] | no | |
|
|
1502
|
-
| uid | number | yes | |
|
|
1503
|
-
| taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] | no | |
|
|
1504
|
-
| created_on | string | no | |
|
|
1423
|
+
| ---------- | ---- | -------- | ----------- || _custom_json | string | no | || addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | || business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | || business_type | string | yes | || company_type | string | yes | || created_by | [UserSerializer](#UserSerializer) | no | || created_on | string | no | || details | [CompanyDetails](#CompanyDetails) | no | || market_channels | [string] | no | || modified_by | [UserSerializer](#UserSerializer) | no | || modified_on | string | no | || name | string | no | || notification_emails | [string] | no | || reject_reason | string | no | || stage | string | no | || uid | number | no | || verified_by | [UserSerializer](#UserSerializer) | no | || verified_on | string | no | |
|
|
1505
1424
|
|
|
1506
1425
|
---
|
|
1507
1426
|
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
#### [ErrorResponse](#ErrorResponse)
|
|
1427
|
+
#### [CompanySocialAccounts](#CompanySocialAccounts)
|
|
1512
1428
|
|
|
1513
1429
|
| Properties | Type | Nullable | Description |
|
|
1514
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1515
|
-
| message | string | no | |
|
|
1516
|
-
| meta | string | no | |
|
|
1517
|
-
| code | string | no | |
|
|
1518
|
-
| status | number | no | |
|
|
1430
|
+
| ---------- | ---- | -------- | ----------- || name | string | yes | || url | string | yes | |
|
|
1519
1431
|
|
|
1520
1432
|
---
|
|
1521
1433
|
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
#### [CompanyTaxesSerializer1](#CompanyTaxesSerializer1)
|
|
1434
|
+
#### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
|
|
1526
1435
|
|
|
1527
1436
|
| Properties | Type | Nullable | Description |
|
|
1528
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1529
|
-
| rate | number | no | |
|
|
1530
|
-
| enable | boolean | no | |
|
|
1531
|
-
| effective_date | string | no | |
|
|
1437
|
+
| ---------- | ---- | -------- | ----------- || effective_date | string | no | || enable | boolean | no | || rate | number | no | |
|
|
1532
1438
|
|
|
1533
1439
|
---
|
|
1534
1440
|
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
#### [CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)
|
|
1441
|
+
#### [CompanyTaxesSerializer1](#CompanyTaxesSerializer1)
|
|
1539
1442
|
|
|
1540
1443
|
| Properties | Type | Nullable | Description |
|
|
1541
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1542
|
-
| country_code | string | no | |
|
|
1543
|
-
| country | string | yes | |
|
|
1544
|
-
| pincode | number | yes | |
|
|
1545
|
-
| state | string | yes | |
|
|
1546
|
-
| landmark | string | no | |
|
|
1547
|
-
| address_type | string | yes | |
|
|
1548
|
-
| longitude | number | yes | |
|
|
1549
|
-
| address2 | string | no | |
|
|
1550
|
-
| address1 | string | yes | |
|
|
1551
|
-
| latitude | number | yes | |
|
|
1552
|
-
| city | string | yes | |
|
|
1444
|
+
| ---------- | ---- | -------- | ----------- || effective_date | string | no | || enable | boolean | no | || rate | number | no | |
|
|
1553
1445
|
|
|
1554
1446
|
---
|
|
1555
1447
|
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
#### [UpdateCompany](#UpdateCompany)
|
|
1448
|
+
#### [ContactDetails](#ContactDetails)
|
|
1560
1449
|
|
|
1561
1450
|
| Properties | Type | Nullable | Description |
|
|
1562
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1563
|
-
| business_info | string | no | |
|
|
1564
|
-
| franchise_enabled | boolean | no | |
|
|
1565
|
-
| warnings | string | no | |
|
|
1566
|
-
| contact_details | [ContactDetails](#ContactDetails) | no | |
|
|
1567
|
-
| reject_reason | string | no | |
|
|
1568
|
-
| name | string | no | |
|
|
1569
|
-
| business_details | [BusinessDetails](#BusinessDetails) | no | |
|
|
1570
|
-
| company_type | string | no | |
|
|
1571
|
-
| documents | [[Document](#Document)] | no | |
|
|
1572
|
-
| taxes | [[CompanyTaxesSerializer1](#CompanyTaxesSerializer1)] | no | |
|
|
1573
|
-
| _custom_json | string | no | |
|
|
1574
|
-
| business_type | string | no | |
|
|
1575
|
-
| notification_emails | [string] | no | |
|
|
1576
|
-
| addresses | [[CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)] | no | |
|
|
1451
|
+
| ---------- | ---- | -------- | ----------- || emails | [string] | no | || phone | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
|
|
1577
1452
|
|
|
1578
1453
|
---
|
|
1579
1454
|
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
#### [ProfileSuccessResponse](#ProfileSuccessResponse)
|
|
1455
|
+
#### [CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)
|
|
1584
1456
|
|
|
1585
1457
|
| Properties | Type | Nullable | Description |
|
|
1586
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1587
|
-
| uid | number | no | |
|
|
1588
|
-
| success | boolean | no | |
|
|
1458
|
+
| ---------- | ---- | -------- | ----------- || address1 | string | yes | || address2 | string | no | || address_type | string | yes | || city | string | yes | || country | string | yes | || country_code | string | no | || landmark | string | no | || latitude | number | yes | || longitude | number | yes | || pincode | number | yes | || state | string | yes | |
|
|
1589
1459
|
|
|
1590
1460
|
---
|
|
1591
1461
|
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
#### [DocumentsObj](#DocumentsObj)
|
|
1462
|
+
#### [CreateUpdateBrandRequestSerializer](#CreateUpdateBrandRequestSerializer)
|
|
1596
1463
|
|
|
1597
1464
|
| Properties | Type | Nullable | Description |
|
|
1598
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1599
|
-
| pending | number | no | |
|
|
1600
|
-
| verified | number | no | |
|
|
1465
|
+
| ---------- | ---- | -------- | ----------- || _custom_json | string | no | || _locale_language | string | no | || banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | || brand_tier | string | no | || company_id | number | no | || description | string | no | || logo | string | yes | || name | string | yes | || synonyms | [string] | no | || uid | number | no | |
|
|
1601
1466
|
|
|
1602
1467
|
---
|
|
1603
1468
|
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
#### [MetricsSerializer](#MetricsSerializer)
|
|
1469
|
+
#### [Document](#Document)
|
|
1608
1470
|
|
|
1609
1471
|
| Properties | Type | Nullable | Description |
|
|
1610
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1611
|
-
| store_documents | [DocumentsObj](#DocumentsObj) | no | |
|
|
1612
|
-
| product | [DocumentsObj](#DocumentsObj) | no | |
|
|
1613
|
-
| brand | [DocumentsObj](#DocumentsObj) | no | |
|
|
1614
|
-
| company_documents | [DocumentsObj](#DocumentsObj) | no | |
|
|
1615
|
-
| stage | string | no | |
|
|
1616
|
-
| uid | number | no | |
|
|
1617
|
-
| store | [DocumentsObj](#DocumentsObj) | no | |
|
|
1472
|
+
| ---------- | ---- | -------- | ----------- || legal_name | string | no | || type | string | yes | || url | string | no | || value | string | yes | || verified | boolean | no | |
|
|
1618
1473
|
|
|
1619
1474
|
---
|
|
1620
1475
|
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
#### [BrandBannerSerializer](#BrandBannerSerializer)
|
|
1476
|
+
#### [DocumentsObj](#DocumentsObj)
|
|
1625
1477
|
|
|
1626
1478
|
| Properties | Type | Nullable | Description |
|
|
1627
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1628
|
-
| portrait | string | no | |
|
|
1629
|
-
| landscape | string | no | |
|
|
1479
|
+
| ---------- | ---- | -------- | ----------- || pending | number | no | || verified | number | no | |
|
|
1630
1480
|
|
|
1631
1481
|
---
|
|
1632
1482
|
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
#### [GetBrandResponseSerializer](#GetBrandResponseSerializer)
|
|
1483
|
+
#### [ErrorResponse](#ErrorResponse)
|
|
1637
1484
|
|
|
1638
1485
|
| Properties | Type | Nullable | Description |
|
|
1639
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1640
|
-
| verified_on | string | no | |
|
|
1641
|
-
| stage | string | no | |
|
|
1642
|
-
| _custom_json | string | no | |
|
|
1643
|
-
| synonyms | [string] | no | |
|
|
1644
|
-
| logo | string | no | |
|
|
1645
|
-
| warnings | string | no | |
|
|
1646
|
-
| name | string | yes | |
|
|
1647
|
-
| created_by | [UserSerializer](#UserSerializer) | no | |
|
|
1648
|
-
| modified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1649
|
-
| verified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1650
|
-
| mode | string | no | |
|
|
1651
|
-
| reject_reason | string | no | |
|
|
1652
|
-
| modified_on | string | no | |
|
|
1653
|
-
| slug_key | string | no | |
|
|
1654
|
-
| description | string | no | |
|
|
1655
|
-
| banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
|
|
1656
|
-
| uid | number | no | |
|
|
1657
|
-
| created_on | string | no | |
|
|
1658
|
-
| _locale_language | string | no | |
|
|
1486
|
+
| ---------- | ---- | -------- | ----------- || code | string | no | || message | string | no | || meta | string | no | || status | number | no | |
|
|
1659
1487
|
|
|
1660
1488
|
---
|
|
1661
1489
|
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
#### [CreateUpdateBrandRequestSerializer](#CreateUpdateBrandRequestSerializer)
|
|
1490
|
+
#### [GetAddressSerializer](#GetAddressSerializer)
|
|
1666
1491
|
|
|
1667
1492
|
| Properties | Type | Nullable | Description |
|
|
1668
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1669
|
-
| description | string | no | |
|
|
1670
|
-
| brand_tier | string | no | |
|
|
1671
|
-
| logo | string | yes | |
|
|
1672
|
-
| name | string | yes | |
|
|
1673
|
-
| company_id | number | no | |
|
|
1674
|
-
| banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
|
|
1675
|
-
| uid | number | no | |
|
|
1676
|
-
| _custom_json | string | no | |
|
|
1677
|
-
| _locale_language | string | no | |
|
|
1678
|
-
| synonyms | [string] | no | |
|
|
1493
|
+
| ---------- | ---- | -------- | ----------- || address1 | string | no | || address2 | string | no | || address_type | string | no | || city | string | no | || country | string | no | || country_code | string | no | || landmark | string | no | || latitude | number | yes | || longitude | number | yes | || pincode | number | no | || state | string | no | |
|
|
1679
1494
|
|
|
1680
1495
|
---
|
|
1681
1496
|
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
#### [Page](#Page)
|
|
1497
|
+
#### [GetBrandResponseSerializer](#GetBrandResponseSerializer)
|
|
1686
1498
|
|
|
1687
1499
|
| Properties | Type | Nullable | Description |
|
|
1688
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1689
|
-
| has_next | boolean | no | |
|
|
1690
|
-
| next_id | string | no | |
|
|
1691
|
-
| current | number | no | |
|
|
1692
|
-
| type | string | yes | |
|
|
1693
|
-
| size | number | no | |
|
|
1694
|
-
| has_previous | boolean | no | |
|
|
1695
|
-
| item_total | number | no | |
|
|
1500
|
+
| ---------- | ---- | -------- | ----------- || _custom_json | string | no | || _locale_language | string | no | || banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | || created_by | [UserSerializer](#UserSerializer) | no | || created_on | string | no | || description | string | no | || logo | string | no | || mode | string | no | || modified_by | [UserSerializer](#UserSerializer) | no | || modified_on | string | no | || name | string | yes | || reject_reason | string | no | || slug_key | string | no | || stage | string | no | || synonyms | [string] | no | || uid | number | no | || verified_by | [UserSerializer](#UserSerializer) | no | || verified_on | string | no | || warnings | string | no | |
|
|
1696
1501
|
|
|
1697
1502
|
---
|
|
1698
1503
|
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
#### [CompanySocialAccounts](#CompanySocialAccounts)
|
|
1504
|
+
#### [GetCompanyProfileSerializerResponse](#GetCompanyProfileSerializerResponse)
|
|
1703
1505
|
|
|
1704
1506
|
| Properties | Type | Nullable | Description |
|
|
1705
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1706
|
-
| name | string | yes | |
|
|
1707
|
-
| url | string | yes | |
|
|
1507
|
+
| ---------- | ---- | -------- | ----------- || _custom_json | string | no | || addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | || business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | || business_details | [BusinessDetails](#BusinessDetails) | no | || business_info | string | no | || business_type | string | yes | || company_type | string | yes | || contact_details | [ContactDetails](#ContactDetails) | no | || created_by | [UserSerializer](#UserSerializer) | no | || created_on | string | no | || documents | [[Document](#Document)] | no | || franchise_enabled | boolean | no | || mode | string | no | || modified_by | [UserSerializer](#UserSerializer) | no | || modified_on | string | no | || name | string | no | || notification_emails | [string] | no | || stage | string | no | || taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] | no | || uid | number | yes | || verified_by | [UserSerializer](#UserSerializer) | no | || verified_on | string | no | || warnings | string | no | |
|
|
1708
1508
|
|
|
1709
1509
|
---
|
|
1710
1510
|
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
#### [CompanyDetails](#CompanyDetails)
|
|
1511
|
+
#### [GetCompanySerializer](#GetCompanySerializer)
|
|
1715
1512
|
|
|
1716
1513
|
| Properties | Type | Nullable | Description |
|
|
1717
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1718
|
-
| socials | [[CompanySocialAccounts](#CompanySocialAccounts)] | no | |
|
|
1719
|
-
| website_url | string | no | |
|
|
1514
|
+
| ---------- | ---- | -------- | ----------- || addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | || business_type | string | no | || company_type | string | no | || created_by | [UserSerializer](#UserSerializer) | no | || created_on | string | no | || modified_by | [UserSerializer](#UserSerializer) | no | || modified_on | string | no | || name | string | no | || reject_reason | string | no | || stage | string | no | || uid | number | no | || verified_by | [UserSerializer](#UserSerializer) | no | || verified_on | string | no | |
|
|
1720
1515
|
|
|
1721
1516
|
---
|
|
1722
1517
|
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
#### [CompanySerializer](#CompanySerializer)
|
|
1518
|
+
#### [GetLocationSerializer](#GetLocationSerializer)
|
|
1727
1519
|
|
|
1728
1520
|
| Properties | Type | Nullable | Description |
|
|
1729
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1730
|
-
| details | [CompanyDetails](#CompanyDetails) | no | |
|
|
1731
|
-
| business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
|
|
1732
|
-
| created_by | [UserSerializer](#UserSerializer) | no | |
|
|
1733
|
-
| verified_on | string | no | |
|
|
1734
|
-
| verified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1735
|
-
| reject_reason | string | no | |
|
|
1736
|
-
| stage | string | no | |
|
|
1737
|
-
| name | string | no | |
|
|
1738
|
-
| company_type | string | yes | |
|
|
1739
|
-
| uid | number | no | |
|
|
1740
|
-
| _custom_json | string | no | |
|
|
1741
|
-
| modified_on | string | no | |
|
|
1742
|
-
| business_type | string | yes | |
|
|
1743
|
-
| created_on | string | no | |
|
|
1744
|
-
| notification_emails | [string] | no | |
|
|
1745
|
-
| market_channels | [string] | no | |
|
|
1746
|
-
| modified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1747
|
-
| addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
|
|
1521
|
+
| ---------- | ---- | -------- | ----------- || _custom_json | string | no | || address | [GetAddressSerializer](#GetAddressSerializer) | yes | || code | string | yes | || company | [GetCompanySerializer](#GetCompanySerializer) | no | || contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | || created_by | [UserSerializer](#UserSerializer) | no | || created_on | string | no | || display_name | string | yes | || documents | [[Document](#Document)] | no | || gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | || holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | || manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | || modified_by | [UserSerializer](#UserSerializer) | no | || modified_on | string | no | || name | string | yes | || notification_emails | [string] | no | || phone_number | string | no | || product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | || stage | string | no | || store_type | string | no | || timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | || uid | number | no | || verified_by | [UserSerializer](#UserSerializer) | no | || verified_on | string | no | || warnings | string | no | |
|
|
1748
1522
|
|
|
1749
1523
|
---
|
|
1750
1524
|
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
#### [CompanyBrandSerializer](#CompanyBrandSerializer)
|
|
1525
|
+
#### [HolidayDateSerializer](#HolidayDateSerializer)
|
|
1755
1526
|
|
|
1756
1527
|
| Properties | Type | Nullable | Description |
|
|
1757
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1758
|
-
| company | [CompanySerializer](#CompanySerializer) | no | |
|
|
1759
|
-
| created_by | [UserSerializer](#UserSerializer) | no | |
|
|
1760
|
-
| brand | [GetBrandResponseSerializer](#GetBrandResponseSerializer) | no | |
|
|
1761
|
-
| verified_on | string | no | |
|
|
1762
|
-
| verified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1763
|
-
| warnings | string | no | |
|
|
1764
|
-
| reject_reason | string | no | |
|
|
1765
|
-
| stage | string | no | |
|
|
1766
|
-
| uid | number | no | |
|
|
1767
|
-
| modified_on | string | no | |
|
|
1768
|
-
| created_on | string | no | |
|
|
1769
|
-
| modified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1528
|
+
| ---------- | ---- | -------- | ----------- || end_date | string | yes | || start_date | string | yes | |
|
|
1770
1529
|
|
|
1771
1530
|
---
|
|
1772
1531
|
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
#### [CompanyBrandListSerializer](#CompanyBrandListSerializer)
|
|
1532
|
+
#### [HolidaySchemaSerializer](#HolidaySchemaSerializer)
|
|
1777
1533
|
|
|
1778
1534
|
| Properties | Type | Nullable | Description |
|
|
1779
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1780
|
-
| page | [Page](#Page) | no | |
|
|
1781
|
-
| items | [[CompanyBrandSerializer](#CompanyBrandSerializer)] | no | |
|
|
1535
|
+
| ---------- | ---- | -------- | ----------- || date | [HolidayDateSerializer](#HolidayDateSerializer) | yes | || holiday_type | string | yes | || title | string | yes | |
|
|
1782
1536
|
|
|
1783
1537
|
---
|
|
1784
1538
|
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
#### [CompanyBrandPostRequestSerializer](#CompanyBrandPostRequestSerializer)
|
|
1539
|
+
#### [InvoiceCredSerializer](#InvoiceCredSerializer)
|
|
1789
1540
|
|
|
1790
1541
|
| Properties | Type | Nullable | Description |
|
|
1791
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1792
|
-
| company | number | yes | |
|
|
1793
|
-
| uid | number | no | |
|
|
1794
|
-
| brands | [number] | yes | |
|
|
1542
|
+
| ---------- | ---- | -------- | ----------- || enabled | boolean | no | || password | string | no | || username | string | no | |
|
|
1795
1543
|
|
|
1796
1544
|
---
|
|
1797
1545
|
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
#### [ProductReturnConfigSerializer](#ProductReturnConfigSerializer)
|
|
1546
|
+
#### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
|
|
1802
1547
|
|
|
1803
1548
|
| Properties | Type | Nullable | Description |
|
|
1804
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1805
|
-
| on_same_store | boolean | no | |
|
|
1806
|
-
| store_uid | number | no | |
|
|
1549
|
+
| ---------- | ---- | -------- | ----------- || e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | || e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
|
|
1807
1550
|
|
|
1808
1551
|
---
|
|
1809
1552
|
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
#### [HolidayDateSerializer](#HolidayDateSerializer)
|
|
1553
|
+
#### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
|
|
1814
1554
|
|
|
1815
1555
|
| Properties | Type | Nullable | Description |
|
|
1816
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1817
|
-
| end_date | string | yes | |
|
|
1818
|
-
| start_date | string | yes | |
|
|
1556
|
+
| ---------- | ---- | -------- | ----------- || closing | [LocationTimingSerializer](#LocationTimingSerializer) | no | || open | boolean | yes | || opening | [LocationTimingSerializer](#LocationTimingSerializer) | no | || weekday | string | yes | |
|
|
1819
1557
|
|
|
1820
1558
|
---
|
|
1821
1559
|
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
#### [HolidaySchemaSerializer](#HolidaySchemaSerializer)
|
|
1560
|
+
#### [LocationListSerializer](#LocationListSerializer)
|
|
1826
1561
|
|
|
1827
1562
|
| Properties | Type | Nullable | Description |
|
|
1828
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1829
|
-
| title | string | yes | |
|
|
1830
|
-
| holiday_type | string | yes | |
|
|
1831
|
-
| date | [HolidayDateSerializer](#HolidayDateSerializer) | yes | |
|
|
1563
|
+
| ---------- | ---- | -------- | ----------- || items | [[GetLocationSerializer](#GetLocationSerializer)] | no | || page | [Page](#Page) | no | |
|
|
1832
1564
|
|
|
1833
1565
|
---
|
|
1834
1566
|
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
#### [LocationTimingSerializer](#LocationTimingSerializer)
|
|
1567
|
+
#### [LocationManagerSerializer](#LocationManagerSerializer)
|
|
1839
1568
|
|
|
1840
1569
|
| Properties | Type | Nullable | Description |
|
|
1841
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1842
|
-
| minute | number | yes | |
|
|
1843
|
-
| hour | number | yes | |
|
|
1570
|
+
| ---------- | ---- | -------- | ----------- || email | string | no | || mobile_no | [SellerPhoneNumber](#SellerPhoneNumber) | yes | || name | string | no | |
|
|
1844
1571
|
|
|
1845
1572
|
---
|
|
1846
1573
|
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
#### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
|
|
1574
|
+
#### [LocationSerializer](#LocationSerializer)
|
|
1851
1575
|
|
|
1852
1576
|
| Properties | Type | Nullable | Description |
|
|
1853
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1854
|
-
| closing | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
|
|
1855
|
-
| opening | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
|
|
1856
|
-
| open | boolean | yes | |
|
|
1857
|
-
| weekday | string | yes | |
|
|
1577
|
+
| ---------- | ---- | -------- | ----------- || _custom_json | string | no | || address | [AddressSerializer](#AddressSerializer) | yes | || code | string | yes | || company | number | yes | || contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | || display_name | string | yes | || documents | [[Document](#Document)] | no | || gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | || holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | || manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | || name | string | yes | || notification_emails | [string] | no | || product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | || stage | string | no | || store_type | string | no | || timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | || uid | number | no | || warnings | string | no | |
|
|
1858
1578
|
|
|
1859
1579
|
---
|
|
1860
1580
|
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
#### [LocationManagerSerializer](#LocationManagerSerializer)
|
|
1581
|
+
#### [LocationTimingSerializer](#LocationTimingSerializer)
|
|
1865
1582
|
|
|
1866
1583
|
| Properties | Type | Nullable | Description |
|
|
1867
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1868
|
-
| email | string | no | |
|
|
1869
|
-
| name | string | no | |
|
|
1870
|
-
| mobile_no | [SellerPhoneNumber](#SellerPhoneNumber) | yes | |
|
|
1584
|
+
| ---------- | ---- | -------- | ----------- || hour | number | yes | || minute | number | yes | |
|
|
1871
1585
|
|
|
1872
1586
|
---
|
|
1873
1587
|
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
#### [GetCompanySerializer](#GetCompanySerializer)
|
|
1588
|
+
#### [MetricsSerializer](#MetricsSerializer)
|
|
1878
1589
|
|
|
1879
1590
|
| Properties | Type | Nullable | Description |
|
|
1880
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1881
|
-
| created_by | [UserSerializer](#UserSerializer) | no | |
|
|
1882
|
-
| verified_on | string | no | |
|
|
1883
|
-
| verified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1884
|
-
| reject_reason | string | no | |
|
|
1885
|
-
| stage | string | no | |
|
|
1886
|
-
| name | string | no | |
|
|
1887
|
-
| company_type | string | no | |
|
|
1888
|
-
| uid | number | no | |
|
|
1889
|
-
| modified_on | string | no | |
|
|
1890
|
-
| business_type | string | no | |
|
|
1891
|
-
| created_on | string | no | |
|
|
1892
|
-
| modified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1893
|
-
| addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
|
|
1591
|
+
| ---------- | ---- | -------- | ----------- || brand | [DocumentsObj](#DocumentsObj) | no | || company_documents | [DocumentsObj](#DocumentsObj) | no | || product | [DocumentsObj](#DocumentsObj) | no | || stage | string | no | || store | [DocumentsObj](#DocumentsObj) | no | || store_documents | [DocumentsObj](#DocumentsObj) | no | || uid | number | no | |
|
|
1894
1592
|
|
|
1895
1593
|
---
|
|
1896
1594
|
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
#### [InvoiceCredSerializer](#InvoiceCredSerializer)
|
|
1595
|
+
#### [Page](#Page)
|
|
1901
1596
|
|
|
1902
1597
|
| Properties | Type | Nullable | Description |
|
|
1903
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1904
|
-
| password | string | no | |
|
|
1905
|
-
| enabled | boolean | no | |
|
|
1906
|
-
| username | string | no | |
|
|
1598
|
+
| ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || has_previous | boolean | no | || item_total | number | no | || next_id | string | no | || size | number | no | || type | string | yes | |
|
|
1907
1599
|
|
|
1908
1600
|
---
|
|
1909
1601
|
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
#### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
|
|
1602
|
+
#### [ProductReturnConfigSerializer](#ProductReturnConfigSerializer)
|
|
1914
1603
|
|
|
1915
1604
|
| Properties | Type | Nullable | Description |
|
|
1916
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1917
|
-
| e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
|
|
1918
|
-
| e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
|
|
1605
|
+
| ---------- | ---- | -------- | ----------- || on_same_store | boolean | no | || store_uid | number | no | |
|
|
1919
1606
|
|
|
1920
1607
|
---
|
|
1921
1608
|
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
#### [GetLocationSerializer](#GetLocationSerializer)
|
|
1609
|
+
#### [ProfileSuccessResponse](#ProfileSuccessResponse)
|
|
1926
1610
|
|
|
1927
1611
|
| Properties | Type | Nullable | Description |
|
|
1928
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1929
|
-
| verified_on | string | no | |
|
|
1930
|
-
| stage | string | no | |
|
|
1931
|
-
| display_name | string | yes | |
|
|
1932
|
-
| _custom_json | string | no | |
|
|
1933
|
-
| phone_number | string | no | |
|
|
1934
|
-
| warnings | string | no | |
|
|
1935
|
-
| product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
|
|
1936
|
-
| name | string | yes | |
|
|
1937
|
-
| holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
|
|
1938
|
-
| notification_emails | [string] | no | |
|
|
1939
|
-
| created_by | [UserSerializer](#UserSerializer) | no | |
|
|
1940
|
-
| modified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1941
|
-
| verified_by | [UserSerializer](#UserSerializer) | no | |
|
|
1942
|
-
| timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
|
|
1943
|
-
| code | string | yes | |
|
|
1944
|
-
| modified_on | string | no | |
|
|
1945
|
-
| manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
|
|
1946
|
-
| address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
|
|
1947
|
-
| company | [GetCompanySerializer](#GetCompanySerializer) | no | |
|
|
1948
|
-
| store_type | string | no | |
|
|
1949
|
-
| gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
|
|
1950
|
-
| documents | [[Document](#Document)] | no | |
|
|
1951
|
-
| uid | number | no | |
|
|
1952
|
-
| contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
|
|
1953
|
-
| created_on | string | no | |
|
|
1612
|
+
| ---------- | ---- | -------- | ----------- || success | boolean | no | || uid | number | no | |
|
|
1954
1613
|
|
|
1955
1614
|
---
|
|
1956
1615
|
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
|
|
1960
|
-
#### [LocationListSerializer](#LocationListSerializer)
|
|
1616
|
+
#### [SellerPhoneNumber](#SellerPhoneNumber)
|
|
1961
1617
|
|
|
1962
1618
|
| Properties | Type | Nullable | Description |
|
|
1963
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1964
|
-
| page | [Page](#Page) | no | |
|
|
1965
|
-
| items | [[GetLocationSerializer](#GetLocationSerializer)] | no | |
|
|
1619
|
+
| ---------- | ---- | -------- | ----------- || country_code | number | yes | || number | string | yes | |
|
|
1966
1620
|
|
|
1967
1621
|
---
|
|
1968
1622
|
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
#### [AddressSerializer](#AddressSerializer)
|
|
1623
|
+
#### [UpdateCompany](#UpdateCompany)
|
|
1973
1624
|
|
|
1974
1625
|
| Properties | Type | Nullable | Description |
|
|
1975
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1976
|
-
| country_code | string | no | |
|
|
1977
|
-
| country | string | no | |
|
|
1978
|
-
| pincode | number | no | |
|
|
1979
|
-
| state | string | no | |
|
|
1980
|
-
| landmark | string | no | |
|
|
1981
|
-
| address_type | string | no | |
|
|
1982
|
-
| longitude | number | yes | |
|
|
1983
|
-
| address2 | string | no | |
|
|
1984
|
-
| address1 | string | no | |
|
|
1985
|
-
| latitude | number | yes | |
|
|
1986
|
-
| city | string | no | |
|
|
1626
|
+
| ---------- | ---- | -------- | ----------- || _custom_json | string | no | || addresses | [[CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)] | no | || business_details | [BusinessDetails](#BusinessDetails) | no | || business_info | string | no | || business_type | string | no | || company_type | string | no | || contact_details | [ContactDetails](#ContactDetails) | no | || documents | [[Document](#Document)] | no | || franchise_enabled | boolean | no | || name | string | no | || notification_emails | [string] | no | || reject_reason | string | no | || taxes | [[CompanyTaxesSerializer1](#CompanyTaxesSerializer1)] | no | || warnings | string | no | |
|
|
1987
1627
|
|
|
1988
1628
|
---
|
|
1989
1629
|
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
#### [LocationSerializer](#LocationSerializer)
|
|
1630
|
+
#### [UserSerializer](#UserSerializer)
|
|
1994
1631
|
|
|
1995
1632
|
| Properties | Type | Nullable | Description |
|
|
1996
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1997
|
-
| company | number | yes | |
|
|
1998
|
-
| product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
|
|
1999
|
-
| store_type | string | no | |
|
|
2000
|
-
| warnings | string | no | |
|
|
2001
|
-
| timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
|
|
2002
|
-
| code | string | yes | |
|
|
2003
|
-
| name | string | yes | |
|
|
2004
|
-
| holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
|
|
2005
|
-
| stage | string | no | |
|
|
2006
|
-
| display_name | string | yes | |
|
|
2007
|
-
| documents | [[Document](#Document)] | no | |
|
|
2008
|
-
| uid | number | no | |
|
|
2009
|
-
| contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
|
|
2010
|
-
| manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
|
|
2011
|
-
| _custom_json | string | no | |
|
|
2012
|
-
| gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
|
|
2013
|
-
| notification_emails | [string] | no | |
|
|
2014
|
-
| address | [AddressSerializer](#AddressSerializer) | yes | |
|
|
1633
|
+
| ---------- | ---- | -------- | ----------- || contact | string | no | || user_id | string | no | || username | string | no | |
|
|
2015
1634
|
|
|
2016
1635
|
---
|
|
2017
1636
|
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
#### [BulkLocationSerializer](#BulkLocationSerializer)
|
|
1637
|
+
#### [Website](#Website)
|
|
2022
1638
|
|
|
2023
1639
|
| Properties | Type | Nullable | Description |
|
|
2024
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2025
|
-
| data | [[LocationSerializer](#LocationSerializer)] | no | |
|
|
1640
|
+
| ---------- | ---- | -------- | ----------- || url | string | no | |
|
|
2026
1641
|
|
|
2027
1642
|
---
|
|
2028
1643
|
|