@commercengine/pos 0.4.5 → 0.4.6

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.
@@ -9,8 +9,8 @@ type $Read<T> = {
9
9
  type $Write<T> = {
10
10
  readonly $write: T;
11
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;
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
14
  interface paths {
15
15
  "/pos/catalog/inventories": {
16
16
  parameters: {
@@ -380,7 +380,8 @@ interface components {
380
380
  * @description Details about an active coupon applied to a cart/order
381
381
  */
382
382
  AppliedCoupon: {
383
- coupon_id: string; /** @enum {unknown} */
383
+ coupon_id: string;
384
+ /** @enum {unknown} */
384
385
  coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
385
386
  savings: number;
386
387
  product_id: string | null;
@@ -393,7 +394,8 @@ interface components {
393
394
  * @description Details about an active promotion applied to a cart/order
394
395
  */
395
396
  AppliedPromotion: {
396
- promotion_id: string; /** @enum {unknown} */
397
+ promotion_id: string;
398
+ /** @enum {unknown} */
397
399
  promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
398
400
  savings: number;
399
401
  product_id: string | null;
@@ -414,7 +416,8 @@ interface components {
414
416
  */
415
417
  bank_account_number?: string;
416
418
  bank_name?: string;
417
- }; /** BusinessInfo */
419
+ };
420
+ /** BusinessInfo */
418
421
  BusinessInfo: {
419
422
  name?: string;
420
423
  business_type?: string;
@@ -431,9 +434,11 @@ interface components {
431
434
  * @description masked card number
432
435
  * e.g. ************1111
433
436
  */
434
- card_number?: string; /** @enum {unknown} */
437
+ card_number?: string;
438
+ /** @enum {unknown} */
435
439
  card_type?: "Visa" | "Master Card" | "Rupay";
436
- }; /** CheckInventoryResponse */
440
+ };
441
+ /** CheckInventoryResponse */
437
442
  CheckInventoryResponse: {
438
443
  allowed_actions?: components["schemas"]["InventoryAction"][];
439
444
  shipment_items?: components["schemas"]["ShipmentItem"][];
@@ -461,27 +466,33 @@ interface components {
461
466
  name?: string;
462
467
  inventory_status?: components["schemas"]["InventoryStatus"];
463
468
  }[];
464
- }; /** CollectInStoreFulfillment */
469
+ };
470
+ /** CollectInStoreFulfillment */
465
471
  CollectInStoreFulfillment: {
466
472
  /**
467
473
  * @description discriminator enum property added by openapi-typescript
468
474
  * @enum {string}
469
475
  */
470
- fulfillment_type: "collect-in-store"; /** @enum {string} */
476
+ fulfillment_type: "collect-in-store";
477
+ /** @enum {string} */
471
478
  preference_type?: $Read<"user" | "auto">;
472
479
  pickup_location_id: string;
473
480
  pickup_location_name?: $Read<string>;
474
- }; /** Customer */
481
+ };
482
+ /** Customer */
475
483
  Customer: components["schemas"]["CustomerInfo"] & {
476
484
  business?: components["schemas"]["BusinessInfo"];
477
485
  segments?: components["schemas"]["CustomerSegment"][];
478
486
  address?: components["schemas"]["CustomerAddress"];
479
- }; /** CustomerAddress */
487
+ };
488
+ /** CustomerAddress */
480
489
  CustomerAddress: {
481
490
  id?: $Read<string>;
482
491
  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. */
492
+ last_name?: string | null;
493
+ /** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
494
+ country_code?: string;
495
+ /** @description 10 digit phone number without country code. */
485
496
  phone: string;
486
497
  email: string;
487
498
  address_line1: string;
@@ -489,21 +500,27 @@ interface components {
489
500
  landmark?: string | null;
490
501
  pincode: string;
491
502
  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. */
503
+ state: string;
504
+ /** @enum {unknown} */
505
+ country: "India";
506
+ /** @description Use in shipping details only for third party. */
507
+ gstin?: string | null;
508
+ /** @description Use in shipping details only for third party. */
495
509
  business_name?: string | null;
496
510
  is_phone_verified?: $Read<boolean>;
497
511
  is_email_verified?: $Read<boolean>;
498
512
  is_default_shipping?: boolean;
499
513
  is_default_billing?: boolean;
500
- }; /** CustomerDetail */
514
+ };
515
+ /** CustomerDetail */
501
516
  CustomerDetail: components["schemas"]["Customer"] & {
502
517
  loyalty?: components["schemas"]["CustomerLoyalty"];
503
518
  notification_preferences?: components["schemas"]["NotificationPreferences"];
504
- }; /** CustomerInfo */
519
+ };
520
+ /** CustomerInfo */
505
521
  CustomerInfo: {
506
- /** @description user id */id?: $Read<string>;
522
+ /** @description user id */
523
+ id?: $Read<string>;
507
524
  first_name?: string;
508
525
  last_name?: string;
509
526
  full_name?: $Read<string>;
@@ -514,22 +531,33 @@ interface components {
514
531
  is_phone_verified?: $Read<boolean>;
515
532
  is_email_verified?: $Read<boolean>;
516
533
  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 */
534
+ status?: components["schemas"]["CustomerStatus"];
535
+ /** Format: date-time */
536
+ created_at?: $Read<string>;
537
+ /** Format: date-time */
538
+ modified_at?: $Read<string>;
539
+ /** Format: date-time */
520
540
  last_seen?: $Read<string>;
521
541
  kyc_status?: components["schemas"]["KycStatus"];
522
542
  is_verified?: $Read<boolean>;
523
543
  tags?: string[];
524
- }; /** CustomerLoyalty */
544
+ };
545
+ /** CustomerLoyalty */
525
546
  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. */
547
+ membership_number?: string;
548
+ /** @description total points earned within the current loyalty program. */
549
+ points_earned?: number;
550
+ /** @description total points redeemed within the current loyalty program. */
551
+ points_redeemed?: number;
552
+ /** @description total points available. */
553
+ points_balance?: number;
554
+ /** @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. */
555
+ total_spent?: number;
556
+ /** @description The total number of completed orders counted in the current loyalty program. */
557
+ total_orders?: number;
558
+ /** @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. */
559
+ lifetime_spent?: number;
560
+ /** @description The total number of completed orders across all time, regardless of loyalty program. */
533
561
  lifetime_orders?: number;
534
562
  /**
535
563
  * Format: date-time
@@ -556,40 +584,49 @@ interface components {
556
584
  total_spent_threshold?: number | null;
557
585
  total_orders_threshold?: number | null;
558
586
  };
559
- name?: string; /** @enum {string} */
560
- renewal_type?: "yearly" | "never" | "custom"; /** @enum {string} */
587
+ name?: string;
588
+ /** @enum {string} */
589
+ renewal_type?: "yearly" | "never" | "custom";
590
+ /** @enum {string} */
561
591
  tier_upgrade_criteria?: "total-spent" | "total-orders" | "custom";
562
- }; /** CustomerSegment */
592
+ };
593
+ /** CustomerSegment */
563
594
  CustomerSegment: {
564
595
  id?: string;
565
596
  name?: string;
566
- }; /** @enum {unknown} */
567
- CustomerStatus: "active" | "inactive"; /** DeliveryFulfillment */
597
+ };
598
+ /** @enum {unknown} */
599
+ CustomerStatus: "active" | "inactive";
600
+ /** DeliveryFulfillment */
568
601
  DeliveryFulfillment: {
569
602
  /**
570
603
  * @description discriminator enum property added by openapi-typescript
571
604
  * @enum {string}
572
605
  */
573
- fulfillment_type: "delivery"; /** @enum {string} */
606
+ fulfillment_type: "delivery";
607
+ /** @enum {string} */
574
608
  preference_type?: $Read<"user" | "auto">;
575
609
  shipping_provider_id: string | null;
576
610
  shipping_provider_name?: $Read<string | null>;
577
611
  courier_company_id?: string | null;
578
612
  courier_company_name?: $Read<string | null>;
579
- }; /** FulfillmentItem */
613
+ };
614
+ /** FulfillmentItem */
580
615
  FulfillmentItem: {
581
616
  product_id: string;
582
617
  product_name: $Read<string>;
583
618
  variant_id: string | null;
584
619
  variant_name: $Read<string | null>;
585
620
  quantity: number;
586
- }; /** FulfillmentPreference */
621
+ };
622
+ /** FulfillmentPreference */
587
623
  FulfillmentPreference: components["schemas"]["CollectInStoreFulfillment"] | components["schemas"]["DeliveryFulfillment"] | components["schemas"]["PartialCollectAndDelivery"];
588
624
  /**
589
625
  * InventoryAction
590
626
  * @enum {unknown}
591
627
  */
592
- InventoryAction: "create-shipment" | "refund-shortfall" | "wait-for-inventory" | "reject-order"; /** InventoryActivity */
628
+ InventoryAction: "create-shipment" | "refund-shortfall" | "wait-for-inventory" | "reject-order";
629
+ /** InventoryActivity */
593
630
  InventoryActivity: {
594
631
  product_id?: string;
595
632
  product_name?: string;
@@ -597,29 +634,39 @@ interface components {
597
634
  variant_name?: string;
598
635
  sku?: string;
599
636
  warehouse_id?: string;
600
- warehouse?: components["schemas"]["WarehouseBasicDetail"]; /** @enum {unknown} */
637
+ warehouse?: components["schemas"]["WarehouseBasicDetail"];
638
+ /** @enum {unknown} */
601
639
  activity_type?: "add" | "reserve" | "reduce" | "adjust" | "update";
602
640
  quantity?: number;
603
641
  reason?: string;
604
- lot_batch?: string; /** Format: date */
605
- mfg_date?: string; /** Format: date */
642
+ lot_batch?: string;
643
+ /** Format: date */
644
+ mfg_date?: string;
645
+ /** Format: date */
606
646
  exp_date?: string;
607
- manufacturer?: string; /** Format: date-time */
608
- created_at?: string; /** Format: date-time */
647
+ manufacturer?: string;
648
+ /** Format: date-time */
649
+ created_at?: string;
650
+ /** Format: date-time */
609
651
  modified_at?: string;
610
- }; /** InventoryDetail */
652
+ };
653
+ /** InventoryDetail */
611
654
  InventoryDetail: components["schemas"]["ItemWiseInventory"] & {
612
655
  details?: components["schemas"]["WarehouseWiseInventory"][];
613
- }; /** @enum {unknown} */
656
+ };
657
+ /** @enum {unknown} */
614
658
  InventoryStatus: "fulfilled" | "partially-fulfilled" | "not-fulfilled";
615
659
  /**
616
660
  * Invoice
617
661
  * @description Invoice model
618
662
  */
619
663
  Invoice: {
620
- invoice_number?: string; /** Format: date-time */
621
- invoice_date?: string; /** @description Invoice Reference Number */
622
- irn_number?: string; /** @description Acknowledgement Number */
664
+ invoice_number?: string;
665
+ /** Format: date-time */
666
+ invoice_date?: string;
667
+ /** @description Invoice Reference Number */
668
+ irn_number?: string;
669
+ /** @description Acknowledgement Number */
623
670
  ack_number?: string;
624
671
  /**
625
672
  * Format: date-time
@@ -644,8 +691,10 @@ interface components {
644
691
  igst?: number;
645
692
  cgst?: number;
646
693
  sgst?: number;
647
- }[]; /** Format: date-time */
648
- created_at?: string; /** Format: date-time */
694
+ }[];
695
+ /** Format: date-time */
696
+ created_at?: string;
697
+ /** Format: date-time */
649
698
  modified_at?: string;
650
699
  };
651
700
  /**
@@ -673,7 +722,8 @@ interface components {
673
722
  batch_number?: string;
674
723
  expiry?: string;
675
724
  amount?: number;
676
- }; /** ItemWiseInventory */
725
+ };
726
+ /** ItemWiseInventory */
677
727
  ItemWiseInventory: {
678
728
  product_id?: string;
679
729
  product_name?: string;
@@ -682,19 +732,29 @@ interface components {
682
732
  sku?: string;
683
733
  track_quantity?: boolean;
684
734
  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 */
735
+ track_lot_batch?: boolean;
736
+ /** Format: decimal */
737
+ low_stock_threshold?: number;
738
+ /** Format: decimal */
739
+ received_quantity?: number;
740
+ /** Format: decimal */
741
+ reserved_quantity?: number;
742
+ /** Format: decimal */
743
+ sold_quantity?: number;
744
+ /** Format: decimal */
745
+ adjusted_quantity?: number;
746
+ /** Format: decimal */
691
747
  stock_quantity?: number;
692
748
  images?: components["schemas"]["ProductImage"][];
693
- }; /** @enum {unknown} */
694
- KycStatus: "pending" | "approved" | "rejected"; /** LotBatchWiseInventory */
749
+ };
750
+ /** @enum {unknown} */
751
+ KycStatus: "pending" | "approved" | "rejected";
752
+ /** LotBatchWiseInventory */
695
753
  LotBatchWiseInventory: components["schemas"]["ItemWiseInventory"] & {
696
- lot_batch?: string; /** Format: date */
697
- mfg_date?: string; /** Format: date */
754
+ lot_batch?: string;
755
+ /** Format: date */
756
+ mfg_date?: string;
757
+ /** Format: date */
698
758
  exp_date?: string;
699
759
  manufacturer?: string;
700
760
  };
@@ -736,45 +796,65 @@ interface components {
736
796
  * @description Set channel preferences for each type of
737
797
  */
738
798
  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. */
799
+ /** @description These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities. */
800
+ transactional?: components["schemas"]["NotificationChannelPreferences"];
801
+ /** @description These notifications aim to engage users with promotional content and enhance their overall experience with the platform. */
802
+ promotional?: components["schemas"]["NotificationChannelPreferences"];
803
+ /** @description These notifications are often sent periodically as part of a subscription service. */
741
804
  newsletter?: components["schemas"]["NotificationChannelPreferences"];
742
805
  };
743
806
  OpeningHours: {
744
807
  monday: {
745
- /** Format: time */opening_time: string; /** Format: time */
808
+ /** Format: time */
809
+ opening_time: string;
810
+ /** Format: time */
746
811
  closing_time: string;
747
812
  } | null;
748
813
  tuesday: {
749
- /** Format: time */opening_time: string; /** Format: time */
814
+ /** Format: time */
815
+ opening_time: string;
816
+ /** Format: time */
750
817
  closing_time: string;
751
818
  } | null;
752
819
  wednesday: {
753
- /** Format: time */opening_time: string; /** Format: time */
820
+ /** Format: time */
821
+ opening_time: string;
822
+ /** Format: time */
754
823
  closing_time: string;
755
824
  } | null;
756
825
  thursday: {
757
- /** Format: time */opening_time: string; /** Format: time */
826
+ /** Format: time */
827
+ opening_time: string;
828
+ /** Format: time */
758
829
  closing_time: string;
759
830
  } | null;
760
831
  friday: {
761
- /** Format: time */opening_time: string; /** Format: time */
832
+ /** Format: time */
833
+ opening_time: string;
834
+ /** Format: time */
762
835
  closing_time: string;
763
836
  } | null;
764
837
  saturday: {
765
- /** Format: time */opening_time: string; /** Format: time */
838
+ /** Format: time */
839
+ opening_time: string;
840
+ /** Format: time */
766
841
  closing_time: string;
767
842
  } | null;
768
843
  sunday: {
769
- /** Format: time */opening_time: string; /** Format: time */
844
+ /** Format: time */
845
+ opening_time: string;
846
+ /** Format: time */
770
847
  closing_time: string;
771
848
  } | null;
772
- }; /** Order */
849
+ };
850
+ /** Order */
773
851
  Order: {
774
- order_number?: string; /** Format: date-time */
852
+ order_number?: string;
853
+ /** Format: date-time */
775
854
  order_date?: string;
776
855
  status?: components["schemas"]["OrderStatus"];
777
- payment_status?: components["schemas"]["PaymentStatus"]; /** Format: date-time */
856
+ payment_status?: components["schemas"]["PaymentStatus"];
857
+ /** Format: date-time */
778
858
  payment_success_date?: string;
779
859
  customer_id?: string;
780
860
  customer_email?: string | null;
@@ -783,19 +863,29 @@ interface components {
783
863
  is_promotion_applied?: boolean;
784
864
  promotion_discount_amount?: number | null;
785
865
  is_coupon_applied?: boolean;
786
- coupon_code?: string | null; /** Format: double */
866
+ coupon_code?: string | null;
867
+ /** Format: double */
787
868
  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 */
869
+ on_subscription?: boolean;
870
+ /** Format: double */
871
+ subtotal?: number;
872
+ /** Format: double */
873
+ item_total_tax?: number;
874
+ /** Format: double */
875
+ subtotal_including_tax?: number;
876
+ /** Format: double */
877
+ shipping_amount?: number;
878
+ /** Format: double */
879
+ shipping_total_tax?: number;
880
+ /** Format: double */
881
+ shipping_amount_including_tax?: number;
882
+ /** Format: double */
883
+ total_tax?: number;
884
+ /** Format: double */
796
885
  grand_total?: number;
797
886
  loyalty_point_redeemed?: number;
798
- credit_balance_used?: number; /** Format: double */
887
+ credit_balance_used?: number;
888
+ /** Format: double */
799
889
  to_be_paid?: number;
800
890
  loyalty_point_earned?: number;
801
891
  order_items_count?: number;
@@ -803,22 +893,31 @@ interface components {
803
893
  name?: string;
804
894
  code?: string;
805
895
  symbol?: string;
806
- }; /** Format: date-time */
807
- created_at?: string; /** Format: date-time */
896
+ };
897
+ /** Format: date-time */
898
+ created_at?: string;
899
+ /** Format: date-time */
808
900
  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 */
901
+ };
902
+ /** @enum {unknown} */
903
+ OrderAction: "create-shipment" | "download-invoice" | "inventory-check" | "refresh-payment-status" | "return-replace" | "update-payment-status" | "cancel-order";
904
+ /** OrderActivity */
811
905
  OrderActivity: {
812
906
  activity_type?: $Read<string>;
813
907
  order_status?: $Read<string>;
814
- comment: string; /** @enum {unknown} */
908
+ comment: string;
909
+ /** @enum {unknown} */
815
910
  user_type?: $Read<"customer" | "admin" | "system">;
816
- user_name?: $Read<string>; /** Format: date-time */
817
- created_at?: $Read<string>; /** Format: date-time */
911
+ user_name?: $Read<string>;
912
+ /** Format: date-time */
913
+ created_at?: $Read<string>;
914
+ /** Format: date-time */
818
915
  modified_at?: $Read<string>;
819
- }; /** OrderDetail */
916
+ };
917
+ /** OrderDetail */
820
918
  OrderDetail: {
821
- order_number: string; /** Format: date-time */
919
+ order_number: string;
920
+ /** Format: date-time */
822
921
  order_date: string;
823
922
  status: components["schemas"]["OrderStatus"];
824
923
  payment_status: components["schemas"]["PaymentStatus"];
@@ -827,10 +926,12 @@ interface components {
827
926
  customer_email: string | null;
828
927
  customer_phone: string | null;
829
928
  customer_note: string | null;
830
- is_promotion_applied: boolean; /** Format: double */
929
+ is_promotion_applied: boolean;
930
+ /** Format: double */
831
931
  promotion_discount_amount: number | null;
832
932
  is_coupon_applied: boolean;
833
- coupon_code: string | null; /** Format: double */
933
+ coupon_code: string | null;
934
+ /** Format: double */
834
935
  coupon_discount_amount: number | null;
835
936
  on_subscription: boolean;
836
937
  fulfillment_preference: components["schemas"]["FulfillmentPreference"];
@@ -841,19 +942,32 @@ interface components {
841
942
  };
842
943
  metadata: {
843
944
  [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 */
945
+ };
946
+ /** Format: double */
947
+ subtotal: number;
948
+ /** Format: double */
949
+ subtotal_tax: number;
950
+ /** Format: double */
951
+ subtotal_including_tax: number;
952
+ /** Format: double */
953
+ shipping_amount: number;
954
+ /** Format: double */
955
+ shipping_tax_rate: number;
956
+ /** Format: double */
957
+ shipping_total_tax: number;
958
+ /** Format: double */
959
+ shipping_amount_including_tax: number;
960
+ /** Format: double */
961
+ total_tax: number;
962
+ /** Format: double */
963
+ grand_total: number;
964
+ /** Format: double */
965
+ loyalty_point_redeemed: number;
966
+ /** Format: double */
967
+ credit_balance_used: number;
968
+ /** Format: double */
969
+ to_be_paid: number;
970
+ /** Format: double */
857
971
  loyalty_point_earned: number;
858
972
  order_items_count: number;
859
973
  order_items: components["schemas"]["OrderItem"][];
@@ -869,10 +983,13 @@ interface components {
869
983
  applied_coupons: components["schemas"]["AppliedCoupon"][];
870
984
  applied_promotions: components["schemas"]["AppliedPromotion"][];
871
985
  payments: components["schemas"]["OrderPayment"][];
872
- shipments: components["schemas"]["OrderShipment"][]; /** Format: date-time */
873
- created_at: string; /** Format: date-time */
986
+ shipments: components["schemas"]["OrderShipment"][];
987
+ /** Format: date-time */
988
+ created_at: string;
989
+ /** Format: date-time */
874
990
  modified_at: string;
875
- }; /** OrderItem */
991
+ };
992
+ /** OrderItem */
876
993
  OrderItem: {
877
994
  product_id?: $Read<string>;
878
995
  product_name?: $Read<string>;
@@ -886,16 +1003,26 @@ interface components {
886
1003
  subscription_frequency?: $Read<string | null>;
887
1004
  quantity: number;
888
1005
  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 */
1006
+ is_free_item?: $Read<boolean>;
1007
+ /** Format: double */
1008
+ selling_price?: $Read<number>;
1009
+ /** Format: double */
1010
+ listing_price?: $Read<number>;
1011
+ /** Format: double */
1012
+ promotion_discount_amount?: $Read<number>;
1013
+ /** Format: double */
1014
+ coupon_discount_amount?: $Read<number>;
1015
+ /** @enum {unknown} */
1016
+ tax_type?: $Read<"GST">;
1017
+ /** Format: float */
1018
+ tax_rate?: $Read<number>;
1019
+ /** Format: double */
1020
+ tax_amount?: $Read<number>;
1021
+ /** Format: double */
1022
+ handling_charge_excluding_tax?: $Read<number>;
1023
+ /** Format: double */
1024
+ handling_charge_including_tax?: number;
1025
+ /** Format: double */
899
1026
  handling_charge_tax_rate?: number;
900
1027
  variant_id?: string | null;
901
1028
  variant_name?: string | null;
@@ -905,7 +1032,9 @@ interface components {
905
1032
  * @description order list model
906
1033
  */
907
1034
  OrderList: {
908
- /** @description Order id. Same as order number. */id: string; /** @description Unique number associated with the order. */
1035
+ /** @description Order id. Same as order number. */
1036
+ id: string;
1037
+ /** @description Unique number associated with the order. */
909
1038
  order_number: string;
910
1039
  /**
911
1040
  * Format: date-time
@@ -913,9 +1042,12 @@ interface components {
913
1042
  */
914
1043
  order_date: string;
915
1044
  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. */
1045
+ payment_status: components["schemas"]["PaymentStatus"];
1046
+ /** @description Date and time when the payment for the order was successfully processed. */
1047
+ payment_success_date: string | null;
1048
+ /** @enum {unknown} */
1049
+ fulfillment_type: "collect-in-store" | "delivery";
1050
+ /** @description Indicates whether the order includes subscription items. */
919
1051
  on_subscription: boolean;
920
1052
  /**
921
1053
  * Format: double
@@ -936,13 +1068,15 @@ interface components {
936
1068
  * Format: double
937
1069
  * @description Amount remaining to be paid for the order.
938
1070
  */
939
- to_be_paid: number; /** @description Total count of items included in the order. */
1071
+ to_be_paid: number;
1072
+ /** @description Total count of items included in the order. */
940
1073
  order_items_count: number;
941
1074
  order_items: components["schemas"]["OrderItem"][];
942
1075
  customer_id: string;
943
1076
  customer_note: string | null;
944
1077
  billing_address: components["schemas"]["CustomerAddress"];
945
- shipping_address: components["schemas"]["CustomerAddress"]; /** Format: double */
1078
+ shipping_address: components["schemas"]["CustomerAddress"];
1079
+ /** Format: double */
946
1080
  loyalty_point_earned: number;
947
1081
  coupon_code: string | null;
948
1082
  currency: {
@@ -957,8 +1091,10 @@ interface components {
957
1091
  };
958
1092
  metadata?: {
959
1093
  [key: string]: string;
960
- }; /** Format: date-time */
961
- created_at: string; /** Format: date-time */
1094
+ };
1095
+ /** Format: date-time */
1096
+ created_at: string;
1097
+ /** Format: date-time */
962
1098
  modified_at: string;
963
1099
  };
964
1100
  /**
@@ -971,15 +1107,20 @@ interface components {
971
1107
  * @description Common fields in all types of payments.
972
1108
  */
973
1109
  OrderPaymentInfo: {
974
- /** @enum {unknown} */transaction_type?: "payment" | "refund";
975
- request_number?: string; /** Format: double */
1110
+ /** @enum {unknown} */
1111
+ transaction_type?: "payment" | "refund";
1112
+ request_number?: string;
1113
+ /** Format: double */
976
1114
  amount?: number;
977
- payment_status?: components["schemas"]["PaymentStatus"]; /** Format: date-time */
1115
+ payment_status?: components["schemas"]["PaymentStatus"];
1116
+ /** Format: date-time */
978
1117
  payment_date?: string;
979
- payment_reference_number?: string | null; /** @enum {unknown} */
1118
+ payment_reference_number?: string | null;
1119
+ /** @enum {unknown} */
980
1120
  payment_method?: "Credit Card" | "Debit Card" | "Netbanking" | "UPI" | "Wallet" | "Loyalty Point" | "IMPS" | "NEFT" | "RTGS";
981
1121
  icon_url?: string;
982
- }; /** OrderReceiptJsonFormat */
1122
+ };
1123
+ /** OrderReceiptJsonFormat */
983
1124
  OrderReceiptJsonFormat: components["schemas"]["Order"] & {
984
1125
  billing_address?: components["schemas"]["CustomerAddress"];
985
1126
  shipping_address?: components["schemas"]["CustomerAddress"];
@@ -996,23 +1137,33 @@ interface components {
996
1137
  total_weight?: number;
997
1138
  total_boxes?: number | null;
998
1139
  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 */
1140
+ shipment_items?: components["schemas"]["ShipmentItem"][];
1141
+ /** Format: double */
1142
+ shipping_amount?: number;
1143
+ /** Format: double */
1144
+ shipping_tax_amount?: number;
1145
+ /** Format: double */
1002
1146
  shipping_amount_including_tax?: number;
1003
1147
  courier_company_id?: string | null;
1004
1148
  courier_company_name?: string | null;
1005
1149
  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 */
1150
+ awb_no?: string | null;
1151
+ /** Format: date-time */
1152
+ eta_delivery?: string | null;
1153
+ /** Format: date-time */
1154
+ shipped_date?: string | null;
1155
+ /** Format: date-time */
1009
1156
  delivered_date?: string | null;
1010
- cancellation_reason?: string | null; /** Format: date-time */
1011
- created_at?: string; /** Format: date-time */
1157
+ cancellation_reason?: string | null;
1158
+ /** Format: date-time */
1159
+ created_at?: string;
1160
+ /** Format: date-time */
1012
1161
  modified_at?: string;
1013
- }; /** OrderShipmentDetail */
1162
+ };
1163
+ /** OrderShipmentDetail */
1014
1164
  OrderShipmentDetail: {
1015
- order_number: string; /** Format: date-time */
1165
+ order_number: string;
1166
+ /** Format: date-time */
1016
1167
  order_date: string;
1017
1168
  order_status: string;
1018
1169
  sales_channel: {
@@ -1024,7 +1175,8 @@ interface components {
1024
1175
  customer_name: string;
1025
1176
  shipments: components["schemas"]["Shipment"][];
1026
1177
  allowed_actions: components["schemas"]["ShipmentAction"][];
1027
- }; /** @enum {unknown} */
1178
+ };
1179
+ /** @enum {unknown} */
1028
1180
  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
1181
  /**
1030
1182
  * Pagination
@@ -1033,16 +1185,19 @@ interface components {
1033
1185
  Pagination: {
1034
1186
  total_records?: number;
1035
1187
  total_pages?: number;
1036
- previous_page?: ((number | null) | null) | null; /** @default 25 */
1188
+ previous_page?: ((number | null) | null) | null;
1189
+ /** @default 25 */
1037
1190
  limit: number;
1038
1191
  next_page?: ((number | null) | null) | null;
1039
- }; /** PartialCollectAndDelivery */
1192
+ };
1193
+ /** PartialCollectAndDelivery */
1040
1194
  PartialCollectAndDelivery: {
1041
1195
  /**
1042
1196
  * @description discriminator enum property added by openapi-typescript
1043
1197
  * @enum {string}
1044
1198
  */
1045
- fulfillment_type: "partial-collect-and-delivery"; /** @enum {string} */
1199
+ fulfillment_type: "partial-collect-and-delivery";
1200
+ /** @enum {string} */
1046
1201
  preference_type?: $Read<"user" | "auto">;
1047
1202
  "collect-in-store": {
1048
1203
  pickup_location_id: string;
@@ -1061,42 +1216,54 @@ interface components {
1061
1216
  * PaymentStatus
1062
1217
  * @enum {unknown}
1063
1218
  */
1064
- PaymentStatus: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated" | "refunded" | "unsettled" | "settled" | "partially_settled"; /** ProductImage */
1219
+ PaymentStatus: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated" | "refunded" | "unsettled" | "settled" | "partially_settled";
1220
+ /** ProductImage */
1065
1221
  ProductImage: {
1066
1222
  title?: string | null;
1067
- alternate_text?: string | null; /** Format: int32 */
1223
+ alternate_text?: string | null;
1224
+ /** Format: int32 */
1068
1225
  sort_order?: number;
1069
1226
  url_tiny?: string;
1070
1227
  url_thumbnail?: string;
1071
1228
  url_standard?: string;
1072
1229
  url_zoom?: string;
1073
- file_id?: string; /** @enum {unknown} */
1230
+ file_id?: string;
1231
+ /** @enum {unknown} */
1074
1232
  file_type?: "image";
1075
- }; /** SalesChannel */
1233
+ };
1234
+ /** SalesChannel */
1076
1235
  SalesChannel: {
1077
1236
  id: string;
1078
- name: $Read<string>; /** @enum {string} */
1237
+ name: $Read<string>;
1238
+ /** @enum {string} */
1079
1239
  kind: "storefront" | "marketplace";
1080
1240
  active: $Read<boolean>;
1081
- }; /** Shipment */
1241
+ };
1242
+ /** Shipment */
1082
1243
  Shipment: components["schemas"]["ShipmentInfo"] & {
1083
1244
  shipment_items?: components["schemas"]["ShipmentItem"][];
1084
1245
  } & {
1085
1246
  packing?: components["schemas"]["ShipmentPackaging"];
1086
1247
  } & {
1087
1248
  progression?: components["schemas"]["ShipmentProgression"][];
1088
- }; /** @enum {unknown} */
1089
- ShipmentAction: "create-shipment" | "download-invoice" | "inventory-check" | "return-replace" | "update-manual" | "cancel"; /** ShipmentActivity */
1249
+ };
1250
+ /** @enum {unknown} */
1251
+ ShipmentAction: "create-shipment" | "download-invoice" | "inventory-check" | "return-replace" | "update-manual" | "cancel";
1252
+ /** ShipmentActivity */
1090
1253
  ShipmentActivity: {
1091
1254
  activity_type: string;
1092
- comment: string; /** @enum {unknown} */
1255
+ comment: string;
1256
+ /** @enum {unknown} */
1093
1257
  status: "success" | "failed";
1094
1258
  user_type: string;
1095
1259
  user_name: string;
1096
- details: string | null; /** Format: date-time */
1097
- created_at: string; /** Format: date-time */
1260
+ details: string | null;
1261
+ /** Format: date-time */
1262
+ created_at: string;
1263
+ /** Format: date-time */
1098
1264
  modified_at: string;
1099
- }; /** ShipmentBox */
1265
+ };
1266
+ /** ShipmentBox */
1100
1267
  ShipmentBox: {
1101
1268
  box_name?: string;
1102
1269
  box_length?: number;
@@ -1105,9 +1272,11 @@ interface components {
1105
1272
  box_weight?: number;
1106
1273
  items_count?: number | null;
1107
1274
  box_count?: number | null;
1108
- }; /** ShipmentDetail */
1275
+ };
1276
+ /** ShipmentDetail */
1109
1277
  ShipmentDetail: {
1110
- order_number: string; /** Format: date-time */
1278
+ order_number: string;
1279
+ /** Format: date-time */
1111
1280
  order_date: string;
1112
1281
  order_status: string;
1113
1282
  sales_channel: {
@@ -1119,7 +1288,8 @@ interface components {
1119
1288
  customer_name?: string | null;
1120
1289
  shipment_detail: components["schemas"]["Shipment"];
1121
1290
  allowed_actions: components["schemas"]["ShipmentAction"][];
1122
- }; /** ShipmentInfo */
1291
+ };
1292
+ /** ShipmentInfo */
1123
1293
  ShipmentInfo: {
1124
1294
  order_number: string;
1125
1295
  order_status: string;
@@ -1129,12 +1299,18 @@ interface components {
1129
1299
  status: components["schemas"]["ShipmentStatus"];
1130
1300
  total_weight: number;
1131
1301
  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 */
1302
+ shipment_items_count: number;
1303
+ /** Format: double */
1304
+ shipping_estimated_cost: number;
1305
+ /** Format: double */
1306
+ shipping_discount_amount: number;
1307
+ /** Format: double */
1308
+ shipping_amount: number;
1309
+ /** Format: double */
1310
+ shipping_tax_rate: number;
1311
+ /** Format: double */
1312
+ shipping_tax_amount: number;
1313
+ /** Format: double */
1138
1314
  shipping_amount_including_tax: number;
1139
1315
  shipping_provider_id: string | null;
1140
1316
  shipping_provider_name: string | null;
@@ -1149,12 +1325,16 @@ interface components {
1149
1325
  out_for_delivery_date?: string | null;
1150
1326
  shipped_date: string | null;
1151
1327
  delivered_date: string | null;
1152
- returned_date: string | null; /** @enum {unknown} */
1328
+ returned_date: string | null;
1329
+ /** @enum {unknown} */
1153
1330
  fulfillment_type: "delivery" | "collect-in-store";
1154
1331
  slo: {
1155
- /** Format: date */expected_date?: string; /** Format: date */
1332
+ /** Format: date */
1333
+ expected_date?: string;
1334
+ /** Format: date */
1156
1335
  actual_date?: string;
1157
- difference?: string; /** @enum {unknown} */
1336
+ difference?: string;
1337
+ /** @enum {unknown} */
1158
1338
  slo_status?: "on-time" | "delay" | "early";
1159
1339
  };
1160
1340
  cancellation_reason: string | null;
@@ -1182,9 +1362,11 @@ interface components {
1182
1362
  sku?: $Read<string>;
1183
1363
  quantity: number;
1184
1364
  free_quantity?: number;
1185
- is_free_item?: $Read<boolean>; /** Format: double */
1365
+ is_free_item?: $Read<boolean>;
1366
+ /** Format: double */
1186
1367
  selling_price?: number;
1187
- }; /** ShipmentList */
1368
+ };
1369
+ /** ShipmentList */
1188
1370
  ShipmentList: {
1189
1371
  order_number?: string;
1190
1372
  sales_channel?: {
@@ -1192,18 +1374,23 @@ interface components {
1192
1374
  name?: string;
1193
1375
  type?: string;
1194
1376
  };
1195
- } & components["schemas"]["ShipmentInfo"]; /** ShipmentPackaging */
1377
+ } & components["schemas"]["ShipmentInfo"];
1378
+ /** ShipmentPackaging */
1196
1379
  ShipmentPackaging: {
1197
- /** @enum {unknown} */package_option?: "Automatic" | "Custom";
1380
+ /** @enum {unknown} */
1381
+ package_option?: "Automatic" | "Custom";
1198
1382
  boxes_count?: number;
1199
1383
  boxes?: components["schemas"]["ShipmentBox"][];
1200
- }; /** ShipmentProgression */
1384
+ };
1385
+ /** ShipmentProgression */
1201
1386
  ShipmentProgression: {
1202
1387
  status?: components["schemas"]["ShipmentStatus"];
1203
1388
  is_current?: $Read<boolean>;
1204
- is_completed?: $Read<boolean>; /** Format: date-time */
1389
+ is_completed?: $Read<boolean>;
1390
+ /** Format: date-time */
1205
1391
  completion_date?: string | null;
1206
- }; /** @enum {unknown} */
1392
+ };
1393
+ /** @enum {unknown} */
1207
1394
  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
1395
  /**
1209
1396
  * UpiPayment
@@ -1211,7 +1398,8 @@ interface components {
1211
1398
  */
1212
1399
  UpiPayment: components["schemas"]["OrderPaymentInfo"] & {
1213
1400
  upi_id?: string;
1214
- }; /** WalletPayment */
1401
+ };
1402
+ /** WalletPayment */
1215
1403
  WalletPayment: components["schemas"]["OrderPaymentInfo"] & {
1216
1404
  wallet_name?: string;
1217
1405
  };
@@ -1225,9 +1413,13 @@ interface components {
1225
1413
  * 4) If 'can_receive_stock' is false then 'can_ship_parcel' and 'can_collect' fields should be false.
1226
1414
  */
1227
1415
  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 */
1416
+ /** @description warehouse id */
1417
+ id?: $Read<string>;
1418
+ /** @description legal name */
1419
+ name: string;
1420
+ /** @enum {unknown} */
1421
+ warehouse_type: "retail-store" | "distribution-center";
1422
+ /** @default true */
1231
1423
  active: boolean;
1232
1424
  gstin?: string | null;
1233
1425
  city: string;
@@ -1236,8 +1428,10 @@ interface components {
1236
1428
  landmark?: string | null;
1237
1429
  pincode: string;
1238
1430
  state: string;
1239
- country: string; /** @default +91 */
1240
- country_code: string; /** @description 10 digit number without country code. */
1431
+ country: string;
1432
+ /** @default +91 */
1433
+ country_code: string;
1434
+ /** @description 10 digit number without country code. */
1241
1435
  contact_phone: number;
1242
1436
  contact_email: string;
1243
1437
  is_default?: boolean;
@@ -1245,12 +1439,15 @@ interface components {
1245
1439
  seller_warehouse_id?: string | null;
1246
1440
  can_receive_stock: boolean;
1247
1441
  can_ship_parcel: boolean;
1248
- can_collect: boolean; /** @description this field will be always true for warehouse_type = retail-store. */
1442
+ can_collect: boolean;
1443
+ /** @description this field will be always true for warehouse_type = retail-store. */
1249
1444
  is_checkout_point: boolean;
1250
1445
  accepts_returns: boolean;
1251
- opening_hours?: components["schemas"]["OpeningHours"]; /** @description channels associated with the warehouse */
1446
+ opening_hours?: components["schemas"]["OpeningHours"];
1447
+ /** @description channels associated with the warehouse */
1252
1448
  channels?: $Read<components["schemas"]["SalesChannel"][]>;
1253
- }; /** WarehouseBasicDetail */
1449
+ };
1450
+ /** WarehouseBasicDetail */
1254
1451
  WarehouseBasicDetail: {
1255
1452
  id?: string;
1256
1453
  name?: string;
@@ -1259,10 +1456,13 @@ interface components {
1259
1456
  city?: string;
1260
1457
  state?: string;
1261
1458
  is_default?: boolean;
1262
- }; /** WarehouseWiseInventory */
1459
+ };
1460
+ /** WarehouseWiseInventory */
1263
1461
  WarehouseWiseInventory: {
1264
- lot_batch?: string; /** Format: date */
1265
- mfg_date?: string; /** Format: date */
1462
+ lot_batch?: string;
1463
+ /** Format: date */
1464
+ mfg_date?: string;
1465
+ /** Format: date */
1266
1466
  exp_date?: string;
1267
1467
  manufacturer?: string;
1268
1468
  warehouse_id?: string;
@@ -1276,11 +1476,17 @@ interface components {
1276
1476
  };
1277
1477
  responses: never;
1278
1478
  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"} */
1479
+ /** @description JSON object */
1480
+ columnBasedFilters: string;
1481
+ /** @description view to be used to display the data */
1482
+ dataView: "warehouse";
1483
+ /** @description no of rows per page */
1484
+ pageLimit: number;
1485
+ /** @description page number of pagination list */
1486
+ pageNumber: number;
1487
+ /** @description search keyword */
1488
+ searchKeyword: string;
1489
+ /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
1284
1490
  sortByOptions: string;
1285
1491
  };
1286
1492
  requestBodies: never;
@@ -1291,10 +1497,15 @@ interface operations {
1291
1497
  "pos-list-inventory": {
1292
1498
  parameters: {
1293
1499
  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 */
1500
+ /** @description view to be used to display the data */
1501
+ view?: components["parameters"]["dataView"];
1502
+ /** @description page number of pagination list */
1503
+ page?: components["parameters"]["pageNumber"];
1504
+ /** @description no of rows per page */
1505
+ limit?: components["parameters"]["pageLimit"];
1506
+ /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
1507
+ sort_by?: components["parameters"]["sortByOptions"];
1508
+ /** @description JSON object */
1298
1509
  filters?: components["parameters"]["columnBasedFilters"];
1299
1510
  };
1300
1511
  header?: never;
@@ -1303,7 +1514,8 @@ interface operations {
1303
1514
  };
1304
1515
  requestBody?: never;
1305
1516
  responses: {
1306
- /** @description OK */200: {
1517
+ /** @description OK */
1518
+ 200: {
1307
1519
  headers: {
1308
1520
  [name: string]: unknown;
1309
1521
  };
@@ -1323,9 +1535,13 @@ interface operations {
1323
1535
  "pos-list-inventory-activity": {
1324
1536
  parameters: {
1325
1537
  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 */
1538
+ /** @description page number of pagination list */
1539
+ page?: components["parameters"]["pageNumber"];
1540
+ /** @description no of rows per page */
1541
+ limit?: components["parameters"]["pageLimit"];
1542
+ /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
1543
+ sort_by?: components["parameters"]["sortByOptions"];
1544
+ /** @description JSON object */
1329
1545
  filters?: components["parameters"]["columnBasedFilters"];
1330
1546
  };
1331
1547
  header?: never;
@@ -1334,7 +1550,8 @@ interface operations {
1334
1550
  };
1335
1551
  requestBody?: never;
1336
1552
  responses: {
1337
- /** @description OK */200: {
1553
+ /** @description OK */
1554
+ 200: {
1338
1555
  headers: {
1339
1556
  [name: string]: unknown;
1340
1557
  };
@@ -1354,8 +1571,11 @@ interface operations {
1354
1571
  "pos-list-inventory-detail": {
1355
1572
  parameters: {
1356
1573
  query: {
1357
- /** @description lot batch of selected productor or variant. */lot_batch?: string; /** @description Product Id */
1358
- product_id: string; /** @description Variant Id */
1574
+ /** @description lot batch of selected productor or variant. */
1575
+ lot_batch?: string;
1576
+ /** @description Product Id */
1577
+ product_id: string;
1578
+ /** @description Variant Id */
1359
1579
  variant_id?: string;
1360
1580
  };
1361
1581
  header?: never;
@@ -1364,7 +1584,8 @@ interface operations {
1364
1584
  };
1365
1585
  requestBody?: never;
1366
1586
  responses: {
1367
- /** @description OK */200: {
1587
+ /** @description OK */
1588
+ 200: {
1368
1589
  headers: {
1369
1590
  [name: string]: unknown;
1370
1591
  };
@@ -1383,10 +1604,15 @@ interface operations {
1383
1604
  "pos-list-customers": {
1384
1605
  parameters: {
1385
1606
  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 */
1607
+ /** @description page number of pagination list */
1608
+ page?: components["parameters"]["pageNumber"];
1609
+ /** @description no of rows per page */
1610
+ limit?: components["parameters"]["pageLimit"];
1611
+ /** @description JSON object */
1612
+ filters?: components["parameters"]["columnBasedFilters"];
1613
+ /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
1614
+ sort_by?: components["parameters"]["sortByOptions"];
1615
+ /** @description search keyword */
1390
1616
  search?: components["parameters"]["searchKeyword"];
1391
1617
  };
1392
1618
  header?: never;
@@ -1395,7 +1621,8 @@ interface operations {
1395
1621
  };
1396
1622
  requestBody?: never;
1397
1623
  responses: {
1398
- /** @description OK */200: {
1624
+ /** @description OK */
1625
+ 200: {
1399
1626
  headers: {
1400
1627
  [name: string]: unknown;
1401
1628
  };
@@ -1417,13 +1644,15 @@ interface operations {
1417
1644
  query?: never;
1418
1645
  header?: never;
1419
1646
  path: {
1420
- /** @description Customer Id */id: string;
1647
+ /** @description Customer Id */
1648
+ id: string;
1421
1649
  };
1422
1650
  cookie?: never;
1423
1651
  };
1424
1652
  requestBody?: never;
1425
1653
  responses: {
1426
- /** @description OK */200: {
1654
+ /** @description OK */
1655
+ 200: {
1427
1656
  headers: {
1428
1657
  [name: string]: unknown;
1429
1658
  };
@@ -1442,10 +1671,15 @@ interface operations {
1442
1671
  "pos-list-orders": {
1443
1672
  parameters: {
1444
1673
  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 */
1674
+ /** @description page number of pagination list */
1675
+ page?: components["parameters"]["pageNumber"];
1676
+ /** @description no of rows per page */
1677
+ limit?: components["parameters"]["pageLimit"];
1678
+ /** @description JSON object */
1679
+ filters?: components["parameters"]["columnBasedFilters"];
1680
+ /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
1681
+ sort_by?: components["parameters"]["sortByOptions"];
1682
+ /** @description search keyword */
1449
1683
  search?: components["parameters"]["searchKeyword"];
1450
1684
  };
1451
1685
  header?: never;
@@ -1454,7 +1688,8 @@ interface operations {
1454
1688
  };
1455
1689
  requestBody?: never;
1456
1690
  responses: {
1457
- /** @description OK */200: {
1691
+ /** @description OK */
1692
+ 200: {
1458
1693
  headers: {
1459
1694
  [name: string]: unknown;
1460
1695
  };
@@ -1476,13 +1711,15 @@ interface operations {
1476
1711
  query?: never;
1477
1712
  header?: never;
1478
1713
  path: {
1479
- /** @description order number */order_number: string;
1714
+ /** @description order number */
1715
+ order_number: string;
1480
1716
  };
1481
1717
  cookie?: never;
1482
1718
  };
1483
1719
  requestBody?: never;
1484
1720
  responses: {
1485
- /** @description OK */200: {
1721
+ /** @description OK */
1722
+ 200: {
1486
1723
  headers: {
1487
1724
  [name: string]: unknown;
1488
1725
  };
@@ -1503,13 +1740,15 @@ interface operations {
1503
1740
  query?: never;
1504
1741
  header?: never;
1505
1742
  path: {
1506
- /** @description order number */order_number: string;
1743
+ /** @description order number */
1744
+ order_number: string;
1507
1745
  };
1508
1746
  cookie?: never;
1509
1747
  };
1510
1748
  requestBody?: never;
1511
1749
  responses: {
1512
- /** @description OK */200: {
1750
+ /** @description OK */
1751
+ 200: {
1513
1752
  headers: {
1514
1753
  [name: string]: unknown;
1515
1754
  };
@@ -1531,13 +1770,15 @@ interface operations {
1531
1770
  query?: never;
1532
1771
  header?: never;
1533
1772
  path: {
1534
- /** @description Order number */order_number: string;
1773
+ /** @description Order number */
1774
+ order_number: string;
1535
1775
  };
1536
1776
  cookie?: never;
1537
1777
  };
1538
1778
  requestBody?: never;
1539
1779
  responses: {
1540
- /** @description OK */200: {
1780
+ /** @description OK */
1781
+ 200: {
1541
1782
  headers: {
1542
1783
  [name: string]: unknown;
1543
1784
  };
@@ -1556,17 +1797,20 @@ interface operations {
1556
1797
  "pos-get-order-invoice": {
1557
1798
  parameters: {
1558
1799
  query?: {
1559
- /** @description Response data format */format?: "json" | "pdf";
1800
+ /** @description Response data format */
1801
+ format?: "json" | "pdf";
1560
1802
  };
1561
1803
  header?: never;
1562
1804
  path: {
1563
- /** @description order number */order_number: string;
1805
+ /** @description order number */
1806
+ order_number: string;
1564
1807
  };
1565
1808
  cookie?: never;
1566
1809
  };
1567
1810
  requestBody?: never;
1568
1811
  responses: {
1569
- /** @description OK */200: {
1812
+ /** @description OK */
1813
+ 200: {
1570
1814
  headers: {
1571
1815
  [name: string]: unknown;
1572
1816
  };
@@ -1586,17 +1830,20 @@ interface operations {
1586
1830
  "pos-get-order-receipt": {
1587
1831
  parameters: {
1588
1832
  query?: {
1589
- /** @description Response data format */format?: "json" | "pdf";
1833
+ /** @description Response data format */
1834
+ format?: "json" | "pdf";
1590
1835
  };
1591
1836
  header?: never;
1592
1837
  path: {
1593
- /** @description order number */order_number: string;
1838
+ /** @description order number */
1839
+ order_number: string;
1594
1840
  };
1595
1841
  cookie?: never;
1596
1842
  };
1597
1843
  requestBody?: never;
1598
1844
  responses: {
1599
- /** @description OK */200: {
1845
+ /** @description OK */
1846
+ 200: {
1600
1847
  headers: {
1601
1848
  [name: string]: unknown;
1602
1849
  };
@@ -1618,13 +1865,15 @@ interface operations {
1618
1865
  query?: never;
1619
1866
  header?: never;
1620
1867
  path: {
1621
- /** @description order number */order_number: string;
1868
+ /** @description order number */
1869
+ order_number: string;
1622
1870
  };
1623
1871
  cookie?: never;
1624
1872
  };
1625
1873
  requestBody?: never;
1626
1874
  responses: {
1627
- /** @description OK */200: {
1875
+ /** @description OK */
1876
+ 200: {
1628
1877
  headers: {
1629
1878
  [name: string]: unknown;
1630
1879
  };
@@ -1643,10 +1892,15 @@ interface operations {
1643
1892
  "pos-list-shipments": {
1644
1893
  parameters: {
1645
1894
  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 */
1895
+ /** @description page number of pagination list */
1896
+ page?: components["parameters"]["pageNumber"];
1897
+ /** @description no of rows per page */
1898
+ limit?: components["parameters"]["pageLimit"];
1899
+ /** @description JSON object */
1900
+ filters?: components["parameters"]["columnBasedFilters"];
1901
+ /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
1902
+ sort_by?: components["parameters"]["sortByOptions"];
1903
+ /** @description search keyword */
1650
1904
  search?: components["parameters"]["searchKeyword"];
1651
1905
  };
1652
1906
  header?: never;
@@ -1655,7 +1909,8 @@ interface operations {
1655
1909
  };
1656
1910
  requestBody?: never;
1657
1911
  responses: {
1658
- /** @description OK */200: {
1912
+ /** @description OK */
1913
+ 200: {
1659
1914
  headers: {
1660
1915
  [name: string]: unknown;
1661
1916
  };
@@ -1677,7 +1932,8 @@ interface operations {
1677
1932
  query?: never;
1678
1933
  header?: never;
1679
1934
  path: {
1680
- /** @description Order Number */order_number: string;
1935
+ /** @description Order Number */
1936
+ order_number: string;
1681
1937
  };
1682
1938
  cookie?: never;
1683
1939
  };
@@ -1686,16 +1942,20 @@ interface operations {
1686
1942
  "application/json": {
1687
1943
  items: {
1688
1944
  sku: string;
1689
- quantity: number; /** @default 0 */
1945
+ quantity: number;
1946
+ /** @default 0 */
1690
1947
  free_quantity?: number;
1691
- }[]; /** @enum {unknown} */
1692
- payment_method: "original-payment-mode" | "bank-transfer"; /** @description required if payment_method = bank-transfer */
1948
+ }[];
1949
+ /** @enum {unknown} */
1950
+ payment_method: "original-payment-mode" | "bank-transfer";
1951
+ /** @description required if payment_method = bank-transfer */
1693
1952
  bank_account_id?: string | null;
1694
1953
  };
1695
1954
  };
1696
1955
  };
1697
1956
  responses: {
1698
- /** @description OK */200: {
1957
+ /** @description OK */
1958
+ 200: {
1699
1959
  headers: {
1700
1960
  [name: string]: unknown;
1701
1961
  };
@@ -1713,13 +1973,15 @@ interface operations {
1713
1973
  query?: never;
1714
1974
  header?: never;
1715
1975
  path: {
1716
- /** @description Shipment reference number */reference_number: string;
1976
+ /** @description Shipment reference number */
1977
+ reference_number: string;
1717
1978
  };
1718
1979
  cookie?: never;
1719
1980
  };
1720
1981
  requestBody?: never;
1721
1982
  responses: {
1722
- /** @description OK */200: {
1983
+ /** @description OK */
1984
+ 200: {
1723
1985
  headers: {
1724
1986
  [name: string]: unknown;
1725
1987
  };
@@ -1740,13 +2002,15 @@ interface operations {
1740
2002
  query?: never;
1741
2003
  header?: never;
1742
2004
  path: {
1743
- /** @description Shipment reference number */reference_number: string;
2005
+ /** @description Shipment reference number */
2006
+ reference_number: string;
1744
2007
  };
1745
2008
  cookie?: never;
1746
2009
  };
1747
2010
  requestBody?: never;
1748
2011
  responses: {
1749
- /** @description OK */200: {
2012
+ /** @description OK */
2013
+ 200: {
1750
2014
  headers: {
1751
2015
  [name: string]: unknown;
1752
2016
  };
@@ -1766,17 +2030,20 @@ interface operations {
1766
2030
  "pos-get-shipment-invoice": {
1767
2031
  parameters: {
1768
2032
  query?: {
1769
- /** @description Response data format */format?: "json" | "pdf";
2033
+ /** @description Response data format */
2034
+ format?: "json" | "pdf";
1770
2035
  };
1771
2036
  header?: never;
1772
2037
  path: {
1773
- /** @description Shipment reference number */reference_number: string;
2038
+ /** @description Shipment reference number */
2039
+ reference_number: string;
1774
2040
  };
1775
2041
  cookie?: never;
1776
2042
  };
1777
2043
  requestBody?: never;
1778
2044
  responses: {
1779
- /** @description OK */200: {
2045
+ /** @description OK */
2046
+ 200: {
1780
2047
  headers: {
1781
2048
  [name: string]: unknown;
1782
2049
  };
@@ -1798,7 +2065,8 @@ interface operations {
1798
2065
  query?: never;
1799
2066
  header?: never;
1800
2067
  path: {
1801
- /** @description Shipment reference number */reference_number: string;
2068
+ /** @description Shipment reference number */
2069
+ reference_number: string;
1802
2070
  };
1803
2071
  cookie?: never;
1804
2072
  };
@@ -1811,16 +2079,21 @@ interface operations {
1811
2079
  courier_company_name?: string;
1812
2080
  shipping_label_url?: string;
1813
2081
  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 */
2082
+ manual_shipping_charges?: number;
2083
+ /** Format: date-time */
2084
+ eta_delivery?: string;
2085
+ /** Format: date-time */
2086
+ shipped_date?: string;
2087
+ /** Format: date-time */
2088
+ out_for_delivery_date?: string;
2089
+ /** Format: date-time */
1818
2090
  delivered_date?: string;
1819
2091
  };
1820
2092
  };
1821
2093
  };
1822
2094
  responses: {
1823
- /** @description OK */200: {
2095
+ /** @description OK */
2096
+ 200: {
1824
2097
  headers: {
1825
2098
  [name: string]: unknown;
1826
2099
  };