@commercengine/pos 0.4.5 → 0.5.0

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