@wix/stores 1.0.95 → 1.0.97
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.
- package/build/cjs/src/stores-catalog-v1-collection.http.js +13 -2
- package/build/cjs/src/stores-catalog-v1-collection.http.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-collection.meta.d.ts +1 -1
- package/build/cjs/src/stores-catalog-v1-collection.meta.js +1 -1
- package/build/cjs/src/stores-catalog-v1-collection.meta.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-product.http.d.ts +9 -1
- package/build/cjs/src/stores-catalog-v1-product.http.js +163 -3
- package/build/cjs/src/stores-catalog-v1-product.http.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-product.meta.d.ts +11 -1
- package/build/cjs/src/stores-catalog-v1-product.meta.js +78 -2
- package/build/cjs/src/stores-catalog-v1-product.meta.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-product.public.d.ts +711 -2
- package/build/cjs/src/stores-catalog-v1-product.public.js +25 -1
- package/build/cjs/src/stores-catalog-v1-product.public.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-product.types.d.ts +931 -214
- package/build/cjs/src/stores-catalog-v1-product.universal.d.ts +1108 -213
- package/build/cjs/src/stores-catalog-v1-product.universal.js +236 -1
- package/build/cjs/src/stores-catalog-v1-product.universal.js.map +1 -1
- package/build/es/src/stores-catalog-v1-collection.http.js +13 -2
- package/build/es/src/stores-catalog-v1-collection.http.js.map +1 -1
- package/build/es/src/stores-catalog-v1-collection.meta.d.ts +1 -1
- package/build/es/src/stores-catalog-v1-collection.meta.js +1 -1
- package/build/es/src/stores-catalog-v1-collection.meta.js.map +1 -1
- package/build/es/src/stores-catalog-v1-product.http.d.ts +9 -1
- package/build/es/src/stores-catalog-v1-product.http.js +158 -2
- package/build/es/src/stores-catalog-v1-product.http.js.map +1 -1
- package/build/es/src/stores-catalog-v1-product.meta.d.ts +11 -1
- package/build/es/src/stores-catalog-v1-product.meta.js +73 -1
- package/build/es/src/stores-catalog-v1-product.meta.js.map +1 -1
- package/build/es/src/stores-catalog-v1-product.public.d.ts +711 -2
- package/build/es/src/stores-catalog-v1-product.public.js +21 -1
- package/build/es/src/stores-catalog-v1-product.public.js.map +1 -1
- package/build/es/src/stores-catalog-v1-product.types.d.ts +931 -214
- package/build/es/src/stores-catalog-v1-product.universal.d.ts +1108 -213
- package/build/es/src/stores-catalog-v1-product.universal.js +231 -0
- package/build/es/src/stores-catalog-v1-product.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -498,7 +498,7 @@ export interface UpdateProductResponse {
|
|
|
498
498
|
product?: Product;
|
|
499
499
|
}
|
|
500
500
|
export interface UpdateProductPlatformizedRequest {
|
|
501
|
-
product
|
|
501
|
+
product: Product;
|
|
502
502
|
}
|
|
503
503
|
export interface UpdateProductPlatformizedResponse {
|
|
504
504
|
product?: Product;
|
|
@@ -511,7 +511,7 @@ export interface DeleteProductResponse {
|
|
|
511
511
|
}
|
|
512
512
|
export interface DeleteProductPlatformizedRequest {
|
|
513
513
|
/** ID of the product to delete. */
|
|
514
|
-
_id
|
|
514
|
+
_id: string;
|
|
515
515
|
}
|
|
516
516
|
export interface DeleteProductPlatformizedResponse {
|
|
517
517
|
}
|
|
@@ -1142,7 +1142,7 @@ export interface GetProductResponse {
|
|
|
1142
1142
|
}
|
|
1143
1143
|
export interface GetProductPlatformizedRequest {
|
|
1144
1144
|
/** Requested product ID. */
|
|
1145
|
-
_id
|
|
1145
|
+
_id: string;
|
|
1146
1146
|
/** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
|
|
1147
1147
|
includeMerchantSpecificData?: boolean;
|
|
1148
1148
|
}
|
|
@@ -1646,7 +1646,7 @@ export interface CreateProductResponseNonNullableFields {
|
|
|
1646
1646
|
};
|
|
1647
1647
|
};
|
|
1648
1648
|
}
|
|
1649
|
-
export interface
|
|
1649
|
+
export interface CreateProductPlatformizedResponseNonNullableFields {
|
|
1650
1650
|
product?: {
|
|
1651
1651
|
_id: string;
|
|
1652
1652
|
slug: string;
|
|
@@ -1884,184 +1884,8 @@ export interface UpdateProductResponseNonNullableFields {
|
|
|
1884
1884
|
};
|
|
1885
1885
|
};
|
|
1886
1886
|
}
|
|
1887
|
-
export interface
|
|
1888
|
-
|
|
1889
|
-
_id: string;
|
|
1890
|
-
variant?: {
|
|
1891
|
-
priceData?: {
|
|
1892
|
-
currency: string;
|
|
1893
|
-
discountedPrice: number;
|
|
1894
|
-
formatted?: {
|
|
1895
|
-
price: string;
|
|
1896
|
-
discountedPrice: string;
|
|
1897
|
-
};
|
|
1898
|
-
};
|
|
1899
|
-
convertedPriceData?: {
|
|
1900
|
-
currency: string;
|
|
1901
|
-
discountedPrice: number;
|
|
1902
|
-
formatted?: {
|
|
1903
|
-
price: string;
|
|
1904
|
-
discountedPrice: string;
|
|
1905
|
-
};
|
|
1906
|
-
};
|
|
1907
|
-
costAndProfitData?: {
|
|
1908
|
-
formattedItemCost: string;
|
|
1909
|
-
profit: number;
|
|
1910
|
-
formattedProfit: string;
|
|
1911
|
-
profitMargin: number;
|
|
1912
|
-
};
|
|
1913
|
-
weight: number;
|
|
1914
|
-
sku: string;
|
|
1915
|
-
visible: boolean;
|
|
1916
|
-
};
|
|
1917
|
-
stock?: {
|
|
1918
|
-
trackQuantity: boolean;
|
|
1919
|
-
inStock: boolean;
|
|
1920
|
-
};
|
|
1921
|
-
}[];
|
|
1922
|
-
}
|
|
1923
|
-
export interface CreateCollectionResponseNonNullableFields {
|
|
1924
|
-
collection?: {
|
|
1925
|
-
media?: {
|
|
1926
|
-
mainMedia?: {
|
|
1927
|
-
image?: {
|
|
1928
|
-
url: string;
|
|
1929
|
-
width: number;
|
|
1930
|
-
height: number;
|
|
1931
|
-
};
|
|
1932
|
-
video?: {
|
|
1933
|
-
files: {
|
|
1934
|
-
url: string;
|
|
1935
|
-
width: number;
|
|
1936
|
-
height: number;
|
|
1937
|
-
}[];
|
|
1938
|
-
stillFrameMediaId: string;
|
|
1939
|
-
};
|
|
1940
|
-
thumbnail?: {
|
|
1941
|
-
url: string;
|
|
1942
|
-
width: number;
|
|
1943
|
-
height: number;
|
|
1944
|
-
};
|
|
1945
|
-
mediaType: MediaItemType;
|
|
1946
|
-
title: string;
|
|
1947
|
-
_id: string;
|
|
1948
|
-
};
|
|
1949
|
-
items: {
|
|
1950
|
-
image?: {
|
|
1951
|
-
url: string;
|
|
1952
|
-
width: number;
|
|
1953
|
-
height: number;
|
|
1954
|
-
};
|
|
1955
|
-
video?: {
|
|
1956
|
-
files: {
|
|
1957
|
-
url: string;
|
|
1958
|
-
width: number;
|
|
1959
|
-
height: number;
|
|
1960
|
-
}[];
|
|
1961
|
-
stillFrameMediaId: string;
|
|
1962
|
-
};
|
|
1963
|
-
thumbnail?: {
|
|
1964
|
-
url: string;
|
|
1965
|
-
width: number;
|
|
1966
|
-
height: number;
|
|
1967
|
-
};
|
|
1968
|
-
mediaType: MediaItemType;
|
|
1969
|
-
title: string;
|
|
1970
|
-
_id: string;
|
|
1971
|
-
}[];
|
|
1972
|
-
};
|
|
1973
|
-
numberOfProducts: number;
|
|
1974
|
-
};
|
|
1975
|
-
}
|
|
1976
|
-
export interface UpdateCollectionResponseNonNullableFields {
|
|
1977
|
-
collection?: {
|
|
1978
|
-
media?: {
|
|
1979
|
-
mainMedia?: {
|
|
1980
|
-
image?: {
|
|
1981
|
-
url: string;
|
|
1982
|
-
width: number;
|
|
1983
|
-
height: number;
|
|
1984
|
-
};
|
|
1985
|
-
video?: {
|
|
1986
|
-
files: {
|
|
1987
|
-
url: string;
|
|
1988
|
-
width: number;
|
|
1989
|
-
height: number;
|
|
1990
|
-
}[];
|
|
1991
|
-
stillFrameMediaId: string;
|
|
1992
|
-
};
|
|
1993
|
-
thumbnail?: {
|
|
1994
|
-
url: string;
|
|
1995
|
-
width: number;
|
|
1996
|
-
height: number;
|
|
1997
|
-
};
|
|
1998
|
-
mediaType: MediaItemType;
|
|
1999
|
-
title: string;
|
|
2000
|
-
_id: string;
|
|
2001
|
-
};
|
|
2002
|
-
items: {
|
|
2003
|
-
image?: {
|
|
2004
|
-
url: string;
|
|
2005
|
-
width: number;
|
|
2006
|
-
height: number;
|
|
2007
|
-
};
|
|
2008
|
-
video?: {
|
|
2009
|
-
files: {
|
|
2010
|
-
url: string;
|
|
2011
|
-
width: number;
|
|
2012
|
-
height: number;
|
|
2013
|
-
}[];
|
|
2014
|
-
stillFrameMediaId: string;
|
|
2015
|
-
};
|
|
2016
|
-
thumbnail?: {
|
|
2017
|
-
url: string;
|
|
2018
|
-
width: number;
|
|
2019
|
-
height: number;
|
|
2020
|
-
};
|
|
2021
|
-
mediaType: MediaItemType;
|
|
2022
|
-
title: string;
|
|
2023
|
-
_id: string;
|
|
2024
|
-
}[];
|
|
2025
|
-
};
|
|
2026
|
-
numberOfProducts: number;
|
|
2027
|
-
};
|
|
2028
|
-
}
|
|
2029
|
-
export interface BulkUpdateProductsResponseNonNullableFields {
|
|
2030
|
-
results: {
|
|
2031
|
-
itemMetadata?: {
|
|
2032
|
-
originalIndex: number;
|
|
2033
|
-
success: boolean;
|
|
2034
|
-
error?: {
|
|
2035
|
-
code: string;
|
|
2036
|
-
description: string;
|
|
2037
|
-
};
|
|
2038
|
-
};
|
|
2039
|
-
}[];
|
|
2040
|
-
bulkActionMetadata?: {
|
|
2041
|
-
totalSuccesses: number;
|
|
2042
|
-
totalFailures: number;
|
|
2043
|
-
undetailedFailures: number;
|
|
2044
|
-
};
|
|
2045
|
-
}
|
|
2046
|
-
export interface BulkAdjustProductPropertiesResponseNonNullableFields {
|
|
2047
|
-
results: {
|
|
2048
|
-
itemMetadata?: {
|
|
2049
|
-
originalIndex: number;
|
|
2050
|
-
success: boolean;
|
|
2051
|
-
error?: {
|
|
2052
|
-
code: string;
|
|
2053
|
-
description: string;
|
|
2054
|
-
};
|
|
2055
|
-
};
|
|
2056
|
-
}[];
|
|
2057
|
-
bulkActionMetadata?: {
|
|
2058
|
-
totalSuccesses: number;
|
|
2059
|
-
totalFailures: number;
|
|
2060
|
-
undetailedFailures: number;
|
|
2061
|
-
};
|
|
2062
|
-
}
|
|
2063
|
-
export interface QueryProductsPlatformizedResponseNonNullableFields {
|
|
2064
|
-
products: {
|
|
1887
|
+
export interface UpdateProductResponseNonNullableFields {
|
|
1888
|
+
product?: {
|
|
2065
1889
|
_id: string;
|
|
2066
1890
|
slug: string;
|
|
2067
1891
|
productType: ProductType;
|
|
@@ -2296,9 +2120,9 @@ export interface QueryProductsPlatformizedResponseNonNullableFields {
|
|
|
2296
2120
|
}[];
|
|
2297
2121
|
};
|
|
2298
2122
|
};
|
|
2299
|
-
}
|
|
2123
|
+
};
|
|
2300
2124
|
}
|
|
2301
|
-
export interface
|
|
2125
|
+
export interface UpdateProductPlatformizedResponseNonNullableFields {
|
|
2302
2126
|
product?: {
|
|
2303
2127
|
_id: string;
|
|
2304
2128
|
slug: string;
|
|
@@ -2536,7 +2360,43 @@ export interface GetProductResponseNonNullableFields {
|
|
|
2536
2360
|
};
|
|
2537
2361
|
};
|
|
2538
2362
|
}
|
|
2539
|
-
export interface
|
|
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 {
|
|
2540
2400
|
collection?: {
|
|
2541
2401
|
media?: {
|
|
2542
2402
|
mainMedia?: {
|
|
@@ -2589,34 +2449,888 @@ export interface GetCollectionBySlugResponseNonNullableFields {
|
|
|
2589
2449
|
numberOfProducts: number;
|
|
2590
2450
|
};
|
|
2591
2451
|
}
|
|
2592
|
-
export interface
|
|
2593
|
-
|
|
2594
|
-
|
|
2595
|
-
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
|
|
2603
|
-
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
|
|
2610
|
-
|
|
2611
|
-
|
|
2612
|
-
|
|
2613
|
-
|
|
2614
|
-
|
|
2615
|
-
|
|
2616
|
-
|
|
2617
|
-
|
|
2618
|
-
|
|
2619
|
-
|
|
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: {
|
|
2541
|
+
_id: string;
|
|
2542
|
+
slug: string;
|
|
2543
|
+
productType: ProductType;
|
|
2544
|
+
weightRange?: {
|
|
2545
|
+
minValue: number;
|
|
2546
|
+
maxValue: number;
|
|
2547
|
+
};
|
|
2548
|
+
stock?: {
|
|
2549
|
+
trackInventory: boolean;
|
|
2550
|
+
inStock: boolean;
|
|
2551
|
+
inventoryStatus: InventoryStatus;
|
|
2552
|
+
};
|
|
2553
|
+
price?: {
|
|
2554
|
+
currency: string;
|
|
2555
|
+
discountedPrice: number;
|
|
2556
|
+
formatted?: {
|
|
2557
|
+
price: string;
|
|
2558
|
+
discountedPrice: string;
|
|
2559
|
+
};
|
|
2560
|
+
};
|
|
2561
|
+
priceData?: {
|
|
2562
|
+
currency: string;
|
|
2563
|
+
discountedPrice: number;
|
|
2564
|
+
formatted?: {
|
|
2565
|
+
price: string;
|
|
2566
|
+
discountedPrice: string;
|
|
2567
|
+
};
|
|
2568
|
+
};
|
|
2569
|
+
convertedPriceData?: {
|
|
2570
|
+
currency: string;
|
|
2571
|
+
discountedPrice: number;
|
|
2572
|
+
formatted?: {
|
|
2573
|
+
price: string;
|
|
2574
|
+
discountedPrice: string;
|
|
2575
|
+
};
|
|
2576
|
+
};
|
|
2577
|
+
priceRange?: {
|
|
2578
|
+
minValue: number;
|
|
2579
|
+
maxValue: number;
|
|
2580
|
+
};
|
|
2581
|
+
costAndProfitData?: {
|
|
2582
|
+
formattedItemCost: string;
|
|
2583
|
+
profit: number;
|
|
2584
|
+
formattedProfit: string;
|
|
2585
|
+
profitMargin: number;
|
|
2586
|
+
};
|
|
2587
|
+
costRange?: {
|
|
2588
|
+
minValue: number;
|
|
2589
|
+
maxValue: number;
|
|
2590
|
+
};
|
|
2591
|
+
pricePerUnitData?: {
|
|
2592
|
+
totalQuantity: number;
|
|
2593
|
+
totalMeasurementUnit: MeasurementUnit;
|
|
2594
|
+
baseQuantity: number;
|
|
2595
|
+
baseMeasurementUnit: MeasurementUnit;
|
|
2596
|
+
};
|
|
2597
|
+
additionalInfoSections: {
|
|
2598
|
+
title: string;
|
|
2599
|
+
description: string;
|
|
2600
|
+
}[];
|
|
2601
|
+
ribbons: {
|
|
2602
|
+
text: string;
|
|
2603
|
+
}[];
|
|
2604
|
+
media?: {
|
|
2605
|
+
mainMedia?: {
|
|
2606
|
+
image?: {
|
|
2607
|
+
url: string;
|
|
2608
|
+
width: number;
|
|
2609
|
+
height: number;
|
|
2610
|
+
};
|
|
2611
|
+
video?: {
|
|
2612
|
+
files: {
|
|
2613
|
+
url: string;
|
|
2614
|
+
width: number;
|
|
2615
|
+
height: number;
|
|
2616
|
+
}[];
|
|
2617
|
+
stillFrameMediaId: string;
|
|
2618
|
+
};
|
|
2619
|
+
thumbnail?: {
|
|
2620
|
+
url: string;
|
|
2621
|
+
width: number;
|
|
2622
|
+
height: number;
|
|
2623
|
+
};
|
|
2624
|
+
mediaType: MediaItemType;
|
|
2625
|
+
title: string;
|
|
2626
|
+
_id: string;
|
|
2627
|
+
};
|
|
2628
|
+
items: {
|
|
2629
|
+
image?: {
|
|
2630
|
+
url: string;
|
|
2631
|
+
width: number;
|
|
2632
|
+
height: number;
|
|
2633
|
+
};
|
|
2634
|
+
video?: {
|
|
2635
|
+
files: {
|
|
2636
|
+
url: string;
|
|
2637
|
+
width: number;
|
|
2638
|
+
height: number;
|
|
2639
|
+
}[];
|
|
2640
|
+
stillFrameMediaId: string;
|
|
2641
|
+
};
|
|
2642
|
+
thumbnail?: {
|
|
2643
|
+
url: string;
|
|
2644
|
+
width: number;
|
|
2645
|
+
height: number;
|
|
2646
|
+
};
|
|
2647
|
+
mediaType: MediaItemType;
|
|
2648
|
+
title: string;
|
|
2649
|
+
_id: string;
|
|
2650
|
+
}[];
|
|
2651
|
+
};
|
|
2652
|
+
customTextFields: {
|
|
2653
|
+
title: string;
|
|
2654
|
+
maxLength: number;
|
|
2655
|
+
mandatory: boolean;
|
|
2656
|
+
}[];
|
|
2657
|
+
productOptions: {
|
|
2658
|
+
optionType: OptionType;
|
|
2659
|
+
name: string;
|
|
2660
|
+
choices: {
|
|
2661
|
+
value: string;
|
|
2662
|
+
description: string;
|
|
2663
|
+
media?: {
|
|
2664
|
+
mainMedia?: {
|
|
2665
|
+
image?: {
|
|
2666
|
+
url: string;
|
|
2667
|
+
width: number;
|
|
2668
|
+
height: number;
|
|
2669
|
+
};
|
|
2670
|
+
video?: {
|
|
2671
|
+
files: {
|
|
2672
|
+
url: string;
|
|
2673
|
+
width: number;
|
|
2674
|
+
height: number;
|
|
2675
|
+
}[];
|
|
2676
|
+
stillFrameMediaId: string;
|
|
2677
|
+
};
|
|
2678
|
+
thumbnail?: {
|
|
2679
|
+
url: string;
|
|
2680
|
+
width: number;
|
|
2681
|
+
height: number;
|
|
2682
|
+
};
|
|
2683
|
+
mediaType: MediaItemType;
|
|
2684
|
+
title: string;
|
|
2685
|
+
_id: string;
|
|
2686
|
+
};
|
|
2687
|
+
items: {
|
|
2688
|
+
image?: {
|
|
2689
|
+
url: string;
|
|
2690
|
+
width: number;
|
|
2691
|
+
height: number;
|
|
2692
|
+
};
|
|
2693
|
+
video?: {
|
|
2694
|
+
files: {
|
|
2695
|
+
url: string;
|
|
2696
|
+
width: number;
|
|
2697
|
+
height: number;
|
|
2698
|
+
}[];
|
|
2699
|
+
stillFrameMediaId: string;
|
|
2700
|
+
};
|
|
2701
|
+
thumbnail?: {
|
|
2702
|
+
url: string;
|
|
2703
|
+
width: number;
|
|
2704
|
+
height: number;
|
|
2705
|
+
};
|
|
2706
|
+
mediaType: MediaItemType;
|
|
2707
|
+
title: string;
|
|
2708
|
+
_id: string;
|
|
2709
|
+
}[];
|
|
2710
|
+
};
|
|
2711
|
+
inStock: boolean;
|
|
2712
|
+
visible: boolean;
|
|
2713
|
+
}[];
|
|
2714
|
+
}[];
|
|
2715
|
+
productPageUrl?: {
|
|
2716
|
+
base: string;
|
|
2717
|
+
path: string;
|
|
2718
|
+
};
|
|
2719
|
+
numericId: string;
|
|
2720
|
+
inventoryItemId: string;
|
|
2721
|
+
discount?: {
|
|
2722
|
+
type: DiscountType;
|
|
2723
|
+
value: number;
|
|
2724
|
+
};
|
|
2725
|
+
collectionIds: string[];
|
|
2726
|
+
variants: {
|
|
2727
|
+
_id: string;
|
|
2728
|
+
variant?: {
|
|
2729
|
+
priceData?: {
|
|
2730
|
+
currency: string;
|
|
2731
|
+
discountedPrice: number;
|
|
2732
|
+
formatted?: {
|
|
2733
|
+
price: string;
|
|
2734
|
+
discountedPrice: string;
|
|
2735
|
+
};
|
|
2736
|
+
};
|
|
2737
|
+
convertedPriceData?: {
|
|
2738
|
+
currency: string;
|
|
2739
|
+
discountedPrice: number;
|
|
2740
|
+
formatted?: {
|
|
2741
|
+
price: string;
|
|
2742
|
+
discountedPrice: string;
|
|
2743
|
+
};
|
|
2744
|
+
};
|
|
2745
|
+
costAndProfitData?: {
|
|
2746
|
+
formattedItemCost: string;
|
|
2747
|
+
profit: number;
|
|
2748
|
+
formattedProfit: string;
|
|
2749
|
+
profitMargin: number;
|
|
2750
|
+
};
|
|
2751
|
+
weight: number;
|
|
2752
|
+
sku: string;
|
|
2753
|
+
visible: boolean;
|
|
2754
|
+
};
|
|
2755
|
+
stock?: {
|
|
2756
|
+
trackQuantity: boolean;
|
|
2757
|
+
inStock: boolean;
|
|
2758
|
+
};
|
|
2759
|
+
}[];
|
|
2760
|
+
seoData?: {
|
|
2761
|
+
tags: {
|
|
2762
|
+
type: string;
|
|
2763
|
+
children: string;
|
|
2764
|
+
custom: boolean;
|
|
2765
|
+
disabled: boolean;
|
|
2766
|
+
}[];
|
|
2767
|
+
settings?: {
|
|
2768
|
+
preventAutoRedirect: boolean;
|
|
2769
|
+
keywords: {
|
|
2770
|
+
term: string;
|
|
2771
|
+
isMain: boolean;
|
|
2772
|
+
}[];
|
|
2773
|
+
};
|
|
2774
|
+
};
|
|
2775
|
+
}[];
|
|
2776
|
+
}
|
|
2777
|
+
export interface GetProductResponseNonNullableFields {
|
|
2778
|
+
product?: {
|
|
2779
|
+
_id: string;
|
|
2780
|
+
slug: string;
|
|
2781
|
+
productType: ProductType;
|
|
2782
|
+
weightRange?: {
|
|
2783
|
+
minValue: number;
|
|
2784
|
+
maxValue: number;
|
|
2785
|
+
};
|
|
2786
|
+
stock?: {
|
|
2787
|
+
trackInventory: boolean;
|
|
2788
|
+
inStock: boolean;
|
|
2789
|
+
inventoryStatus: InventoryStatus;
|
|
2790
|
+
};
|
|
2791
|
+
price?: {
|
|
2792
|
+
currency: string;
|
|
2793
|
+
discountedPrice: number;
|
|
2794
|
+
formatted?: {
|
|
2795
|
+
price: string;
|
|
2796
|
+
discountedPrice: string;
|
|
2797
|
+
};
|
|
2798
|
+
};
|
|
2799
|
+
priceData?: {
|
|
2800
|
+
currency: string;
|
|
2801
|
+
discountedPrice: number;
|
|
2802
|
+
formatted?: {
|
|
2803
|
+
price: string;
|
|
2804
|
+
discountedPrice: string;
|
|
2805
|
+
};
|
|
2806
|
+
};
|
|
2807
|
+
convertedPriceData?: {
|
|
2808
|
+
currency: string;
|
|
2809
|
+
discountedPrice: number;
|
|
2810
|
+
formatted?: {
|
|
2811
|
+
price: string;
|
|
2812
|
+
discountedPrice: string;
|
|
2813
|
+
};
|
|
2814
|
+
};
|
|
2815
|
+
priceRange?: {
|
|
2816
|
+
minValue: number;
|
|
2817
|
+
maxValue: number;
|
|
2818
|
+
};
|
|
2819
|
+
costAndProfitData?: {
|
|
2820
|
+
formattedItemCost: string;
|
|
2821
|
+
profit: number;
|
|
2822
|
+
formattedProfit: string;
|
|
2823
|
+
profitMargin: number;
|
|
2824
|
+
};
|
|
2825
|
+
costRange?: {
|
|
2826
|
+
minValue: number;
|
|
2827
|
+
maxValue: number;
|
|
2828
|
+
};
|
|
2829
|
+
pricePerUnitData?: {
|
|
2830
|
+
totalQuantity: number;
|
|
2831
|
+
totalMeasurementUnit: MeasurementUnit;
|
|
2832
|
+
baseQuantity: number;
|
|
2833
|
+
baseMeasurementUnit: MeasurementUnit;
|
|
2834
|
+
};
|
|
2835
|
+
additionalInfoSections: {
|
|
2836
|
+
title: string;
|
|
2837
|
+
description: string;
|
|
2838
|
+
}[];
|
|
2839
|
+
ribbons: {
|
|
2840
|
+
text: string;
|
|
2841
|
+
}[];
|
|
2842
|
+
media?: {
|
|
2843
|
+
mainMedia?: {
|
|
2844
|
+
image?: {
|
|
2845
|
+
url: string;
|
|
2846
|
+
width: number;
|
|
2847
|
+
height: number;
|
|
2848
|
+
};
|
|
2849
|
+
video?: {
|
|
2850
|
+
files: {
|
|
2851
|
+
url: string;
|
|
2852
|
+
width: number;
|
|
2853
|
+
height: number;
|
|
2854
|
+
}[];
|
|
2855
|
+
stillFrameMediaId: string;
|
|
2856
|
+
};
|
|
2857
|
+
thumbnail?: {
|
|
2858
|
+
url: string;
|
|
2859
|
+
width: number;
|
|
2860
|
+
height: number;
|
|
2861
|
+
};
|
|
2862
|
+
mediaType: MediaItemType;
|
|
2863
|
+
title: string;
|
|
2864
|
+
_id: string;
|
|
2865
|
+
};
|
|
2866
|
+
items: {
|
|
2867
|
+
image?: {
|
|
2868
|
+
url: string;
|
|
2869
|
+
width: number;
|
|
2870
|
+
height: number;
|
|
2871
|
+
};
|
|
2872
|
+
video?: {
|
|
2873
|
+
files: {
|
|
2874
|
+
url: string;
|
|
2875
|
+
width: number;
|
|
2876
|
+
height: number;
|
|
2877
|
+
}[];
|
|
2878
|
+
stillFrameMediaId: string;
|
|
2879
|
+
};
|
|
2880
|
+
thumbnail?: {
|
|
2881
|
+
url: string;
|
|
2882
|
+
width: number;
|
|
2883
|
+
height: number;
|
|
2884
|
+
};
|
|
2885
|
+
mediaType: MediaItemType;
|
|
2886
|
+
title: string;
|
|
2887
|
+
_id: string;
|
|
2888
|
+
}[];
|
|
2889
|
+
};
|
|
2890
|
+
customTextFields: {
|
|
2891
|
+
title: string;
|
|
2892
|
+
maxLength: number;
|
|
2893
|
+
mandatory: boolean;
|
|
2894
|
+
}[];
|
|
2895
|
+
productOptions: {
|
|
2896
|
+
optionType: OptionType;
|
|
2897
|
+
name: string;
|
|
2898
|
+
choices: {
|
|
2899
|
+
value: string;
|
|
2900
|
+
description: string;
|
|
2901
|
+
media?: {
|
|
2902
|
+
mainMedia?: {
|
|
2903
|
+
image?: {
|
|
2904
|
+
url: string;
|
|
2905
|
+
width: number;
|
|
2906
|
+
height: number;
|
|
2907
|
+
};
|
|
2908
|
+
video?: {
|
|
2909
|
+
files: {
|
|
2910
|
+
url: string;
|
|
2911
|
+
width: number;
|
|
2912
|
+
height: number;
|
|
2913
|
+
}[];
|
|
2914
|
+
stillFrameMediaId: string;
|
|
2915
|
+
};
|
|
2916
|
+
thumbnail?: {
|
|
2917
|
+
url: string;
|
|
2918
|
+
width: number;
|
|
2919
|
+
height: number;
|
|
2920
|
+
};
|
|
2921
|
+
mediaType: MediaItemType;
|
|
2922
|
+
title: string;
|
|
2923
|
+
_id: string;
|
|
2924
|
+
};
|
|
2925
|
+
items: {
|
|
2926
|
+
image?: {
|
|
2927
|
+
url: string;
|
|
2928
|
+
width: number;
|
|
2929
|
+
height: number;
|
|
2930
|
+
};
|
|
2931
|
+
video?: {
|
|
2932
|
+
files: {
|
|
2933
|
+
url: string;
|
|
2934
|
+
width: number;
|
|
2935
|
+
height: number;
|
|
2936
|
+
}[];
|
|
2937
|
+
stillFrameMediaId: string;
|
|
2938
|
+
};
|
|
2939
|
+
thumbnail?: {
|
|
2940
|
+
url: string;
|
|
2941
|
+
width: number;
|
|
2942
|
+
height: number;
|
|
2943
|
+
};
|
|
2944
|
+
mediaType: MediaItemType;
|
|
2945
|
+
title: string;
|
|
2946
|
+
_id: string;
|
|
2947
|
+
}[];
|
|
2948
|
+
};
|
|
2949
|
+
inStock: boolean;
|
|
2950
|
+
visible: boolean;
|
|
2951
|
+
}[];
|
|
2952
|
+
}[];
|
|
2953
|
+
productPageUrl?: {
|
|
2954
|
+
base: string;
|
|
2955
|
+
path: string;
|
|
2956
|
+
};
|
|
2957
|
+
numericId: string;
|
|
2958
|
+
inventoryItemId: string;
|
|
2959
|
+
discount?: {
|
|
2960
|
+
type: DiscountType;
|
|
2961
|
+
value: number;
|
|
2962
|
+
};
|
|
2963
|
+
collectionIds: string[];
|
|
2964
|
+
variants: {
|
|
2965
|
+
_id: string;
|
|
2966
|
+
variant?: {
|
|
2967
|
+
priceData?: {
|
|
2968
|
+
currency: string;
|
|
2969
|
+
discountedPrice: number;
|
|
2970
|
+
formatted?: {
|
|
2971
|
+
price: string;
|
|
2972
|
+
discountedPrice: string;
|
|
2973
|
+
};
|
|
2974
|
+
};
|
|
2975
|
+
convertedPriceData?: {
|
|
2976
|
+
currency: string;
|
|
2977
|
+
discountedPrice: number;
|
|
2978
|
+
formatted?: {
|
|
2979
|
+
price: string;
|
|
2980
|
+
discountedPrice: string;
|
|
2981
|
+
};
|
|
2982
|
+
};
|
|
2983
|
+
costAndProfitData?: {
|
|
2984
|
+
formattedItemCost: string;
|
|
2985
|
+
profit: number;
|
|
2986
|
+
formattedProfit: string;
|
|
2987
|
+
profitMargin: number;
|
|
2988
|
+
};
|
|
2989
|
+
weight: number;
|
|
2990
|
+
sku: string;
|
|
2991
|
+
visible: boolean;
|
|
2992
|
+
};
|
|
2993
|
+
stock?: {
|
|
2994
|
+
trackQuantity: boolean;
|
|
2995
|
+
inStock: boolean;
|
|
2996
|
+
};
|
|
2997
|
+
}[];
|
|
2998
|
+
seoData?: {
|
|
2999
|
+
tags: {
|
|
3000
|
+
type: string;
|
|
3001
|
+
children: string;
|
|
3002
|
+
custom: boolean;
|
|
3003
|
+
disabled: boolean;
|
|
3004
|
+
}[];
|
|
3005
|
+
settings?: {
|
|
3006
|
+
preventAutoRedirect: boolean;
|
|
3007
|
+
keywords: {
|
|
3008
|
+
term: string;
|
|
3009
|
+
isMain: boolean;
|
|
3010
|
+
}[];
|
|
3011
|
+
};
|
|
3012
|
+
};
|
|
3013
|
+
};
|
|
3014
|
+
}
|
|
3015
|
+
export interface GetProductPlatformizedResponseNonNullableFields {
|
|
3016
|
+
product?: {
|
|
3017
|
+
_id: string;
|
|
3018
|
+
slug: string;
|
|
3019
|
+
productType: ProductType;
|
|
3020
|
+
weightRange?: {
|
|
3021
|
+
minValue: number;
|
|
3022
|
+
maxValue: number;
|
|
3023
|
+
};
|
|
3024
|
+
stock?: {
|
|
3025
|
+
trackInventory: boolean;
|
|
3026
|
+
inStock: boolean;
|
|
3027
|
+
inventoryStatus: InventoryStatus;
|
|
3028
|
+
};
|
|
3029
|
+
price?: {
|
|
3030
|
+
currency: string;
|
|
3031
|
+
discountedPrice: number;
|
|
3032
|
+
formatted?: {
|
|
3033
|
+
price: string;
|
|
3034
|
+
discountedPrice: string;
|
|
3035
|
+
};
|
|
3036
|
+
};
|
|
3037
|
+
priceData?: {
|
|
3038
|
+
currency: string;
|
|
3039
|
+
discountedPrice: number;
|
|
3040
|
+
formatted?: {
|
|
3041
|
+
price: string;
|
|
3042
|
+
discountedPrice: string;
|
|
3043
|
+
};
|
|
3044
|
+
};
|
|
3045
|
+
convertedPriceData?: {
|
|
3046
|
+
currency: string;
|
|
3047
|
+
discountedPrice: number;
|
|
3048
|
+
formatted?: {
|
|
3049
|
+
price: string;
|
|
3050
|
+
discountedPrice: string;
|
|
3051
|
+
};
|
|
3052
|
+
};
|
|
3053
|
+
priceRange?: {
|
|
3054
|
+
minValue: number;
|
|
3055
|
+
maxValue: number;
|
|
3056
|
+
};
|
|
3057
|
+
costAndProfitData?: {
|
|
3058
|
+
formattedItemCost: string;
|
|
3059
|
+
profit: number;
|
|
3060
|
+
formattedProfit: string;
|
|
3061
|
+
profitMargin: number;
|
|
3062
|
+
};
|
|
3063
|
+
costRange?: {
|
|
3064
|
+
minValue: number;
|
|
3065
|
+
maxValue: number;
|
|
3066
|
+
};
|
|
3067
|
+
pricePerUnitData?: {
|
|
3068
|
+
totalQuantity: number;
|
|
3069
|
+
totalMeasurementUnit: MeasurementUnit;
|
|
3070
|
+
baseQuantity: number;
|
|
3071
|
+
baseMeasurementUnit: MeasurementUnit;
|
|
3072
|
+
};
|
|
3073
|
+
additionalInfoSections: {
|
|
3074
|
+
title: string;
|
|
3075
|
+
description: string;
|
|
3076
|
+
}[];
|
|
3077
|
+
ribbons: {
|
|
3078
|
+
text: string;
|
|
3079
|
+
}[];
|
|
3080
|
+
media?: {
|
|
3081
|
+
mainMedia?: {
|
|
3082
|
+
image?: {
|
|
3083
|
+
url: string;
|
|
3084
|
+
width: number;
|
|
3085
|
+
height: number;
|
|
3086
|
+
};
|
|
3087
|
+
video?: {
|
|
3088
|
+
files: {
|
|
3089
|
+
url: string;
|
|
3090
|
+
width: number;
|
|
3091
|
+
height: number;
|
|
3092
|
+
}[];
|
|
3093
|
+
stillFrameMediaId: string;
|
|
3094
|
+
};
|
|
3095
|
+
thumbnail?: {
|
|
3096
|
+
url: string;
|
|
3097
|
+
width: number;
|
|
3098
|
+
height: number;
|
|
3099
|
+
};
|
|
3100
|
+
mediaType: MediaItemType;
|
|
3101
|
+
title: string;
|
|
3102
|
+
_id: string;
|
|
3103
|
+
};
|
|
3104
|
+
items: {
|
|
3105
|
+
image?: {
|
|
3106
|
+
url: string;
|
|
3107
|
+
width: number;
|
|
3108
|
+
height: number;
|
|
3109
|
+
};
|
|
3110
|
+
video?: {
|
|
3111
|
+
files: {
|
|
3112
|
+
url: string;
|
|
3113
|
+
width: number;
|
|
3114
|
+
height: number;
|
|
3115
|
+
}[];
|
|
3116
|
+
stillFrameMediaId: string;
|
|
3117
|
+
};
|
|
3118
|
+
thumbnail?: {
|
|
3119
|
+
url: string;
|
|
3120
|
+
width: number;
|
|
3121
|
+
height: number;
|
|
3122
|
+
};
|
|
3123
|
+
mediaType: MediaItemType;
|
|
3124
|
+
title: string;
|
|
3125
|
+
_id: string;
|
|
3126
|
+
}[];
|
|
3127
|
+
};
|
|
3128
|
+
customTextFields: {
|
|
3129
|
+
title: string;
|
|
3130
|
+
maxLength: number;
|
|
3131
|
+
mandatory: boolean;
|
|
3132
|
+
}[];
|
|
3133
|
+
productOptions: {
|
|
3134
|
+
optionType: OptionType;
|
|
3135
|
+
name: string;
|
|
3136
|
+
choices: {
|
|
3137
|
+
value: string;
|
|
3138
|
+
description: string;
|
|
3139
|
+
media?: {
|
|
3140
|
+
mainMedia?: {
|
|
3141
|
+
image?: {
|
|
3142
|
+
url: string;
|
|
3143
|
+
width: number;
|
|
3144
|
+
height: number;
|
|
3145
|
+
};
|
|
3146
|
+
video?: {
|
|
3147
|
+
files: {
|
|
3148
|
+
url: string;
|
|
3149
|
+
width: number;
|
|
3150
|
+
height: number;
|
|
3151
|
+
}[];
|
|
3152
|
+
stillFrameMediaId: string;
|
|
3153
|
+
};
|
|
3154
|
+
thumbnail?: {
|
|
3155
|
+
url: string;
|
|
3156
|
+
width: number;
|
|
3157
|
+
height: number;
|
|
3158
|
+
};
|
|
3159
|
+
mediaType: MediaItemType;
|
|
3160
|
+
title: string;
|
|
3161
|
+
_id: string;
|
|
3162
|
+
};
|
|
3163
|
+
items: {
|
|
3164
|
+
image?: {
|
|
3165
|
+
url: string;
|
|
3166
|
+
width: number;
|
|
3167
|
+
height: number;
|
|
3168
|
+
};
|
|
3169
|
+
video?: {
|
|
3170
|
+
files: {
|
|
3171
|
+
url: string;
|
|
3172
|
+
width: number;
|
|
3173
|
+
height: number;
|
|
3174
|
+
}[];
|
|
3175
|
+
stillFrameMediaId: string;
|
|
3176
|
+
};
|
|
3177
|
+
thumbnail?: {
|
|
3178
|
+
url: string;
|
|
3179
|
+
width: number;
|
|
3180
|
+
height: number;
|
|
3181
|
+
};
|
|
3182
|
+
mediaType: MediaItemType;
|
|
3183
|
+
title: string;
|
|
3184
|
+
_id: string;
|
|
3185
|
+
}[];
|
|
3186
|
+
};
|
|
3187
|
+
inStock: boolean;
|
|
3188
|
+
visible: boolean;
|
|
3189
|
+
}[];
|
|
3190
|
+
}[];
|
|
3191
|
+
productPageUrl?: {
|
|
3192
|
+
base: string;
|
|
3193
|
+
path: string;
|
|
3194
|
+
};
|
|
3195
|
+
numericId: string;
|
|
3196
|
+
inventoryItemId: string;
|
|
3197
|
+
discount?: {
|
|
3198
|
+
type: DiscountType;
|
|
3199
|
+
value: number;
|
|
3200
|
+
};
|
|
3201
|
+
collectionIds: string[];
|
|
3202
|
+
variants: {
|
|
3203
|
+
_id: string;
|
|
3204
|
+
variant?: {
|
|
3205
|
+
priceData?: {
|
|
3206
|
+
currency: string;
|
|
3207
|
+
discountedPrice: number;
|
|
3208
|
+
formatted?: {
|
|
3209
|
+
price: string;
|
|
3210
|
+
discountedPrice: string;
|
|
3211
|
+
};
|
|
3212
|
+
};
|
|
3213
|
+
convertedPriceData?: {
|
|
3214
|
+
currency: string;
|
|
3215
|
+
discountedPrice: number;
|
|
3216
|
+
formatted?: {
|
|
3217
|
+
price: string;
|
|
3218
|
+
discountedPrice: string;
|
|
3219
|
+
};
|
|
3220
|
+
};
|
|
3221
|
+
costAndProfitData?: {
|
|
3222
|
+
formattedItemCost: string;
|
|
3223
|
+
profit: number;
|
|
3224
|
+
formattedProfit: string;
|
|
3225
|
+
profitMargin: number;
|
|
3226
|
+
};
|
|
3227
|
+
weight: number;
|
|
3228
|
+
sku: string;
|
|
3229
|
+
visible: boolean;
|
|
3230
|
+
};
|
|
3231
|
+
stock?: {
|
|
3232
|
+
trackQuantity: boolean;
|
|
3233
|
+
inStock: boolean;
|
|
3234
|
+
};
|
|
3235
|
+
}[];
|
|
3236
|
+
seoData?: {
|
|
3237
|
+
tags: {
|
|
3238
|
+
type: string;
|
|
3239
|
+
children: string;
|
|
3240
|
+
custom: boolean;
|
|
3241
|
+
disabled: boolean;
|
|
3242
|
+
}[];
|
|
3243
|
+
settings?: {
|
|
3244
|
+
preventAutoRedirect: boolean;
|
|
3245
|
+
keywords: {
|
|
3246
|
+
term: string;
|
|
3247
|
+
isMain: boolean;
|
|
3248
|
+
}[];
|
|
3249
|
+
};
|
|
3250
|
+
};
|
|
3251
|
+
};
|
|
3252
|
+
}
|
|
3253
|
+
export interface GetCollectionBySlugResponseNonNullableFields {
|
|
3254
|
+
collection?: {
|
|
3255
|
+
media?: {
|
|
3256
|
+
mainMedia?: {
|
|
3257
|
+
image?: {
|
|
3258
|
+
url: string;
|
|
3259
|
+
width: number;
|
|
3260
|
+
height: number;
|
|
3261
|
+
};
|
|
3262
|
+
video?: {
|
|
3263
|
+
files: {
|
|
3264
|
+
url: string;
|
|
3265
|
+
width: number;
|
|
3266
|
+
height: number;
|
|
3267
|
+
}[];
|
|
3268
|
+
stillFrameMediaId: string;
|
|
3269
|
+
};
|
|
3270
|
+
thumbnail?: {
|
|
3271
|
+
url: string;
|
|
3272
|
+
width: number;
|
|
3273
|
+
height: number;
|
|
3274
|
+
};
|
|
3275
|
+
mediaType: MediaItemType;
|
|
3276
|
+
title: string;
|
|
3277
|
+
_id: string;
|
|
3278
|
+
};
|
|
3279
|
+
items: {
|
|
3280
|
+
image?: {
|
|
3281
|
+
url: string;
|
|
3282
|
+
width: number;
|
|
3283
|
+
height: number;
|
|
3284
|
+
};
|
|
3285
|
+
video?: {
|
|
3286
|
+
files: {
|
|
3287
|
+
url: string;
|
|
3288
|
+
width: number;
|
|
3289
|
+
height: number;
|
|
3290
|
+
}[];
|
|
3291
|
+
stillFrameMediaId: string;
|
|
3292
|
+
};
|
|
3293
|
+
thumbnail?: {
|
|
3294
|
+
url: string;
|
|
3295
|
+
width: number;
|
|
3296
|
+
height: number;
|
|
3297
|
+
};
|
|
3298
|
+
mediaType: MediaItemType;
|
|
3299
|
+
title: string;
|
|
3300
|
+
_id: string;
|
|
3301
|
+
}[];
|
|
3302
|
+
};
|
|
3303
|
+
numberOfProducts: number;
|
|
3304
|
+
};
|
|
3305
|
+
}
|
|
3306
|
+
export interface ProductOptionsAvailabilityResponseNonNullableFields {
|
|
3307
|
+
selectedVariant?: {
|
|
3308
|
+
price?: {
|
|
3309
|
+
currency: string;
|
|
3310
|
+
discountedPrice: number;
|
|
3311
|
+
formatted?: {
|
|
3312
|
+
price: string;
|
|
3313
|
+
discountedPrice: string;
|
|
3314
|
+
};
|
|
3315
|
+
};
|
|
3316
|
+
convertedPriceData?: {
|
|
3317
|
+
currency: string;
|
|
3318
|
+
discountedPrice: number;
|
|
3319
|
+
formatted?: {
|
|
3320
|
+
price: string;
|
|
3321
|
+
discountedPrice: string;
|
|
3322
|
+
};
|
|
3323
|
+
};
|
|
3324
|
+
sku: string;
|
|
3325
|
+
inStock: boolean;
|
|
3326
|
+
visible: boolean;
|
|
3327
|
+
};
|
|
3328
|
+
media?: {
|
|
3329
|
+
mainMedia?: {
|
|
3330
|
+
image?: {
|
|
3331
|
+
url: string;
|
|
3332
|
+
width: number;
|
|
3333
|
+
height: number;
|
|
2620
3334
|
};
|
|
2621
3335
|
video?: {
|
|
2622
3336
|
files: {
|
|
@@ -2820,6 +3534,20 @@ export interface GetStoreVariantResponseNonNullableFields {
|
|
|
2820
3534
|
* @applicableIdentity APP
|
|
2821
3535
|
*/
|
|
2822
3536
|
export declare function createProduct(product: Product): Promise<CreateProductResponse & CreateProductResponseNonNullableFields>;
|
|
3537
|
+
/**
|
|
3538
|
+
* Creates a new product.
|
|
3539
|
+
* @param product - Product information.
|
|
3540
|
+
* @public
|
|
3541
|
+
* @documentationMaturity preview
|
|
3542
|
+
* @requiredField product
|
|
3543
|
+
* @requiredField product.costAndProfitData.itemCost
|
|
3544
|
+
* @requiredField product.name
|
|
3545
|
+
* @requiredField product.priceData
|
|
3546
|
+
* @requiredField product.priceData.price
|
|
3547
|
+
* @permissionScope Manage Products
|
|
3548
|
+
* @applicableIdentity APP
|
|
3549
|
+
*/
|
|
3550
|
+
export declare function createProductPlatformized(product: Product): Promise<Product & NonNullable<CreateProductPlatformizedResponseNonNullableFields>['product']>;
|
|
2823
3551
|
/**
|
|
2824
3552
|
* Updates specified fields in a product.
|
|
2825
3553
|
* @param _id - Product ID (generated automatically by the catalog).
|
|
@@ -2959,6 +3687,144 @@ export interface UpdateProduct {
|
|
|
2959
3687
|
/** 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). */
|
|
2960
3688
|
brand?: string | null;
|
|
2961
3689
|
}
|
|
3690
|
+
/**
|
|
3691
|
+
* Updates specified fields in a product.
|
|
3692
|
+
* @param _id - Product ID (generated automatically by the catalog).
|
|
3693
|
+
* @public
|
|
3694
|
+
* @documentationMaturity preview
|
|
3695
|
+
* @requiredField _id
|
|
3696
|
+
* @requiredField product
|
|
3697
|
+
* @permissionScope Manage Products
|
|
3698
|
+
* @applicableIdentity APP
|
|
3699
|
+
*/
|
|
3700
|
+
export declare function updateProductPlatformized(_id: string, product: UpdateProductPlatformizedProduct): Promise<Product & NonNullable<UpdateProductPlatformizedResponseNonNullableFields>['product']>;
|
|
3701
|
+
export interface UpdateProductPlatformizedProduct {
|
|
3702
|
+
/**
|
|
3703
|
+
* Product ID (generated automatically by the catalog).
|
|
3704
|
+
* @readonly
|
|
3705
|
+
*/
|
|
3706
|
+
_id?: string;
|
|
3707
|
+
/**
|
|
3708
|
+
* Product name.
|
|
3709
|
+
*
|
|
3710
|
+
* Min: 1 character
|
|
3711
|
+
* Max: 80 characters
|
|
3712
|
+
*/
|
|
3713
|
+
name?: string | null;
|
|
3714
|
+
/** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
|
|
3715
|
+
slug?: string;
|
|
3716
|
+
/** Whether the product is visible to site visitors. */
|
|
3717
|
+
visible?: boolean | null;
|
|
3718
|
+
/** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
|
|
3719
|
+
productType?: ProductType;
|
|
3720
|
+
/** Product description. */
|
|
3721
|
+
description?: string | null;
|
|
3722
|
+
/** 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. */
|
|
3723
|
+
sku?: string | null;
|
|
3724
|
+
/** 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. */
|
|
3725
|
+
weight?: number | null;
|
|
3726
|
+
/**
|
|
3727
|
+
* Product weight range. The minimum and maximum weights of all the variants.
|
|
3728
|
+
* @readonly
|
|
3729
|
+
*/
|
|
3730
|
+
weightRange?: NumericPropertyRange;
|
|
3731
|
+
/**
|
|
3732
|
+
* Product inventory status (in future this will be writable via Inventory API).
|
|
3733
|
+
* @readonly
|
|
3734
|
+
*/
|
|
3735
|
+
stock?: Stock;
|
|
3736
|
+
/**
|
|
3737
|
+
* Deprecated (use `priceData` instead).
|
|
3738
|
+
* @readonly
|
|
3739
|
+
*/
|
|
3740
|
+
price?: PriceData;
|
|
3741
|
+
/** Price data. */
|
|
3742
|
+
priceData?: PriceData;
|
|
3743
|
+
/**
|
|
3744
|
+
* Price data, converted to the currency specified in request header.
|
|
3745
|
+
* @readonly
|
|
3746
|
+
*/
|
|
3747
|
+
convertedPriceData?: PriceData;
|
|
3748
|
+
/**
|
|
3749
|
+
* Product price range. The minimum and maximum prices of all the variants.
|
|
3750
|
+
* @readonly
|
|
3751
|
+
*/
|
|
3752
|
+
priceRange?: NumericPropertyRange;
|
|
3753
|
+
/** Cost and profit data. */
|
|
3754
|
+
costAndProfitData?: CostAndProfitData;
|
|
3755
|
+
/**
|
|
3756
|
+
* Product cost range. The minimum and maximum costs of all the variants.
|
|
3757
|
+
* @readonly
|
|
3758
|
+
*/
|
|
3759
|
+
costRange?: NumericPropertyRange;
|
|
3760
|
+
/** Price per unit data. */
|
|
3761
|
+
pricePerUnitData?: PricePerUnitData;
|
|
3762
|
+
/** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */
|
|
3763
|
+
additionalInfoSections?: AdditionalInfoSection[];
|
|
3764
|
+
/**
|
|
3765
|
+
* Deprecated (use `ribbon` instead).
|
|
3766
|
+
* @readonly
|
|
3767
|
+
*/
|
|
3768
|
+
ribbons?: Ribbon[];
|
|
3769
|
+
/**
|
|
3770
|
+
* 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).
|
|
3771
|
+
* @readonly
|
|
3772
|
+
*/
|
|
3773
|
+
media?: Media;
|
|
3774
|
+
/**
|
|
3775
|
+
* Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
|
|
3776
|
+
* @readonly
|
|
3777
|
+
*/
|
|
3778
|
+
customTextFields?: CustomTextField[];
|
|
3779
|
+
/** 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. */
|
|
3780
|
+
manageVariants?: boolean | null;
|
|
3781
|
+
/** Options for this product. */
|
|
3782
|
+
productOptions?: ProductOption[];
|
|
3783
|
+
/**
|
|
3784
|
+
* Product page URL for this product (generated automatically by the server).
|
|
3785
|
+
* @readonly
|
|
3786
|
+
*/
|
|
3787
|
+
productPageUrl?: PageUrl;
|
|
3788
|
+
/**
|
|
3789
|
+
* Product’s unique numeric ID (assigned in ascending order).
|
|
3790
|
+
* Primarily used for sorting and filtering when crawling all products.
|
|
3791
|
+
* @readonly
|
|
3792
|
+
*/
|
|
3793
|
+
numericId?: string;
|
|
3794
|
+
/**
|
|
3795
|
+
* Inventory item ID - ID referencing the inventory system.
|
|
3796
|
+
* @readonly
|
|
3797
|
+
*/
|
|
3798
|
+
inventoryItemId?: string;
|
|
3799
|
+
/** Discount deducted from the product's original price. */
|
|
3800
|
+
discount?: Discount;
|
|
3801
|
+
/**
|
|
3802
|
+
* A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
|
|
3803
|
+
* @readonly
|
|
3804
|
+
*/
|
|
3805
|
+
collectionIds?: string[];
|
|
3806
|
+
/**
|
|
3807
|
+
* Product variants, will be provided if the the request was sent with the includeVariants flag.
|
|
3808
|
+
* @readonly
|
|
3809
|
+
*/
|
|
3810
|
+
variants?: Variant[];
|
|
3811
|
+
/**
|
|
3812
|
+
* Date and time the product was last updated.
|
|
3813
|
+
* @readonly
|
|
3814
|
+
*/
|
|
3815
|
+
lastUpdated?: Date;
|
|
3816
|
+
/**
|
|
3817
|
+
* Date and time the product was created.
|
|
3818
|
+
* @readonly
|
|
3819
|
+
*/
|
|
3820
|
+
_createdDate?: Date;
|
|
3821
|
+
/** Custom SEO data for the product. */
|
|
3822
|
+
seoData?: SeoSchema;
|
|
3823
|
+
/** Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out". */
|
|
3824
|
+
ribbon?: string | null;
|
|
3825
|
+
/** 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). */
|
|
3826
|
+
brand?: string | null;
|
|
3827
|
+
}
|
|
2962
3828
|
/**
|
|
2963
3829
|
* Deletes a product.
|
|
2964
3830
|
* @param _id - ID of the product to delete.
|
|
@@ -2968,6 +3834,16 @@ export interface UpdateProduct {
|
|
|
2968
3834
|
* @applicableIdentity APP
|
|
2969
3835
|
*/
|
|
2970
3836
|
export declare function deleteProduct(_id: string): Promise<void>;
|
|
3837
|
+
/**
|
|
3838
|
+
* Deletes a product.
|
|
3839
|
+
* @param _id - ID of the product to delete.
|
|
3840
|
+
* @public
|
|
3841
|
+
* @documentationMaturity preview
|
|
3842
|
+
* @requiredField _id
|
|
3843
|
+
* @permissionScope Manage Products
|
|
3844
|
+
* @applicableIdentity APP
|
|
3845
|
+
*/
|
|
3846
|
+
export declare function deleteProductPlatformized(_id: string): Promise<void>;
|
|
2971
3847
|
/**
|
|
2972
3848
|
* Updates variants of a specified product.
|
|
2973
3849
|
* @param _id - ID of the product with managed variants.
|
|
@@ -3292,6 +4168,25 @@ export interface GetProductOptions {
|
|
|
3292
4168
|
/** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
|
|
3293
4169
|
includeMerchantSpecificData?: boolean;
|
|
3294
4170
|
}
|
|
4171
|
+
/**
|
|
4172
|
+
* Retrieves a product with the provided ID.
|
|
4173
|
+
* @param _id - Requested product ID.
|
|
4174
|
+
* @public
|
|
4175
|
+
* @documentationMaturity preview
|
|
4176
|
+
* @requiredField _id
|
|
4177
|
+
* @permissionScope Manage Orders
|
|
4178
|
+
* @permissionScope Manage Products
|
|
4179
|
+
* @permissionScope Read Products
|
|
4180
|
+
* @applicableIdentity APP
|
|
4181
|
+
* @applicableIdentity MEMBER
|
|
4182
|
+
* @applicableIdentity VISITOR
|
|
4183
|
+
* @returns Requested product data.
|
|
4184
|
+
*/
|
|
4185
|
+
export declare function getProductPlatformized(_id: string, options?: GetProductPlatformizedOptions): Promise<Product & NonNullable<GetProductPlatformizedResponseNonNullableFields>['product']>;
|
|
4186
|
+
export interface GetProductPlatformizedOptions {
|
|
4187
|
+
/** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
|
|
4188
|
+
includeMerchantSpecificData?: boolean;
|
|
4189
|
+
}
|
|
3295
4190
|
/**
|
|
3296
4191
|
* Retrieves a collection with the provided slug.
|
|
3297
4192
|
* @param slug - Slug of the collection to retrieve.
|