@wix/stores 1.0.59 → 1.0.61

package/build/cjs/src/{stores-catalog-v1-product-products.universal.d.ts → stores-catalog-v1-product.universal.d.ts}

@@ -528,7 +528,7 @@ export interface ResetAllVariantDataRequest {
 export interface ResetAllVariantDataResponse {
 }
 export interface AddProductsToCollectionRequest {
-    /** Collection ID. */
+    /** Collection ID. Cannot be used to add products to All Products */
     _id: string;
     /** IDs of the products to add to the collection. */
     productIds?: string[];
@@ -536,7 +536,7 @@ export interface AddProductsToCollectionRequest {
 export interface AddProductsToCollectionResponse {
 }
 export interface RemoveProductsFromCollectionRequest {
-    /** Collection ID. */
+    /** Collection ID. Cannot be used to remove products from All Products */
     _id: string;
     /** IDs of the products that will be deleted from the collection. */
     productIds: string[];
@@ -690,7 +690,7 @@ export interface UpdateCollectionResponse {
     collection?: Collection;
 }
 export interface DeleteCollectionRequest {
-    /** ID of the collection to delete. */
+    /** ID of the collection to delete. Cannot be used to delete All Products */
     _id: string;
 }
 export interface DeleteCollectionResponse {
@@ -1132,7 +1132,7 @@ export interface QueryCollectionsPlatformizedResponse {
 }
 export interface GetCollectionRequest {
     /** Requested collection ID. */
-    _id?: string;
+    _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.
@@ -1145,7 +1145,7 @@ export interface GetCollectionResponse {
 }
 export interface GetCollectionBySlugRequest {
     /** Slug of the collection to retrieve. */
-    slug?: string;
+    slug: string;
 }
 export interface GetCollectionBySlugResponse {
     /** The requested collection. */
@@ -1153,7 +1153,7 @@ export interface GetCollectionBySlugResponse {
 }
 export interface ProductOptionsAvailabilityRequest {
     /** Requested product ID. */
-    _id?: string;
+    _id: string;
     /** Array containing the selected options (e.g, color: Blue, size: Large). */
     options?: Record<string, string>;
 }
@@ -1188,7 +1188,7 @@ export interface VariantData {
 }
 export interface QueryProductVariantsRequest {
     /** Requested product ID. */
-    _id?: string;
+    _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).
@@ -1322,7 +1322,7 @@ export interface UnlimitedPlatformCursorPaging {
 }
 export interface GetStoreVariantRequest {
     /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`. */
-    _id?: string;
+    _id: string;
 }
 export interface GetStoreVariantResponse {
     /** The requested store variant. */
@@ -1365,6 +1365,355 @@ export interface AggregateProductsRequest {
 export interface AggregateProductsResponse {
     aggregates?: Record<string, any> | null;
 }
+/**
+ * Creates a new product.
+ * @public
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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.). */
+    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
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function resetAllVariantData(_id: string): Promise<void>;
+/**
+ * Adds products to a specified collection.
+ * @param _id - Collection ID. Cannot be used to add products to All Products
+ * @public
+ * @documentationMaturity preview
+ * @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. Cannot be used to remove products from All Products
+ * @param productIds - IDs of the products that will be deleted from the collection.
+ * @public
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function deleteProductOptions(_id: string): Promise<void>;
+/**
+ * Deletes a product's brand.
+ * @param _id - Product ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function removeBrand(_id: string): Promise<void>;
+/**
+ * Creates a new collection.
+ * @param collection - Collection info.
+ * @public
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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. */
+    description?: string | null;
+    /** Collection slug. */
+    slug?: string | null;
+    /** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
+    visible?: boolean | null;
+}
+/**
+ * Deletes a collection.
+ * @param _id - ID of the collection to delete. Cannot be used to delete All Products
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function deleteCollection(_id: string): Promise<void>;
+/**
+ * Deletes a product's ribbon.
+ * @param _id - Product ID.
+ * @public
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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
+ * @documentationMaturity preview
+ * @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
@@ -1462,4 +1811,93 @@ 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;
 }
+/**
+ * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
+ * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryCollections(options?: QueryCollectionsOptions): Promise<QueryCollectionsResponse>;
+export interface QueryCollectionsOptions {
+    /** Query options. */
+    query?: Query;
+    /** Whether number of products should be included in the response. */
+    includeNumberOfProducts?: boolean;
+    /** Wether to include collection description in the response. When `false` is passed, `collection.description` will return null. */
+    includeDescription?: boolean;
+}
+/**
+ * Retrieves a collection with the provided ID.
+ * @param _id - Requested collection ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function getCollection(_id: string, options?: GetCollectionOptions): Promise<GetCollectionResponse>;
+export interface GetCollectionOptions {
+    /**
+     * 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;
+}
+/**
+ * Retrieves a collection with the provided slug.
+ * @param slug - Slug of the collection to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField slug
+ */
+export declare function getCollectionBySlug(slug: string): Promise<GetCollectionBySlugResponse>;
+/**
+ * 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.
+ * @param _id - Requested product ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function getProductOptionsAvailability(_id: string, options?: GetProductOptionsAvailabilityOptions): Promise<ProductOptionsAvailabilityResponse>;
+export interface GetProductOptionsAvailabilityOptions {
+    /** Array containing the selected options (e.g, color: Blue, size: Large). */
+    options?: Record<string, string>;
+}
+/**
+ * Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs.
+ * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+ * @param _id - Requested product ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function queryProductVariants(_id: string, options?: QueryProductVariantsOptions): Promise<QueryProductVariantsResponse>;
+export interface QueryProductVariantsOptions {
+    /**
+     * 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;
+}
+/**
+ * Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryStoreVariants(options?: QueryStoreVariantsOptions): Promise<QueryStoreVariantsResponse>;
+export interface QueryStoreVariantsOptions {
+    /** Query options. */
+    query?: PlatformQuery;
+}
+/**
+ * Retrieves a store variant with the provided ID.
+ * @param _id - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function getStoreVariant(_id: string): Promise<GetStoreVariantResponse>;
 export {};