@wix/stores 1.0.4 → 1.0.6

package/build/cjs/src/stores-catalog-v1-product.universal.d.ts

@@ -0,0 +1,1744 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Product {
+    /**
+     * Product ID (generated automatically by the catalog).
+     * @readonly
+     */
+    _id?: string;
+    /** Product name. */
+    name?: string | null;
+    /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
+    slug?: string;
+    /** Whether the product is visible to site visitors. */
+    visible?: boolean | null;
+    /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
+    productType?: ProductType;
+    /** Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */
+    description?: string | null;
+    /** Stock keeping unit (if variant management is enabled, SKUs will be set per variant, and this field will be empty). */
+    sku?: string | null;
+    /** Product weight (if variant management is enabled, weight will be set per variant, and this field will be empty). */
+    weight?: number | null;
+    /**
+     * Product weight range. The minimum and maximum weights of all the variants.
+     * @readonly
+     */
+    weightRange?: NumericPropertyRange;
+    /**
+     * Product inventory status (in future this will be writable via Inventory API).
+     * @readonly
+     */
+    stock?: Stock;
+    /**
+     * Deprecated (use `priceData` instead).
+     * @readonly
+     */
+    price?: PriceData;
+    /** Price data. */
+    priceData?: PriceData;
+    /**
+     * Price data, converted to the currency specified in request header.
+     * @readonly
+     */
+    convertedPriceData?: PriceData;
+    /**
+     * Product price range. The minimum and maximum prices of all the variants.
+     * @readonly
+     */
+    priceRange?: NumericPropertyRange;
+    /** Cost and profit data. */
+    costAndProfitData?: CostAndProfitData;
+    /**
+     * Product cost range. The minimum and maximum costs of all the variants.
+     * @readonly
+     */
+    costRange?: NumericPropertyRange;
+    /** Price per unit data. */
+    pricePerUnitData?: PricePerUnitData;
+    /**
+     * Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). Currently writable only from the UI.
+     * @readonly
+     */
+    additionalInfoSections?: AdditionalInfoSection[];
+    /**
+     * Deprecated (use `ribbon` instead).
+     * @readonly
+     */
+    ribbons?: Ribbon[];
+    /**
+     * 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).
+     * @readonly
+     */
+    media?: Media;
+    /**
+     * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
+     * @readonly
+     */
+    customTextFields?: CustomTextField[];
+    /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
+    manageVariants?: boolean | null;
+    /** Options (color, size, etc) for this product. */
+    productOptions?: ProductOption[];
+    /**
+     * Product page URL for this product (generated automatically by the server).
+     * @readonly
+     */
+    productPageUrl?: PageUrl;
+    /**
+     * Product’s unique numeric ID (assigned in ascending order).
+     * Primarily used for sorting and filtering when crawling all products.
+     * @readonly
+     */
+    numericId?: string;
+    /**
+     * Inventory item ID - ID referencing the inventory system.
+     * @readonly
+     */
+    inventoryItemId?: string;
+    /** Discount deducted from the product's original price. */
+    discount?: Discount;
+    /**
+     * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
+     * @readonly
+     */
+    collectionIds?: string[];
+    /**
+     * Product variants, will be provided if the the request was sent with the includeVariants flag.
+     * @readonly
+     */
+    variants?: Variant[];
+    /**
+     * Date and time the product was last updated.
+     * @readonly
+     */
+    lastUpdated?: Date;
+    /**
+     * Date and time the product was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /** Custom SEO data for the product. */
+    seoData?: SeoSchema;
+    /** Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out". */
+    ribbon?: string | null;
+    /** 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). */
+    brand?: string | null;
+}
+export declare enum ProductType {
+    unspecified_product_type = "unspecified_product_type",
+    physical = "physical",
+    digital = "digital"
+}
+export interface NumericPropertyRange {
+    /** Minimum value. */
+    minValue?: number;
+    /** Maximum value. */
+    maxValue?: number;
+}
+export interface Stock {
+    /** Whether inventory is being tracked */
+    trackInventory?: boolean;
+    /** Quantity currently left in inventory */
+    quantity?: number | null;
+    /**
+     * Whether the product is currently in stock (relevant only when tracking manually)
+     * Deprecated (use `inventoryStatus` instead)
+     */
+    inStock?: boolean;
+    /**
+     * The current status of the inventory
+     * + `IN_STOCK` - In stock
+     * + `OUT_OF_STOCK` - Not in stock
+     * + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock
+     */
+    inventoryStatus?: InventoryStatus;
+}
+export declare enum InventoryStatus {
+    IN_STOCK = "IN_STOCK",
+    OUT_OF_STOCK = "OUT_OF_STOCK",
+    PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
+}
+export interface PriceData {
+    /**
+     * Product price currency
+     * @readonly
+     */
+    currency?: string;
+    /** Product price */
+    price?: number | null;
+    /**
+     * Discounted product price (if no discounted price is set, the product price is returned)
+     * @readonly
+     */
+    discountedPrice?: number;
+    /**
+     * The product price and discounted price, formatted with the currency
+     * @readonly
+     */
+    formatted?: FormattedPrice;
+    /**
+     * Price per unit
+     * @readonly
+     */
+    pricePerUnit?: number | null;
+}
+export interface FormattedPrice {
+    /** Product price formatted with the currency */
+    price?: string;
+    /** Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned) */
+    discountedPrice?: string;
+    /**
+     * Price per unit
+     * @readonly
+     */
+    pricePerUnit?: string | null;
+}
+export interface CostAndProfitData {
+    /** Item cost. */
+    itemCost?: number | null;
+    /**
+     * Item cost formatted with currency symbol.
+     * @readonly
+     */
+    formattedItemCost?: string;
+    /**
+     * Profit. Calculated by reducing `cost` from `discounted_price`.
+     * @readonly
+     */
+    profit?: number;
+    /**
+     * Profit formatted with currency symbol.
+     * @readonly
+     */
+    formattedProfit?: string;
+    /**
+     * Profit Margin. Calculated by dividing `profit` by `discounted_price`.
+     * The result is rounded to 4 decimal places.
+     * @readonly
+     */
+    profitMargin?: number;
+}
+export interface PricePerUnitData {
+    /** Total quantity */
+    totalQuantity?: number;
+    /** Total measurement unit */
+    totalMeasurementUnit?: MeasurementUnit;
+    /** Base quantity */
+    baseQuantity?: number;
+    /** Base measurement unit */
+    baseMeasurementUnit?: MeasurementUnit;
+}
+export declare enum MeasurementUnit {
+    UNSPECIFIED = "UNSPECIFIED",
+    ML = "ML",
+    CL = "CL",
+    L = "L",
+    CBM = "CBM",
+    MG = "MG",
+    G = "G",
+    KG = "KG",
+    MM = "MM",
+    CM = "CM",
+    M = "M",
+    SQM = "SQM",
+    OZ = "OZ",
+    LB = "LB",
+    FLOZ = "FLOZ",
+    PT = "PT",
+    QT = "QT",
+    GAL = "GAL",
+    IN = "IN",
+    FT = "FT",
+    YD = "YD",
+    SQFT = "SQFT"
+}
+export interface AdditionalInfoSection {
+    /** Product info section title */
+    title?: string;
+    /** Product info section description */
+    description?: string;
+}
+export interface Ribbon {
+    /** Ribbon text */
+    text?: string;
+}
+export interface Media {
+    /** Primary media (image, video etc) associated with this product. */
+    mainMedia?: MediaItem;
+    /** Media (images, videos etc) associated with this product. */
+    items?: MediaItem[];
+}
+export interface MediaItem extends MediaItemItemOneOf {
+    /** Media item thumbnail details. */
+    thumbnail?: MediaItemUrlAndSize;
+    /** Media item type (image, video, etc.). */
+    mediaType?: MediaItemType;
+    /** Media item title. */
+    title?: string;
+    /** Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). */
+    _id?: string;
+    /** Image data (URL, size). */
+    image?: MediaItemUrlAndSize;
+    /** Video data (URL, size). */
+    video?: MediaItemVideo;
+}
+/** @oneof */
+export interface MediaItemItemOneOf {
+    /** Image data (URL, size). */
+    image?: MediaItemUrlAndSize;
+    /** Video data (URL, size). */
+    video?: MediaItemVideo;
+}
+export interface MediaItemUrlAndSize {
+    /** Media item URL. */
+    url?: string;
+    /** Media item width. */
+    width?: number;
+    /** Media item height. */
+    height?: number;
+    /** Media format (mp4, png, etc.). */
+    format?: string | null;
+    /** Alt text. This text will be shown in case the image is not available. */
+    altText?: string | null;
+}
+export declare enum MediaItemType {
+    unspecified_media_item_type = "unspecified_media_item_type",
+    image = "image",
+    video = "video",
+    audio = "audio",
+    document = "document",
+    zip = "zip"
+}
+export interface MediaItemVideo {
+    /** Data (URL, size) about each resolution for which this video is available. */
+    files?: MediaItemUrlAndSize[];
+    /** ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. */
+    stillFrameMediaId?: string;
+}
+export interface CustomTextField {
+    /** Text box title */
+    title?: string;
+    /** Text box input max length */
+    maxLength?: number;
+    /** Whether this text box is mandatory */
+    mandatory?: boolean;
+}
+export interface ProductOption {
+    /**
+     * Option type - color or other(drop down)
+     * @readonly
+     */
+    optionType?: OptionType;
+    /** Option name (e.g., color, size) */
+    name?: string;
+    /** Choices available for this option */
+    choices?: Choice[];
+}
+export declare enum OptionType {
+    unspecified_option_type = "unspecified_option_type",
+    drop_down = "drop_down",
+    color = "color"
+}
+export interface Choice {
+    /** Color hex value or choice name */
+    value?: string;
+    /** Choice name */
+    description?: string;
+    /**
+     * Media items (images, videos) associated with this choice
+     * @readonly
+     */
+    media?: Media;
+    /**
+     * Based on the customer’s choices, which (if any) variants that include the selected choices are in stock
+     * @readonly
+     */
+    inStock?: boolean;
+    /**
+     * Based on the customer’s choices, which (if any) variants that include the selected choices are visible
+     * @readonly
+     */
+    visible?: boolean;
+}
+export interface PageUrl {
+    /** Base URL. For premium sites, this is the domain. For free sites, this is the site URL (e.g mysite.wixsite.com/mysite). */
+    base?: string;
+    /** Path to the product page - e.g /product-page/a-product. */
+    path?: string;
+}
+export interface Discount {
+    /** Discount type: amount / percent */
+    type?: DiscountType;
+    /** Discount value */
+    value?: number;
+}
+export declare enum DiscountType {
+    UNDEFINED = "UNDEFINED",
+    /** No discount */
+    NONE = "NONE",
+    AMOUNT = "AMOUNT",
+    PERCENT = "PERCENT"
+}
+export interface Variant {
+    /** Requested Variant ID */
+    _id?: string;
+    /** Specific choices within a selection, as option-choice key-value pairs */
+    choices?: Record<string, string>;
+    variant?: VariantDataWithNoStock;
+    /**
+     * Variant inventory status.
+     * @readonly
+     */
+    stock?: VariantStock;
+}
+export interface VariantDataWithNoStock {
+    /** Variant price. */
+    priceData?: PriceData;
+    /**
+     * Variant price data, converted to currency requested in header.
+     * @readonly
+     */
+    convertedPriceData?: PriceData;
+    /** Cost and profit data. */
+    costAndProfitData?: CostAndProfitData;
+    /** Variant weight. */
+    weight?: number;
+    /** Variant SKU (stock keeping unit). */
+    sku?: string;
+    /** Whether the variant is visible to customers. */
+    visible?: boolean;
+}
+export interface VariantStock {
+    /** Whether inventory is being tracked. */
+    trackQuantity?: boolean;
+    /** Quantity currently left in inventory. */
+    quantity?: number | null;
+    /** Whether the product is currently in stock (relevant only when tracking manually). */
+    inStock?: boolean;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tags information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Tag {
+    /** SEO tag type. Supported values: `title`, `meta`, `script`, `link`. */
+    type?: string;
+    /** SEO tag attributes/properties (name, content, rel, href). */
+    props?: Record<string, any> | null;
+    /** Tag meta data, e.g. {height: 300, width: 240}. */
+    meta?: Record<string, any> | null;
+    /** Tag inner content e.g. `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /** disable auto creation of 301 redirects on slug changes (enabled by default). */
+    preventAutoRedirect?: boolean;
+}
+export interface CreateProductRequest {
+    /** Product information. */
+    product?: Product;
+}
+export interface CreateProductResponse {
+    product?: Product;
+}
+export interface UpdateProductRequest {
+    product: Product;
+}
+export interface UpdateProductResponse {
+    product?: Product;
+}
+export interface DeleteProductRequest {
+    /** ID of the product to be deleted. */
+    _id: string;
+}
+export interface DeleteProductResponse {
+}
+export interface BulkDeleteProductsRequest {
+    /** IDs of the products to be deleted. */
+    ids?: string[];
+}
+export interface BulkDeleteProductsResponse {
+}
+export interface UpdateVariantsRequest {
+    /** ID of the product with managed variants. */
+    _id: string;
+    variants?: VariantOverride[];
+}
+export interface VariantOverride {
+    /** The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice). You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (Not relevant when passing variant IDs) */
+    choices?: Record<string, string>;
+    /**
+     * List of variant IDs
+     * (Not relevant when passing choices)
+     */
+    variantIds?: string[];
+    /** Variant price */
+    price?: number | null;
+    /** Variant cost of goods */
+    cost?: number | null;
+    /** Variant weight */
+    weight?: number | null;
+    /** Variant SKU (stock keeping unit) */
+    sku?: string | null;
+    /** Whether the variant is visible to  customers */
+    visible?: boolean | null;
+}
+export interface UpdateVariantsResponse {
+    /** List of the product's variants. */
+    variants?: Variant[];
+}
+export interface ResetAllVariantDataRequest {
+    /** Product ID. */
+    _id: string;
+}
+export interface ResetAllVariantDataResponse {
+}
+export interface AddProductsToCollectionRequest {
+    /** Collection ID. */
+    _id: string;
+    /** IDs of the products to add to the collection. */
+    productIds?: string[];
+}
+export interface AddProductsToCollectionResponse {
+}
+export interface RemoveProductsFromCollectionRequest {
+    /** Collection ID. */
+    _id: string;
+    /** IDs of the products that will be deleted from the collection. */
+    productIds: string[];
+}
+export interface RemoveProductsFromCollectionResponse {
+}
+export interface AddProductMediaRequest {
+    /** Product ID. */
+    _id: string;
+    media?: MediaDataForWrite[];
+}
+export interface MediaDataForWrite extends MediaDataForWriteMediaSourceOneOf {
+    /**
+     * Optional - assign this media item to a specific product choice.
+     * Note that you may set media items for choices under only one option (e.g., if Colors blue, green, and red have media items, Sizes S, M, and L can't have media items assigned to them).
+     * You may clear existing media from choices via the Remove Product Media From Choices endpoint
+     */
+    choice?: OptionAndChoice;
+    /** Media ID. For media items previously saved in Wix Media, the media ID is returned in the Query Product response. */
+    mediaId?: string;
+    /** Media external URL (for new media items). */
+    url?: string;
+}
+/** @oneof */
+export interface MediaDataForWriteMediaSourceOneOf {
+    /** Media ID. For media items previously saved in Wix Media, the media ID is returned in the Query Product response. */
+    mediaId?: string;
+    /** Media external URL (for new media items). */
+    url?: string;
+}
+export interface OptionAndChoice {
+    option?: string;
+    choice?: string;
+}
+export interface AddProductMediaResponse {
+}
+export interface RemoveProductMediaRequest {
+    /** Product ID. */
+    _id: string;
+    /** List of media IDs to remove. Pass an empty array to delete all media items for the product. */
+    mediaIds?: string[];
+}
+export interface RemoveProductMediaResponse {
+}
+export interface AddProductMediaToChoicesRequest {
+    /** Product ID. */
+    _id: string;
+    media?: MediaAssignmentToChoice[];
+}
+export interface MediaAssignmentToChoice {
+    /** Product option. For example, color or size. */
+    option?: string;
+    /** Choice within the option. For example, red or L. */
+    choice?: string;
+    /** Media IDs (available via the Query Product endpoint). */
+    mediaIds?: string[];
+}
+export interface AddProductMediaToChoicesResponse {
+}
+export interface RemoveProductMediaFromChoicesRequest {
+    /** Product ID. */
+    _id: string;
+    /** Optional - if an empty array is passed, all media will be removed from all choices. */
+    media?: MediaAssignmentToChoice[];
+}
+export interface RemoveProductMediaFromChoicesResponse {
+}
+export interface DeleteProductOptionsRequest {
+    /** Product ID. */
+    _id: string;
+}
+export interface DeleteProductOptionsResponse {
+}
+export interface SetCustomFieldsRequest {
+    /** Product ID. */
+    _id?: string;
+    /** Custom field that will be added, if a custom field with the same name already exists, the value of the custom field will be overridden. */
+    customFields?: Record<string, any>;
+}
+export interface SetCustomFieldsResponse {
+}
+export interface RemoveCustomFieldsRequest {
+    /** Product ID. */
+    _id?: string;
+    /** Custom fields to be removed (by name). */
+    names?: string[];
+}
+export interface RemoveCustomFieldsResponse {
+}
+export interface RemoveProductBrandRequest {
+    /** Product ID. */
+    _id: string;
+}
+export interface RemoveProductBrandResponse {
+}
+export interface BulkSetCustomFieldsRequest {
+    /** Filter string. */
+    filter?: string | null;
+    /** Custom field that will be added, if a custom field with same name already exists, the value of the custom field will be overridden. */
+    customFields?: Record<string, any>;
+}
+export interface BulkSetCustomFieldsResponse {
+}
+export interface BulkRemoveCustomFieldsRequest {
+    /** Filter string. */
+    filter?: string | null;
+    /** Custom fields names. */
+    names?: string[];
+}
+export interface BulkRemoveCustomFieldsResponse {
+}
+export interface CreateCollectionRequest {
+    /** Collection information. */
+    collection: Collection;
+}
+export interface Collection {
+    /**
+     * Collection ID (generated automatically by the catalog)
+     * @readonly
+     */
+    _id?: string | null;
+    /** Collection name */
+    name?: string | null;
+    /**
+     * Media items (images, videos etc) associated with this collection. Read only.
+     * @readonly
+     */
+    media?: Media;
+    /**
+     * Number of products in the collection. Read only.
+     * @readonly
+     */
+    numberOfProducts?: number;
+    /** Collection description. The description length without HTML must not exceed 2000 characters (10K includes HTML) */
+    description?: string | null;
+    /** Collection slug */
+    slug?: string | null;
+    /** Collection visibility. Only impacts dynamic pages, no impact on static pages */
+    visible?: boolean | null;
+}
+export interface CreateCollectionResponse {
+    collection?: Collection;
+}
+export interface UpdateCollectionRequest {
+    /** Collection information. */
+    collection: Collection;
+}
+export interface UpdateCollectionResponse {
+    collection?: Collection;
+}
+export interface DeleteCollectionRequest {
+    /** Collection ID. */
+    _id: string;
+}
+export interface DeleteCollectionResponse {
+}
+export interface RemoveProductRibbonRequest {
+    /** Product ID. */
+    _id: string;
+}
+export interface RemoveProductRibbonResponse {
+}
+export interface BulkUpdateProductsRequest {
+    /** Product IDs. */
+    ids: string[];
+    /** Field to update. */
+    set?: SetValue;
+}
+export interface SetValue extends SetValueValueOneOf {
+    /**
+     * Set product price.
+     * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
+     * variant prices will be calculated according to the set product price.
+     * If variant price is negative after setting new price, the update will fail.
+     */
+    price?: number;
+    /**
+     * Set product cost of goods.
+     * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
+     * cost of goods will be set per variant.
+     */
+    cost?: number;
+    /**
+     * Set 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.
+     */
+    weight?: number;
+    /** Set product ribbon. Pass empty string to remove existing ribbon. */
+    ribbon?: string;
+    /** Set product brand. Pass empty string to remove existing brand. */
+    brand?: string;
+}
+/** @oneof */
+export interface SetValueValueOneOf {
+    /**
+     * Set product price.
+     * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
+     * variant prices will be calculated according to the set product price.
+     * If variant price is negative after setting new price, the update will fail.
+     */
+    price?: number;
+    /**
+     * Set product cost of goods.
+     * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
+     * cost of goods will be set per variant.
+     */
+    cost?: number;
+    /**
+     * Set 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.
+     */
+    weight?: number;
+    /** Set product ribbon. Pass empty string to remove existing ribbon. */
+    ribbon?: string;
+    /** Set product brand. Pass empty string to remove existing brand. */
+    brand?: string;
+}
+export interface BulkUpdateProductsResponse {
+    /** Bulk action results. */
+    results?: BulkProductResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkProductResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    code?: string;
+    description?: string;
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface BulkUpdateProductsByFilterSyncRequest {
+    /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort). */
+    filter?: Record<string, any> | null;
+    /** The field to update. */
+    set?: SetValue;
+}
+export interface BulkUpdateProductsByFilterSyncResponse {
+    /** Items updated by bulk action. */
+    results?: BulkProductResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface AllowedProductsCountLimitExceededErrorData {
+    /** Total number of products */
+    totalCount?: number;
+}
+export interface BulkAdjustProductPropertiesRequest {
+    /** Product IDs. */
+    ids: string[];
+    /** Numerical property to adjust. */
+    adjust?: AdjustValue;
+}
+export interface AdjustValue extends AdjustValueValueOneOf {
+    /**
+     * Adjust product price.
+     * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
+     * variants prices will be calculated according to the adjusted price.
+     * If variant price is negative after the adjustment, the update will fail.
+     */
+    price?: PropertyAdjustmentData;
+    /**
+     * Adjust product cost of goods.
+     * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
+     * cost of goods will be adjusted per variant.
+     */
+    cost?: PropertyAdjustmentData;
+    /**
+     * Adjust 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 adjusted per variant.
+     */
+    weight?: PropertyAdjustmentData;
+}
+/** @oneof */
+export interface AdjustValueValueOneOf {
+    /**
+     * Adjust product price.
+     * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
+     * variants prices will be calculated according to the adjusted price.
+     * If variant price is negative after the adjustment, the update will fail.
+     */
+    price?: PropertyAdjustmentData;
+    /**
+     * Adjust product cost of goods.
+     * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
+     * cost of goods will be adjusted per variant.
+     */
+    cost?: PropertyAdjustmentData;
+    /**
+     * Adjust 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 adjusted per variant.
+     */
+    weight?: PropertyAdjustmentData;
+}
+export interface PropertyAdjustmentData extends PropertyAdjustmentDataByOneOf {
+    /** Adjust by percentage. */
+    percentage?: PercentageData;
+    /** Adjust by amount. */
+    amount?: number;
+}
+/** @oneof */
+export interface PropertyAdjustmentDataByOneOf {
+    /** Adjust by percentage. */
+    percentage?: PercentageData;
+    /** Adjust by amount. */
+    amount?: number;
+}
+export interface PercentageData {
+    /**
+     * If `true`, result will be rounded to the nearest whole number.
+     * If `false`, result will be rounded to 2 places after the decimal point.
+     */
+    roundToInt?: boolean;
+    /**
+     * Percentage value, as a whole number (integer) between -100 and 1000.
+     * For example, pass 100 to increase value by 100% (multiply original value by 2).
+     */
+    rate?: number;
+}
+export interface BulkAdjustProductPropertiesResponse {
+    /** Bulk action results. */
+    results?: BulkProductResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkAdjustProductPropertiesByFilterSyncRequest {
+    /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort). */
+    filter?: Record<string, any> | null;
+    /** Numerical property to adjust. */
+    adjust?: AdjustValue;
+}
+export interface BulkAdjustProductPropertiesByFilterSyncResponse {
+    /** Items updated by bulk action. */
+    results?: BulkProductResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ProductCreated {
+    /** Product ID (generated automatically by the catalog). */
+    productId?: string;
+    /** Product name. */
+    name?: string;
+    /** Product price. */
+    price?: PriceData;
+    /** Whether the product is visible to customers. */
+    visible?: boolean;
+    /** Media items (images, videos, etc.) associated with this product. */
+    media?: Media;
+    /** Product stock keeping unit (SKU). If variants are being managed, this will be empty. */
+    sku?: string;
+    /** Product page URL for this product (generated automatically by the server). */
+    productPageUrl?: PageUrl;
+    /** Product brand. */
+    brand?: string | null;
+    /** Cost and profit data */
+    costAndProfitData?: CostAndProfitData;
+}
+export interface ProductChanged {
+    /** Product ID. */
+    productId?: string;
+    /** List of product fields that were changed. */
+    changedFields?: string[];
+}
+export interface ProductDeleted {
+    /** ID of the product that was deleted. */
+    productId?: string;
+}
+export interface CollectionCreated {
+    /** Collection ID (generated automatically by the catalog). */
+    collectionId?: string;
+    /** Collection name. */
+    name?: string;
+    /** Media items (images, videos, etc.) associated with this collection. */
+    media?: Media;
+    /** Collection slug */
+    slug?: string;
+    /** Collection visible status */
+    visible?: boolean;
+}
+export interface CollectionChanged {
+    /** Collection ID (generated automatically by the catalog). */
+    collectionId?: string;
+    /** List of collection fields that were changed. */
+    changedFields?: string[];
+}
+export interface CollectionDeleted {
+    /** ID of the collection that was deleted. */
+    collectionId?: string;
+}
+export interface VariantsChanged {
+    /** Product ID. */
+    productId?: string;
+    /** List of variants that were changed. */
+    variants?: VariantChanged[];
+}
+export interface VariantChanged {
+    /** Variant ID. */
+    variantId?: string;
+    choices?: Record<string, string>;
+    /** List of variant fields that were changed. */
+    changedFields?: string[];
+}
+export interface QueryProductsRequest {
+    query?: Query;
+    /** Whether variants should be included in the response. */
+    includeVariants?: boolean;
+    /** Whether hidden products should be included in the response. Requires permissions to manage products. */
+    includeHiddenProducts?: boolean;
+    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean;
+}
+export interface Query {
+    paging?: Paging;
+    /** Filter string */
+    filter?: string | null;
+    /** Sort string */
+    sort?: string | null;
+}
+export interface Paging {
+    /** Amount of items to load per page */
+    limit?: number | null;
+    /** Number of items to skip in the display (relevant for all pages after the first) */
+    offset?: number | null;
+}
+export interface QueryProductsResponse {
+    products?: Product[];
+    metadata?: PagingMetadata;
+    totalResults?: number;
+}
+export interface PagingMetadata {
+    /** Amount of items to load per page */
+    items?: number;
+    /** Number of items to skip in the display (relevant for all pages after the first) */
+    offset?: number;
+}
+export interface QueryProductsPlatformizedRequest {
+    query?: PlatformQuery;
+}
+export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+    /** Filter object. */
+    filter?: Record<string, any> | null;
+    /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
+    sort?: Sorting[];
+    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
+    paging?: PlatformPaging;
+    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+/** @oneof */
+export interface PlatformQueryPagingMethodOneOf {
+    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
+    paging?: PlatformPaging;
+    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface PlatformPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryProductsPlatformizedResponse {
+    products?: Product[];
+    metadata?: PlatformPagingMetadata;
+}
+export interface PlatformPagingMetadata {
+    /** The number of items returned in this response. */
+    count?: number | null;
+    /** The offset which was requested. Returned if offset paging was used. */
+    offset?: number | null;
+    /** The total number of items that match the query. Returned if offset paging was used. */
+    total?: number | null;
+    /** Cursors to navigate through result pages. Returned if cursor paging was used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface QueryProductsWithBigPageLimitRequest {
+    query?: QueryWithBigPageLimit;
+    /** Whether variants should be included in the response. */
+    includeVariants?: boolean;
+    /** Whether hidden products should be included in the response. Requires permissions to manage products. */
+    includeHiddenProducts?: boolean;
+    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean;
+}
+export interface QueryWithBigPageLimit {
+    paging?: PagingWithBigLimit;
+    /** Filter string */
+    filter?: string | null;
+    /** Sort string */
+    sort?: string | null;
+}
+export interface PagingWithBigLimit {
+    /** Amount of items to load per page */
+    limit?: number | null;
+    /** Number of items to skip in the display (relevant for all pages after the first) */
+    offset?: number | null;
+}
+export interface GetProductsRequest {
+    /** Requested product IDs. */
+    ids?: string[];
+}
+export interface GetProductsResponse {
+    products?: Product[];
+}
+export interface GetProductRequest {
+    /** Requested product ID. */
+    _id: string;
+    /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean;
+}
+export interface GetProductResponse {
+    /** Requested product data. */
+    product?: Product;
+}
+export interface QueryCollectionsRequest {
+    query?: Query;
+    /** Whether number of products should be included in the response. */
+    includeNumberOfProducts?: boolean;
+    /** Include description in response. When False, description will be null */
+    includeDescription?: boolean;
+}
+export interface QueryCollectionsResponse {
+    collections?: Collection[];
+    metadata?: PagingMetadata;
+    totalResults?: number;
+}
+export interface QueryCollectionsPlatformizedRequest {
+    query?: PlatformQuery;
+}
+export interface QueryCollectionsPlatformizedResponse {
+    collections?: Collection[];
+    metadata?: PlatformPagingMetadata;
+}
+export interface GetCollectionRequest {
+    /** Requested collection ID. */
+    _id?: string;
+    /**
+     * Whether to return the `collection.numberOfProducts` field in the response.
+     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
+     */
+    includeNumberOfProducts?: boolean;
+    /** Include description in response. When False, description will be null */
+    includeDescription?: boolean;
+}
+export interface GetCollectionResponse {
+    collection?: Collection;
+}
+export interface GetCollectionBySlugRequest {
+    /** Slug with which to retrieve collection */
+    slug?: string;
+}
+export interface GetCollectionBySlugResponse {
+    collection?: Collection;
+}
+export interface ProductOptionsAvailabilityRequest {
+    /** Requested product ID. */
+    _id?: string;
+    /** Array containing the selected options (e.g, color: Blue, size: Large). */
+    options?: Record<string, string>;
+}
+export interface ProductOptionsAvailabilityResponse {
+    /** Variant information, given that all the choices were provided. */
+    selectedVariant?: VariantData;
+    /** Information about media items (images, videos, etc.) associated with this choice. */
+    media?: Media;
+    /** Options information (color, size, etc.) for this product, with the inventory and visibility fields updated based on the provided choices. */
+    productOptions?: ProductOption[];
+    /** Whether all the selected choices result in a visible, in-stock variant. */
+    availableForPurchase?: boolean;
+}
+export interface VariantData {
+    /** Variant price. */
+    price?: PriceData;
+    /**
+     * Variant price data converted to currency provided in header.
+     * @readonly
+     */
+    convertedPriceData?: PriceData;
+    /** Variant weight. */
+    weight?: number | null;
+    /** Variant SKU (stock keeping unit). */
+    sku?: string;
+    /** Quantity currently in inventory (relevant only when tracking by inventory). */
+    quantity?: number | null;
+    /** Whether the product is currently in stock (relevant only when tracking manually). */
+    inStock?: boolean;
+    /** Whether the variant is visible to customers. */
+    visible?: boolean;
+}
+export interface QueryProductVariantsRequest {
+    /** Requested product ID. */
+    _id?: string;
+    /**
+     * The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice).
+     * You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (not relevant when passing variant IDs).
+     */
+    choices?: Record<string, string>;
+    /** List of variant IDs (not relevant when passing choices). */
+    variantIds?: string[];
+    paging?: Paging;
+    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean;
+}
+export interface QueryProductVariantsResponse {
+    /** List of variants based on the specified filters and sorting. */
+    variants?: Variant[];
+    metadata?: PagingMetadata;
+    totalResults?: number;
+}
+export interface QueryStoreVariantsRequest {
+    /** Query options. */
+    query?: PlatformQuery;
+}
+export interface QueryStoreVariantsResponse {
+    /** List of variants based on the specified filters and sorting. */
+    variants?: StoreVariant[];
+    /** Details on the paged set of results returned. */
+    metadata?: PlatformPagingMetadata;
+}
+export interface StoreVariant {
+    /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen: {productId}.{variantId}. */
+    _id?: string;
+    /** Variant ID. */
+    variantId?: string;
+    /** Product ID. */
+    productId?: string;
+    /** Variant name. */
+    variantName?: string;
+    /** Product name. */
+    productName?: string;
+    /** Whether the variant is managed or represents a product. */
+    managedVariant?: boolean;
+    /** Variant SKU (stock keeping unit). */
+    sku?: string;
+    /** Variant inventory status. */
+    stock?: VariantStock;
+    /** The selected options of this variant. For example, `{"Color": "Blue", "Size": "Large"}`. */
+    choices?: Record<string, string>;
+    /** Collections that include this variant. */
+    collectionIds?: string[];
+    /**
+     * Media items (images, videos) associated with this variant.
+     * @readonly
+     */
+    media?: PlatformMedia;
+    /** preorder information. */
+    preorderInfo?: PreorderInfo;
+}
+export interface PlatformMedia extends PlatformMediaMediaOneOf {
+    image?: string;
+    video?: string;
+}
+/** @oneof */
+export interface PlatformMediaMediaOneOf {
+    image?: string;
+    video?: string;
+}
+export interface VideoResolution {
+    /** Video URL. */
+    url?: string;
+    /** Video height. */
+    height?: number;
+    /** Video width. */
+    width?: number;
+    /** Video format for example, mp4, hls. */
+    format?: string;
+}
+export interface PreorderInfo {
+    /** Whether the item is set to allow preordering. */
+    enabled?: boolean;
+    /** A message that buyer will see when the item is out of stock and preorder enabled */
+    message?: string | null;
+    /** Number of products that can be preordered after stock reaches zero. */
+    limit?: number | null;
+}
+export interface QueryStoreVariantsWithBigLimitRequest {
+    /** Query options. */
+    query?: UnlimitedPlatformQuery;
+}
+/**
+ * Don't use it unless you have to and know what you do. Prefer PlatformQuery other than this.
+ * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.
+ */
+export interface UnlimitedPlatformQuery extends UnlimitedPlatformQueryPagingMethodOneOf {
+    /** Filter object. */
+    filter?: Record<string, any> | null;
+    /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
+    sort?: Sorting[];
+    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
+    paging?: UnlimitedPlatformPaging;
+    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
+    cursorPaging?: UnlimitedPlatformCursorPaging;
+}
+/** @oneof */
+export interface UnlimitedPlatformQueryPagingMethodOneOf {
+    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
+    paging?: UnlimitedPlatformPaging;
+    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
+    cursorPaging?: UnlimitedPlatformCursorPaging;
+}
+/**
+ * Don't use it unless you have to and know what you do. Prefer PlatformPaging or wix.common.Paging other than this.
+ * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.
+ */
+export interface UnlimitedPlatformPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+/**
+ * Don't use it unless you have to and know what you do. Prefer PlatformCursorPaging or wix.common.CursorPaging other than this.
+ * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.
+ */
+export interface UnlimitedPlatformCursorPaging {
+    /**
+     * The number of items to load.
+     * Cursor token returned in the query response. To be used on the next query request, but not the first query request.
+     */
+    limit?: number | null;
+    /** Cursor returned in last query response. Should not be provided on first page request */
+    cursor?: string | null;
+}
+export interface GetStoreVariantRequest {
+    /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`. */
+    _id?: string;
+}
+export interface GetStoreVariantResponse {
+    /** The requested store variant. */
+    variant?: StoreVariant;
+}
+export interface QueryCustomFieldsRequest {
+    /** Requested product ID. */
+    _id?: string;
+    /** Requested field names. */
+    names?: string[];
+}
+export interface QueryCustomFieldsResponse {
+    customFields?: Record<string, any>;
+}
+export interface BulkQueryCustomFieldsRequest {
+    /** Filter string. */
+    query?: Query;
+    /** Requested field names. */
+    names?: string[];
+}
+export interface BulkQueryCustomFieldsResponse {
+    /** ProductId to Custom Fields Map packed in container. */
+    productIdToCustomFields?: Record<string, CustomFieldsContainer>;
+    metadata?: PagingMetadata;
+    totalResults?: number;
+}
+export interface CustomFieldsContainer {
+    customFields?: Record<string, any>;
+}
+export interface AggregateProductsRequest {
+    /** Filter applied to original data */
+    filter?: Record<string, any> | null;
+    /** This is an object defining aggregation itself */
+    aggregation?: Record<string, any> | null;
+    /** Whether hidden products should be considered. Requires permissions to manage products. */
+    includeHiddenProducts?: boolean;
+    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean;
+}
+export interface AggregateProductsResponse {
+    aggregates?: Record<string, any> | null;
+}
+/**
+ * Creates a new product.
+ * @public
+ * @requiredField options.product.costAndProfitData.itemCost
+ * @requiredField options.product.name
+ * @requiredField options.product.priceData
+ * @requiredField options.product.priceData.price
+ */
+export declare function createProduct(options?: CreateProductOptions): Promise<CreateProductResponse>;
+export interface CreateProductOptions {
+    /** Product information. */
+    product?: Product;
+}
+/**
+ * Updates specified fields in a product.
+ * @param _id - Product ID (generated automatically by the catalog).
+ * @public
+ * @requiredField _id
+ * @requiredField product
+ */
+export declare function updateProduct(_id: string, product: UpdateProduct): Promise<UpdateProductResponse>;
+export interface UpdateProduct {
+    /**
+     * Product ID (generated automatically by the catalog).
+     * @readonly
+     */
+    _id?: string;
+    /** Product name. */
+    name?: string | null;
+    /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
+    slug?: string;
+    /** Whether the product is visible to site visitors. */
+    visible?: boolean | null;
+    /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
+    productType?: ProductType;
+    /** Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */
+    description?: string | null;
+    /** Stock keeping unit (if variant management is enabled, SKUs will be set per variant, and this field will be empty). */
+    sku?: string | null;
+    /** Product weight (if variant management is enabled, weight will be set per variant, and this field will be empty). */
+    weight?: number | null;
+    /**
+     * Product weight range. The minimum and maximum weights of all the variants.
+     * @readonly
+     */
+    weightRange?: NumericPropertyRange;
+    /**
+     * Product inventory status (in future this will be writable via Inventory API).
+     * @readonly
+     */
+    stock?: Stock;
+    /**
+     * Deprecated (use `priceData` instead).
+     * @readonly
+     */
+    price?: PriceData;
+    /** Price data. */
+    priceData?: PriceData;
+    /**
+     * Price data, converted to the currency specified in request header.
+     * @readonly
+     */
+    convertedPriceData?: PriceData;
+    /**
+     * Product price range. The minimum and maximum prices of all the variants.
+     * @readonly
+     */
+    priceRange?: NumericPropertyRange;
+    /** Cost and profit data. */
+    costAndProfitData?: CostAndProfitData;
+    /**
+     * Product cost range. The minimum and maximum costs of all the variants.
+     * @readonly
+     */
+    costRange?: NumericPropertyRange;
+    /** Price per unit data. */
+    pricePerUnitData?: PricePerUnitData;
+    /**
+     * Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). Currently writable only from the UI.
+     * @readonly
+     */
+    additionalInfoSections?: AdditionalInfoSection[];
+    /**
+     * Deprecated (use `ribbon` instead).
+     * @readonly
+     */
+    ribbons?: Ribbon[];
+    /**
+     * 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).
+     * @readonly
+     */
+    media?: Media;
+    /**
+     * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
+     * @readonly
+     */
+    customTextFields?: CustomTextField[];
+    /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
+    manageVariants?: boolean | null;
+    /** Options (color, size, etc) for this product. */
+    productOptions?: ProductOption[];
+    /**
+     * Product page URL for this product (generated automatically by the server).
+     * @readonly
+     */
+    productPageUrl?: PageUrl;
+    /**
+     * Product’s unique numeric ID (assigned in ascending order).
+     * Primarily used for sorting and filtering when crawling all products.
+     * @readonly
+     */
+    numericId?: string;
+    /**
+     * Inventory item ID - ID referencing the inventory system.
+     * @readonly
+     */
+    inventoryItemId?: string;
+    /** Discount deducted from the product's original price. */
+    discount?: Discount;
+    /**
+     * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
+     * @readonly
+     */
+    collectionIds?: string[];
+    /**
+     * Product variants, will be provided if the the request was sent with the includeVariants flag.
+     * @readonly
+     */
+    variants?: Variant[];
+    /**
+     * Date and time the product was last updated.
+     * @readonly
+     */
+    lastUpdated?: Date;
+    /**
+     * Date and time the product was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /** Custom SEO data for the product. */
+    seoData?: SeoSchema;
+    /** Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out". */
+    ribbon?: string | null;
+    /** 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). */
+    brand?: string | null;
+}
+/**
+ * Deletes a product.
+ * @param _id - ID of the product to be deleted.
+ * @public
+ * @requiredField _id
+ */
+export declare function deleteProduct(_id: string): Promise<void>;
+/**
+ * Updates variants of a specified product.
+ * @param _id - ID of the product with managed variants.
+ * @public
+ * @requiredField _id
+ */
+export declare function updateVariants(_id: string, options?: UpdateVariantsOptions): Promise<UpdateVariantsResponse>;
+export interface UpdateVariantsOptions {
+    variants?: VariantOverride[];
+}
+/**
+ * Resets all variant information to default values (price = current product price; weight = current product weight; SKU = current product SKU; visibility = true).
+ * @param _id - Product ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function resetAllVariantData(_id: string): Promise<void>;
+/**
+ * Adds products to a specified collection.
+ * @param _id - Collection ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function addProductsToCollection(_id: string, options?: AddProductsToCollectionOptions): Promise<void>;
+export interface AddProductsToCollectionOptions {
+    /** IDs of the products to add to the collection. */
+    productIds?: string[];
+}
+/**
+ * Deletes products from a specified collection.
+ * @param _id - Collection ID.
+ * @param productIds - IDs of the products that will be deleted from the collection.
+ * @public
+ * @requiredField _id
+ * @requiredField productIds
+ */
+export declare function removeProductsFromCollection(_id: string, productIds: string[]): Promise<void>;
+/**
+ * Adds media items to a specified product, either via URL or existing media ID.
+ * @param _id - Product ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function addProductMedia(_id: string, options?: AddProductMediaOptions): Promise<void>;
+export interface AddProductMediaOptions {
+    media?: MediaDataForWrite[];
+}
+/**
+ * Removes specified media items from a product.
+ * Pass an empty array to remove all media items.
+ * @param _id - Product ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function removeProductMedia(_id: string, options?: RemoveProductMediaOptions): Promise<void>;
+export interface RemoveProductMediaOptions {
+    /** List of media IDs to remove. Pass an empty array to delete all media items for the product. */
+    mediaIds?: string[];
+}
+/**
+ * Links media items that are already associated with a specific product to a choice within the same product.
+ *
+ * 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).
+ *
+ * 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.
+ * @param _id - Product ID.
+ * @public
+ * @requiredField _id
+ * @requiredField options.media.choice
+ * @requiredField options.media.option
+ */
+export declare function addProductMediaToChoices(_id: string, options?: AddProductMediaToChoicesOptions): Promise<void>;
+export interface AddProductMediaToChoicesOptions {
+    media?: MediaAssignmentToChoice[];
+}
+/**
+ * Removes media items from all or some of a product's choices.
+ * (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).)
+ * @param _id - Product ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function removeProductMediaFromChoices(_id: string, options?: RemoveProductMediaFromChoicesOptions): Promise<void>;
+export interface RemoveProductMediaFromChoicesOptions {
+    /** Optional - if an empty array is passed, all media will be removed from all choices. */
+    media?: MediaAssignmentToChoice[];
+}
+/**
+ * Delete all options from a specific product (only available when variant management is disabled).
+ * @param _id - Product ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function deleteProductOptions(_id: string): Promise<void>;
+/**
+ * Deletes a product's brand.
+ * @param _id - Product ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function removeBrand(_id: string): Promise<void>;
+/**
+ * Creates a new collection.
+ * @param collection - Collection information.
+ * @public
+ * @requiredField collection
+ * @requiredField collection.name
+ */
+export declare function createCollection(collection: Collection): Promise<CreateCollectionResponse>;
+/**
+ * Updates specified properties of a collection.
+ * To add products to a collection, call the [Add Products to Collection](https://dev.wix.com/api/rest/wix-stores/catalog/collection/add-products-to-collection) endpoint.
+ * @param _id - Collection ID (generated automatically by the catalog)
+ * @public
+ * @requiredField _id
+ * @requiredField collection
+ */
+export declare function updateCollection(_id: string | null, collection: UpdateCollection): Promise<UpdateCollectionResponse>;
+export interface UpdateCollection {
+    /**
+     * Collection ID (generated automatically by the catalog)
+     * @readonly
+     */
+    _id?: string | null;
+    /** Collection name */
+    name?: string | null;
+    /**
+     * Media items (images, videos etc) associated with this collection. Read only.
+     * @readonly
+     */
+    media?: Media;
+    /**
+     * Number of products in the collection. Read only.
+     * @readonly
+     */
+    numberOfProducts?: number;
+    /** Collection description. The description length without HTML must not exceed 2000 characters (10K includes HTML) */
+    description?: string | null;
+    /** Collection slug */
+    slug?: string | null;
+    /** Collection visibility. Only impacts dynamic pages, no impact on static pages */
+    visible?: boolean | null;
+}
+/**
+ * Deletes a collection.
+ * @param _id - Collection ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function deleteCollection(_id: string): Promise<void>;
+/**
+ * Deletes a product's ribbon.
+ * @param _id - Product ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function removeRibbon(_id: string): Promise<void>;
+/**
+ * Updates a specified property for up to 100 products at a time.
+ * @param ids - Product IDs.
+ * @public
+ * @requiredField ids
+ */
+export declare function bulkUpdateProducts(ids: string[], options?: BulkUpdateProductsOptions): Promise<BulkUpdateProductsResponse>;
+export interface BulkUpdateProductsOptions {
+    /** Field to update. */
+    set?: SetValue;
+}
+/**
+ * Adjusts a specified numerical property for up to 100 products at a time.
+ * The property can be increased or decreased either by percentage or amount.
+ * @param ids - Product IDs.
+ * @public
+ * @requiredField ids
+ */
+export declare function bulkAdjustProductProperties(ids: string[], options?: BulkAdjustProductPropertiesOptions): Promise<BulkAdjustProductPropertiesResponse>;
+export interface BulkAdjustProductPropertiesOptions {
+    /** Numerical property to adjust. */
+    adjust?: AdjustValue;
+}
+/**
+ * Returns a list of up to 100 products, given the provided paging, sorting and filtering.
+ * @public */
+export declare function queryProducts(): ProductsQueryBuilder;
+interface QueryCursorResult {
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface ProductsQueryResult extends QueryCursorResult {
+    items: Product[];
+    query: ProductsQueryBuilder;
+    next: () => Promise<ProductsQueryResult>;
+    prev: () => Promise<ProductsQueryResult>;
+}
+export interface ProductsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    eq: (propertyName: string, value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ne: (propertyName: string, value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ge: (propertyName: string, value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    gt: (propertyName: string, value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    le: (propertyName: string, value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    lt: (propertyName: string, value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     */
+    startsWith: (propertyName: string, value: string) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     */
+    hasSome: (propertyName: string, value: any[]) => ProductsQueryBuilder;
+    in: (propertyName: string, value: any) => ProductsQueryBuilder;
+    exists: (propertyName: string, value: boolean) => ProductsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    ascending: (...propertyNames: string[]) => ProductsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    descending: (...propertyNames: string[]) => ProductsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
+    limit: (limit: number) => ProductsQueryBuilder;
+    find: () => Promise<ProductsQueryResult>;
+}
+/**
+ * Retrieves a product with the provided ID.
+ * @param _id - Requested product ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function getProduct(_id: string, options?: GetProductOptions): Promise<GetProductResponse>;
+export interface GetProductOptions {
+    /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean;
+}
+export {};