@wix/stores 1.0.236 → 1.0.238

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/stores",
-  "version": "1.0.236",
+  "version": "1.0.238",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -26,7 +26,7 @@
     "@wix/stores_inventory": "1.0.39",
     "@wix/stores_inventory-items-v-3": "1.0.14",
     "@wix/stores_products": "1.0.54",
-    "@wix/stores_products-v-3": "1.0.43",
+    "@wix/stores_products-v-3": "1.0.45",
     "@wix/stores_ribbons-v-3": "1.0.10",
     "@wix/stores_stores-locations-v-3": "1.0.11",
     "@wix/stores_subscription-options": "1.0.35",
@@ -55,5 +55,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "e1b9133b2fd5cd1254f63064a4e78b151b2f8e6e1ccce6502756ad48"
+  "falconPackageHash": "1d5ca74e678c1dfa8735522c6b43f39a7bbc38a892c91fa01b9a3dc7"
 }

package/type-bundles/context.bundle.d.ts

@@ -11611,7 +11611,7 @@ interface ProductCategoriesInfo {
 interface ProductCategory {
     /** Category ID. */
     _id?: string;
-    /** Index location of the product within the category. */
+    /** Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow. */
     index?: number | null;
 }
 interface ProductCategoryIdsInfo {
@@ -12124,8 +12124,35 @@ interface MinVariantPriceInfo {
     /**
      * Variant price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.
      * @readonly
+     * @deprecated
+     * @replacedBy price_per_unit_data
+     * @targetRemovalDate 2024-10-05
      */
     pricePerUnit?: string | null;
+    /**
+     * Variant price per unit.
+     * @readonly
+     */
+    pricePerUnitData?: PricePerUnit;
+    /**
+     * Variant SKU (stock keeping unit).
+     * @readonly
+     */
+    sku?: string | null;
+    /**
+     * Variant shipping weight.
+     * @readonly
+     */
+    weight?: number | null;
+    /**
+     * Variant revenue details.
+     *
+     * > **Note:** Returned only when the following conditions are met:
+     * > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests.
+     * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
+     * @readonly
+     */
+    revenueDetails?: RevenueDetails;
 }
 interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
     /** insert/update documents */
@@ -13223,6 +13250,18 @@ interface WixCommonSorting {
     fieldName?: string;
     /** Sort order. */
     order?: WixCommonSortOrder;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum WixCommonSortOrder {
     ASC = "ASC",
@@ -15584,6 +15623,8 @@ interface MinVariantPriceInfoNonNullableFields {
     basePrice?: FixedMonetaryAmountNonNullableFields;
     salePrice?: FixedMonetaryAmountNonNullableFields;
     minSubscriptionPrice?: FixedMonetaryAmountNonNullableFields;
+    pricePerUnitData?: PricePerUnitNonNullableFields;
+    revenueDetails?: RevenueDetailsNonNullableFields;
 }
 interface V3ProductNonNullableFields {
     physicalProperties?: PhysicalPropertiesNonNullableFields;

package/type-bundles/index.bundle.d.ts

@@ -11611,7 +11611,7 @@ interface ProductCategoriesInfo {
 interface ProductCategory {
     /** Category ID. */
     _id?: string;
-    /** Index location of the product within the category. */
+    /** Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow. */
     index?: number | null;
 }
 interface ProductCategoryIdsInfo {
@@ -12124,8 +12124,35 @@ interface MinVariantPriceInfo {
     /**
      * Variant price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.
      * @readonly
+     * @deprecated
+     * @replacedBy price_per_unit_data
+     * @targetRemovalDate 2024-10-05
      */
     pricePerUnit?: string | null;
+    /**
+     * Variant price per unit.
+     * @readonly
+     */
+    pricePerUnitData?: PricePerUnit;
+    /**
+     * Variant SKU (stock keeping unit).
+     * @readonly
+     */
+    sku?: string | null;
+    /**
+     * Variant shipping weight.
+     * @readonly
+     */
+    weight?: number | null;
+    /**
+     * Variant revenue details.
+     *
+     * > **Note:** Returned only when the following conditions are met:
+     * > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests.
+     * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
+     * @readonly
+     */
+    revenueDetails?: RevenueDetails;
 }
 interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
     /** insert/update documents */
@@ -13223,6 +13250,18 @@ interface WixCommonSorting {
     fieldName?: string;
     /** Sort order. */
     order?: WixCommonSortOrder;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum WixCommonSortOrder {
     ASC = "ASC",
@@ -15584,6 +15623,8 @@ interface MinVariantPriceInfoNonNullableFields {
     basePrice?: FixedMonetaryAmountNonNullableFields;
     salePrice?: FixedMonetaryAmountNonNullableFields;
     minSubscriptionPrice?: FixedMonetaryAmountNonNullableFields;
+    pricePerUnitData?: PricePerUnitNonNullableFields;
+    revenueDetails?: RevenueDetailsNonNullableFields;
 }
 interface V3ProductNonNullableFields {
     physicalProperties?: PhysicalPropertiesNonNullableFields;

package/type-bundles/meta.bundle.d.ts

@@ -12973,7 +12973,7 @@ interface ProductCategoriesInfo$1 {
 interface ProductCategory$1 {
     /** Category ID. */
     id?: string;
-    /** Index location of the product within the category. */
+    /** Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow. */
     index?: number | null;
 }
 interface PriceRange$1 {
@@ -14309,6 +14309,18 @@ interface WixCommonSorting$1 {
     fieldName?: string;
     /** Sort order. */
     order?: WixCommonSortOrder$1;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum WixCommonSortOrder$1 {
     ASC = "ASC",
@@ -15418,6 +15430,8 @@ interface MinVariantPriceInfoNonNullableFields$1 {
     basePrice?: FixedMonetaryAmountNonNullableFields$1;
     salePrice?: FixedMonetaryAmountNonNullableFields$1;
     minSubscriptionPrice?: FixedMonetaryAmountNonNullableFields$1;
+    pricePerUnitData?: PricePerUnitNonNullableFields$1;
+    revenueDetails?: RevenueDetailsNonNullableFields$1;
 }
 interface V3ProductNonNullableFields$1 {
     physicalProperties?: PhysicalPropertiesNonNullableFields$1;
@@ -17389,7 +17403,7 @@ interface ProductCategoriesInfo {
 interface ProductCategory {
     /** Category ID. */
     _id?: string;
-    /** Index location of the product within the category. */
+    /** Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow. */
     index?: number | null;
 }
 interface PriceRange {
@@ -18725,6 +18739,18 @@ interface WixCommonSorting {
     fieldName?: string;
     /** Sort order. */
     order?: WixCommonSortOrder;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum WixCommonSortOrder {
     ASC = "ASC",
@@ -19812,6 +19838,8 @@ interface MinVariantPriceInfoNonNullableFields {
     basePrice?: FixedMonetaryAmountNonNullableFields;
     salePrice?: FixedMonetaryAmountNonNullableFields;
     minSubscriptionPrice?: FixedMonetaryAmountNonNullableFields;
+    pricePerUnitData?: PricePerUnitNonNullableFields;
+    revenueDetails?: RevenueDetailsNonNullableFields;
 }
 interface V3ProductNonNullableFields {
     physicalProperties?: PhysicalPropertiesNonNullableFields;