@gofynd/fdk-client-javascript 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/documentation/application/CATALOG.md +371 -371
  2. package/documentation/application/ORDER.md +272 -272
  3. package/documentation/application/PAYMENT.md +269 -269
  4. package/documentation/platform/CATALOG.md +1678 -1664
  5. package/documentation/platform/COMPANYPROFILE.md +201 -201
  6. package/documentation/platform/ORDER.md +1442 -1323
  7. package/documentation/platform/PAYMENT.md +88 -88
  8. package/index.js +7 -1
  9. package/package.json +1 -1
  10. package/sdk/application/Cart/CartApplicationClient.js +302 -0
  11. package/sdk/application/Cart/CartApplicationValidator.js +1 -0
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +378 -0
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +17 -17
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +500 -500
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +1 -0
  16. package/sdk/application/Common/CommonApplicationClient.js +22 -0
  17. package/sdk/application/Common/CommonApplicationValidator.js +1 -0
  18. package/sdk/application/Communication/CommunicationApplicationClient.js +41 -0
  19. package/sdk/application/Communication/CommunicationApplicationValidator.js +1 -0
  20. package/sdk/application/Configuration/ConfigurationApplicationClient.js +200 -0
  21. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  22. package/sdk/application/Content/ContentApplicationClient.js +215 -0
  23. package/sdk/application/Content/ContentApplicationValidator.js +1 -0
  24. package/sdk/application/FileStorage/FileStorageApplicationClient.js +33 -0
  25. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +1 -0
  26. package/sdk/application/Lead/LeadApplicationClient.js +81 -0
  27. package/sdk/application/Lead/LeadApplicationValidator.js +1 -0
  28. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  29. package/sdk/application/Logistic/LogisticApplicationValidator.js +1 -0
  30. package/sdk/application/Order/OrderApplicationClient.js +146 -0
  31. package/sdk/application/Order/OrderApplicationModel.d.ts +20 -20
  32. package/sdk/application/Order/OrderApplicationModel.js +329 -329
  33. package/sdk/application/Order/OrderApplicationValidator.js +1 -0
  34. package/sdk/application/Payment/PaymentApplicationClient.js +528 -0
  35. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -5
  36. package/sdk/application/Payment/PaymentApplicationModel.js +391 -391
  37. package/sdk/application/Payment/PaymentApplicationValidator.js +1 -0
  38. package/sdk/application/PosCart/PosCartApplicationClient.js +329 -0
  39. package/sdk/application/PosCart/PosCartApplicationValidator.js +1 -0
  40. package/sdk/application/Rewards/RewardsApplicationClient.js +81 -0
  41. package/sdk/application/Rewards/RewardsApplicationValidator.js +1 -0
  42. package/sdk/application/Share/ShareApplicationClient.js +87 -0
  43. package/sdk/application/Share/ShareApplicationValidator.js +1 -0
  44. package/sdk/application/Theme/ThemeApplicationClient.js +44 -0
  45. package/sdk/application/Theme/ThemeApplicationValidator.js +1 -0
  46. package/sdk/application/User/UserApplicationClient.js +405 -0
  47. package/sdk/application/User/UserApplicationValidator.js +1 -0
  48. package/sdk/common/AxiosHelper.js +1 -1
  49. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +114 -0
  50. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +58 -0
  51. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +46 -0
  52. package/sdk/platform/Billing/BillingPlatformClient.js +160 -0
  53. package/sdk/platform/Cart/CartPlatformApplicationClient.js +246 -0
  54. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +29 -29
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +839 -48
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +3 -3
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +9 -9
  58. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +54 -54
  59. package/sdk/platform/Catalog/CatalogPlatformClient.js +1149 -96
  60. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +58 -57
  61. package/sdk/platform/Catalog/CatalogPlatformModel.js +1626 -1614
  62. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +6 -6
  63. package/sdk/platform/Catalog/CatalogPlatformValidator.js +20 -20
  64. package/sdk/platform/Common/CommonPlatformClient.js +26 -0
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +587 -0
  66. package/sdk/platform/Communication/CommunicationPlatformClient.js +15 -0
  67. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +179 -0
  68. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +11 -11
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +269 -269
  70. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +382 -0
  71. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +282 -0
  72. package/sdk/platform/Content/ContentPlatformApplicationClient.js +866 -0
  73. package/sdk/platform/Discount/DiscountPlatformClient.js +152 -0
  74. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +54 -0
  75. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +76 -0
  76. package/sdk/platform/Inventory/InventoryPlatformClient.js +161 -0
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +162 -0
  78. package/sdk/platform/Lead/LeadPlatformClient.js +140 -0
  79. package/sdk/platform/Order/OrderPlatformApplicationClient.js +55 -0
  80. package/sdk/platform/Order/OrderPlatformClient.d.ts +15 -6
  81. package/sdk/platform/Order/OrderPlatformClient.js +674 -15
  82. package/sdk/platform/Order/OrderPlatformModel.d.ts +67 -60
  83. package/sdk/platform/Order/OrderPlatformModel.js +1559 -1623
  84. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -1
  85. package/sdk/platform/Order/OrderPlatformValidator.js +10 -4
  86. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +26 -0
  87. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +165 -0
  88. package/sdk/platform/Payment/PaymentPlatformClient.js +139 -0
  89. package/sdk/platform/Payment/PaymentPlatformModel.js +137 -137
  90. package/sdk/platform/PlatformApplicationClient.d.ts +2217 -2243
  91. package/sdk/platform/PlatformApplicationClient.js +2514 -2524
  92. package/sdk/platform/PlatformClient.d.ts +2217 -2243
  93. package/sdk/platform/PlatformClient.js +2514 -2524
  94. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +169 -0
  95. package/sdk/platform/Share/SharePlatformApplicationClient.js +53 -0
  96. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +293 -0
  97. package/sdk/platform/User/UserPlatformApplicationClient.js +145 -0
  98. package/sdk/platform/Webhook/WebhookPlatformClient.js +90 -0
  99. package/sdk/public/Configuration/ConfigurationPublicClient.js +25 -0
  100. package/sdk/public/Configuration/ConfigurationPublicValidator.js +3 -1
  101. package/sdk/public/Inventory/InventoryPublicClient.js +75 -0
  102. package/sdk/public/Inventory/InventoryPublicValidator.js +3 -1
  103. package/sdk/public/Webhook/WebhookPublicClient.js +29 -0
  104. package/sdk/public/Webhook/WebhookPublicValidator.js +3 -1
@@ -1355,120 +1355,120 @@ Returns a success response
1355
1355
 
1356
1356
 
1357
1357
 
1358
- #### [UserSerializer](#UserSerializer)
1358
+ #### [BusinessCountryInfo](#BusinessCountryInfo)
1359
1359
 
1360
1360
  | Properties | Type | Nullable | Description |
1361
1361
  | ---------- | ---- | -------- | ----------- |
1362
- | user_id | string | no | |
1363
- | contact | string | no | |
1364
- | username | string | no | |
1362
+ | country_code | string | no | |
1363
+ | country | string | no | |
1365
1364
 
1366
1365
  ---
1367
1366
 
1368
1367
 
1369
1368
 
1370
1369
 
1371
- #### [Document](#Document)
1370
+ #### [SellerPhoneNumber](#SellerPhoneNumber)
1372
1371
 
1373
1372
  | Properties | Type | Nullable | Description |
1374
1373
  | ---------- | ---- | -------- | ----------- |
1375
- | url | string | no | |
1376
- | verified | boolean | no | |
1377
- | value | string | yes | |
1378
- | type | string | yes | |
1379
- | legal_name | string | no | |
1374
+ | number | string | yes | |
1375
+ | country_code | number | yes | |
1380
1376
 
1381
1377
  ---
1382
1378
 
1383
1379
 
1384
1380
 
1385
1381
 
1386
- #### [Website](#Website)
1382
+ #### [ContactDetails](#ContactDetails)
1387
1383
 
1388
1384
  | Properties | Type | Nullable | Description |
1389
1385
  | ---------- | ---- | -------- | ----------- |
1390
- | url | string | no | |
1386
+ | emails | [string] | no | |
1387
+ | phone | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1391
1388
 
1392
1389
  ---
1393
1390
 
1394
1391
 
1395
1392
 
1396
1393
 
1397
- #### [BusinessDetails](#BusinessDetails)
1394
+ #### [UserSerializer](#UserSerializer)
1398
1395
 
1399
1396
  | Properties | Type | Nullable | Description |
1400
1397
  | ---------- | ---- | -------- | ----------- |
1401
- | website | [Website](#Website) | no | |
1398
+ | user_id | string | no | |
1399
+ | contact | string | no | |
1400
+ | username | string | no | |
1402
1401
 
1403
1402
  ---
1404
1403
 
1405
1404
 
1406
1405
 
1407
1406
 
1408
- #### [BusinessCountryInfo](#BusinessCountryInfo)
1407
+ #### [Website](#Website)
1409
1408
 
1410
1409
  | Properties | Type | Nullable | Description |
1411
1410
  | ---------- | ---- | -------- | ----------- |
1412
- | country_code | string | no | |
1413
- | country | string | no | |
1411
+ | url | string | no | |
1414
1412
 
1415
1413
  ---
1416
1414
 
1417
1415
 
1418
1416
 
1419
1417
 
1420
- #### [SellerPhoneNumber](#SellerPhoneNumber)
1418
+ #### [BusinessDetails](#BusinessDetails)
1421
1419
 
1422
1420
  | Properties | Type | Nullable | Description |
1423
1421
  | ---------- | ---- | -------- | ----------- |
1424
- | country_code | number | yes | |
1425
- | number | string | yes | |
1422
+ | website | [Website](#Website) | no | |
1426
1423
 
1427
1424
  ---
1428
1425
 
1429
1426
 
1430
1427
 
1431
1428
 
1432
- #### [ContactDetails](#ContactDetails)
1429
+ #### [GetAddressSerializer](#GetAddressSerializer)
1433
1430
 
1434
1431
  | Properties | Type | Nullable | Description |
1435
1432
  | ---------- | ---- | -------- | ----------- |
1436
- | phone | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1437
- | emails | [string] | no | |
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 | |
1438
1444
 
1439
1445
  ---
1440
1446
 
1441
1447
 
1442
1448
 
1443
1449
 
1444
- #### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
1450
+ #### [Document](#Document)
1445
1451
 
1446
1452
  | Properties | Type | Nullable | Description |
1447
1453
  | ---------- | ---- | -------- | ----------- |
1448
- | enable | boolean | no | |
1449
- | rate | number | no | |
1450
- | effective_date | string | no | |
1454
+ | url | string | no | |
1455
+ | legal_name | string | no | |
1456
+ | verified | boolean | no | |
1457
+ | type | string | yes | |
1458
+ | value | string | yes | |
1451
1459
 
1452
1460
  ---
1453
1461
 
1454
1462
 
1455
1463
 
1456
1464
 
1457
- #### [GetAddressSerializer](#GetAddressSerializer)
1465
+ #### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
1458
1466
 
1459
1467
  | Properties | Type | Nullable | Description |
1460
1468
  | ---------- | ---- | -------- | ----------- |
1461
- | country_code | string | no | |
1462
- | pincode | number | no | |
1463
- | longitude | number | yes | |
1464
- | landmark | string | no | |
1465
- | latitude | number | yes | |
1466
- | country | string | no | |
1467
- | address_type | string | no | |
1468
- | state | string | no | |
1469
- | address2 | string | no | |
1470
- | city | string | no | |
1471
- | address1 | string | no | |
1469
+ | rate | number | no | |
1470
+ | enable | boolean | no | |
1471
+ | effective_date | string | no | |
1472
1472
 
1473
1473
  ---
1474
1474
 
@@ -1479,29 +1479,29 @@ Returns a success response
1479
1479
 
1480
1480
  | Properties | Type | Nullable | Description |
1481
1481
  | ---------- | ---- | -------- | ----------- |
1482
- | verified_by | [UserSerializer](#UserSerializer) | no | |
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 | |
1483
1487
  | company_type | string | yes | |
1484
- | notification_emails | [string] | no | |
1488
+ | _custom_json | string | no | |
1489
+ | business_type | string | yes | |
1485
1490
  | warnings | string | no | |
1486
- | franchise_enabled | boolean | no | |
1487
1491
  | name | string | no | |
1488
- | business_info | string | no | |
1489
- | stage | string | no | |
1490
- | created_on | string | no | |
1492
+ | notification_emails | [string] | no | |
1491
1493
  | created_by | [UserSerializer](#UserSerializer) | no | |
1492
- | verified_on | string | no | |
1493
- | _custom_json | string | no | |
1494
- | documents | [[Document](#Document)] | no | |
1495
- | business_details | [BusinessDetails](#BusinessDetails) | no | |
1496
- | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
1497
1494
  | modified_by | [UserSerializer](#UserSerializer) | no | |
1498
- | contact_details | [ContactDetails](#ContactDetails) | no | |
1499
- | uid | number | yes | |
1500
- | modified_on | string | no | |
1495
+ | franchise_enabled | boolean | no | |
1496
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1501
1497
  | mode | string | no | |
1502
- | taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] | no | |
1503
- | business_type | string | yes | |
1498
+ | business_details | [BusinessDetails](#BusinessDetails) | no | |
1499
+ | modified_on | string | no | |
1504
1500
  | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1501
+ | documents | [[Document](#Document)] | no | |
1502
+ | uid | number | yes | |
1503
+ | taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] | no | |
1504
+ | created_on | string | no | |
1505
1505
 
1506
1506
  ---
1507
1507
 
@@ -1513,9 +1513,9 @@ Returns a success response
1513
1513
  | Properties | Type | Nullable | Description |
1514
1514
  | ---------- | ---- | -------- | ----------- |
1515
1515
  | message | string | no | |
1516
- | status | number | no | |
1517
1516
  | meta | string | no | |
1518
1517
  | code | string | no | |
1518
+ | status | number | no | |
1519
1519
 
1520
1520
  ---
1521
1521
 
@@ -1526,8 +1526,8 @@ Returns a success response
1526
1526
 
1527
1527
  | Properties | Type | Nullable | Description |
1528
1528
  | ---------- | ---- | -------- | ----------- |
1529
- | enable | boolean | no | |
1530
1529
  | rate | number | no | |
1530
+ | enable | boolean | no | |
1531
1531
  | effective_date | string | no | |
1532
1532
 
1533
1533
  ---
@@ -1540,16 +1540,16 @@ Returns a success response
1540
1540
  | Properties | Type | Nullable | Description |
1541
1541
  | ---------- | ---- | -------- | ----------- |
1542
1542
  | country_code | string | no | |
1543
- | pincode | number | yes | |
1544
- | longitude | number | yes | |
1545
- | landmark | string | no | |
1546
- | latitude | number | yes | |
1547
1543
  | country | string | yes | |
1544
+ | pincode | number | yes | |
1548
1545
  | state | string | yes | |
1546
+ | landmark | string | no | |
1549
1547
  | address_type | string | yes | |
1548
+ | longitude | number | yes | |
1550
1549
  | address2 | string | no | |
1551
- | city | string | yes | |
1552
1550
  | address1 | string | yes | |
1551
+ | latitude | number | yes | |
1552
+ | city | string | yes | |
1553
1553
 
1554
1554
  ---
1555
1555
 
@@ -1560,19 +1560,19 @@ Returns a success response
1560
1560
 
1561
1561
  | Properties | Type | Nullable | Description |
1562
1562
  | ---------- | ---- | -------- | ----------- |
1563
+ | business_info | string | no | |
1564
+ | franchise_enabled | boolean | no | |
1565
+ | warnings | string | no | |
1563
1566
  | contact_details | [ContactDetails](#ContactDetails) | no | |
1564
- | company_type | string | no | |
1565
1567
  | reject_reason | string | no | |
1566
- | notification_emails | [string] | no | |
1567
- | _custom_json | string | no | |
1568
- | warnings | string | no | |
1569
- | taxes | [[CompanyTaxesSerializer1](#CompanyTaxesSerializer1)] | no | |
1570
- | documents | [[Document](#Document)] | no | |
1571
- | franchise_enabled | boolean | no | |
1572
- | business_details | [BusinessDetails](#BusinessDetails) | no | |
1573
1568
  | name | string | no | |
1574
- | business_info | 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 | |
1575
1574
  | business_type | string | no | |
1575
+ | notification_emails | [string] | no | |
1576
1576
  | addresses | [[CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)] | no | |
1577
1577
 
1578
1578
  ---
@@ -1584,8 +1584,8 @@ Returns a success response
1584
1584
 
1585
1585
  | Properties | Type | Nullable | Description |
1586
1586
  | ---------- | ---- | -------- | ----------- |
1587
- | success | boolean | no | |
1588
1587
  | uid | number | no | |
1588
+ | success | boolean | no | |
1589
1589
 
1590
1590
  ---
1591
1591
 
@@ -1596,8 +1596,8 @@ Returns a success response
1596
1596
 
1597
1597
  | Properties | Type | Nullable | Description |
1598
1598
  | ---------- | ---- | -------- | ----------- |
1599
- | verified | number | no | |
1600
1599
  | pending | number | no | |
1600
+ | verified | number | no | |
1601
1601
 
1602
1602
  ---
1603
1603
 
@@ -1608,13 +1608,13 @@ Returns a success response
1608
1608
 
1609
1609
  | Properties | Type | Nullable | Description |
1610
1610
  | ---------- | ---- | -------- | ----------- |
1611
- | stage | string | no | |
1612
- | uid | number | no | |
1613
1611
  | store_documents | [DocumentsObj](#DocumentsObj) | no | |
1612
+ | product | [DocumentsObj](#DocumentsObj) | no | |
1614
1613
  | brand | [DocumentsObj](#DocumentsObj) | no | |
1615
1614
  | company_documents | [DocumentsObj](#DocumentsObj) | no | |
1615
+ | stage | string | no | |
1616
+ | uid | number | no | |
1616
1617
  | store | [DocumentsObj](#DocumentsObj) | no | |
1617
- | product | [DocumentsObj](#DocumentsObj) | no | |
1618
1618
 
1619
1619
  ---
1620
1620
 
@@ -1637,25 +1637,25 @@ Returns a success response
1637
1637
 
1638
1638
  | Properties | Type | Nullable | Description |
1639
1639
  | ---------- | ---- | -------- | ----------- |
1640
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1641
- | slug_key | string | no | |
1642
- | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1640
+ | verified_on | string | no | |
1641
+ | stage | string | no | |
1642
+ | _custom_json | string | no | |
1643
+ | synonyms | [string] | no | |
1643
1644
  | logo | string | no | |
1644
1645
  | warnings | string | no | |
1645
- | _locale_language | string | no | |
1646
1646
  | name | string | yes | |
1647
- | stage | string | no | |
1648
- | created_on | string | no | |
1649
- | synonyms | [string] | no | |
1650
1647
  | created_by | [UserSerializer](#UserSerializer) | no | |
1651
- | verified_on | string | no | |
1652
- | _custom_json | string | no | |
1653
1648
  | modified_by | [UserSerializer](#UserSerializer) | no | |
1654
- | uid | number | no | |
1655
- | modified_on | string | no | |
1649
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1656
1650
  | mode | string | no | |
1657
1651
  | reject_reason | string | no | |
1652
+ | modified_on | string | no | |
1653
+ | slug_key | string | no | |
1658
1654
  | description | string | no | |
1655
+ | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1656
+ | uid | number | no | |
1657
+ | created_on | string | no | |
1658
+ | _locale_language | string | no | |
1659
1659
 
1660
1660
  ---
1661
1661
 
@@ -1666,16 +1666,33 @@ Returns a success response
1666
1666
 
1667
1667
  | Properties | Type | Nullable | Description |
1668
1668
  | ---------- | ---- | -------- | ----------- |
1669
+ | description | string | no | |
1670
+ | brand_tier | string | no | |
1671
+ | logo | string | yes | |
1672
+ | name | string | yes | |
1673
+ | company_id | number | no | |
1669
1674
  | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1670
- | synonyms | [string] | no | |
1671
1675
  | uid | number | no | |
1672
- | logo | string | yes | |
1673
1676
  | _custom_json | string | no | |
1674
- | company_id | number | no | |
1675
- | description | string | no | |
1676
- | brand_tier | string | no | |
1677
1677
  | _locale_language | string | no | |
1678
- | name | string | yes | |
1678
+ | synonyms | [string] | no | |
1679
+
1680
+ ---
1681
+
1682
+
1683
+
1684
+
1685
+ #### [Page](#Page)
1686
+
1687
+ | 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 | |
1679
1696
 
1680
1697
  ---
1681
1698
 
@@ -1710,23 +1727,23 @@ Returns a success response
1710
1727
 
1711
1728
  | Properties | Type | Nullable | Description |
1712
1729
  | ---------- | ---- | -------- | ----------- |
1730
+ | details | [CompanyDetails](#CompanyDetails) | no | |
1731
+ | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
1732
+ | created_by | [UserSerializer](#UserSerializer) | no | |
1733
+ | verified_on | string | no | |
1713
1734
  | verified_by | [UserSerializer](#UserSerializer) | no | |
1714
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1735
+ | reject_reason | string | no | |
1715
1736
  | stage | string | no | |
1737
+ | name | string | no | |
1716
1738
  | company_type | string | yes | |
1717
- | created_by | [UserSerializer](#UserSerializer) | no | |
1718
1739
  | uid | number | no | |
1740
+ | _custom_json | string | no | |
1719
1741
  | modified_on | string | no | |
1720
- | verified_on | string | no | |
1721
- | reject_reason | string | no | |
1742
+ | business_type | string | yes | |
1743
+ | created_on | string | no | |
1722
1744
  | notification_emails | [string] | no | |
1723
- | _custom_json | string | no | |
1724
- | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
1725
1745
  | market_channels | [string] | no | |
1726
- | created_on | string | no | |
1727
- | details | [CompanyDetails](#CompanyDetails) | no | |
1728
- | name | string | no | |
1729
- | business_type | string | yes | |
1746
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1730
1747
  | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1731
1748
 
1732
1749
  ---
@@ -1738,35 +1755,18 @@ Returns a success response
1738
1755
 
1739
1756
  | Properties | Type | Nullable | Description |
1740
1757
  | ---------- | ---- | -------- | ----------- |
1758
+ | company | [CompanySerializer](#CompanySerializer) | no | |
1759
+ | created_by | [UserSerializer](#UserSerializer) | no | |
1760
+ | brand | [GetBrandResponseSerializer](#GetBrandResponseSerializer) | no | |
1761
+ | verified_on | string | no | |
1741
1762
  | verified_by | [UserSerializer](#UserSerializer) | no | |
1742
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1763
+ | warnings | string | no | |
1764
+ | reject_reason | string | no | |
1743
1765
  | stage | string | no | |
1744
- | created_by | [UserSerializer](#UserSerializer) | no | |
1745
1766
  | uid | number | no | |
1746
1767
  | modified_on | string | no | |
1747
- | verified_on | string | no | |
1748
- | reject_reason | string | no | |
1749
- | warnings | string | no | |
1750
- | brand | [GetBrandResponseSerializer](#GetBrandResponseSerializer) | no | |
1751
1768
  | created_on | string | no | |
1752
- | company | [CompanySerializer](#CompanySerializer) | no | |
1753
-
1754
- ---
1755
-
1756
-
1757
-
1758
-
1759
- #### [Page](#Page)
1760
-
1761
- | Properties | Type | Nullable | Description |
1762
- | ---------- | ---- | -------- | ----------- |
1763
- | next_id | string | no | |
1764
- | item_total | number | no | |
1765
- | has_previous | boolean | no | |
1766
- | has_next | boolean | no | |
1767
- | current | number | no | |
1768
- | type | string | yes | |
1769
- | size | number | no | |
1769
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1770
1770
 
1771
1771
  ---
1772
1772
 
@@ -1777,8 +1777,8 @@ Returns a success response
1777
1777
 
1778
1778
  | Properties | Type | Nullable | Description |
1779
1779
  | ---------- | ---- | -------- | ----------- |
1780
- | items | [[CompanyBrandSerializer](#CompanyBrandSerializer)] | no | |
1781
1780
  | page | [Page](#Page) | no | |
1781
+ | items | [[CompanyBrandSerializer](#CompanyBrandSerializer)] | no | |
1782
1782
 
1783
1783
  ---
1784
1784
 
@@ -1790,84 +1790,84 @@ Returns a success response
1790
1790
  | Properties | Type | Nullable | Description |
1791
1791
  | ---------- | ---- | -------- | ----------- |
1792
1792
  | company | number | yes | |
1793
- | brands | [number] | yes | |
1794
1793
  | uid | number | no | |
1794
+ | brands | [number] | yes | |
1795
1795
 
1796
1796
  ---
1797
1797
 
1798
1798
 
1799
1799
 
1800
1800
 
1801
- #### [LocationTimingSerializer](#LocationTimingSerializer)
1801
+ #### [ProductReturnConfigSerializer](#ProductReturnConfigSerializer)
1802
1802
 
1803
1803
  | Properties | Type | Nullable | Description |
1804
1804
  | ---------- | ---- | -------- | ----------- |
1805
- | hour | number | yes | |
1806
- | minute | number | yes | |
1805
+ | on_same_store | boolean | no | |
1806
+ | store_uid | number | no | |
1807
1807
 
1808
1808
  ---
1809
1809
 
1810
1810
 
1811
1811
 
1812
1812
 
1813
- #### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
1813
+ #### [HolidayDateSerializer](#HolidayDateSerializer)
1814
1814
 
1815
1815
  | Properties | Type | Nullable | Description |
1816
1816
  | ---------- | ---- | -------- | ----------- |
1817
- | opening | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1818
- | weekday | string | yes | |
1819
- | open | boolean | yes | |
1820
- | closing | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1817
+ | end_date | string | yes | |
1818
+ | start_date | string | yes | |
1821
1819
 
1822
1820
  ---
1823
1821
 
1824
1822
 
1825
1823
 
1826
1824
 
1827
- #### [HolidayDateSerializer](#HolidayDateSerializer)
1825
+ #### [HolidaySchemaSerializer](#HolidaySchemaSerializer)
1828
1826
 
1829
1827
  | Properties | Type | Nullable | Description |
1830
1828
  | ---------- | ---- | -------- | ----------- |
1831
- | end_date | string | yes | |
1832
- | start_date | string | yes | |
1829
+ | title | string | yes | |
1830
+ | holiday_type | string | yes | |
1831
+ | date | [HolidayDateSerializer](#HolidayDateSerializer) | yes | |
1833
1832
 
1834
1833
  ---
1835
1834
 
1836
1835
 
1837
1836
 
1838
1837
 
1839
- #### [HolidaySchemaSerializer](#HolidaySchemaSerializer)
1838
+ #### [LocationTimingSerializer](#LocationTimingSerializer)
1840
1839
 
1841
1840
  | Properties | Type | Nullable | Description |
1842
1841
  | ---------- | ---- | -------- | ----------- |
1843
- | date | [HolidayDateSerializer](#HolidayDateSerializer) | yes | |
1844
- | holiday_type | string | yes | |
1845
- | title | string | yes | |
1842
+ | minute | number | yes | |
1843
+ | hour | number | yes | |
1846
1844
 
1847
1845
  ---
1848
1846
 
1849
1847
 
1850
1848
 
1851
1849
 
1852
- #### [InvoiceCredSerializer](#InvoiceCredSerializer)
1850
+ #### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
1853
1851
 
1854
1852
  | Properties | Type | Nullable | Description |
1855
1853
  | ---------- | ---- | -------- | ----------- |
1856
- | password | string | no | |
1857
- | enabled | boolean | no | |
1858
- | username | string | no | |
1854
+ | closing | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1855
+ | opening | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1856
+ | open | boolean | yes | |
1857
+ | weekday | string | yes | |
1859
1858
 
1860
1859
  ---
1861
1860
 
1862
1861
 
1863
1862
 
1864
1863
 
1865
- #### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
1864
+ #### [LocationManagerSerializer](#LocationManagerSerializer)
1866
1865
 
1867
1866
  | Properties | Type | Nullable | Description |
1868
1867
  | ---------- | ---- | -------- | ----------- |
1869
- | e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1870
- | e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1868
+ | email | string | no | |
1869
+ | name | string | no | |
1870
+ | mobile_no | [SellerPhoneNumber](#SellerPhoneNumber) | yes | |
1871
1871
 
1872
1872
  ---
1873
1873
 
@@ -1878,18 +1878,18 @@ Returns a success response
1878
1878
 
1879
1879
  | Properties | Type | Nullable | Description |
1880
1880
  | ---------- | ---- | -------- | ----------- |
1881
+ | created_by | [UserSerializer](#UserSerializer) | no | |
1882
+ | verified_on | string | no | |
1881
1883
  | verified_by | [UserSerializer](#UserSerializer) | no | |
1882
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1884
+ | reject_reason | string | no | |
1883
1885
  | stage | string | no | |
1886
+ | name | string | no | |
1884
1887
  | company_type | string | no | |
1885
- | created_by | [UserSerializer](#UserSerializer) | no | |
1886
1888
  | uid | number | no | |
1887
1889
  | modified_on | string | no | |
1888
- | verified_on | string | no | |
1889
- | reject_reason | string | no | |
1890
- | created_on | string | no | |
1891
- | name | string | no | |
1892
1890
  | business_type | string | no | |
1891
+ | created_on | string | no | |
1892
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1893
1893
  | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1894
1894
 
1895
1895
  ---
@@ -1897,25 +1897,25 @@ Returns a success response
1897
1897
 
1898
1898
 
1899
1899
 
1900
- #### [ProductReturnConfigSerializer](#ProductReturnConfigSerializer)
1900
+ #### [InvoiceCredSerializer](#InvoiceCredSerializer)
1901
1901
 
1902
1902
  | Properties | Type | Nullable | Description |
1903
1903
  | ---------- | ---- | -------- | ----------- |
1904
- | on_same_store | boolean | no | |
1905
- | store_uid | number | no | |
1904
+ | password | string | no | |
1905
+ | enabled | boolean | no | |
1906
+ | username | string | no | |
1906
1907
 
1907
1908
  ---
1908
1909
 
1909
1910
 
1910
1911
 
1911
1912
 
1912
- #### [LocationManagerSerializer](#LocationManagerSerializer)
1913
+ #### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
1913
1914
 
1914
1915
  | Properties | Type | Nullable | Description |
1915
1916
  | ---------- | ---- | -------- | ----------- |
1916
- | email | string | no | |
1917
- | name | string | no | |
1918
- | mobile_no | [SellerPhoneNumber](#SellerPhoneNumber) | yes | |
1917
+ | e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1918
+ | e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1919
1919
 
1920
1920
  ---
1921
1921
 
@@ -1926,31 +1926,31 @@ Returns a success response
1926
1926
 
1927
1927
  | Properties | Type | Nullable | Description |
1928
1928
  | ---------- | ---- | -------- | ----------- |
1929
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1930
- | notification_emails | [string] | no | |
1929
+ | verified_on | string | no | |
1930
+ | stage | string | no | |
1931
+ | display_name | string | yes | |
1932
+ | _custom_json | string | no | |
1933
+ | phone_number | string | no | |
1931
1934
  | warnings | string | no | |
1935
+ | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
1932
1936
  | name | string | yes | |
1933
- | stage | string | no | |
1934
- | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
1935
- | store_type | string | no | |
1936
- | created_on | string | no | |
1937
- | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1938
1937
  | holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
1938
+ | notification_emails | [string] | no | |
1939
1939
  | created_by | [UserSerializer](#UserSerializer) | no | |
1940
- | verified_on | string | no | |
1941
- | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
1942
- | _custom_json | string | no | |
1943
- | phone_number | string | no | |
1944
- | documents | [[Document](#Document)] | no | |
1945
- | company | [GetCompanySerializer](#GetCompanySerializer) | no | |
1946
1940
  | modified_by | [UserSerializer](#UserSerializer) | no | |
1947
- | address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
1948
- | uid | number | no | |
1941
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1942
+ | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
1943
+ | code | string | yes | |
1949
1944
  | modified_on | string | no | |
1950
- | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
1951
1945
  | manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
1952
- | code | string | yes | |
1953
- | display_name | string | yes | |
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 | |
1954
1954
 
1955
1955
  ---
1956
1956
 
@@ -1961,8 +1961,8 @@ Returns a success response
1961
1961
 
1962
1962
  | Properties | Type | Nullable | Description |
1963
1963
  | ---------- | ---- | -------- | ----------- |
1964
- | items | [[GetLocationSerializer](#GetLocationSerializer)] | no | |
1965
1964
  | page | [Page](#Page) | no | |
1965
+ | items | [[GetLocationSerializer](#GetLocationSerializer)] | no | |
1966
1966
 
1967
1967
  ---
1968
1968
 
@@ -1974,16 +1974,16 @@ Returns a success response
1974
1974
  | Properties | Type | Nullable | Description |
1975
1975
  | ---------- | ---- | -------- | ----------- |
1976
1976
  | country_code | string | no | |
1977
+ | country | string | no | |
1977
1978
  | pincode | number | no | |
1978
- | longitude | number | yes | |
1979
+ | state | string | no | |
1979
1980
  | landmark | string | no | |
1980
- | latitude | number | yes | |
1981
- | country | string | no | |
1982
1981
  | address_type | string | no | |
1983
- | state | string | no | |
1982
+ | longitude | number | yes | |
1984
1983
  | address2 | string | no | |
1985
- | city | string | no | |
1986
1984
  | address1 | string | no | |
1985
+ | latitude | number | yes | |
1986
+ | city | string | no | |
1987
1987
 
1988
1988
  ---
1989
1989
 
@@ -1994,24 +1994,24 @@ Returns a success response
1994
1994
 
1995
1995
  | Properties | Type | Nullable | Description |
1996
1996
  | ---------- | ---- | -------- | ----------- |
1997
- | address | [AddressSerializer](#AddressSerializer) | yes | |
1998
- | stage | string | no | |
1999
- | uid | number | no | |
2000
- | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
1997
+ | company | number | yes | |
2001
1998
  | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
2002
- | manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
2003
- | code | string | yes | |
2004
- | notification_emails | [string] | no | |
2005
- | _custom_json | string | no | |
1999
+ | store_type | string | no | |
2006
2000
  | warnings | string | no | |
2007
- | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
2001
+ | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2002
+ | code | string | yes | |
2003
+ | name | string | yes | |
2004
+ | holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
2005
+ | stage | string | no | |
2008
2006
  | display_name | string | yes | |
2009
- | store_type | string | no | |
2010
2007
  | documents | [[Document](#Document)] | no | |
2008
+ | uid | number | no | |
2011
2009
  | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
2012
- | name | string | yes | |
2013
- | holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
2014
- | company | number | yes | |
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 | |
2015
2015
 
2016
2016
  ---
2017
2017