@commercengine/pos 0.3.5 → 0.3.7
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/dist/admin-types.d.ts +1981 -0
- package/dist/admin-types.js +1 -0
- package/dist/index.d.ts +171 -25
- package/dist/index.js +57 -35
- package/dist/index.js.map +1 -1
- package/package.json +4 -1
|
@@ -0,0 +1,1981 @@
|
|
|
1
|
+
//#region src/types/admin-pos.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by openapi-typescript.
|
|
4
|
+
* Do not make direct changes to the file.
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
interface paths {
|
|
8
|
+
"/pos/catalog/inventories": {
|
|
9
|
+
parameters: {
|
|
10
|
+
query?: never;
|
|
11
|
+
header?: never;
|
|
12
|
+
path?: never;
|
|
13
|
+
cookie?: never;
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* List all inventories
|
|
17
|
+
* @description List all inventories
|
|
18
|
+
*/
|
|
19
|
+
get: operations["pos-list-inventory"];
|
|
20
|
+
put?: never;
|
|
21
|
+
post?: never;
|
|
22
|
+
delete?: never;
|
|
23
|
+
options?: never;
|
|
24
|
+
head?: never;
|
|
25
|
+
patch?: never;
|
|
26
|
+
trace?: never;
|
|
27
|
+
};
|
|
28
|
+
"/pos/catalog/inventories/activites": {
|
|
29
|
+
parameters: {
|
|
30
|
+
query?: never;
|
|
31
|
+
header?: never;
|
|
32
|
+
path?: never;
|
|
33
|
+
cookie?: never;
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* List all inventories activities
|
|
37
|
+
* @description Lists all inventory related activities of stock movements. This provides a comprehensive audit trail of inventory operations such as receiving, reservations, adjustments, transfers, and sales.
|
|
38
|
+
*/
|
|
39
|
+
get: operations["pos-list-inventory-activity"];
|
|
40
|
+
put?: never;
|
|
41
|
+
post?: never;
|
|
42
|
+
delete?: never;
|
|
43
|
+
options?: never;
|
|
44
|
+
head?: never;
|
|
45
|
+
patch?: never;
|
|
46
|
+
trace?: never;
|
|
47
|
+
};
|
|
48
|
+
"/pos/catalog/inventories/detail": {
|
|
49
|
+
parameters: {
|
|
50
|
+
query?: never;
|
|
51
|
+
header?: never;
|
|
52
|
+
path?: never;
|
|
53
|
+
cookie?: never;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* Retrieve inventory detail
|
|
57
|
+
* @description Retrieves inventory details for a specific product, product variant, or lot/batch based on the parameters provided.
|
|
58
|
+
*/
|
|
59
|
+
get: operations["pos-list-inventory-detail"];
|
|
60
|
+
put?: never;
|
|
61
|
+
post?: never;
|
|
62
|
+
delete?: never;
|
|
63
|
+
options?: never;
|
|
64
|
+
head?: never;
|
|
65
|
+
patch?: never;
|
|
66
|
+
trace?: never;
|
|
67
|
+
};
|
|
68
|
+
"/pos/customers": {
|
|
69
|
+
parameters: {
|
|
70
|
+
query?: never;
|
|
71
|
+
header?: never;
|
|
72
|
+
path?: never;
|
|
73
|
+
cookie?: never;
|
|
74
|
+
};
|
|
75
|
+
/**
|
|
76
|
+
* List all customers
|
|
77
|
+
* @description List all customers
|
|
78
|
+
*/
|
|
79
|
+
get: operations["pos-list-customers"];
|
|
80
|
+
put?: never;
|
|
81
|
+
post?: never;
|
|
82
|
+
delete?: never;
|
|
83
|
+
options?: never;
|
|
84
|
+
head?: never;
|
|
85
|
+
patch?: never;
|
|
86
|
+
trace?: never;
|
|
87
|
+
};
|
|
88
|
+
"/pos/customers/{id}": {
|
|
89
|
+
parameters: {
|
|
90
|
+
query?: never;
|
|
91
|
+
header?: never;
|
|
92
|
+
path?: never;
|
|
93
|
+
cookie?: never;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* Retrieve customer detail
|
|
97
|
+
* @description Retrieve customer detail
|
|
98
|
+
*/
|
|
99
|
+
get: operations["pos-get-customer-detail"];
|
|
100
|
+
put?: never;
|
|
101
|
+
post?: never;
|
|
102
|
+
delete?: never;
|
|
103
|
+
options?: never;
|
|
104
|
+
head?: never;
|
|
105
|
+
patch?: never;
|
|
106
|
+
trace?: never;
|
|
107
|
+
};
|
|
108
|
+
"/pos/orders": {
|
|
109
|
+
parameters: {
|
|
110
|
+
query?: never;
|
|
111
|
+
header?: never;
|
|
112
|
+
path?: never;
|
|
113
|
+
cookie?: never;
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* List all orders
|
|
117
|
+
* @description List all orders
|
|
118
|
+
*/
|
|
119
|
+
get: operations["pos-list-orders"];
|
|
120
|
+
put?: never;
|
|
121
|
+
post?: never;
|
|
122
|
+
delete?: never;
|
|
123
|
+
options?: never;
|
|
124
|
+
head?: never;
|
|
125
|
+
patch?: never;
|
|
126
|
+
trace?: never;
|
|
127
|
+
};
|
|
128
|
+
"/pos/orders/{order_number}": {
|
|
129
|
+
parameters: {
|
|
130
|
+
query?: never;
|
|
131
|
+
header?: never;
|
|
132
|
+
path?: never;
|
|
133
|
+
cookie?: never;
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* Retrieve order details
|
|
137
|
+
* @description Retrieve order details
|
|
138
|
+
*/
|
|
139
|
+
get: operations["pos-get-order-detail"];
|
|
140
|
+
put?: never;
|
|
141
|
+
post?: never;
|
|
142
|
+
delete?: never;
|
|
143
|
+
options?: never;
|
|
144
|
+
head?: never;
|
|
145
|
+
patch?: never;
|
|
146
|
+
trace?: never;
|
|
147
|
+
};
|
|
148
|
+
"/pos/orders/{order_number}/activity": {
|
|
149
|
+
parameters: {
|
|
150
|
+
query?: never;
|
|
151
|
+
header?: never;
|
|
152
|
+
path?: never;
|
|
153
|
+
cookie?: never;
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* List all order activity
|
|
157
|
+
* @description List all order activity
|
|
158
|
+
*/
|
|
159
|
+
get: operations["pos-list-order-activity"];
|
|
160
|
+
put?: never;
|
|
161
|
+
post?: never;
|
|
162
|
+
delete?: never;
|
|
163
|
+
options?: never;
|
|
164
|
+
head?: never;
|
|
165
|
+
patch?: never;
|
|
166
|
+
trace?: never;
|
|
167
|
+
};
|
|
168
|
+
"/pos/orders/{order_number}/invoice": {
|
|
169
|
+
parameters: {
|
|
170
|
+
query?: never;
|
|
171
|
+
header?: never;
|
|
172
|
+
path?: never;
|
|
173
|
+
cookie?: never;
|
|
174
|
+
};
|
|
175
|
+
/**
|
|
176
|
+
* Retrieve order invoice
|
|
177
|
+
* @description Retrieve order invoice
|
|
178
|
+
*/
|
|
179
|
+
get: operations["pos-get-order-invoice"];
|
|
180
|
+
put?: never;
|
|
181
|
+
post?: never;
|
|
182
|
+
delete?: never;
|
|
183
|
+
options?: never;
|
|
184
|
+
head?: never;
|
|
185
|
+
patch?: never;
|
|
186
|
+
trace?: never;
|
|
187
|
+
};
|
|
188
|
+
"/pos/orders/{order_number}/receipt": {
|
|
189
|
+
parameters: {
|
|
190
|
+
query?: never;
|
|
191
|
+
header?: never;
|
|
192
|
+
path?: never;
|
|
193
|
+
cookie?: never;
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* Retrieve order receipt
|
|
197
|
+
* @description Retrieves a printable receipt for a specific order using the order number. This endpoint returns either structured JSON data or a formatted PDF, suitable for customer presentation. Response format (JSON or PDF) is determined by an optional query parameter (e.g. format=pdf or format=json).
|
|
198
|
+
*/
|
|
199
|
+
get: operations["pos-get-order-receipt"];
|
|
200
|
+
put?: never;
|
|
201
|
+
post?: never;
|
|
202
|
+
delete?: never;
|
|
203
|
+
options?: never;
|
|
204
|
+
head?: never;
|
|
205
|
+
patch?: never;
|
|
206
|
+
trace?: never;
|
|
207
|
+
};
|
|
208
|
+
"/pos/orders/{order_number}/shipments": {
|
|
209
|
+
parameters: {
|
|
210
|
+
query?: never;
|
|
211
|
+
header?: never;
|
|
212
|
+
path?: never;
|
|
213
|
+
cookie?: never;
|
|
214
|
+
};
|
|
215
|
+
/**
|
|
216
|
+
* Retrieve order shipments
|
|
217
|
+
* @description Retrieve order shipments
|
|
218
|
+
*/
|
|
219
|
+
get: operations["pos-list-order-shipments"];
|
|
220
|
+
put?: never;
|
|
221
|
+
post?: never;
|
|
222
|
+
delete?: never;
|
|
223
|
+
options?: never;
|
|
224
|
+
head?: never;
|
|
225
|
+
patch?: never;
|
|
226
|
+
trace?: never;
|
|
227
|
+
};
|
|
228
|
+
"/pos/shipping/shipments": {
|
|
229
|
+
parameters: {
|
|
230
|
+
query?: never;
|
|
231
|
+
header?: never;
|
|
232
|
+
path?: never;
|
|
233
|
+
cookie?: never;
|
|
234
|
+
};
|
|
235
|
+
/**
|
|
236
|
+
* List all shipments
|
|
237
|
+
* @description List all shipments
|
|
238
|
+
*/
|
|
239
|
+
get: operations["pos-list-shipments"];
|
|
240
|
+
put?: never;
|
|
241
|
+
post?: never;
|
|
242
|
+
delete?: never;
|
|
243
|
+
options?: never;
|
|
244
|
+
head?: never;
|
|
245
|
+
patch?: never;
|
|
246
|
+
trace?: never;
|
|
247
|
+
};
|
|
248
|
+
"/pos/shipping/shipments/{order_number}/check-inventory": {
|
|
249
|
+
parameters: {
|
|
250
|
+
query?: never;
|
|
251
|
+
header?: never;
|
|
252
|
+
path?: never;
|
|
253
|
+
cookie?: never;
|
|
254
|
+
};
|
|
255
|
+
/**
|
|
256
|
+
* Check Inventory
|
|
257
|
+
* @description Check Inventory
|
|
258
|
+
*/
|
|
259
|
+
get: operations["pos-check-order-inventory"];
|
|
260
|
+
put?: never;
|
|
261
|
+
post?: never;
|
|
262
|
+
delete?: never;
|
|
263
|
+
options?: never;
|
|
264
|
+
head?: never;
|
|
265
|
+
patch?: never;
|
|
266
|
+
trace?: never;
|
|
267
|
+
};
|
|
268
|
+
"/pos/shipping/shipments/{order_number}/refund-shortfall": {
|
|
269
|
+
parameters: {
|
|
270
|
+
query?: never;
|
|
271
|
+
header?: never;
|
|
272
|
+
path?: never;
|
|
273
|
+
cookie?: never;
|
|
274
|
+
};
|
|
275
|
+
get?: never;
|
|
276
|
+
put?: never;
|
|
277
|
+
/**
|
|
278
|
+
* Refund shortfall
|
|
279
|
+
* @description Refund shortfall
|
|
280
|
+
*/
|
|
281
|
+
post: operations["pos-refund-shortfall"];
|
|
282
|
+
delete?: never;
|
|
283
|
+
options?: never;
|
|
284
|
+
head?: never;
|
|
285
|
+
patch?: never;
|
|
286
|
+
trace?: never;
|
|
287
|
+
};
|
|
288
|
+
"/pos/shipping/shipments/{reference_number}": {
|
|
289
|
+
parameters: {
|
|
290
|
+
query?: never;
|
|
291
|
+
header?: never;
|
|
292
|
+
path?: never;
|
|
293
|
+
cookie?: never;
|
|
294
|
+
};
|
|
295
|
+
/**
|
|
296
|
+
* Retrieve shipment detail
|
|
297
|
+
* @description Retrieve shipment detail
|
|
298
|
+
*/
|
|
299
|
+
get: operations["pos-get-shipment-detail"];
|
|
300
|
+
put?: never;
|
|
301
|
+
post?: never;
|
|
302
|
+
delete?: never;
|
|
303
|
+
options?: never;
|
|
304
|
+
head?: never;
|
|
305
|
+
patch?: never;
|
|
306
|
+
trace?: never;
|
|
307
|
+
};
|
|
308
|
+
"/pos/shipping/shipments/{reference_number}/invoice": {
|
|
309
|
+
parameters: {
|
|
310
|
+
query?: never;
|
|
311
|
+
header?: never;
|
|
312
|
+
path?: never;
|
|
313
|
+
cookie?: never;
|
|
314
|
+
};
|
|
315
|
+
/**
|
|
316
|
+
* Retrieve shipment invoice
|
|
317
|
+
* @description Retrieve shipment invoice
|
|
318
|
+
*/
|
|
319
|
+
get: operations["pos-get-shipment-invoice"];
|
|
320
|
+
put?: never;
|
|
321
|
+
post?: never;
|
|
322
|
+
delete?: never;
|
|
323
|
+
options?: never;
|
|
324
|
+
head?: never;
|
|
325
|
+
patch?: never;
|
|
326
|
+
trace?: never;
|
|
327
|
+
};
|
|
328
|
+
"/pos/shipping/shipments/{reference_number}/manual-update": {
|
|
329
|
+
parameters: {
|
|
330
|
+
query?: never;
|
|
331
|
+
header?: never;
|
|
332
|
+
path?: never;
|
|
333
|
+
cookie?: never;
|
|
334
|
+
};
|
|
335
|
+
get?: never;
|
|
336
|
+
/**
|
|
337
|
+
* Update shipment detail
|
|
338
|
+
* @description Update shipment detail
|
|
339
|
+
*/
|
|
340
|
+
put: operations["pos-update-shipment"];
|
|
341
|
+
post?: never;
|
|
342
|
+
delete?: never;
|
|
343
|
+
options?: never;
|
|
344
|
+
head?: never;
|
|
345
|
+
patch?: never;
|
|
346
|
+
trace?: never;
|
|
347
|
+
};
|
|
348
|
+
}
|
|
349
|
+
interface components {
|
|
350
|
+
schemas: {
|
|
351
|
+
/**
|
|
352
|
+
* AppliedPromotion
|
|
353
|
+
* @description Details about an active coupon applied to a cart/order
|
|
354
|
+
*/
|
|
355
|
+
AppliedCoupon: {
|
|
356
|
+
coupon_id: string;
|
|
357
|
+
/** @enum {unknown} */
|
|
358
|
+
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
359
|
+
savings: number;
|
|
360
|
+
product_id: string | null;
|
|
361
|
+
variant_id: string | null;
|
|
362
|
+
product_name: string | null;
|
|
363
|
+
variant_name: string | null;
|
|
364
|
+
};
|
|
365
|
+
/**
|
|
366
|
+
* AppliedPromotion
|
|
367
|
+
* @description Details about an active promotion applied to a cart/order
|
|
368
|
+
*/
|
|
369
|
+
AppliedPromotion: {
|
|
370
|
+
promotion_id: string;
|
|
371
|
+
/** @enum {unknown} */
|
|
372
|
+
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
373
|
+
savings: number;
|
|
374
|
+
product_id: string | null;
|
|
375
|
+
variant_id: string | null;
|
|
376
|
+
product_name: string | null;
|
|
377
|
+
variant_name: string | null;
|
|
378
|
+
applied_sequence: number;
|
|
379
|
+
scope: string;
|
|
380
|
+
};
|
|
381
|
+
/**
|
|
382
|
+
* BankTransfer
|
|
383
|
+
* @description Bank transfer payment - IMPS, NEFT, RTGS
|
|
384
|
+
*/
|
|
385
|
+
BankTransfer: components["schemas"]["OrderPaymentInfo"] & {
|
|
386
|
+
/** @description masked account number
|
|
387
|
+
* e.g. ************1234 */
|
|
388
|
+
bank_account_number?: string;
|
|
389
|
+
bank_name?: string;
|
|
390
|
+
};
|
|
391
|
+
/** BusinessInfo */
|
|
392
|
+
BusinessInfo: {
|
|
393
|
+
name?: string;
|
|
394
|
+
business_type?: string;
|
|
395
|
+
pan_number?: string;
|
|
396
|
+
gstin?: string;
|
|
397
|
+
is_registered_under_gst?: boolean;
|
|
398
|
+
};
|
|
399
|
+
/**
|
|
400
|
+
* CardPayment
|
|
401
|
+
* @description Payments using credit card, debit card
|
|
402
|
+
*/
|
|
403
|
+
CardPayment: components["schemas"]["OrderPaymentInfo"] & {
|
|
404
|
+
/** @description masked card number
|
|
405
|
+
* e.g. ************1111 */
|
|
406
|
+
card_number?: string;
|
|
407
|
+
/** @enum {unknown} */
|
|
408
|
+
card_type?: "Visa" | "Master Card" | "Rupay";
|
|
409
|
+
};
|
|
410
|
+
/** Customer */
|
|
411
|
+
Customer: components["schemas"]["CustomerInfo"] & {
|
|
412
|
+
business?: components["schemas"]["BusinessInfo"];
|
|
413
|
+
segments?: components["schemas"]["CustomerSegment"][];
|
|
414
|
+
};
|
|
415
|
+
/** CustomerAddress */
|
|
416
|
+
CustomerAddress: {
|
|
417
|
+
readonly id?: string;
|
|
418
|
+
first_name: string;
|
|
419
|
+
last_name?: string;
|
|
420
|
+
/** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
|
|
421
|
+
* */
|
|
422
|
+
country_code?: string;
|
|
423
|
+
/** @description 10 digit phone number without country code. */
|
|
424
|
+
phone: string;
|
|
425
|
+
email: string;
|
|
426
|
+
address_line1: string;
|
|
427
|
+
address_line2?: string | null;
|
|
428
|
+
landmark?: string | null;
|
|
429
|
+
pincode: string;
|
|
430
|
+
city: string;
|
|
431
|
+
state: string;
|
|
432
|
+
/** @enum {unknown} */
|
|
433
|
+
country: "India";
|
|
434
|
+
/** @description Use in shipping details only for third party. */
|
|
435
|
+
gstin?: string | null;
|
|
436
|
+
/** @description Use in shipping details only for third party. */
|
|
437
|
+
business_name?: string | null;
|
|
438
|
+
readonly is_phone_verified?: boolean;
|
|
439
|
+
readonly is_email_verified?: boolean;
|
|
440
|
+
};
|
|
441
|
+
/** CustomerDetail */
|
|
442
|
+
CustomerDetail: components["schemas"]["Customer"] & {
|
|
443
|
+
loyalty?: components["schemas"]["CustomerLoyalty"];
|
|
444
|
+
notification_preferences?: components["schemas"]["NotificationPreferences"];
|
|
445
|
+
};
|
|
446
|
+
/** CustomerInfo */
|
|
447
|
+
CustomerInfo: {
|
|
448
|
+
/** @description user id */
|
|
449
|
+
readonly id?: string;
|
|
450
|
+
first_name?: string;
|
|
451
|
+
last_name?: string;
|
|
452
|
+
readonly full_name?: string;
|
|
453
|
+
readonly profile_image_url?: string;
|
|
454
|
+
country_code?: string;
|
|
455
|
+
phone?: string;
|
|
456
|
+
email?: string;
|
|
457
|
+
readonly is_phone_verified?: boolean;
|
|
458
|
+
readonly is_email_verified?: boolean;
|
|
459
|
+
readonly is_whatsapp_verified?: boolean;
|
|
460
|
+
/** @enum {unknown} */
|
|
461
|
+
status?: "active" | "inactive" | "suspended" | "blocked";
|
|
462
|
+
/** Format: date-time */
|
|
463
|
+
readonly created_at?: string;
|
|
464
|
+
/** Format: date-time */
|
|
465
|
+
readonly modified_at?: string;
|
|
466
|
+
/** Format: date-time */
|
|
467
|
+
readonly last_seen?: string;
|
|
468
|
+
readonly kyc_status?: boolean;
|
|
469
|
+
readonly is_verified?: boolean;
|
|
470
|
+
tags?: string[];
|
|
471
|
+
};
|
|
472
|
+
/** CustomerLoyalty */
|
|
473
|
+
CustomerLoyalty: {
|
|
474
|
+
membership_number?: string;
|
|
475
|
+
/** @description total points earned within the current loyalty program. */
|
|
476
|
+
points_earned?: number;
|
|
477
|
+
/** @description total points redeemed within the current loyalty program. */
|
|
478
|
+
points_redeemed?: number;
|
|
479
|
+
/** @description total points available. */
|
|
480
|
+
points_balance?: number;
|
|
481
|
+
/** @description The total amount a customer has spent within the current loyalty program, excluding taxes, promotional discounts, and redeemed loyalty points. This value is used to determine tier eligibility and earning points calculation. */
|
|
482
|
+
total_spent?: number;
|
|
483
|
+
/** @description The total number of completed orders counted in the current loyalty program. */
|
|
484
|
+
total_orders?: number;
|
|
485
|
+
/** @description The total amount a customer has spent across all time, regardless of loyalty program participation. This includes all completed orders and excludes taxes, promotional discounts, and redeemed points. */
|
|
486
|
+
lifetime_spent?: number;
|
|
487
|
+
/** @description The total number of completed orders across all time, regardless of loyalty program. */
|
|
488
|
+
lifetime_orders?: number;
|
|
489
|
+
/**
|
|
490
|
+
* Format: date-time
|
|
491
|
+
* @description The date and time when the customer first enrolled in the loyalty program.
|
|
492
|
+
*/
|
|
493
|
+
date_of_join?: string;
|
|
494
|
+
/**
|
|
495
|
+
* Format: date-time
|
|
496
|
+
* @description The date and time when the customer's current loyalty tier or program instance was assigned. This may change when tiers are upgraded, downgraded, or reassigned.
|
|
497
|
+
*/
|
|
498
|
+
date_of_assign?: string | null;
|
|
499
|
+
/**
|
|
500
|
+
* Format: date-time
|
|
501
|
+
* @description The date and time when the customer’s current loyalty program cycle will reset, at which points earned, points redeemed, balance points, total spent, total orders will be cleared.
|
|
502
|
+
*/
|
|
503
|
+
date_of_reset?: string | null;
|
|
504
|
+
current_tier?: {
|
|
505
|
+
id?: string;
|
|
506
|
+
name?: string;
|
|
507
|
+
};
|
|
508
|
+
next_tier?: {
|
|
509
|
+
id?: string;
|
|
510
|
+
name?: string;
|
|
511
|
+
total_spent_threshold?: number | null;
|
|
512
|
+
total_orders_threshold?: number | null;
|
|
513
|
+
};
|
|
514
|
+
};
|
|
515
|
+
/** CustomerSegment */
|
|
516
|
+
CustomerSegment: {
|
|
517
|
+
id?: string;
|
|
518
|
+
name?: string;
|
|
519
|
+
};
|
|
520
|
+
/** InventoryActivity */
|
|
521
|
+
InventoryActivity: {
|
|
522
|
+
product_id?: string;
|
|
523
|
+
product_name?: string;
|
|
524
|
+
variant_id?: string;
|
|
525
|
+
variant_name?: string;
|
|
526
|
+
sku?: string;
|
|
527
|
+
warehouse_id?: string;
|
|
528
|
+
warehouse?: components["schemas"]["WarehouseBasicDetail"];
|
|
529
|
+
/** @enum {unknown} */
|
|
530
|
+
activity_type?: "add" | "reserve" | "reduce" | "adjust" | "update";
|
|
531
|
+
quantity?: number;
|
|
532
|
+
reason?: string;
|
|
533
|
+
lot_batch?: string;
|
|
534
|
+
/** Format: date */
|
|
535
|
+
mfg_date?: string;
|
|
536
|
+
/** Format: date */
|
|
537
|
+
exp_date?: string;
|
|
538
|
+
manufacturer?: string;
|
|
539
|
+
/** Format: date-time */
|
|
540
|
+
created_at?: string;
|
|
541
|
+
/** Format: date-time */
|
|
542
|
+
modified_at?: string;
|
|
543
|
+
};
|
|
544
|
+
/** InventoryDetail */
|
|
545
|
+
InventoryDetail: components["schemas"]["ItemWiseInventory"] & {
|
|
546
|
+
details?: components["schemas"]["WarehouseWiseInventory"][];
|
|
547
|
+
};
|
|
548
|
+
/**
|
|
549
|
+
* Invoice
|
|
550
|
+
* @description Invoice model
|
|
551
|
+
*/
|
|
552
|
+
Invoice: {
|
|
553
|
+
invoice_number?: string;
|
|
554
|
+
/** Format: date-time */
|
|
555
|
+
invoice_date?: string;
|
|
556
|
+
/** @description Invoice Reference Number */
|
|
557
|
+
irn_number?: string;
|
|
558
|
+
/** @description Acknowledgement Number */
|
|
559
|
+
ack_number?: string;
|
|
560
|
+
/**
|
|
561
|
+
* Format: date-time
|
|
562
|
+
* @description Acknowledgement Date
|
|
563
|
+
*/
|
|
564
|
+
ack_date?: string;
|
|
565
|
+
signed_qr_code?: string;
|
|
566
|
+
gatepass_barcode?: string;
|
|
567
|
+
seller_details?: components["schemas"]["Warehouse"];
|
|
568
|
+
billing_address?: components["schemas"]["CustomerAddress"];
|
|
569
|
+
shipping_address?: components["schemas"]["CustomerAddress"];
|
|
570
|
+
subtotal?: number;
|
|
571
|
+
shipping_amount?: number;
|
|
572
|
+
coupon_code?: string;
|
|
573
|
+
coupon_discount_percent?: number;
|
|
574
|
+
coupon_discount_amount?: number;
|
|
575
|
+
total_tax?: number;
|
|
576
|
+
grand_total?: number;
|
|
577
|
+
tax_summary?: {
|
|
578
|
+
tax_rate?: number;
|
|
579
|
+
taxable_value?: number;
|
|
580
|
+
igst?: number;
|
|
581
|
+
cgst?: number;
|
|
582
|
+
sgst?: number;
|
|
583
|
+
}[];
|
|
584
|
+
/** Format: date-time */
|
|
585
|
+
created_at?: string;
|
|
586
|
+
/** Format: date-time */
|
|
587
|
+
modified_at?: string;
|
|
588
|
+
};
|
|
589
|
+
/**
|
|
590
|
+
* InvoiceDetail
|
|
591
|
+
* @description InvoiceDetail model
|
|
592
|
+
*/
|
|
593
|
+
InvoiceDetail: components["schemas"]["Invoice"] & {
|
|
594
|
+
items?: components["schemas"]["InvoiceItem"][];
|
|
595
|
+
};
|
|
596
|
+
/**
|
|
597
|
+
* InvoiceItem
|
|
598
|
+
* @description InvoiceItem model
|
|
599
|
+
*/
|
|
600
|
+
InvoiceItem: {
|
|
601
|
+
sku?: string;
|
|
602
|
+
product_name?: string;
|
|
603
|
+
product_image_url?: string;
|
|
604
|
+
listing_price?: number;
|
|
605
|
+
selling_price?: number;
|
|
606
|
+
qty?: number;
|
|
607
|
+
free_qty?: number;
|
|
608
|
+
tax_type?: string;
|
|
609
|
+
tax_rate?: number;
|
|
610
|
+
hsncode?: string;
|
|
611
|
+
batch_number?: string;
|
|
612
|
+
expiry?: string;
|
|
613
|
+
amount?: number;
|
|
614
|
+
};
|
|
615
|
+
/** ItemWiseInventory */
|
|
616
|
+
ItemWiseInventory: {
|
|
617
|
+
product_id?: string;
|
|
618
|
+
product_name?: string;
|
|
619
|
+
variant_id?: string;
|
|
620
|
+
variant_name?: string;
|
|
621
|
+
sku?: string;
|
|
622
|
+
track_quantity?: boolean;
|
|
623
|
+
allow_backorder?: boolean;
|
|
624
|
+
track_lot_bacth?: boolean;
|
|
625
|
+
received_quantity?: number;
|
|
626
|
+
reserved_quantity?: number;
|
|
627
|
+
sold_quantity?: number;
|
|
628
|
+
adjusted_quantity?: number;
|
|
629
|
+
stock_quantity?: number;
|
|
630
|
+
};
|
|
631
|
+
/** LotBatchWiseInventory */
|
|
632
|
+
LotBatchWiseInventory: components["schemas"]["ItemWiseInventory"] & {
|
|
633
|
+
lot_batch?: string;
|
|
634
|
+
/** Format: date */
|
|
635
|
+
mfg_date?: string;
|
|
636
|
+
/** Format: date */
|
|
637
|
+
exp_date?: string;
|
|
638
|
+
manufacturer?: string;
|
|
639
|
+
};
|
|
640
|
+
/**
|
|
641
|
+
* LoyaltyPointPayment
|
|
642
|
+
* @description Loyalty point redemption.
|
|
643
|
+
*/
|
|
644
|
+
LoyaltyPointPayment: components["schemas"]["OrderPaymentInfo"];
|
|
645
|
+
/**
|
|
646
|
+
* NetbankingPayment
|
|
647
|
+
* @description Payments using payment gateway netbanking option.
|
|
648
|
+
*/
|
|
649
|
+
NetbankingPayment: components["schemas"]["OrderPaymentInfo"] & {
|
|
650
|
+
bank_name?: string;
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* NotificationChannelPreferences
|
|
654
|
+
* @description Set specific channel preferences
|
|
655
|
+
*/
|
|
656
|
+
NotificationChannelPreferences: {
|
|
657
|
+
/**
|
|
658
|
+
* @description Indicates whether the user has opted to receive notifications via email.
|
|
659
|
+
* @default true
|
|
660
|
+
*/
|
|
661
|
+
email: boolean;
|
|
662
|
+
/**
|
|
663
|
+
* @description Indicates whether the user has opted to receive notifications via SMS.
|
|
664
|
+
* @default true
|
|
665
|
+
*/
|
|
666
|
+
sms: boolean;
|
|
667
|
+
/**
|
|
668
|
+
* @description Indicates whether the user has opted to receive notifications via WhatsApp.
|
|
669
|
+
* @default true
|
|
670
|
+
*/
|
|
671
|
+
whatsapp: boolean;
|
|
672
|
+
};
|
|
673
|
+
/**
|
|
674
|
+
* NotificationPreferences
|
|
675
|
+
* @description Set channel preferences for each type of
|
|
676
|
+
*/
|
|
677
|
+
NotificationPreferences: {
|
|
678
|
+
/** @description These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities. */
|
|
679
|
+
transactional?: components["schemas"]["NotificationChannelPreferences"];
|
|
680
|
+
/** @description These notifications aim to engage users with promotional content and enhance their overall experience with the platform. */
|
|
681
|
+
promotional?: components["schemas"]["NotificationChannelPreferences"];
|
|
682
|
+
/** @description These notifications are often sent periodically as part of a subscription service.
|
|
683
|
+
* */
|
|
684
|
+
newsletter?: components["schemas"]["NotificationChannelPreferences"];
|
|
685
|
+
};
|
|
686
|
+
OpeningHours: {
|
|
687
|
+
monday: {
|
|
688
|
+
/** Format: time */
|
|
689
|
+
opening_time: string;
|
|
690
|
+
/** Format: time */
|
|
691
|
+
closing_time: string;
|
|
692
|
+
} | null;
|
|
693
|
+
tuesday: {
|
|
694
|
+
/** Format: time */
|
|
695
|
+
opening_time: string;
|
|
696
|
+
/** Format: time */
|
|
697
|
+
closing_time: string;
|
|
698
|
+
} | null;
|
|
699
|
+
wednesday: {
|
|
700
|
+
/** Format: time */
|
|
701
|
+
opening_time: string;
|
|
702
|
+
/** Format: time */
|
|
703
|
+
closing_time: string;
|
|
704
|
+
} | null;
|
|
705
|
+
thursday: {
|
|
706
|
+
/** Format: time */
|
|
707
|
+
opening_time: string;
|
|
708
|
+
/** Format: time */
|
|
709
|
+
closing_time: string;
|
|
710
|
+
} | null;
|
|
711
|
+
friday: {
|
|
712
|
+
/** Format: time */
|
|
713
|
+
opening_time: string;
|
|
714
|
+
/** Format: time */
|
|
715
|
+
closing_time: string;
|
|
716
|
+
} | null;
|
|
717
|
+
saturday: {
|
|
718
|
+
/** Format: time */
|
|
719
|
+
opening_time: string;
|
|
720
|
+
/** Format: time */
|
|
721
|
+
closing_time: string;
|
|
722
|
+
} | null;
|
|
723
|
+
sunday: {
|
|
724
|
+
/** Format: time */
|
|
725
|
+
opening_time: string;
|
|
726
|
+
/** Format: time */
|
|
727
|
+
closing_time: string;
|
|
728
|
+
} | null;
|
|
729
|
+
};
|
|
730
|
+
/** Order */
|
|
731
|
+
Order: {
|
|
732
|
+
order_number?: string;
|
|
733
|
+
/** Format: date-time */
|
|
734
|
+
order_date?: string;
|
|
735
|
+
/** @enum {string} */
|
|
736
|
+
status?: "draft" | "awaiting_approval" | "cancelled" | "shipped" | "delivered" | "awaiting_shipment";
|
|
737
|
+
/** @enum {string} */
|
|
738
|
+
payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refunded";
|
|
739
|
+
/** Format: date-time */
|
|
740
|
+
payment_success_date?: string;
|
|
741
|
+
customer_id?: string;
|
|
742
|
+
customer_email?: string | null;
|
|
743
|
+
customer_phone?: string | null;
|
|
744
|
+
customer_note?: string | null;
|
|
745
|
+
is_promotion_applied?: boolean;
|
|
746
|
+
promotion_discount_amount?: number | null;
|
|
747
|
+
is_coupon_applied?: boolean;
|
|
748
|
+
coupon_code?: string | null;
|
|
749
|
+
/** Format: double */
|
|
750
|
+
coupon_discount_amount?: number | null;
|
|
751
|
+
on_subscription?: boolean;
|
|
752
|
+
/** Format: double */
|
|
753
|
+
subtotal?: number;
|
|
754
|
+
/** Format: double */
|
|
755
|
+
item_total_tax?: number;
|
|
756
|
+
/** Format: double */
|
|
757
|
+
subtotal_including_tax?: number;
|
|
758
|
+
/** Format: double */
|
|
759
|
+
shipping_amount?: number;
|
|
760
|
+
/** Format: double */
|
|
761
|
+
shipping_total_tax?: number;
|
|
762
|
+
/** Format: double */
|
|
763
|
+
shipping_amount_including_tax?: number;
|
|
764
|
+
/** Format: double */
|
|
765
|
+
total_tax?: number;
|
|
766
|
+
/** Format: double */
|
|
767
|
+
grand_total?: number;
|
|
768
|
+
loyalty_point_redeemed?: number;
|
|
769
|
+
credit_balance_used?: number;
|
|
770
|
+
/** Format: double */
|
|
771
|
+
to_be_paid?: number;
|
|
772
|
+
loyalty_point_earned?: number;
|
|
773
|
+
order_items_count?: number;
|
|
774
|
+
currency?: {
|
|
775
|
+
name?: string;
|
|
776
|
+
code?: string;
|
|
777
|
+
symbol?: string;
|
|
778
|
+
};
|
|
779
|
+
/** Format: date-time */
|
|
780
|
+
created_at?: string;
|
|
781
|
+
/** Format: date-time */
|
|
782
|
+
modified_at?: string;
|
|
783
|
+
};
|
|
784
|
+
/** OrderActivity */
|
|
785
|
+
OrderActivity: {
|
|
786
|
+
readonly activity_type?: string;
|
|
787
|
+
readonly order_status?: string;
|
|
788
|
+
comment: string;
|
|
789
|
+
/** @enum {unknown} */
|
|
790
|
+
readonly user_type?: "customer" | "admin" | "system";
|
|
791
|
+
readonly user_name?: string;
|
|
792
|
+
/** Format: date-time */
|
|
793
|
+
readonly created_at?: string;
|
|
794
|
+
/** Format: date-time */
|
|
795
|
+
readonly modified_at?: string;
|
|
796
|
+
};
|
|
797
|
+
/** OrderDetail */
|
|
798
|
+
OrderDetail: {
|
|
799
|
+
order_number?: string;
|
|
800
|
+
/** Format: date-time */
|
|
801
|
+
order_date?: string;
|
|
802
|
+
/** @enum {string} */
|
|
803
|
+
status?: "draft" | "awaiting_approval" | "cancelled" | "shipped" | "delivered" | "awaiting_shipment";
|
|
804
|
+
/** @enum {string} */
|
|
805
|
+
payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refunded";
|
|
806
|
+
/** Format: date-time */
|
|
807
|
+
payment_success_date?: string;
|
|
808
|
+
customer_id?: string;
|
|
809
|
+
customer_email?: string | null;
|
|
810
|
+
customer_phone?: string | null;
|
|
811
|
+
customer_note?: string | null;
|
|
812
|
+
is_promotion_applied?: boolean;
|
|
813
|
+
promotion_discount_amount?: number | null;
|
|
814
|
+
is_coupon_applied?: boolean;
|
|
815
|
+
coupon_code?: string | null;
|
|
816
|
+
/** Format: double */
|
|
817
|
+
coupon_discount_amount?: number | null;
|
|
818
|
+
on_subscription?: boolean;
|
|
819
|
+
/** @enum {unknown} */
|
|
820
|
+
fulfillment_type?: "collect-in-store" | "delivery" | "partial-collect-and-delivery";
|
|
821
|
+
fulfillment_preferences?: components["schemas"]["PartialCollectAndDelivery"] | null;
|
|
822
|
+
sales_channel?: {
|
|
823
|
+
id?: string;
|
|
824
|
+
name?: string;
|
|
825
|
+
type?: string;
|
|
826
|
+
};
|
|
827
|
+
metadata?: {
|
|
828
|
+
[key: string]: string;
|
|
829
|
+
};
|
|
830
|
+
/** Format: double */
|
|
831
|
+
subtotal?: number;
|
|
832
|
+
/** Format: double */
|
|
833
|
+
subtotal_tax?: number;
|
|
834
|
+
/** Format: double */
|
|
835
|
+
subtotal_including_tax?: number;
|
|
836
|
+
/** Format: double */
|
|
837
|
+
shipping_amount?: number;
|
|
838
|
+
/** Format: double */
|
|
839
|
+
shipping_tax_rate?: number;
|
|
840
|
+
/** Format: double */
|
|
841
|
+
shipping_total_tax?: number;
|
|
842
|
+
/** Format: double */
|
|
843
|
+
shipping_amount_including_tax?: number;
|
|
844
|
+
/** Format: double */
|
|
845
|
+
total_tax?: number;
|
|
846
|
+
/** Format: double */
|
|
847
|
+
grand_total?: number;
|
|
848
|
+
loyalty_point_redeemed?: number;
|
|
849
|
+
credit_balance_used?: number;
|
|
850
|
+
/** Format: double */
|
|
851
|
+
to_be_paid?: number;
|
|
852
|
+
loyalty_point_earned?: number;
|
|
853
|
+
order_items_count?: number;
|
|
854
|
+
order_items?: components["schemas"]["OrderItem"][];
|
|
855
|
+
billing_address?: components["schemas"]["CustomerAddress"];
|
|
856
|
+
shipping_address?: components["schemas"]["CustomerAddress"];
|
|
857
|
+
currency?: {
|
|
858
|
+
name?: string;
|
|
859
|
+
code?: string;
|
|
860
|
+
symbol?: string;
|
|
861
|
+
};
|
|
862
|
+
feedback?: string | null;
|
|
863
|
+
allowed_actions?: string[];
|
|
864
|
+
applied_coupons?: components["schemas"]["AppliedCoupon"][];
|
|
865
|
+
applied_promotions?: components["schemas"]["AppliedPromotion"][];
|
|
866
|
+
payments?: components["schemas"]["OrderPayment"][];
|
|
867
|
+
shipments?: components["schemas"]["OrderShipment"][];
|
|
868
|
+
/** Format: date-time */
|
|
869
|
+
created_at?: string;
|
|
870
|
+
/** Format: date-time */
|
|
871
|
+
modified_at?: string;
|
|
872
|
+
};
|
|
873
|
+
/** OrderItem */
|
|
874
|
+
OrderItem: {
|
|
875
|
+
readonly product_id?: string;
|
|
876
|
+
readonly product_name?: string;
|
|
877
|
+
readonly product_image_url?: string | null;
|
|
878
|
+
sku: string;
|
|
879
|
+
readonly on_offer?: boolean;
|
|
880
|
+
readonly on_promotion?: boolean;
|
|
881
|
+
on_subscription?: boolean;
|
|
882
|
+
subscription_plan?: string | null;
|
|
883
|
+
readonly subscription_interval?: number | null;
|
|
884
|
+
readonly subscription_frequency?: string | null;
|
|
885
|
+
quantity: number;
|
|
886
|
+
readonly free_quantity?: number;
|
|
887
|
+
readonly is_free_item?: boolean;
|
|
888
|
+
/** Format: double */
|
|
889
|
+
readonly selling_price?: number;
|
|
890
|
+
/** Format: double */
|
|
891
|
+
readonly listing_price?: number;
|
|
892
|
+
/** Format: double */
|
|
893
|
+
readonly promotion_discount_amount?: number;
|
|
894
|
+
/** Format: double */
|
|
895
|
+
readonly coupon_discount_amount?: number;
|
|
896
|
+
/** @enum {unknown} */
|
|
897
|
+
readonly tax_type?: "GST";
|
|
898
|
+
/** Format: float */
|
|
899
|
+
readonly tax_rate?: number;
|
|
900
|
+
/** Format: double */
|
|
901
|
+
readonly tax_amount?: number;
|
|
902
|
+
/** Format: double */
|
|
903
|
+
readonly shipping_additional_cost?: number;
|
|
904
|
+
};
|
|
905
|
+
/**
|
|
906
|
+
* OrderList
|
|
907
|
+
* @description order list model
|
|
908
|
+
*/
|
|
909
|
+
OrderList: {
|
|
910
|
+
/** @description Order id. Same as order number. */
|
|
911
|
+
id?: string;
|
|
912
|
+
/** @description Unique number associated with the order. */
|
|
913
|
+
order_number?: string;
|
|
914
|
+
/**
|
|
915
|
+
* Format: date-time
|
|
916
|
+
* @description Date and time when the order was placed.
|
|
917
|
+
*/
|
|
918
|
+
order_date?: string;
|
|
919
|
+
/**
|
|
920
|
+
* @description Current status of the order (e.g., "pending," "processing," "shipped," etc.).
|
|
921
|
+
* @enum {string}
|
|
922
|
+
*/
|
|
923
|
+
status?: "draft" | "awaiting_approval" | "cancelled" | "shipped" | "delivered" | "awaiting_shipment" | "pending" | "payment_failed" | "schedule_requested";
|
|
924
|
+
/**
|
|
925
|
+
* @description Current payment status of the order (e.g., "pending," "success," "failed").
|
|
926
|
+
* @enum {string}
|
|
927
|
+
*/
|
|
928
|
+
payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refunded";
|
|
929
|
+
/** @description Date and time when the payment for the order was successfully processed. */
|
|
930
|
+
payment_success_date?: string | null;
|
|
931
|
+
/** @enum {unknown} */
|
|
932
|
+
fulfillment_type?: "collect-in-store" | "delivery";
|
|
933
|
+
/** @description Indicates whether the order includes subscription items. */
|
|
934
|
+
on_subscription?: boolean;
|
|
935
|
+
/**
|
|
936
|
+
* Format: double
|
|
937
|
+
* @description Total amount for the order, including all items, taxes, and discounts.
|
|
938
|
+
*/
|
|
939
|
+
grand_total?: number;
|
|
940
|
+
/** @description Number of loyalty points redeemed in the order. */
|
|
941
|
+
loyalty_point_redeemed?: number;
|
|
942
|
+
/** @description Amount of credit balance used in the order. */
|
|
943
|
+
credit_balance_used?: number;
|
|
944
|
+
/**
|
|
945
|
+
* Format: double
|
|
946
|
+
* @description Amount remaining to be paid for the order.
|
|
947
|
+
*/
|
|
948
|
+
to_be_paid?: number;
|
|
949
|
+
/** @description Total count of items included in the order. */
|
|
950
|
+
order_items_count?: number;
|
|
951
|
+
order_items?: components["schemas"]["OrderItem"][];
|
|
952
|
+
customer_id?: string;
|
|
953
|
+
customer_note?: string | null;
|
|
954
|
+
billing_address?: components["schemas"]["CustomerAddress"];
|
|
955
|
+
shipping_address?: components["schemas"]["CustomerAddress"];
|
|
956
|
+
loyalty_point_earned?: number;
|
|
957
|
+
currency?: {
|
|
958
|
+
name?: string;
|
|
959
|
+
code?: string;
|
|
960
|
+
symbol?: string;
|
|
961
|
+
};
|
|
962
|
+
sales_channel?: {
|
|
963
|
+
id?: string;
|
|
964
|
+
name?: string;
|
|
965
|
+
type?: string;
|
|
966
|
+
};
|
|
967
|
+
metadata?: {
|
|
968
|
+
[key: string]: string;
|
|
969
|
+
};
|
|
970
|
+
/** Format: date-time */
|
|
971
|
+
created_at?: string;
|
|
972
|
+
/** Format: date-time */
|
|
973
|
+
modified_at?: string;
|
|
974
|
+
};
|
|
975
|
+
/**
|
|
976
|
+
* OrderPayment
|
|
977
|
+
* @description Order Payment
|
|
978
|
+
*/
|
|
979
|
+
OrderPayment: components["schemas"]["CardPayment"] | components["schemas"]["NetbankingPayment"] | components["schemas"]["UpiPayment"] | components["schemas"]["WalletPayment"] | components["schemas"]["BankTransfer"] | components["schemas"]["LoyaltyPointPayment"];
|
|
980
|
+
/**
|
|
981
|
+
* OrderPaymentInfo
|
|
982
|
+
* @description Common fields in all types of payments.
|
|
983
|
+
*/
|
|
984
|
+
OrderPaymentInfo: {
|
|
985
|
+
/** @enum {unknown} */
|
|
986
|
+
transaction_type?: "payment" | "refund";
|
|
987
|
+
request_number?: string;
|
|
988
|
+
/** Format: double */
|
|
989
|
+
amount?: number;
|
|
990
|
+
/** @enum {unknown} */
|
|
991
|
+
payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated";
|
|
992
|
+
/** Format: date-time */
|
|
993
|
+
payment_date?: string;
|
|
994
|
+
payment_reference_number?: string | null;
|
|
995
|
+
/** @enum {unknown} */
|
|
996
|
+
payment_method?: "Credit Card" | "Debit Card" | "Netbanking" | "UPI" | "Wallet" | "Loyalty Point" | "IMPS" | "NEFT" | "RTGS";
|
|
997
|
+
icon_url?: string;
|
|
998
|
+
};
|
|
999
|
+
/** OrderReceiptJsonFormat */
|
|
1000
|
+
OrderReceiptJsonFormat: components["schemas"]["Order"] & {
|
|
1001
|
+
billing_address?: components["schemas"]["CustomerAddress"];
|
|
1002
|
+
shipping_address?: components["schemas"]["CustomerAddress"];
|
|
1003
|
+
order_items?: components["schemas"]["OrderItem"][];
|
|
1004
|
+
payments?: components["schemas"]["OrderPayment"][];
|
|
1005
|
+
};
|
|
1006
|
+
/**
|
|
1007
|
+
* OrderShipment
|
|
1008
|
+
* @description Order shipment model
|
|
1009
|
+
*/
|
|
1010
|
+
OrderShipment: {
|
|
1011
|
+
reference_number?: string;
|
|
1012
|
+
/** @enum {unknown} */
|
|
1013
|
+
status?: "pending" | "approved" | "shipped" | "delivered" | "cancelled";
|
|
1014
|
+
total_weight?: number;
|
|
1015
|
+
total_boxes?: number;
|
|
1016
|
+
shipment_items_count?: number;
|
|
1017
|
+
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
1018
|
+
/** Format: double */
|
|
1019
|
+
shipping_amount?: number;
|
|
1020
|
+
/** Format: double */
|
|
1021
|
+
shipping_tax_amount?: number;
|
|
1022
|
+
/** Format: double */
|
|
1023
|
+
shipping_amount_including_tax?: number;
|
|
1024
|
+
courier_company_id?: string;
|
|
1025
|
+
courier_company_name?: string;
|
|
1026
|
+
shipping_label_url?: string;
|
|
1027
|
+
awb_no?: string;
|
|
1028
|
+
eta_delivery?: string;
|
|
1029
|
+
/** Format: date-time */
|
|
1030
|
+
shipped_date?: string;
|
|
1031
|
+
/** Format: date-time */
|
|
1032
|
+
delivered_date?: string;
|
|
1033
|
+
cancellation_reason?: string;
|
|
1034
|
+
/** Format: date-time */
|
|
1035
|
+
created_at?: string;
|
|
1036
|
+
/** Format: date-time */
|
|
1037
|
+
modified_at?: string;
|
|
1038
|
+
};
|
|
1039
|
+
/**
|
|
1040
|
+
* Pagination
|
|
1041
|
+
* @description pagination metadata structure
|
|
1042
|
+
*/
|
|
1043
|
+
Pagination: {
|
|
1044
|
+
total_records?: number;
|
|
1045
|
+
total_pages?: number;
|
|
1046
|
+
previous_page?: ((number | null) | null) | null;
|
|
1047
|
+
/** @default 25 */
|
|
1048
|
+
limit: number;
|
|
1049
|
+
next_page?: ((number | null) | null) | null;
|
|
1050
|
+
};
|
|
1051
|
+
/** PartialCollectAndDelivery */
|
|
1052
|
+
PartialCollectAndDelivery: {
|
|
1053
|
+
pickup: {
|
|
1054
|
+
product_id: string;
|
|
1055
|
+
readonly product_name: string;
|
|
1056
|
+
variant_id: string | null;
|
|
1057
|
+
readonly variant_name: string | null;
|
|
1058
|
+
quantity: number;
|
|
1059
|
+
}[];
|
|
1060
|
+
delivery: {
|
|
1061
|
+
product_id: string;
|
|
1062
|
+
readonly product_name: string;
|
|
1063
|
+
variant_id: string | null;
|
|
1064
|
+
readonly variant_name: string | null;
|
|
1065
|
+
quantity: number;
|
|
1066
|
+
}[];
|
|
1067
|
+
shipping_address: components["schemas"]["CustomerAddress"];
|
|
1068
|
+
};
|
|
1069
|
+
/** Shipment */
|
|
1070
|
+
Shipment: components["schemas"]["ShipmentInfo"] & {
|
|
1071
|
+
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
1072
|
+
} & {
|
|
1073
|
+
packing?: components["schemas"]["ShipmentPackaging"];
|
|
1074
|
+
} & {
|
|
1075
|
+
progression?: components["schemas"]["ShipmentProgression"][];
|
|
1076
|
+
};
|
|
1077
|
+
/** ShipmentBox */
|
|
1078
|
+
ShipmentBox: {
|
|
1079
|
+
box_name?: string;
|
|
1080
|
+
box_length?: number;
|
|
1081
|
+
box_width?: number;
|
|
1082
|
+
box_height?: number;
|
|
1083
|
+
box_weight?: number;
|
|
1084
|
+
items_count?: number | null;
|
|
1085
|
+
box_count?: number | null;
|
|
1086
|
+
};
|
|
1087
|
+
/** ShipmentDetail */
|
|
1088
|
+
ShipmentDetail: {
|
|
1089
|
+
order_number?: string;
|
|
1090
|
+
/** Format: date-time */
|
|
1091
|
+
order_date?: string;
|
|
1092
|
+
order_status?: string;
|
|
1093
|
+
/** @enum {unknown} */
|
|
1094
|
+
payment_status?: "pending" | "success" | "failed";
|
|
1095
|
+
customer_name?: string;
|
|
1096
|
+
shipments?: components["schemas"]["Shipment"][];
|
|
1097
|
+
/** @description dynamic values as per current status of the shipment. */
|
|
1098
|
+
allowed_actions?: string[];
|
|
1099
|
+
};
|
|
1100
|
+
/** ShipmentInfo */
|
|
1101
|
+
ShipmentInfo: {
|
|
1102
|
+
order_number?: string;
|
|
1103
|
+
order_status?: string;
|
|
1104
|
+
shipment_number?: string;
|
|
1105
|
+
warehouse_id?: string;
|
|
1106
|
+
warehouse_name?: string;
|
|
1107
|
+
status?: string;
|
|
1108
|
+
total_weight?: number;
|
|
1109
|
+
total_boxes?: number;
|
|
1110
|
+
shipment_items_count?: number;
|
|
1111
|
+
/** Format: double */
|
|
1112
|
+
shipping_amount?: number;
|
|
1113
|
+
/** Format: double */
|
|
1114
|
+
shipping_tax_amount?: number;
|
|
1115
|
+
/** Format: double */
|
|
1116
|
+
shipping_amount_including_tax?: number;
|
|
1117
|
+
courier_company_id?: string | null;
|
|
1118
|
+
courier_company_name?: string | null;
|
|
1119
|
+
courier_company_image_url?: string | null;
|
|
1120
|
+
awb_no?: string | null;
|
|
1121
|
+
shipping_label_url?: string | null;
|
|
1122
|
+
eta_delivery?: string | null;
|
|
1123
|
+
shipped_date?: string | null;
|
|
1124
|
+
delivered_date?: string | null;
|
|
1125
|
+
slo?: {
|
|
1126
|
+
/** Format: date */
|
|
1127
|
+
expected_date?: string;
|
|
1128
|
+
/** Format: date */
|
|
1129
|
+
actual_date?: string;
|
|
1130
|
+
difference?: string;
|
|
1131
|
+
};
|
|
1132
|
+
cancellation_reason?: string | null;
|
|
1133
|
+
customer_id?: string;
|
|
1134
|
+
customer_name?: string;
|
|
1135
|
+
shipping_address_line1?: string;
|
|
1136
|
+
shipping_address_line2?: string;
|
|
1137
|
+
shipping_landmark?: string;
|
|
1138
|
+
shipping_pincode?: string;
|
|
1139
|
+
shipping_city?: string;
|
|
1140
|
+
shipping_state?: string;
|
|
1141
|
+
created_at?: string;
|
|
1142
|
+
modified_at?: string;
|
|
1143
|
+
};
|
|
1144
|
+
/**
|
|
1145
|
+
* ShipmentItem
|
|
1146
|
+
* @description Shipment item model
|
|
1147
|
+
*/
|
|
1148
|
+
ShipmentItem: {
|
|
1149
|
+
product_id: string;
|
|
1150
|
+
readonly product_name?: string;
|
|
1151
|
+
variant_id: string | null;
|
|
1152
|
+
readonly variant_name?: string | null;
|
|
1153
|
+
readonly product_image_url?: string | null;
|
|
1154
|
+
readonly sku?: string;
|
|
1155
|
+
quantity: number;
|
|
1156
|
+
free_quantity?: number;
|
|
1157
|
+
readonly is_free_item?: boolean;
|
|
1158
|
+
};
|
|
1159
|
+
/** ShipmentList */
|
|
1160
|
+
ShipmentList: {
|
|
1161
|
+
order_number?: string;
|
|
1162
|
+
} & components["schemas"]["ShipmentInfo"];
|
|
1163
|
+
/** ShipmentPackaging */
|
|
1164
|
+
ShipmentPackaging: {
|
|
1165
|
+
/** @enum {unknown} */
|
|
1166
|
+
package_option?: "Automatic" | "Custom";
|
|
1167
|
+
boxes_count?: number;
|
|
1168
|
+
boxes?: components["schemas"]["ShipmentBox"][];
|
|
1169
|
+
};
|
|
1170
|
+
/** ShipmentProgression */
|
|
1171
|
+
ShipmentProgression: {
|
|
1172
|
+
readonly status?: string;
|
|
1173
|
+
readonly is_current?: boolean;
|
|
1174
|
+
readonly is_completed?: boolean;
|
|
1175
|
+
/** Format: date-time */
|
|
1176
|
+
readonly completion_date?: string;
|
|
1177
|
+
};
|
|
1178
|
+
/**
|
|
1179
|
+
* UpiPayment
|
|
1180
|
+
* @description UPI Payment
|
|
1181
|
+
*/
|
|
1182
|
+
UpiPayment: components["schemas"]["OrderPaymentInfo"] & {
|
|
1183
|
+
upi_id?: string;
|
|
1184
|
+
};
|
|
1185
|
+
/** WalletPayment */
|
|
1186
|
+
WalletPayment: components["schemas"]["OrderPaymentInfo"] & {
|
|
1187
|
+
wallet_name?: string;
|
|
1188
|
+
};
|
|
1189
|
+
/**
|
|
1190
|
+
* Warehouse
|
|
1191
|
+
* @description Validations:
|
|
1192
|
+
*
|
|
1193
|
+
* 1) Either 'can_receive_stock' or 'accepts_returns' must be set to true.
|
|
1194
|
+
* 2) 'can_receive_stock' cannot be set to false while the warehouse has existing inventory.
|
|
1195
|
+
* 3) 'is_checkout_point' must be true when the warehouse type is 'retail-store'.
|
|
1196
|
+
* 4) If 'can_receive_stock' is false then 'can_ship_parcel' and 'can_collect' fields should be false.
|
|
1197
|
+
*/
|
|
1198
|
+
Warehouse: {
|
|
1199
|
+
/** @description warehouse id */
|
|
1200
|
+
readonly id?: string;
|
|
1201
|
+
/** @description legal name */
|
|
1202
|
+
name: string;
|
|
1203
|
+
/** @enum {unknown} */
|
|
1204
|
+
warehouse_type: "retail-store" | "distribution-center";
|
|
1205
|
+
/** @default true */
|
|
1206
|
+
active: boolean;
|
|
1207
|
+
gstin?: string | null;
|
|
1208
|
+
city: string;
|
|
1209
|
+
address_line1: string;
|
|
1210
|
+
address_line2?: string | null;
|
|
1211
|
+
landmark?: string | null;
|
|
1212
|
+
pincode: string;
|
|
1213
|
+
state: string;
|
|
1214
|
+
country: string;
|
|
1215
|
+
/** @default +91 */
|
|
1216
|
+
country_code: string;
|
|
1217
|
+
/** @description 10 digit number without country code. */
|
|
1218
|
+
contact_phone: number;
|
|
1219
|
+
contact_email: string;
|
|
1220
|
+
is_default?: boolean;
|
|
1221
|
+
image_url?: string | null;
|
|
1222
|
+
seller_warehouse_id?: string | null;
|
|
1223
|
+
can_receive_stock: boolean;
|
|
1224
|
+
can_ship_parcel: boolean;
|
|
1225
|
+
can_collect: boolean;
|
|
1226
|
+
/** @description this field will be always true for warehouse_type = retail-store. */
|
|
1227
|
+
is_checkout_point: boolean;
|
|
1228
|
+
accepts_returns: boolean;
|
|
1229
|
+
opening_hours?: components["schemas"]["OpeningHours"];
|
|
1230
|
+
};
|
|
1231
|
+
/** WarehouseBasicDetail */
|
|
1232
|
+
WarehouseBasicDetail: {
|
|
1233
|
+
id?: string;
|
|
1234
|
+
name?: string;
|
|
1235
|
+
address_line1?: string;
|
|
1236
|
+
pincode?: string;
|
|
1237
|
+
city?: string;
|
|
1238
|
+
state?: string;
|
|
1239
|
+
is_default?: boolean;
|
|
1240
|
+
};
|
|
1241
|
+
/** WarehouseWiseInventory */
|
|
1242
|
+
WarehouseWiseInventory: {
|
|
1243
|
+
lot_bacth?: string;
|
|
1244
|
+
/** Format: date */
|
|
1245
|
+
mfg_date?: string;
|
|
1246
|
+
/** Format: date */
|
|
1247
|
+
exp_date?: string;
|
|
1248
|
+
manufacturer?: string;
|
|
1249
|
+
warehouse_id?: string;
|
|
1250
|
+
warehouse?: components["schemas"]["WarehouseBasicDetail"];
|
|
1251
|
+
received_quantity?: number;
|
|
1252
|
+
reserved_quantity?: number;
|
|
1253
|
+
sold_quantity?: number;
|
|
1254
|
+
adjusted_quantity?: number;
|
|
1255
|
+
stock_quantity?: number;
|
|
1256
|
+
};
|
|
1257
|
+
};
|
|
1258
|
+
responses: never;
|
|
1259
|
+
parameters: {
|
|
1260
|
+
/** @description JSON object */
|
|
1261
|
+
columnBasedFilters: string;
|
|
1262
|
+
/** @description no of rows per page */
|
|
1263
|
+
pageLimit: number;
|
|
1264
|
+
/** @description page number of pagination list */
|
|
1265
|
+
pageNumber: number;
|
|
1266
|
+
/** @description search keyword */
|
|
1267
|
+
searchKeyword: string;
|
|
1268
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1269
|
+
sortByOptions: string;
|
|
1270
|
+
};
|
|
1271
|
+
requestBodies: never;
|
|
1272
|
+
headers: never;
|
|
1273
|
+
pathItems: never;
|
|
1274
|
+
}
|
|
1275
|
+
interface operations {
|
|
1276
|
+
"pos-list-inventory": {
|
|
1277
|
+
parameters: {
|
|
1278
|
+
query?: {
|
|
1279
|
+
/** @description page number of pagination list */
|
|
1280
|
+
page?: components["parameters"]["pageNumber"];
|
|
1281
|
+
/** @description no of rows per page */
|
|
1282
|
+
limit?: components["parameters"]["pageLimit"];
|
|
1283
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1284
|
+
sort_by?: components["parameters"]["sortByOptions"];
|
|
1285
|
+
/** @description JSON object */
|
|
1286
|
+
filters?: components["parameters"]["columnBasedFilters"];
|
|
1287
|
+
};
|
|
1288
|
+
header?: never;
|
|
1289
|
+
path?: never;
|
|
1290
|
+
cookie?: never;
|
|
1291
|
+
};
|
|
1292
|
+
requestBody?: never;
|
|
1293
|
+
responses: {
|
|
1294
|
+
/** @description OK */
|
|
1295
|
+
200: {
|
|
1296
|
+
headers: {
|
|
1297
|
+
[name: string]: unknown;
|
|
1298
|
+
};
|
|
1299
|
+
content: {
|
|
1300
|
+
"application/json": {
|
|
1301
|
+
message?: string;
|
|
1302
|
+
success?: boolean;
|
|
1303
|
+
content?: {
|
|
1304
|
+
inventories?: (components["schemas"]["ItemWiseInventory"] | components["schemas"]["LotBatchWiseInventory"])[];
|
|
1305
|
+
};
|
|
1306
|
+
};
|
|
1307
|
+
};
|
|
1308
|
+
};
|
|
1309
|
+
};
|
|
1310
|
+
};
|
|
1311
|
+
"pos-list-inventory-activity": {
|
|
1312
|
+
parameters: {
|
|
1313
|
+
query?: {
|
|
1314
|
+
/** @description page number of pagination list */
|
|
1315
|
+
page?: components["parameters"]["pageNumber"];
|
|
1316
|
+
/** @description no of rows per page */
|
|
1317
|
+
limit?: components["parameters"]["pageLimit"];
|
|
1318
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1319
|
+
sort_by?: components["parameters"]["sortByOptions"];
|
|
1320
|
+
/** @description JSON object */
|
|
1321
|
+
filters?: components["parameters"]["columnBasedFilters"];
|
|
1322
|
+
};
|
|
1323
|
+
header?: never;
|
|
1324
|
+
path?: never;
|
|
1325
|
+
cookie?: never;
|
|
1326
|
+
};
|
|
1327
|
+
requestBody?: never;
|
|
1328
|
+
responses: {
|
|
1329
|
+
/** @description OK */
|
|
1330
|
+
200: {
|
|
1331
|
+
headers: {
|
|
1332
|
+
[name: string]: unknown;
|
|
1333
|
+
};
|
|
1334
|
+
content: {
|
|
1335
|
+
"application/json": {
|
|
1336
|
+
message?: string;
|
|
1337
|
+
success?: boolean;
|
|
1338
|
+
content?: {
|
|
1339
|
+
activities?: components["schemas"]["InventoryActivity"][];
|
|
1340
|
+
};
|
|
1341
|
+
};
|
|
1342
|
+
};
|
|
1343
|
+
};
|
|
1344
|
+
};
|
|
1345
|
+
};
|
|
1346
|
+
"pos-list-inventory-detail": {
|
|
1347
|
+
parameters: {
|
|
1348
|
+
query: {
|
|
1349
|
+
/** @description lot batch of selected productor or variant. */
|
|
1350
|
+
lot_batch?: string;
|
|
1351
|
+
/** @description Product Id */
|
|
1352
|
+
product_id: string;
|
|
1353
|
+
/** @description Variant Id */
|
|
1354
|
+
variant_id?: string;
|
|
1355
|
+
};
|
|
1356
|
+
header?: never;
|
|
1357
|
+
path?: never;
|
|
1358
|
+
cookie?: never;
|
|
1359
|
+
};
|
|
1360
|
+
requestBody?: never;
|
|
1361
|
+
responses: {
|
|
1362
|
+
/** @description OK */
|
|
1363
|
+
200: {
|
|
1364
|
+
headers: {
|
|
1365
|
+
[name: string]: unknown;
|
|
1366
|
+
};
|
|
1367
|
+
content: {
|
|
1368
|
+
"application/json": {
|
|
1369
|
+
message?: string;
|
|
1370
|
+
success?: boolean;
|
|
1371
|
+
content?: {
|
|
1372
|
+
inventory?: components["schemas"]["InventoryDetail"];
|
|
1373
|
+
};
|
|
1374
|
+
};
|
|
1375
|
+
};
|
|
1376
|
+
};
|
|
1377
|
+
};
|
|
1378
|
+
};
|
|
1379
|
+
"pos-list-customers": {
|
|
1380
|
+
parameters: {
|
|
1381
|
+
query?: {
|
|
1382
|
+
/** @description page number of pagination list */
|
|
1383
|
+
page?: components["parameters"]["pageNumber"];
|
|
1384
|
+
/** @description no of rows per page */
|
|
1385
|
+
limit?: components["parameters"]["pageLimit"];
|
|
1386
|
+
/** @description JSON object */
|
|
1387
|
+
filters?: components["parameters"]["columnBasedFilters"];
|
|
1388
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1389
|
+
sort_by?: components["parameters"]["sortByOptions"];
|
|
1390
|
+
/** @description search keyword */
|
|
1391
|
+
search?: components["parameters"]["searchKeyword"];
|
|
1392
|
+
};
|
|
1393
|
+
header?: never;
|
|
1394
|
+
path?: never;
|
|
1395
|
+
cookie?: never;
|
|
1396
|
+
};
|
|
1397
|
+
requestBody?: never;
|
|
1398
|
+
responses: {
|
|
1399
|
+
/** @description OK */
|
|
1400
|
+
200: {
|
|
1401
|
+
headers: {
|
|
1402
|
+
[name: string]: unknown;
|
|
1403
|
+
};
|
|
1404
|
+
content: {
|
|
1405
|
+
"application/json": {
|
|
1406
|
+
message?: string;
|
|
1407
|
+
success?: boolean;
|
|
1408
|
+
content?: {
|
|
1409
|
+
customers?: components["schemas"]["Customer"][];
|
|
1410
|
+
pagination?: components["schemas"]["Pagination"];
|
|
1411
|
+
};
|
|
1412
|
+
};
|
|
1413
|
+
};
|
|
1414
|
+
};
|
|
1415
|
+
};
|
|
1416
|
+
};
|
|
1417
|
+
"pos-get-customer-detail": {
|
|
1418
|
+
parameters: {
|
|
1419
|
+
query?: never;
|
|
1420
|
+
header?: never;
|
|
1421
|
+
path: {
|
|
1422
|
+
/** @description Customer Id */
|
|
1423
|
+
id: string;
|
|
1424
|
+
};
|
|
1425
|
+
cookie?: never;
|
|
1426
|
+
};
|
|
1427
|
+
requestBody?: never;
|
|
1428
|
+
responses: {
|
|
1429
|
+
/** @description OK */
|
|
1430
|
+
200: {
|
|
1431
|
+
headers: {
|
|
1432
|
+
[name: string]: unknown;
|
|
1433
|
+
};
|
|
1434
|
+
content: {
|
|
1435
|
+
"application/json": {
|
|
1436
|
+
message?: string;
|
|
1437
|
+
success?: boolean;
|
|
1438
|
+
content?: {
|
|
1439
|
+
customer?: components["schemas"]["CustomerDetail"];
|
|
1440
|
+
};
|
|
1441
|
+
};
|
|
1442
|
+
};
|
|
1443
|
+
};
|
|
1444
|
+
};
|
|
1445
|
+
};
|
|
1446
|
+
"pos-list-orders": {
|
|
1447
|
+
parameters: {
|
|
1448
|
+
query?: {
|
|
1449
|
+
/** @description page number of pagination list */
|
|
1450
|
+
page?: components["parameters"]["pageNumber"];
|
|
1451
|
+
/** @description no of rows per page */
|
|
1452
|
+
limit?: components["parameters"]["pageLimit"];
|
|
1453
|
+
/** @description JSON object */
|
|
1454
|
+
filters?: components["parameters"]["columnBasedFilters"];
|
|
1455
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1456
|
+
sort_by?: components["parameters"]["sortByOptions"];
|
|
1457
|
+
/** @description search keyword */
|
|
1458
|
+
search?: components["parameters"]["searchKeyword"];
|
|
1459
|
+
};
|
|
1460
|
+
header?: never;
|
|
1461
|
+
path?: never;
|
|
1462
|
+
cookie?: never;
|
|
1463
|
+
};
|
|
1464
|
+
requestBody?: never;
|
|
1465
|
+
responses: {
|
|
1466
|
+
/** @description OK */
|
|
1467
|
+
200: {
|
|
1468
|
+
headers: {
|
|
1469
|
+
[name: string]: unknown;
|
|
1470
|
+
};
|
|
1471
|
+
content: {
|
|
1472
|
+
"application/json": {
|
|
1473
|
+
message?: string;
|
|
1474
|
+
success?: boolean;
|
|
1475
|
+
content?: {
|
|
1476
|
+
orders?: components["schemas"]["OrderList"][];
|
|
1477
|
+
pagination?: components["schemas"]["Pagination"];
|
|
1478
|
+
};
|
|
1479
|
+
};
|
|
1480
|
+
};
|
|
1481
|
+
};
|
|
1482
|
+
};
|
|
1483
|
+
};
|
|
1484
|
+
"pos-get-order-detail": {
|
|
1485
|
+
parameters: {
|
|
1486
|
+
query?: never;
|
|
1487
|
+
header?: never;
|
|
1488
|
+
path: {
|
|
1489
|
+
/** @description order number */
|
|
1490
|
+
order_number: string;
|
|
1491
|
+
};
|
|
1492
|
+
cookie?: never;
|
|
1493
|
+
};
|
|
1494
|
+
requestBody?: never;
|
|
1495
|
+
responses: {
|
|
1496
|
+
/** @description OK */
|
|
1497
|
+
200: {
|
|
1498
|
+
headers: {
|
|
1499
|
+
[name: string]: unknown;
|
|
1500
|
+
};
|
|
1501
|
+
content: {
|
|
1502
|
+
"application/json": {
|
|
1503
|
+
message?: string;
|
|
1504
|
+
success?: boolean;
|
|
1505
|
+
content?: {
|
|
1506
|
+
order?: components["schemas"]["OrderDetail"];
|
|
1507
|
+
};
|
|
1508
|
+
};
|
|
1509
|
+
};
|
|
1510
|
+
};
|
|
1511
|
+
};
|
|
1512
|
+
};
|
|
1513
|
+
"pos-list-order-activity": {
|
|
1514
|
+
parameters: {
|
|
1515
|
+
query?: never;
|
|
1516
|
+
header?: never;
|
|
1517
|
+
path: {
|
|
1518
|
+
/** @description order number */
|
|
1519
|
+
order_number: string;
|
|
1520
|
+
};
|
|
1521
|
+
cookie?: never;
|
|
1522
|
+
};
|
|
1523
|
+
requestBody?: never;
|
|
1524
|
+
responses: {
|
|
1525
|
+
/** @description OK */
|
|
1526
|
+
200: {
|
|
1527
|
+
headers: {
|
|
1528
|
+
[name: string]: unknown;
|
|
1529
|
+
};
|
|
1530
|
+
content: {
|
|
1531
|
+
"application/json": {
|
|
1532
|
+
message?: string;
|
|
1533
|
+
success?: boolean;
|
|
1534
|
+
content?: {
|
|
1535
|
+
activity?: components["schemas"]["OrderActivity"][];
|
|
1536
|
+
pagination?: components["schemas"]["Pagination"];
|
|
1537
|
+
};
|
|
1538
|
+
};
|
|
1539
|
+
};
|
|
1540
|
+
};
|
|
1541
|
+
};
|
|
1542
|
+
};
|
|
1543
|
+
"pos-get-order-invoice": {
|
|
1544
|
+
parameters: {
|
|
1545
|
+
query?: {
|
|
1546
|
+
/** @description Response data format */
|
|
1547
|
+
format?: "json" | "pdf";
|
|
1548
|
+
};
|
|
1549
|
+
header?: never;
|
|
1550
|
+
path: {
|
|
1551
|
+
/** @description order number */
|
|
1552
|
+
order_number: string;
|
|
1553
|
+
};
|
|
1554
|
+
cookie?: never;
|
|
1555
|
+
};
|
|
1556
|
+
requestBody?: never;
|
|
1557
|
+
responses: {
|
|
1558
|
+
/** @description OK */
|
|
1559
|
+
200: {
|
|
1560
|
+
headers: {
|
|
1561
|
+
[name: string]: unknown;
|
|
1562
|
+
};
|
|
1563
|
+
content: {
|
|
1564
|
+
"application/json": {
|
|
1565
|
+
message?: string;
|
|
1566
|
+
success?: boolean;
|
|
1567
|
+
content?: {
|
|
1568
|
+
invoices?: components["schemas"]["InvoiceDetail"][];
|
|
1569
|
+
};
|
|
1570
|
+
};
|
|
1571
|
+
"application/pdf": Record<string, never>;
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
};
|
|
1575
|
+
};
|
|
1576
|
+
"pos-get-order-receipt": {
|
|
1577
|
+
parameters: {
|
|
1578
|
+
query?: {
|
|
1579
|
+
/** @description Response data format */
|
|
1580
|
+
format?: "json" | "pdf";
|
|
1581
|
+
};
|
|
1582
|
+
header?: never;
|
|
1583
|
+
path: {
|
|
1584
|
+
/** @description order number */
|
|
1585
|
+
order_number: string;
|
|
1586
|
+
};
|
|
1587
|
+
cookie?: never;
|
|
1588
|
+
};
|
|
1589
|
+
requestBody?: never;
|
|
1590
|
+
responses: {
|
|
1591
|
+
/** @description OK */
|
|
1592
|
+
200: {
|
|
1593
|
+
headers: {
|
|
1594
|
+
[name: string]: unknown;
|
|
1595
|
+
};
|
|
1596
|
+
content: {
|
|
1597
|
+
"application/json": {
|
|
1598
|
+
message?: string;
|
|
1599
|
+
success?: boolean;
|
|
1600
|
+
content?: {
|
|
1601
|
+
order_receipt?: components["schemas"]["OrderReceiptJsonFormat"];
|
|
1602
|
+
};
|
|
1603
|
+
};
|
|
1604
|
+
"application/pdf": Record<string, never>;
|
|
1605
|
+
};
|
|
1606
|
+
};
|
|
1607
|
+
};
|
|
1608
|
+
};
|
|
1609
|
+
"pos-list-order-shipments": {
|
|
1610
|
+
parameters: {
|
|
1611
|
+
query?: never;
|
|
1612
|
+
header?: never;
|
|
1613
|
+
path: {
|
|
1614
|
+
/** @description order number */
|
|
1615
|
+
order_number: string;
|
|
1616
|
+
};
|
|
1617
|
+
cookie?: never;
|
|
1618
|
+
};
|
|
1619
|
+
requestBody?: never;
|
|
1620
|
+
responses: {
|
|
1621
|
+
/** @description OK */
|
|
1622
|
+
200: {
|
|
1623
|
+
headers: {
|
|
1624
|
+
[name: string]: unknown;
|
|
1625
|
+
};
|
|
1626
|
+
content: {
|
|
1627
|
+
"application/json": {
|
|
1628
|
+
message?: string;
|
|
1629
|
+
success?: boolean;
|
|
1630
|
+
content?: {
|
|
1631
|
+
shipment?: components["schemas"]["ShipmentDetail"];
|
|
1632
|
+
};
|
|
1633
|
+
};
|
|
1634
|
+
};
|
|
1635
|
+
};
|
|
1636
|
+
};
|
|
1637
|
+
};
|
|
1638
|
+
"pos-list-shipments": {
|
|
1639
|
+
parameters: {
|
|
1640
|
+
query?: {
|
|
1641
|
+
/** @description page number of pagination list */
|
|
1642
|
+
page?: components["parameters"]["pageNumber"];
|
|
1643
|
+
/** @description no of rows per page */
|
|
1644
|
+
limit?: components["parameters"]["pageLimit"];
|
|
1645
|
+
/** @description JSON object */
|
|
1646
|
+
filters?: components["parameters"]["columnBasedFilters"];
|
|
1647
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1648
|
+
sort_by?: components["parameters"]["sortByOptions"];
|
|
1649
|
+
/** @description search keyword */
|
|
1650
|
+
search?: components["parameters"]["searchKeyword"];
|
|
1651
|
+
};
|
|
1652
|
+
header?: never;
|
|
1653
|
+
path?: never;
|
|
1654
|
+
cookie?: never;
|
|
1655
|
+
};
|
|
1656
|
+
requestBody?: never;
|
|
1657
|
+
responses: {
|
|
1658
|
+
/** @description OK */
|
|
1659
|
+
200: {
|
|
1660
|
+
headers: {
|
|
1661
|
+
[name: string]: unknown;
|
|
1662
|
+
};
|
|
1663
|
+
content: {
|
|
1664
|
+
"application/json": {
|
|
1665
|
+
message?: string;
|
|
1666
|
+
success?: boolean;
|
|
1667
|
+
content?: {
|
|
1668
|
+
shipments?: components["schemas"]["ShipmentList"][];
|
|
1669
|
+
pagination?: components["schemas"]["Pagination"];
|
|
1670
|
+
};
|
|
1671
|
+
};
|
|
1672
|
+
};
|
|
1673
|
+
};
|
|
1674
|
+
};
|
|
1675
|
+
};
|
|
1676
|
+
"pos-check-order-inventory": {
|
|
1677
|
+
parameters: {
|
|
1678
|
+
query?: never;
|
|
1679
|
+
header?: never;
|
|
1680
|
+
path: {
|
|
1681
|
+
/** @description Order number */
|
|
1682
|
+
order_number: string;
|
|
1683
|
+
};
|
|
1684
|
+
cookie?: never;
|
|
1685
|
+
};
|
|
1686
|
+
requestBody?: never;
|
|
1687
|
+
responses: {
|
|
1688
|
+
/** @description OK */
|
|
1689
|
+
200: {
|
|
1690
|
+
headers: {
|
|
1691
|
+
[name: string]: unknown;
|
|
1692
|
+
};
|
|
1693
|
+
content: {
|
|
1694
|
+
"application/json": {
|
|
1695
|
+
message?: string;
|
|
1696
|
+
success?: boolean;
|
|
1697
|
+
content?: {
|
|
1698
|
+
/** @enum {unknown} */
|
|
1699
|
+
inventory_status?: "fulfilled" | "partially-fulfilled" | "not-fulfilled";
|
|
1700
|
+
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
1701
|
+
recommended_warehouses?: {
|
|
1702
|
+
id?: string;
|
|
1703
|
+
name?: string;
|
|
1704
|
+
/** @enum {unknown} */
|
|
1705
|
+
inventory_status?: "fulfilled" | "partially-fulfilled" | "not-fulfilled";
|
|
1706
|
+
}[];
|
|
1707
|
+
inventory_detail?: {
|
|
1708
|
+
sku?: string;
|
|
1709
|
+
total_quantity?: number;
|
|
1710
|
+
warehouses?: {
|
|
1711
|
+
warehouse_id?: string;
|
|
1712
|
+
warehouse_name?: string;
|
|
1713
|
+
quantity?: number;
|
|
1714
|
+
}[];
|
|
1715
|
+
}[];
|
|
1716
|
+
allowed_action?: string[];
|
|
1717
|
+
};
|
|
1718
|
+
};
|
|
1719
|
+
};
|
|
1720
|
+
};
|
|
1721
|
+
};
|
|
1722
|
+
};
|
|
1723
|
+
"pos-refund-shortfall": {
|
|
1724
|
+
parameters: {
|
|
1725
|
+
query?: never;
|
|
1726
|
+
header?: never;
|
|
1727
|
+
path: {
|
|
1728
|
+
/** @description Order Number */
|
|
1729
|
+
order_number: string;
|
|
1730
|
+
};
|
|
1731
|
+
cookie?: never;
|
|
1732
|
+
};
|
|
1733
|
+
requestBody?: {
|
|
1734
|
+
content: {
|
|
1735
|
+
"application/json": {
|
|
1736
|
+
items: {
|
|
1737
|
+
sku: string;
|
|
1738
|
+
quantity: number;
|
|
1739
|
+
/** @default 0 */
|
|
1740
|
+
free_quantity?: number;
|
|
1741
|
+
}[];
|
|
1742
|
+
/** @enum {unknown} */
|
|
1743
|
+
payment_method: "original-payment-mode" | "bank-transfer";
|
|
1744
|
+
/** @description required if payment_method = bank-transfer */
|
|
1745
|
+
bank_account_id?: string | null;
|
|
1746
|
+
};
|
|
1747
|
+
};
|
|
1748
|
+
};
|
|
1749
|
+
responses: {
|
|
1750
|
+
/** @description OK */
|
|
1751
|
+
200: {
|
|
1752
|
+
headers: {
|
|
1753
|
+
[name: string]: unknown;
|
|
1754
|
+
};
|
|
1755
|
+
content: {
|
|
1756
|
+
"application/json": {
|
|
1757
|
+
message?: string;
|
|
1758
|
+
success?: boolean;
|
|
1759
|
+
};
|
|
1760
|
+
};
|
|
1761
|
+
};
|
|
1762
|
+
};
|
|
1763
|
+
};
|
|
1764
|
+
"pos-get-shipment-detail": {
|
|
1765
|
+
parameters: {
|
|
1766
|
+
query?: never;
|
|
1767
|
+
header?: never;
|
|
1768
|
+
path: {
|
|
1769
|
+
/** @description Shipment reference number */
|
|
1770
|
+
reference_number: string;
|
|
1771
|
+
};
|
|
1772
|
+
cookie?: never;
|
|
1773
|
+
};
|
|
1774
|
+
requestBody?: never;
|
|
1775
|
+
responses: {
|
|
1776
|
+
/** @description OK */
|
|
1777
|
+
200: {
|
|
1778
|
+
headers: {
|
|
1779
|
+
[name: string]: unknown;
|
|
1780
|
+
};
|
|
1781
|
+
content: {
|
|
1782
|
+
"application/json": {
|
|
1783
|
+
message?: string;
|
|
1784
|
+
success?: boolean;
|
|
1785
|
+
content?: {
|
|
1786
|
+
shipment?: components["schemas"]["ShipmentDetail"];
|
|
1787
|
+
};
|
|
1788
|
+
};
|
|
1789
|
+
};
|
|
1790
|
+
};
|
|
1791
|
+
};
|
|
1792
|
+
};
|
|
1793
|
+
"pos-get-shipment-invoice": {
|
|
1794
|
+
parameters: {
|
|
1795
|
+
query?: {
|
|
1796
|
+
/** @description Response data format */
|
|
1797
|
+
format?: "json" | "pdf";
|
|
1798
|
+
};
|
|
1799
|
+
header?: never;
|
|
1800
|
+
path: {
|
|
1801
|
+
/** @description Shipment reference number */
|
|
1802
|
+
reference_number: string;
|
|
1803
|
+
};
|
|
1804
|
+
cookie?: never;
|
|
1805
|
+
};
|
|
1806
|
+
requestBody?: never;
|
|
1807
|
+
responses: {
|
|
1808
|
+
/** @description OK */
|
|
1809
|
+
200: {
|
|
1810
|
+
headers: {
|
|
1811
|
+
[name: string]: unknown;
|
|
1812
|
+
};
|
|
1813
|
+
content: {
|
|
1814
|
+
"application/json": {
|
|
1815
|
+
message?: string;
|
|
1816
|
+
success?: boolean;
|
|
1817
|
+
content?: {
|
|
1818
|
+
invoice?: components["schemas"]["InvoiceDetail"];
|
|
1819
|
+
};
|
|
1820
|
+
};
|
|
1821
|
+
"application/pdf": Record<string, never>;
|
|
1822
|
+
};
|
|
1823
|
+
};
|
|
1824
|
+
};
|
|
1825
|
+
};
|
|
1826
|
+
"pos-update-shipment": {
|
|
1827
|
+
parameters: {
|
|
1828
|
+
query?: never;
|
|
1829
|
+
header?: never;
|
|
1830
|
+
path: {
|
|
1831
|
+
/** @description Shipment reference number */
|
|
1832
|
+
reference_number: string;
|
|
1833
|
+
};
|
|
1834
|
+
cookie?: never;
|
|
1835
|
+
};
|
|
1836
|
+
requestBody?: {
|
|
1837
|
+
content: {
|
|
1838
|
+
"application/json": {
|
|
1839
|
+
status?: string;
|
|
1840
|
+
warehouse_id?: string;
|
|
1841
|
+
awb_no?: string;
|
|
1842
|
+
courier_company_name?: string;
|
|
1843
|
+
shipping_label_url?: string;
|
|
1844
|
+
tracking_url?: string;
|
|
1845
|
+
manual_shipping_charges?: number;
|
|
1846
|
+
/** Format: date-time */
|
|
1847
|
+
eta_delivery?: string;
|
|
1848
|
+
/** Format: date-time */
|
|
1849
|
+
shipped_date?: string;
|
|
1850
|
+
/** Format: date-time */
|
|
1851
|
+
out_for_delivery_date?: string;
|
|
1852
|
+
/** Format: date-time */
|
|
1853
|
+
delivered_date?: string;
|
|
1854
|
+
};
|
|
1855
|
+
};
|
|
1856
|
+
};
|
|
1857
|
+
responses: {
|
|
1858
|
+
/** @description OK */
|
|
1859
|
+
200: {
|
|
1860
|
+
headers: {
|
|
1861
|
+
[name: string]: unknown;
|
|
1862
|
+
};
|
|
1863
|
+
content: {
|
|
1864
|
+
"application/json": {
|
|
1865
|
+
message?: string;
|
|
1866
|
+
success?: boolean;
|
|
1867
|
+
content?: {
|
|
1868
|
+
shipment?: components["schemas"]["ShipmentDetail"];
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
};
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1874
|
+
};
|
|
1875
|
+
}
|
|
1876
|
+
//#endregion
|
|
1877
|
+
//#region src/types/admin-pos-api-types.d.ts
|
|
1878
|
+
type AppliedCoupon = components["schemas"]["AppliedCoupon"];
|
|
1879
|
+
type AppliedPromotion = components["schemas"]["AppliedPromotion"];
|
|
1880
|
+
type BankTransfer = components["schemas"]["BankTransfer"];
|
|
1881
|
+
type BusinessInfo = components["schemas"]["BusinessInfo"];
|
|
1882
|
+
type CardPayment = components["schemas"]["CardPayment"];
|
|
1883
|
+
type Customer = components["schemas"]["Customer"];
|
|
1884
|
+
type CustomerAddress = components["schemas"]["CustomerAddress"];
|
|
1885
|
+
type CustomerDetail = components["schemas"]["CustomerDetail"];
|
|
1886
|
+
type CustomerInfo = components["schemas"]["CustomerInfo"];
|
|
1887
|
+
type CustomerLoyalty = components["schemas"]["CustomerLoyalty"];
|
|
1888
|
+
type CustomerSegment = components["schemas"]["CustomerSegment"];
|
|
1889
|
+
type InventoryActivity = components["schemas"]["InventoryActivity"];
|
|
1890
|
+
type InventoryDetail = components["schemas"]["InventoryDetail"];
|
|
1891
|
+
type Invoice = components["schemas"]["Invoice"];
|
|
1892
|
+
type InvoiceDetail = components["schemas"]["InvoiceDetail"];
|
|
1893
|
+
type InvoiceItem = components["schemas"]["InvoiceItem"];
|
|
1894
|
+
type ItemWiseInventory = components["schemas"]["ItemWiseInventory"];
|
|
1895
|
+
type LotBatchWiseInventory = components["schemas"]["LotBatchWiseInventory"];
|
|
1896
|
+
type LoyaltyPointPayment = components["schemas"]["LoyaltyPointPayment"];
|
|
1897
|
+
type NetbankingPayment = components["schemas"]["NetbankingPayment"];
|
|
1898
|
+
type NotificationChannelPreferences = components["schemas"]["NotificationChannelPreferences"];
|
|
1899
|
+
type NotificationPreferences = components["schemas"]["NotificationPreferences"];
|
|
1900
|
+
type OpeningHours = components["schemas"]["OpeningHours"];
|
|
1901
|
+
type Order = components["schemas"]["Order"];
|
|
1902
|
+
type OrderActivity = components["schemas"]["OrderActivity"];
|
|
1903
|
+
type OrderDetail = components["schemas"]["OrderDetail"];
|
|
1904
|
+
type OrderItem = components["schemas"]["OrderItem"];
|
|
1905
|
+
type OrderList = components["schemas"]["OrderList"];
|
|
1906
|
+
type OrderPayment = components["schemas"]["OrderPayment"];
|
|
1907
|
+
type OrderPaymentInfo = components["schemas"]["OrderPaymentInfo"];
|
|
1908
|
+
type OrderReceiptJsonFormat = components["schemas"]["OrderReceiptJsonFormat"];
|
|
1909
|
+
type OrderShipment = components["schemas"]["OrderShipment"];
|
|
1910
|
+
type Pagination = components["schemas"]["Pagination"];
|
|
1911
|
+
type PartialCollectAndDelivery = components["schemas"]["PartialCollectAndDelivery"];
|
|
1912
|
+
type Shipment = components["schemas"]["Shipment"];
|
|
1913
|
+
type ShipmentBox = components["schemas"]["ShipmentBox"];
|
|
1914
|
+
type ShipmentDetail = components["schemas"]["ShipmentDetail"];
|
|
1915
|
+
type ShipmentInfo = components["schemas"]["ShipmentInfo"];
|
|
1916
|
+
type ShipmentItem = components["schemas"]["ShipmentItem"];
|
|
1917
|
+
type ShipmentList = components["schemas"]["ShipmentList"];
|
|
1918
|
+
type ShipmentPackaging = components["schemas"]["ShipmentPackaging"];
|
|
1919
|
+
type ShipmentProgression = components["schemas"]["ShipmentProgression"];
|
|
1920
|
+
type UpiPayment = components["schemas"]["UpiPayment"];
|
|
1921
|
+
type WalletPayment = components["schemas"]["WalletPayment"];
|
|
1922
|
+
type Warehouse = components["schemas"]["Warehouse"];
|
|
1923
|
+
type WarehouseBasicDetail = components["schemas"]["WarehouseBasicDetail"];
|
|
1924
|
+
type WarehouseWiseInventory = components["schemas"]["WarehouseWiseInventory"];
|
|
1925
|
+
type PosListInventoryResponse = paths["/pos/catalog/inventories"]["get"]["responses"][200]["content"]["application/json"];
|
|
1926
|
+
type PosListInventoryContent = PosListInventoryResponse["content"];
|
|
1927
|
+
type PosListInventoryQuery = paths["/pos/catalog/inventories"]["get"]["parameters"]["query"];
|
|
1928
|
+
type PosListInventoryActivityResponse = paths["/pos/catalog/inventories/activites"]["get"]["responses"][200]["content"]["application/json"];
|
|
1929
|
+
type PosListInventoryActivityContent = PosListInventoryActivityResponse["content"];
|
|
1930
|
+
type PosListInventoryActivityQuery = paths["/pos/catalog/inventories/activites"]["get"]["parameters"]["query"];
|
|
1931
|
+
type PosListInventoryDetailResponse = paths["/pos/catalog/inventories/detail"]["get"]["responses"][200]["content"]["application/json"];
|
|
1932
|
+
type PosListInventoryDetailContent = PosListInventoryDetailResponse["content"];
|
|
1933
|
+
type PosListInventoryDetailQuery = paths["/pos/catalog/inventories/detail"]["get"]["parameters"]["query"];
|
|
1934
|
+
type PosListCustomersResponse = paths["/pos/customers"]["get"]["responses"][200]["content"]["application/json"];
|
|
1935
|
+
type PosListCustomersContent = PosListCustomersResponse["content"];
|
|
1936
|
+
type PosListCustomersQuery = paths["/pos/customers"]["get"]["parameters"]["query"];
|
|
1937
|
+
type PosGetCustomerDetailResponse = paths["/pos/customers/{id}"]["get"]["responses"][200]["content"]["application/json"];
|
|
1938
|
+
type PosGetCustomerDetailContent = PosGetCustomerDetailResponse["content"];
|
|
1939
|
+
type PosGetCustomerDetailPathParams = paths["/pos/customers/{id}"]["get"]["parameters"]["path"];
|
|
1940
|
+
type PosListOrdersResponse = paths["/pos/orders"]["get"]["responses"][200]["content"]["application/json"];
|
|
1941
|
+
type PosListOrdersContent = PosListOrdersResponse["content"];
|
|
1942
|
+
type PosListOrdersQuery = paths["/pos/orders"]["get"]["parameters"]["query"];
|
|
1943
|
+
type PosGetOrderDetailResponse = paths["/pos/orders/{order_number}"]["get"]["responses"][200]["content"]["application/json"];
|
|
1944
|
+
type PosGetOrderDetailContent = PosGetOrderDetailResponse["content"];
|
|
1945
|
+
type PosGetOrderDetailPathParams = paths["/pos/orders/{order_number}"]["get"]["parameters"]["path"];
|
|
1946
|
+
type PosListOrderActivityResponse = paths["/pos/orders/{order_number}/activity"]["get"]["responses"][200]["content"]["application/json"];
|
|
1947
|
+
type PosListOrderActivityContent = PosListOrderActivityResponse["content"];
|
|
1948
|
+
type PosListOrderActivityPathParams = paths["/pos/orders/{order_number}/activity"]["get"]["parameters"]["path"];
|
|
1949
|
+
type PosGetOrderInvoiceResponse = paths["/pos/orders/{order_number}/invoice"]["get"]["responses"][200]["content"]["application/json"];
|
|
1950
|
+
type PosGetOrderInvoiceContent = PosGetOrderInvoiceResponse["content"];
|
|
1951
|
+
type PosGetOrderInvoiceQuery = paths["/pos/orders/{order_number}/invoice"]["get"]["parameters"]["query"];
|
|
1952
|
+
type PosGetOrderInvoicePathParams = paths["/pos/orders/{order_number}/invoice"]["get"]["parameters"]["path"];
|
|
1953
|
+
type PosGetOrderReceiptResponse = paths["/pos/orders/{order_number}/receipt"]["get"]["responses"][200]["content"]["application/json"];
|
|
1954
|
+
type PosGetOrderReceiptContent = PosGetOrderReceiptResponse["content"];
|
|
1955
|
+
type PosGetOrderReceiptQuery = paths["/pos/orders/{order_number}/receipt"]["get"]["parameters"]["query"];
|
|
1956
|
+
type PosGetOrderReceiptPathParams = paths["/pos/orders/{order_number}/receipt"]["get"]["parameters"]["path"];
|
|
1957
|
+
type PosListOrderShipmentsResponse = paths["/pos/orders/{order_number}/shipments"]["get"]["responses"][200]["content"]["application/json"];
|
|
1958
|
+
type PosListOrderShipmentsContent = PosListOrderShipmentsResponse["content"];
|
|
1959
|
+
type PosListOrderShipmentsPathParams = paths["/pos/orders/{order_number}/shipments"]["get"]["parameters"]["path"];
|
|
1960
|
+
type PosListShipmentsResponse = paths["/pos/shipping/shipments"]["get"]["responses"][200]["content"]["application/json"];
|
|
1961
|
+
type PosListShipmentsContent = PosListShipmentsResponse["content"];
|
|
1962
|
+
type PosListShipmentsQuery = paths["/pos/shipping/shipments"]["get"]["parameters"]["query"];
|
|
1963
|
+
type PosCheckOrderInventoryResponse = paths["/pos/shipping/shipments/{order_number}/check-inventory"]["get"]["responses"][200]["content"]["application/json"];
|
|
1964
|
+
type PosCheckOrderInventoryContent = PosCheckOrderInventoryResponse["content"];
|
|
1965
|
+
type PosCheckOrderInventoryPathParams = paths["/pos/shipping/shipments/{order_number}/check-inventory"]["get"]["parameters"]["path"];
|
|
1966
|
+
type PosRefundShortfallResponse = paths["/pos/shipping/shipments/{order_number}/refund-shortfall"]["post"]["responses"][200]["content"]["application/json"];
|
|
1967
|
+
type PosRefundShortfallPathParams = paths["/pos/shipping/shipments/{order_number}/refund-shortfall"]["post"]["parameters"]["path"];
|
|
1968
|
+
type PosRefundShortfallBody = NonNullable<paths["/pos/shipping/shipments/{order_number}/refund-shortfall"]["post"]["requestBody"]>["content"]["application/json"];
|
|
1969
|
+
type PosGetShipmentDetailResponse = paths["/pos/shipping/shipments/{reference_number}"]["get"]["responses"][200]["content"]["application/json"];
|
|
1970
|
+
type PosGetShipmentDetailContent = PosGetShipmentDetailResponse["content"];
|
|
1971
|
+
type PosGetShipmentDetailPathParams = paths["/pos/shipping/shipments/{reference_number}"]["get"]["parameters"]["path"];
|
|
1972
|
+
type PosGetShipmentInvoiceResponse = paths["/pos/shipping/shipments/{reference_number}/invoice"]["get"]["responses"][200]["content"]["application/json"];
|
|
1973
|
+
type PosGetShipmentInvoiceContent = PosGetShipmentInvoiceResponse["content"];
|
|
1974
|
+
type PosGetShipmentInvoiceQuery = paths["/pos/shipping/shipments/{reference_number}/invoice"]["get"]["parameters"]["query"];
|
|
1975
|
+
type PosGetShipmentInvoicePathParams = paths["/pos/shipping/shipments/{reference_number}/invoice"]["get"]["parameters"]["path"];
|
|
1976
|
+
type PosUpdateShipmentResponse = paths["/pos/shipping/shipments/{reference_number}/manual-update"]["put"]["responses"][200]["content"]["application/json"];
|
|
1977
|
+
type PosUpdateShipmentContent = PosUpdateShipmentResponse["content"];
|
|
1978
|
+
type PosUpdateShipmentPathParams = paths["/pos/shipping/shipments/{reference_number}/manual-update"]["put"]["parameters"]["path"];
|
|
1979
|
+
type PosUpdateShipmentBody = NonNullable<paths["/pos/shipping/shipments/{reference_number}/manual-update"]["put"]["requestBody"]>["content"]["application/json"];
|
|
1980
|
+
//#endregion
|
|
1981
|
+
export { AppliedCoupon, AppliedPromotion, BankTransfer, BusinessInfo, CardPayment, Customer, CustomerAddress, CustomerDetail, CustomerInfo, CustomerLoyalty, CustomerSegment, InventoryActivity, InventoryDetail, Invoice, InvoiceDetail, InvoiceItem, ItemWiseInventory, LotBatchWiseInventory, LoyaltyPointPayment, NetbankingPayment, NotificationChannelPreferences, NotificationPreferences, OpeningHours, Order, OrderActivity, OrderDetail, OrderItem, OrderList, OrderPayment, OrderPaymentInfo, OrderReceiptJsonFormat, OrderShipment, Pagination, PartialCollectAndDelivery, PosCheckOrderInventoryContent, PosCheckOrderInventoryPathParams, PosCheckOrderInventoryResponse, PosGetCustomerDetailContent, PosGetCustomerDetailPathParams, PosGetCustomerDetailResponse, PosGetOrderDetailContent, PosGetOrderDetailPathParams, PosGetOrderDetailResponse, PosGetOrderInvoiceContent, PosGetOrderInvoicePathParams, PosGetOrderInvoiceQuery, PosGetOrderInvoiceResponse, PosGetOrderReceiptContent, PosGetOrderReceiptPathParams, PosGetOrderReceiptQuery, PosGetOrderReceiptResponse, PosGetShipmentDetailContent, PosGetShipmentDetailPathParams, PosGetShipmentDetailResponse, PosGetShipmentInvoiceContent, PosGetShipmentInvoicePathParams, PosGetShipmentInvoiceQuery, PosGetShipmentInvoiceResponse, PosListCustomersContent, PosListCustomersQuery, PosListCustomersResponse, PosListInventoryActivityContent, PosListInventoryActivityQuery, PosListInventoryActivityResponse, PosListInventoryContent, PosListInventoryDetailContent, PosListInventoryDetailQuery, PosListInventoryDetailResponse, PosListInventoryQuery, PosListInventoryResponse, PosListOrderActivityContent, PosListOrderActivityPathParams, PosListOrderActivityResponse, PosListOrderShipmentsContent, PosListOrderShipmentsPathParams, PosListOrderShipmentsResponse, PosListOrdersContent, PosListOrdersQuery, PosListOrdersResponse, PosListShipmentsContent, PosListShipmentsQuery, PosListShipmentsResponse, PosRefundShortfallBody, PosRefundShortfallPathParams, PosRefundShortfallResponse, PosUpdateShipmentBody, PosUpdateShipmentContent, PosUpdateShipmentPathParams, PosUpdateShipmentResponse, Shipment, ShipmentBox, ShipmentDetail, ShipmentInfo, ShipmentItem, ShipmentList, ShipmentPackaging, ShipmentProgression, UpiPayment, WalletPayment, Warehouse, WarehouseBasicDetail, WarehouseWiseInventory, type components, type operations, type paths };
|