@wix/stores 1.0.99 → 1.0.101

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 (51) hide show
  1. package/build/cjs/index.d.ts +1 -1
  2. package/build/cjs/index.js +2 -2
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +1 -1
  5. package/build/cjs/index.typings.js +2 -2
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +1 -1
  8. package/build/cjs/meta.js +2 -2
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/src/stores-catalog-v1-product.http.d.ts +6 -6
  11. package/build/cjs/src/stores-catalog-v1-product.http.js +113 -113
  12. package/build/cjs/src/stores-catalog-v1-product.http.js.map +1 -1
  13. package/build/cjs/src/stores-catalog-v1-product.meta.d.ts +7 -7
  14. package/build/cjs/src/stores-catalog-v1-product.meta.js +58 -58
  15. package/build/cjs/src/stores-catalog-v1-product.meta.js.map +1 -1
  16. package/build/cjs/src/stores-catalog-v1-product.public.d.ts +475 -5
  17. package/build/cjs/src/stores-catalog-v1-product.public.js +19 -19
  18. package/build/cjs/src/stores-catalog-v1-product.public.js.map +1 -1
  19. package/build/cjs/src/stores-catalog-v1-product.types.d.ts +231 -231
  20. package/build/cjs/src/stores-catalog-v1-product.universal.d.ts +381 -381
  21. package/build/cjs/src/stores-catalog-v1-product.universal.js +163 -163
  22. package/build/cjs/src/stores-catalog-v1-product.universal.js.map +1 -1
  23. package/build/cjs/src/stores-v1-subscription-option.universal.d.ts +16 -0
  24. package/build/cjs/src/stores-v1-subscription-option.universal.js +16 -0
  25. package/build/cjs/src/stores-v1-subscription-option.universal.js.map +1 -1
  26. package/build/es/index.d.ts +1 -1
  27. package/build/es/index.js +1 -1
  28. package/build/es/index.js.map +1 -1
  29. package/build/es/index.typings.d.ts +1 -1
  30. package/build/es/index.typings.js +1 -1
  31. package/build/es/index.typings.js.map +1 -1
  32. package/build/es/meta.d.ts +1 -1
  33. package/build/es/meta.js +1 -1
  34. package/build/es/meta.js.map +1 -1
  35. package/build/es/src/stores-catalog-v1-product.http.d.ts +6 -6
  36. package/build/es/src/stores-catalog-v1-product.http.js +109 -109
  37. package/build/es/src/stores-catalog-v1-product.http.js.map +1 -1
  38. package/build/es/src/stores-catalog-v1-product.meta.d.ts +7 -7
  39. package/build/es/src/stores-catalog-v1-product.meta.js +54 -54
  40. package/build/es/src/stores-catalog-v1-product.meta.js.map +1 -1
  41. package/build/es/src/stores-catalog-v1-product.public.d.ts +475 -5
  42. package/build/es/src/stores-catalog-v1-product.public.js +16 -16
  43. package/build/es/src/stores-catalog-v1-product.public.js.map +1 -1
  44. package/build/es/src/stores-catalog-v1-product.types.d.ts +231 -231
  45. package/build/es/src/stores-catalog-v1-product.universal.d.ts +381 -381
  46. package/build/es/src/stores-catalog-v1-product.universal.js +159 -159
  47. package/build/es/src/stores-catalog-v1-product.universal.js.map +1 -1
  48. package/build/es/src/stores-v1-subscription-option.universal.d.ts +16 -0
  49. package/build/es/src/stores-v1-subscription-option.universal.js +16 -0
  50. package/build/es/src/stores-v1-subscription-option.universal.js.map +1 -1
  51. package/package.json +2 -2
@@ -477,25 +477,6 @@ export interface Settings {
477
477
  /** User-selected keyword terms for a specific page. */
478
478
  keywords?: Keyword[];
479
479
  }
480
- export interface V1CreateProductPlatformizedRequest {
481
- /** Product information. */
482
- product?: Product;
483
- }
484
- export interface V1CreateProductPlatformizedResponse {
485
- product?: Product;
486
- }
487
- export interface V1UpdateProductPlatformizedRequest {
488
- product: Product;
489
- }
490
- export interface V1UpdateProductPlatformizedResponse {
491
- product?: Product;
492
- }
493
- export interface V1DeleteProductPlatformizedRequest {
494
- /** ID of the product to delete. */
495
- _id: string;
496
- }
497
- export interface V1DeleteProductPlatformizedResponse {
498
- }
499
480
  export interface CreateProductRequest {
500
481
  /** Product information. */
501
482
  product?: Product;
@@ -954,6 +935,25 @@ export interface BulkAdjustProductPropertiesByFilterSyncResponse {
954
935
  /** Bulk action metadata. */
955
936
  bulkActionMetadata?: BulkActionMetadata;
956
937
  }
938
+ export interface V1CreateProductPlatformizedRequest {
939
+ /** Product information. */
940
+ product?: Product;
941
+ }
942
+ export interface V1CreateProductPlatformizedResponse {
943
+ product?: Product;
944
+ }
945
+ export interface V1UpdateProductPlatformizedRequest {
946
+ product: Product;
947
+ }
948
+ export interface V1UpdateProductPlatformizedResponse {
949
+ product?: Product;
950
+ }
951
+ export interface V1DeleteProductPlatformizedRequest {
952
+ /** ID of the product to delete. */
953
+ _id: string;
954
+ }
955
+ export interface V1DeleteProductPlatformizedResponse {
956
+ }
957
957
  export interface ProductCreated {
958
958
  /** Product ID (generated automatically by the catalog). */
959
959
  productId?: string;
@@ -1427,7 +1427,7 @@ export interface AggregateProductsRequest {
1427
1427
  export interface AggregateProductsResponse {
1428
1428
  aggregates?: Record<string, any> | null;
1429
1429
  }
1430
- export interface V1CreateProductPlatformizedResponseNonNullableFields {
1430
+ export interface CreateProductResponseNonNullableFields {
1431
1431
  product?: {
1432
1432
  _id: string;
1433
1433
  slug: string;
@@ -1665,7 +1665,7 @@ export interface V1CreateProductPlatformizedResponseNonNullableFields {
1665
1665
  };
1666
1666
  };
1667
1667
  }
1668
- export interface V1UpdateProductPlatformizedResponseNonNullableFields {
1668
+ export interface CreateProductPlatformizedResponseNonNullableFields {
1669
1669
  product?: {
1670
1670
  _id: string;
1671
1671
  slug: string;
@@ -1903,7 +1903,7 @@ export interface V1UpdateProductPlatformizedResponseNonNullableFields {
1903
1903
  };
1904
1904
  };
1905
1905
  }
1906
- export interface CreateProductResponseNonNullableFields {
1906
+ export interface UpdateProductResponseNonNullableFields {
1907
1907
  product?: {
1908
1908
  _id: string;
1909
1909
  slug: string;
@@ -2141,7 +2141,7 @@ export interface CreateProductResponseNonNullableFields {
2141
2141
  };
2142
2142
  };
2143
2143
  }
2144
- export interface CreateProductPlatformizedResponseNonNullableFields {
2144
+ export interface UpdateProductPlatformizedResponseNonNullableFields {
2145
2145
  product?: {
2146
2146
  _id: string;
2147
2147
  slug: string;
@@ -2379,7 +2379,183 @@ export interface CreateProductPlatformizedResponseNonNullableFields {
2379
2379
  };
2380
2380
  };
2381
2381
  }
2382
- export interface UpdateProductResponseNonNullableFields {
2382
+ export interface UpdateVariantsResponseNonNullableFields {
2383
+ variants: {
2384
+ _id: string;
2385
+ variant?: {
2386
+ priceData?: {
2387
+ currency: string;
2388
+ discountedPrice: number;
2389
+ formatted?: {
2390
+ price: string;
2391
+ discountedPrice: string;
2392
+ };
2393
+ };
2394
+ convertedPriceData?: {
2395
+ currency: string;
2396
+ discountedPrice: number;
2397
+ formatted?: {
2398
+ price: string;
2399
+ discountedPrice: string;
2400
+ };
2401
+ };
2402
+ costAndProfitData?: {
2403
+ formattedItemCost: string;
2404
+ profit: number;
2405
+ formattedProfit: string;
2406
+ profitMargin: number;
2407
+ };
2408
+ weight: number;
2409
+ sku: string;
2410
+ visible: boolean;
2411
+ };
2412
+ stock?: {
2413
+ trackQuantity: boolean;
2414
+ inStock: boolean;
2415
+ };
2416
+ }[];
2417
+ }
2418
+ export interface CreateCollectionResponseNonNullableFields {
2419
+ collection?: {
2420
+ media?: {
2421
+ mainMedia?: {
2422
+ image?: {
2423
+ url: string;
2424
+ width: number;
2425
+ height: number;
2426
+ };
2427
+ video?: {
2428
+ files: {
2429
+ url: string;
2430
+ width: number;
2431
+ height: number;
2432
+ }[];
2433
+ stillFrameMediaId: string;
2434
+ };
2435
+ thumbnail?: {
2436
+ url: string;
2437
+ width: number;
2438
+ height: number;
2439
+ };
2440
+ mediaType: MediaItemType;
2441
+ title: string;
2442
+ _id: string;
2443
+ };
2444
+ items: {
2445
+ image?: {
2446
+ url: string;
2447
+ width: number;
2448
+ height: number;
2449
+ };
2450
+ video?: {
2451
+ files: {
2452
+ url: string;
2453
+ width: number;
2454
+ height: number;
2455
+ }[];
2456
+ stillFrameMediaId: string;
2457
+ };
2458
+ thumbnail?: {
2459
+ url: string;
2460
+ width: number;
2461
+ height: number;
2462
+ };
2463
+ mediaType: MediaItemType;
2464
+ title: string;
2465
+ _id: string;
2466
+ }[];
2467
+ };
2468
+ numberOfProducts: number;
2469
+ };
2470
+ }
2471
+ export interface UpdateCollectionResponseNonNullableFields {
2472
+ collection?: {
2473
+ media?: {
2474
+ mainMedia?: {
2475
+ image?: {
2476
+ url: string;
2477
+ width: number;
2478
+ height: number;
2479
+ };
2480
+ video?: {
2481
+ files: {
2482
+ url: string;
2483
+ width: number;
2484
+ height: number;
2485
+ }[];
2486
+ stillFrameMediaId: string;
2487
+ };
2488
+ thumbnail?: {
2489
+ url: string;
2490
+ width: number;
2491
+ height: number;
2492
+ };
2493
+ mediaType: MediaItemType;
2494
+ title: string;
2495
+ _id: string;
2496
+ };
2497
+ items: {
2498
+ image?: {
2499
+ url: string;
2500
+ width: number;
2501
+ height: number;
2502
+ };
2503
+ video?: {
2504
+ files: {
2505
+ url: string;
2506
+ width: number;
2507
+ height: number;
2508
+ }[];
2509
+ stillFrameMediaId: string;
2510
+ };
2511
+ thumbnail?: {
2512
+ url: string;
2513
+ width: number;
2514
+ height: number;
2515
+ };
2516
+ mediaType: MediaItemType;
2517
+ title: string;
2518
+ _id: string;
2519
+ }[];
2520
+ };
2521
+ numberOfProducts: number;
2522
+ };
2523
+ }
2524
+ export interface BulkUpdateProductsResponseNonNullableFields {
2525
+ results: {
2526
+ itemMetadata?: {
2527
+ originalIndex: number;
2528
+ success: boolean;
2529
+ error?: {
2530
+ code: string;
2531
+ description: string;
2532
+ };
2533
+ };
2534
+ }[];
2535
+ bulkActionMetadata?: {
2536
+ totalSuccesses: number;
2537
+ totalFailures: number;
2538
+ undetailedFailures: number;
2539
+ };
2540
+ }
2541
+ export interface BulkAdjustProductPropertiesResponseNonNullableFields {
2542
+ results: {
2543
+ itemMetadata?: {
2544
+ originalIndex: number;
2545
+ success: boolean;
2546
+ error?: {
2547
+ code: string;
2548
+ description: string;
2549
+ };
2550
+ };
2551
+ }[];
2552
+ bulkActionMetadata?: {
2553
+ totalSuccesses: number;
2554
+ totalFailures: number;
2555
+ undetailedFailures: number;
2556
+ };
2557
+ }
2558
+ export interface V1CreateProductPlatformizedResponseNonNullableFields {
2383
2559
  product?: {
2384
2560
  _id: string;
2385
2561
  slug: string;
@@ -2617,7 +2793,7 @@ export interface UpdateProductResponseNonNullableFields {
2617
2793
  };
2618
2794
  };
2619
2795
  }
2620
- export interface UpdateProductPlatformizedResponseNonNullableFields {
2796
+ export interface V1UpdateProductPlatformizedResponseNonNullableFields {
2621
2797
  product?: {
2622
2798
  _id: string;
2623
2799
  slug: string;
@@ -2855,202 +3031,26 @@ export interface UpdateProductPlatformizedResponseNonNullableFields {
2855
3031
  };
2856
3032
  };
2857
3033
  }
2858
- export interface UpdateVariantsResponseNonNullableFields {
2859
- variants: {
3034
+ export interface QueryProductsPlatformizedResponseNonNullableFields {
3035
+ products: {
2860
3036
  _id: string;
2861
- variant?: {
2862
- priceData?: {
2863
- currency: string;
2864
- discountedPrice: number;
2865
- formatted?: {
2866
- price: string;
2867
- discountedPrice: string;
2868
- };
2869
- };
2870
- convertedPriceData?: {
2871
- currency: string;
2872
- discountedPrice: number;
2873
- formatted?: {
2874
- price: string;
2875
- discountedPrice: string;
2876
- };
2877
- };
2878
- costAndProfitData?: {
2879
- formattedItemCost: string;
2880
- profit: number;
2881
- formattedProfit: string;
2882
- profitMargin: number;
2883
- };
2884
- weight: number;
2885
- sku: string;
2886
- visible: boolean;
2887
- };
2888
- stock?: {
2889
- trackQuantity: boolean;
2890
- inStock: boolean;
2891
- };
2892
- }[];
2893
- }
2894
- export interface CreateCollectionResponseNonNullableFields {
2895
- collection?: {
2896
- media?: {
2897
- mainMedia?: {
2898
- image?: {
2899
- url: string;
2900
- width: number;
2901
- height: number;
2902
- };
2903
- video?: {
2904
- files: {
2905
- url: string;
2906
- width: number;
2907
- height: number;
2908
- }[];
2909
- stillFrameMediaId: string;
2910
- };
2911
- thumbnail?: {
2912
- url: string;
2913
- width: number;
2914
- height: number;
2915
- };
2916
- mediaType: MediaItemType;
2917
- title: string;
2918
- _id: string;
2919
- };
2920
- items: {
2921
- image?: {
2922
- url: string;
2923
- width: number;
2924
- height: number;
2925
- };
2926
- video?: {
2927
- files: {
2928
- url: string;
2929
- width: number;
2930
- height: number;
2931
- }[];
2932
- stillFrameMediaId: string;
2933
- };
2934
- thumbnail?: {
2935
- url: string;
2936
- width: number;
2937
- height: number;
2938
- };
2939
- mediaType: MediaItemType;
2940
- title: string;
2941
- _id: string;
2942
- }[];
2943
- };
2944
- numberOfProducts: number;
2945
- };
2946
- }
2947
- export interface UpdateCollectionResponseNonNullableFields {
2948
- collection?: {
2949
- media?: {
2950
- mainMedia?: {
2951
- image?: {
2952
- url: string;
2953
- width: number;
2954
- height: number;
2955
- };
2956
- video?: {
2957
- files: {
2958
- url: string;
2959
- width: number;
2960
- height: number;
2961
- }[];
2962
- stillFrameMediaId: string;
2963
- };
2964
- thumbnail?: {
2965
- url: string;
2966
- width: number;
2967
- height: number;
2968
- };
2969
- mediaType: MediaItemType;
2970
- title: string;
2971
- _id: string;
2972
- };
2973
- items: {
2974
- image?: {
2975
- url: string;
2976
- width: number;
2977
- height: number;
2978
- };
2979
- video?: {
2980
- files: {
2981
- url: string;
2982
- width: number;
2983
- height: number;
2984
- }[];
2985
- stillFrameMediaId: string;
2986
- };
2987
- thumbnail?: {
2988
- url: string;
2989
- width: number;
2990
- height: number;
2991
- };
2992
- mediaType: MediaItemType;
2993
- title: string;
2994
- _id: string;
2995
- }[];
2996
- };
2997
- numberOfProducts: number;
2998
- };
2999
- }
3000
- export interface BulkUpdateProductsResponseNonNullableFields {
3001
- results: {
3002
- itemMetadata?: {
3003
- originalIndex: number;
3004
- success: boolean;
3005
- error?: {
3006
- code: string;
3007
- description: string;
3008
- };
3009
- };
3010
- }[];
3011
- bulkActionMetadata?: {
3012
- totalSuccesses: number;
3013
- totalFailures: number;
3014
- undetailedFailures: number;
3015
- };
3016
- }
3017
- export interface BulkAdjustProductPropertiesResponseNonNullableFields {
3018
- results: {
3019
- itemMetadata?: {
3020
- originalIndex: number;
3021
- success: boolean;
3022
- error?: {
3023
- code: string;
3024
- description: string;
3025
- };
3026
- };
3027
- }[];
3028
- bulkActionMetadata?: {
3029
- totalSuccesses: number;
3030
- totalFailures: number;
3031
- undetailedFailures: number;
3032
- };
3033
- }
3034
- export interface QueryProductsPlatformizedResponseNonNullableFields {
3035
- products: {
3036
- _id: string;
3037
- slug: string;
3038
- productType: ProductType;
3039
- weightRange?: {
3040
- minValue: number;
3041
- maxValue: number;
3042
- };
3043
- stock?: {
3044
- trackInventory: boolean;
3045
- inStock: boolean;
3046
- inventoryStatus: InventoryStatus;
3047
- };
3048
- price?: {
3049
- currency: string;
3050
- discountedPrice: number;
3051
- formatted?: {
3052
- price: string;
3053
- discountedPrice: string;
3037
+ slug: string;
3038
+ productType: ProductType;
3039
+ weightRange?: {
3040
+ minValue: number;
3041
+ maxValue: number;
3042
+ };
3043
+ stock?: {
3044
+ trackInventory: boolean;
3045
+ inStock: boolean;
3046
+ inventoryStatus: InventoryStatus;
3047
+ };
3048
+ price?: {
3049
+ currency: string;
3050
+ discountedPrice: number;
3051
+ formatted?: {
3052
+ price: string;
3053
+ discountedPrice: string;
3054
3054
  };
3055
3055
  };
3056
3056
  priceData?: {
@@ -4015,165 +4015,6 @@ export interface GetStoreVariantResponseNonNullableFields {
4015
4015
  };
4016
4016
  };
4017
4017
  }
4018
- /**
4019
- * Creates a new product.
4020
- * @param product - Product information.
4021
- * @public
4022
- * @documentationMaturity preview
4023
- * @requiredField product
4024
- * @requiredField product.costAndProfitData.itemCost
4025
- * @requiredField product.name
4026
- * @requiredField product.priceData
4027
- * @requiredField product.priceData.price
4028
- * @permissionScope Manage Products
4029
- */
4030
- export declare function writeProxyCreateProductPlatformized(product: Product): Promise<V1CreateProductPlatformizedResponse & V1CreateProductPlatformizedResponseNonNullableFields>;
4031
- /**
4032
- * Updates specified fields in a product.
4033
- * @param _id - Product ID (generated automatically by the catalog).
4034
- * @public
4035
- * @documentationMaturity preview
4036
- * @requiredField _id
4037
- * @requiredField product
4038
- * @permissionScope Manage Products
4039
- */
4040
- export declare function writeProxyUpdateProductPlatformized(_id: string, product: WriteProxyUpdateProductPlatformizedProduct): Promise<V1UpdateProductPlatformizedResponse & V1UpdateProductPlatformizedResponseNonNullableFields>;
4041
- export interface WriteProxyUpdateProductPlatformizedProduct {
4042
- /**
4043
- * Product ID (generated automatically by the catalog).
4044
- * @readonly
4045
- */
4046
- _id?: string;
4047
- /**
4048
- * Product name.
4049
- *
4050
- * Min: 1 character
4051
- * Max: 80 characters
4052
- */
4053
- name?: string | null;
4054
- /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
4055
- slug?: string;
4056
- /** Whether the product is visible to site visitors. */
4057
- visible?: boolean | null;
4058
- /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
4059
- productType?: ProductType;
4060
- /** Product description. */
4061
- description?: string | null;
4062
- /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */
4063
- sku?: string | null;
4064
- /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */
4065
- weight?: number | null;
4066
- /**
4067
- * Product weight range. The minimum and maximum weights of all the variants.
4068
- * @readonly
4069
- */
4070
- weightRange?: NumericPropertyRange;
4071
- /**
4072
- * Product inventory status (in future this will be writable via Inventory API).
4073
- * @readonly
4074
- */
4075
- stock?: Stock;
4076
- /**
4077
- * Deprecated (use `priceData` instead).
4078
- * @readonly
4079
- */
4080
- price?: PriceData;
4081
- /** Price data. */
4082
- priceData?: PriceData;
4083
- /**
4084
- * Price data, converted to the currency specified in request header.
4085
- * @readonly
4086
- */
4087
- convertedPriceData?: PriceData;
4088
- /**
4089
- * Product price range. The minimum and maximum prices of all the variants.
4090
- * @readonly
4091
- */
4092
- priceRange?: NumericPropertyRange;
4093
- /** Cost and profit data. */
4094
- costAndProfitData?: CostAndProfitData;
4095
- /**
4096
- * Product cost range. The minimum and maximum costs of all the variants.
4097
- * @readonly
4098
- */
4099
- costRange?: NumericPropertyRange;
4100
- /** Price per unit data. */
4101
- pricePerUnitData?: PricePerUnitData;
4102
- /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */
4103
- additionalInfoSections?: AdditionalInfoSection[];
4104
- /**
4105
- * Deprecated (use `ribbon` instead).
4106
- * @readonly
4107
- */
4108
- ribbons?: Ribbon[];
4109
- /**
4110
- * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).
4111
- * @readonly
4112
- */
4113
- media?: Media;
4114
- /**
4115
- * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
4116
- * @readonly
4117
- */
4118
- customTextFields?: CustomTextField[];
4119
- /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to `true`, can be reset to `false` only if no variants exist. You cannot set `manageVariants` to `true` if more than 300 variants are defined. */
4120
- manageVariants?: boolean | null;
4121
- /** Options for this product. */
4122
- productOptions?: ProductOption[];
4123
- /**
4124
- * Product page URL for this product (generated automatically by the server).
4125
- * @readonly
4126
- */
4127
- productPageUrl?: PageUrl;
4128
- /**
4129
- * Product’s unique numeric ID (assigned in ascending order).
4130
- * Primarily used for sorting and filtering when crawling all products.
4131
- * @readonly
4132
- */
4133
- numericId?: string;
4134
- /**
4135
- * Inventory item ID - ID referencing the inventory system.
4136
- * @readonly
4137
- */
4138
- inventoryItemId?: string;
4139
- /** Discount deducted from the product's original price. */
4140
- discount?: Discount;
4141
- /**
4142
- * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
4143
- * @readonly
4144
- */
4145
- collectionIds?: string[];
4146
- /**
4147
- * Product variants, will be provided if the the request was sent with the includeVariants flag.
4148
- * @readonly
4149
- */
4150
- variants?: Variant[];
4151
- /**
4152
- * Date and time the product was last updated.
4153
- * @readonly
4154
- */
4155
- lastUpdated?: Date;
4156
- /**
4157
- * Date and time the product was created.
4158
- * @readonly
4159
- */
4160
- _createdDate?: Date;
4161
- /** Custom SEO data for the product. */
4162
- seoData?: SeoSchema;
4163
- /** Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out". */
4164
- ribbon?: string | null;
4165
- /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */
4166
- brand?: string | null;
4167
- }
4168
- /**
4169
- * Deletes a product.
4170
- * @param _id - ID of the product to delete.
4171
- * @public
4172
- * @documentationMaturity preview
4173
- * @requiredField _id
4174
- * @permissionScope Manage Products
4175
- */
4176
- export declare function writeProxyDeleteProductPlatformized(_id: string): Promise<void>;
4177
4018
  /**
4178
4019
  * Creates a new product.
4179
4020
  * @param product - Product information.
@@ -4708,6 +4549,165 @@ export declare function bulkUpdateProductsProperty(ids: string[], set: SetValue)
4708
4549
  * @applicableIdentity APP
4709
4550
  */
4710
4551
  export declare function bulkAdjustProductProperty(adjust: AdjustValue, ids: string[]): Promise<BulkAdjustProductPropertiesResponse & BulkAdjustProductPropertiesResponseNonNullableFields>;
4552
+ /**
4553
+ * Creates a new product.
4554
+ * @param product - Product information.
4555
+ * @public
4556
+ * @documentationMaturity preview
4557
+ * @requiredField product
4558
+ * @requiredField product.costAndProfitData.itemCost
4559
+ * @requiredField product.name
4560
+ * @requiredField product.priceData
4561
+ * @requiredField product.priceData.price
4562
+ * @permissionScope Manage Products
4563
+ */
4564
+ export declare function writeProxyCreateProductPlatformized(product: Product): Promise<Product & NonNullable<V1CreateProductPlatformizedResponseNonNullableFields>['product']>;
4565
+ /**
4566
+ * Updates specified fields in a product.
4567
+ * @param _id - Product ID (generated automatically by the catalog).
4568
+ * @public
4569
+ * @documentationMaturity preview
4570
+ * @requiredField _id
4571
+ * @requiredField product
4572
+ * @permissionScope Manage Products
4573
+ */
4574
+ export declare function writeProxyUpdateProductPlatformized(_id: string, product: WriteProxyUpdateProductPlatformizedProduct): Promise<Product & NonNullable<V1UpdateProductPlatformizedResponseNonNullableFields>['product']>;
4575
+ export interface WriteProxyUpdateProductPlatformizedProduct {
4576
+ /**
4577
+ * Product ID (generated automatically by the catalog).
4578
+ * @readonly
4579
+ */
4580
+ _id?: string;
4581
+ /**
4582
+ * Product name.
4583
+ *
4584
+ * Min: 1 character
4585
+ * Max: 80 characters
4586
+ */
4587
+ name?: string | null;
4588
+ /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
4589
+ slug?: string;
4590
+ /** Whether the product is visible to site visitors. */
4591
+ visible?: boolean | null;
4592
+ /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
4593
+ productType?: ProductType;
4594
+ /** Product description. */
4595
+ description?: string | null;
4596
+ /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */
4597
+ sku?: string | null;
4598
+ /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */
4599
+ weight?: number | null;
4600
+ /**
4601
+ * Product weight range. The minimum and maximum weights of all the variants.
4602
+ * @readonly
4603
+ */
4604
+ weightRange?: NumericPropertyRange;
4605
+ /**
4606
+ * Product inventory status (in future this will be writable via Inventory API).
4607
+ * @readonly
4608
+ */
4609
+ stock?: Stock;
4610
+ /**
4611
+ * Deprecated (use `priceData` instead).
4612
+ * @readonly
4613
+ */
4614
+ price?: PriceData;
4615
+ /** Price data. */
4616
+ priceData?: PriceData;
4617
+ /**
4618
+ * Price data, converted to the currency specified in request header.
4619
+ * @readonly
4620
+ */
4621
+ convertedPriceData?: PriceData;
4622
+ /**
4623
+ * Product price range. The minimum and maximum prices of all the variants.
4624
+ * @readonly
4625
+ */
4626
+ priceRange?: NumericPropertyRange;
4627
+ /** Cost and profit data. */
4628
+ costAndProfitData?: CostAndProfitData;
4629
+ /**
4630
+ * Product cost range. The minimum and maximum costs of all the variants.
4631
+ * @readonly
4632
+ */
4633
+ costRange?: NumericPropertyRange;
4634
+ /** Price per unit data. */
4635
+ pricePerUnitData?: PricePerUnitData;
4636
+ /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */
4637
+ additionalInfoSections?: AdditionalInfoSection[];
4638
+ /**
4639
+ * Deprecated (use `ribbon` instead).
4640
+ * @readonly
4641
+ */
4642
+ ribbons?: Ribbon[];
4643
+ /**
4644
+ * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).
4645
+ * @readonly
4646
+ */
4647
+ media?: Media;
4648
+ /**
4649
+ * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
4650
+ * @readonly
4651
+ */
4652
+ customTextFields?: CustomTextField[];
4653
+ /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to `true`, can be reset to `false` only if no variants exist. You cannot set `manageVariants` to `true` if more than 300 variants are defined. */
4654
+ manageVariants?: boolean | null;
4655
+ /** Options for this product. */
4656
+ productOptions?: ProductOption[];
4657
+ /**
4658
+ * Product page URL for this product (generated automatically by the server).
4659
+ * @readonly
4660
+ */
4661
+ productPageUrl?: PageUrl;
4662
+ /**
4663
+ * Product’s unique numeric ID (assigned in ascending order).
4664
+ * Primarily used for sorting and filtering when crawling all products.
4665
+ * @readonly
4666
+ */
4667
+ numericId?: string;
4668
+ /**
4669
+ * Inventory item ID - ID referencing the inventory system.
4670
+ * @readonly
4671
+ */
4672
+ inventoryItemId?: string;
4673
+ /** Discount deducted from the product's original price. */
4674
+ discount?: Discount;
4675
+ /**
4676
+ * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
4677
+ * @readonly
4678
+ */
4679
+ collectionIds?: string[];
4680
+ /**
4681
+ * Product variants, will be provided if the the request was sent with the includeVariants flag.
4682
+ * @readonly
4683
+ */
4684
+ variants?: Variant[];
4685
+ /**
4686
+ * Date and time the product was last updated.
4687
+ * @readonly
4688
+ */
4689
+ lastUpdated?: Date;
4690
+ /**
4691
+ * Date and time the product was created.
4692
+ * @readonly
4693
+ */
4694
+ _createdDate?: Date;
4695
+ /** Custom SEO data for the product. */
4696
+ seoData?: SeoSchema;
4697
+ /** Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out". */
4698
+ ribbon?: string | null;
4699
+ /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */
4700
+ brand?: string | null;
4701
+ }
4702
+ /**
4703
+ * Deletes a product.
4704
+ * @param _id - ID of the product to delete.
4705
+ * @public
4706
+ * @documentationMaturity preview
4707
+ * @requiredField _id
4708
+ * @permissionScope Manage Products
4709
+ */
4710
+ export declare function writeProxyDeleteProductPlatformized(_id: string): Promise<void>;
4711
4711
  /**
4712
4712
  * Returns a list of up to 100 products, given the provided paging, sorting and filtering.
4713
4713
  * @public
@@ -4750,7 +4750,7 @@ export interface ProductsQueryBuilder {
4750
4750
  * @param value - Value to compare against.
4751
4751
  * @documentationMaturity preview
4752
4752
  */
4753
- ge: (propertyName: 'priceData.price' | 'numericId', value: any) => ProductsQueryBuilder;
4753
+ ge: (propertyName: 'priceData.price' | 'numericId' | 'lastUpdated' | '_createdDate', value: any) => ProductsQueryBuilder;
4754
4754
  /** @param propertyName - Property whose value is compared with `value`.
4755
4755
  * @param value - Value to compare against.
4756
4756
  * @documentationMaturity preview
@@ -4760,7 +4760,7 @@ export interface ProductsQueryBuilder {
4760
4760
  * @param value - Value to compare against.
4761
4761
  * @documentationMaturity preview
4762
4762
  */
4763
- le: (propertyName: 'priceData.price' | 'numericId', value: any) => ProductsQueryBuilder;
4763
+ le: (propertyName: 'priceData.price' | 'numericId' | 'lastUpdated' | '_createdDate', value: any) => ProductsQueryBuilder;
4764
4764
  /** @param propertyName - Property whose value is compared with `value`.
4765
4765
  * @param value - Value to compare against.
4766
4766
  * @documentationMaturity preview