@gofynd/fdk-client-javascript 0.1.35 → 0.1.37
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/documentation/application/CART.md +272 -249
- package/documentation/application/CATALOG.md +417 -413
- package/documentation/application/COMMON.md +4 -0
- package/documentation/application/COMMUNICATION.md +4 -0
- package/documentation/application/CONFIGURATION.md +4 -0
- package/documentation/application/CONTENT.md +7 -20
- package/documentation/application/FILESTORAGE.md +85 -0
- package/documentation/application/LEAD.md +6 -2
- package/documentation/application/LOGISTIC.md +427 -101
- package/documentation/application/ORDER.md +292 -288
- package/documentation/application/PAYMENT.md +445 -259
- package/documentation/application/POSCART.md +309 -286
- package/documentation/application/README.md +1 -1
- package/documentation/application/REWARDS.md +153 -160
- package/documentation/application/SHARE.md +4 -0
- package/documentation/application/THEME.md +4 -0
- package/documentation/application/USER.md +4 -0
- package/documentation/platform/ANALYTICS.md +4 -0
- package/documentation/platform/AUDITTRAIL.md +6 -2
- package/documentation/platform/BILLING.md +4 -0
- package/documentation/platform/CART.md +476 -459
- package/documentation/platform/CATALOG.md +4138 -2968
- package/documentation/platform/COMMON.md +4 -0
- package/documentation/platform/COMMUNICATION.md +4 -0
- package/documentation/platform/COMPANYPROFILE.md +258 -206
- package/documentation/platform/CONFIGURATION.md +4 -0
- package/documentation/platform/CONTENT.md +8 -21
- package/documentation/platform/DISCOUNT.md +4 -0
- package/documentation/platform/FILESTORAGE.md +85 -0
- package/documentation/platform/INVENTORY.md +4 -0
- package/documentation/platform/LEAD.md +6 -2
- package/documentation/platform/ORDER.md +6298 -1448
- package/documentation/platform/PARTNER.md +12 -8
- package/documentation/platform/PAYMENT.md +107 -103
- package/documentation/platform/README.md +2 -2
- package/documentation/platform/REWARDS.md +219 -152
- package/documentation/platform/SHARE.md +4 -0
- package/documentation/platform/THEME.md +4 -0
- package/documentation/platform/USER.md +4 -0
- package/documentation/platform/WEBHOOK.md +4 -0
- package/documentation/public/CONFIGURATION.md +4 -0
- package/documentation/public/INVENTORY.md +4 -0
- package/documentation/public/WEBHOOK.md +4 -0
- package/package.json +2 -2
- package/sdk/application/ApplicationAPIClient.js +3 -0
- package/sdk/application/ApplicationClient.d.ts +1 -0
- package/sdk/application/ApplicationClient.js +11 -1
- package/sdk/application/ApplicationConfig.d.ts +1 -0
- package/sdk/application/ApplicationConfig.js +1 -0
- package/sdk/application/ApplicationModels.d.ts +94 -85
- package/sdk/application/ApplicationModels.js +1909 -1792
- package/sdk/application/client/CartApplicationClient.d.ts +36 -36
- package/sdk/application/client/CatalogApplicationClient.d.ts +39 -39
- package/sdk/application/client/CatalogApplicationClient.js +16 -16
- package/sdk/application/client/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/client/CommunicationApplicationClient.d.ts +5 -5
- package/sdk/application/client/ConfigurationApplicationClient.d.ts +17 -17
- package/sdk/application/client/ContentApplicationClient.d.ts +19 -19
- package/sdk/application/client/FileStorageApplicationClient.d.ts +14 -6
- package/sdk/application/client/FileStorageApplicationClient.js +2 -0
- package/sdk/application/client/LeadApplicationClient.d.ts +10 -10
- package/sdk/application/client/LogisticApplicationClient.d.ts +32 -21
- package/sdk/application/client/LogisticApplicationClient.js +62 -27
- package/sdk/application/client/OrderApplicationClient.d.ts +15 -15
- package/sdk/application/client/OrderApplicationClient.js +1 -1
- package/sdk/application/client/PaymentApplicationClient.d.ts +79 -57
- package/sdk/application/client/PaymentApplicationClient.js +66 -0
- package/sdk/application/client/PosCartApplicationClient.d.ts +38 -38
- package/sdk/application/client/RewardsApplicationClient.d.ts +34 -34
- package/sdk/application/client/RewardsApplicationClient.js +77 -77
- package/sdk/application/client/ShareApplicationClient.d.ts +8 -8
- package/sdk/application/client/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/client/UserApplicationClient.d.ts +63 -63
- package/sdk/application/models/CatalogValidator.d.ts +1 -1
- package/sdk/application/models/CatalogValidator.js +2 -2
- package/sdk/application/models/LogisticValidator.d.ts +2 -1
- package/sdk/application/models/LogisticValidator.js +11 -6
- package/sdk/application/models/PaymentValidator.d.ts +2 -0
- package/sdk/application/models/PaymentValidator.js +12 -0
- package/sdk/application/models/RewardsValidator.d.ts +3 -3
- package/sdk/application/models/RewardsValidator.js +12 -12
- package/sdk/common/AxiosHelper.js +1 -1
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/platform/PlatformApplicationClient.d.ts +7962 -6505
- package/sdk/platform/PlatformApplicationClient.js +4377 -3635
- package/sdk/platform/PlatformApplicationModels.d.ts +26 -31
- package/sdk/platform/PlatformApplicationModels.js +5530 -4134
- package/sdk/platform/PlatformClient.d.ts +3495 -2780
- package/sdk/platform/PlatformClient.js +3985 -3108
- package/sdk/platform/PlatformModels.d.ts +354 -273
- package/sdk/platform/PlatformModels.js +5635 -4211
- package/sdk/platform/client/AnalyticsPlatformClient.d.ts +5 -5
- package/sdk/platform/client/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/client/BillingPlatformClient.d.ts +4 -4
- package/sdk/platform/client/CatalogPlatformClient.d.ts +222 -154
- package/sdk/platform/client/CatalogPlatformClient.js +473 -295
- package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +8 -8
- package/sdk/platform/client/ConfigurationPlatformClient.d.ts +9 -9
- package/sdk/platform/client/DiscountPlatformClient.d.ts +4 -4
- package/sdk/platform/client/FileStoragePlatformClient.d.ts +20 -4
- package/sdk/platform/client/FileStoragePlatformClient.js +49 -0
- package/sdk/platform/client/InventoryPlatformClient.d.ts +3 -3
- package/sdk/platform/client/LeadPlatformClient.d.ts +6 -6
- package/sdk/platform/client/OrderPlatformClient.d.ts +557 -131
- package/sdk/platform/client/OrderPlatformClient.js +1551 -247
- package/sdk/platform/client/PaymentPlatformClient.d.ts +4 -4
- package/sdk/platform/client/WebhookPlatformClient.d.ts +2 -2
- package/sdk/platform/models/CatalogValidator.d.ts +26 -22
- package/sdk/platform/models/CatalogValidator.js +109 -72
- package/sdk/platform/models/OrderValidator.d.ts +43 -11
- package/sdk/platform/models/OrderValidator.js +312 -51
- package/sdk/public/client/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/client/InventoryPublicClient.d.ts +7 -7
- package/sdk/public/client/WebhookPublicClient.d.ts +3 -3
- package/tests/common/schema/action-url.json +15 -0
- package/tests/common/schema/url-action.json +16 -0
|
@@ -4,187 +4,613 @@ declare class Order {
|
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
6
|
* @param {Object} arg - Arg object.
|
|
7
|
-
* @param {
|
|
8
|
-
* @
|
|
9
|
-
* @
|
|
7
|
+
* @param {string} [arg.lane] -
|
|
8
|
+
* @param {string} [arg.searchType] -
|
|
9
|
+
* @param {string} [arg.searchValue] -
|
|
10
|
+
* @param {string} [arg.searchId] -
|
|
11
|
+
* @param {string} [arg.fromDate] -
|
|
12
|
+
* @param {string} [arg.toDate] -
|
|
13
|
+
* @param {string} [arg.dpIds] -
|
|
14
|
+
* @param {string} [arg.orderingCompanyId] -
|
|
15
|
+
* @param {string} [arg.stores] -
|
|
16
|
+
* @param {string} [arg.salesChannel] -
|
|
17
|
+
* @param {string} [arg.requestByExt] -
|
|
18
|
+
* @param {number} [arg.pageNo] -
|
|
19
|
+
* @param {number} [arg.pageSize] -
|
|
20
|
+
* @param {boolean} [arg.isPrioritySort] -
|
|
21
|
+
* @param {boolean} [arg.excludeLockedShipments] -
|
|
22
|
+
* @param {string} [arg.paymentMethods] -
|
|
23
|
+
* @param {string} [arg.channelShipmentId] -
|
|
24
|
+
* @param {string} [arg.channelOrderId] -
|
|
25
|
+
* @param {string} [arg.customMeta] -
|
|
26
|
+
* @summary:
|
|
27
|
+
* @description:
|
|
10
28
|
*/
|
|
11
|
-
|
|
12
|
-
|
|
29
|
+
getShipments({ lane, searchType, searchValue, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, isPrioritySort, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, }?: {
|
|
30
|
+
lane?: string;
|
|
31
|
+
searchType?: string;
|
|
32
|
+
searchValue?: string;
|
|
33
|
+
searchId?: string;
|
|
34
|
+
fromDate?: string;
|
|
35
|
+
toDate?: string;
|
|
36
|
+
dpIds?: string;
|
|
37
|
+
orderingCompanyId?: string;
|
|
38
|
+
stores?: string;
|
|
39
|
+
salesChannel?: string;
|
|
40
|
+
requestByExt?: string;
|
|
41
|
+
pageNo?: number;
|
|
42
|
+
pageSize?: number;
|
|
43
|
+
isPrioritySort?: boolean;
|
|
44
|
+
excludeLockedShipments?: boolean;
|
|
45
|
+
paymentMethods?: string;
|
|
46
|
+
channelShipmentId?: string;
|
|
47
|
+
channelOrderId?: string;
|
|
48
|
+
customMeta?: string;
|
|
13
49
|
}): Promise<any>;
|
|
14
50
|
/**
|
|
15
51
|
* @param {Object} arg - Arg object.
|
|
16
|
-
* @param {string} arg.
|
|
17
|
-
* @
|
|
18
|
-
* @
|
|
52
|
+
* @param {string} [arg.channelShipmentId] -
|
|
53
|
+
* @param {string} [arg.shipmentId] -
|
|
54
|
+
* @param {string} [arg.orderingCompanyId] -
|
|
55
|
+
* @param {string} [arg.requestByExt] -
|
|
56
|
+
* @summary:
|
|
57
|
+
* @description:
|
|
19
58
|
*/
|
|
20
|
-
|
|
21
|
-
|
|
59
|
+
getShipmentById({ channelShipmentId, shipmentId, orderingCompanyId, requestByExt, }?: {
|
|
60
|
+
channelShipmentId?: string;
|
|
61
|
+
shipmentId?: string;
|
|
62
|
+
orderingCompanyId?: string;
|
|
63
|
+
requestByExt?: string;
|
|
22
64
|
}): Promise<any>;
|
|
23
65
|
/**
|
|
24
66
|
* @param {Object} arg - Arg object.
|
|
25
|
-
* @param {
|
|
26
|
-
* @summary:
|
|
27
|
-
* @description:
|
|
67
|
+
* @param {string} arg.orderId -
|
|
68
|
+
* @summary:
|
|
69
|
+
* @description:
|
|
28
70
|
*/
|
|
29
|
-
|
|
30
|
-
|
|
71
|
+
getOrderById({ orderId }?: {
|
|
72
|
+
orderId: string;
|
|
31
73
|
}): Promise<any>;
|
|
32
74
|
/**
|
|
33
75
|
* @param {Object} arg - Arg object.
|
|
34
|
-
* @param {string} arg.
|
|
35
|
-
* @
|
|
36
|
-
* @
|
|
76
|
+
* @param {string} [arg.superLane] -
|
|
77
|
+
* @param {string} [arg.groupEntity] -
|
|
78
|
+
* @param {string} [arg.fromDate] -
|
|
79
|
+
* @param {string} [arg.toDate] -
|
|
80
|
+
* @param {string} [arg.dpIds] -
|
|
81
|
+
* @param {string} [arg.stores] -
|
|
82
|
+
* @param {string} [arg.salesChannel] -
|
|
83
|
+
* @param {string} [arg.paymentMode] -
|
|
84
|
+
* @param {string} [arg.bagStatus] -
|
|
85
|
+
* @summary:
|
|
86
|
+
* @description:
|
|
37
87
|
*/
|
|
38
|
-
|
|
39
|
-
|
|
88
|
+
getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannel, paymentMode, bagStatus, }?: {
|
|
89
|
+
superLane?: string;
|
|
90
|
+
groupEntity?: string;
|
|
91
|
+
fromDate?: string;
|
|
92
|
+
toDate?: string;
|
|
93
|
+
dpIds?: string;
|
|
94
|
+
stores?: string;
|
|
95
|
+
salesChannel?: string;
|
|
96
|
+
paymentMode?: string;
|
|
97
|
+
bagStatus?: string;
|
|
40
98
|
}): Promise<any>;
|
|
41
99
|
/**
|
|
42
100
|
* @param {Object} arg - Arg object.
|
|
43
|
-
* @param {
|
|
44
|
-
* @
|
|
45
|
-
* @
|
|
101
|
+
* @param {string} [arg.lane] -
|
|
102
|
+
* @param {string} [arg.searchType] -
|
|
103
|
+
* @param {string} [arg.searchValue] -
|
|
104
|
+
* @param {string} [arg.fromDate] -
|
|
105
|
+
* @param {string} [arg.toDate] -
|
|
106
|
+
* @param {string} [arg.dpIds] -
|
|
107
|
+
* @param {string} [arg.stores] -
|
|
108
|
+
* @param {string} [arg.salesChannel] -
|
|
109
|
+
* @param {number} [arg.pageNo] -
|
|
110
|
+
* @param {number} [arg.pageSize] -
|
|
111
|
+
* @param {boolean} [arg.isPrioritySort] -
|
|
112
|
+
* @param {string} [arg.customMeta] -
|
|
113
|
+
* @summary:
|
|
114
|
+
* @description:
|
|
46
115
|
*/
|
|
47
|
-
|
|
48
|
-
|
|
116
|
+
getOrders({ lane, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannel, pageNo, pageSize, isPrioritySort, customMeta, }?: {
|
|
117
|
+
lane?: string;
|
|
118
|
+
searchType?: string;
|
|
119
|
+
searchValue?: string;
|
|
120
|
+
fromDate?: string;
|
|
121
|
+
toDate?: string;
|
|
122
|
+
dpIds?: string;
|
|
123
|
+
stores?: string;
|
|
124
|
+
salesChannel?: string;
|
|
125
|
+
pageNo?: number;
|
|
126
|
+
pageSize?: number;
|
|
127
|
+
isPrioritySort?: boolean;
|
|
128
|
+
customMeta?: string;
|
|
49
129
|
}): Promise<any>;
|
|
50
130
|
/**
|
|
51
131
|
* @param {Object} arg - Arg object.
|
|
52
|
-
* @param {string} [arg.
|
|
53
|
-
* @param {string} [arg.
|
|
54
|
-
* @
|
|
55
|
-
* @
|
|
56
|
-
* @param {boolean} [arg.isPrioritySort] - Sorting Order
|
|
57
|
-
* @param {boolean} [arg.lockStatus] - Hide Lock Status
|
|
58
|
-
* @param {string} [arg.userId] - User Id
|
|
59
|
-
* @param {string} [arg.q] - Keyword for Search
|
|
60
|
-
* @param {string} [arg.stage] - Specefic Order Stage
|
|
61
|
-
* @param {string} [arg.salesChannels] - Selected Sales Channel
|
|
62
|
-
* @param {string} [arg.orderId] - Order Id
|
|
63
|
-
* @param {string} [arg.stores] - Selected Stores
|
|
64
|
-
* @param {string} [arg.deploymentStores] - Selected Deployment Stores
|
|
65
|
-
* @param {string} [arg.status] - Status of order
|
|
66
|
-
* @param {string} [arg.dp] - Delivery Partners
|
|
67
|
-
* @param {string} [arg.filterType] - Filters
|
|
68
|
-
* @summary: Get Orders for company based on Company Id
|
|
69
|
-
* @description: Get Orders
|
|
132
|
+
* @param {string} [arg.fromDate] -
|
|
133
|
+
* @param {string} [arg.toDate] -
|
|
134
|
+
* @summary:
|
|
135
|
+
* @description:
|
|
70
136
|
*/
|
|
71
|
-
|
|
72
|
-
pageNo?: string;
|
|
73
|
-
pageSize?: string;
|
|
137
|
+
getMetricCount({ fromDate, toDate }?: {
|
|
74
138
|
fromDate?: string;
|
|
75
139
|
toDate?: string;
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
* @param {
|
|
91
|
-
* @param {string} [arg.
|
|
92
|
-
* @
|
|
93
|
-
* @
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
* @param {string} [arg.stage] - Specefic Order Stage
|
|
97
|
-
* @param {string} [arg.salesChannels] - Selected Sales Channel
|
|
98
|
-
* @param {string} [arg.orderId] - Order Id
|
|
99
|
-
* @param {string} [arg.stores] - Selected Stores
|
|
100
|
-
* @param {string} [arg.status] - Status of order
|
|
101
|
-
* @param {string} [arg.filterType] - Filters
|
|
102
|
-
* @summary: Get Order Lanes Count for company based on Company Id
|
|
103
|
-
* @description: Get Orders Seperate Lane Count
|
|
104
|
-
*/
|
|
105
|
-
getOrderLanesCountByCompanyId({ pageNo, pageSize, fromDate, toDate, q, stage, salesChannels, orderId, stores, status, filterType, }?: {
|
|
106
|
-
pageNo?: string;
|
|
107
|
-
pageSize?: string;
|
|
140
|
+
}): Promise<any>;
|
|
141
|
+
/**
|
|
142
|
+
* @param {Object} arg - Arg object.
|
|
143
|
+
* @param {string} arg.view -
|
|
144
|
+
* @param {string} [arg.groupEntity] -
|
|
145
|
+
* @summary:
|
|
146
|
+
* @description:
|
|
147
|
+
*/
|
|
148
|
+
getfilters({ view, groupEntity }?: {
|
|
149
|
+
view: string;
|
|
150
|
+
groupEntity?: string;
|
|
151
|
+
}): Promise<any>;
|
|
152
|
+
/**
|
|
153
|
+
* @param {Object} arg - Arg object.
|
|
154
|
+
* @param {string} [arg.fromDate] -
|
|
155
|
+
* @param {string} [arg.toDate] -
|
|
156
|
+
* @summary:
|
|
157
|
+
* @description:
|
|
158
|
+
*/
|
|
159
|
+
createShipmentReport({ fromDate, toDate }?: {
|
|
108
160
|
fromDate?: string;
|
|
109
161
|
toDate?: string;
|
|
110
|
-
q?: string;
|
|
111
|
-
stage?: string;
|
|
112
|
-
salesChannels?: string;
|
|
113
|
-
orderId?: string;
|
|
114
|
-
stores?: string;
|
|
115
|
-
status?: string;
|
|
116
|
-
filterType?: string;
|
|
117
162
|
}): Promise<any>;
|
|
118
163
|
/**
|
|
119
164
|
* @param {Object} arg - Arg object.
|
|
120
|
-
* @param {
|
|
121
|
-
* @param {
|
|
122
|
-
* @
|
|
123
|
-
* @
|
|
124
|
-
|
|
165
|
+
* @param {number} [arg.pageNo] -
|
|
166
|
+
* @param {number} [arg.pageSize] -
|
|
167
|
+
* @summary:
|
|
168
|
+
* @description:
|
|
169
|
+
*/
|
|
170
|
+
getReportsShipmentListing({ pageNo, pageSize }?: {
|
|
171
|
+
pageNo?: number;
|
|
172
|
+
pageSize?: number;
|
|
173
|
+
}): Promise<any>;
|
|
174
|
+
/**
|
|
175
|
+
* @param {Object} arg - Arg object.
|
|
176
|
+
* @param {JioCodeUpsertPayload} arg.body
|
|
177
|
+
* @summary:
|
|
178
|
+
* @description:
|
|
179
|
+
*/
|
|
180
|
+
upsertJioCode({ body }?: {
|
|
181
|
+
body: JioCodeUpsertPayload;
|
|
182
|
+
}): Promise<any>;
|
|
183
|
+
/**
|
|
184
|
+
* @param {Object} arg - Arg object.
|
|
185
|
+
* @param {string} arg.batchId -
|
|
186
|
+
* @param {string} arg.docType -
|
|
187
|
+
* @summary:
|
|
188
|
+
* @description:
|
|
189
|
+
*/
|
|
190
|
+
getBulkInvoice({ batchId, docType }?: {
|
|
191
|
+
batchId: string;
|
|
192
|
+
docType: string;
|
|
193
|
+
}): Promise<any>;
|
|
194
|
+
/**
|
|
195
|
+
* @param {Object} arg - Arg object.
|
|
196
|
+
* @param {string} arg.batchId -
|
|
197
|
+
* @summary:
|
|
198
|
+
* @description:
|
|
125
199
|
*/
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
next?: string;
|
|
129
|
-
previous?: string;
|
|
200
|
+
getBulkInvoiceLabel({ batchId }?: {
|
|
201
|
+
batchId: string;
|
|
130
202
|
}): Promise<any>;
|
|
131
203
|
/**
|
|
132
204
|
* @param {Object} arg - Arg object.
|
|
133
|
-
* @param {string} [arg.
|
|
134
|
-
* @param {string} [arg.
|
|
135
|
-
* @param {string} [arg.
|
|
136
|
-
* @param {string} [arg.
|
|
137
|
-
* @param {string} [arg.
|
|
138
|
-
* @param {string} [arg.
|
|
139
|
-
* @param {string} [arg.
|
|
140
|
-
* @param {string} [arg.
|
|
141
|
-
* @param {string} [arg.
|
|
142
|
-
* @param {string} [arg.
|
|
143
|
-
* @param {
|
|
144
|
-
* @
|
|
145
|
-
* @
|
|
205
|
+
* @param {string} [arg.lane] -
|
|
206
|
+
* @param {string} [arg.searchType] -
|
|
207
|
+
* @param {string} [arg.searchId] -
|
|
208
|
+
* @param {string} [arg.fromDate] -
|
|
209
|
+
* @param {string} [arg.toDate] -
|
|
210
|
+
* @param {string} [arg.dpIds] -
|
|
211
|
+
* @param {string} [arg.orderingCompanyId] -
|
|
212
|
+
* @param {string} [arg.stores] -
|
|
213
|
+
* @param {string} [arg.salesChannel] -
|
|
214
|
+
* @param {string} [arg.requestByExt] -
|
|
215
|
+
* @param {number} [arg.pageNo] -
|
|
216
|
+
* @param {number} [arg.pageSize] -
|
|
217
|
+
* @param {string} [arg.customerId] -
|
|
218
|
+
* @param {boolean} [arg.isPrioritySort] -
|
|
219
|
+
* @summary:
|
|
220
|
+
* @description:
|
|
146
221
|
*/
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
222
|
+
getBulkShipmentExcelFile({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
|
|
223
|
+
lane?: string;
|
|
224
|
+
searchType?: string;
|
|
225
|
+
searchId?: string;
|
|
150
226
|
fromDate?: string;
|
|
151
227
|
toDate?: string;
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
salesChannels?: string;
|
|
155
|
-
orderId?: string;
|
|
228
|
+
dpIds?: string;
|
|
229
|
+
orderingCompanyId?: string;
|
|
156
230
|
stores?: string;
|
|
231
|
+
salesChannel?: string;
|
|
232
|
+
requestByExt?: string;
|
|
233
|
+
pageNo?: number;
|
|
234
|
+
pageSize?: number;
|
|
235
|
+
customerId?: string;
|
|
236
|
+
isPrioritySort?: boolean;
|
|
237
|
+
}): Promise<any>;
|
|
238
|
+
/**
|
|
239
|
+
* @param {Object} arg - Arg object.
|
|
240
|
+
* @param {string} [arg.lane] -
|
|
241
|
+
* @param {string} [arg.searchType] -
|
|
242
|
+
* @param {string} [arg.searchId] -
|
|
243
|
+
* @param {string} [arg.fromDate] -
|
|
244
|
+
* @param {string} [arg.toDate] -
|
|
245
|
+
* @param {string} [arg.dpIds] -
|
|
246
|
+
* @param {string} [arg.orderingCompanyId] -
|
|
247
|
+
* @param {string} [arg.stores] -
|
|
248
|
+
* @param {string} [arg.salesChannel] -
|
|
249
|
+
* @param {string} [arg.requestByExt] -
|
|
250
|
+
* @param {number} [arg.pageNo] -
|
|
251
|
+
* @param {number} [arg.pageSize] -
|
|
252
|
+
* @param {string} [arg.customerId] -
|
|
253
|
+
* @param {boolean} [arg.isPrioritySort] -
|
|
254
|
+
* @summary:
|
|
255
|
+
* @description:
|
|
256
|
+
*/
|
|
257
|
+
getBulkList({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
|
|
258
|
+
lane?: string;
|
|
259
|
+
searchType?: string;
|
|
260
|
+
searchId?: string;
|
|
261
|
+
fromDate?: string;
|
|
262
|
+
toDate?: string;
|
|
263
|
+
dpIds?: string;
|
|
264
|
+
orderingCompanyId?: string;
|
|
265
|
+
stores?: string;
|
|
266
|
+
salesChannel?: string;
|
|
267
|
+
requestByExt?: string;
|
|
268
|
+
pageNo?: number;
|
|
269
|
+
pageSize?: number;
|
|
270
|
+
customerId?: string;
|
|
271
|
+
isPrioritySort?: boolean;
|
|
272
|
+
}): Promise<any>;
|
|
273
|
+
/**
|
|
274
|
+
* @param {Object} arg - Arg object.
|
|
275
|
+
* @param {string} [arg.status] -
|
|
276
|
+
* @param {number} [arg.storeId] -
|
|
277
|
+
* @param {number} [arg.pageNo] -
|
|
278
|
+
* @param {number} [arg.pageSize] -
|
|
279
|
+
* @param {string} [arg.searchValue] -
|
|
280
|
+
* @param {string} [arg.fromDate] -
|
|
281
|
+
* @param {string} [arg.toDate] -
|
|
282
|
+
* @summary:
|
|
283
|
+
* @description:
|
|
284
|
+
*/
|
|
285
|
+
getManifestList({ status, storeId, pageNo, pageSize, searchValue, fromDate, toDate, }?: {
|
|
157
286
|
status?: string;
|
|
158
|
-
|
|
287
|
+
storeId?: number;
|
|
288
|
+
pageNo?: number;
|
|
289
|
+
pageSize?: number;
|
|
290
|
+
searchValue?: string;
|
|
291
|
+
fromDate?: string;
|
|
292
|
+
toDate?: string;
|
|
293
|
+
}): Promise<any>;
|
|
294
|
+
/**
|
|
295
|
+
* @param {Object} arg - Arg object.
|
|
296
|
+
* @param {string} arg.manifestId -
|
|
297
|
+
* @param {string} [arg.fromDate] -
|
|
298
|
+
* @param {string} [arg.toDate] -
|
|
299
|
+
* @param {number} arg.storeId -
|
|
300
|
+
* @param {number} [arg.page] -
|
|
301
|
+
* @param {number} [arg.pageSize] -
|
|
302
|
+
* @param {string} [arg.lane] -
|
|
303
|
+
* @param {number} [arg.dpIds] -
|
|
304
|
+
* @param {string} [arg.searchType] -
|
|
305
|
+
* @param {string} [arg.searchValue] -
|
|
306
|
+
* @summary:
|
|
307
|
+
* @description:
|
|
308
|
+
*/
|
|
309
|
+
getManifestDetailsWithShipments({ manifestId, storeId, fromDate, toDate, page, pageSize, lane, dpIds, searchType, searchValue, }?: {
|
|
310
|
+
manifestId: string;
|
|
311
|
+
fromDate?: string;
|
|
312
|
+
toDate?: string;
|
|
313
|
+
storeId: number;
|
|
314
|
+
page?: number;
|
|
315
|
+
pageSize?: number;
|
|
316
|
+
lane?: string;
|
|
317
|
+
dpIds?: number;
|
|
318
|
+
searchType?: string;
|
|
319
|
+
searchValue?: string;
|
|
320
|
+
}): Promise<any>;
|
|
321
|
+
/**
|
|
322
|
+
* @param {Object} arg - Arg object.
|
|
323
|
+
* @param {string} arg.batchId -
|
|
324
|
+
* @param {string} [arg.reportType] -
|
|
325
|
+
* @summary:
|
|
326
|
+
* @description:
|
|
327
|
+
*/
|
|
328
|
+
getBulkActionFailedReport({ batchId, reportType }?: {
|
|
329
|
+
batchId: string;
|
|
330
|
+
reportType?: string;
|
|
159
331
|
}): Promise<any>;
|
|
160
332
|
/**
|
|
161
333
|
* @param {Object} arg - Arg object.
|
|
162
334
|
* @param {string} arg.shipmentId - ID of the shipment. An order may contain
|
|
163
335
|
* multiple items and may get divided into one or more shipment, each
|
|
164
336
|
* having its own ID.
|
|
165
|
-
* @param {string} arg.
|
|
166
|
-
* into
|
|
167
|
-
* @
|
|
168
|
-
* @
|
|
337
|
+
* @param {string} arg.bagId - ID of the bag. An order may contain multiple
|
|
338
|
+
* items and may get divided into one or more shipment, each having its own ID.
|
|
339
|
+
* @param {string} arg.state - State for which reasons are required.
|
|
340
|
+
* @summary: Get reasons behind full or partial cancellation of a shipment
|
|
341
|
+
* @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
|
|
169
342
|
*/
|
|
170
|
-
|
|
343
|
+
getShipmentReasons({ shipmentId, bagId, state }?: {
|
|
171
344
|
shipmentId: string;
|
|
172
|
-
|
|
345
|
+
bagId: string;
|
|
346
|
+
state: string;
|
|
173
347
|
}): Promise<any>;
|
|
174
348
|
/**
|
|
175
349
|
* @param {Object} arg - Arg object.
|
|
176
|
-
* @param {
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
350
|
+
* @param {BulkActionPayload} arg.body
|
|
351
|
+
* @summary: emits uuid to kafka topic.
|
|
352
|
+
* @description: Use this API to start processing Xlsx file.
|
|
353
|
+
*/
|
|
354
|
+
bulkActionProcessXlsxFile({ body }?: {
|
|
355
|
+
body: BulkActionPayload;
|
|
356
|
+
}): Promise<any>;
|
|
357
|
+
/**
|
|
358
|
+
* @param {Object} arg - Arg object.
|
|
359
|
+
* @param {string} arg.batchId -
|
|
360
|
+
* @summary: Returns failed, processing and successfully processed shipments.
|
|
361
|
+
* @description: Returns failed, processing and successfully processed shipments along with their counts and failed reasons.
|
|
362
|
+
*/
|
|
363
|
+
bulkActionDetails({ batchId }?: {
|
|
364
|
+
batchId: string;
|
|
365
|
+
}): Promise<any>;
|
|
366
|
+
/**
|
|
367
|
+
* @param {Object} arg - Arg object.
|
|
368
|
+
* @param {string} [arg.bagId] -
|
|
369
|
+
* @param {string} [arg.channelBagId] -
|
|
370
|
+
* @param {string} [arg.channelId] -
|
|
371
|
+
* @summary:
|
|
372
|
+
* @description:
|
|
373
|
+
*/
|
|
374
|
+
getBagById({ bagId, channelBagId, channelId }?: {
|
|
375
|
+
bagId?: string;
|
|
376
|
+
channelBagId?: string;
|
|
377
|
+
channelId?: string;
|
|
378
|
+
}): Promise<any>;
|
|
379
|
+
/**
|
|
380
|
+
* @param {Object} arg - Arg object.
|
|
381
|
+
* @param {string} [arg.bagIds] -
|
|
382
|
+
* @param {string} [arg.shipmentIds] -
|
|
383
|
+
* @param {string} [arg.orderIds] -
|
|
384
|
+
* @param {string} [arg.channelBagIds] -
|
|
385
|
+
* @param {string} [arg.channelShipmentIds] -
|
|
386
|
+
* @param {string} [arg.channelOrderIds] -
|
|
387
|
+
* @param {string} [arg.channelId] -
|
|
388
|
+
* @param {number} [arg.pageNo] -
|
|
389
|
+
* @param {number} [arg.pageSize] -
|
|
390
|
+
* @summary:
|
|
391
|
+
* @description:
|
|
392
|
+
*/
|
|
393
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, }?: {
|
|
394
|
+
bagIds?: string;
|
|
395
|
+
shipmentIds?: string;
|
|
396
|
+
orderIds?: string;
|
|
397
|
+
channelBagIds?: string;
|
|
398
|
+
channelShipmentIds?: string;
|
|
399
|
+
channelOrderIds?: string;
|
|
400
|
+
channelId?: string;
|
|
401
|
+
pageNo?: number;
|
|
402
|
+
pageSize?: number;
|
|
403
|
+
}): Promise<any>;
|
|
404
|
+
/**
|
|
405
|
+
* @param {Object} arg - Arg object.
|
|
406
|
+
* @param {InvalidateShipmentCachePayload} arg.body
|
|
407
|
+
* @summary:
|
|
408
|
+
* @description: Invalidate shipment Cache
|
|
409
|
+
*/
|
|
410
|
+
invalidateShipmentCache({ body }?: {
|
|
411
|
+
body: InvalidateShipmentCachePayload;
|
|
412
|
+
}): Promise<any>;
|
|
413
|
+
/**
|
|
414
|
+
* @param {Object} arg - Arg object.
|
|
415
|
+
* @param {StoreReassign} arg.body
|
|
416
|
+
* @summary:
|
|
417
|
+
* @description: Reassign Location
|
|
418
|
+
*/
|
|
419
|
+
reassignLocation({ body }?: {
|
|
420
|
+
body: StoreReassign;
|
|
421
|
+
}): Promise<any>;
|
|
422
|
+
/**
|
|
423
|
+
* @param {Object} arg - Arg object.
|
|
424
|
+
* @param {UpdateShipmentLockPayload} arg.body
|
|
425
|
+
* @summary:
|
|
426
|
+
* @description: update shipment lock
|
|
184
427
|
*/
|
|
185
|
-
|
|
428
|
+
updateShipmentLock({ body }?: {
|
|
429
|
+
body: UpdateShipmentLockPayload;
|
|
430
|
+
}): Promise<any>;
|
|
431
|
+
/**
|
|
432
|
+
* @param {Object} arg - Arg object.
|
|
433
|
+
* @param {string} [arg.date] -
|
|
434
|
+
* @summary:
|
|
435
|
+
* @description:
|
|
436
|
+
*/
|
|
437
|
+
getAnnouncements({ date }?: {
|
|
438
|
+
date?: string;
|
|
439
|
+
}): Promise<any>;
|
|
440
|
+
/**
|
|
441
|
+
* @param {Object} arg - Arg object.
|
|
442
|
+
* @param {string} arg.shipmentId -
|
|
443
|
+
* @param {string} [arg.name] -
|
|
444
|
+
* @param {string} [arg.address] -
|
|
445
|
+
* @param {string} [arg.addressType] -
|
|
446
|
+
* @param {string} [arg.pincode] -
|
|
447
|
+
* @param {string} [arg.phone] -
|
|
448
|
+
* @param {string} [arg.email] -
|
|
449
|
+
* @param {string} [arg.landmark] -
|
|
450
|
+
* @param {string} arg.addressCategory -
|
|
451
|
+
* @param {string} [arg.city] -
|
|
452
|
+
* @param {string} [arg.state] -
|
|
453
|
+
* @param {string} [arg.country] -
|
|
454
|
+
* @summary:
|
|
455
|
+
* @description:
|
|
456
|
+
*/
|
|
457
|
+
updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, }?: {
|
|
186
458
|
shipmentId: string;
|
|
459
|
+
name?: string;
|
|
460
|
+
address?: string;
|
|
461
|
+
addressType?: string;
|
|
462
|
+
pincode?: string;
|
|
463
|
+
phone?: string;
|
|
464
|
+
email?: string;
|
|
465
|
+
landmark?: string;
|
|
187
466
|
addressCategory: string;
|
|
188
|
-
|
|
467
|
+
city?: string;
|
|
468
|
+
state?: string;
|
|
469
|
+
country?: string;
|
|
189
470
|
}): Promise<any>;
|
|
471
|
+
/**
|
|
472
|
+
* @param {Object} arg - Arg object.
|
|
473
|
+
* @param {string} arg.caller -
|
|
474
|
+
* @param {string} arg.receiver -
|
|
475
|
+
* @param {string} arg.bagId -
|
|
476
|
+
* @param {string} [arg.callingTo] -
|
|
477
|
+
* @param {string} [arg.callerId] -
|
|
478
|
+
* @summary:
|
|
479
|
+
* @description:
|
|
480
|
+
*/
|
|
481
|
+
click2Call({ caller, receiver, bagId, callingTo, callerId }?: {
|
|
482
|
+
caller: string;
|
|
483
|
+
receiver: string;
|
|
484
|
+
bagId: string;
|
|
485
|
+
callingTo?: string;
|
|
486
|
+
callerId?: string;
|
|
487
|
+
}): Promise<any>;
|
|
488
|
+
/**
|
|
489
|
+
* @param {Object} arg - Arg object.
|
|
490
|
+
* @param {UpdateShipmentStatusRequest} arg.body
|
|
491
|
+
* @summary:
|
|
492
|
+
* @description: Update shipment status
|
|
493
|
+
*/
|
|
494
|
+
updateShipmentStatus({ body }?: {
|
|
495
|
+
body: UpdateShipmentStatusRequest;
|
|
496
|
+
}): Promise<any>;
|
|
497
|
+
/**
|
|
498
|
+
* @param {Object} arg - Arg object.
|
|
499
|
+
* @param {CreateOrderPayload} arg.body
|
|
500
|
+
* @summary:
|
|
501
|
+
* @description:
|
|
502
|
+
*/
|
|
503
|
+
processManifest({ body }?: {
|
|
504
|
+
body: CreateOrderPayload;
|
|
505
|
+
}): Promise<any>;
|
|
506
|
+
/**
|
|
507
|
+
* @param {Object} arg - Arg object.
|
|
508
|
+
* @param {DispatchManifest} arg.body
|
|
509
|
+
* @summary:
|
|
510
|
+
* @description:
|
|
511
|
+
*/
|
|
512
|
+
dispatchManifest({ body }?: {
|
|
513
|
+
body: DispatchManifest;
|
|
514
|
+
}): Promise<any>;
|
|
515
|
+
/**
|
|
516
|
+
* @param {Object} arg - Arg object.
|
|
517
|
+
* @summary:
|
|
518
|
+
* @description:
|
|
519
|
+
*/
|
|
520
|
+
getRoleBasedActions({}?: any): Promise<any>;
|
|
521
|
+
/**
|
|
522
|
+
* @param {Object} arg - Arg object.
|
|
523
|
+
* @param {number} [arg.shipmentId] -
|
|
524
|
+
* @param {number} [arg.bagId] -
|
|
525
|
+
* @summary:
|
|
526
|
+
* @description:
|
|
527
|
+
*/
|
|
528
|
+
getShipmentHistory({ shipmentId, bagId }?: {
|
|
529
|
+
shipmentId?: number;
|
|
530
|
+
bagId?: number;
|
|
531
|
+
}): Promise<any>;
|
|
532
|
+
/**
|
|
533
|
+
* @param {Object} arg - Arg object.
|
|
534
|
+
* @param {SendSmsPayload} arg.body
|
|
535
|
+
* @summary:
|
|
536
|
+
* @description:
|
|
537
|
+
*/
|
|
538
|
+
sendSmsNinja({ body }?: {
|
|
539
|
+
body: SendSmsPayload;
|
|
540
|
+
}): Promise<any>;
|
|
541
|
+
/**
|
|
542
|
+
* @param {Object} arg - Arg object.
|
|
543
|
+
* @param {ManualAssignDPToShipment} arg.body
|
|
544
|
+
* @summary:
|
|
545
|
+
* @description:
|
|
546
|
+
*/
|
|
547
|
+
platformManualAssignDPToShipment({ body }?: {
|
|
548
|
+
body: ManualAssignDPToShipment;
|
|
549
|
+
}): Promise<any>;
|
|
550
|
+
/**
|
|
551
|
+
* @param {Object} arg - Arg object.
|
|
552
|
+
* @param {CreateOrderPayload} arg.body
|
|
553
|
+
* @summary:
|
|
554
|
+
* @description:
|
|
555
|
+
*/
|
|
556
|
+
updatePackagingDimensions({ body }?: {
|
|
557
|
+
body: CreateOrderPayload;
|
|
558
|
+
}): Promise<any>;
|
|
559
|
+
/**
|
|
560
|
+
* @param {Object} arg - Arg object.
|
|
561
|
+
* @param {CreateOrderAPI} arg.body
|
|
562
|
+
* @summary:
|
|
563
|
+
* @description:
|
|
564
|
+
*/
|
|
565
|
+
createOrder({ body }?: {
|
|
566
|
+
body: CreateOrderAPI;
|
|
567
|
+
}): Promise<any>;
|
|
568
|
+
/**
|
|
569
|
+
* @param {Object} arg - Arg object.
|
|
570
|
+
* @param {CreateChannelConfigData} arg.body
|
|
571
|
+
* @summary:
|
|
572
|
+
* @description: createChannelConfig
|
|
573
|
+
*/
|
|
574
|
+
createChannelConfig({ body }?: {
|
|
575
|
+
body: CreateChannelConfigData;
|
|
576
|
+
}): Promise<any>;
|
|
577
|
+
/**
|
|
578
|
+
* @param {Object} arg - Arg object.
|
|
579
|
+
* @summary:
|
|
580
|
+
* @description: getChannelConfig
|
|
581
|
+
*/
|
|
582
|
+
getChannelConfig({}?: any): Promise<any>;
|
|
583
|
+
/**
|
|
584
|
+
* @param {Object} arg - Arg object.
|
|
585
|
+
* @param {UploadConsent} arg.body
|
|
586
|
+
* @summary:
|
|
587
|
+
* @description:
|
|
588
|
+
*/
|
|
589
|
+
uploadConsent({ body }?: {
|
|
590
|
+
body: UploadConsent;
|
|
591
|
+
}): Promise<any>;
|
|
592
|
+
/**
|
|
593
|
+
* @param {Object} arg - Arg object.
|
|
594
|
+
* @param {PlatformOrderUpdate} arg.body
|
|
595
|
+
* @summary:
|
|
596
|
+
* @description:
|
|
597
|
+
*/
|
|
598
|
+
orderUpdate({ body }?: {
|
|
599
|
+
body: PlatformOrderUpdate;
|
|
600
|
+
}): Promise<any>;
|
|
601
|
+
/**
|
|
602
|
+
* @param {Object} arg - Arg object.
|
|
603
|
+
* @param {OrderStatus} arg.body
|
|
604
|
+
* @summary:
|
|
605
|
+
* @description:
|
|
606
|
+
*/
|
|
607
|
+
checkOrderStatus({ body }?: {
|
|
608
|
+
body: OrderStatus;
|
|
609
|
+
}): Promise<any>;
|
|
610
|
+
/**
|
|
611
|
+
* @param {Object} arg - Arg object.
|
|
612
|
+
* @summary:
|
|
613
|
+
* @description:
|
|
614
|
+
*/
|
|
615
|
+
sendSmsNinjaPlatform({}?: any): Promise<any>;
|
|
190
616
|
}
|