@wix/stores 1.0.97 → 1.0.99

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/build/cjs/src/stores-catalog-v1-collection.http.js +2 -2
  2. package/build/cjs/src/stores-catalog-v1-collection.http.js.map +1 -1
  3. package/build/cjs/src/stores-catalog-v1-product.http.d.ts +7 -1
  4. package/build/cjs/src/stores-catalog-v1-product.http.js +121 -3
  5. package/build/cjs/src/stores-catalog-v1-product.http.js.map +1 -1
  6. package/build/cjs/src/stores-catalog-v1-product.meta.d.ts +7 -0
  7. package/build/cjs/src/stores-catalog-v1-product.meta.js +58 -1
  8. package/build/cjs/src/stores-catalog-v1-product.meta.js.map +1 -1
  9. package/build/cjs/src/stores-catalog-v1-product.public.d.ts +5 -2
  10. package/build/cjs/src/stores-catalog-v1-product.public.js +19 -1
  11. package/build/cjs/src/stores-catalog-v1-product.public.js.map +1 -1
  12. package/build/cjs/src/stores-catalog-v1-product.types.d.ts +497 -0
  13. package/build/cjs/src/stores-catalog-v1-product.types.js.map +1 -1
  14. package/build/cjs/src/stores-catalog-v1-product.universal.d.ts +862 -208
  15. package/build/cjs/src/stores-catalog-v1-product.universal.js +169 -1
  16. package/build/cjs/src/stores-catalog-v1-product.universal.js.map +1 -1
  17. package/build/es/src/stores-catalog-v1-collection.http.js +2 -2
  18. package/build/es/src/stores-catalog-v1-collection.http.js.map +1 -1
  19. package/build/es/src/stores-catalog-v1-product.http.d.ts +7 -1
  20. package/build/es/src/stores-catalog-v1-product.http.js +117 -2
  21. package/build/es/src/stores-catalog-v1-product.http.js.map +1 -1
  22. package/build/es/src/stores-catalog-v1-product.meta.d.ts +7 -0
  23. package/build/es/src/stores-catalog-v1-product.meta.js +54 -0
  24. package/build/es/src/stores-catalog-v1-product.meta.js.map +1 -1
  25. package/build/es/src/stores-catalog-v1-product.public.d.ts +5 -2
  26. package/build/es/src/stores-catalog-v1-product.public.js +16 -1
  27. package/build/es/src/stores-catalog-v1-product.public.js.map +1 -1
  28. package/build/es/src/stores-catalog-v1-product.types.d.ts +497 -0
  29. package/build/es/src/stores-catalog-v1-product.types.js.map +1 -1
  30. package/build/es/src/stores-catalog-v1-product.universal.d.ts +862 -208
  31. package/build/es/src/stores-catalog-v1-product.universal.js +165 -0
  32. package/build/es/src/stores-catalog-v1-product.universal.js.map +1 -1
  33. package/package.json +2 -2
@@ -477,6 +477,25 @@ 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
+ }
480
499
  export interface CreateProductRequest {
481
500
  /** Product information. */
482
501
  product?: Product;
@@ -1408,7 +1427,7 @@ export interface AggregateProductsRequest {
1408
1427
  export interface AggregateProductsResponse {
1409
1428
  aggregates?: Record<string, any> | null;
1410
1429
  }
1411
- export interface CreateProductResponseNonNullableFields {
1430
+ export interface V1CreateProductPlatformizedResponseNonNullableFields {
1412
1431
  product?: {
1413
1432
  _id: string;
1414
1433
  slug: string;
@@ -1646,7 +1665,7 @@ export interface CreateProductResponseNonNullableFields {
1646
1665
  };
1647
1666
  };
1648
1667
  }
1649
- export interface CreateProductPlatformizedResponseNonNullableFields {
1668
+ export interface V1UpdateProductPlatformizedResponseNonNullableFields {
1650
1669
  product?: {
1651
1670
  _id: string;
1652
1671
  slug: string;
@@ -1884,7 +1903,7 @@ export interface CreateProductPlatformizedResponseNonNullableFields {
1884
1903
  };
1885
1904
  };
1886
1905
  }
1887
- export interface UpdateProductResponseNonNullableFields {
1906
+ export interface CreateProductResponseNonNullableFields {
1888
1907
  product?: {
1889
1908
  _id: string;
1890
1909
  slug: string;
@@ -2122,7 +2141,7 @@ export interface UpdateProductResponseNonNullableFields {
2122
2141
  };
2123
2142
  };
2124
2143
  }
2125
- export interface UpdateProductPlatformizedResponseNonNullableFields {
2144
+ export interface CreateProductPlatformizedResponseNonNullableFields {
2126
2145
  product?: {
2127
2146
  _id: string;
2128
2147
  slug: string;
@@ -2360,184 +2379,8 @@ export interface UpdateProductPlatformizedResponseNonNullableFields {
2360
2379
  };
2361
2380
  };
2362
2381
  }
2363
- export interface UpdateVariantsResponseNonNullableFields {
2364
- variants: {
2365
- _id: string;
2366
- variant?: {
2367
- priceData?: {
2368
- currency: string;
2369
- discountedPrice: number;
2370
- formatted?: {
2371
- price: string;
2372
- discountedPrice: string;
2373
- };
2374
- };
2375
- convertedPriceData?: {
2376
- currency: string;
2377
- discountedPrice: number;
2378
- formatted?: {
2379
- price: string;
2380
- discountedPrice: string;
2381
- };
2382
- };
2383
- costAndProfitData?: {
2384
- formattedItemCost: string;
2385
- profit: number;
2386
- formattedProfit: string;
2387
- profitMargin: number;
2388
- };
2389
- weight: number;
2390
- sku: string;
2391
- visible: boolean;
2392
- };
2393
- stock?: {
2394
- trackQuantity: boolean;
2395
- inStock: boolean;
2396
- };
2397
- }[];
2398
- }
2399
- export interface CreateCollectionResponseNonNullableFields {
2400
- collection?: {
2401
- media?: {
2402
- mainMedia?: {
2403
- image?: {
2404
- url: string;
2405
- width: number;
2406
- height: number;
2407
- };
2408
- video?: {
2409
- files: {
2410
- url: string;
2411
- width: number;
2412
- height: number;
2413
- }[];
2414
- stillFrameMediaId: string;
2415
- };
2416
- thumbnail?: {
2417
- url: string;
2418
- width: number;
2419
- height: number;
2420
- };
2421
- mediaType: MediaItemType;
2422
- title: string;
2423
- _id: string;
2424
- };
2425
- items: {
2426
- image?: {
2427
- url: string;
2428
- width: number;
2429
- height: number;
2430
- };
2431
- video?: {
2432
- files: {
2433
- url: string;
2434
- width: number;
2435
- height: number;
2436
- }[];
2437
- stillFrameMediaId: string;
2438
- };
2439
- thumbnail?: {
2440
- url: string;
2441
- width: number;
2442
- height: number;
2443
- };
2444
- mediaType: MediaItemType;
2445
- title: string;
2446
- _id: string;
2447
- }[];
2448
- };
2449
- numberOfProducts: number;
2450
- };
2451
- }
2452
- export interface UpdateCollectionResponseNonNullableFields {
2453
- collection?: {
2454
- media?: {
2455
- mainMedia?: {
2456
- image?: {
2457
- url: string;
2458
- width: number;
2459
- height: number;
2460
- };
2461
- video?: {
2462
- files: {
2463
- url: string;
2464
- width: number;
2465
- height: number;
2466
- }[];
2467
- stillFrameMediaId: string;
2468
- };
2469
- thumbnail?: {
2470
- url: string;
2471
- width: number;
2472
- height: number;
2473
- };
2474
- mediaType: MediaItemType;
2475
- title: string;
2476
- _id: string;
2477
- };
2478
- items: {
2479
- image?: {
2480
- url: string;
2481
- width: number;
2482
- height: number;
2483
- };
2484
- video?: {
2485
- files: {
2486
- url: string;
2487
- width: number;
2488
- height: number;
2489
- }[];
2490
- stillFrameMediaId: string;
2491
- };
2492
- thumbnail?: {
2493
- url: string;
2494
- width: number;
2495
- height: number;
2496
- };
2497
- mediaType: MediaItemType;
2498
- title: string;
2499
- _id: string;
2500
- }[];
2501
- };
2502
- numberOfProducts: number;
2503
- };
2504
- }
2505
- export interface BulkUpdateProductsResponseNonNullableFields {
2506
- results: {
2507
- itemMetadata?: {
2508
- originalIndex: number;
2509
- success: boolean;
2510
- error?: {
2511
- code: string;
2512
- description: string;
2513
- };
2514
- };
2515
- }[];
2516
- bulkActionMetadata?: {
2517
- totalSuccesses: number;
2518
- totalFailures: number;
2519
- undetailedFailures: number;
2520
- };
2521
- }
2522
- export interface BulkAdjustProductPropertiesResponseNonNullableFields {
2523
- results: {
2524
- itemMetadata?: {
2525
- originalIndex: number;
2526
- success: boolean;
2527
- error?: {
2528
- code: string;
2529
- description: string;
2530
- };
2531
- };
2532
- }[];
2533
- bulkActionMetadata?: {
2534
- totalSuccesses: number;
2535
- totalFailures: number;
2536
- undetailedFailures: number;
2537
- };
2538
- }
2539
- export interface QueryProductsPlatformizedResponseNonNullableFields {
2540
- products: {
2382
+ export interface UpdateProductResponseNonNullableFields {
2383
+ product?: {
2541
2384
  _id: string;
2542
2385
  slug: string;
2543
2386
  productType: ProductType;
@@ -2772,9 +2615,9 @@ export interface QueryProductsPlatformizedResponseNonNullableFields {
2772
2615
  }[];
2773
2616
  };
2774
2617
  };
2775
- }[];
2618
+ };
2776
2619
  }
2777
- export interface GetProductResponseNonNullableFields {
2620
+ export interface UpdateProductPlatformizedResponseNonNullableFields {
2778
2621
  product?: {
2779
2622
  _id: string;
2780
2623
  slug: string;
@@ -3012,35 +2855,687 @@ export interface GetProductResponseNonNullableFields {
3012
2855
  };
3013
2856
  };
3014
2857
  }
3015
- export interface GetProductPlatformizedResponseNonNullableFields {
3016
- product?: {
2858
+ export interface UpdateVariantsResponseNonNullableFields {
2859
+ variants: {
3017
2860
  _id: string;
3018
- slug: string;
3019
- productType: ProductType;
3020
- weightRange?: {
3021
- minValue: number;
3022
- maxValue: number;
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;
3023
2887
  };
3024
2888
  stock?: {
3025
- trackInventory: boolean;
2889
+ trackQuantity: boolean;
3026
2890
  inStock: boolean;
3027
- inventoryStatus: InventoryStatus;
3028
- };
3029
- price?: {
3030
- currency: string;
3031
- discountedPrice: number;
3032
- formatted?: {
3033
- price: string;
3034
- discountedPrice: string;
3035
- };
3036
2891
  };
3037
- priceData?: {
3038
- currency: string;
3039
- discountedPrice: number;
3040
- formatted?: {
3041
- price: string;
3042
- discountedPrice: string;
3043
- };
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;
3054
+ };
3055
+ };
3056
+ priceData?: {
3057
+ currency: string;
3058
+ discountedPrice: number;
3059
+ formatted?: {
3060
+ price: string;
3061
+ discountedPrice: string;
3062
+ };
3063
+ };
3064
+ convertedPriceData?: {
3065
+ currency: string;
3066
+ discountedPrice: number;
3067
+ formatted?: {
3068
+ price: string;
3069
+ discountedPrice: string;
3070
+ };
3071
+ };
3072
+ priceRange?: {
3073
+ minValue: number;
3074
+ maxValue: number;
3075
+ };
3076
+ costAndProfitData?: {
3077
+ formattedItemCost: string;
3078
+ profit: number;
3079
+ formattedProfit: string;
3080
+ profitMargin: number;
3081
+ };
3082
+ costRange?: {
3083
+ minValue: number;
3084
+ maxValue: number;
3085
+ };
3086
+ pricePerUnitData?: {
3087
+ totalQuantity: number;
3088
+ totalMeasurementUnit: MeasurementUnit;
3089
+ baseQuantity: number;
3090
+ baseMeasurementUnit: MeasurementUnit;
3091
+ };
3092
+ additionalInfoSections: {
3093
+ title: string;
3094
+ description: string;
3095
+ }[];
3096
+ ribbons: {
3097
+ text: string;
3098
+ }[];
3099
+ media?: {
3100
+ mainMedia?: {
3101
+ image?: {
3102
+ url: string;
3103
+ width: number;
3104
+ height: number;
3105
+ };
3106
+ video?: {
3107
+ files: {
3108
+ url: string;
3109
+ width: number;
3110
+ height: number;
3111
+ }[];
3112
+ stillFrameMediaId: string;
3113
+ };
3114
+ thumbnail?: {
3115
+ url: string;
3116
+ width: number;
3117
+ height: number;
3118
+ };
3119
+ mediaType: MediaItemType;
3120
+ title: string;
3121
+ _id: string;
3122
+ };
3123
+ items: {
3124
+ image?: {
3125
+ url: string;
3126
+ width: number;
3127
+ height: number;
3128
+ };
3129
+ video?: {
3130
+ files: {
3131
+ url: string;
3132
+ width: number;
3133
+ height: number;
3134
+ }[];
3135
+ stillFrameMediaId: string;
3136
+ };
3137
+ thumbnail?: {
3138
+ url: string;
3139
+ width: number;
3140
+ height: number;
3141
+ };
3142
+ mediaType: MediaItemType;
3143
+ title: string;
3144
+ _id: string;
3145
+ }[];
3146
+ };
3147
+ customTextFields: {
3148
+ title: string;
3149
+ maxLength: number;
3150
+ mandatory: boolean;
3151
+ }[];
3152
+ productOptions: {
3153
+ optionType: OptionType;
3154
+ name: string;
3155
+ choices: {
3156
+ value: string;
3157
+ description: string;
3158
+ media?: {
3159
+ mainMedia?: {
3160
+ image?: {
3161
+ url: string;
3162
+ width: number;
3163
+ height: number;
3164
+ };
3165
+ video?: {
3166
+ files: {
3167
+ url: string;
3168
+ width: number;
3169
+ height: number;
3170
+ }[];
3171
+ stillFrameMediaId: string;
3172
+ };
3173
+ thumbnail?: {
3174
+ url: string;
3175
+ width: number;
3176
+ height: number;
3177
+ };
3178
+ mediaType: MediaItemType;
3179
+ title: string;
3180
+ _id: string;
3181
+ };
3182
+ items: {
3183
+ image?: {
3184
+ url: string;
3185
+ width: number;
3186
+ height: number;
3187
+ };
3188
+ video?: {
3189
+ files: {
3190
+ url: string;
3191
+ width: number;
3192
+ height: number;
3193
+ }[];
3194
+ stillFrameMediaId: string;
3195
+ };
3196
+ thumbnail?: {
3197
+ url: string;
3198
+ width: number;
3199
+ height: number;
3200
+ };
3201
+ mediaType: MediaItemType;
3202
+ title: string;
3203
+ _id: string;
3204
+ }[];
3205
+ };
3206
+ inStock: boolean;
3207
+ visible: boolean;
3208
+ }[];
3209
+ }[];
3210
+ productPageUrl?: {
3211
+ base: string;
3212
+ path: string;
3213
+ };
3214
+ numericId: string;
3215
+ inventoryItemId: string;
3216
+ discount?: {
3217
+ type: DiscountType;
3218
+ value: number;
3219
+ };
3220
+ collectionIds: string[];
3221
+ variants: {
3222
+ _id: string;
3223
+ variant?: {
3224
+ priceData?: {
3225
+ currency: string;
3226
+ discountedPrice: number;
3227
+ formatted?: {
3228
+ price: string;
3229
+ discountedPrice: string;
3230
+ };
3231
+ };
3232
+ convertedPriceData?: {
3233
+ currency: string;
3234
+ discountedPrice: number;
3235
+ formatted?: {
3236
+ price: string;
3237
+ discountedPrice: string;
3238
+ };
3239
+ };
3240
+ costAndProfitData?: {
3241
+ formattedItemCost: string;
3242
+ profit: number;
3243
+ formattedProfit: string;
3244
+ profitMargin: number;
3245
+ };
3246
+ weight: number;
3247
+ sku: string;
3248
+ visible: boolean;
3249
+ };
3250
+ stock?: {
3251
+ trackQuantity: boolean;
3252
+ inStock: boolean;
3253
+ };
3254
+ }[];
3255
+ seoData?: {
3256
+ tags: {
3257
+ type: string;
3258
+ children: string;
3259
+ custom: boolean;
3260
+ disabled: boolean;
3261
+ }[];
3262
+ settings?: {
3263
+ preventAutoRedirect: boolean;
3264
+ keywords: {
3265
+ term: string;
3266
+ isMain: boolean;
3267
+ }[];
3268
+ };
3269
+ };
3270
+ }[];
3271
+ }
3272
+ export interface GetProductResponseNonNullableFields {
3273
+ product?: {
3274
+ _id: string;
3275
+ slug: string;
3276
+ productType: ProductType;
3277
+ weightRange?: {
3278
+ minValue: number;
3279
+ maxValue: number;
3280
+ };
3281
+ stock?: {
3282
+ trackInventory: boolean;
3283
+ inStock: boolean;
3284
+ inventoryStatus: InventoryStatus;
3285
+ };
3286
+ price?: {
3287
+ currency: string;
3288
+ discountedPrice: number;
3289
+ formatted?: {
3290
+ price: string;
3291
+ discountedPrice: string;
3292
+ };
3293
+ };
3294
+ priceData?: {
3295
+ currency: string;
3296
+ discountedPrice: number;
3297
+ formatted?: {
3298
+ price: string;
3299
+ discountedPrice: string;
3300
+ };
3301
+ };
3302
+ convertedPriceData?: {
3303
+ currency: string;
3304
+ discountedPrice: number;
3305
+ formatted?: {
3306
+ price: string;
3307
+ discountedPrice: string;
3308
+ };
3309
+ };
3310
+ priceRange?: {
3311
+ minValue: number;
3312
+ maxValue: number;
3313
+ };
3314
+ costAndProfitData?: {
3315
+ formattedItemCost: string;
3316
+ profit: number;
3317
+ formattedProfit: string;
3318
+ profitMargin: number;
3319
+ };
3320
+ costRange?: {
3321
+ minValue: number;
3322
+ maxValue: number;
3323
+ };
3324
+ pricePerUnitData?: {
3325
+ totalQuantity: number;
3326
+ totalMeasurementUnit: MeasurementUnit;
3327
+ baseQuantity: number;
3328
+ baseMeasurementUnit: MeasurementUnit;
3329
+ };
3330
+ additionalInfoSections: {
3331
+ title: string;
3332
+ description: string;
3333
+ }[];
3334
+ ribbons: {
3335
+ text: string;
3336
+ }[];
3337
+ media?: {
3338
+ mainMedia?: {
3339
+ image?: {
3340
+ url: string;
3341
+ width: number;
3342
+ height: number;
3343
+ };
3344
+ video?: {
3345
+ files: {
3346
+ url: string;
3347
+ width: number;
3348
+ height: number;
3349
+ }[];
3350
+ stillFrameMediaId: string;
3351
+ };
3352
+ thumbnail?: {
3353
+ url: string;
3354
+ width: number;
3355
+ height: number;
3356
+ };
3357
+ mediaType: MediaItemType;
3358
+ title: string;
3359
+ _id: string;
3360
+ };
3361
+ items: {
3362
+ image?: {
3363
+ url: string;
3364
+ width: number;
3365
+ height: number;
3366
+ };
3367
+ video?: {
3368
+ files: {
3369
+ url: string;
3370
+ width: number;
3371
+ height: number;
3372
+ }[];
3373
+ stillFrameMediaId: string;
3374
+ };
3375
+ thumbnail?: {
3376
+ url: string;
3377
+ width: number;
3378
+ height: number;
3379
+ };
3380
+ mediaType: MediaItemType;
3381
+ title: string;
3382
+ _id: string;
3383
+ }[];
3384
+ };
3385
+ customTextFields: {
3386
+ title: string;
3387
+ maxLength: number;
3388
+ mandatory: boolean;
3389
+ }[];
3390
+ productOptions: {
3391
+ optionType: OptionType;
3392
+ name: string;
3393
+ choices: {
3394
+ value: string;
3395
+ description: string;
3396
+ media?: {
3397
+ mainMedia?: {
3398
+ image?: {
3399
+ url: string;
3400
+ width: number;
3401
+ height: number;
3402
+ };
3403
+ video?: {
3404
+ files: {
3405
+ url: string;
3406
+ width: number;
3407
+ height: number;
3408
+ }[];
3409
+ stillFrameMediaId: string;
3410
+ };
3411
+ thumbnail?: {
3412
+ url: string;
3413
+ width: number;
3414
+ height: number;
3415
+ };
3416
+ mediaType: MediaItemType;
3417
+ title: string;
3418
+ _id: string;
3419
+ };
3420
+ items: {
3421
+ image?: {
3422
+ url: string;
3423
+ width: number;
3424
+ height: number;
3425
+ };
3426
+ video?: {
3427
+ files: {
3428
+ url: string;
3429
+ width: number;
3430
+ height: number;
3431
+ }[];
3432
+ stillFrameMediaId: string;
3433
+ };
3434
+ thumbnail?: {
3435
+ url: string;
3436
+ width: number;
3437
+ height: number;
3438
+ };
3439
+ mediaType: MediaItemType;
3440
+ title: string;
3441
+ _id: string;
3442
+ }[];
3443
+ };
3444
+ inStock: boolean;
3445
+ visible: boolean;
3446
+ }[];
3447
+ }[];
3448
+ productPageUrl?: {
3449
+ base: string;
3450
+ path: string;
3451
+ };
3452
+ numericId: string;
3453
+ inventoryItemId: string;
3454
+ discount?: {
3455
+ type: DiscountType;
3456
+ value: number;
3457
+ };
3458
+ collectionIds: string[];
3459
+ variants: {
3460
+ _id: string;
3461
+ variant?: {
3462
+ priceData?: {
3463
+ currency: string;
3464
+ discountedPrice: number;
3465
+ formatted?: {
3466
+ price: string;
3467
+ discountedPrice: string;
3468
+ };
3469
+ };
3470
+ convertedPriceData?: {
3471
+ currency: string;
3472
+ discountedPrice: number;
3473
+ formatted?: {
3474
+ price: string;
3475
+ discountedPrice: string;
3476
+ };
3477
+ };
3478
+ costAndProfitData?: {
3479
+ formattedItemCost: string;
3480
+ profit: number;
3481
+ formattedProfit: string;
3482
+ profitMargin: number;
3483
+ };
3484
+ weight: number;
3485
+ sku: string;
3486
+ visible: boolean;
3487
+ };
3488
+ stock?: {
3489
+ trackQuantity: boolean;
3490
+ inStock: boolean;
3491
+ };
3492
+ }[];
3493
+ seoData?: {
3494
+ tags: {
3495
+ type: string;
3496
+ children: string;
3497
+ custom: boolean;
3498
+ disabled: boolean;
3499
+ }[];
3500
+ settings?: {
3501
+ preventAutoRedirect: boolean;
3502
+ keywords: {
3503
+ term: string;
3504
+ isMain: boolean;
3505
+ }[];
3506
+ };
3507
+ };
3508
+ };
3509
+ }
3510
+ export interface GetProductPlatformizedResponseNonNullableFields {
3511
+ product?: {
3512
+ _id: string;
3513
+ slug: string;
3514
+ productType: ProductType;
3515
+ weightRange?: {
3516
+ minValue: number;
3517
+ maxValue: number;
3518
+ };
3519
+ stock?: {
3520
+ trackInventory: boolean;
3521
+ inStock: boolean;
3522
+ inventoryStatus: InventoryStatus;
3523
+ };
3524
+ price?: {
3525
+ currency: string;
3526
+ discountedPrice: number;
3527
+ formatted?: {
3528
+ price: string;
3529
+ discountedPrice: string;
3530
+ };
3531
+ };
3532
+ priceData?: {
3533
+ currency: string;
3534
+ discountedPrice: number;
3535
+ formatted?: {
3536
+ price: string;
3537
+ discountedPrice: string;
3538
+ };
3044
3539
  };
3045
3540
  convertedPriceData?: {
3046
3541
  currency: string;
@@ -3520,6 +4015,165 @@ export interface GetStoreVariantResponseNonNullableFields {
3520
4015
  };
3521
4016
  };
3522
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>;
3523
4177
  /**
3524
4178
  * Creates a new product.
3525
4179
  * @param product - Product information.