@wix/auto_sdk_stores_products 1.0.21 → 1.0.23
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/index.d.ts +2 -2
- package/build/cjs/{stores-catalog-v1-product-products.universal-Css_EY8d.d.ts → index.typings.d.ts} +479 -1
- package/build/cjs/index.typings.js +1994 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +2 -2
- package/build/es/{stores-catalog-v1-product-products.universal-Css_EY8d.d.mts → index.typings.d.mts} +479 -1
- package/build/es/index.typings.mjs +1935 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2 -1
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/{stores-catalog-v1-product-products.universal-CgcdUR7z.d.ts → index.typings.d.ts} +479 -1
- package/build/internal/cjs/index.typings.js +1994 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2 -1
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/{stores-catalog-v1-product-products.universal-CgcdUR7z.d.mts → index.typings.d.mts} +479 -1
- package/build/internal/es/index.typings.mjs +1935 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2 -1
- package/package.json +3 -3
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
3
|
-
export {
|
|
2
|
+
import { Product, CreateProductResponse, UpdateProduct, UpdateProductResponse, VariantOverride, UpdateVariantsResponse, MediaDataForWrite, MediaAssignmentToChoice, Collection, CreateCollectionResponse, UpdateCollection, UpdateCollectionResponse, SetValue, BulkUpdateProductsResponse, AdjustValue, BulkAdjustProductPropertiesResponse, ProductsQueryBuilder, GetProductOptions, GetProductResponse, GetCollectionBySlugResponse, ProductOptionsAvailabilityResponse, QueryProductVariantsOptions, QueryProductVariantsResponse, PlatformQuery, QueryStoreVariantsResponse, GetStoreVariantResponse, ProductCollectionChangedEnvelope, ProductCollectionCreatedEnvelope, ProductCollectionDeletedEnvelope, ProductChangedEnvelope, ProductCreatedEnvelope, ProductDeletedEnvelope, ProductVariantsChangedEnvelope } from './index.typings.js';
|
|
3
|
+
export { AddProductMediaRequest, AddProductMediaResponse, AddProductMediaToChoicesRequest, AddProductMediaToChoicesResponse, AddProductsToCollectionRequest, AddProductsToCollectionResponse, AdditionalInfoSection, AdjustValueValueOneOf, AggregateProductsRequest, AggregateProductsResponse, AllowedProductsCountLimitExceededErrorData, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkAdjustProductPropertiesByFilterSyncRequest, BulkAdjustProductPropertiesByFilterSyncResponse, BulkAdjustProductPropertiesRequest, BulkDeleteProductsRequest, BulkDeleteProductsResponse, BulkProductResult, BulkQueryCustomFieldsRequest, BulkQueryCustomFieldsResponse, BulkRemoveCustomFieldsRequest, BulkRemoveCustomFieldsResponse, BulkSetCustomFieldsRequest, BulkSetCustomFieldsResponse, BulkUpdateProductsByFilterSyncRequest, BulkUpdateProductsByFilterSyncResponse, BulkUpdateProductsRequest, Choice, CollectionChanged, CollectionCreated, CollectionDeleted, CostAndProfitData, CreateCollectionRequest, CreateDigitalProductRequest, CreateDigitalProductResponse, CreateProductPlatformizedRequest, CreateProductPlatformizedResponse, CreateProductRequest, CursorPaging, Cursors, CustomFieldsContainer, CustomTextField, DeleteCollectionRequest, DeleteCollectionResponse, DeleteProductOptionsRequest, DeleteProductOptionsResponse, DeleteProductPlatformizedRequest, DeleteProductPlatformizedResponse, DeleteProductRequest, DeleteProductResponse, Discount, DiscountType, FileType, FocalPoint, FormattedPrice, GetCollectionBySlugRequest, GetCollectionRequest, GetCollectionResponse, GetProductPlatformizedRequest, GetProductPlatformizedResponse, GetProductRequest, GetProductsRequest, GetProductsResponse, GetStoreVariantRequest, IdentificationData, IdentificationDataIdOneOf, InventoryStatus, ItemMetadata, Keyword, MeasurementUnit, Media, MediaDataForWriteMediaSourceOneOf, MediaItem, MediaItemItemOneOf, MediaItemType, MediaItemUrlAndSize, MediaItemVideo, MessageEnvelope, NumericPropertyRange, OptionAndChoice, OptionType, PageUrl, Paging, PagingMetadata, PagingWithBigLimit, PercentageData, PlatformMedia, PlatformMediaMediaOneOf, PlatformPaging, PlatformPagingMetadata, PlatformQueryPagingMethodOneOf, PreorderInfo, PriceData, PricePerUnitData, ProductChanged, ProductCreated, ProductDeleted, ProductOption, ProductOptionsAvailabilityRequest, ProductType, ProductsQueryResult, PropertyAdjustmentData, PropertyAdjustmentDataByOneOf, Query, QueryCollectionsPlatformizedRequest, QueryCollectionsPlatformizedResponse, QueryCollectionsRequest, QueryCollectionsResponse, QueryCustomFieldsRequest, QueryCustomFieldsResponse, QueryProductVariantsRequest, QueryProductsPlatformizedRequest, QueryProductsPlatformizedResponse, QueryProductsRequest, QueryProductsResponse, QueryProductsWithBigPageLimitRequest, QueryStoreVariantsRequest, QueryStoreVariantsWithBigLimitRequest, QueryWithBigPageLimit, ReCloneStoreRequest, ReCloneStoreResponse, RemoveCustomFieldsRequest, RemoveCustomFieldsResponse, RemoveProductBrandRequest, RemoveProductBrandResponse, RemoveProductMediaFromChoicesRequest, RemoveProductMediaFromChoicesResponse, RemoveProductMediaRequest, RemoveProductMediaResponse, RemoveProductRibbonRequest, RemoveProductRibbonResponse, RemoveProductsFromCollectionRequest, RemoveProductsFromCollectionResponse, ResetAllVariantDataRequest, ResetAllVariantDataResponse, Ribbon, SecuredMedia, SeoSchema, SetCustomFieldsRequest, SetCustomFieldsResponse, SetValueValueOneOf, Settings, SortOrder, Sorting, Stock, StoreVariant, Tag, UnlimitedPlatformCursorPaging, UnlimitedPlatformPaging, UnlimitedPlatformQuery, UnlimitedPlatformQueryPagingMethodOneOf, UpdateCollectionRequest, UpdateProductPlatformizedRequest, UpdateProductPlatformizedResponse, UpdateProductRequest, UpdateVariantsRequest, V1CreateProductPlatformizedRequest, V1CreateProductPlatformizedResponse, V1DeleteProductPlatformizedRequest, V1DeleteProductPlatformizedResponse, V1UpdateProductPlatformizedRequest, V1UpdateProductPlatformizedResponse, Variant, VariantChanged, VariantData, VariantDataWithNoStock, VariantStock, VariantsChanged, Version, VideoResolution, WebhookIdentityType } from './index.typings.js';
|
|
4
4
|
|
|
5
5
|
declare function createProduct$1(httpClient: HttpClient): CreateProductSignature;
|
|
6
6
|
interface CreateProductSignature {
|
package/build/cjs/{stores-catalog-v1-product-products.universal-Css_EY8d.d.ts → index.typings.d.ts}
RENAMED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface Product {
|
|
2
4
|
/**
|
|
3
5
|
* Product ID (generated automatically by the catalog).
|
|
@@ -1924,30 +1926,224 @@ interface ProductCollectionChangedEnvelope {
|
|
|
1924
1926
|
data: CollectionChanged;
|
|
1925
1927
|
metadata: BaseEventMetadata;
|
|
1926
1928
|
}
|
|
1929
|
+
/**
|
|
1930
|
+
* Triggered when a collection is changed.
|
|
1931
|
+
* @permissionScope Manage Stores - all permissions
|
|
1932
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1933
|
+
* @permissionScope Manage Stores
|
|
1934
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1935
|
+
* @permissionScope Manage Products
|
|
1936
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
1937
|
+
* @permissionScope Read Stores - all read permissions
|
|
1938
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1939
|
+
* @permissionScope Read Products
|
|
1940
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
1941
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1942
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1943
|
+
* @permissionScope Manage Orders
|
|
1944
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
1945
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
1946
|
+
* @webhook
|
|
1947
|
+
* @eventType com.wix.ecommerce.catalog.api.v1.CollectionChanged
|
|
1948
|
+
* @serviceIdentifier wix.catalog.api.v1.CatalogReadApi
|
|
1949
|
+
* @slug collection_changed
|
|
1950
|
+
*/
|
|
1951
|
+
declare function onProductCollectionChanged(handler: (event: ProductCollectionChangedEnvelope) => void | Promise<void>): void;
|
|
1927
1952
|
interface ProductCollectionCreatedEnvelope {
|
|
1928
1953
|
data: CollectionCreated;
|
|
1929
1954
|
metadata: BaseEventMetadata;
|
|
1930
1955
|
}
|
|
1956
|
+
/**
|
|
1957
|
+
* Triggered when a collection is created.
|
|
1958
|
+
* @permissionScope Manage Stores - all permissions
|
|
1959
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1960
|
+
* @permissionScope Manage Stores
|
|
1961
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1962
|
+
* @permissionScope Manage Products
|
|
1963
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
1964
|
+
* @permissionScope Read Stores - all read permissions
|
|
1965
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1966
|
+
* @permissionScope Read Products
|
|
1967
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
1968
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1969
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1970
|
+
* @permissionScope Manage Orders
|
|
1971
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
1972
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
1973
|
+
* @webhook
|
|
1974
|
+
* @eventType com.wix.ecommerce.catalog.api.v1.CollectionCreated
|
|
1975
|
+
* @serviceIdentifier wix.catalog.api.v1.CatalogReadApi
|
|
1976
|
+
* @slug collection_created
|
|
1977
|
+
*/
|
|
1978
|
+
declare function onProductCollectionCreated(handler: (event: ProductCollectionCreatedEnvelope) => void | Promise<void>): void;
|
|
1931
1979
|
interface ProductCollectionDeletedEnvelope {
|
|
1932
1980
|
data: CollectionDeleted;
|
|
1933
1981
|
metadata: BaseEventMetadata;
|
|
1934
1982
|
}
|
|
1983
|
+
/**
|
|
1984
|
+
* Triggered when a collection is deleted.
|
|
1985
|
+
* @permissionScope Manage Stores - all permissions
|
|
1986
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1987
|
+
* @permissionScope Manage Stores
|
|
1988
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1989
|
+
* @permissionScope Manage Products
|
|
1990
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
1991
|
+
* @permissionScope Read Stores - all read permissions
|
|
1992
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1993
|
+
* @permissionScope Read Products
|
|
1994
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
1995
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1996
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1997
|
+
* @permissionScope Manage Orders
|
|
1998
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
1999
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2000
|
+
* @webhook
|
|
2001
|
+
* @eventType com.wix.ecommerce.catalog.api.v1.CollectionDeleted
|
|
2002
|
+
* @serviceIdentifier wix.catalog.api.v1.CatalogReadApi
|
|
2003
|
+
* @slug collection_deleted
|
|
2004
|
+
*/
|
|
2005
|
+
declare function onProductCollectionDeleted(handler: (event: ProductCollectionDeletedEnvelope) => void | Promise<void>): void;
|
|
1935
2006
|
interface ProductChangedEnvelope {
|
|
1936
2007
|
data: ProductChanged;
|
|
1937
2008
|
metadata: BaseEventMetadata;
|
|
1938
2009
|
}
|
|
2010
|
+
/**
|
|
2011
|
+
* Triggered when a product is changed.
|
|
2012
|
+
* @permissionScope Manage Stores - all permissions
|
|
2013
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2014
|
+
* @permissionScope Manage Stores
|
|
2015
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2016
|
+
* @permissionScope Manage Products
|
|
2017
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
2018
|
+
* @permissionScope Read Stores - all read permissions
|
|
2019
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
2020
|
+
* @permissionScope Read Products
|
|
2021
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
2022
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2023
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2024
|
+
* @permissionScope Manage Orders
|
|
2025
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
2026
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2027
|
+
* @webhook
|
|
2028
|
+
* @eventType com.wix.ecommerce.catalog.api.v1.ProductChanged
|
|
2029
|
+
* @serviceIdentifier wix.catalog.api.v1.CatalogReadApi
|
|
2030
|
+
* @slug product_changed
|
|
2031
|
+
*/
|
|
2032
|
+
declare function onProductChanged(handler: (event: ProductChangedEnvelope) => void | Promise<void>): void;
|
|
1939
2033
|
interface ProductCreatedEnvelope {
|
|
1940
2034
|
data: ProductCreated;
|
|
1941
2035
|
metadata: BaseEventMetadata;
|
|
1942
2036
|
}
|
|
2037
|
+
/**
|
|
2038
|
+
* Triggered when a product is created.
|
|
2039
|
+
* @permissionScope Manage Stores - all permissions
|
|
2040
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2041
|
+
* @permissionScope Manage Stores
|
|
2042
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2043
|
+
* @permissionScope Manage Products
|
|
2044
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
2045
|
+
* @permissionScope Read Stores - all read permissions
|
|
2046
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
2047
|
+
* @permissionScope Read Products
|
|
2048
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
2049
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2050
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2051
|
+
* @permissionScope Manage Orders
|
|
2052
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
2053
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2054
|
+
* @webhook
|
|
2055
|
+
* @eventType com.wix.ecommerce.catalog.api.v1.ProductCreated
|
|
2056
|
+
* @serviceIdentifier wix.catalog.api.v1.CatalogReadApi
|
|
2057
|
+
* @slug product_created
|
|
2058
|
+
*/
|
|
2059
|
+
declare function onProductCreated(handler: (event: ProductCreatedEnvelope) => void | Promise<void>): void;
|
|
1943
2060
|
interface ProductDeletedEnvelope {
|
|
1944
2061
|
data: ProductDeleted;
|
|
1945
2062
|
metadata: BaseEventMetadata;
|
|
1946
2063
|
}
|
|
2064
|
+
/**
|
|
2065
|
+
* Triggered when a product is deleted.
|
|
2066
|
+
* @permissionScope Manage Stores - all permissions
|
|
2067
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2068
|
+
* @permissionScope Manage Stores
|
|
2069
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2070
|
+
* @permissionScope Manage Products
|
|
2071
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
2072
|
+
* @permissionScope Read Stores - all read permissions
|
|
2073
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
2074
|
+
* @permissionScope Read Products
|
|
2075
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
2076
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2077
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2078
|
+
* @permissionScope Manage Orders
|
|
2079
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
2080
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2081
|
+
* @webhook
|
|
2082
|
+
* @eventType com.wix.ecommerce.catalog.api.v1.ProductDeleted
|
|
2083
|
+
* @serviceIdentifier wix.catalog.api.v1.CatalogReadApi
|
|
2084
|
+
* @slug product_deleted
|
|
2085
|
+
*/
|
|
2086
|
+
declare function onProductDeleted(handler: (event: ProductDeletedEnvelope) => void | Promise<void>): void;
|
|
1947
2087
|
interface ProductVariantsChangedEnvelope {
|
|
1948
2088
|
data: VariantsChanged;
|
|
1949
2089
|
metadata: BaseEventMetadata;
|
|
1950
2090
|
}
|
|
2091
|
+
/**
|
|
2092
|
+
* Triggered when a product variant is changed.
|
|
2093
|
+
* @permissionScope Manage Stores - all permissions
|
|
2094
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2095
|
+
* @permissionScope Manage Stores
|
|
2096
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2097
|
+
* @permissionScope Manage Products
|
|
2098
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
2099
|
+
* @permissionScope Read Stores - all read permissions
|
|
2100
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
2101
|
+
* @permissionScope Read Products
|
|
2102
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
2103
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2104
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2105
|
+
* @permissionScope Manage Orders
|
|
2106
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
2107
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2108
|
+
* @webhook
|
|
2109
|
+
* @eventType com.wix.ecommerce.catalog.api.v1.VariantsChanged
|
|
2110
|
+
* @serviceIdentifier wix.catalog.api.v1.CatalogReadApi
|
|
2111
|
+
* @slug variants_changed
|
|
2112
|
+
*/
|
|
2113
|
+
declare function onProductVariantsChanged(handler: (event: ProductVariantsChangedEnvelope) => void | Promise<void>): void;
|
|
2114
|
+
type ProductNonNullablePaths = `_id` | `slug` | `productType` | `weightRange.minValue` | `weightRange.maxValue` | `stock.trackInventory` | `stock.inStock` | `stock.inventoryStatus` | `price.currency` | `price.discountedPrice` | `price.formatted.price` | `price.formatted.discountedPrice` | `priceData.currency` | `priceData.discountedPrice` | `priceData.formatted.price` | `priceData.formatted.discountedPrice` | `convertedPriceData.currency` | `convertedPriceData.discountedPrice` | `convertedPriceData.formatted.price` | `convertedPriceData.formatted.discountedPrice` | `priceRange.minValue` | `priceRange.maxValue` | `costAndProfitData.formattedItemCost` | `costAndProfitData.profit` | `costAndProfitData.formattedProfit` | `costAndProfitData.profitMargin` | `costRange.minValue` | `costRange.maxValue` | `pricePerUnitData.totalQuantity` | `pricePerUnitData.totalMeasurementUnit` | `pricePerUnitData.baseQuantity` | `pricePerUnitData.baseMeasurementUnit` | `additionalInfoSections` | `additionalInfoSections.${number}.title` | `additionalInfoSections.${number}.description` | `ribbons` | `ribbons.${number}.text` | `media.mainMedia.image.url` | `media.mainMedia.image.width` | `media.mainMedia.image.height` | `media.mainMedia.video.files` | `media.mainMedia.video.stillFrameMediaId` | `media.mainMedia.mediaType` | `media.mainMedia.title` | `media.mainMedia._id` | `media.items` | `customTextFields` | `customTextFields.${number}.title` | `customTextFields.${number}.maxLength` | `customTextFields.${number}.mandatory` | `productOptions` | `productOptions.${number}.optionType` | `productOptions.${number}.name` | `productPageUrl.base` | `productPageUrl.path` | `numericId` | `inventoryItemId` | `discount.type` | `discount.value` | `collectionIds` | `variants` | `variants.${number}._id` | `variants.${number}.variant.priceData.currency` | `variants.${number}.variant.priceData.discountedPrice` | `variants.${number}.variant.priceData.formatted.price` | `variants.${number}.variant.priceData.formatted.discountedPrice` | `variants.${number}.variant.costAndProfitData.formattedItemCost` | `variants.${number}.variant.costAndProfitData.profit` | `variants.${number}.variant.costAndProfitData.formattedProfit` | `variants.${number}.variant.costAndProfitData.profitMargin` | `variants.${number}.variant.weight` | `variants.${number}.variant.sku` | `variants.${number}.variant.visible` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`;
|
|
2115
|
+
/**
|
|
2116
|
+
* Creates a new product.
|
|
2117
|
+
* @param product - Product information.
|
|
2118
|
+
* @public
|
|
2119
|
+
* @requiredField product
|
|
2120
|
+
* @requiredField product.costAndProfitData.itemCost
|
|
2121
|
+
* @requiredField product.name
|
|
2122
|
+
* @requiredField product.priceData
|
|
2123
|
+
* @requiredField product.priceData.price
|
|
2124
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2125
|
+
* @applicableIdentity APP
|
|
2126
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.CreateProduct
|
|
2127
|
+
*/
|
|
2128
|
+
declare function createProduct(product: NonNullablePaths<Product, `costAndProfitData.itemCost` | `name` | `priceData` | `priceData.price`>): Promise<NonNullablePaths<CreateProductResponse, {
|
|
2129
|
+
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
2130
|
+
}[ProductNonNullablePaths]>>;
|
|
2131
|
+
/**
|
|
2132
|
+
* Updates specified fields in a product.
|
|
2133
|
+
*
|
|
2134
|
+
* To update a single field across multiple products, use [Bulk Update Product Property](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/bulk-update-product-property).
|
|
2135
|
+
* @param _id - Product ID (generated automatically by the catalog).
|
|
2136
|
+
* @public
|
|
2137
|
+
* @requiredField _id
|
|
2138
|
+
* @requiredField product
|
|
2139
|
+
* @param product - Product info to update.
|
|
2140
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2141
|
+
* @applicableIdentity APP
|
|
2142
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.UpdateProduct
|
|
2143
|
+
*/
|
|
2144
|
+
declare function updateProduct(_id: string, product: UpdateProduct): Promise<NonNullablePaths<UpdateProductResponse, {
|
|
2145
|
+
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
2146
|
+
}[ProductNonNullablePaths]>>;
|
|
1951
2147
|
interface UpdateProduct {
|
|
1952
2148
|
/**
|
|
1953
2149
|
* Product ID (generated automatically by the catalog).
|
|
@@ -2104,6 +2300,163 @@ interface UpdateProduct {
|
|
|
2104
2300
|
*/
|
|
2105
2301
|
brand?: string | null;
|
|
2106
2302
|
}
|
|
2303
|
+
/**
|
|
2304
|
+
* Deletes a product.
|
|
2305
|
+
* @param _id - ID of the product to delete.
|
|
2306
|
+
* @public
|
|
2307
|
+
* @requiredField _id
|
|
2308
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2309
|
+
* @applicableIdentity APP
|
|
2310
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.DeleteProduct
|
|
2311
|
+
*/
|
|
2312
|
+
declare function deleteProduct(_id: string): Promise<void>;
|
|
2313
|
+
/**
|
|
2314
|
+
* Updates variants of a specified product.
|
|
2315
|
+
* @param _id - ID of the product with managed variants.
|
|
2316
|
+
* @param variants - Variant info to update.
|
|
2317
|
+
* @public
|
|
2318
|
+
* @requiredField _id
|
|
2319
|
+
* @requiredField variants
|
|
2320
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2321
|
+
* @applicableIdentity APP
|
|
2322
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.UpdateVariants
|
|
2323
|
+
*/
|
|
2324
|
+
declare function updateProductVariants(_id: string, variants: VariantOverride[]): Promise<NonNullablePaths<UpdateVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variant.priceData.currency` | `variants.${number}.variant.priceData.discountedPrice` | `variants.${number}.variant.priceData.formatted.price` | `variants.${number}.variant.priceData.formatted.discountedPrice` | `variants.${number}.variant.costAndProfitData.formattedItemCost` | `variants.${number}.variant.costAndProfitData.profit` | `variants.${number}.variant.costAndProfitData.formattedProfit` | `variants.${number}.variant.costAndProfitData.profitMargin` | `variants.${number}.variant.weight` | `variants.${number}.variant.sku` | `variants.${number}.variant.visible` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock`>>;
|
|
2325
|
+
/**
|
|
2326
|
+
* Resets the data (such as the price and the weight) of all variants for a given product to their default values.
|
|
2327
|
+
* @param _id - Product ID.
|
|
2328
|
+
* @public
|
|
2329
|
+
* @requiredField _id
|
|
2330
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2331
|
+
* @applicableIdentity APP
|
|
2332
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.ResetAllVariantData
|
|
2333
|
+
*/
|
|
2334
|
+
declare function resetAllProductVariantData(_id: string): Promise<void>;
|
|
2335
|
+
/**
|
|
2336
|
+
* Adds products to a specified collection.
|
|
2337
|
+
* @param _id - Collection ID.
|
|
2338
|
+
* @param productIds - IDs of the products to add to the collection, separated by commas.
|
|
2339
|
+
* @public
|
|
2340
|
+
* @requiredField _id
|
|
2341
|
+
* @requiredField productIds
|
|
2342
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2343
|
+
* @applicableIdentity APP
|
|
2344
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.AddProductsToCollection
|
|
2345
|
+
*/
|
|
2346
|
+
declare function addProductsToCollection(_id: string, productIds: string[]): Promise<void>;
|
|
2347
|
+
/**
|
|
2348
|
+
* Deletes products from a specified collection.
|
|
2349
|
+
* @param _id - ID of the collection from which to remove products.
|
|
2350
|
+
* @param productIds - IDs of the products to remove from the collection.
|
|
2351
|
+
* @public
|
|
2352
|
+
* @requiredField _id
|
|
2353
|
+
* @requiredField productIds
|
|
2354
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2355
|
+
* @applicableIdentity APP
|
|
2356
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveProductsFromCollection
|
|
2357
|
+
*/
|
|
2358
|
+
declare function removeProductsFromCollection(_id: string, productIds: string[]): Promise<void>;
|
|
2359
|
+
/**
|
|
2360
|
+
* Adds media items to a specified product, either via URL or existing media ID.
|
|
2361
|
+
*
|
|
2362
|
+
* > **NOTE:** The URL is not validated and no event is triggered to indicate if the media was added successfully.
|
|
2363
|
+
* @param _id - Product ID.
|
|
2364
|
+
* @param media - Sources of media items already uploaded to the Wix site.
|
|
2365
|
+
* @public
|
|
2366
|
+
* @requiredField _id
|
|
2367
|
+
* @requiredField media
|
|
2368
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2369
|
+
* @applicableIdentity APP
|
|
2370
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.AddProductMedia
|
|
2371
|
+
*/
|
|
2372
|
+
declare function addProductMedia(_id: string, media: MediaDataForWrite[]): Promise<void>;
|
|
2373
|
+
/**
|
|
2374
|
+
* Removes specified media items from a product.
|
|
2375
|
+
* Pass an empty array to remove all media items.
|
|
2376
|
+
* @param _id - Product ID.
|
|
2377
|
+
* @param mediaIds - List of media IDs to remove. Pass an empty array to delete all media items for the product.
|
|
2378
|
+
* @public
|
|
2379
|
+
* @requiredField _id
|
|
2380
|
+
* @requiredField mediaIds
|
|
2381
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2382
|
+
* @applicableIdentity APP
|
|
2383
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveProductMedia
|
|
2384
|
+
*/
|
|
2385
|
+
declare function removeProductMedia(_id: string, mediaIds: string[]): Promise<void>;
|
|
2386
|
+
/**
|
|
2387
|
+
* Links media items that are already associated with a specific product to a choice within the same product.
|
|
2388
|
+
*
|
|
2389
|
+
* Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).
|
|
2390
|
+
*
|
|
2391
|
+
* To remove all existing media items, call the [Remove Product Media From Choices](https://dev.wix.com/api/rest/wix-stores/catalog/products/remove-product-media-from-choices) endpoint.
|
|
2392
|
+
* @param _id - Product ID.
|
|
2393
|
+
* @param media - Product media items and the choices to add the media to.
|
|
2394
|
+
* @public
|
|
2395
|
+
* @requiredField _id
|
|
2396
|
+
* @requiredField media
|
|
2397
|
+
* @requiredField media.choice
|
|
2398
|
+
* @requiredField media.option
|
|
2399
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2400
|
+
* @applicableIdentity APP
|
|
2401
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.AddProductMediaToChoices
|
|
2402
|
+
*/
|
|
2403
|
+
declare function addProductMediaToChoices(_id: string, media: NonNullablePaths<MediaAssignmentToChoice, `choice` | `option`>[]): Promise<void>;
|
|
2404
|
+
/**
|
|
2405
|
+
* Removes media items from all or some of a product's choices.
|
|
2406
|
+
* (Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)
|
|
2407
|
+
* @param _id - Product ID from whose choices to remove media items.
|
|
2408
|
+
* @param media - Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.
|
|
2409
|
+
* @public
|
|
2410
|
+
* @requiredField _id
|
|
2411
|
+
* @requiredField media
|
|
2412
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2413
|
+
* @applicableIdentity APP
|
|
2414
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveProductMediaFromChoices
|
|
2415
|
+
*/
|
|
2416
|
+
declare function removeProductMediaFromChoices(_id: string, media: MediaAssignmentToChoice[]): Promise<void>;
|
|
2417
|
+
/**
|
|
2418
|
+
* Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.
|
|
2419
|
+
* @param _id - ID of the product with options to delete.
|
|
2420
|
+
* @public
|
|
2421
|
+
* @requiredField _id
|
|
2422
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2423
|
+
* @applicableIdentity APP
|
|
2424
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.DeleteProductOptions
|
|
2425
|
+
*/
|
|
2426
|
+
declare function deleteProductOptions(_id: string): Promise<void>;
|
|
2427
|
+
/**
|
|
2428
|
+
* Deletes a product's brand.
|
|
2429
|
+
* @param _id - Product ID.
|
|
2430
|
+
* @public
|
|
2431
|
+
* @requiredField _id
|
|
2432
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2433
|
+
* @applicableIdentity APP
|
|
2434
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveBrand
|
|
2435
|
+
*/
|
|
2436
|
+
declare function removeBrand(_id: string): Promise<void>;
|
|
2437
|
+
/**
|
|
2438
|
+
* Creates a new collection.
|
|
2439
|
+
* @param collection - Collection info.
|
|
2440
|
+
* @public
|
|
2441
|
+
* @requiredField collection
|
|
2442
|
+
* @requiredField collection.name
|
|
2443
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2444
|
+
* @applicableIdentity APP
|
|
2445
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.CreateCollection
|
|
2446
|
+
*/
|
|
2447
|
+
declare function createCollection(collection: NonNullablePaths<Collection, `name`>): Promise<NonNullablePaths<CreateCollectionResponse, `collection.media.mainMedia.image.url` | `collection.media.mainMedia.image.width` | `collection.media.mainMedia.image.height` | `collection.media.mainMedia.video.files` | `collection.media.mainMedia.video.stillFrameMediaId` | `collection.media.mainMedia.mediaType` | `collection.media.mainMedia.title` | `collection.media.mainMedia._id` | `collection.media.items` | `collection.numberOfProducts`>>;
|
|
2448
|
+
/**
|
|
2449
|
+
* Updates specified properties of a collection. To add products to a collection, call the [addProductsToCollection](#addproductstocollection) function.
|
|
2450
|
+
* @param _id - Collection ID (generated automatically by the catalog).
|
|
2451
|
+
* @public
|
|
2452
|
+
* @requiredField _id
|
|
2453
|
+
* @requiredField collection
|
|
2454
|
+
* @param collection - Collection info to update.
|
|
2455
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2456
|
+
* @applicableIdentity APP
|
|
2457
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.UpdateCollection
|
|
2458
|
+
*/
|
|
2459
|
+
declare function updateCollection(_id: string, collection: UpdateCollection): Promise<NonNullablePaths<UpdateCollectionResponse, `collection.media.mainMedia.image.url` | `collection.media.mainMedia.image.width` | `collection.media.mainMedia.image.height` | `collection.media.mainMedia.video.files` | `collection.media.mainMedia.video.stillFrameMediaId` | `collection.media.mainMedia.mediaType` | `collection.media.mainMedia.title` | `collection.media.mainMedia._id` | `collection.media.items` | `collection.numberOfProducts`>>;
|
|
2107
2460
|
interface UpdateCollection {
|
|
2108
2461
|
/**
|
|
2109
2462
|
* Collection ID (generated automatically by the catalog).
|
|
@@ -2142,6 +2495,60 @@ interface UpdateCollection {
|
|
|
2142
2495
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
2143
2496
|
visible?: boolean | null;
|
|
2144
2497
|
}
|
|
2498
|
+
/**
|
|
2499
|
+
* Deletes a collection.
|
|
2500
|
+
* @public
|
|
2501
|
+
* @requiredField _id
|
|
2502
|
+
* @param _id - ID of the collection to delete.
|
|
2503
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2504
|
+
* @applicableIdentity APP
|
|
2505
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.DeleteCollection
|
|
2506
|
+
*/
|
|
2507
|
+
declare function deleteCollection(_id: string): Promise<void>;
|
|
2508
|
+
/**
|
|
2509
|
+
* Deletes a product's ribbon.
|
|
2510
|
+
* @param _id - Product ID.
|
|
2511
|
+
* @public
|
|
2512
|
+
* @requiredField _id
|
|
2513
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2514
|
+
* @applicableIdentity APP
|
|
2515
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveRibbon
|
|
2516
|
+
*/
|
|
2517
|
+
declare function removeRibbon(_id: string): Promise<void>;
|
|
2518
|
+
/**
|
|
2519
|
+
* Updates a specified property for up to 100 products at a time.
|
|
2520
|
+
* @param ids - Product IDs.
|
|
2521
|
+
* @param set - Field to update.
|
|
2522
|
+
* @public
|
|
2523
|
+
* @requiredField ids
|
|
2524
|
+
* @requiredField set
|
|
2525
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2526
|
+
* @applicableIdentity APP
|
|
2527
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.BulkUpdateProducts
|
|
2528
|
+
*/
|
|
2529
|
+
declare function bulkUpdateProductsProperty(ids: string[], set: SetValue): Promise<NonNullablePaths<BulkUpdateProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
2530
|
+
/**
|
|
2531
|
+
* Adjusts a specified numerical property for up to 100 products at a time.
|
|
2532
|
+
* The property can be increased or decreased either by percentage or amount.
|
|
2533
|
+
* @param adjust - Numerical property to adjust.
|
|
2534
|
+
* @param ids - Product IDs.
|
|
2535
|
+
* @public
|
|
2536
|
+
* @requiredField adjust
|
|
2537
|
+
* @requiredField ids
|
|
2538
|
+
* @permissionId WIX_STORES.MODIFY_PRODUCTS
|
|
2539
|
+
* @applicableIdentity APP
|
|
2540
|
+
* @fqn wix.catalog.api.v1.CatalogWriteApi.BulkAdjustProductProperties
|
|
2541
|
+
*/
|
|
2542
|
+
declare function bulkAdjustProductProperty(adjust: AdjustValue, ids: string[]): Promise<NonNullablePaths<BulkAdjustProductPropertiesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
2543
|
+
/**
|
|
2544
|
+
* Returns a list of up to 100 products, given the provided paging, sorting and filtering.
|
|
2545
|
+
* @public
|
|
2546
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2547
|
+
* @applicableIdentity APP
|
|
2548
|
+
* @applicableIdentity VISITOR
|
|
2549
|
+
* @fqn wix.catalog.api.v1.CatalogReadApi.QueryProductsPlatformized
|
|
2550
|
+
*/
|
|
2551
|
+
declare function queryProducts(): ProductsQueryBuilder;
|
|
2145
2552
|
interface QueryOffsetResult {
|
|
2146
2553
|
currentPage: number | undefined;
|
|
2147
2554
|
totalPages: number | undefined;
|
|
@@ -2206,10 +2613,59 @@ interface ProductsQueryBuilder {
|
|
|
2206
2613
|
skip: (skip: number) => ProductsQueryBuilder;
|
|
2207
2614
|
find: () => Promise<ProductsQueryResult>;
|
|
2208
2615
|
}
|
|
2616
|
+
/**
|
|
2617
|
+
* Retrieves a product with the provided ID.
|
|
2618
|
+
* @param _id - Requested product ID.
|
|
2619
|
+
* @public
|
|
2620
|
+
* @requiredField _id
|
|
2621
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2622
|
+
* @applicableIdentity APP
|
|
2623
|
+
* @applicableIdentity VISITOR
|
|
2624
|
+
* @fqn wix.catalog.api.v1.CatalogReadApi.GetProduct
|
|
2625
|
+
*/
|
|
2626
|
+
declare function getProduct(_id: string, options?: GetProductOptions): Promise<NonNullablePaths<GetProductResponse, {
|
|
2627
|
+
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
2628
|
+
}[ProductNonNullablePaths]>>;
|
|
2209
2629
|
interface GetProductOptions {
|
|
2210
2630
|
/** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
|
|
2211
2631
|
includeMerchantSpecificData?: boolean;
|
|
2212
2632
|
}
|
|
2633
|
+
/**
|
|
2634
|
+
* Retrieves a collection with the provided slug.
|
|
2635
|
+
* @param slug - Slug of the collection to retrieve.
|
|
2636
|
+
* @public
|
|
2637
|
+
* @requiredField slug
|
|
2638
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2639
|
+
* @applicableIdentity APP
|
|
2640
|
+
* @applicableIdentity VISITOR
|
|
2641
|
+
* @fqn wix.catalog.api.v1.CatalogReadApi.GetCollectionBySlug
|
|
2642
|
+
*/
|
|
2643
|
+
declare function getCollectionBySlug(slug: string): Promise<NonNullablePaths<GetCollectionBySlugResponse, `collection.media.mainMedia.image.url` | `collection.media.mainMedia.image.width` | `collection.media.mainMedia.image.height` | `collection.media.mainMedia.video.files` | `collection.media.mainMedia.video.stillFrameMediaId` | `collection.media.mainMedia.mediaType` | `collection.media.mainMedia.title` | `collection.media.mainMedia._id` | `collection.media.items` | `collection.numberOfProducts`>>;
|
|
2644
|
+
/**
|
|
2645
|
+
* Gets the availability of relevant product variants based on the product ID and selections provided. See [Use Cases](https://dev.wix.com/api/rest/wix-stores/catalog/use-cases) for an example.
|
|
2646
|
+
* @param _id - Requested product ID.
|
|
2647
|
+
* @param options - Array containing the selected options. For example, `["color": "Blue", "size": "Large"]`.
|
|
2648
|
+
* @public
|
|
2649
|
+
* @requiredField _id
|
|
2650
|
+
* @requiredField options
|
|
2651
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2652
|
+
* @applicableIdentity APP
|
|
2653
|
+
* @applicableIdentity VISITOR
|
|
2654
|
+
* @fqn wix.catalog.api.v1.CatalogReadApi.ProductOptionsAvailability
|
|
2655
|
+
*/
|
|
2656
|
+
declare function getProductOptionsAvailability(_id: string, options: Record<string, string>): Promise<NonNullablePaths<ProductOptionsAvailabilityResponse, `selectedVariant.price.currency` | `selectedVariant.price.discountedPrice` | `selectedVariant.price.formatted.price` | `selectedVariant.price.formatted.discountedPrice` | `selectedVariant.sku` | `selectedVariant.inStock` | `selectedVariant.visible` | `media.mainMedia.image.url` | `media.mainMedia.image.width` | `media.mainMedia.image.height` | `media.mainMedia.video.files` | `media.mainMedia.video.stillFrameMediaId` | `media.mainMedia.mediaType` | `media.mainMedia.title` | `media.mainMedia._id` | `media.items` | `productOptions` | `productOptions.${number}.optionType` | `productOptions.${number}.name` | `availableForPurchase`>>;
|
|
2657
|
+
/**
|
|
2658
|
+
* Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs.
|
|
2659
|
+
* See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
|
|
2660
|
+
* @param _id - Requested product ID.
|
|
2661
|
+
* @public
|
|
2662
|
+
* @requiredField _id
|
|
2663
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2664
|
+
* @applicableIdentity APP
|
|
2665
|
+
* @applicableIdentity VISITOR
|
|
2666
|
+
* @fqn wix.catalog.api.v1.CatalogReadApi.QueryProductVariants
|
|
2667
|
+
*/
|
|
2668
|
+
declare function queryProductVariants(_id: string, options?: QueryProductVariantsOptions): Promise<NonNullablePaths<QueryProductVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variant.priceData.currency` | `variants.${number}.variant.priceData.discountedPrice` | `variants.${number}.variant.priceData.formatted.price` | `variants.${number}.variant.priceData.formatted.discountedPrice` | `variants.${number}.variant.costAndProfitData.formattedItemCost` | `variants.${number}.variant.costAndProfitData.profit` | `variants.${number}.variant.costAndProfitData.formattedProfit` | `variants.${number}.variant.costAndProfitData.profitMargin` | `variants.${number}.variant.weight` | `variants.${number}.variant.sku` | `variants.${number}.variant.visible` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `metadata.items` | `metadata.offset` | `totalResults`>>;
|
|
2213
2669
|
interface QueryProductVariantsOptions {
|
|
2214
2670
|
/**
|
|
2215
2671
|
* The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice).
|
|
@@ -2222,5 +2678,27 @@ interface QueryProductVariantsOptions {
|
|
|
2222
2678
|
/** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
|
|
2223
2679
|
includeMerchantSpecificData?: boolean;
|
|
2224
2680
|
}
|
|
2681
|
+
/**
|
|
2682
|
+
* Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
|
|
2683
|
+
* @param query - Query options.
|
|
2684
|
+
* @public
|
|
2685
|
+
* @requiredField query
|
|
2686
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2687
|
+
* @applicableIdentity APP
|
|
2688
|
+
* @applicableIdentity VISITOR
|
|
2689
|
+
* @fqn wix.catalog.api.v1.CatalogReadApi.QueryStoreVariants
|
|
2690
|
+
*/
|
|
2691
|
+
declare function queryStoreVariants(query: PlatformQuery): Promise<NonNullablePaths<QueryStoreVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variantId` | `variants.${number}.productId` | `variants.${number}.variantName` | `variants.${number}.productName` | `variants.${number}.managedVariant` | `variants.${number}.sku` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `variants.${number}.preorderInfo.enabled`>>;
|
|
2692
|
+
/**
|
|
2693
|
+
* Retrieves a store variant with the provided ID.
|
|
2694
|
+
* @param _id - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
|
|
2695
|
+
* @public
|
|
2696
|
+
* @requiredField _id
|
|
2697
|
+
* @permissionId WIX_STORES.READ_PRODUCTS
|
|
2698
|
+
* @applicableIdentity APP
|
|
2699
|
+
* @applicableIdentity VISITOR
|
|
2700
|
+
* @fqn wix.catalog.api.v1.CatalogReadApi.GetStoreVariant
|
|
2701
|
+
*/
|
|
2702
|
+
declare function getStoreVariant(_id: string): Promise<NonNullablePaths<GetStoreVariantResponse, `variant._id` | `variant.variantId` | `variant.productId` | `variant.variantName` | `variant.productName` | `variant.managedVariant` | `variant.sku` | `variant.stock.trackQuantity` | `variant.stock.inStock` | `variant.collectionIds` | `variant.preorderInfo.enabled`>>;
|
|
2225
2703
|
|
|
2226
|
-
export { type
|
|
2704
|
+
export { type AddProductMediaRequest, type AddProductMediaResponse, type AddProductMediaToChoicesRequest, type AddProductMediaToChoicesResponse, type AddProductsToCollectionRequest, type AddProductsToCollectionResponse, type AdditionalInfoSection, type AdjustValue, type AdjustValueValueOneOf, type AggregateProductsRequest, type AggregateProductsResponse, type AllowedProductsCountLimitExceededErrorData, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkAdjustProductPropertiesByFilterSyncRequest, type BulkAdjustProductPropertiesByFilterSyncResponse, type BulkAdjustProductPropertiesRequest, type BulkAdjustProductPropertiesResponse, type BulkDeleteProductsRequest, type BulkDeleteProductsResponse, type BulkProductResult, type BulkQueryCustomFieldsRequest, type BulkQueryCustomFieldsResponse, type BulkRemoveCustomFieldsRequest, type BulkRemoveCustomFieldsResponse, type BulkSetCustomFieldsRequest, type BulkSetCustomFieldsResponse, type BulkUpdateProductsByFilterSyncRequest, type BulkUpdateProductsByFilterSyncResponse, type BulkUpdateProductsRequest, type BulkUpdateProductsResponse, type Choice, type Collection, type CollectionChanged, type CollectionCreated, type CollectionDeleted, type CostAndProfitData, type CreateCollectionRequest, type CreateCollectionResponse, type CreateDigitalProductRequest, type CreateDigitalProductResponse, type CreateProductPlatformizedRequest, type CreateProductPlatformizedResponse, type CreateProductRequest, type CreateProductResponse, type CursorPaging, type Cursors, type CustomFieldsContainer, type CustomTextField, type DeleteCollectionRequest, type DeleteCollectionResponse, type DeleteProductOptionsRequest, type DeleteProductOptionsResponse, type DeleteProductPlatformizedRequest, type DeleteProductPlatformizedResponse, type DeleteProductRequest, type DeleteProductResponse, type Discount, DiscountType, type DiscountTypeWithLiterals, FileType, type FileTypeWithLiterals, type FocalPoint, type FormattedPrice, type GetCollectionBySlugRequest, type GetCollectionBySlugResponse, type GetCollectionRequest, type GetCollectionResponse, type GetProductOptions, type GetProductPlatformizedRequest, type GetProductPlatformizedResponse, type GetProductRequest, type GetProductResponse, type GetProductsRequest, type GetProductsResponse, type GetStoreVariantRequest, type GetStoreVariantResponse, type IdentificationData, type IdentificationDataIdOneOf, InventoryStatus, type InventoryStatusWithLiterals, type ItemMetadata, type Keyword, MeasurementUnit, type MeasurementUnitWithLiterals, type Media, type MediaAssignmentToChoice, type MediaDataForWrite, type MediaDataForWriteMediaSourceOneOf, type MediaItem, type MediaItemItemOneOf, MediaItemType, type MediaItemTypeWithLiterals, type MediaItemUrlAndSize, type MediaItemVideo, type MessageEnvelope, type NumericPropertyRange, type OptionAndChoice, OptionType, type OptionTypeWithLiterals, type PageUrl, type Paging, type PagingMetadata, type PagingWithBigLimit, type PercentageData, type PlatformMedia, type PlatformMediaMediaOneOf, type PlatformPaging, type PlatformPagingMetadata, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PreorderInfo, type PriceData, type PricePerUnitData, type Product, type ProductChanged, type ProductChangedEnvelope, type ProductCollectionChangedEnvelope, type ProductCollectionCreatedEnvelope, type ProductCollectionDeletedEnvelope, type ProductCreated, type ProductCreatedEnvelope, type ProductDeleted, type ProductDeletedEnvelope, type ProductOption, type ProductOptionsAvailabilityRequest, type ProductOptionsAvailabilityResponse, ProductType, type ProductTypeWithLiterals, type ProductVariantsChangedEnvelope, type ProductsQueryBuilder, type ProductsQueryResult, type PropertyAdjustmentData, type PropertyAdjustmentDataByOneOf, type Query, type QueryCollectionsPlatformizedRequest, type QueryCollectionsPlatformizedResponse, type QueryCollectionsRequest, type QueryCollectionsResponse, type QueryCustomFieldsRequest, type QueryCustomFieldsResponse, type QueryProductVariantsOptions, type QueryProductVariantsRequest, type QueryProductVariantsResponse, type QueryProductsPlatformizedRequest, type QueryProductsPlatformizedResponse, type QueryProductsRequest, type QueryProductsResponse, type QueryProductsWithBigPageLimitRequest, type QueryStoreVariantsRequest, type QueryStoreVariantsResponse, type QueryStoreVariantsWithBigLimitRequest, type QueryWithBigPageLimit, type ReCloneStoreRequest, type ReCloneStoreResponse, type RemoveCustomFieldsRequest, type RemoveCustomFieldsResponse, type RemoveProductBrandRequest, type RemoveProductBrandResponse, type RemoveProductMediaFromChoicesRequest, type RemoveProductMediaFromChoicesResponse, type RemoveProductMediaRequest, type RemoveProductMediaResponse, type RemoveProductRibbonRequest, type RemoveProductRibbonResponse, type RemoveProductsFromCollectionRequest, type RemoveProductsFromCollectionResponse, type ResetAllVariantDataRequest, type ResetAllVariantDataResponse, type Ribbon, type SecuredMedia, type SeoSchema, type SetCustomFieldsRequest, type SetCustomFieldsResponse, type SetValue, type SetValueValueOneOf, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, type Stock, type StoreVariant, type Tag, type UnlimitedPlatformCursorPaging, type UnlimitedPlatformPaging, type UnlimitedPlatformQuery, type UnlimitedPlatformQueryPagingMethodOneOf, type UpdateCollection, type UpdateCollectionRequest, type UpdateCollectionResponse, type UpdateProduct, type UpdateProductPlatformizedRequest, type UpdateProductPlatformizedResponse, type UpdateProductRequest, type UpdateProductResponse, type UpdateVariantsRequest, type UpdateVariantsResponse, type V1CreateProductPlatformizedRequest, type V1CreateProductPlatformizedResponse, type V1DeleteProductPlatformizedRequest, type V1DeleteProductPlatformizedResponse, type V1UpdateProductPlatformizedRequest, type V1UpdateProductPlatformizedResponse, type Variant, type VariantChanged, type VariantData, type VariantDataWithNoStock, type VariantOverride, type VariantStock, type VariantsChanged, Version, type VersionWithLiterals, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addProductMedia, addProductMediaToChoices, addProductsToCollection, bulkAdjustProductProperty, bulkUpdateProductsProperty, createCollection, createProduct, deleteCollection, deleteProduct, deleteProductOptions, getCollectionBySlug, getProduct, getProductOptionsAvailability, getStoreVariant, onProductChanged, onProductCollectionChanged, onProductCollectionCreated, onProductCollectionDeleted, onProductCreated, onProductDeleted, onProductVariantsChanged, queryProductVariants, queryProducts, queryStoreVariants, removeBrand, removeProductMedia, removeProductMediaFromChoices, removeProductsFromCollection, removeRibbon, resetAllProductVariantData, updateCollection, updateProduct, updateProductVariants };
|