@wix/auto_sdk_ecom_orders 1.0.39 → 1.0.41

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 (41) hide show
  1. package/build/cjs/index.typings.d.ts +38 -0
  2. package/build/cjs/index.typings.js.map +1 -1
  3. package/build/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
  4. package/build/cjs/src/ecom-v1-order-orders.public.d.ts +1 -1
  5. package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
  6. package/build/cjs/src/ecom-v1-order-orders.types.d.ts +64 -0
  7. package/build/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
  8. package/build/cjs/src/ecom-v1-order-orders.universal.d.ts +96 -0
  9. package/build/cjs/src/ecom-v1-order-orders.universal.js +53 -0
  10. package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
  11. package/build/es/index.typings.d.ts +38 -0
  12. package/build/es/index.typings.js.map +1 -1
  13. package/build/es/src/ecom-v1-order-orders.context.d.ts +1 -1
  14. package/build/es/src/ecom-v1-order-orders.public.d.ts +1 -1
  15. package/build/es/src/ecom-v1-order-orders.public.js.map +1 -1
  16. package/build/es/src/ecom-v1-order-orders.types.d.ts +64 -0
  17. package/build/es/src/ecom-v1-order-orders.types.js.map +1 -1
  18. package/build/es/src/ecom-v1-order-orders.universal.d.ts +96 -0
  19. package/build/es/src/ecom-v1-order-orders.universal.js +53 -0
  20. package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -1
  21. package/build/internal/cjs/index.typings.d.ts +38 -0
  22. package/build/internal/cjs/index.typings.js.map +1 -1
  23. package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
  24. package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +1 -1
  25. package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
  26. package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +64 -0
  27. package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
  28. package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +141 -1
  29. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +53 -0
  30. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
  31. package/build/internal/es/index.typings.d.ts +38 -0
  32. package/build/internal/es/index.typings.js.map +1 -1
  33. package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +1 -1
  34. package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +1 -1
  35. package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -1
  36. package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +64 -0
  37. package/build/internal/es/src/ecom-v1-order-orders.types.js.map +1 -1
  38. package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +141 -1
  39. package/build/internal/es/src/ecom-v1-order-orders.universal.js +53 -0
  40. package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -1
  41. 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
@@ -667,6 +667,8 @@ export var InvoiceStatus;
667
667
  * @requiredField amount
668
668
  * @requiredField ecomOrderId
669
669
  * @permissionId ECOM.COLLECT_PAYMENTS
670
+ * @permissionScope Manage Stores
671
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
670
672
  * @permissionScope Manage Restaurants - all permissions
671
673
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
672
674
  * @applicableIdentity APP
@@ -714,6 +716,8 @@ export async function preparePaymentCollection(ecomOrderId, amount, options) {
714
716
  * @documentationMaturity preview
715
717
  * @requiredField ecomOrderId
716
718
  * @permissionId ECOM.COLLECT_PAYMENTS
719
+ * @permissionScope Manage Stores
720
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
717
721
  * @permissionScope Manage Restaurants - all permissions
718
722
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
719
723
  * @applicableIdentity APP
@@ -753,6 +757,8 @@ export async function getPaymentCollectabilityStatus(ecomOrderId) {
753
757
  * @requiredField amount
754
758
  * @requiredField orderId
755
759
  * @permissionId ECOM.COLLECT_PAYMENTS
760
+ * @permissionScope Manage Stores
761
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
756
762
  * @permissionScope Manage Restaurants - all permissions
757
763
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
758
764
  * @applicableIdentity APP
@@ -795,6 +801,8 @@ export async function recordManuallyCollectedPayment(orderId, amount) {
795
801
  * @permissionId ECOM.MODIFY_ORDERS
796
802
  * @permissionScope Manage Stores - all permissions
797
803
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
804
+ * @permissionScope Manage Stores
805
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
798
806
  * @permissionScope Manage Restaurants - all permissions
799
807
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
800
808
  * @permissionScope Manage eCommerce - all permissions
@@ -852,6 +860,8 @@ export async function paymentCollectionMarkOrderAsPaid(ecomOrderId) {
852
860
  * @permissionId ECOM.MODIFY_ORDERS
853
861
  * @permissionScope Manage Stores - all permissions
854
862
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
863
+ * @permissionScope Manage Stores
864
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
855
865
  * @permissionScope Manage Restaurants - all permissions
856
866
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
857
867
  * @permissionScope Manage eCommerce - all permissions
@@ -911,6 +921,8 @@ export async function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds) {
911
921
  * @permissionId ECOM.READ_TRANSACTIONS
912
922
  * @permissionScope Manage Stores - all permissions
913
923
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
924
+ * @permissionScope Manage Stores
925
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
914
926
  * @permissionScope Read eCommerce - all read permissions
915
927
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
916
928
  * @permissionScope Read Orders
@@ -962,6 +974,8 @@ export async function getRefundabilityStatus(ecomOrderId) {
962
974
  * @permissionId ECOM.MODIFY_ORDERS
963
975
  * @permissionScope Manage Stores - all permissions
964
976
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
977
+ * @permissionScope Manage Stores
978
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
965
979
  * @permissionScope Manage Restaurants - all permissions
966
980
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
967
981
  * @permissionScope Manage eCommerce - all permissions
@@ -1016,6 +1030,8 @@ export async function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId, op
1016
1030
  * @permissionId ECOM.MODIFY_TRANSACTIONS
1017
1031
  * @permissionScope Manage Stores - all permissions
1018
1032
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1033
+ * @permissionScope Manage Stores
1034
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1019
1035
  * @permissionScope Manage Restaurants - all permissions
1020
1036
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1021
1037
  * @permissionScope Manage eCommerce - all permissions
@@ -1068,6 +1084,8 @@ export async function chargeMemberships(ecomOrderId, memberId, options) {
1068
1084
  * @permissionId ECOM.MODIFY_TRANSACTIONS
1069
1085
  * @permissionScope Manage Stores - all permissions
1070
1086
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1087
+ * @permissionScope Manage Stores
1088
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1071
1089
  * @permissionScope Manage Restaurants - all permissions
1072
1090
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1073
1091
  * @permissionScope Manage eCommerce - all permissions
@@ -1120,6 +1138,8 @@ export async function triggerRefund(ecomOrderId, payments, options) {
1120
1138
  * @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
1121
1139
  * @permissionScope Manage Stores - all permissions
1122
1140
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1141
+ * @permissionScope Manage Stores
1142
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1123
1143
  * @permissionScope Manage Restaurants - all permissions
1124
1144
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1125
1145
  * @permissionScope Manage eCommerce - all permissions
@@ -1166,6 +1186,8 @@ export async function voidAuthorizedPayments(ecomOrderId, paymentIds) {
1166
1186
  * @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
1167
1187
  * @permissionScope Manage Stores - all permissions
1168
1188
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1189
+ * @permissionScope Manage Stores
1190
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1169
1191
  * @permissionScope Manage Restaurants - all permissions
1170
1192
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1171
1193
  * @permissionScope Manage eCommerce - all permissions
@@ -1213,6 +1235,8 @@ export async function captureAuthorizedPayments(ecomOrderId, payments) {
1213
1235
  * @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
1214
1236
  * @permissionScope Manage Stores - all permissions
1215
1237
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1238
+ * @permissionScope Manage Stores
1239
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1216
1240
  * @permissionScope Read eCommerce - all read permissions
1217
1241
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1218
1242
  * @permissionScope Read Orders
@@ -1285,6 +1309,8 @@ export async function getOrder(_id) {
1285
1309
  * @permissionId ECOM.READ_ORDERS
1286
1310
  * @permissionScope Manage Stores - all permissions
1287
1311
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1312
+ * @permissionScope Manage Stores
1313
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1288
1314
  * @permissionScope Read eCommerce - all read permissions
1289
1315
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1290
1316
  * @permissionScope Read Orders
@@ -1368,6 +1394,8 @@ export async function searchOrders(options) {
1368
1394
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1369
1395
  * @permissionScope Manage Stores - all permissions
1370
1396
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1397
+ * @permissionScope Manage Stores
1398
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1371
1399
  * @permissionScope Manage Restaurants - all permissions
1372
1400
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1373
1401
  * @permissionScope Manage eCommerce - all permissions
@@ -1466,6 +1494,8 @@ export async function createOrder(order, options) {
1466
1494
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1467
1495
  * @permissionScope Manage Stores - all permissions
1468
1496
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1497
+ * @permissionScope Manage Stores
1498
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1469
1499
  * @permissionScope Manage Restaurants - all permissions
1470
1500
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1471
1501
  * @permissionScope Manage eCommerce - all permissions
@@ -1561,6 +1591,8 @@ export async function updateOrder(_id, order) {
1561
1591
  * @permissionId ECOM.MODIFY_ORDERS
1562
1592
  * @permissionScope Manage Stores - all permissions
1563
1593
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1594
+ * @permissionScope Manage Stores
1595
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1564
1596
  * @permissionScope Manage Restaurants - all permissions
1565
1597
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1566
1598
  * @permissionScope Manage eCommerce - all permissions
@@ -1640,6 +1672,9 @@ export async function bulkUpdateOrders(orders, options) {
1640
1672
  * @requiredField options.changes.priceSummary.total
1641
1673
  * @permissionId ECOM.ORDERS_DELTAS_COMMIT
1642
1674
  * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1675
+ * @permissionScope Manage Stores
1676
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1677
+ * @applicableIdentity APP
1643
1678
  * @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
1644
1679
  */
1645
1680
  export async function commitDeltas(_id, options) {
@@ -1718,6 +1753,8 @@ export async function commitDeltas(_id, options) {
1718
1753
  * @permissionId ECOM.MODIFY_ORDERS
1719
1754
  * @permissionScope Manage Stores - all permissions
1720
1755
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1756
+ * @permissionScope Manage Stores
1757
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1721
1758
  * @permissionScope Manage Restaurants - all permissions
1722
1759
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1723
1760
  * @permissionScope Manage eCommerce - all permissions
@@ -1789,6 +1826,8 @@ export async function updateOrderLineItem(identifiers, lineItem) {
1789
1826
  * @permissionId ECOM.MODIFY_ORDERS
1790
1827
  * @permissionScope Manage Stores - all permissions
1791
1828
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1829
+ * @permissionScope Manage Stores
1830
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1792
1831
  * @permissionScope Manage Restaurants - all permissions
1793
1832
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1794
1833
  * @permissionScope Manage eCommerce - all permissions
@@ -1853,6 +1892,8 @@ export async function addActivity(_id, activity) {
1853
1892
  * @permissionId ECOM.MODIFY_ORDERS
1854
1893
  * @permissionScope Manage Stores - all permissions
1855
1894
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1895
+ * @permissionScope Manage Stores
1896
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1856
1897
  * @permissionScope Manage Restaurants - all permissions
1857
1898
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1858
1899
  * @permissionScope Manage eCommerce - all permissions
@@ -1919,6 +1960,8 @@ export async function updateActivity(identifiers, activity) {
1919
1960
  * @permissionId ECOM.MODIFY_ORDERS
1920
1961
  * @permissionScope Manage Stores - all permissions
1921
1962
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1963
+ * @permissionScope Manage Stores
1964
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1922
1965
  * @permissionScope Manage Restaurants - all permissions
1923
1966
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1924
1967
  * @permissionScope Manage eCommerce - all permissions
@@ -1982,6 +2025,8 @@ export async function deleteActivity(identifiers) {
1982
2025
  * @permissionId ECOM.MODIFY_ORDERS
1983
2026
  * @permissionScope Manage Stores - all permissions
1984
2027
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2028
+ * @permissionScope Manage Stores
2029
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1985
2030
  * @permissionScope Manage Restaurants - all permissions
1986
2031
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1987
2032
  * @permissionScope Manage eCommerce - all permissions
@@ -2061,6 +2106,8 @@ export async function cancelOrder(_id, options) {
2061
2106
  * @permissionId ECOM.ORDER_UPDATE_STATUS
2062
2107
  * @permissionScope Manage Stores - all permissions
2063
2108
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2109
+ * @permissionScope Manage Stores
2110
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2064
2111
  * @permissionScope Manage Restaurants - all permissions
2065
2112
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2066
2113
  * @permissionScope Manage eCommerce - all permissions
@@ -2116,6 +2163,8 @@ export async function updateOrderStatus(orderId, status) {
2116
2163
  * @permissionId ECOM.READ_ORDERS
2117
2164
  * @permissionScope Manage Stores - all permissions
2118
2165
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2166
+ * @permissionScope Manage Stores
2167
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2119
2168
  * @permissionScope Read eCommerce - all read permissions
2120
2169
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
2121
2170
  * @permissionScope Read Orders
@@ -2171,6 +2220,8 @@ export async function aggregateOrders(options) {
2171
2220
  * @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
2172
2221
  * @permissionScope Manage Stores - all permissions
2173
2222
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2223
+ * @permissionScope Manage Stores
2224
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2174
2225
  * @permissionScope Manage Restaurants - all permissions
2175
2226
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2176
2227
  * @permissionScope Manage eCommerce - all permissions
@@ -2179,6 +2230,8 @@ export async function aggregateOrders(options) {
2179
2230
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2180
2231
  * @permissionScope Manage Stores - all permissions
2181
2232
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2233
+ * @permissionScope Manage Stores
2234
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2182
2235
  * @permissionScope Manage Restaurants - all permissions
2183
2236
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2184
2237
  * @permissionScope Manage eCommerce - all permissions