@wix/auto_sdk_stores_products 1.0.9 → 1.0.11

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.
@@ -1907,6 +1907,8 @@ export interface ProductCollectionChangedEnvelope {
1907
1907
  * Triggered when a collection is changed.
1908
1908
  * @permissionScope Manage Stores - all permissions
1909
1909
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1910
+ * @permissionScope Manage Stores
1911
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1910
1912
  * @permissionScope Manage Products
1911
1913
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1912
1914
  * @permissionScope Read Stores - all read permissions
@@ -1932,6 +1934,8 @@ export interface ProductCollectionCreatedEnvelope {
1932
1934
  * Triggered when a collection is created.
1933
1935
  * @permissionScope Manage Stores - all permissions
1934
1936
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1937
+ * @permissionScope Manage Stores
1938
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1935
1939
  * @permissionScope Manage Products
1936
1940
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1937
1941
  * @permissionScope Read Stores - all read permissions
@@ -1957,6 +1961,8 @@ export interface ProductCollectionDeletedEnvelope {
1957
1961
  * Triggered when a collection is deleted.
1958
1962
  * @permissionScope Manage Stores - all permissions
1959
1963
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1964
+ * @permissionScope Manage Stores
1965
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1960
1966
  * @permissionScope Manage Products
1961
1967
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1962
1968
  * @permissionScope Read Stores - all read permissions
@@ -1982,6 +1988,8 @@ export interface ProductChangedEnvelope {
1982
1988
  * Triggered when a product is changed.
1983
1989
  * @permissionScope Manage Stores - all permissions
1984
1990
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1991
+ * @permissionScope Manage Stores
1992
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1985
1993
  * @permissionScope Manage Products
1986
1994
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1987
1995
  * @permissionScope Read Stores - all read permissions
@@ -2007,6 +2015,8 @@ export interface ProductCreatedEnvelope {
2007
2015
  * Triggered when a product is created.
2008
2016
  * @permissionScope Manage Stores - all permissions
2009
2017
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2018
+ * @permissionScope Manage Stores
2019
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2010
2020
  * @permissionScope Manage Products
2011
2021
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2012
2022
  * @permissionScope Read Stores - all read permissions
@@ -2032,6 +2042,8 @@ export interface ProductDeletedEnvelope {
2032
2042
  * Triggered when a product is deleted.
2033
2043
  * @permissionScope Manage Stores - all permissions
2034
2044
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2045
+ * @permissionScope Manage Stores
2046
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2035
2047
  * @permissionScope Manage Products
2036
2048
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2037
2049
  * @permissionScope Read Stores - all read permissions
@@ -2057,6 +2069,8 @@ export interface ProductVariantsChangedEnvelope {
2057
2069
  * Triggered when a product variant is changed.
2058
2070
  * @permissionScope Manage Stores - all permissions
2059
2071
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2072
+ * @permissionScope Manage Stores
2073
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2060
2074
  * @permissionScope Manage Products
2061
2075
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2062
2076
  * @permissionScope Read Stores - all read permissions
@@ -2087,6 +2101,8 @@ type ProductNonNullablePaths = `_id` | `slug` | `productType` | `weightRange.min
2087
2101
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2088
2102
  * @permissionScope Manage Stores - all permissions
2089
2103
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2104
+ * @permissionScope Manage Stores
2105
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2090
2106
  * @permissionScope Manage Products
2091
2107
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2092
2108
  * @applicableIdentity APP
@@ -2107,6 +2123,8 @@ export declare function createProduct(product: NonNullablePaths<Product, `costAn
2107
2123
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2108
2124
  * @permissionScope Manage Stores - all permissions
2109
2125
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2126
+ * @permissionScope Manage Stores
2127
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2110
2128
  * @permissionScope Manage Products
2111
2129
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2112
2130
  * @applicableIdentity APP
@@ -2279,6 +2297,8 @@ export interface UpdateProduct {
2279
2297
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2280
2298
  * @permissionScope Manage Stores - all permissions
2281
2299
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2300
+ * @permissionScope Manage Stores
2301
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2282
2302
  * @permissionScope Manage Products
2283
2303
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2284
2304
  * @applicableIdentity APP
@@ -2295,6 +2315,8 @@ export declare function deleteProduct(_id: string): Promise<void>;
2295
2315
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2296
2316
  * @permissionScope Manage Stores - all permissions
2297
2317
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2318
+ * @permissionScope Manage Stores
2319
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2298
2320
  * @permissionScope Manage Products
2299
2321
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2300
2322
  * @applicableIdentity APP
@@ -2309,6 +2331,8 @@ export declare function updateProductVariants(_id: string, variants: VariantOver
2309
2331
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2310
2332
  * @permissionScope Manage Stores - all permissions
2311
2333
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2334
+ * @permissionScope Manage Stores
2335
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2312
2336
  * @permissionScope Manage Products
2313
2337
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2314
2338
  * @applicableIdentity APP
@@ -2325,6 +2349,8 @@ export declare function resetAllProductVariantData(_id: string): Promise<void>;
2325
2349
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2326
2350
  * @permissionScope Manage Stores - all permissions
2327
2351
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2352
+ * @permissionScope Manage Stores
2353
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2328
2354
  * @permissionScope Manage Products
2329
2355
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2330
2356
  * @applicableIdentity APP
@@ -2336,12 +2362,13 @@ export declare function addProductsToCollection(_id: string, productIds: string[
2336
2362
  * @param _id - ID of the collection from which to remove products.
2337
2363
  * @param productIds - IDs of the products to remove from the collection.
2338
2364
  * @public
2339
- * @documentationMaturity preview
2340
2365
  * @requiredField _id
2341
2366
  * @requiredField productIds
2342
2367
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2343
2368
  * @permissionScope Manage Stores - all permissions
2344
2369
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2370
+ * @permissionScope Manage Stores
2371
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2345
2372
  * @permissionScope Manage Products
2346
2373
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2347
2374
  * @applicableIdentity APP
@@ -2360,6 +2387,8 @@ export declare function removeProductsFromCollection(_id: string, productIds: st
2360
2387
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2361
2388
  * @permissionScope Manage Stores - all permissions
2362
2389
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2390
+ * @permissionScope Manage Stores
2391
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2363
2392
  * @permissionScope Manage Products
2364
2393
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2365
2394
  * @applicableIdentity APP
@@ -2377,6 +2406,8 @@ export declare function addProductMedia(_id: string, media: MediaDataForWrite[])
2377
2406
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2378
2407
  * @permissionScope Manage Stores - all permissions
2379
2408
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2409
+ * @permissionScope Manage Stores
2410
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2380
2411
  * @permissionScope Manage Products
2381
2412
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2382
2413
  * @applicableIdentity APP
@@ -2392,7 +2423,6 @@ export declare function removeProductMedia(_id: string, mediaIds: string[]): Pro
2392
2423
  * @param _id - Product ID.
2393
2424
  * @param media - Product media items and the choices to add the media to.
2394
2425
  * @public
2395
- * @documentationMaturity preview
2396
2426
  * @requiredField _id
2397
2427
  * @requiredField media
2398
2428
  * @requiredField media.choice
@@ -2400,6 +2430,8 @@ export declare function removeProductMedia(_id: string, mediaIds: string[]): Pro
2400
2430
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2401
2431
  * @permissionScope Manage Stores - all permissions
2402
2432
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2433
+ * @permissionScope Manage Stores
2434
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2403
2435
  * @permissionScope Manage Products
2404
2436
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2405
2437
  * @applicableIdentity APP
@@ -2412,12 +2444,13 @@ export declare function addProductMediaToChoices(_id: string, media: NonNullable
2412
2444
  * @param _id - Product ID from whose choices to remove media items.
2413
2445
  * @param media - Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.
2414
2446
  * @public
2415
- * @documentationMaturity preview
2416
2447
  * @requiredField _id
2417
2448
  * @requiredField media
2418
2449
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2419
2450
  * @permissionScope Manage Stores - all permissions
2420
2451
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2452
+ * @permissionScope Manage Stores
2453
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2421
2454
  * @permissionScope Manage Products
2422
2455
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2423
2456
  * @applicableIdentity APP
@@ -2428,11 +2461,12 @@ export declare function removeProductMediaFromChoices(_id: string, media: MediaA
2428
2461
  * Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.
2429
2462
  * @param _id - ID of the product with options to delete.
2430
2463
  * @public
2431
- * @documentationMaturity preview
2432
2464
  * @requiredField _id
2433
2465
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2434
2466
  * @permissionScope Manage Stores - all permissions
2435
2467
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2468
+ * @permissionScope Manage Stores
2469
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2436
2470
  * @permissionScope Manage Products
2437
2471
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2438
2472
  * @applicableIdentity APP
@@ -2447,6 +2481,8 @@ export declare function deleteProductOptions(_id: string): Promise<void>;
2447
2481
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2448
2482
  * @permissionScope Manage Stores - all permissions
2449
2483
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2484
+ * @permissionScope Manage Stores
2485
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2450
2486
  * @permissionScope Manage Products
2451
2487
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2452
2488
  * @applicableIdentity APP
@@ -2462,6 +2498,8 @@ export declare function removeBrand(_id: string): Promise<void>;
2462
2498
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2463
2499
  * @permissionScope Manage Stores - all permissions
2464
2500
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2501
+ * @permissionScope Manage Stores
2502
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2465
2503
  * @permissionScope Manage Products
2466
2504
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2467
2505
  * @applicableIdentity APP
@@ -2472,13 +2510,14 @@ export declare function createCollection(collection: NonNullablePaths<Collection
2472
2510
  * Updates specified properties of a collection. To add products to a collection, call the [addProductsToCollection](#addproductstocollection) function.
2473
2511
  * @param _id - Collection ID (generated automatically by the catalog).
2474
2512
  * @public
2475
- * @documentationMaturity preview
2476
2513
  * @requiredField _id
2477
2514
  * @requiredField collection
2478
2515
  * @param collection - Collection info to update.
2479
2516
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2480
2517
  * @permissionScope Manage Stores - all permissions
2481
2518
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2519
+ * @permissionScope Manage Stores
2520
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2482
2521
  * @permissionScope Manage Products
2483
2522
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2484
2523
  * @applicableIdentity APP
@@ -2526,12 +2565,13 @@ export interface UpdateCollection {
2526
2565
  /**
2527
2566
  * Deletes a collection.
2528
2567
  * @public
2529
- * @documentationMaturity preview
2530
2568
  * @requiredField _id
2531
2569
  * @param _id - ID of the collection to delete.
2532
2570
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2533
2571
  * @permissionScope Manage Stores - all permissions
2534
2572
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2573
+ * @permissionScope Manage Stores
2574
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2535
2575
  * @permissionScope Manage Products
2536
2576
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2537
2577
  * @applicableIdentity APP
@@ -2546,6 +2586,8 @@ export declare function deleteCollection(_id: string): Promise<void>;
2546
2586
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2547
2587
  * @permissionScope Manage Stores - all permissions
2548
2588
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2589
+ * @permissionScope Manage Stores
2590
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2549
2591
  * @permissionScope Manage Products
2550
2592
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2551
2593
  * @applicableIdentity APP
@@ -2557,12 +2599,13 @@ export declare function removeRibbon(_id: string): Promise<void>;
2557
2599
  * @param ids - Product IDs.
2558
2600
  * @param set - Field to update.
2559
2601
  * @public
2560
- * @documentationMaturity preview
2561
2602
  * @requiredField ids
2562
2603
  * @requiredField set
2563
2604
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2564
2605
  * @permissionScope Manage Stores - all permissions
2565
2606
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2607
+ * @permissionScope Manage Stores
2608
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2566
2609
  * @permissionScope Manage Products
2567
2610
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2568
2611
  * @applicableIdentity APP
@@ -2575,12 +2618,13 @@ export declare function bulkUpdateProductsProperty(ids: string[], set: SetValue)
2575
2618
  * @param adjust - Numerical property to adjust.
2576
2619
  * @param ids - Product IDs.
2577
2620
  * @public
2578
- * @documentationMaturity preview
2579
2621
  * @requiredField adjust
2580
2622
  * @requiredField ids
2581
2623
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
2582
2624
  * @permissionScope Manage Stores - all permissions
2583
2625
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2626
+ * @permissionScope Manage Stores
2627
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2584
2628
  * @permissionScope Manage Products
2585
2629
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2586
2630
  * @applicableIdentity APP
@@ -2592,6 +2636,8 @@ export declare function bulkAdjustProductProperty(adjust: AdjustValue, ids: stri
2592
2636
  * @public
2593
2637
  * @permissionScope Manage Stores - all permissions
2594
2638
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2639
+ * @permissionScope Manage Stores
2640
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2595
2641
  * @permissionScope Manage Products
2596
2642
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2597
2643
  * @permissionScope Read Stores - all read permissions
@@ -2680,6 +2726,8 @@ export interface ProductsQueryBuilder {
2680
2726
  * @permissionId WIX_STORES.READ_PRODUCTS
2681
2727
  * @permissionScope Manage Stores - all permissions
2682
2728
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2729
+ * @permissionScope Manage Stores
2730
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2683
2731
  * @permissionScope Manage Products
2684
2732
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2685
2733
  * @permissionScope Read Stores - all read permissions
@@ -2709,6 +2757,8 @@ export interface GetProductOptions {
2709
2757
  * @permissionId WIX_STORES.READ_PRODUCTS
2710
2758
  * @permissionScope Manage Stores - all permissions
2711
2759
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2760
+ * @permissionScope Manage Stores
2761
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2712
2762
  * @permissionScope Manage Products
2713
2763
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2714
2764
  * @permissionScope Read Stores - all read permissions
@@ -2734,6 +2784,8 @@ export declare function getCollectionBySlug(slug: string): Promise<NonNullablePa
2734
2784
  * @permissionId WIX_STORES.READ_PRODUCTS
2735
2785
  * @permissionScope Manage Stores - all permissions
2736
2786
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2787
+ * @permissionScope Manage Stores
2788
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2737
2789
  * @permissionScope Manage Products
2738
2790
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2739
2791
  * @permissionScope Read Stores - all read permissions
@@ -2758,6 +2810,8 @@ export declare function getProductOptionsAvailability(_id: string, options: Reco
2758
2810
  * @permissionId WIX_STORES.READ_PRODUCTS
2759
2811
  * @permissionScope Manage Stores - all permissions
2760
2812
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2813
+ * @permissionScope Manage Stores
2814
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2761
2815
  * @permissionScope Manage Products
2762
2816
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2763
2817
  * @permissionScope Read Stores - all read permissions
@@ -2793,6 +2847,8 @@ export interface QueryProductVariantsOptions {
2793
2847
  * @permissionId WIX_STORES.READ_PRODUCTS
2794
2848
  * @permissionScope Manage Stores - all permissions
2795
2849
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2850
+ * @permissionScope Manage Stores
2851
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2796
2852
  * @permissionScope Manage Products
2797
2853
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2798
2854
  * @permissionScope Read Stores - all read permissions
@@ -2816,6 +2872,8 @@ export declare function queryStoreVariants(query: PlatformQuery): Promise<NonNul
2816
2872
  * @permissionId WIX_STORES.READ_PRODUCTS
2817
2873
  * @permissionScope Manage Stores - all permissions
2818
2874
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2875
+ * @permissionScope Manage Stores
2876
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2819
2877
  * @permissionScope Manage Products
2820
2878
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2821
2879
  * @permissionScope Read Stores - all read permissions
@@ -146,6 +146,8 @@ var WebhookIdentityType;
146
146
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
147
147
  * @permissionScope Manage Stores - all permissions
148
148
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
149
+ * @permissionScope Manage Stores
150
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
149
151
  * @permissionScope Manage Products
150
152
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
151
153
  * @applicableIdentity APP
@@ -185,6 +187,8 @@ exports.createProduct = createProduct;
185
187
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
186
188
  * @permissionScope Manage Stores - all permissions
187
189
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
190
+ * @permissionScope Manage Stores
191
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
188
192
  * @permissionScope Manage Products
189
193
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
190
194
  * @applicableIdentity APP
@@ -222,6 +226,8 @@ exports.updateProduct = updateProduct;
222
226
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
223
227
  * @permissionScope Manage Stores - all permissions
224
228
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
229
+ * @permissionScope Manage Stores
230
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
225
231
  * @permissionScope Manage Products
226
232
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
227
233
  * @applicableIdentity APP
@@ -258,6 +264,8 @@ exports.deleteProduct = deleteProduct;
258
264
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
259
265
  * @permissionScope Manage Stores - all permissions
260
266
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
267
+ * @permissionScope Manage Stores
268
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
261
269
  * @permissionScope Manage Products
262
270
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
263
271
  * @applicableIdentity APP
@@ -296,6 +304,8 @@ exports.updateProductVariants = updateProductVariants;
296
304
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
297
305
  * @permissionScope Manage Stores - all permissions
298
306
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
307
+ * @permissionScope Manage Stores
308
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
299
309
  * @permissionScope Manage Products
300
310
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
301
311
  * @applicableIdentity APP
@@ -332,6 +342,8 @@ exports.resetAllProductVariantData = resetAllProductVariantData;
332
342
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
333
343
  * @permissionScope Manage Stores - all permissions
334
344
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
345
+ * @permissionScope Manage Stores
346
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
335
347
  * @permissionScope Manage Products
336
348
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
337
349
  * @applicableIdentity APP
@@ -366,12 +378,13 @@ exports.addProductsToCollection = addProductsToCollection;
366
378
  * @param _id - ID of the collection from which to remove products.
367
379
  * @param productIds - IDs of the products to remove from the collection.
368
380
  * @public
369
- * @documentationMaturity preview
370
381
  * @requiredField _id
371
382
  * @requiredField productIds
372
383
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
373
384
  * @permissionScope Manage Stores - all permissions
374
385
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
386
+ * @permissionScope Manage Stores
387
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
375
388
  * @permissionScope Manage Products
376
389
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
377
390
  * @applicableIdentity APP
@@ -413,6 +426,8 @@ exports.removeProductsFromCollection = removeProductsFromCollection;
413
426
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
414
427
  * @permissionScope Manage Stores - all permissions
415
428
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
429
+ * @permissionScope Manage Stores
430
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
416
431
  * @permissionScope Manage Products
417
432
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
418
433
  * @applicableIdentity APP
@@ -453,6 +468,8 @@ exports.addProductMedia = addProductMedia;
453
468
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
454
469
  * @permissionScope Manage Stores - all permissions
455
470
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
471
+ * @permissionScope Manage Stores
472
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
456
473
  * @permissionScope Manage Products
457
474
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
458
475
  * @applicableIdentity APP
@@ -491,7 +508,6 @@ exports.removeProductMedia = removeProductMedia;
491
508
  * @param _id - Product ID.
492
509
  * @param media - Product media items and the choices to add the media to.
493
510
  * @public
494
- * @documentationMaturity preview
495
511
  * @requiredField _id
496
512
  * @requiredField media
497
513
  * @requiredField media.choice
@@ -499,6 +515,8 @@ exports.removeProductMedia = removeProductMedia;
499
515
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
500
516
  * @permissionScope Manage Stores - all permissions
501
517
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
518
+ * @permissionScope Manage Stores
519
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
502
520
  * @permissionScope Manage Products
503
521
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
504
522
  * @applicableIdentity APP
@@ -534,12 +552,13 @@ exports.addProductMediaToChoices = addProductMediaToChoices;
534
552
  * @param _id - Product ID from whose choices to remove media items.
535
553
  * @param media - Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.
536
554
  * @public
537
- * @documentationMaturity preview
538
555
  * @requiredField _id
539
556
  * @requiredField media
540
557
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
541
558
  * @permissionScope Manage Stores - all permissions
542
559
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
560
+ * @permissionScope Manage Stores
561
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
543
562
  * @permissionScope Manage Products
544
563
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
545
564
  * @applicableIdentity APP
@@ -573,11 +592,12 @@ exports.removeProductMediaFromChoices = removeProductMediaFromChoices;
573
592
  * Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.
574
593
  * @param _id - ID of the product with options to delete.
575
594
  * @public
576
- * @documentationMaturity preview
577
595
  * @requiredField _id
578
596
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
579
597
  * @permissionScope Manage Stores - all permissions
580
598
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
599
+ * @permissionScope Manage Stores
600
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
581
601
  * @permissionScope Manage Products
582
602
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
583
603
  * @applicableIdentity APP
@@ -612,6 +632,8 @@ exports.deleteProductOptions = deleteProductOptions;
612
632
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
613
633
  * @permissionScope Manage Stores - all permissions
614
634
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
635
+ * @permissionScope Manage Stores
636
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
615
637
  * @permissionScope Manage Products
616
638
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
617
639
  * @applicableIdentity APP
@@ -647,6 +669,8 @@ exports.removeBrand = removeBrand;
647
669
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
648
670
  * @permissionScope Manage Stores - all permissions
649
671
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
672
+ * @permissionScope Manage Stores
673
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
650
674
  * @permissionScope Manage Products
651
675
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
652
676
  * @applicableIdentity APP
@@ -680,13 +704,14 @@ exports.createCollection = createCollection;
680
704
  * Updates specified properties of a collection. To add products to a collection, call the [addProductsToCollection](#addproductstocollection) function.
681
705
  * @param _id - Collection ID (generated automatically by the catalog).
682
706
  * @public
683
- * @documentationMaturity preview
684
707
  * @requiredField _id
685
708
  * @requiredField collection
686
709
  * @param collection - Collection info to update.
687
710
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
688
711
  * @permissionScope Manage Stores - all permissions
689
712
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
713
+ * @permissionScope Manage Stores
714
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
690
715
  * @permissionScope Manage Products
691
716
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
692
717
  * @applicableIdentity APP
@@ -719,12 +744,13 @@ exports.updateCollection = updateCollection;
719
744
  /**
720
745
  * Deletes a collection.
721
746
  * @public
722
- * @documentationMaturity preview
723
747
  * @requiredField _id
724
748
  * @param _id - ID of the collection to delete.
725
749
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
726
750
  * @permissionScope Manage Stores - all permissions
727
751
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
752
+ * @permissionScope Manage Stores
753
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
728
754
  * @permissionScope Manage Products
729
755
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
730
756
  * @applicableIdentity APP
@@ -759,6 +785,8 @@ exports.deleteCollection = deleteCollection;
759
785
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
760
786
  * @permissionScope Manage Stores - all permissions
761
787
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
788
+ * @permissionScope Manage Stores
789
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
762
790
  * @permissionScope Manage Products
763
791
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
764
792
  * @applicableIdentity APP
@@ -790,12 +818,13 @@ exports.removeRibbon = removeRibbon;
790
818
  * @param ids - Product IDs.
791
819
  * @param set - Field to update.
792
820
  * @public
793
- * @documentationMaturity preview
794
821
  * @requiredField ids
795
822
  * @requiredField set
796
823
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
797
824
  * @permissionScope Manage Stores - all permissions
798
825
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
826
+ * @permissionScope Manage Stores
827
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
799
828
  * @permissionScope Manage Products
800
829
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
801
830
  * @applicableIdentity APP
@@ -829,12 +858,13 @@ exports.bulkUpdateProductsProperty = bulkUpdateProductsProperty;
829
858
  * @param adjust - Numerical property to adjust.
830
859
  * @param ids - Product IDs.
831
860
  * @public
832
- * @documentationMaturity preview
833
861
  * @requiredField adjust
834
862
  * @requiredField ids
835
863
  * @permissionId WIX_STORES.MODIFY_PRODUCTS
836
864
  * @permissionScope Manage Stores - all permissions
837
865
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
866
+ * @permissionScope Manage Stores
867
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
838
868
  * @permissionScope Manage Products
839
869
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
840
870
  * @applicableIdentity APP
@@ -870,6 +900,8 @@ exports.bulkAdjustProductProperty = bulkAdjustProductProperty;
870
900
  * @public
871
901
  * @permissionScope Manage Stores - all permissions
872
902
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
903
+ * @permissionScope Manage Stores
904
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
873
905
  * @permissionScope Manage Products
874
906
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
875
907
  * @permissionScope Read Stores - all read permissions
@@ -937,6 +969,8 @@ exports.queryProducts = queryProducts;
937
969
  * @permissionId WIX_STORES.READ_PRODUCTS
938
970
  * @permissionScope Manage Stores - all permissions
939
971
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
972
+ * @permissionScope Manage Stores
973
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
940
974
  * @permissionScope Manage Products
941
975
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
942
976
  * @permissionScope Read Stores - all read permissions
@@ -987,6 +1021,8 @@ exports.getProduct = getProduct;
987
1021
  * @permissionId WIX_STORES.READ_PRODUCTS
988
1022
  * @permissionScope Manage Stores - all permissions
989
1023
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1024
+ * @permissionScope Manage Stores
1025
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
990
1026
  * @permissionScope Manage Products
991
1027
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
992
1028
  * @permissionScope Read Stores - all read permissions
@@ -1033,6 +1069,8 @@ exports.getCollectionBySlug = getCollectionBySlug;
1033
1069
  * @permissionId WIX_STORES.READ_PRODUCTS
1034
1070
  * @permissionScope Manage Stores - all permissions
1035
1071
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1072
+ * @permissionScope Manage Stores
1073
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1036
1074
  * @permissionScope Manage Products
1037
1075
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1038
1076
  * @permissionScope Read Stores - all read permissions
@@ -1081,6 +1119,8 @@ exports.getProductOptionsAvailability = getProductOptionsAvailability;
1081
1119
  * @permissionId WIX_STORES.READ_PRODUCTS
1082
1120
  * @permissionScope Manage Stores - all permissions
1083
1121
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1122
+ * @permissionScope Manage Stores
1123
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1084
1124
  * @permissionScope Manage Products
1085
1125
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1086
1126
  * @permissionScope Read Stores - all read permissions
@@ -1137,6 +1177,8 @@ exports.queryProductVariants = queryProductVariants;
1137
1177
  * @permissionId WIX_STORES.READ_PRODUCTS
1138
1178
  * @permissionScope Manage Stores - all permissions
1139
1179
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1180
+ * @permissionScope Manage Stores
1181
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1140
1182
  * @permissionScope Manage Products
1141
1183
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1142
1184
  * @permissionScope Read Stores - all read permissions
@@ -1190,6 +1232,8 @@ exports.queryStoreVariants = queryStoreVariants;
1190
1232
  * @permissionId WIX_STORES.READ_PRODUCTS
1191
1233
  * @permissionScope Manage Stores - all permissions
1192
1234
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1235
+ * @permissionScope Manage Stores
1236
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1193
1237
  * @permissionScope Manage Products
1194
1238
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1195
1239
  * @permissionScope Read Stores - all read permissions