@gofynd/fdk-client-javascript 0.1.35 → 0.1.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/README.md +1 -1
  2. package/documentation/application/CART.md +256 -239
  3. package/documentation/application/CATALOG.md +413 -409
  4. package/documentation/application/COMMON.md +4 -0
  5. package/documentation/application/COMMUNICATION.md +4 -0
  6. package/documentation/application/CONFIGURATION.md +4 -0
  7. package/documentation/application/CONTENT.md +7 -20
  8. package/documentation/application/FILESTORAGE.md +85 -0
  9. package/documentation/application/LEAD.md +6 -2
  10. package/documentation/application/LOGISTIC.md +4 -0
  11. package/documentation/application/ORDER.md +307 -303
  12. package/documentation/application/PAYMENT.md +445 -259
  13. package/documentation/application/POSCART.md +317 -300
  14. package/documentation/application/REWARDS.md +153 -160
  15. package/documentation/application/SHARE.md +4 -0
  16. package/documentation/application/THEME.md +4 -0
  17. package/documentation/application/USER.md +4 -0
  18. package/documentation/platform/ANALYTICS.md +4 -0
  19. package/documentation/platform/AUDITTRAIL.md +4 -0
  20. package/documentation/platform/BILLING.md +4 -0
  21. package/documentation/platform/CART.md +480 -463
  22. package/documentation/platform/CATALOG.md +3895 -2942
  23. package/documentation/platform/COMMON.md +4 -0
  24. package/documentation/platform/COMMUNICATION.md +4 -0
  25. package/documentation/platform/COMPANYPROFILE.md +224 -193
  26. package/documentation/platform/CONFIGURATION.md +4 -0
  27. package/documentation/platform/CONTENT.md +8 -21
  28. package/documentation/platform/DISCOUNT.md +4 -0
  29. package/documentation/platform/FILESTORAGE.md +85 -0
  30. package/documentation/platform/INVENTORY.md +4 -0
  31. package/documentation/platform/LEAD.md +6 -2
  32. package/documentation/platform/ORDER.md +6298 -1448
  33. package/documentation/platform/PARTNER.md +12 -8
  34. package/documentation/platform/PAYMENT.md +107 -103
  35. package/documentation/platform/README.md +2 -2
  36. package/documentation/platform/REWARDS.md +219 -152
  37. package/documentation/platform/SHARE.md +4 -0
  38. package/documentation/platform/THEME.md +4 -0
  39. package/documentation/platform/USER.md +4 -0
  40. package/documentation/platform/WEBHOOK.md +4 -0
  41. package/documentation/public/CONFIGURATION.md +4 -0
  42. package/documentation/public/INVENTORY.md +4 -0
  43. package/documentation/public/WEBHOOK.md +4 -0
  44. package/package.json +1 -1
  45. package/sdk/application/ApplicationModels.d.ts +77 -73
  46. package/sdk/application/ApplicationModels.js +1751 -1725
  47. package/sdk/application/client/CartApplicationClient.d.ts +36 -36
  48. package/sdk/application/client/CatalogApplicationClient.d.ts +39 -39
  49. package/sdk/application/client/CatalogApplicationClient.js +16 -16
  50. package/sdk/application/client/CommonApplicationClient.d.ts +2 -2
  51. package/sdk/application/client/CommunicationApplicationClient.d.ts +5 -5
  52. package/sdk/application/client/ConfigurationApplicationClient.d.ts +17 -17
  53. package/sdk/application/client/ContentApplicationClient.d.ts +19 -19
  54. package/sdk/application/client/FileStorageApplicationClient.d.ts +14 -6
  55. package/sdk/application/client/FileStorageApplicationClient.js +2 -0
  56. package/sdk/application/client/LeadApplicationClient.d.ts +10 -10
  57. package/sdk/application/client/LogisticApplicationClient.d.ts +5 -5
  58. package/sdk/application/client/OrderApplicationClient.d.ts +15 -15
  59. package/sdk/application/client/OrderApplicationClient.js +1 -1
  60. package/sdk/application/client/PaymentApplicationClient.d.ts +79 -57
  61. package/sdk/application/client/PaymentApplicationClient.js +66 -0
  62. package/sdk/application/client/PosCartApplicationClient.d.ts +38 -38
  63. package/sdk/application/client/RewardsApplicationClient.d.ts +34 -34
  64. package/sdk/application/client/RewardsApplicationClient.js +77 -77
  65. package/sdk/application/client/ShareApplicationClient.d.ts +8 -8
  66. package/sdk/application/client/ThemeApplicationClient.d.ts +4 -4
  67. package/sdk/application/client/UserApplicationClient.d.ts +63 -63
  68. package/sdk/application/models/CatalogValidator.d.ts +1 -1
  69. package/sdk/application/models/CatalogValidator.js +2 -2
  70. package/sdk/application/models/PaymentValidator.d.ts +2 -0
  71. package/sdk/application/models/PaymentValidator.js +12 -0
  72. package/sdk/application/models/RewardsValidator.d.ts +3 -3
  73. package/sdk/application/models/RewardsValidator.js +12 -12
  74. package/sdk/common/AxiosHelper.js +1 -1
  75. package/sdk/common/Constant.d.ts +9 -0
  76. package/sdk/common/Constant.js +11 -0
  77. package/sdk/platform/PlatformApplicationClient.d.ts +8600 -7286
  78. package/sdk/platform/PlatformApplicationClient.js +4338 -3678
  79. package/sdk/platform/PlatformApplicationModels.d.ts +21 -26
  80. package/sdk/platform/PlatformApplicationModels.js +5561 -4301
  81. package/sdk/platform/PlatformClient.d.ts +3448 -2801
  82. package/sdk/platform/PlatformClient.js +3903 -3108
  83. package/sdk/platform/PlatformModels.d.ts +352 -278
  84. package/sdk/platform/PlatformModels.js +5230 -3942
  85. package/sdk/platform/client/AnalyticsPlatformClient.d.ts +5 -5
  86. package/sdk/platform/client/AuditTrailPlatformClient.d.ts +1 -1
  87. package/sdk/platform/client/BillingPlatformClient.d.ts +4 -4
  88. package/sdk/platform/client/CatalogPlatformClient.d.ts +209 -150
  89. package/sdk/platform/client/CatalogPlatformClient.js +441 -294
  90. package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +8 -8
  91. package/sdk/platform/client/ConfigurationPlatformClient.d.ts +9 -9
  92. package/sdk/platform/client/DiscountPlatformClient.d.ts +4 -4
  93. package/sdk/platform/client/FileStoragePlatformClient.d.ts +20 -4
  94. package/sdk/platform/client/FileStoragePlatformClient.js +49 -0
  95. package/sdk/platform/client/InventoryPlatformClient.d.ts +3 -3
  96. package/sdk/platform/client/LeadPlatformClient.d.ts +6 -6
  97. package/sdk/platform/client/OrderPlatformClient.d.ts +557 -131
  98. package/sdk/platform/client/OrderPlatformClient.js +1551 -247
  99. package/sdk/platform/client/PaymentPlatformClient.d.ts +4 -4
  100. package/sdk/platform/client/WebhookPlatformClient.d.ts +2 -2
  101. package/sdk/platform/models/CatalogValidator.d.ts +24 -21
  102. package/sdk/platform/models/CatalogValidator.js +103 -72
  103. package/sdk/platform/models/OrderValidator.d.ts +43 -11
  104. package/sdk/platform/models/OrderValidator.js +312 -51
  105. package/sdk/public/client/ConfigurationPublicClient.d.ts +2 -2
  106. package/sdk/public/client/InventoryPublicClient.d.ts +7 -7
  107. package/sdk/public/client/WebhookPublicClient.d.ts +3 -3
  108. package/tests/common/schema/action-url.json +15 -0
  109. package/tests/common/schema/url-action.json +16 -0
@@ -2,10 +2,12 @@
2
2
 
3
3
 
4
4
 
5
+
5
6
  ##### [Back to Platform docs](./README.md)
6
7
 
7
8
  ## CompanyProfile Methods
8
9
 
10
+
9
11
  * [cbsOnboardGet](#cbsonboardget)
10
12
  * [updateCompany](#updatecompany)
11
13
  * [getCompanyMetrics](#getcompanymetrics)
@@ -26,6 +28,8 @@
26
28
  ## Methods with example and description
27
29
 
28
30
 
31
+
32
+
29
33
  ### cbsOnboardGet
30
34
  Get company profile
31
35
 
@@ -1431,33 +1435,34 @@ Returns a success response
1431
1435
 
1432
1436
 
1433
1437
 
1434
- #### [GetAddressSerializer](#GetAddressSerializer)
1438
+ #### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
1435
1439
 
1436
1440
  | Properties | Type | Nullable | Description |
1437
1441
  | ---------- | ---- | -------- | ----------- |
1438
- | address1 | string | no | |
1439
- | longitude | number | no | |
1440
- | state | string | no | |
1441
- | latitude | number | no | |
1442
- | country | string | no | |
1443
- | address_type | string | no | |
1444
- | city | string | no | |
1445
- | country_code | string | no | |
1446
- | landmark | string | no | |
1447
- | pincode | number | no | |
1448
- | address2 | string | no | |
1442
+ | effective_date | string | no | |
1443
+ | rate | number | no | |
1444
+ | enable | boolean | no | |
1449
1445
 
1450
1446
  ---
1451
1447
 
1452
1448
 
1453
1449
 
1454
1450
 
1455
- #### [BusinessCountryInfo](#BusinessCountryInfo)
1451
+ #### [GetAddressSerializer](#GetAddressSerializer)
1456
1452
 
1457
1453
  | Properties | Type | Nullable | Description |
1458
1454
  | ---------- | ---- | -------- | ----------- |
1455
+ | address1 | string | no | |
1456
+ | landmark | string | no | |
1457
+ | longitude | number | no | |
1458
+ | latitude | number | no | |
1459
+ | address2 | string | no | |
1460
+ | pincode | number | no | |
1459
1461
  | country_code | string | no | |
1462
+ | state | string | no | |
1463
+ | city | string | no | |
1460
1464
  | country | string | no | |
1465
+ | address_type | string | no | |
1461
1466
 
1462
1467
  ---
1463
1468
 
@@ -1477,13 +1482,12 @@ Returns a success response
1477
1482
 
1478
1483
 
1479
1484
 
1480
- #### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
1485
+ #### [BusinessCountryInfo](#BusinessCountryInfo)
1481
1486
 
1482
1487
  | Properties | Type | Nullable | Description |
1483
1488
  | ---------- | ---- | -------- | ----------- |
1484
- | rate | number | no | |
1485
- | effective_date | string | no | |
1486
- | enable | boolean | no | |
1489
+ | country_code | string | no | |
1490
+ | country | string | no | |
1487
1491
 
1488
1492
  ---
1489
1493
 
@@ -1512,39 +1516,39 @@ Returns a success response
1512
1516
 
1513
1517
 
1514
1518
 
1515
- #### [SellerPhoneNumber](#SellerPhoneNumber)
1519
+ #### [Document](#Document)
1516
1520
 
1517
1521
  | Properties | Type | Nullable | Description |
1518
1522
  | ---------- | ---- | -------- | ----------- |
1519
- | country_code | number | yes | |
1520
- | number | string | yes | |
1523
+ | value | string | yes | |
1524
+ | url | string | no | |
1525
+ | legal_name | string | no | |
1526
+ | verified | boolean | no | |
1527
+ | type | string | yes | |
1521
1528
 
1522
1529
  ---
1523
1530
 
1524
1531
 
1525
1532
 
1526
1533
 
1527
- #### [ContactDetails](#ContactDetails)
1534
+ #### [SellerPhoneNumber](#SellerPhoneNumber)
1528
1535
 
1529
1536
  | Properties | Type | Nullable | Description |
1530
1537
  | ---------- | ---- | -------- | ----------- |
1531
- | phone | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1532
- | emails | [string] | no | |
1538
+ | country_code | number | yes | |
1539
+ | number | string | yes | |
1533
1540
 
1534
1541
  ---
1535
1542
 
1536
1543
 
1537
1544
 
1538
1545
 
1539
- #### [Document](#Document)
1546
+ #### [ContactDetails](#ContactDetails)
1540
1547
 
1541
1548
  | Properties | Type | Nullable | Description |
1542
1549
  | ---------- | ---- | -------- | ----------- |
1543
- | type | string | yes | |
1544
- | url | string | no | |
1545
- | verified | boolean | no | |
1546
- | value | string | yes | |
1547
- | legal_name | string | no | |
1550
+ | emails | [string] | no | |
1551
+ | phone | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1548
1552
 
1549
1553
  ---
1550
1554
 
@@ -1555,29 +1559,29 @@ Returns a success response
1555
1559
 
1556
1560
  | Properties | Type | Nullable | Description |
1557
1561
  | ---------- | ---- | -------- | ----------- |
1558
- | uid | number | yes | |
1559
- | business_type | string | yes | |
1560
- | franchise_enabled | boolean | no | |
1561
- | warnings | string | no | |
1562
- | mode | string | no | |
1562
+ | created_on | string | no | |
1563
+ | taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] | no | |
1563
1564
  | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1564
- | name | string | no | |
1565
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1566
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1565
1567
  | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
1568
+ | company_type | string | yes | |
1569
+ | _custom_json | string | no | |
1570
+ | notification_emails | [string] | no | |
1571
+ | business_info | string | no | |
1572
+ | warnings | string | no | |
1573
+ | modified_on | string | no | |
1574
+ | mode | string | no | |
1566
1575
  | stage | string | no | |
1576
+ | business_type | string | yes | |
1577
+ | verified_on | string | no | |
1567
1578
  | created_by | [UserSerializer](#UserSerializer) | no | |
1568
- | taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] | no | |
1579
+ | uid | number | yes | |
1580
+ | franchise_enabled | boolean | no | |
1581
+ | name | string | no | |
1569
1582
  | business_details | [BusinessDetails](#BusinessDetails) | no | |
1570
- | business_info | string | no | |
1571
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1572
- | modified_on | string | no | |
1573
- | company_type | string | yes | |
1574
- | contact_details | [ContactDetails](#ContactDetails) | no | |
1575
- | created_on | string | no | |
1576
1583
  | documents | [[Document](#Document)] | no | |
1577
- | notification_emails | [string] | no | |
1578
- | _custom_json | string | no | |
1579
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1580
- | verified_on | string | no | |
1584
+ | contact_details | [ContactDetails](#ContactDetails) | no | |
1581
1585
 
1582
1586
  ---
1583
1587
 
@@ -1589,8 +1593,8 @@ Returns a success response
1589
1593
  | Properties | Type | Nullable | Description |
1590
1594
  | ---------- | ---- | -------- | ----------- |
1591
1595
  | message | string | no | |
1592
- | meta | string | no | |
1593
1596
  | status | number | no | |
1597
+ | meta | string | no | |
1594
1598
  | code | string | no | |
1595
1599
 
1596
1600
  ---
@@ -1602,8 +1606,8 @@ Returns a success response
1602
1606
 
1603
1607
  | Properties | Type | Nullable | Description |
1604
1608
  | ---------- | ---- | -------- | ----------- |
1605
- | rate | number | no | |
1606
1609
  | effective_date | string | no | |
1610
+ | rate | number | no | |
1607
1611
  | enable | boolean | no | |
1608
1612
 
1609
1613
  ---
@@ -1616,16 +1620,16 @@ Returns a success response
1616
1620
  | Properties | Type | Nullable | Description |
1617
1621
  | ---------- | ---- | -------- | ----------- |
1618
1622
  | address1 | string | yes | |
1623
+ | landmark | string | no | |
1619
1624
  | longitude | number | yes | |
1620
- | state | string | yes | |
1621
1625
  | latitude | number | yes | |
1622
- | country | string | yes | |
1626
+ | pincode | number | yes | |
1627
+ | address2 | string | no | |
1623
1628
  | country_code | string | no | |
1629
+ | state | string | yes | |
1630
+ | country | string | yes | |
1624
1631
  | city | string | yes | |
1625
1632
  | address_type | string | yes | |
1626
- | landmark | string | no | |
1627
- | pincode | number | yes | |
1628
- | address2 | string | no | |
1629
1633
 
1630
1634
  ---
1631
1635
 
@@ -1636,20 +1640,20 @@ Returns a success response
1636
1640
 
1637
1641
  | Properties | Type | Nullable | Description |
1638
1642
  | ---------- | ---- | -------- | ----------- |
1639
- | name | string | no | |
1643
+ | notification_emails | [string] | no | |
1644
+ | reject_reason | string | no | |
1645
+ | taxes | [[CompanyTaxesSerializer1](#CompanyTaxesSerializer1)] | no | |
1640
1646
  | business_info | string | no | |
1641
- | business_type | string | no | |
1642
1647
  | franchise_enabled | boolean | no | |
1643
- | documents | [[Document](#Document)] | no | |
1644
- | notification_emails | [string] | no | |
1648
+ | addresses | [[CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)] | no | |
1649
+ | company_type | string | no | |
1650
+ | name | string | no | |
1651
+ | business_details | [BusinessDetails](#BusinessDetails) | no | |
1645
1652
  | _custom_json | string | no | |
1646
- | taxes | [[CompanyTaxesSerializer1](#CompanyTaxesSerializer1)] | no | |
1647
1653
  | warnings | string | no | |
1648
- | business_details | [BusinessDetails](#BusinessDetails) | no | |
1649
- | company_type | string | no | |
1654
+ | documents | [[Document](#Document)] | no | |
1655
+ | business_type | string | no | |
1650
1656
  | contact_details | [ContactDetails](#ContactDetails) | no | |
1651
- | reject_reason | string | no | |
1652
- | addresses | [[CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)] | no | |
1653
1657
 
1654
1658
  ---
1655
1659
 
@@ -1660,8 +1664,8 @@ Returns a success response
1660
1664
 
1661
1665
  | Properties | Type | Nullable | Description |
1662
1666
  | ---------- | ---- | -------- | ----------- |
1663
- | success | boolean | no | |
1664
1667
  | uid | number | no | |
1668
+ | success | boolean | no | |
1665
1669
 
1666
1670
  ---
1667
1671
 
@@ -1672,8 +1676,8 @@ Returns a success response
1672
1676
 
1673
1677
  | Properties | Type | Nullable | Description |
1674
1678
  | ---------- | ---- | -------- | ----------- |
1675
- | verified | number | no | |
1676
1679
  | pending | number | no | |
1680
+ | verified | number | no | |
1677
1681
 
1678
1682
  ---
1679
1683
 
@@ -1684,13 +1688,13 @@ Returns a success response
1684
1688
 
1685
1689
  | Properties | Type | Nullable | Description |
1686
1690
  | ---------- | ---- | -------- | ----------- |
1687
- | uid | number | no | |
1688
- | stage | string | no | |
1689
1691
  | store_documents | [DocumentsObj](#DocumentsObj) | no | |
1690
- | brand | [DocumentsObj](#DocumentsObj) | no | |
1691
- | company_documents | [DocumentsObj](#DocumentsObj) | no | |
1692
1692
  | store | [DocumentsObj](#DocumentsObj) | no | |
1693
+ | uid | number | no | |
1693
1694
  | product | [DocumentsObj](#DocumentsObj) | no | |
1695
+ | brand | [DocumentsObj](#DocumentsObj) | no | |
1696
+ | stage | string | no | |
1697
+ | company_documents | [DocumentsObj](#DocumentsObj) | no | |
1694
1698
 
1695
1699
  ---
1696
1700
 
@@ -1713,25 +1717,25 @@ Returns a success response
1713
1717
 
1714
1718
  | Properties | Type | Nullable | Description |
1715
1719
  | ---------- | ---- | -------- | ----------- |
1716
- | uid | number | no | |
1717
- | warnings | string | no | |
1720
+ | created_on | string | no | |
1721
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1722
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1723
+ | synonyms | [string] | no | |
1724
+ | logo | string | no | |
1725
+ | _locale_language | string | no | |
1726
+ | _custom_json | string | no | |
1727
+ | description | string | no | |
1718
1728
  | mode | string | no | |
1719
- | reject_reason | string | no | |
1720
- | name | string | yes | |
1729
+ | modified_on | string | no | |
1730
+ | warnings | string | no | |
1721
1731
  | stage | string | no | |
1732
+ | verified_on | string | no | |
1722
1733
  | created_by | [UserSerializer](#UserSerializer) | no | |
1723
- | synonyms | [string] | no | |
1724
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1725
- | modified_on | string | no | |
1726
- | description | string | no | |
1727
- | _locale_language | string | no | |
1734
+ | reject_reason | string | no | |
1735
+ | uid | number | no | |
1728
1736
  | slug_key | string | no | |
1729
- | logo | string | no | |
1737
+ | name | string | yes | |
1730
1738
  | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1731
- | created_on | string | no | |
1732
- | _custom_json | string | no | |
1733
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1734
- | verified_on | string | no | |
1735
1739
 
1736
1740
  ---
1737
1741
 
@@ -1742,16 +1746,16 @@ Returns a success response
1742
1746
 
1743
1747
  | Properties | Type | Nullable | Description |
1744
1748
  | ---------- | ---- | -------- | ----------- |
1749
+ | description | string | no | |
1745
1750
  | uid | number | no | |
1751
+ | _locale_language | string | no | |
1746
1752
  | name | string | yes | |
1747
- | company_id | number | no | |
1748
1753
  | synonyms | [string] | no | |
1754
+ | company_id | number | no | |
1749
1755
  | _custom_json | string | no | |
1750
- | description | string | no | |
1751
- | _locale_language | string | no | |
1752
- | brand_tier | string | no | |
1753
1756
  | logo | string | yes | |
1754
1757
  | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1758
+ | brand_tier | string | no | |
1755
1759
 
1756
1760
  ---
1757
1761
 
@@ -1762,13 +1766,13 @@ Returns a success response
1762
1766
 
1763
1767
  | Properties | Type | Nullable | Description |
1764
1768
  | ---------- | ---- | -------- | ----------- |
1765
- | size | number | no | |
1766
- | next_id | string | no | |
1767
- | has_previous | boolean | no | |
1769
+ | item_total | number | no | |
1770
+ | has_next | boolean | no | |
1768
1771
  | current | number | no | |
1772
+ | next_id | string | no | |
1769
1773
  | type | string | yes | |
1770
- | has_next | boolean | no | |
1771
- | item_total | number | no | |
1774
+ | size | number | no | |
1775
+ | has_previous | boolean | no | |
1772
1776
 
1773
1777
  ---
1774
1778
 
@@ -1791,8 +1795,8 @@ Returns a success response
1791
1795
 
1792
1796
  | Properties | Type | Nullable | Description |
1793
1797
  | ---------- | ---- | -------- | ----------- |
1794
- | socials | [[CompanySocialAccounts](#CompanySocialAccounts)] | no | |
1795
1798
  | website_url | string | no | |
1799
+ | socials | [[CompanySocialAccounts](#CompanySocialAccounts)] | no | |
1796
1800
 
1797
1801
  ---
1798
1802
 
@@ -1803,24 +1807,24 @@ Returns a success response
1803
1807
 
1804
1808
  | Properties | Type | Nullable | Description |
1805
1809
  | ---------- | ---- | -------- | ----------- |
1806
- | uid | number | no | |
1807
- | name | string | no | |
1808
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1809
- | business_type | string | yes | |
1810
+ | notification_emails | [string] | no | |
1811
+ | verified_on | string | no | |
1810
1812
  | created_by | [UserSerializer](#UserSerializer) | no | |
1811
- | stage | string | no | |
1812
1813
  | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
1813
- | modified_on | string | no | |
1814
- | details | [CompanyDetails](#CompanyDetails) | no | |
1815
- | notification_emails | [string] | no | |
1816
- | _custom_json | string | no | |
1817
1814
  | created_on | string | no | |
1818
- | market_channels | [string] | no | |
1819
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1820
- | company_type | string | yes | |
1821
1815
  | reject_reason | string | no | |
1822
- | verified_on | string | no | |
1816
+ | uid | number | no | |
1823
1817
  | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1818
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1819
+ | name | string | no | |
1820
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1821
+ | company_type | string | yes | |
1822
+ | details | [CompanyDetails](#CompanyDetails) | no | |
1823
+ | market_channels | [string] | no | |
1824
+ | _custom_json | string | no | |
1825
+ | modified_on | string | no | |
1826
+ | stage | string | no | |
1827
+ | business_type | string | yes | |
1824
1828
 
1825
1829
  ---
1826
1830
 
@@ -1831,18 +1835,18 @@ Returns a success response
1831
1835
 
1832
1836
  | Properties | Type | Nullable | Description |
1833
1837
  | ---------- | ---- | -------- | ----------- |
1838
+ | verified_on | string | no | |
1839
+ | created_by | [UserSerializer](#UserSerializer) | no | |
1840
+ | created_on | string | no | |
1841
+ | reject_reason | string | no | |
1834
1842
  | uid | number | no | |
1835
- | stage | string | no | |
1836
1843
  | verified_by | [UserSerializer](#UserSerializer) | no | |
1844
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1837
1845
  | company | [CompanySerializer](#CompanySerializer) | no | |
1838
- | created_by | [UserSerializer](#UserSerializer) | no | |
1839
- | modified_on | string | no | |
1840
- | warnings | string | no | |
1841
- | created_on | string | no | |
1842
1846
  | brand | [GetBrandResponseSerializer](#GetBrandResponseSerializer) | no | |
1843
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1844
- | reject_reason | string | no | |
1845
- | verified_on | string | no | |
1847
+ | warnings | string | no | |
1848
+ | modified_on | string | no | |
1849
+ | stage | string | no | |
1846
1850
 
1847
1851
  ---
1848
1852
 
@@ -1874,60 +1878,61 @@ Returns a success response
1874
1878
 
1875
1879
 
1876
1880
 
1877
- #### [GetCompanySerializer](#GetCompanySerializer)
1881
+ #### [LocationTimingSerializer](#LocationTimingSerializer)
1878
1882
 
1879
1883
  | Properties | Type | Nullable | Description |
1880
1884
  | ---------- | ---- | -------- | ----------- |
1881
- | uid | number | no | |
1882
- | name | string | no | |
1883
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1884
- | business_type | string | no | |
1885
- | created_by | [UserSerializer](#UserSerializer) | no | |
1886
- | stage | string | no | |
1887
- | modified_on | string | no | |
1888
- | created_on | string | no | |
1889
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1890
- | company_type | string | no | |
1891
- | reject_reason | string | no | |
1892
- | verified_on | string | no | |
1893
- | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1885
+ | minute | number | yes | |
1886
+ | hour | number | yes | |
1894
1887
 
1895
1888
  ---
1896
1889
 
1897
1890
 
1898
1891
 
1899
1892
 
1900
- #### [InvoiceCredSerializer](#InvoiceCredSerializer)
1893
+ #### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
1901
1894
 
1902
1895
  | Properties | Type | Nullable | Description |
1903
1896
  | ---------- | ---- | -------- | ----------- |
1904
- | password | string | no | |
1905
- | username | string | no | |
1906
- | enabled | boolean | no | |
1897
+ | opening | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1898
+ | weekday | string | yes | |
1899
+ | open | boolean | yes | |
1900
+ | closing | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1907
1901
 
1908
1902
  ---
1909
1903
 
1910
1904
 
1911
1905
 
1912
1906
 
1913
- #### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
1907
+ #### [ProductReturnConfigSerializer](#ProductReturnConfigSerializer)
1914
1908
 
1915
1909
  | Properties | Type | Nullable | Description |
1916
1910
  | ---------- | ---- | -------- | ----------- |
1917
- | e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1918
- | e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1911
+ | on_same_store | boolean | no | |
1912
+ | store_uid | number | no | |
1919
1913
 
1920
1914
  ---
1921
1915
 
1922
1916
 
1923
1917
 
1924
1918
 
1925
- #### [ProductReturnConfigSerializer](#ProductReturnConfigSerializer)
1919
+ #### [GetCompanySerializer](#GetCompanySerializer)
1926
1920
 
1927
1921
  | Properties | Type | Nullable | Description |
1928
1922
  | ---------- | ---- | -------- | ----------- |
1929
- | on_same_store | boolean | no | |
1930
- | store_uid | number | no | |
1923
+ | verified_on | string | no | |
1924
+ | created_by | [UserSerializer](#UserSerializer) | no | |
1925
+ | created_on | string | no | |
1926
+ | reject_reason | string | no | |
1927
+ | uid | number | no | |
1928
+ | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1929
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1930
+ | name | string | no | |
1931
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1932
+ | company_type | string | no | |
1933
+ | modified_on | string | no | |
1934
+ | stage | string | no | |
1935
+ | business_type | string | no | |
1931
1936
 
1932
1937
  ---
1933
1938
 
@@ -1938,35 +1943,59 @@ Returns a success response
1938
1943
 
1939
1944
  | Properties | Type | Nullable | Description |
1940
1945
  | ---------- | ---- | -------- | ----------- |
1941
- | name | string | no | |
1942
1946
  | mobile_no | [SellerPhoneNumber](#SellerPhoneNumber) | yes | |
1943
1947
  | email | string | no | |
1948
+ | name | string | no | |
1944
1949
 
1945
1950
  ---
1946
1951
 
1947
1952
 
1948
1953
 
1949
1954
 
1950
- #### [LocationTimingSerializer](#LocationTimingSerializer)
1955
+ #### [InvoiceCredSerializer](#InvoiceCredSerializer)
1951
1956
 
1952
1957
  | Properties | Type | Nullable | Description |
1953
1958
  | ---------- | ---- | -------- | ----------- |
1954
- | minute | number | yes | |
1955
- | hour | number | yes | |
1959
+ | username | string | no | |
1960
+ | enabled | boolean | no | |
1961
+ | password | string | no | |
1956
1962
 
1957
1963
  ---
1958
1964
 
1959
1965
 
1960
1966
 
1961
1967
 
1962
- #### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
1968
+ #### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
1963
1969
 
1964
1970
  | Properties | Type | Nullable | Description |
1965
1971
  | ---------- | ---- | -------- | ----------- |
1966
- | closing | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1967
- | weekday | string | yes | |
1968
- | opening | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1969
- | open | boolean | yes | |
1972
+ | e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1973
+ | e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1974
+
1975
+ ---
1976
+
1977
+
1978
+
1979
+
1980
+ #### [HolidayDateSerializer](#HolidayDateSerializer)
1981
+
1982
+ | Properties | Type | Nullable | Description |
1983
+ | ---------- | ---- | -------- | ----------- |
1984
+ | start_date | string | yes | |
1985
+ | end_date | string | yes | |
1986
+
1987
+ ---
1988
+
1989
+
1990
+
1991
+
1992
+ #### [HolidaySchemaSerializer](#HolidaySchemaSerializer)
1993
+
1994
+ | Properties | Type | Nullable | Description |
1995
+ | ---------- | ---- | -------- | ----------- |
1996
+ | date | [HolidayDateSerializer](#HolidayDateSerializer) | yes | |
1997
+ | holiday_type | string | yes | |
1998
+ | title | string | yes | |
1970
1999
 
1971
2000
  ---
1972
2001
 
@@ -1977,30 +2006,31 @@ Returns a success response
1977
2006
 
1978
2007
  | Properties | Type | Nullable | Description |
1979
2008
  | ---------- | ---- | -------- | ----------- |
1980
- | uid | number | no | |
1981
- | address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
1982
- | warnings | string | no | |
1983
- | name | string | yes | |
1984
- | stage | string | no | |
1985
- | company | [GetCompanySerializer](#GetCompanySerializer) | no | |
1986
- | created_by | [UserSerializer](#UserSerializer) | no | |
1987
- | store_type | string | no | |
1988
- | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1989
- | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
1990
- | code | string | yes | |
2009
+ | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2010
+ | created_on | string | no | |
1991
2011
  | verified_by | [UserSerializer](#UserSerializer) | no | |
2012
+ | phone_number | string | yes | |
2013
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
2014
+ | _custom_json | string | no | |
2015
+ | store_type | string | no | |
2016
+ | notification_emails | [string] | no | |
1992
2017
  | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
2018
+ | code | string | yes | |
2019
+ | company | [GetCompanySerializer](#GetCompanySerializer) | no | |
2020
+ | warnings | string | no | |
1993
2021
  | modified_on | string | no | |
1994
2022
  | manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
2023
+ | stage | string | no | |
2024
+ | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
2025
+ | verified_on | string | no | |
2026
+ | created_by | [UserSerializer](#UserSerializer) | no | |
2027
+ | address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
2028
+ | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
2029
+ | holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
2030
+ | uid | number | no | |
2031
+ | name | string | yes | |
1995
2032
  | display_name | string | yes | |
1996
- | created_on | string | no | |
1997
2033
  | documents | [[Document](#Document)] | no | |
1998
- | notification_emails | [string] | no | |
1999
- | _custom_json | string | no | |
2000
- | modified_by | [UserSerializer](#UserSerializer) | no | |
2001
- | phone_number | string | yes | |
2002
- | verified_on | string | no | |
2003
- | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2004
2034
 
2005
2035
  ---
2006
2036
 
@@ -2023,23 +2053,24 @@ Returns a success response
2023
2053
 
2024
2054
  | Properties | Type | Nullable | Description |
2025
2055
  | ---------- | ---- | -------- | ----------- |
2026
- | uid | number | no | |
2027
- | name | string | yes | |
2028
- | company | number | yes | |
2029
- | stage | string | no | |
2030
- | documents | [[Document](#Document)] | no | |
2031
- | address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
2032
2056
  | notification_emails | [string] | no | |
2033
- | store_type | string | no | |
2034
- | _custom_json | string | no | |
2057
+ | address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
2058
+ | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2035
2059
  | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
2036
2060
  | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
2037
- | warnings | string | no | |
2061
+ | holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
2062
+ | uid | number | no | |
2038
2063
  | manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
2039
- | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2064
+ | code | string | yes | |
2065
+ | name | string | yes | |
2040
2066
  | display_name | string | yes | |
2067
+ | company | number | yes | |
2068
+ | _custom_json | string | no | |
2069
+ | warnings | string | no | |
2070
+ | store_type | string | no | |
2071
+ | documents | [[Document](#Document)] | no | |
2072
+ | stage | string | no | |
2041
2073
  | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
2042
- | code | string | yes | |
2043
2074
 
2044
2075
  ---
2045
2076
 
@@ -2074,8 +2105,8 @@ Returns a success response
2074
2105
 
2075
2106
  | Properties | Type | Nullable | Description |
2076
2107
  | ---------- | ---- | -------- | ----------- |
2077
- | level | string | no | |
2078
2108
  | strategy | string | no | |
2109
+ | level | string | no | |
2079
2110
 
2080
2111
  ---
2081
2112
 
@@ -2086,11 +2117,11 @@ Returns a success response
2086
2117
 
2087
2118
  | Properties | Type | Nullable | Description |
2088
2119
  | ---------- | ---- | -------- | ----------- |
2120
+ | group_id | string | no | |
2121
+ | meta | string | no | |
2089
2122
  | query | [_ArticleQuery](#_ArticleQuery) | no | |
2090
2123
  | article_assignment | [_ArticleAssignment](#_ArticleAssignment) | no | |
2091
2124
  | quantity | number | no | |
2092
- | meta | string | no | |
2093
- | group_id | string | no | |
2094
2125
 
2095
2126
  ---
2096
2127
 
@@ -2101,13 +2132,13 @@ Returns a success response
2101
2132
 
2102
2133
  | Properties | Type | Nullable | Description |
2103
2134
  | ---------- | ---- | -------- | ----------- |
2135
+ | channel_identifier | string | no | |
2136
+ | pincode | string | no | |
2137
+ | channel_type | string | no | |
2104
2138
  | store_ids | [number] | no | |
2105
2139
  | company_id | number | no | |
2106
- | channel_identifier | string | no | |
2107
- | app_id | string | no | |
2108
2140
  | articles | [[_AssignStoreArticle](#_AssignStoreArticle)] | no | |
2109
- | channel_type | string | no | |
2110
- | pincode | string | no | |
2141
+ | app_id | string | no | |
2111
2142
 
2112
2143
  ---
2113
2144
 
@@ -2118,21 +2149,21 @@ Returns a success response
2118
2149
 
2119
2150
  | Properties | Type | Nullable | Description |
2120
2151
  | ---------- | ---- | -------- | ----------- |
2121
- | price_marked | number | no | |
2122
- | uid | string | no | |
2123
- | article_assignment | [_ArticleAssignment](#_ArticleAssignment) | no | |
2124
- | size | string | no | |
2125
- | company_id | number | no | |
2126
- | _id | string | no | |
2127
- | store_pincode | string | no | |
2128
2152
  | preice_effective | number | no | |
2129
- | quantity | number | no | |
2153
+ | store_id | number | no | |
2154
+ | store_pincode | string | no | |
2155
+ | index | number | no | |
2130
2156
  | meta | string | no | |
2131
- | item_id | number | no | |
2157
+ | price_marked | number | no | |
2158
+ | uid | string | no | |
2132
2159
  | s_city | string | no | |
2133
- | store_id | number | no | |
2160
+ | item_id | number | no | |
2161
+ | company_id | number | no | |
2134
2162
  | status | boolean | no | |
2135
- | index | number | no | |
2163
+ | size | string | no | |
2164
+ | article_assignment | [_ArticleAssignment](#_ArticleAssignment) | no | |
2165
+ | quantity | number | no | |
2166
+ | _id | string | no | |
2136
2167
 
2137
2168
  ---
2138
2169