@gofynd/fdk-client-javascript 1.0.2 → 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 +557 -1279
- 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 +14453 -17192
- 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 +3438 -4172
- 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 +3400 -5361
- 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/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +567 -567
- 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 +1036 -1036
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +677 -1243
- 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 +38 -38
- 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 +26 -26
- 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 +330 -330
- 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 +191 -191
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
- package/sdk/application/Content/ContentApplicationModel.js +467 -884
- 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 +59 -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 +100 -100
- 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 +110 -43
- 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 +85 -85
- package/sdk/application/Order/OrderApplicationClient.js +232 -232
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +352 -656
- 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 +739 -739
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
- package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
- 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 +617 -617
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
- package/sdk/application/PosCart/PosCartApplicationModel.js +475 -871
- 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 +112 -112
- 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 +84 -84
- 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 +31 -31
- 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 +581 -581
- 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 +51 -51
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +179 -179
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +41 -41
- 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 +60 -60
- package/sdk/platform/Billing/BillingPlatformClient.js +181 -181
- 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 +168 -168
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +553 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
- package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
- package/sdk/platform/Cart/CartPlatformModel.js +671 -1205
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1525 -1525
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +174 -174
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +682 -682
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1557 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2127 -3904
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -229
- package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformClient.js +41 -41
- 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 +326 -326
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +943 -943
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +212 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +615 -552
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +342 -342
- 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 +534 -534
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1324 -1324
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -50
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +156 -156
- package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
- package/sdk/platform/Content/ContentPlatformModel.js +484 -907
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
- package/sdk/platform/Discount/DiscountPlatformClient.js +216 -216
- 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 +24 -24
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +58 -58
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +52 -52
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +123 -123
- 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 +63 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +228 -228
- 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 +73 -73
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +200 -200
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
- package/sdk/platform/Lead/LeadPlatformClient.js +212 -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/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +65 -65
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
- package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
- package/sdk/platform/Order/OrderPlatformClient.js +1035 -1035
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
- package/sdk/platform/Order/OrderPlatformModel.js +1574 -2861
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +160 -160
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
- package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +167 -167
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
- package/sdk/platform/Payment/PaymentPlatformClient.js +153 -153
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
- package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
- package/sdk/platform/PlatformApplicationClient.js +1584 -13899
- package/sdk/platform/PlatformClient.d.ts +7965 -7885
- package/sdk/platform/PlatformClient.js +8672 -10105
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +83 -83
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +275 -275
- 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 +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +59 -59
- 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 +132 -132
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +310 -310
- 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 +136 -69
- package/sdk/platform/User/UserPlatformApplicationClient.js +505 -166
- 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 +31 -31
- package/sdk/platform/Webhook/WebhookPlatformClient.js +88 -88
- 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 +38 -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 +113 -113
- 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/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/tests/application/catalog.spec.js +7 -0
|
@@ -4,114 +4,110 @@ declare class Catalog {
|
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
6
|
* @param {Object} arg - Arg object.
|
|
7
|
-
* @param {
|
|
8
|
-
* @
|
|
9
|
-
* @
|
|
10
|
-
* @
|
|
7
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
8
|
+
* @param {string} arg.size - Size in which inventory is to be added.
|
|
9
|
+
* @param {InventoryRequest} arg.body
|
|
10
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
11
|
+
* @summary: Add Inventory for particular size and store.
|
|
12
|
+
* @description: This API allows add Inventory for particular size and store.
|
|
11
13
|
*/
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
14
|
+
addInventory({ itemId, size, body }?: {
|
|
15
|
+
itemId: number;
|
|
16
|
+
size: string;
|
|
17
|
+
body: InventoryRequest;
|
|
18
|
+
}): Promise<SuccessResponse>;
|
|
15
19
|
/**
|
|
16
20
|
* @param {Object} arg - Arg object.
|
|
17
|
-
* @param {
|
|
18
|
-
*
|
|
19
|
-
* @
|
|
20
|
-
* @
|
|
21
|
-
* @summary: List all Product Bundles
|
|
22
|
-
* @description: Get all product bundles for a particular company
|
|
21
|
+
* @param {number} arg.itemId - Id of the product to be updated.
|
|
22
|
+
* @returns {Promise<GetAllSizes>} - Success response
|
|
23
|
+
* @summary: All Sizes for a given Product
|
|
24
|
+
* @description: This API allows to get All Sizes for a given Product.
|
|
23
25
|
*/
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
}): Promise<GetProductBundleListingResponse>;
|
|
26
|
+
allSizes({ itemId }?: {
|
|
27
|
+
itemId: number;
|
|
28
|
+
}): Promise<GetAllSizes>;
|
|
28
29
|
/**
|
|
29
30
|
* @param {Object} arg - Arg object.
|
|
30
|
-
* @param {
|
|
31
|
-
*
|
|
32
|
-
* @
|
|
33
|
-
* @
|
|
34
|
-
* @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
|
|
31
|
+
* @param {BulkHsnUpsert} arg.body
|
|
32
|
+
* @returns {Promise<BulkHsnResponse>} - Success response
|
|
33
|
+
* @summary: Bulk Create or Update Hsn Code.
|
|
34
|
+
* @description: Bulk Create or Update Hsn Code.
|
|
35
35
|
*/
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
}): Promise<
|
|
36
|
+
bulkHsnCode({ body }?: {
|
|
37
|
+
body: BulkHsnUpsert;
|
|
38
|
+
}): Promise<BulkHsnResponse>;
|
|
39
39
|
/**
|
|
40
40
|
* @param {Object} arg - Arg object.
|
|
41
|
-
* @param {string} arg.
|
|
42
|
-
*
|
|
43
|
-
* @
|
|
44
|
-
* @
|
|
45
|
-
* @
|
|
46
|
-
* @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
|
|
41
|
+
* @param {string} arg.batchId - Batch Id of the bulk create job.
|
|
42
|
+
* @param {InventoryBulkRequest} arg.body
|
|
43
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
44
|
+
* @summary: Create products in bulk associated with given batch Id.
|
|
45
|
+
* @description: This API helps to create products in bulk push to kafka for approval/creation.
|
|
47
46
|
*/
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
body:
|
|
51
|
-
}): Promise<
|
|
47
|
+
createBulkInventory({ batchId, body }?: {
|
|
48
|
+
batchId: string;
|
|
49
|
+
body: InventoryBulkRequest;
|
|
50
|
+
}): Promise<SuccessResponse>;
|
|
52
51
|
/**
|
|
53
52
|
* @param {Object} arg - Arg object.
|
|
54
|
-
* @param {
|
|
55
|
-
* @returns {Promise<
|
|
56
|
-
* @summary: Create a
|
|
57
|
-
* @description: This API
|
|
53
|
+
* @param {BulkJob} arg.body
|
|
54
|
+
* @returns {Promise<BulkResponse>} - Success response
|
|
55
|
+
* @summary: Create a Bulk Inventory upload Job.
|
|
56
|
+
* @description: This API helps to create a bulk Inventory upload job.
|
|
58
57
|
*/
|
|
59
|
-
|
|
60
|
-
body:
|
|
61
|
-
}): Promise<
|
|
58
|
+
createBulkInventoryJob({ body }?: {
|
|
59
|
+
body: BulkJob;
|
|
60
|
+
}): Promise<BulkResponse>;
|
|
62
61
|
/**
|
|
63
62
|
* @param {Object} arg - Arg object.
|
|
64
|
-
* @param {
|
|
65
|
-
* @
|
|
66
|
-
* @
|
|
67
|
-
* @
|
|
68
|
-
* given set of results
|
|
69
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
70
|
-
* page. Default is 10.
|
|
71
|
-
* @returns {Promise<ListSizeGuide>} - Success response
|
|
72
|
-
* @summary: Get list of size guides
|
|
73
|
-
* @description: This API allows to view all the size guides associated to the seller.
|
|
63
|
+
* @param {BulkJob} arg.body
|
|
64
|
+
* @returns {Promise<BulkResponse>} - Success response
|
|
65
|
+
* @summary: Create a Bulk product to upload job.
|
|
66
|
+
* @description: This API helps to create a bulk products upload job.
|
|
74
67
|
*/
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
tag?: string;
|
|
79
|
-
pageNo?: number;
|
|
80
|
-
pageSize?: number;
|
|
81
|
-
}): Promise<ListSizeGuide>;
|
|
68
|
+
createBulkProductUploadJob({ body }?: {
|
|
69
|
+
body: BulkJob;
|
|
70
|
+
}): Promise<BulkResponse>;
|
|
82
71
|
/**
|
|
83
72
|
* @param {Object} arg - Arg object.
|
|
84
|
-
* @param {
|
|
85
|
-
* @returns {Promise<
|
|
86
|
-
* @summary:
|
|
87
|
-
* @description: This API
|
|
73
|
+
* @param {CategoryRequestBody} arg.body
|
|
74
|
+
* @returns {Promise<CategoryCreateResponse>} - Success response
|
|
75
|
+
* @summary: Create product categories
|
|
76
|
+
* @description: This API lets user create product categories
|
|
88
77
|
*/
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
}): Promise<
|
|
78
|
+
createCategories({ body }?: {
|
|
79
|
+
body: CategoryRequestBody;
|
|
80
|
+
}): Promise<CategoryCreateResponse>;
|
|
92
81
|
/**
|
|
93
82
|
* @param {Object} arg - Arg object.
|
|
94
|
-
* @param {
|
|
95
|
-
* @
|
|
96
|
-
* @
|
|
97
|
-
* @
|
|
98
|
-
* @description: This API allows to edit a size guide.
|
|
83
|
+
* @param {DepartmentCreateUpdate} arg.body
|
|
84
|
+
* @returns {Promise<DepartmentCreateResponse>} - Success response
|
|
85
|
+
* @summary: Create the department.
|
|
86
|
+
* @description: Create departments using the API.
|
|
99
87
|
*/
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
}): Promise<SuccessResponse>;
|
|
88
|
+
createDepartments({ body }?: {
|
|
89
|
+
body: DepartmentCreateUpdate;
|
|
90
|
+
}): Promise<DepartmentCreateResponse>;
|
|
104
91
|
/**
|
|
105
92
|
* @param {Object} arg - Arg object.
|
|
106
|
-
* @param {
|
|
107
|
-
*
|
|
108
|
-
* @
|
|
109
|
-
* @
|
|
110
|
-
* @description: Analytics data of catalog and inventory that are being cross-selled.
|
|
93
|
+
* @param {InventoryCreateRequest} arg.body
|
|
94
|
+
* @returns {Promise<InventoryExportResponse>} - Success response
|
|
95
|
+
* @summary: Create an inventory export job.
|
|
96
|
+
* @description: This API helps to create a Inventory export job.
|
|
111
97
|
*/
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
}): Promise<
|
|
98
|
+
createInventoryExport({ body }?: {
|
|
99
|
+
body: InventoryCreateRequest;
|
|
100
|
+
}): Promise<InventoryExportResponse>;
|
|
101
|
+
/**
|
|
102
|
+
* @param {Object} arg - Arg object.
|
|
103
|
+
* @param {InventoryExportRequest} arg.body
|
|
104
|
+
* @returns {Promise<InventoryExportResponse>} - Success response
|
|
105
|
+
* @summary: Create a Inventory export Job.
|
|
106
|
+
* @description: This API helps to create a Inventory export job.
|
|
107
|
+
*/
|
|
108
|
+
createInventoryExportJob({ body }?: {
|
|
109
|
+
body: InventoryExportRequest;
|
|
110
|
+
}): Promise<InventoryExportResponse>;
|
|
115
111
|
/**
|
|
116
112
|
* @param {Object} arg - Arg object.
|
|
117
113
|
* @param {string} arg.marketplace - The marketplace for which the detail
|
|
@@ -127,164 +123,150 @@ declare class Catalog {
|
|
|
127
123
|
}): Promise<UpdatedResponse>;
|
|
128
124
|
/**
|
|
129
125
|
* @param {Object} arg - Arg object.
|
|
130
|
-
* @
|
|
131
|
-
* @
|
|
132
|
-
* @
|
|
126
|
+
* @param {ProductCreateUpdateSchemaV2} arg.body
|
|
127
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
128
|
+
* @summary: Create a product.
|
|
129
|
+
* @description: This API allows to create product.
|
|
133
130
|
*/
|
|
134
|
-
|
|
131
|
+
createProduct({ body }?: {
|
|
132
|
+
body: ProductCreateUpdateSchemaV2;
|
|
133
|
+
}): Promise<SuccessResponse>;
|
|
135
134
|
/**
|
|
136
135
|
* @param {Object} arg - Arg object.
|
|
137
|
-
* @
|
|
138
|
-
* @
|
|
139
|
-
* @
|
|
136
|
+
* @param {ProductBulkAssets} arg.body
|
|
137
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
138
|
+
* @summary: Create a Bulk asset upload Job.
|
|
139
|
+
* @description: This API helps to create a bulk asset upload job.
|
|
140
140
|
*/
|
|
141
|
-
|
|
141
|
+
createProductAssetsInBulk({ body }?: {
|
|
142
|
+
body: ProductBulkAssets;
|
|
143
|
+
}): Promise<SuccessResponse>;
|
|
142
144
|
/**
|
|
143
145
|
* @param {Object} arg - Arg object.
|
|
144
|
-
* @param {
|
|
145
|
-
* @
|
|
146
|
-
* @
|
|
147
|
-
* @
|
|
148
|
-
* the page for the company id.
|
|
149
|
-
* @param {string} [arg.marketplace] - The marketplace platform associated
|
|
150
|
-
* with the company id.
|
|
151
|
-
* @returns {Promise<OptinCompanyBrandDetailsView>} - Success response
|
|
152
|
-
* @summary: Get the Company Brand details of Optin.
|
|
153
|
-
* @description: Get the details of the Brands associated with the given company_id passed.
|
|
146
|
+
* @param {ProductBundleRequest} arg.body
|
|
147
|
+
* @returns {Promise<GetProductBundleCreateResponse>} - Success response
|
|
148
|
+
* @summary: Create Product Bundle
|
|
149
|
+
* @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id
|
|
154
150
|
*/
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
pageNo?: number;
|
|
159
|
-
pageSize?: number;
|
|
160
|
-
marketplace?: string;
|
|
161
|
-
}): Promise<OptinCompanyBrandDetailsView>;
|
|
151
|
+
createProductBundle({ body }?: {
|
|
152
|
+
body: ProductBundleRequest;
|
|
153
|
+
}): Promise<GetProductBundleCreateResponse>;
|
|
162
154
|
/**
|
|
163
155
|
* @param {Object} arg - Arg object.
|
|
164
|
-
* @
|
|
165
|
-
* @
|
|
166
|
-
* @
|
|
156
|
+
* @param {ProductTemplateDownloadsExport} arg.body
|
|
157
|
+
* @returns {Promise<ProductDownloadsResponse>} - Success response
|
|
158
|
+
* @summary: Create a product export job.
|
|
159
|
+
* @description: This API helps to create a Inventory export job.
|
|
167
160
|
*/
|
|
168
|
-
|
|
161
|
+
createProductExportJob({ body }?: {
|
|
162
|
+
body: ProductTemplateDownloadsExport;
|
|
163
|
+
}): Promise<ProductDownloadsResponse>;
|
|
169
164
|
/**
|
|
170
165
|
* @param {Object} arg - Arg object.
|
|
171
|
-
* @param {string}
|
|
172
|
-
* @param {
|
|
173
|
-
* @
|
|
174
|
-
*
|
|
175
|
-
* @
|
|
176
|
-
* @summary: Get the Store details.
|
|
177
|
-
* @description: Get the details of the store associated with the company ID passed.
|
|
166
|
+
* @param {string} arg.batchId - Batch Id in which assets to be uploaded.
|
|
167
|
+
* @param {BulkProductRequest} arg.body
|
|
168
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
169
|
+
* @summary: Create products in bulk associated with given batch Id.
|
|
170
|
+
* @description: This API helps to create products in bulk push to kafka for approval/creation.
|
|
178
171
|
*/
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
}): Promise<OptinStoreDetails>;
|
|
172
|
+
createProductsInBulk({ batchId, body }?: {
|
|
173
|
+
batchId: string;
|
|
174
|
+
body: BulkProductRequest;
|
|
175
|
+
}): Promise<SuccessResponse>;
|
|
184
176
|
/**
|
|
185
177
|
* @param {Object} arg - Arg object.
|
|
186
|
-
* @param {
|
|
187
|
-
*
|
|
188
|
-
* @
|
|
189
|
-
* @
|
|
190
|
-
* @description: This API allows to view the gender attribute details.
|
|
178
|
+
* @param {ValidateSizeGuide} arg.body
|
|
179
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
180
|
+
* @summary: Create a size guide.
|
|
181
|
+
* @description: This API allows to create a size guide associated to a brand.
|
|
191
182
|
*/
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
}): Promise<
|
|
183
|
+
createSizeGuide({ body }?: {
|
|
184
|
+
body: ValidateSizeGuide;
|
|
185
|
+
}): Promise<SuccessResponse>;
|
|
195
186
|
/**
|
|
196
187
|
* @param {Object} arg - Arg object.
|
|
197
|
-
* @param {string} arg.
|
|
198
|
-
*
|
|
199
|
-
* @
|
|
200
|
-
*
|
|
201
|
-
* @returns {Promise<ProdcutTemplateCategoriesResponse>} - Success response
|
|
202
|
-
* @summary: List Department specifiec product categories
|
|
203
|
-
* @description: Allows you to list all product categories values for the departments specified
|
|
188
|
+
* @param {string} arg.batchId - Batch Id of the bulk delete job.
|
|
189
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
190
|
+
* @summary: Delete Bulk Inventory job.
|
|
191
|
+
* @description: This API allows to delete bulk Inventory job associated with company.
|
|
204
192
|
*/
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
}): Promise<ProdcutTemplateCategoriesResponse>;
|
|
193
|
+
deleteBulkInventoryJob({ batchId }?: {
|
|
194
|
+
batchId: string;
|
|
195
|
+
}): Promise<SuccessResponse>;
|
|
209
196
|
/**
|
|
210
197
|
* @param {Object} arg - Arg object.
|
|
211
|
-
* @param {
|
|
212
|
-
* @
|
|
213
|
-
*
|
|
214
|
-
* @
|
|
198
|
+
* @param {string} arg.size - Size that is to be deleted.
|
|
199
|
+
* @param {number} arg.itemId - Id of the product associated with Inventory
|
|
200
|
+
* to be deleted.
|
|
201
|
+
* @param {number} arg.locationId - Location ID of store of which inventory
|
|
202
|
+
* is to be deleted.
|
|
203
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
204
|
+
* @summary: Delete a Inventory.
|
|
205
|
+
* @description: This API allows to delete inventory of a particular product for particular company.
|
|
215
206
|
*/
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
207
|
+
deleteInventory({ size, itemId, locationId }?: {
|
|
208
|
+
size: string;
|
|
209
|
+
itemId: number;
|
|
210
|
+
locationId: number;
|
|
211
|
+
}): Promise<SuccessResponse>;
|
|
219
212
|
/**
|
|
220
213
|
* @param {Object} arg - Arg object.
|
|
221
|
-
* @param {number}
|
|
222
|
-
*
|
|
223
|
-
* @
|
|
224
|
-
*
|
|
225
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
226
|
-
* page. Default is 10.
|
|
227
|
-
* @param {string} [arg.name] - Can search departments by passing name.
|
|
228
|
-
* @param {string} [arg.search] - Can search departments by passing name of
|
|
229
|
-
* the department in search parameter.
|
|
230
|
-
* @param {boolean} [arg.isActive] - Can query for departments based on
|
|
231
|
-
* whether they are active or inactive.
|
|
232
|
-
* @returns {Promise<DepartmentsResponse>} - Success response
|
|
233
|
-
* @summary: List all Departments.
|
|
234
|
-
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
|
|
214
|
+
* @param {number} arg.itemId - Id of the product to be updated.
|
|
215
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
216
|
+
* @summary: Delete a product.
|
|
217
|
+
* @description: This API allows to delete product.
|
|
235
218
|
*/
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
pageSize?: number;
|
|
240
|
-
name?: string;
|
|
241
|
-
search?: string;
|
|
242
|
-
isActive?: boolean;
|
|
243
|
-
}): Promise<DepartmentsResponse>;
|
|
219
|
+
deleteProduct({ itemId }?: {
|
|
220
|
+
itemId: number;
|
|
221
|
+
}): Promise<SuccessResponse>;
|
|
244
222
|
/**
|
|
245
223
|
* @param {Object} arg - Arg object.
|
|
246
|
-
* @param {
|
|
247
|
-
* @returns {Promise<
|
|
248
|
-
* @summary:
|
|
249
|
-
* @description:
|
|
224
|
+
* @param {number} arg.batchId - Batch Id of the bulk product job to be deleted.
|
|
225
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
226
|
+
* @summary: Delete Bulk product job.
|
|
227
|
+
* @description: This API allows to delete bulk product job associated with company.
|
|
250
228
|
*/
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
}): Promise<
|
|
229
|
+
deleteProductBulkJob({ batchId }?: {
|
|
230
|
+
batchId: number;
|
|
231
|
+
}): Promise<SuccessResponse>;
|
|
254
232
|
/**
|
|
255
233
|
* @param {Object} arg - Arg object.
|
|
256
|
-
* @param {
|
|
257
|
-
* @param {
|
|
258
|
-
*
|
|
259
|
-
* @
|
|
260
|
-
* @
|
|
234
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
235
|
+
* @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
|
|
236
|
+
* or Primary Identifier) of which inventory is to get.
|
|
237
|
+
* @param {InventoryRequestSchemaV2} arg.body
|
|
238
|
+
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
239
|
+
* @summary: Add Inventory for particular size and store.
|
|
240
|
+
* @description: This API allows add Inventory for particular size and store.
|
|
261
241
|
*/
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
242
|
+
deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: {
|
|
243
|
+
itemId: number;
|
|
244
|
+
sellerIdentifier: string;
|
|
245
|
+
body: InventoryRequestSchemaV2;
|
|
246
|
+
}): Promise<InventoryUpdateResponse>;
|
|
266
247
|
/**
|
|
267
248
|
* @param {Object} arg - Arg object.
|
|
268
|
-
* @param {
|
|
269
|
-
*
|
|
270
|
-
* @
|
|
271
|
-
* @
|
|
272
|
-
* @
|
|
249
|
+
* @param {number} arg.itemId - Item Id of the product associated with size
|
|
250
|
+
* to be deleted.
|
|
251
|
+
* @param {string} arg.size - Size to be deleted.
|
|
252
|
+
* @returns {Promise<ProductSizeDeleteResponse>} - Success response
|
|
253
|
+
* @summary: Delete a Size associated with product.
|
|
254
|
+
* @description: This API allows to delete size associated with product.
|
|
273
255
|
*/
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
256
|
+
deleteSize({ itemId, size }?: {
|
|
257
|
+
itemId: number;
|
|
258
|
+
size: string;
|
|
259
|
+
}): Promise<ProductSizeDeleteResponse>;
|
|
277
260
|
/**
|
|
278
261
|
* @param {Object} arg - Arg object.
|
|
279
|
-
* @param {string} arg.
|
|
280
|
-
*
|
|
281
|
-
* @
|
|
282
|
-
* @
|
|
283
|
-
* @description: Allows you to list all product templates validation values for all the fields present in the database
|
|
262
|
+
* @param {string} arg.itemType - An `item_type` defines the type of item.
|
|
263
|
+
* @returns {Promise<string>} - Success response
|
|
264
|
+
* @summary: Download Product Template View
|
|
265
|
+
* @description: Allows you to download product template data
|
|
284
266
|
*/
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
}): Promise<
|
|
267
|
+
downloadInventoryTemplateView({ itemType }?: {
|
|
268
|
+
itemType: string;
|
|
269
|
+
}): Promise<string>;
|
|
288
270
|
/**
|
|
289
271
|
* @param {Object} arg - Arg object.
|
|
290
272
|
* @param {string} arg.slug - A `slug` is a unique identifier for a
|
|
@@ -298,209 +280,228 @@ declare class Catalog {
|
|
|
298
280
|
}): Promise<string>;
|
|
299
281
|
/**
|
|
300
282
|
* @param {Object} arg - Arg object.
|
|
301
|
-
* @param {
|
|
302
|
-
* @
|
|
303
|
-
* @
|
|
304
|
-
* @
|
|
283
|
+
* @param {number} arg.itemId - Id of the product to be updated.
|
|
284
|
+
* @param {ProductCreateUpdateSchemaV2} arg.body
|
|
285
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
286
|
+
* @summary: Edit a product.
|
|
287
|
+
* @description: This API allows to edit product.
|
|
305
288
|
*/
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
289
|
+
editProduct({ itemId, body }?: {
|
|
290
|
+
itemId: number;
|
|
291
|
+
body: ProductCreateUpdateSchemaV2;
|
|
292
|
+
}): Promise<SuccessResponse>;
|
|
309
293
|
/**
|
|
310
294
|
* @param {Object} arg - Arg object.
|
|
311
|
-
* @param {string} arg.
|
|
312
|
-
*
|
|
313
|
-
* @returns {Promise<
|
|
314
|
-
* @summary:
|
|
315
|
-
* @description:
|
|
295
|
+
* @param {string} [arg.filterType] - Filter type from any one of ['brand',
|
|
296
|
+
* 'store', 'type']
|
|
297
|
+
* @returns {Promise<InventoryConfig>} - Success response
|
|
298
|
+
* @summary: Get List of different filters for inventory export
|
|
299
|
+
* @description: This API allows get List of different filters like brand, store, and type for inventory export.
|
|
316
300
|
*/
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
}): Promise<
|
|
301
|
+
exportInventoryConfig({ filterType }?: {
|
|
302
|
+
filterType?: string;
|
|
303
|
+
}): Promise<InventoryConfig>;
|
|
320
304
|
/**
|
|
321
305
|
* @param {Object} arg - Arg object.
|
|
322
|
-
* @
|
|
323
|
-
* @
|
|
324
|
-
* @
|
|
306
|
+
* @param {number} [arg.pageNo] - Page no
|
|
307
|
+
* @param {number} [arg.pageSize] - Page size
|
|
308
|
+
* @param {string} [arg.q] - Search using hsn code, description, reporting_hsn
|
|
309
|
+
* @param {string} [arg.type] - Search using type
|
|
310
|
+
* @returns {Promise<HsnCodesListingResponseSchemaV2>} - Success response
|
|
311
|
+
* @summary: Hsn Code List.
|
|
312
|
+
* @description: Hsn Code List.
|
|
325
313
|
*/
|
|
326
|
-
|
|
314
|
+
getAllProductHsnCodes({ pageNo, pageSize, q, type }?: {
|
|
315
|
+
pageNo?: number;
|
|
316
|
+
pageSize?: number;
|
|
317
|
+
q?: string;
|
|
318
|
+
type?: string;
|
|
319
|
+
}): Promise<HsnCodesListingResponseSchemaV2>;
|
|
327
320
|
/**
|
|
328
321
|
* @param {Object} arg - Arg object.
|
|
329
|
-
* @
|
|
330
|
-
* @
|
|
331
|
-
* @
|
|
322
|
+
* @param {string} arg.uid - Category unique id
|
|
323
|
+
* @returns {Promise<SingleCategoryResponse>} - Success response
|
|
324
|
+
* @summary: Get product category by uid
|
|
325
|
+
* @description: This API gets meta associated to product categories.
|
|
332
326
|
*/
|
|
333
|
-
|
|
327
|
+
getCategoryData({ uid }?: {
|
|
328
|
+
uid: string;
|
|
329
|
+
}): Promise<SingleCategoryResponse>;
|
|
334
330
|
/**
|
|
335
331
|
* @param {Object} arg - Arg object.
|
|
336
|
-
* @param {
|
|
337
|
-
* @
|
|
338
|
-
* @
|
|
339
|
-
* @
|
|
332
|
+
* @param {boolean} [arg.isActive] - The is_active status for the optin id.
|
|
333
|
+
* @param {boolean} [arg.q] - The search value to filter the list.
|
|
334
|
+
* @param {number} [arg.pageNo] - The number of page for the company id.
|
|
335
|
+
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
336
|
+
* the page for the company id.
|
|
337
|
+
* @param {string} [arg.marketplace] - The marketplace platform associated
|
|
338
|
+
* with the company id.
|
|
339
|
+
* @returns {Promise<OptinCompanyBrandDetailsView>} - Success response
|
|
340
|
+
* @summary: Get the Company Brand details of Optin.
|
|
341
|
+
* @description: Get the details of the Brands associated with the given company_id passed.
|
|
340
342
|
*/
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
343
|
+
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, }?: {
|
|
344
|
+
isActive?: boolean;
|
|
345
|
+
q?: boolean;
|
|
346
|
+
pageNo?: number;
|
|
347
|
+
pageSize?: number;
|
|
348
|
+
marketplace?: string;
|
|
349
|
+
}): Promise<OptinCompanyBrandDetailsView>;
|
|
344
350
|
/**
|
|
345
351
|
* @param {Object} arg - Arg object.
|
|
346
|
-
* @
|
|
347
|
-
*
|
|
348
|
-
* @
|
|
349
|
-
* from the date specified to the current date.
|
|
350
|
-
* @param {string} [arg.toDate] - This is a parameter used to find the job
|
|
351
|
-
* from the from_date specified to the to_date.
|
|
352
|
-
* @param {string} [arg.q] - It is a query parameter to search the export
|
|
353
|
-
* job with the task ID.
|
|
354
|
-
* @returns {Promise<ProductDownloadsResponse>} - Success response
|
|
355
|
-
* @summary: Allows you to list all product templates export list details
|
|
356
|
-
* @description: Can view details including trigger data, task id , etc.
|
|
352
|
+
* @returns {Promise<OptinCompanyDetail>} - Success response
|
|
353
|
+
* @summary: Get the Company details.
|
|
354
|
+
* @description: Get the details of the company associated with the given company_id passed.
|
|
357
355
|
*/
|
|
358
|
-
|
|
359
|
-
status?: string;
|
|
360
|
-
fromDate?: string;
|
|
361
|
-
toDate?: string;
|
|
362
|
-
q?: string;
|
|
363
|
-
}): Promise<ProductDownloadsResponse>;
|
|
356
|
+
getCompanyDetail({}?: any): Promise<OptinCompanyDetail>;
|
|
364
357
|
/**
|
|
365
358
|
* @param {Object} arg - Arg object.
|
|
366
|
-
* @
|
|
367
|
-
*
|
|
368
|
-
* @
|
|
369
|
-
* the type of template required.
|
|
370
|
-
* @param {string} [arg.itemType] - A `item_type` is the identifier of the
|
|
371
|
-
* type of template required.
|
|
372
|
-
* @returns {Promise<ProductConfigurationDownloads>} - Success response
|
|
373
|
-
* @summary: Allows you to list all values for Templates, Brands or Type
|
|
374
|
-
* @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same
|
|
359
|
+
* @returns {Promise<OptinCompanyMetrics>} - Success response
|
|
360
|
+
* @summary: Get the Company metrics
|
|
361
|
+
* @description: Get the Company metrics associated with the company ID passed.
|
|
375
362
|
*/
|
|
376
|
-
|
|
377
|
-
filter: string;
|
|
378
|
-
templateTag?: string;
|
|
379
|
-
itemType?: string;
|
|
380
|
-
}): Promise<ProductConfigurationDownloads>;
|
|
363
|
+
getCompanyMetrics({}?: any): Promise<OptinCompanyMetrics>;
|
|
381
364
|
/**
|
|
382
365
|
* @param {Object} arg - Arg object.
|
|
383
|
-
* @param {
|
|
384
|
-
* @returns {Promise<
|
|
385
|
-
* @summary:
|
|
386
|
-
* @description:
|
|
366
|
+
* @param {string} arg.uid - A `uid` is a unique identifier of a department.
|
|
367
|
+
* @returns {Promise<DepartmentsResponse>} - Success response
|
|
368
|
+
* @summary: Get specific departments details by passing in unique id of the department.
|
|
369
|
+
* @description: Allows you to get department data, by uid.
|
|
387
370
|
*/
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
}): Promise<
|
|
371
|
+
getDepartmentData({ uid }?: {
|
|
372
|
+
uid: string;
|
|
373
|
+
}): Promise<DepartmentsResponse>;
|
|
391
374
|
/**
|
|
392
375
|
* @param {Object} arg - Arg object.
|
|
393
|
-
* @param {string}
|
|
394
|
-
*
|
|
395
|
-
* @
|
|
396
|
-
* @
|
|
397
|
-
*
|
|
398
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
399
|
-
* page. Default is 10.
|
|
400
|
-
* @returns {Promise<CategoryResponse>} - Success response
|
|
401
|
-
* @summary: Get product categories list
|
|
402
|
-
* @description: This API gets meta associated to product categories.
|
|
376
|
+
* @param {string} arg.attributeSlug - Slug of the attribute for which you
|
|
377
|
+
* want to view the genders
|
|
378
|
+
* @returns {Promise<GenderDetail>} - Success response
|
|
379
|
+
* @summary: Get gender attribute details
|
|
380
|
+
* @description: This API allows to view the gender attribute details.
|
|
403
381
|
*/
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
q?: string;
|
|
408
|
-
pageNo?: number;
|
|
409
|
-
pageSize?: number;
|
|
410
|
-
}): Promise<CategoryResponse>;
|
|
382
|
+
getGenderAttribute({ attributeSlug }?: {
|
|
383
|
+
attributeSlug: string;
|
|
384
|
+
}): Promise<GenderDetail>;
|
|
411
385
|
/**
|
|
412
386
|
* @param {Object} arg - Arg object.
|
|
413
|
-
* @param {string} arg.
|
|
414
|
-
* @returns {Promise<
|
|
415
|
-
* @summary:
|
|
416
|
-
* @description:
|
|
387
|
+
* @param {string} arg.id - Unique id
|
|
388
|
+
* @returns {Promise<HsnCode>} - Success response
|
|
389
|
+
* @summary: Fetch Hsn Code.
|
|
390
|
+
* @description: Fetch Hsn Code.
|
|
417
391
|
*/
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
}): Promise<
|
|
392
|
+
getHsnCode({ id }?: {
|
|
393
|
+
id: string;
|
|
394
|
+
}): Promise<HsnCode>;
|
|
421
395
|
/**
|
|
422
396
|
* @param {Object} arg - Arg object.
|
|
423
|
-
* @param {string} arg.
|
|
424
|
-
* @param {
|
|
425
|
-
* @
|
|
426
|
-
*
|
|
427
|
-
* @
|
|
397
|
+
* @param {string} [arg.itemId] - Item code of the product of which size is to be get.
|
|
398
|
+
* @param {string} [arg.size] - Size of which inventory is to get.
|
|
399
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
400
|
+
* given set of results
|
|
401
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
402
|
+
* page. Default is 12.
|
|
403
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
404
|
+
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
405
|
+
* @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
|
|
406
|
+
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
407
|
+
* or Primary Identifier) of which inventory is to get.
|
|
408
|
+
* @returns {Promise<GetInventoriesResponse>} - Success response
|
|
409
|
+
* @summary: Get Inventory for company
|
|
410
|
+
* @description: This API allows get Inventories data for particular company.
|
|
428
411
|
*/
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
412
|
+
getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, }?: {
|
|
413
|
+
itemId?: string;
|
|
414
|
+
size?: string;
|
|
415
|
+
pageNo?: number;
|
|
416
|
+
pageSize?: number;
|
|
417
|
+
q?: string;
|
|
418
|
+
sellable?: boolean;
|
|
419
|
+
storeIds?: number[];
|
|
420
|
+
sizeIdentifier?: string;
|
|
421
|
+
}): Promise<GetInventoriesResponse>;
|
|
433
422
|
/**
|
|
434
423
|
* @param {Object} arg - Arg object.
|
|
435
|
-
* @param {
|
|
436
|
-
*
|
|
437
|
-
* @
|
|
438
|
-
*
|
|
424
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
425
|
+
* given set of results
|
|
426
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
427
|
+
* page. Default is 12.
|
|
428
|
+
* @returns {Promise<BulkInventoryGet>} - Success response
|
|
429
|
+
* @summary: Get a list of all bulk Inventory upload jobs.
|
|
430
|
+
* @description: This API helps to get bulk Inventory upload jobs data.
|
|
439
431
|
*/
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
432
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize }?: {
|
|
433
|
+
pageNo?: number;
|
|
434
|
+
pageSize?: number;
|
|
435
|
+
}): Promise<BulkInventoryGet>;
|
|
443
436
|
/**
|
|
444
437
|
* @param {Object} arg - Arg object.
|
|
445
|
-
* @param {number
|
|
446
|
-
* @param {
|
|
447
|
-
* Category Ids
|
|
448
|
-
* @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
|
|
449
|
-
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
450
|
-
* Department Ids
|
|
451
|
-
* @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
|
|
452
|
-
* @param {string} [arg.q] - Get multiple products filtered by q string
|
|
453
|
-
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
438
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
439
|
+
* @param {string} arg.size - Size of which inventory is to get.
|
|
454
440
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
455
441
|
* given set of results
|
|
456
442
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
457
|
-
* page. Default is
|
|
458
|
-
* @
|
|
459
|
-
* @
|
|
460
|
-
* @
|
|
443
|
+
* page. Default is 12.
|
|
444
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
445
|
+
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
446
|
+
* @returns {Promise<InventoryResponsePaginated>} - Success response
|
|
447
|
+
* @summary: Get Inventory for company
|
|
448
|
+
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
461
449
|
*/
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
itemIds?: number[];
|
|
466
|
-
departmentIds?: number[];
|
|
467
|
-
itemCode?: string[];
|
|
468
|
-
q?: string;
|
|
469
|
-
tags?: string[];
|
|
450
|
+
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, }?: {
|
|
451
|
+
itemId: number;
|
|
452
|
+
size: string;
|
|
470
453
|
pageNo?: number;
|
|
471
454
|
pageSize?: number;
|
|
472
|
-
|
|
455
|
+
q?: string;
|
|
456
|
+
sellable?: boolean;
|
|
457
|
+
}): Promise<InventoryResponsePaginated>;
|
|
473
458
|
/**
|
|
474
459
|
* @param {Object} arg - Arg object.
|
|
475
|
-
* @param {number} arg.itemId -
|
|
476
|
-
* @param {string} arg.
|
|
460
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
461
|
+
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
462
|
+
* or Primary Identifier) of which inventory is to get.
|
|
477
463
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
478
464
|
* given set of results
|
|
479
465
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
480
|
-
* page. Default is
|
|
481
|
-
* @
|
|
482
|
-
* @
|
|
483
|
-
* @
|
|
466
|
+
* page. Default is 12.
|
|
467
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
468
|
+
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
469
|
+
* @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
|
|
470
|
+
* @summary: Get Inventory for company
|
|
471
|
+
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
484
472
|
*/
|
|
485
|
-
|
|
473
|
+
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
|
|
486
474
|
itemId: number;
|
|
487
|
-
|
|
475
|
+
sizeIdentifier: string;
|
|
488
476
|
pageNo?: number;
|
|
489
477
|
pageSize?: number;
|
|
490
|
-
|
|
478
|
+
q?: string;
|
|
479
|
+
locationIds?: number[];
|
|
480
|
+
}): Promise<InventorySellerIdentifierResponsePaginated>;
|
|
491
481
|
/**
|
|
492
482
|
* @param {Object} arg - Arg object.
|
|
493
|
-
* @
|
|
494
|
-
* @
|
|
495
|
-
*
|
|
496
|
-
* @returns {Promise<ProductAttributesResponse>} - Success response
|
|
497
|
-
* @summary: Get list of all the attributes by their l3_categories
|
|
498
|
-
* @description: This API allows to list all the attributes by their l3_categories.
|
|
483
|
+
* @returns {Promise<InventoryExportJob>} - Success response
|
|
484
|
+
* @summary: Get Inventory export history.
|
|
485
|
+
* @description: This API helps to get Inventory export history.
|
|
499
486
|
*/
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
487
|
+
getInventoryExport({}?: any): Promise<InventoryExportJob>;
|
|
488
|
+
/**
|
|
489
|
+
* @param {Object} arg - Arg object.
|
|
490
|
+
* @returns {Promise<GetOptInPlatform>} - Success response
|
|
491
|
+
* @summary: Get opt-in infomation.
|
|
492
|
+
* @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema`
|
|
493
|
+
*/
|
|
494
|
+
getMarketplaceOptinDetail({}?: any): Promise<GetOptInPlatform>;
|
|
495
|
+
/**
|
|
496
|
+
* @param {Object} arg - Arg object.
|
|
497
|
+
* @param {AssignStore} arg.body
|
|
498
|
+
* @returns {Promise<StoreAssignResponse>} - Success response
|
|
499
|
+
* @summary: Location Reassignment
|
|
500
|
+
* @description:
|
|
501
|
+
*/
|
|
502
|
+
getOptimalLocations({ body }?: {
|
|
503
|
+
body: AssignStore;
|
|
504
|
+
}): Promise<StoreAssignResponse>;
|
|
504
505
|
/**
|
|
505
506
|
* @param {Object} arg - Arg object.
|
|
506
507
|
* @param {number} arg.itemId - Item Id of the product.
|
|
@@ -517,69 +518,31 @@ declare class Catalog {
|
|
|
517
518
|
}): Promise<SingleProductResponse>;
|
|
518
519
|
/**
|
|
519
520
|
* @param {Object} arg - Arg object.
|
|
520
|
-
* @param {number} arg.
|
|
521
|
-
*
|
|
522
|
-
* @
|
|
523
|
-
*
|
|
524
|
-
* @
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
itemId: number;
|
|
528
|
-
body: ProductCreateUpdateSchemaV2;
|
|
529
|
-
}): Promise<SuccessResponse>;
|
|
530
|
-
/**
|
|
531
|
-
* @param {Object} arg - Arg object.
|
|
532
|
-
* @param {number} arg.itemId - Id of the product to be updated.
|
|
533
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
534
|
-
* @summary: Delete a product.
|
|
535
|
-
* @description: This API allows to delete product.
|
|
536
|
-
*/
|
|
537
|
-
deleteProduct({ itemId }?: {
|
|
538
|
-
itemId: number;
|
|
539
|
-
}): Promise<SuccessResponse>;
|
|
540
|
-
/**
|
|
541
|
-
* @param {Object} arg - Arg object.
|
|
542
|
-
* @param {number} arg.itemId - Id of the product to be updated.
|
|
543
|
-
* @returns {Promise<GetAllSizes>} - Success response
|
|
544
|
-
* @summary: All Sizes for a given Product
|
|
545
|
-
* @description: This API allows to get All Sizes for a given Product.
|
|
546
|
-
*/
|
|
547
|
-
allSizes({ itemId }?: {
|
|
548
|
-
itemId: number;
|
|
549
|
-
}): Promise<GetAllSizes>;
|
|
550
|
-
/**
|
|
551
|
-
* @param {Object} arg - Arg object.
|
|
552
|
-
* @returns {Promise<ValidateProduct>} - Success response
|
|
553
|
-
* @summary: Validate product/size data
|
|
554
|
-
* @description: This API validates product data.
|
|
555
|
-
*/
|
|
556
|
-
getProductValidation({}?: any): Promise<ValidateProduct>;
|
|
557
|
-
/**
|
|
558
|
-
* @param {Object} arg - Arg object.
|
|
559
|
-
* @param {string} [arg.itemCode] - Item code of the product size.
|
|
560
|
-
* @param {number} arg.itemId - Item Id of the product size.
|
|
561
|
-
* @param {number} [arg.brandUid] - Brand Id of the product size.
|
|
562
|
-
* @param {number} [arg.uid] - Id of the product size.
|
|
563
|
-
* @returns {Promise<ProductListingResponse>} - Success response
|
|
564
|
-
* @summary: Get a single product size.
|
|
565
|
-
* @description: This API helps to get data associated to a particular product size.
|
|
521
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
522
|
+
* given set of results
|
|
523
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
524
|
+
* page. Default is 12.
|
|
525
|
+
* @returns {Promise<BulkAssetResponse>} - Success response
|
|
526
|
+
* @summary: Get a list of all bulk asset jobs.
|
|
527
|
+
* @description: This API helps to get bulk asset jobs data associated to a particular company.
|
|
566
528
|
*/
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
uid?: number;
|
|
572
|
-
}): Promise<ProductListingResponse>;
|
|
529
|
+
getProductAssetsInBulk({ pageNo, pageSize }?: {
|
|
530
|
+
pageNo?: number;
|
|
531
|
+
pageSize?: number;
|
|
532
|
+
}): Promise<BulkAssetResponse>;
|
|
573
533
|
/**
|
|
574
534
|
* @param {Object} arg - Arg object.
|
|
575
|
-
* @param {
|
|
576
|
-
* @
|
|
577
|
-
*
|
|
578
|
-
* @
|
|
535
|
+
* @param {string} arg.category - It is the name of the l3 cateogry
|
|
536
|
+
* @param {boolean} [arg.filter] - If true, returns filtered values, else
|
|
537
|
+
* returns all the attributes
|
|
538
|
+
* @returns {Promise<ProductAttributesResponse>} - Success response
|
|
539
|
+
* @summary: Get list of all the attributes by their l3_categories
|
|
540
|
+
* @description: This API allows to list all the attributes by their l3_categories.
|
|
579
541
|
*/
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
542
|
+
getProductAttributes({ category, filter }?: {
|
|
543
|
+
category: string;
|
|
544
|
+
filter?: boolean;
|
|
545
|
+
}): Promise<ProductAttributesResponse>;
|
|
583
546
|
/**
|
|
584
547
|
* @param {Object} arg - Arg object.
|
|
585
548
|
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
@@ -598,41 +561,64 @@ declare class Catalog {
|
|
|
598
561
|
}): Promise<ProductBulkRequestList>;
|
|
599
562
|
/**
|
|
600
563
|
* @param {Object} arg - Arg object.
|
|
601
|
-
* @param {string} arg.
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
* @
|
|
605
|
-
* @
|
|
606
|
-
* @
|
|
607
|
-
* @description: This API helps to create a bulk products upload job.
|
|
564
|
+
* @param {string} [arg.q] - A search string that is searched with product
|
|
565
|
+
* bundle name.
|
|
566
|
+
* @param {string[]} [arg.slug] - Slugs of bundles to be retrieved.
|
|
567
|
+
* @returns {Promise<GetProductBundleListingResponse>} - Success response
|
|
568
|
+
* @summary: List all Product Bundles
|
|
569
|
+
* @description: Get all product bundles for a particular company
|
|
608
570
|
*/
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
}): Promise<BulkResponse>;
|
|
571
|
+
getProductBundle({ q, slug }?: {
|
|
572
|
+
q?: string;
|
|
573
|
+
slug?: string[];
|
|
574
|
+
}): Promise<GetProductBundleListingResponse>;
|
|
614
575
|
/**
|
|
615
576
|
* @param {Object} arg - Arg object.
|
|
616
|
-
* @param {string} arg.
|
|
617
|
-
*
|
|
618
|
-
* @returns {Promise<
|
|
619
|
-
* @summary:
|
|
620
|
-
* @description:
|
|
577
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
578
|
+
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
579
|
+
* @returns {Promise<GetProductBundleResponse>} - Success response
|
|
580
|
+
* @summary: Get a particular Product Bundle details
|
|
581
|
+
* @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
|
|
621
582
|
*/
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
}): Promise<SuccessResponse>;
|
|
583
|
+
getProductBundleDetail({ id }?: {
|
|
584
|
+
id: string;
|
|
585
|
+
}): Promise<GetProductBundleResponse>;
|
|
626
586
|
/**
|
|
627
587
|
* @param {Object} arg - Arg object.
|
|
628
|
-
* @param {
|
|
629
|
-
*
|
|
630
|
-
* @
|
|
631
|
-
*
|
|
588
|
+
* @param {string} [arg.status] - This is a parameter used to find all the
|
|
589
|
+
* jobs with the specified status.
|
|
590
|
+
* @param {string} [arg.fromDate] - This is a parameter used to find the job
|
|
591
|
+
* from the date specified to the current date.
|
|
592
|
+
* @param {string} [arg.toDate] - This is a parameter used to find the job
|
|
593
|
+
* from the from_date specified to the to_date.
|
|
594
|
+
* @param {string} [arg.q] - It is a query parameter to search the export
|
|
595
|
+
* job with the task ID.
|
|
596
|
+
* @returns {Promise<ProductDownloadsResponse>} - Success response
|
|
597
|
+
* @summary: Allows you to list all product templates export list details
|
|
598
|
+
* @description: Can view details including trigger data, task id , etc.
|
|
599
|
+
*/
|
|
600
|
+
getProductExportJobs({ status, fromDate, toDate, q }?: {
|
|
601
|
+
status?: string;
|
|
602
|
+
fromDate?: string;
|
|
603
|
+
toDate?: string;
|
|
604
|
+
q?: string;
|
|
605
|
+
}): Promise<ProductDownloadsResponse>;
|
|
606
|
+
/**
|
|
607
|
+
* @param {Object} arg - Arg object.
|
|
608
|
+
* @param {string} [arg.itemCode] - Item code of the product size.
|
|
609
|
+
* @param {number} arg.itemId - Item Id of the product size.
|
|
610
|
+
* @param {number} [arg.brandUid] - Brand Id of the product size.
|
|
611
|
+
* @param {number} [arg.uid] - Id of the product size.
|
|
612
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
613
|
+
* @summary: Get a single product size.
|
|
614
|
+
* @description: This API helps to get data associated to a particular product size.
|
|
632
615
|
*/
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
616
|
+
getProductSize({ itemId, itemCode, brandUid, uid }?: {
|
|
617
|
+
itemCode?: string;
|
|
618
|
+
itemId: number;
|
|
619
|
+
brandUid?: number;
|
|
620
|
+
uid?: number;
|
|
621
|
+
}): Promise<ProductListingResponse>;
|
|
636
622
|
/**
|
|
637
623
|
* @param {Object} arg - Arg object.
|
|
638
624
|
* @returns {Promise<ProductTagsViewResponse>} - Success response
|
|
@@ -642,216 +628,177 @@ declare class Catalog {
|
|
|
642
628
|
getProductTags({}?: any): Promise<ProductTagsViewResponse>;
|
|
643
629
|
/**
|
|
644
630
|
* @param {Object} arg - Arg object.
|
|
645
|
-
* @
|
|
646
|
-
* @
|
|
647
|
-
* @
|
|
648
|
-
* @description: This API helps to create a bulk asset upload job.
|
|
631
|
+
* @returns {Promise<ValidateProduct>} - Success response
|
|
632
|
+
* @summary: Validate product/size data
|
|
633
|
+
* @description: This API validates product data.
|
|
649
634
|
*/
|
|
650
|
-
|
|
651
|
-
body: ProductBulkAssets;
|
|
652
|
-
}): Promise<SuccessResponse>;
|
|
635
|
+
getProductValidation({}?: any): Promise<ValidateProduct>;
|
|
653
636
|
/**
|
|
654
637
|
* @param {Object} arg - Arg object.
|
|
638
|
+
* @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
|
|
639
|
+
* @param {number[]} [arg.categoryIds] - Get multiple products filtered by
|
|
640
|
+
* Category Ids
|
|
641
|
+
* @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
|
|
642
|
+
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
643
|
+
* Department Ids
|
|
644
|
+
* @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
|
|
645
|
+
* @param {string} [arg.q] - Get multiple products filtered by q string
|
|
646
|
+
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
655
647
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
656
648
|
* given set of results
|
|
657
649
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
658
|
-
* page. Default is
|
|
659
|
-
* @returns {Promise<
|
|
660
|
-
* @summary: Get
|
|
661
|
-
* @description: This API
|
|
650
|
+
* page. Default is 10.
|
|
651
|
+
* @returns {Promise<ProductListingResponseV2>} - Success response
|
|
652
|
+
* @summary: Get product list
|
|
653
|
+
* @description: This API gets meta associated to products.
|
|
662
654
|
*/
|
|
663
|
-
|
|
655
|
+
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, }?: {
|
|
656
|
+
brandIds?: number[];
|
|
657
|
+
categoryIds?: number[];
|
|
658
|
+
itemIds?: number[];
|
|
659
|
+
departmentIds?: number[];
|
|
660
|
+
itemCode?: string[];
|
|
661
|
+
q?: string;
|
|
662
|
+
tags?: string[];
|
|
664
663
|
pageNo?: number;
|
|
665
664
|
pageSize?: number;
|
|
666
|
-
}): Promise<
|
|
665
|
+
}): Promise<ProductListingResponseV2>;
|
|
667
666
|
/**
|
|
668
667
|
* @param {Object} arg - Arg object.
|
|
669
|
-
* @param {
|
|
670
|
-
*
|
|
671
|
-
* @
|
|
672
|
-
* @
|
|
673
|
-
* @
|
|
674
|
-
* @description: This API allows to delete size associated with product.
|
|
668
|
+
* @param {string} arg.sellerAppId - Id of the seller application which is
|
|
669
|
+
* serving the invetory/catalog of the company
|
|
670
|
+
* @returns {Promise<CrossSellingResponse>} - Success response
|
|
671
|
+
* @summary: Analytics data of catalog and inventory that are being cross-selled.
|
|
672
|
+
* @description: Analytics data of catalog and inventory that are being cross-selled.
|
|
675
673
|
*/
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
}): Promise<ProductSizeDeleteResponse>;
|
|
674
|
+
getSellerInsights({ sellerAppId }?: {
|
|
675
|
+
sellerAppId: string;
|
|
676
|
+
}): Promise<CrossSellingResponse>;
|
|
680
677
|
/**
|
|
681
678
|
* @param {Object} arg - Arg object.
|
|
682
|
-
* @param {
|
|
683
|
-
* @
|
|
684
|
-
* @
|
|
685
|
-
* @
|
|
686
|
-
* @summary: Add Inventory for particular size and store.
|
|
687
|
-
* @description: This API allows add Inventory for particular size and store.
|
|
679
|
+
* @param {string} arg.reportingHsn - Reporting_hsn
|
|
680
|
+
* @returns {Promise<HSNDataInsertV2>} - Success response
|
|
681
|
+
* @summary: Hsn Code List.
|
|
682
|
+
* @description: Hsn Code List.
|
|
688
683
|
*/
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
body: InventoryRequest;
|
|
693
|
-
}): Promise<SuccessResponse>;
|
|
684
|
+
getSingleProductHSNCode({ reportingHsn }?: {
|
|
685
|
+
reportingHsn: string;
|
|
686
|
+
}): Promise<HSNDataInsertV2>;
|
|
694
687
|
/**
|
|
695
688
|
* @param {Object} arg - Arg object.
|
|
696
|
-
* @param {
|
|
697
|
-
* @
|
|
698
|
-
* @
|
|
699
|
-
*
|
|
700
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
701
|
-
* page. Default is 12.
|
|
702
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
703
|
-
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
704
|
-
* @returns {Promise<InventoryResponsePaginated>} - Success response
|
|
705
|
-
* @summary: Get Inventory for company
|
|
706
|
-
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
689
|
+
* @param {string} arg.id - Id of the size guide to be viewed.
|
|
690
|
+
* @returns {Promise<SizeGuideResponse>} - Success response
|
|
691
|
+
* @summary: Get a single size guide.
|
|
692
|
+
* @description: This API helps to get data associated to a size guide.
|
|
707
693
|
*/
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
pageNo?: number;
|
|
712
|
-
pageSize?: number;
|
|
713
|
-
q?: string;
|
|
714
|
-
sellable?: boolean;
|
|
715
|
-
}): Promise<InventoryResponsePaginated>;
|
|
694
|
+
getSizeGuide({ id }?: {
|
|
695
|
+
id: string;
|
|
696
|
+
}): Promise<SizeGuideResponse>;
|
|
716
697
|
/**
|
|
717
698
|
* @param {Object} arg - Arg object.
|
|
718
|
-
* @param {
|
|
719
|
-
* @param {string} arg.
|
|
720
|
-
*
|
|
699
|
+
* @param {boolean} [arg.active] - Filter size guide on basis of active, in-active
|
|
700
|
+
* @param {string} [arg.q] - Query that is to be searched.
|
|
701
|
+
* @param {string} [arg.tag] - To filter size guide on basis of tag.
|
|
721
702
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
722
703
|
* given set of results
|
|
723
704
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
724
|
-
* page. Default is
|
|
725
|
-
* @
|
|
726
|
-
* @
|
|
727
|
-
* @
|
|
728
|
-
* @summary: Get Inventory for company
|
|
729
|
-
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
705
|
+
* page. Default is 10.
|
|
706
|
+
* @returns {Promise<ListSizeGuide>} - Success response
|
|
707
|
+
* @summary: Get list of size guides
|
|
708
|
+
* @description: This API allows to view all the size guides associated to the seller.
|
|
730
709
|
*/
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
710
|
+
getSizeGuides({ active, q, tag, pageNo, pageSize }?: {
|
|
711
|
+
active?: boolean;
|
|
712
|
+
q?: string;
|
|
713
|
+
tag?: string;
|
|
734
714
|
pageNo?: number;
|
|
735
715
|
pageSize?: number;
|
|
736
|
-
|
|
737
|
-
locationIds?: number[];
|
|
738
|
-
}): Promise<InventorySellerIdentifierResponsePaginated>;
|
|
716
|
+
}): Promise<ListSizeGuide>;
|
|
739
717
|
/**
|
|
740
718
|
* @param {Object} arg - Arg object.
|
|
741
|
-
* @param {string} [arg.
|
|
742
|
-
* @param {
|
|
743
|
-
* @param {number} [arg.
|
|
744
|
-
*
|
|
745
|
-
* @
|
|
746
|
-
*
|
|
747
|
-
* @
|
|
748
|
-
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
749
|
-
* @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
|
|
750
|
-
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
751
|
-
* or Primary Identifier) of which inventory is to get.
|
|
752
|
-
* @returns {Promise<GetInventoriesResponse>} - Success response
|
|
753
|
-
* @summary: Get Inventory for company
|
|
754
|
-
* @description: This API allows get Inventories data for particular company.
|
|
719
|
+
* @param {string} [arg.q] - The search related the store for the company id.
|
|
720
|
+
* @param {number} [arg.pageNo] - The number of page for the company id.
|
|
721
|
+
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
722
|
+
* the page for the company id.
|
|
723
|
+
* @returns {Promise<OptinStoreDetails>} - Success response
|
|
724
|
+
* @summary: Get the Store details.
|
|
725
|
+
* @description: Get the details of the store associated with the company ID passed.
|
|
755
726
|
*/
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
size?: string;
|
|
727
|
+
getStoreDetail({ q, pageNo, pageSize }?: {
|
|
728
|
+
q?: string;
|
|
759
729
|
pageNo?: number;
|
|
760
730
|
pageSize?: number;
|
|
761
|
-
|
|
762
|
-
sellable?: boolean;
|
|
763
|
-
storeIds?: number[];
|
|
764
|
-
sizeIdentifier?: string;
|
|
765
|
-
}): Promise<GetInventoriesResponse>;
|
|
766
|
-
/**
|
|
767
|
-
* @param {Object} arg - Arg object.
|
|
768
|
-
* @param {string} arg.size - Size that is to be deleted.
|
|
769
|
-
* @param {number} arg.itemId - Id of the product associated with Inventory
|
|
770
|
-
* to be deleted.
|
|
771
|
-
* @param {number} arg.locationId - Location ID of store of which inventory
|
|
772
|
-
* is to be deleted.
|
|
773
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
774
|
-
* @summary: Delete a Inventory.
|
|
775
|
-
* @description: This API allows to delete inventory of a particular product for particular company.
|
|
776
|
-
*/
|
|
777
|
-
deleteInventory({ size, itemId, locationId }?: {
|
|
778
|
-
size: string;
|
|
779
|
-
itemId: number;
|
|
780
|
-
locationId: number;
|
|
781
|
-
}): Promise<SuccessResponse>;
|
|
782
|
-
/**
|
|
783
|
-
* @param {Object} arg - Arg object.
|
|
784
|
-
* @param {BulkJob} arg.body
|
|
785
|
-
* @returns {Promise<BulkResponse>} - Success response
|
|
786
|
-
* @summary: Create a Bulk Inventory upload Job.
|
|
787
|
-
* @description: This API helps to create a bulk Inventory upload job.
|
|
788
|
-
*/
|
|
789
|
-
createBulkInventoryJob({ body }?: {
|
|
790
|
-
body: BulkJob;
|
|
791
|
-
}): Promise<BulkResponse>;
|
|
731
|
+
}): Promise<OptinStoreDetails>;
|
|
792
732
|
/**
|
|
793
733
|
* @param {Object} arg - Arg object.
|
|
734
|
+
* @param {number} arg.itemId - Get list of variants of item Id
|
|
735
|
+
* @param {string} arg.variantType - Get multiple products filtered by variant type
|
|
794
736
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
795
737
|
* given set of results
|
|
796
738
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
797
|
-
* page. Default is
|
|
798
|
-
* @returns {Promise<
|
|
799
|
-
* @summary: Get
|
|
800
|
-
* @description: This API
|
|
739
|
+
* page. Default is 10.
|
|
740
|
+
* @returns {Promise<ProductVariantsResponse>} - Success response
|
|
741
|
+
* @summary: Get product list
|
|
742
|
+
* @description: This API gets meta associated to products.
|
|
801
743
|
*/
|
|
802
|
-
|
|
744
|
+
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize }?: {
|
|
745
|
+
itemId: number;
|
|
746
|
+
variantType: string;
|
|
803
747
|
pageNo?: number;
|
|
804
748
|
pageSize?: number;
|
|
805
|
-
}): Promise<
|
|
806
|
-
/**
|
|
807
|
-
* @param {Object} arg - Arg object.
|
|
808
|
-
* @param {string} arg.batchId - Batch Id of the bulk create job.
|
|
809
|
-
* @param {InventoryBulkRequest} arg.body
|
|
810
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
811
|
-
* @summary: Create products in bulk associated with given batch Id.
|
|
812
|
-
* @description: This API helps to create products in bulk push to kafka for approval/creation.
|
|
813
|
-
*/
|
|
814
|
-
createBulkInventory({ batchId, body }?: {
|
|
815
|
-
batchId: string;
|
|
816
|
-
body: InventoryBulkRequest;
|
|
817
|
-
}): Promise<SuccessResponse>;
|
|
818
|
-
/**
|
|
819
|
-
* @param {Object} arg - Arg object.
|
|
820
|
-
* @param {string} arg.batchId - Batch Id of the bulk delete job.
|
|
821
|
-
* @returns {Promise<SuccessResponse>} - Success response
|
|
822
|
-
* @summary: Delete Bulk Inventory job.
|
|
823
|
-
* @description: This API allows to delete bulk Inventory job associated with company.
|
|
824
|
-
*/
|
|
825
|
-
deleteBulkInventoryJob({ batchId }?: {
|
|
826
|
-
batchId: string;
|
|
827
|
-
}): Promise<SuccessResponse>;
|
|
749
|
+
}): Promise<ProductVariantsResponse>;
|
|
828
750
|
/**
|
|
829
751
|
* @param {Object} arg - Arg object.
|
|
830
|
-
* @param {
|
|
831
|
-
* @
|
|
832
|
-
* @
|
|
833
|
-
* @
|
|
752
|
+
* @param {string} [arg.level] - Get category for multiple levels
|
|
753
|
+
* @param {string} [arg.departments] - Get category for multiple departments filtered
|
|
754
|
+
* @param {string} [arg.q] - Get multiple categories filtered by search string
|
|
755
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
756
|
+
* given set of results
|
|
757
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
758
|
+
* page. Default is 10.
|
|
759
|
+
* @returns {Promise<CategoryResponse>} - Success response
|
|
760
|
+
* @summary: Get product categories list
|
|
761
|
+
* @description: This API gets meta associated to product categories.
|
|
834
762
|
*/
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
763
|
+
listCategories({ level, departments, q, pageNo, pageSize }?: {
|
|
764
|
+
level?: string;
|
|
765
|
+
departments?: string;
|
|
766
|
+
q?: string;
|
|
767
|
+
pageNo?: number;
|
|
768
|
+
pageSize?: number;
|
|
769
|
+
}): Promise<CategoryResponse>;
|
|
838
770
|
/**
|
|
839
771
|
* @param {Object} arg - Arg object.
|
|
840
|
-
* @
|
|
841
|
-
*
|
|
842
|
-
* @
|
|
772
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
773
|
+
* given set of results
|
|
774
|
+
* @param {string} [arg.itemType] - A `item_type` is a type of product eg.
|
|
775
|
+
* set, standard, digital
|
|
776
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
777
|
+
* page. Default is 10.
|
|
778
|
+
* @param {string} [arg.name] - Can search departments by passing name.
|
|
779
|
+
* @param {string} [arg.search] - Can search departments by passing name of
|
|
780
|
+
* the department in search parameter.
|
|
781
|
+
* @param {boolean} [arg.isActive] - Can query for departments based on
|
|
782
|
+
* whether they are active or inactive.
|
|
783
|
+
* @returns {Promise<DepartmentsResponse>} - Success response
|
|
784
|
+
* @summary: List all Departments.
|
|
785
|
+
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
|
|
843
786
|
*/
|
|
844
|
-
|
|
787
|
+
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, }?: {
|
|
788
|
+
pageNo?: number;
|
|
789
|
+
itemType?: string;
|
|
790
|
+
pageSize?: number;
|
|
791
|
+
name?: string;
|
|
792
|
+
search?: string;
|
|
793
|
+
isActive?: boolean;
|
|
794
|
+
}): Promise<DepartmentsResponse>;
|
|
845
795
|
/**
|
|
846
796
|
* @param {Object} arg - Arg object.
|
|
847
|
-
* @
|
|
848
|
-
* @
|
|
849
|
-
* @
|
|
850
|
-
* @description: This API helps to create a Inventory export job.
|
|
797
|
+
* @returns {Promise<HSNCodesResponse>} - Success response
|
|
798
|
+
* @summary: List HSN Codes
|
|
799
|
+
* @description: Allows you to list all hsn Codes
|
|
851
800
|
*/
|
|
852
|
-
|
|
853
|
-
body: InventoryCreateRequest;
|
|
854
|
-
}): Promise<InventoryExportResponse>;
|
|
801
|
+
listHSNCodes({}?: any): Promise<HSNCodesResponse>;
|
|
855
802
|
/**
|
|
856
803
|
* @param {Object} arg - Arg object.
|
|
857
804
|
* @param {string} [arg.status] - Status of the export job.
|
|
@@ -872,65 +819,77 @@ declare class Catalog {
|
|
|
872
819
|
}): Promise<InventoryExportJobListResponse>;
|
|
873
820
|
/**
|
|
874
821
|
* @param {Object} arg - Arg object.
|
|
875
|
-
* @param {string}
|
|
876
|
-
*
|
|
877
|
-
* @returns {Promise<
|
|
878
|
-
* @summary:
|
|
879
|
-
* @description:
|
|
822
|
+
* @param {string} arg.department - A `department` is the name of a
|
|
823
|
+
* particular department.
|
|
824
|
+
* @returns {Promise<TemplatesResponse>} - Success response
|
|
825
|
+
* @summary: List all Templates
|
|
826
|
+
* @description: Allows you to list all product templates, also can filter by department
|
|
880
827
|
*/
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
}): Promise<
|
|
828
|
+
listProductTemplate({ department }?: {
|
|
829
|
+
department: string;
|
|
830
|
+
}): Promise<TemplatesResponse>;
|
|
884
831
|
/**
|
|
885
832
|
* @param {Object} arg - Arg object.
|
|
886
|
-
* @param {
|
|
887
|
-
*
|
|
888
|
-
*
|
|
889
|
-
*
|
|
890
|
-
* @returns {Promise<
|
|
891
|
-
* @summary:
|
|
892
|
-
* @description:
|
|
833
|
+
* @param {string} arg.departments - A `department` is name of a departments
|
|
834
|
+
* whose category needs to be listed. Can specify multiple departments.
|
|
835
|
+
* @param {string} arg.itemType - An `item_type` is the type of item, it can
|
|
836
|
+
* be `set`, `standard`, `digital`, etc.
|
|
837
|
+
* @returns {Promise<ProdcutTemplateCategoriesResponse>} - Success response
|
|
838
|
+
* @summary: List Department specifiec product categories
|
|
839
|
+
* @description: Allows you to list all product categories values for the departments specified
|
|
893
840
|
*/
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
}): Promise<InventoryUpdateResponse>;
|
|
841
|
+
listProductTemplateCategories({ departments, itemType }?: {
|
|
842
|
+
departments: string;
|
|
843
|
+
itemType: string;
|
|
844
|
+
}): Promise<ProdcutTemplateCategoriesResponse>;
|
|
899
845
|
/**
|
|
900
846
|
* @param {Object} arg - Arg object.
|
|
901
|
-
* @
|
|
902
|
-
* @
|
|
903
|
-
*
|
|
904
|
-
* @param {InventoryRequestSchemaV2} arg.body
|
|
905
|
-
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
906
|
-
* @summary: Add Inventory for particular size and store.
|
|
907
|
-
* @description: This API allows add Inventory for particular size and store.
|
|
847
|
+
* @returns {Promise<ProductDownloadsResponse>} - Success response
|
|
848
|
+
* @summary: Allows you to list all product templates export list details
|
|
849
|
+
* @description: Can view details including trigger data, task id , etc.
|
|
908
850
|
*/
|
|
909
|
-
|
|
910
|
-
itemId: number;
|
|
911
|
-
sellerIdentifier: string;
|
|
912
|
-
body: InventoryRequestSchemaV2;
|
|
913
|
-
}): Promise<InventoryUpdateResponse>;
|
|
851
|
+
listProductTemplateExportDetails({}?: any): Promise<ProductDownloadsResponse>;
|
|
914
852
|
/**
|
|
915
853
|
* @param {Object} arg - Arg object.
|
|
916
|
-
* @param {
|
|
917
|
-
*
|
|
918
|
-
* @
|
|
919
|
-
*
|
|
854
|
+
* @param {string} arg.filter - A `filter` is the unique identifier of the
|
|
855
|
+
* type of value required.
|
|
856
|
+
* @param {string} [arg.templateTag] - A `template_tag` is the identifier of
|
|
857
|
+
* the type of template required.
|
|
858
|
+
* @param {string} [arg.itemType] - A `item_type` is the identifier of the
|
|
859
|
+
* type of template required.
|
|
860
|
+
* @returns {Promise<ProductConfigurationDownloads>} - Success response
|
|
861
|
+
* @summary: Allows you to list all values for Templates, Brands or Type
|
|
862
|
+
* @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same
|
|
920
863
|
*/
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
864
|
+
listTemplateBrandTypeValues({ filter, templateTag, itemType }?: {
|
|
865
|
+
filter: string;
|
|
866
|
+
templateTag?: string;
|
|
867
|
+
itemType?: string;
|
|
868
|
+
}): Promise<ProductConfigurationDownloads>;
|
|
924
869
|
/**
|
|
925
870
|
* @param {Object} arg - Arg object.
|
|
926
|
-
* @param {string} arg.
|
|
927
|
-
* @
|
|
928
|
-
* @
|
|
929
|
-
* @
|
|
871
|
+
* @param {string} arg.uid - Category unique id
|
|
872
|
+
* @param {CategoryRequestBody} arg.body
|
|
873
|
+
* @returns {Promise<CategoryUpdateResponse>} - Success response
|
|
874
|
+
* @summary: Update product categories
|
|
875
|
+
* @description: Update a product category using this apu
|
|
930
876
|
*/
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
877
|
+
updateCategory({ uid, body }?: {
|
|
878
|
+
uid: string;
|
|
879
|
+
body: CategoryRequestBody;
|
|
880
|
+
}): Promise<CategoryUpdateResponse>;
|
|
881
|
+
/**
|
|
882
|
+
* @param {Object} arg - Arg object.
|
|
883
|
+
* @param {string} arg.uid - A `uid` is a unique identifier of a department.
|
|
884
|
+
* @param {DepartmentCreateUpdate} arg.body
|
|
885
|
+
* @returns {Promise<DepartmentModel>} - Success response
|
|
886
|
+
* @summary: Update the department by their uid.
|
|
887
|
+
* @description: Update the department by their uid using this API.
|
|
888
|
+
*/
|
|
889
|
+
updateDepartment({ uid, body }?: {
|
|
890
|
+
uid: string;
|
|
891
|
+
body: DepartmentCreateUpdate;
|
|
892
|
+
}): Promise<DepartmentModel>;
|
|
934
893
|
/**
|
|
935
894
|
* @param {Object} arg - Arg object.
|
|
936
895
|
* @param {string} arg.id - Unique id
|
|
@@ -945,48 +904,89 @@ declare class Catalog {
|
|
|
945
904
|
}): Promise<HsnCode>;
|
|
946
905
|
/**
|
|
947
906
|
* @param {Object} arg - Arg object.
|
|
948
|
-
* @param {
|
|
949
|
-
* @returns {Promise<
|
|
950
|
-
* @summary:
|
|
951
|
-
* @description:
|
|
907
|
+
* @param {InventoryRequestSchemaV2} arg.body
|
|
908
|
+
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
909
|
+
* @summary: Add Inventory for particular size and store.
|
|
910
|
+
* @description: This API allows add Inventory for particular size and store.
|
|
952
911
|
*/
|
|
953
|
-
|
|
954
|
-
body:
|
|
955
|
-
}): Promise<
|
|
912
|
+
updateInventories({ body }?: {
|
|
913
|
+
body: InventoryRequestSchemaV2;
|
|
914
|
+
}): Promise<InventoryUpdateResponse>;
|
|
956
915
|
/**
|
|
957
916
|
* @param {Object} arg - Arg object.
|
|
958
|
-
* @param {
|
|
959
|
-
*
|
|
960
|
-
* @param {
|
|
961
|
-
* @
|
|
962
|
-
* @
|
|
963
|
-
* @
|
|
964
|
-
* @description: Hsn Code List.
|
|
917
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
918
|
+
* detail. Pass the `id` of the keywords which you want to delete.
|
|
919
|
+
* @param {ProductBundleUpdateRequest} arg.body
|
|
920
|
+
* @returns {Promise<GetProductBundleCreateResponse>} - Success response
|
|
921
|
+
* @summary: Update a Product Bundle
|
|
922
|
+
* @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
|
|
965
923
|
*/
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
type?: string;
|
|
971
|
-
}): Promise<HsnCodesListingResponseSchemaV2>;
|
|
924
|
+
updateProductBundle({ id, body }?: {
|
|
925
|
+
id: string;
|
|
926
|
+
body: ProductBundleUpdateRequest;
|
|
927
|
+
}): Promise<GetProductBundleCreateResponse>;
|
|
972
928
|
/**
|
|
973
929
|
* @param {Object} arg - Arg object.
|
|
974
|
-
* @param {
|
|
975
|
-
* @
|
|
976
|
-
*
|
|
977
|
-
* @
|
|
930
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
931
|
+
* @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
|
|
932
|
+
* or Primary Identifier) of which inventory is to get.
|
|
933
|
+
* @param {InventoryRequestSchemaV2} arg.body
|
|
934
|
+
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
935
|
+
* @summary: Add Inventory for particular size and store.
|
|
936
|
+
* @description: This API allows add Inventory for particular size and store.
|
|
978
937
|
*/
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
938
|
+
updateRealtimeInventory({ itemId, sellerIdentifier, body }?: {
|
|
939
|
+
itemId: number;
|
|
940
|
+
sellerIdentifier: string;
|
|
941
|
+
body: InventoryRequestSchemaV2;
|
|
942
|
+
}): Promise<InventoryUpdateResponse>;
|
|
982
943
|
/**
|
|
983
944
|
* @param {Object} arg - Arg object.
|
|
984
|
-
* @param {
|
|
985
|
-
* @
|
|
986
|
-
* @
|
|
987
|
-
* @
|
|
945
|
+
* @param {string} arg.id - Mongo id of the size guide to be edited
|
|
946
|
+
* @param {ValidateSizeGuide} arg.body
|
|
947
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
948
|
+
* @summary: Edit a size guide.
|
|
949
|
+
* @description: This API allows to edit a size guide.
|
|
988
950
|
*/
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
951
|
+
updateSizeGuide({ id, body }?: {
|
|
952
|
+
id: string;
|
|
953
|
+
body: ValidateSizeGuide;
|
|
954
|
+
}): Promise<SuccessResponse>;
|
|
955
|
+
/**
|
|
956
|
+
* @param {Object} arg - Arg object.
|
|
957
|
+
* @param {string} arg.department - Department of the product to be uploaded.
|
|
958
|
+
* @param {string} arg.productType - Product type of the product to be
|
|
959
|
+
* uploaded i.e. set, standard , digital.
|
|
960
|
+
* @param {BulkJob} arg.body
|
|
961
|
+
* @returns {Promise<BulkResponse>} - Success response
|
|
962
|
+
* @summary: Create a Bulk product to upload job.
|
|
963
|
+
* @description: This API helps to create a bulk products upload job.
|
|
964
|
+
*/
|
|
965
|
+
uploadBulkProducts({ department, productType, body }?: {
|
|
966
|
+
department: string;
|
|
967
|
+
productType: string;
|
|
968
|
+
body: BulkJob;
|
|
969
|
+
}): Promise<BulkResponse>;
|
|
970
|
+
/**
|
|
971
|
+
* @param {Object} arg - Arg object.
|
|
972
|
+
* @param {string} arg.slug - A `slug` is a unique identifier for a
|
|
973
|
+
* particular template.
|
|
974
|
+
* @returns {Promise<TemplatesValidationResponse>} - Success response
|
|
975
|
+
* @summary: Validate Product Template Schema
|
|
976
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database
|
|
977
|
+
*/
|
|
978
|
+
validateProductTemplate({ slug }?: {
|
|
979
|
+
slug: string;
|
|
980
|
+
}): Promise<TemplatesValidationResponse>;
|
|
981
|
+
/**
|
|
982
|
+
* @param {Object} arg - Arg object.
|
|
983
|
+
* @param {string} arg.itemType - An `item_type` defines the type of item.
|
|
984
|
+
* The default value is standard.
|
|
985
|
+
* @returns {Promise<InventoryValidationResponse>} - Success response
|
|
986
|
+
* @summary: Validate Product Template Schema
|
|
987
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database
|
|
988
|
+
*/
|
|
989
|
+
validateProductTemplateSchema({ itemType }?: {
|
|
990
|
+
itemType: string;
|
|
991
|
+
}): Promise<InventoryValidationResponse>;
|
|
992
992
|
}
|