@wix/auto_sdk_ecom_orders 1.0.38 → 1.0.40

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.
Files changed (33) hide show
  1. package/build/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
  2. package/build/cjs/src/ecom-v1-order-orders.public.d.ts +1 -1
  3. package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
  4. package/build/cjs/src/ecom-v1-order-orders.types.d.ts +64 -0
  5. package/build/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
  6. package/build/cjs/src/ecom-v1-order-orders.universal.d.ts +96 -0
  7. package/build/cjs/src/ecom-v1-order-orders.universal.js +53 -0
  8. package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
  9. package/build/es/src/ecom-v1-order-orders.context.d.ts +1 -1
  10. package/build/es/src/ecom-v1-order-orders.public.d.ts +1 -1
  11. package/build/es/src/ecom-v1-order-orders.public.js.map +1 -1
  12. package/build/es/src/ecom-v1-order-orders.types.d.ts +64 -0
  13. package/build/es/src/ecom-v1-order-orders.types.js.map +1 -1
  14. package/build/es/src/ecom-v1-order-orders.universal.d.ts +96 -0
  15. package/build/es/src/ecom-v1-order-orders.universal.js +53 -0
  16. package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -1
  17. package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
  18. package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +1 -1
  19. package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
  20. package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +64 -0
  21. package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
  22. package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +141 -1
  23. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +53 -0
  24. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
  25. package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +1 -1
  26. package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +1 -1
  27. package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -1
  28. package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +64 -0
  29. package/build/internal/es/src/ecom-v1-order-orders.types.js.map +1 -1
  30. package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +141 -1
  31. package/build/internal/es/src/ecom-v1-order-orders.universal.js +53 -0
  32. package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -1
  33. package/package.json +4 -4
@@ -295,6 +295,13 @@ export interface OrderLineItem {
295
295
  * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
296
296
  */
297
297
  extendedFields?: ExtendedFields;
298
+ /**
299
+ * Modifier groups that were added to the item.
300
+ * @internal
301
+ * @readonly
302
+ * @maxSize 10
303
+ */
304
+ modifierGroups?: ModifierGroup[];
298
305
  }
299
306
  export interface ProductName {
300
307
  /**
@@ -626,7 +633,6 @@ export interface SubscriptionInfo {
626
633
  subscriptionSettings?: SubscriptionSettings;
627
634
  /**
628
635
  * Description of the charges that will be applied for subscription.
629
- * @internal
630
636
  * @maxLength 1000
631
637
  */
632
638
  chargesDescription?: string | null;
@@ -803,6 +809,63 @@ export interface ExtendedFields {
803
809
  */
804
810
  namespaces?: Record<string, Record<string, any>>;
805
811
  }
812
+ export interface ModifierGroup {
813
+ /**
814
+ * Modifier group id.
815
+ * @minLength 1
816
+ * @maxLength 36
817
+ */
818
+ _id?: string;
819
+ /** Modifier group name. */
820
+ name?: TranslatableString;
821
+ /**
822
+ * List of modifiers in this group.
823
+ * @minSize 1
824
+ * @maxSize 10
825
+ */
826
+ modifiers?: ItemModifier[];
827
+ }
828
+ export interface TranslatableString {
829
+ /**
830
+ * __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
831
+ *
832
+ * Min: 1 character.
833
+ * Max: 200 characters.
834
+ * @minLength 1
835
+ * @maxLength 200
836
+ */
837
+ original?: string;
838
+ /**
839
+ * String translated into the buyer's language.
840
+ *
841
+ * Min: 1 character.
842
+ * Max: 400 characters.
843
+ * Default: Same as `original`.
844
+ * @minLength 1
845
+ * @maxLength 400
846
+ */
847
+ translated?: string | null;
848
+ }
849
+ export interface ItemModifier {
850
+ /**
851
+ * Modifier ID.
852
+ * @minLength 1
853
+ * @maxLength 36
854
+ */
855
+ _id?: string;
856
+ /**
857
+ * The quantity of this modifier.
858
+ * @min 1
859
+ * @max 100000
860
+ */
861
+ quantity?: number | null;
862
+ /** Primary display label for the modifier. */
863
+ label?: TranslatableString;
864
+ /** Optional additional details or clarification for the modifier. */
865
+ details?: TranslatableString;
866
+ /** The price of the modifier. */
867
+ price?: Price;
868
+ }
806
869
  /** Buyer Info */
807
870
  export interface BuyerInfo extends BuyerInfoIdOneOf {
808
871
  /**
@@ -4257,6 +4320,8 @@ export interface HtmlApplication {
4257
4320
  editorX?: boolean;
4258
4321
  /** Indicates whether this site is managed by Wix Studio. */
4259
4322
  studio?: boolean;
4323
+ /** Indicates that site is managed by Odeditor */
4324
+ odeditor?: boolean;
4260
4325
  }
4261
4326
  export interface ExternalUriMapping {
4262
4327
  /**
@@ -4980,6 +5045,13 @@ export interface OrderLineItemChangedDetails {
4980
5045
  inventoryAppId?: string | null;
4981
5046
  /** Subscription info. */
4982
5047
  subscriptionInfo?: SubscriptionInfo;
5048
+ /**
5049
+ * Modifier groups that were added to the item.
5050
+ * @internal
5051
+ * @readonly
5052
+ * @maxSize 10
5053
+ */
5054
+ modifierGroups?: ModifierGroup[];
4983
5055
  }
4984
5056
  /** Type of selected payment option for catalog item */
4985
5057
  export declare enum DeltaPaymentOptionType {
@@ -6512,6 +6584,8 @@ export interface OrderApprovedEnvelope {
6512
6584
  }
6513
6585
  /** @permissionScope Manage Stores - all permissions
6514
6586
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6587
+ * @permissionScope Manage Stores
6588
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6515
6589
  * @permissionScope Read eCommerce - all read permissions
6516
6590
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6517
6591
  * @permissionScope Read Orders
@@ -6536,6 +6610,8 @@ export interface OrderUpdatedEnvelope {
6536
6610
  }
6537
6611
  /** @permissionScope Manage Stores - all permissions
6538
6612
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6613
+ * @permissionScope Manage Stores
6614
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6539
6615
  * @permissionScope Read eCommerce - all read permissions
6540
6616
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6541
6617
  * @permissionScope Read Orders
@@ -6563,6 +6639,8 @@ export interface OrderCanceledEnvelope {
6563
6639
  * Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
6564
6640
  * @permissionScope Manage Stores - all permissions
6565
6641
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6642
+ * @permissionScope Manage Stores
6643
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6566
6644
  * @permissionScope Read eCommerce - all read permissions
6567
6645
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6568
6646
  * @permissionScope Read Orders
@@ -6591,6 +6669,8 @@ export interface OrderCreatedEnvelope {
6591
6669
  * Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
6592
6670
  * @permissionScope Manage Stores - all permissions
6593
6671
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6672
+ * @permissionScope Manage Stores
6673
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6594
6674
  * @permissionScope Read eCommerce - all read permissions
6595
6675
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6596
6676
  * @permissionScope Read Orders
@@ -6624,6 +6704,8 @@ type OrderNonNullablePaths = `number` | `lineItems` | `lineItems.${number}._id`
6624
6704
  * @requiredField amount
6625
6705
  * @requiredField ecomOrderId
6626
6706
  * @permissionId ECOM.COLLECT_PAYMENTS
6707
+ * @permissionScope Manage Stores
6708
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6627
6709
  * @permissionScope Manage Restaurants - all permissions
6628
6710
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6629
6711
  * @applicableIdentity APP
@@ -6658,6 +6740,8 @@ export interface PreparePaymentCollectionOptions {
6658
6740
  * @documentationMaturity preview
6659
6741
  * @requiredField ecomOrderId
6660
6742
  * @permissionId ECOM.COLLECT_PAYMENTS
6743
+ * @permissionScope Manage Stores
6744
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6661
6745
  * @permissionScope Manage Restaurants - all permissions
6662
6746
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6663
6747
  * @applicableIdentity APP
@@ -6675,6 +6759,8 @@ export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Pro
6675
6759
  * @requiredField amount
6676
6760
  * @requiredField orderId
6677
6761
  * @permissionId ECOM.COLLECT_PAYMENTS
6762
+ * @permissionScope Manage Stores
6763
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6678
6764
  * @permissionScope Manage Restaurants - all permissions
6679
6765
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6680
6766
  * @applicableIdentity APP
@@ -6695,6 +6781,8 @@ export declare function recordManuallyCollectedPayment(orderId: string, amount:
6695
6781
  * @permissionId ECOM.MODIFY_ORDERS
6696
6782
  * @permissionScope Manage Stores - all permissions
6697
6783
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6784
+ * @permissionScope Manage Stores
6785
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6698
6786
  * @permissionScope Manage Restaurants - all permissions
6699
6787
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6700
6788
  * @permissionScope Manage eCommerce - all permissions
@@ -6716,6 +6804,8 @@ export declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): P
6716
6804
  * @permissionId ECOM.MODIFY_ORDERS
6717
6805
  * @permissionScope Manage Stores - all permissions
6718
6806
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6807
+ * @permissionScope Manage Stores
6808
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6719
6809
  * @permissionScope Manage Restaurants - all permissions
6720
6810
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6721
6811
  * @permissionScope Manage eCommerce - all permissions
@@ -6737,6 +6827,8 @@ export declare function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: stri
6737
6827
  * @permissionId ECOM.READ_TRANSACTIONS
6738
6828
  * @permissionScope Manage Stores - all permissions
6739
6829
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6830
+ * @permissionScope Manage Stores
6831
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6740
6832
  * @permissionScope Read eCommerce - all read permissions
6741
6833
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6742
6834
  * @permissionScope Read Orders
@@ -6766,6 +6858,8 @@ export declare function getRefundabilityStatus(ecomOrderId: string): Promise<Non
6766
6858
  * @permissionId ECOM.MODIFY_ORDERS
6767
6859
  * @permissionScope Manage Stores - all permissions
6768
6860
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6861
+ * @permissionScope Manage Stores
6862
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6769
6863
  * @permissionScope Manage Restaurants - all permissions
6770
6864
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6771
6865
  * @permissionScope Manage eCommerce - all permissions
@@ -6798,6 +6892,8 @@ export interface PaymentCollectionCreatePaymentGatewayOrderOptions {
6798
6892
  * @permissionId ECOM.MODIFY_TRANSACTIONS
6799
6893
  * @permissionScope Manage Stores - all permissions
6800
6894
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6895
+ * @permissionScope Manage Stores
6896
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6801
6897
  * @permissionScope Manage Restaurants - all permissions
6802
6898
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6803
6899
  * @permissionScope Manage eCommerce - all permissions
@@ -6831,6 +6927,8 @@ export interface ChargeMembershipsOptions {
6831
6927
  * @permissionId ECOM.MODIFY_TRANSACTIONS
6832
6928
  * @permissionScope Manage Stores - all permissions
6833
6929
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6930
+ * @permissionScope Manage Stores
6931
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6834
6932
  * @permissionScope Manage Restaurants - all permissions
6835
6933
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6836
6934
  * @permissionScope Manage eCommerce - all permissions
@@ -6859,6 +6957,8 @@ export interface TriggerRefundOptions {
6859
6957
  * @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
6860
6958
  * @permissionScope Manage Stores - all permissions
6861
6959
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6960
+ * @permissionScope Manage Stores
6961
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6862
6962
  * @permissionScope Manage Restaurants - all permissions
6863
6963
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6864
6964
  * @permissionScope Manage eCommerce - all permissions
@@ -6882,6 +6982,8 @@ export declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds:
6882
6982
  * @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
6883
6983
  * @permissionScope Manage Stores - all permissions
6884
6984
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6985
+ * @permissionScope Manage Stores
6986
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6885
6987
  * @permissionScope Manage Restaurants - all permissions
6886
6988
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6887
6989
  * @permissionScope Manage eCommerce - all permissions
@@ -6906,6 +7008,8 @@ export declare function captureAuthorizedPayments(ecomOrderId: string, payments:
6906
7008
  * @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
6907
7009
  * @permissionScope Manage Stores - all permissions
6908
7010
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7011
+ * @permissionScope Manage Stores
7012
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6909
7013
  * @permissionScope Read eCommerce - all read permissions
6910
7014
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6911
7015
  * @permissionScope Read Orders
@@ -6942,6 +7046,8 @@ export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, O
6942
7046
  * @permissionId ECOM.READ_ORDERS
6943
7047
  * @permissionScope Manage Stores - all permissions
6944
7048
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7049
+ * @permissionScope Manage Stores
7050
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6945
7051
  * @permissionScope Read eCommerce - all read permissions
6946
7052
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6947
7053
  * @permissionScope Read Orders
@@ -6993,6 +7099,8 @@ export interface SearchOrdersOptions {
6993
7099
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
6994
7100
  * @permissionScope Manage Stores - all permissions
6995
7101
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7102
+ * @permissionScope Manage Stores
7103
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
6996
7104
  * @permissionScope Manage Restaurants - all permissions
6997
7105
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6998
7106
  * @permissionScope Manage eCommerce - all permissions
@@ -7042,6 +7150,8 @@ export interface CreateOrderOptions {
7042
7150
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
7043
7151
  * @permissionScope Manage Stores - all permissions
7044
7152
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7153
+ * @permissionScope Manage Stores
7154
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7045
7155
  * @permissionScope Manage Restaurants - all permissions
7046
7156
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7047
7157
  * @permissionScope Manage eCommerce - all permissions
@@ -7261,6 +7371,8 @@ export interface UpdateOrder {
7261
7371
  * @permissionId ECOM.MODIFY_ORDERS
7262
7372
  * @permissionScope Manage Stores - all permissions
7263
7373
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7374
+ * @permissionScope Manage Stores
7375
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7264
7376
  * @permissionScope Manage Restaurants - all permissions
7265
7377
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7266
7378
  * @permissionScope Manage eCommerce - all permissions
@@ -7290,6 +7402,9 @@ export interface BulkUpdateOrdersOptions {
7290
7402
  * @requiredField options.changes.priceSummary.total
7291
7403
  * @permissionId ECOM.ORDERS_DELTAS_COMMIT
7292
7404
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
7405
+ * @permissionScope Manage Stores
7406
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7407
+ * @applicableIdentity APP
7293
7408
  * @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
7294
7409
  */
7295
7410
  export declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
@@ -7321,6 +7436,8 @@ export interface CommitDeltasOptions {
7321
7436
  * @permissionId ECOM.MODIFY_ORDERS
7322
7437
  * @permissionScope Manage Stores - all permissions
7323
7438
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7439
+ * @permissionScope Manage Stores
7440
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7324
7441
  * @permissionScope Manage Restaurants - all permissions
7325
7442
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7326
7443
  * @permissionScope Manage eCommerce - all permissions
@@ -7470,6 +7587,13 @@ export interface UpdateOrderLineItem {
7470
7587
  * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
7471
7588
  */
7472
7589
  extendedFields?: ExtendedFields;
7590
+ /**
7591
+ * Modifier groups that were added to the item.
7592
+ * @internal
7593
+ * @readonly
7594
+ * @maxSize 10
7595
+ */
7596
+ modifierGroups?: ModifierGroup[];
7473
7597
  }
7474
7598
  /**
7475
7599
  * Adds a merchant comment to an order.
@@ -7483,6 +7607,8 @@ export interface UpdateOrderLineItem {
7483
7607
  * @permissionId ECOM.MODIFY_ORDERS
7484
7608
  * @permissionScope Manage Stores - all permissions
7485
7609
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7610
+ * @permissionScope Manage Stores
7611
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7486
7612
  * @permissionScope Manage Restaurants - all permissions
7487
7613
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7488
7614
  * @permissionScope Manage eCommerce - all permissions
@@ -7510,6 +7636,8 @@ export declare function addActivity(_id: string, activity: PublicActivity): Prom
7510
7636
  * @permissionId ECOM.MODIFY_ORDERS
7511
7637
  * @permissionScope Manage Stores - all permissions
7512
7638
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7639
+ * @permissionScope Manage Stores
7640
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7513
7641
  * @permissionScope Manage Restaurants - all permissions
7514
7642
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7515
7643
  * @permissionScope Manage eCommerce - all permissions
@@ -7547,6 +7675,8 @@ export interface UpdateActivityIdentifiers {
7547
7675
  * @permissionId ECOM.MODIFY_ORDERS
7548
7676
  * @permissionScope Manage Stores - all permissions
7549
7677
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7678
+ * @permissionScope Manage Stores
7679
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7550
7680
  * @permissionScope Manage Restaurants - all permissions
7551
7681
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7552
7682
  * @permissionScope Manage eCommerce - all permissions
@@ -7583,6 +7713,8 @@ export interface DeleteActivityIdentifiers {
7583
7713
  * @permissionId ECOM.MODIFY_ORDERS
7584
7714
  * @permissionScope Manage Stores - all permissions
7585
7715
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7716
+ * @permissionScope Manage Stores
7717
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7586
7718
  * @permissionScope Manage Restaurants - all permissions
7587
7719
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7588
7720
  * @permissionScope Manage eCommerce - all permissions
@@ -7630,6 +7762,8 @@ export interface CancelOrderOptions {
7630
7762
  * @permissionId ECOM.ORDER_UPDATE_STATUS
7631
7763
  * @permissionScope Manage Stores - all permissions
7632
7764
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7765
+ * @permissionScope Manage Stores
7766
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7633
7767
  * @permissionScope Manage Restaurants - all permissions
7634
7768
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7635
7769
  * @permissionScope Manage eCommerce - all permissions
@@ -7648,6 +7782,8 @@ export declare function updateOrderStatus(orderId: string, status: OrderStatus):
7648
7782
  * @permissionId ECOM.READ_ORDERS
7649
7783
  * @permissionScope Manage Stores - all permissions
7650
7784
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7785
+ * @permissionScope Manage Stores
7786
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7651
7787
  * @permissionScope Read eCommerce - all read permissions
7652
7788
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
7653
7789
  * @permissionScope Read Orders
@@ -7691,6 +7827,8 @@ export interface AggregateOrdersOptions {
7691
7827
  * @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
7692
7828
  * @permissionScope Manage Stores - all permissions
7693
7829
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7830
+ * @permissionScope Manage Stores
7831
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7694
7832
  * @permissionScope Manage Restaurants - all permissions
7695
7833
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7696
7834
  * @permissionScope Manage eCommerce - all permissions
@@ -7699,6 +7837,8 @@ export interface AggregateOrdersOptions {
7699
7837
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
7700
7838
  * @permissionScope Manage Stores - all permissions
7701
7839
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7840
+ * @permissionScope Manage Stores
7841
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7702
7842
  * @permissionScope Manage Restaurants - all permissions
7703
7843
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7704
7844
  * @permissionScope Manage eCommerce - all permissions
@@ -694,6 +694,8 @@ var InvoiceStatus;
694
694
  * @requiredField amount
695
695
  * @requiredField ecomOrderId
696
696
  * @permissionId ECOM.COLLECT_PAYMENTS
697
+ * @permissionScope Manage Stores
698
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
697
699
  * @permissionScope Manage Restaurants - all permissions
698
700
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
699
701
  * @applicableIdentity APP
@@ -742,6 +744,8 @@ exports.preparePaymentCollection = preparePaymentCollection;
742
744
  * @documentationMaturity preview
743
745
  * @requiredField ecomOrderId
744
746
  * @permissionId ECOM.COLLECT_PAYMENTS
747
+ * @permissionScope Manage Stores
748
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
745
749
  * @permissionScope Manage Restaurants - all permissions
746
750
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
747
751
  * @applicableIdentity APP
@@ -782,6 +786,8 @@ exports.getPaymentCollectabilityStatus = getPaymentCollectabilityStatus;
782
786
  * @requiredField amount
783
787
  * @requiredField orderId
784
788
  * @permissionId ECOM.COLLECT_PAYMENTS
789
+ * @permissionScope Manage Stores
790
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
785
791
  * @permissionScope Manage Restaurants - all permissions
786
792
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
787
793
  * @applicableIdentity APP
@@ -825,6 +831,8 @@ exports.recordManuallyCollectedPayment = recordManuallyCollectedPayment;
825
831
  * @permissionId ECOM.MODIFY_ORDERS
826
832
  * @permissionScope Manage Stores - all permissions
827
833
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
834
+ * @permissionScope Manage Stores
835
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
828
836
  * @permissionScope Manage Restaurants - all permissions
829
837
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
830
838
  * @permissionScope Manage eCommerce - all permissions
@@ -883,6 +891,8 @@ exports.paymentCollectionMarkOrderAsPaid = paymentCollectionMarkOrderAsPaid;
883
891
  * @permissionId ECOM.MODIFY_ORDERS
884
892
  * @permissionScope Manage Stores - all permissions
885
893
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
894
+ * @permissionScope Manage Stores
895
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
886
896
  * @permissionScope Manage Restaurants - all permissions
887
897
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
888
898
  * @permissionScope Manage eCommerce - all permissions
@@ -943,6 +953,8 @@ exports.paymentCollectionBulkMarkOrdersAsPaid = paymentCollectionBulkMarkOrdersA
943
953
  * @permissionId ECOM.READ_TRANSACTIONS
944
954
  * @permissionScope Manage Stores - all permissions
945
955
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
956
+ * @permissionScope Manage Stores
957
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
946
958
  * @permissionScope Read eCommerce - all read permissions
947
959
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
948
960
  * @permissionScope Read Orders
@@ -995,6 +1007,8 @@ exports.getRefundabilityStatus = getRefundabilityStatus;
995
1007
  * @permissionId ECOM.MODIFY_ORDERS
996
1008
  * @permissionScope Manage Stores - all permissions
997
1009
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1010
+ * @permissionScope Manage Stores
1011
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
998
1012
  * @permissionScope Manage Restaurants - all permissions
999
1013
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1000
1014
  * @permissionScope Manage eCommerce - all permissions
@@ -1050,6 +1064,8 @@ exports.paymentCollectionCreatePaymentGatewayOrder = paymentCollectionCreatePaym
1050
1064
  * @permissionId ECOM.MODIFY_TRANSACTIONS
1051
1065
  * @permissionScope Manage Stores - all permissions
1052
1066
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1067
+ * @permissionScope Manage Stores
1068
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1053
1069
  * @permissionScope Manage Restaurants - all permissions
1054
1070
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1055
1071
  * @permissionScope Manage eCommerce - all permissions
@@ -1103,6 +1119,8 @@ exports.chargeMemberships = chargeMemberships;
1103
1119
  * @permissionId ECOM.MODIFY_TRANSACTIONS
1104
1120
  * @permissionScope Manage Stores - all permissions
1105
1121
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1122
+ * @permissionScope Manage Stores
1123
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1106
1124
  * @permissionScope Manage Restaurants - all permissions
1107
1125
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1108
1126
  * @permissionScope Manage eCommerce - all permissions
@@ -1156,6 +1174,8 @@ exports.triggerRefund = triggerRefund;
1156
1174
  * @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
1157
1175
  * @permissionScope Manage Stores - all permissions
1158
1176
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1177
+ * @permissionScope Manage Stores
1178
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1159
1179
  * @permissionScope Manage Restaurants - all permissions
1160
1180
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1161
1181
  * @permissionScope Manage eCommerce - all permissions
@@ -1203,6 +1223,8 @@ exports.voidAuthorizedPayments = voidAuthorizedPayments;
1203
1223
  * @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
1204
1224
  * @permissionScope Manage Stores - all permissions
1205
1225
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1226
+ * @permissionScope Manage Stores
1227
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1206
1228
  * @permissionScope Manage Restaurants - all permissions
1207
1229
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1208
1230
  * @permissionScope Manage eCommerce - all permissions
@@ -1251,6 +1273,8 @@ exports.captureAuthorizedPayments = captureAuthorizedPayments;
1251
1273
  * @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
1252
1274
  * @permissionScope Manage Stores - all permissions
1253
1275
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1276
+ * @permissionScope Manage Stores
1277
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1254
1278
  * @permissionScope Read eCommerce - all read permissions
1255
1279
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1256
1280
  * @permissionScope Read Orders
@@ -1324,6 +1348,8 @@ exports.getOrder = getOrder;
1324
1348
  * @permissionId ECOM.READ_ORDERS
1325
1349
  * @permissionScope Manage Stores - all permissions
1326
1350
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1351
+ * @permissionScope Manage Stores
1352
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1327
1353
  * @permissionScope Read eCommerce - all read permissions
1328
1354
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1329
1355
  * @permissionScope Read Orders
@@ -1408,6 +1434,8 @@ exports.searchOrders = searchOrders;
1408
1434
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1409
1435
  * @permissionScope Manage Stores - all permissions
1410
1436
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1437
+ * @permissionScope Manage Stores
1438
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1411
1439
  * @permissionScope Manage Restaurants - all permissions
1412
1440
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1413
1441
  * @permissionScope Manage eCommerce - all permissions
@@ -1507,6 +1535,8 @@ exports.createOrder = createOrder;
1507
1535
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1508
1536
  * @permissionScope Manage Stores - all permissions
1509
1537
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1538
+ * @permissionScope Manage Stores
1539
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1510
1540
  * @permissionScope Manage Restaurants - all permissions
1511
1541
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1512
1542
  * @permissionScope Manage eCommerce - all permissions
@@ -1603,6 +1633,8 @@ exports.updateOrder = updateOrder;
1603
1633
  * @permissionId ECOM.MODIFY_ORDERS
1604
1634
  * @permissionScope Manage Stores - all permissions
1605
1635
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1636
+ * @permissionScope Manage Stores
1637
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1606
1638
  * @permissionScope Manage Restaurants - all permissions
1607
1639
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1608
1640
  * @permissionScope Manage eCommerce - all permissions
@@ -1683,6 +1715,9 @@ exports.bulkUpdateOrders = bulkUpdateOrders;
1683
1715
  * @requiredField options.changes.priceSummary.total
1684
1716
  * @permissionId ECOM.ORDERS_DELTAS_COMMIT
1685
1717
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1718
+ * @permissionScope Manage Stores
1719
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1720
+ * @applicableIdentity APP
1686
1721
  * @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
1687
1722
  */
1688
1723
  async function commitDeltas(_id, options) {
@@ -1762,6 +1797,8 @@ exports.commitDeltas = commitDeltas;
1762
1797
  * @permissionId ECOM.MODIFY_ORDERS
1763
1798
  * @permissionScope Manage Stores - all permissions
1764
1799
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1800
+ * @permissionScope Manage Stores
1801
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1765
1802
  * @permissionScope Manage Restaurants - all permissions
1766
1803
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1767
1804
  * @permissionScope Manage eCommerce - all permissions
@@ -1834,6 +1871,8 @@ exports.updateOrderLineItem = updateOrderLineItem;
1834
1871
  * @permissionId ECOM.MODIFY_ORDERS
1835
1872
  * @permissionScope Manage Stores - all permissions
1836
1873
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1874
+ * @permissionScope Manage Stores
1875
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1837
1876
  * @permissionScope Manage Restaurants - all permissions
1838
1877
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1839
1878
  * @permissionScope Manage eCommerce - all permissions
@@ -1899,6 +1938,8 @@ exports.addActivity = addActivity;
1899
1938
  * @permissionId ECOM.MODIFY_ORDERS
1900
1939
  * @permissionScope Manage Stores - all permissions
1901
1940
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1941
+ * @permissionScope Manage Stores
1942
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1902
1943
  * @permissionScope Manage Restaurants - all permissions
1903
1944
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1904
1945
  * @permissionScope Manage eCommerce - all permissions
@@ -1966,6 +2007,8 @@ exports.updateActivity = updateActivity;
1966
2007
  * @permissionId ECOM.MODIFY_ORDERS
1967
2008
  * @permissionScope Manage Stores - all permissions
1968
2009
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2010
+ * @permissionScope Manage Stores
2011
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1969
2012
  * @permissionScope Manage Restaurants - all permissions
1970
2013
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1971
2014
  * @permissionScope Manage eCommerce - all permissions
@@ -2030,6 +2073,8 @@ exports.deleteActivity = deleteActivity;
2030
2073
  * @permissionId ECOM.MODIFY_ORDERS
2031
2074
  * @permissionScope Manage Stores - all permissions
2032
2075
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2076
+ * @permissionScope Manage Stores
2077
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2033
2078
  * @permissionScope Manage Restaurants - all permissions
2034
2079
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2035
2080
  * @permissionScope Manage eCommerce - all permissions
@@ -2110,6 +2155,8 @@ exports.cancelOrder = cancelOrder;
2110
2155
  * @permissionId ECOM.ORDER_UPDATE_STATUS
2111
2156
  * @permissionScope Manage Stores - all permissions
2112
2157
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2158
+ * @permissionScope Manage Stores
2159
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2113
2160
  * @permissionScope Manage Restaurants - all permissions
2114
2161
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2115
2162
  * @permissionScope Manage eCommerce - all permissions
@@ -2166,6 +2213,8 @@ exports.updateOrderStatus = updateOrderStatus;
2166
2213
  * @permissionId ECOM.READ_ORDERS
2167
2214
  * @permissionScope Manage Stores - all permissions
2168
2215
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2216
+ * @permissionScope Manage Stores
2217
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2169
2218
  * @permissionScope Read eCommerce - all read permissions
2170
2219
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
2171
2220
  * @permissionScope Read Orders
@@ -2222,6 +2271,8 @@ exports.aggregateOrders = aggregateOrders;
2222
2271
  * @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
2223
2272
  * @permissionScope Manage Stores - all permissions
2224
2273
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2274
+ * @permissionScope Manage Stores
2275
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2225
2276
  * @permissionScope Manage Restaurants - all permissions
2226
2277
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2227
2278
  * @permissionScope Manage eCommerce - all permissions
@@ -2230,6 +2281,8 @@ exports.aggregateOrders = aggregateOrders;
2230
2281
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2231
2282
  * @permissionScope Manage Stores - all permissions
2232
2283
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2284
+ * @permissionScope Manage Stores
2285
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2233
2286
  * @permissionScope Manage Restaurants - all permissions
2234
2287
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2235
2288
  * @permissionScope Manage eCommerce - all permissions