@wix/bex-utils 1.28.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v1/catalog.proto

@@ -0,0 +1,1185 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "google/api/annotations.proto";
+import "wix/api/callback.proto";
+import "wix/api/api_errors.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/entity.proto";
+import "wix/common/bulk.proto";
+import "wix/catalog/api/v1/bulk.proto";
+import "wix/catalog/api/v1/product.proto";
+import "wix/catalog/api/v1/productOption.proto";
+import "wix/catalog/api/v1/query.proto";
+import "wix/catalog/api/v1/collection.proto";
+import "wix/catalog/api/v1/variant.proto";
+import "wix/catalog/api/v1/media.proto";
+import "wix/api/permissions.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "com/wix/ecommerce/commons/api/platformQuery.proto";
+import "com/wix/ecommerce/commons/api/unlimitedPlatformQuery.proto";
+import "com/wix/ecommerce/commons/api/platformPagingMetadata.proto";
+import "wix/sdk/definitions.proto";
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+service CatalogReadApi {
+    option (wix.api.service_exposure) = PUBLIC;
+    option (wix.api.service_maturity) = GA;
+    option (wix.api.service_entity).message = "wix.catalog.api.v1.Product";
+
+    // Returns a list of up to 100 products, given the provided paging, sorting and filtering.
+    // See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+    rpc QueryProducts (QueryProductsRequest) returns (QueryProductsResponse) {
+        option (google.api.http) = {
+            post: "/v1/products/query"
+            additional_bindings {
+                // Needed in order to maintain backwards compatibility
+                post: "/api/v1/products/query"
+            }
+        };
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    // Returns a list of up to 100 products, given the provided paging, sorting and filtering.
+    rpc QueryProductsPlatformized (QueryProductsPlatformizedRequest) returns (QueryProductsPlatformizedResponse) {
+        option (google.api.http) = {
+            post: "/v1/products/query-platformized"
+        };
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+        option (wix.api.exposure) = INTERNAL;
+        option (.wix.api.crud) = {
+            method: QUERY
+            query_options: {
+                paging: {
+                    type: OFFSET
+                }
+                items_field: 'products'
+                wql: {
+                    operator_field_support: {
+                        glob: "id"
+                        operator: ALL_APPLICABLE_OPERATORS
+                        sort: BOTH
+                    }
+                    operator_field_support: {
+                        glob: "createdDate"
+                        operator: ALL_APPLICABLE_OPERATORS
+                    }
+                    operator_field_support: {
+                        glob: "lastUpdated"
+                        operator: ALL_APPLICABLE_OPERATORS
+                        sort: BOTH
+                    }
+                    operator_field_support: {
+                        glob: "name"
+                        operator: ALL_APPLICABLE_OPERATORS
+                        sort: BOTH
+                    }
+                    operator_field_support: {
+                        glob: "description"
+                        operator: ALL_APPLICABLE_OPERATORS
+                    }
+                    operator_field_support: {
+                        glob: "sku"
+                        operator: ALL_APPLICABLE_OPERATORS
+                        sort: BOTH
+                    }
+                    operator_field_support: {
+                        glob: "price"
+                        operator: ALL_APPLICABLE_OPERATORS
+                        sort: BOTH
+                    }
+                    operator_field_support: {
+                        glob: "numericId"
+                        operator: ALL_APPLICABLE_OPERATORS
+                        sort: BOTH
+                    }
+                    operator_field_support: {
+                        glob: "productType"
+                        operator: ALL_APPLICABLE_OPERATORS
+                        sort: BOTH
+                    }
+                    operator_field_support: {
+                        glob: "slug"
+                        operator: ALL_APPLICABLE_OPERATORS
+                        sort: BOTH
+                    }
+                    operator_field_support: {
+                        glob: "collectionIds"
+                        operator: ALL_APPLICABLE_OPERATORS
+                    }
+                    operator_field_support: {
+                        glob: "inventoryStatus"
+                        operator: ALL_APPLICABLE_OPERATORS
+                    }
+                }
+            }
+        };
+    }
+
+    // Returns a list of up to 600 products, given the provided paging, sorting and filtering.
+    // See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+    rpc QueryProductsWithBigPageLimit (QueryProductsWithBigPageLimitRequest) returns (QueryProductsResponse) {
+        option (wix.api.exposure) = PRIVATE;
+        option (google.api.http) = {
+            post: "/v1/products/query-with-big-page-limit"
+        };
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS_QUERY_WITH_BIG_PAGE_LIMIT";
+    }
+
+    // Returns a list of up to 250 products, given the provided ids.
+    rpc GetProducts (GetProductsRequest) returns (GetProductsResponse) {
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+        option (wix.api.exposure) = PRIVATE;
+    }
+
+    // Retrieves a product with the provided ID.
+    rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+        option (google.api.http) = {
+            get: "/v1/products/{id}"
+            additional_bindings {
+                // Needed in order to maintain backwards compatibility
+                get: "/api/v1/products/{id}"
+            }
+        };
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    // 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.
+    rpc QueryCollections (QueryCollectionsRequest) returns (QueryCollectionsResponse) {
+        option (google.api.http) = {
+            post: "/v1/collections/query"
+            additional_bindings {
+                // Needed in order to maintain backwards compatibility
+                post: "/api/v1/collections/query"
+            }
+        };
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    // 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.
+    rpc QueryCollectionsPlatformized (QueryCollectionsPlatformizedRequest) returns (QueryCollectionsPlatformizedResponse) {
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+        option (.wix.sdk.signature) = {params: "query"};
+        option (wix.api.exposure) = INTERNAL;
+    }
+
+    // Retrieves a collection with the provided ID.
+    rpc GetCollection (GetCollectionRequest) returns (GetCollectionResponse) {
+        option (google.api.http) = {
+            get: "/v1/collections/{id}"
+            additional_bindings {
+                // Needed in order to maintain backwards compatibility
+                get: "/api/v1/collections/{id}"
+            }
+        };
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    // Retrieves a collection with the provided slug.
+    rpc GetCollectionBySlug (GetCollectionBySlugRequest) returns (GetCollectionBySlugResponse) {
+        option (google.api.http) = {
+            get: "/v1/collections/slug/{slug}"
+        };
+        option (wix.api.required) = "GetCollectionBySlugRequest.slug";
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    // 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.
+    rpc ProductOptionsAvailability (ProductOptionsAvailabilityRequest) returns (ProductOptionsAvailabilityResponse) {
+        option (google.api.http) = {
+            post: "/v1/products/{id}/productOptionsAvailability"
+            additional_bindings {
+                // Needed in order to maintain backwards compatibility
+                post: "/api/v1/products/{id}/productOptionsAvailability"
+            }
+        };
+        option (wix.api.maturity) = BETA;
+        option (.wix.sdk.signature) = {params: "options"};
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    // 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.
+    rpc QueryProductVariants (QueryProductVariantsRequest) returns (QueryProductVariantsResponse) {
+        option (wix.api.required) = "QueryProductVariantsRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/variants/query"
+        };
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    // Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
+    rpc QueryStoreVariants (QueryStoreVariantsRequest) returns (QueryStoreVariantsResponse) {
+        option (google.api.http) = {
+            post: "/v1/variants/query"
+        };
+        option (wix.api.maturity) = BETA;
+        option (.wix.sdk.signature) = {params: "query"};
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    // Retrieves up to 1000 store variants, given the provided paging, filtering, and sorting.
+    rpc QueryStoreVariantsWithBigLimit (QueryStoreVariantsWithBigLimitRequest) returns (QueryStoreVariantsResponse) {
+        option (google.api.http) = {
+            post: "/v1/variants/query-with-big-limit"
+        };
+        option (wix.api.exposure) = INTERNAL;
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS_QUERY_WITH_BIG_PAGE_LIMIT";
+    }
+
+    // Retrieves a store variant with the provided ID.
+    rpc GetStoreVariant (GetStoreVariantRequest) returns (GetStoreVariantResponse) {
+        option (google.api.http) = {
+            get: "/v1/variants/{id}"
+        };
+        option (wix.api.maturity) = BETA;
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    rpc QueryCustomFields (QueryCustomFieldsRequest) returns (QueryCustomFieldsResponse) {
+        option (wix.api.required) = "QueryCustomFieldsRequest.id";
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+        option (wix.api.exposure) = PRIVATE;
+    }
+
+    // Retrieves a list of up to 100 productId to CustomFields, given the provided paging, sorting and filtering.
+    // See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+    // This is exposed only to internal since it's a partial solution that doesn't cover the data extensions use case
+    rpc BulkQueryCustomFields (BulkQueryCustomFieldsRequest) returns (BulkQueryCustomFieldsResponse) {
+        option (wix.api.required) = "BulkQueryCustomFieldsRequest.query";
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+        option (wix.api.exposure) = INTERNAL;
+    }
+
+    //Before open to users we should support group by field which will impact all aggregations
+    //Group by field is optional, in case you want to count all, max on all etc
+    //Issue: for count we allow 2-dimensional aggregation which will not be supported when group by single field
+    //To support group by we need to add support of it in object-search library
+    // This is exposed only to internal since it has limitations and there isn't an aggregate spec yet
+    rpc AggregateProducts (AggregateProductsRequest) returns (AggregateProductsResponse) {
+        option (wix.api.required) = "AggregateProductsRequest.aggregation";
+        option (google.api.http) = {
+            post: "/v1/products/aggregate"
+        };
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+        option (wix.api.exposure) = INTERNAL;
+    }
+    // Triggered when a product is created.
+    option (wix.api.event) = {
+       topic: "wixStores-catalog-product-created"
+       payload: "wix.catalog.api.v1.event.ProductCreated"
+       permission: "WIX_STORES.READ_PRODUCTS"
+    };
+    // Triggered when a product is changed.
+    option (wix.api.event) = {
+       topic: "wixStores-catalog-product-changed"
+       payload: "wix.catalog.api.v1.event.ProductChanged"
+       permission: "WIX_STORES.READ_PRODUCTS"
+    };
+    // Triggered when a product is deleted.
+    option (wix.api.event) = {
+       topic: "wixStores-catalog-product-deleted"
+       payload: "wix.catalog.api.v1.event.ProductDeleted"
+       permission: "WIX_STORES.READ_PRODUCTS"
+    };
+    // Triggered when a collection is created.
+    option (wix.api.event) = {
+       topic: "wixStores-catalog-collection-created"
+       payload: "wix.catalog.api.v1.event.CollectionCreated"
+       permission: "WIX_STORES.READ_PRODUCTS"
+    };
+    // Triggered when a collection is changed.
+    option (wix.api.event) = {
+       topic: "wixStores-catalog-collection-changed"
+       payload: "wix.catalog.api.v1.event.CollectionChanged"
+       permission: "WIX_STORES.READ_PRODUCTS"
+    };
+    // Triggered when a collection is deleted.
+    option (wix.api.event) = {
+       topic: "wixStores-catalog-collection-deleted"
+       payload: "wix.catalog.api.v1.event.CollectionDeleted"
+       permission: "WIX_STORES.READ_PRODUCTS"
+    };
+    // Triggered when a product variant is changed.
+    option (wix.api.event) = {
+       topic: "wixStores-catalog-variants-changed"
+       payload: "wix.catalog.api.v1.event.VariantsChanged"
+       permission: "WIX_STORES.READ_PRODUCTS"
+    };
+}
+
+message QueryProductsRequest {
+    Query query = 1;
+    // Whether variants should be included in the response.
+    bool include_variants = 2;
+    // Whether hidden products should be included in the response. Requires permissions to manage products.
+    bool include_hidden_products = 3;
+    // Whether merchant specific data should be included in the response. Requires permissions to manage products.
+    bool include_merchant_specific_data = 4;
+}
+
+message QueryProductsPlatformizedRequest {
+    com.wix.ecommerce.commons.api.PlatformQuery query = 1;
+}
+
+message QueryProductsWithBigPageLimitRequest {
+    QueryWithBigPageLimit query = 1;
+    // Whether variants should be included in the response.
+    bool include_variants = 2;
+    // Whether hidden products should be included in the response. Requires permissions to manage products.
+    bool include_hidden_products = 3;
+    // Whether merchant specific data should be included in the response. Requires permissions to manage products.
+    bool include_merchant_specific_data = 4;
+}
+
+message QueryProductsResponse {
+    repeated Product products = 1;
+    PagingMetadata metadata = 2;
+    int32 totalResults = 3;
+}
+
+message QueryProductsPlatformizedResponse {
+    repeated Product products = 1 [(wix.api.maxSize) = 100];
+    com.wix.ecommerce.commons.api.PlatformPagingMetadata metadata = 2;
+}
+
+message GetProductsRequest {
+    // Requested product IDs.
+    repeated string ids = 1 [(wix.api.minSize) = 1, (wix.api.maxSize) = 250];
+}
+
+message GetProductsResponse {
+    repeated Product products = 1;
+}
+
+message GetProductRequest {
+    // Requested product ID.
+    string id = 1 [(wix.api.minLength) = 1];
+    // Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products.
+    bool include_merchant_specific_data = 2;
+}
+
+message GetProductResponse {
+    // Requested product data.
+    Product product = 1;
+}
+
+message QueryCollectionsRequest {
+    // Query options.
+    Query query = 1;
+    // Whether number of products should be included in the response.
+    bool include_number_of_products = 2;
+    // Wether to include collection description in the response. When `false` is passed, `collection.description` will return null.
+    bool include_description = 3;
+    // Include SeoSchema in response. When False, SeoSchema will be null
+    bool include_seo_schema = 4 [(.wix.api.field_exposure) = INTERNAL];
+}
+
+message GetCollectionBySlugRequest {
+    // Slug of the collection to retrieve.
+    string slug = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+}
+
+message QueryCollectionsResponse {
+    // List of collections.
+    repeated Collection collections = 1;
+    // Details on the paged set of results returned.
+    PagingMetadata metadata = 2;
+    // Total number of results returned.
+    int32 totalResults = 3;
+}
+
+message QueryCollectionsPlatformizedRequest {
+    com.wix.ecommerce.commons.api.PlatformQuery query = 1;
+}
+
+message QueryCollectionsPlatformizedResponse {
+    repeated Collection collections = 1 [(wix.api.maxSize) = 100];
+    com.wix.ecommerce.commons.api.PlatformPagingMetadata metadata = 2;
+}
+
+message GetCollectionRequest {
+    // Requested collection ID.
+    string id = 1 [(.wix.api.minLength) = 35, (.wix.api.maxLength) = 36];
+    // Whether to return the `collection.numberOfProducts` field in the response.
+    // Defaults to `false`, in which case the value of `collection.numberOfProducts` will be `0`.
+    bool include_number_of_products = 2;
+}
+
+message GetCollectionResponse {
+    // The requested collection.
+    Collection collection = 1;
+}
+
+message ProductOptionsAvailabilityRequest {
+    // Requested product ID.
+    string id = 1 [(wix.api.minLength) = 1];
+    // Set of key-value pairs. Array containing the selected options (e.g, color: Blue, size: Large).
+    map<string, string> options = 2;
+}
+
+message ProductOptionsAvailabilityResponse {
+    // Variant information, given that all the choices were provided.
+    VariantData selected_variant = 1;
+    // Information about media items (images, videos, etc.) associated with this choice.
+    Media media = 2;
+    // Options information (color, size, etc.) for this product, with the inventory and visibility fields updated based on the provided choices.
+    repeated ProductOption product_options = 3;
+    // Whether all the selected choices result in a visible, in-stock variant.
+    bool available_for_purchase = 4;
+    //Whether the variant is managed or represents a product.
+    bool managed_product = 5 [(wix.api.field_exposure) = PRIVATE];
+}
+
+message QueryProductVariantsRequest {
+    // Requested product ID.
+    string id = 1 [(wix.api.minLength) = 1];
+    // 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).
+    map<string, string> choices = 2;
+    // List of variant IDs (not relevant when passing choices).
+    repeated string variantIds = 3;
+    Paging paging = 4;
+    // Whether merchant specific data should be included in the response. Requires permissions to manage products.
+    bool include_merchant_specific_data = 5;
+}
+
+message QueryProductVariantsResponse {
+    // List of variants based on the specified filters and sorting.
+    repeated Variant variants = 1;
+    PagingMetadata metadata = 3;
+    int32 total_results = 4;
+}
+
+message QueryStoreVariantsRequest {
+    // Query options.
+    com.wix.ecommerce.commons.api.PlatformQuery query = 1;
+    // Requested custom field names.
+    repeated string custom_fields = 2 [(.wix.api.field_exposure) = PRIVATE, (wix.api.maxLength) = 100];
+}
+
+message QueryStoreVariantsWithBigLimitRequest {
+    // Query options.
+    com.wix.ecommerce.commons.api.UnlimitedPlatformQuery query = 1;
+    // Requested custom field names.
+    repeated string custom_fields = 2 [(.wix.api.field_exposure) = PRIVATE, (wix.api.maxLength) = 100];
+}
+
+message QueryStoreVariantsResponse {
+    // List of variants based on the specified filters and sorting.
+    repeated StoreVariant variants = 1;
+    // Details on the paged set of results returned.
+    com.wix.ecommerce.commons.api.PlatformPagingMetadata metadata = 2;
+}
+
+message GetStoreVariantRequest {
+    // Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
+    string id = 1;
+}
+
+message GetStoreVariantResponse {
+    // The requested store variant.
+    StoreVariant variant = 1;
+}
+
+message QueryCustomFieldsRequest {
+    // Requested product ID.
+    string id = 1;
+    //Requested field names.
+    repeated string names = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+}
+
+message QueryCustomFieldsResponse {
+    map<string, google.protobuf.Value> custom_fields = 1;
+}
+
+message BulkQueryCustomFieldsRequest {
+    // Filter string.
+    Query query = 1;
+    // Requested field names.
+    repeated string names = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+}
+
+message BulkQueryCustomFieldsResponse {
+    // ProductId to Custom Fields Map packed in container.
+    map<string, CustomFieldsContainer> product_id_to_custom_fields = 1;
+    PagingMetadata metadata = 2;
+    int32 totalResults = 3;
+}
+
+message CustomFieldsContainer {
+    map<string, google.protobuf.Value> custom_fields = 1;
+}
+
+message AggregateProductsRequest {
+    // Filter applied to original data
+    google.protobuf.Struct filter = 1;
+    //This is an object defining aggregation itself
+    google.protobuf.Struct aggregation = 2;
+    // Whether hidden products should be considered. Requires permissions to manage products.
+    bool include_hidden_products = 3;
+    // Whether merchant specific data should be included in the response. Requires permissions to manage products.
+    bool include_merchant_specific_data = 4;
+}
+
+message AggregateProductsResponse {
+    google.protobuf.Struct aggregates = 1;
+}
+
+service CatalogWriteApi {
+    option (wix.api.service_exposure) = PUBLIC;
+    option (wix.api.service_maturity) = GA;
+    option (wix.api.service_entity).message = "wix.catalog.api.v1.Product";
+
+    //Creates a new product.
+    rpc CreateProduct (CreateProductRequest) returns (CreateProductResponse) {
+        option (wix.api.required) = "CreateProductRequest.product.name";
+        option (wix.api.required) = "CreateProductRequest.product.priceData";
+        option (wix.api.required) = "CreateProductRequest.product.priceData.price";
+        option (wix.api.required) = "CreateProductRequest.product.cost_and_profit_data.item_cost";
+        option (google.api.http) = {
+            post: "/v1/products"
+        };
+        option (.wix.sdk.signature) = {params: "product"};
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //Updates specified fields in a product.
+    rpc UpdateProduct (UpdateProductRequest) returns (UpdateProductResponse) {
+        option (wix.api.required) = "UpdateProductRequest.product.id";
+        option (wix.api.required) = "UpdateProductRequest.product";
+        option (google.api.http) = {
+            patch: "/v1/products/{product.id}"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //Deletes a product.
+    rpc DeleteProduct (DeleteProductRequest) returns (DeleteProductResponse) {
+        option (wix.api.required) = "DeleteProductRequest.id";
+        option (google.api.http) = {
+            delete: "/v1/products/{id}"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //Deletes a bulk of products.
+    rpc BulkDeleteProducts (BulkDeleteProductsRequest) returns (BulkDeleteProductsResponse) {
+        option (wix.api.required) = "BulkDeleteProductsRequest.ids";
+        option (wix.api.exposure) = PRIVATE;
+        option (google.api.http) = {
+            delete: "/v1/bulk/products/delete"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //Updates variants of a specified product.
+    rpc UpdateVariants (UpdateVariantsRequest) returns (UpdateVariantsResponse) {
+        option (wix.api.required) = "UpdateVariantsRequest.id";
+        option (google.api.http) = {
+            patch: "/v1/products/{id}/variants"
+        };
+        option (.wix.sdk.signature) = {params: "variants"};
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //Resets the data (such as the price and the weight) of all variants for a given product to their default values.
+    rpc ResetAllVariantData (ResetAllVariantDataRequest) returns (ResetAllVariantDataResponse) {
+        option (wix.api.required) = "ResetAllVariantDataRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/variants/resetToDefault"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //Adds products to a specified collection.
+    rpc AddProductsToCollection (AddProductsToCollectionRequest) returns (AddProductsToCollectionResponse) {
+        option (wix.api.required) = "AddProductsToCollectionRequest.id";
+        option (google.api.http) = {
+            post: "/v1/collections/{id}/productIds"
+        };
+        option (.wix.sdk.signature) = {params: "product_ids"};
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //Deletes products from a specified collection.
+    rpc RemoveProductsFromCollection (RemoveProductsFromCollectionRequest) returns (RemoveProductsFromCollectionResponse) {
+        option (wix.api.required) = "RemoveProductsFromCollectionRequest.id";
+        option (wix.api.required) = "RemoveProductsFromCollectionRequest.product_ids";
+        option (google.api.http) = {
+            post: "/v1/collections/{id}/productIds/delete"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.maturity) = BETA;
+    }
+
+    // Adds media items to a specified product, either via URL or existing media ID.
+    rpc AddProductMedia (AddProductMediaRequest) returns (AddProductMediaResponse) {
+        option (wix.api.required) = "AddProductMediaRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/media"
+        };
+        option (.wix.sdk.signature) = {params: "media"};
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    // Removes specified media items from a product.
+    // Pass an empty array to remove all media items.
+    rpc RemoveProductMedia (RemoveProductMediaRequest) returns (RemoveProductMediaResponse) {
+        option (wix.api.required) = "RemoveProductMediaRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/media/delete"
+        };
+        option (.wix.sdk.signature) = {params: "media_ids"};
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    // 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.
+    rpc AddProductMediaToChoices (AddProductMediaToChoicesRequest) returns (AddProductMediaToChoicesResponse) {
+        option (wix.api.required) = "AddProductMediaToChoicesRequest.id";
+        option (wix.api.required) = "AddProductMediaToChoicesRequest.media.option";
+        option (wix.api.required) = "AddProductMediaToChoicesRequest.media.choice";
+        option (google.api.http) = {
+            patch: "/v1/products/{id}/choices/media"
+        };
+        option (.wix.sdk.signature) = {params: "media"};
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.maturity) = BETA;
+    }
+
+    // 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).)
+    rpc RemoveProductMediaFromChoices (RemoveProductMediaFromChoicesRequest) returns (RemoveProductMediaFromChoicesResponse) {
+        option (wix.api.required) = "RemoveProductMediaFromChoicesRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/choices/media/delete"
+        };
+        option (.wix.sdk.signature) = {params: "media"};
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.maturity) = BETA;
+    }
+
+    // Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.
+    rpc DeleteProductOptions (DeleteProductOptionsRequest) returns (DeleteProductOptionsResponse) {
+        option (wix.api.required) = "DeleteProductOptionsRequest.id";
+        option (google.api.http) = {
+            delete: "/v1/products/{id}/options"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.maturity) = BETA;
+    }
+
+    rpc SetCustomFields (SetCustomFieldsRequest) returns (SetCustomFieldsResponse) {
+        option (wix.api.required) = "SetCustomFieldsRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/set-custom-field"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.exposure) = PRIVATE;
+    }
+
+    rpc RemoveCustomFields (RemoveCustomFieldsRequest) returns (RemoveCustomFieldsResponse) {
+        option (wix.api.required) = "RemoveCustomFieldsRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/remove-custom-field"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.exposure) = PRIVATE;
+    }
+
+    //Deletes a product's brand.
+    rpc RemoveBrand (RemoveProductBrandRequest) returns (RemoveProductBrandResponse) {
+        option (wix.api.required) = "RemoveProductBrandRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/remove-brand"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    rpc BulkSetCustomFields (BulkSetCustomFieldsRequest) returns (BulkSetCustomFieldsResponse) {
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (google.api.http) = {
+            post: "/v1/bulk/products/set-custom-fields"
+        };
+        option (wix.api.exposure) = PRIVATE;
+    }
+
+    rpc BulkRemoveCustomFields (BulkRemoveCustomFieldsRequest) returns (BulkRemoveCustomFieldsResponse) {
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (google.api.http) = {
+            post: "/v1/bulk/products/remove-custom-fields"
+        };
+        option (wix.api.exposure) = PRIVATE;
+    }
+
+    //Creates a new collection.
+    rpc CreateCollection (CreateCollectionRequest) returns (CreateCollectionResponse) {
+        option (google.api.http) = {
+            post: "/v1/collections"
+        };
+        option (wix.api.required) = "CreateCollectionRequest.collection";
+        option (wix.api.required) = "CreateCollectionRequest.collection.name";
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    // 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/collections/add-products-to-collection) endpoint.
+    rpc UpdateCollection (UpdateCollectionRequest) returns (UpdateCollectionResponse) {
+        option (google.api.http) = {
+            patch: "/v1/collections/{collection.id}"
+        };
+        option (wix.api.required) = "UpdateCollectionRequest.collection";
+        option (wix.api.required) = "UpdateCollectionRequest.collection.id";
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.maturity) = BETA;
+    }
+
+    //Deletes a collection.
+    rpc DeleteCollection (DeleteCollectionRequest) returns (DeleteCollectionResponse) {
+        option (google.api.http) = {
+            delete: "/v1/collections/{id}"
+        };
+        option (wix.api.required) = "DeleteCollectionRequest.id";
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.maturity) = BETA;
+    }
+
+    //Deletes a product's ribbon.
+    rpc RemoveRibbon (RemoveProductRibbonRequest) returns (RemoveProductRibbonResponse) {
+        option (wix.api.required) = "RemoveProductRibbonRequest.id";
+        option (google.api.http) = {
+            post: "/v1/products/{id}/remove-ribbon"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    // Updates a specified property for up to 100 products at a time.
+    rpc BulkUpdateProducts (BulkUpdateProductsRequest) returns (BulkUpdateProductsResponse) {
+        option (google.api.http) = {
+            post: "/v1/bulk/products/update"
+        };
+        option (wix.api.required) = "BulkUpdateProductsRequest.ids";
+        option (.wix.sdk.signature) = {
+            params: "ids"
+            params: "set"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.maturity) = BETA;
+    }
+
+    // Updates a bulk of products, selected by filter.
+    // The number of products that can be updated by filter is limited to 1000.
+    // Internal only. Will be replaced in some point.
+    rpc BulkUpdateProductsByFilterSync (BulkUpdateProductsByFilterSyncRequest) returns (BulkUpdateProductsByFilterSyncResponse) {
+        option (google.api.http) = {
+            post: "/v1/bulk/products/update-by-filter-sync"
+        };
+        option (wix.api.required) = "BulkUpdateProductsByFilterSyncRequest.filter";
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.exposure) = INTERNAL;
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "ALLOWED_PRODUCTS_COUNT_LIMIT_EXCEEDED"
+            data: "wix.catalog.api.v1.AllowedProductsCountLimitExceededErrorData"
+        };
+    }
+
+    // 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.
+    rpc BulkAdjustProductProperties (BulkAdjustProductPropertiesRequest) returns (BulkAdjustProductPropertiesResponse) {
+        option (google.api.http) = {
+            post: "/v1/bulk/products/adjust-properties"
+            additional_bindings {
+                post: "/v1/bulk/products/adjust"
+            }
+        };
+        option (.wix.sdk.signature) = {
+            params: "adjust"
+            params: "ids"
+        };
+        option (wix.api.required) = "BulkAdjustProductPropertiesRequest.ids";
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.maturity) = BETA;
+    }
+
+    // Adjust property for multiple products, selected by filter.
+    // The number of products that can be updated by filter is limited to 1000.
+    // Internal only. Will be replaced at some point.
+    rpc BulkAdjustProductPropertiesByFilterSync (BulkAdjustProductPropertiesByFilterSyncRequest) returns (BulkAdjustProductPropertiesByFilterSyncResponse) {
+        option (google.api.http) = {
+            post: "/v1/bulk/products/adjust-properties-by-filter-sync"
+        };
+        option (wix.api.required) = "BulkAdjustProductPropertiesByFilterSyncRequest.filter";
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+        option (wix.api.exposure) = INTERNAL;
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "ALLOWED_PRODUCTS_COUNT_LIMIT_EXCEEDED"
+            data: "wix.catalog.api.v1.AllowedProductsCountLimitExceededErrorData"
+        };
+    }
+}
+
+message CreateProductRequest {
+    //Product information.
+    Product product = 1;
+}
+
+message CreateProductResponse {
+    Product product = 1;
+}
+
+message UpdateProductRequest {
+    Product product = 1;
+}
+
+message UpdateProductResponse {
+    Product product = 1;
+}
+
+message DeleteProductRequest {
+    //ID of the product to delete.
+    string id = 1;
+}
+
+message DeleteProductResponse {
+}
+
+message BulkDeleteProductsRequest {
+    //IDs of the products to be deleted.
+    repeated string ids = 1 [(wix.api.maxSize) = 1000];
+}
+
+message BulkDeleteProductsResponse {
+}
+
+message UpdateVariantsRequest {
+    //ID of the product with managed variants.
+    string id = 1;
+    // Variant info to update.
+    repeated VariantOverride variants = 2;
+}
+
+message UpdateVariantsResponse {
+    // List of the product's variants.
+    repeated Variant variants = 1;
+}
+
+message AddProductsToCollectionRequest {
+    //Collection ID. Cannot be used to add products to All Products
+    string id = 1 [(wix.api.format) = GUID];
+    //IDs of the products to add to the collection, separated by commas.
+    repeated string product_ids = 2 [(wix.api.maxSize) = 1000];
+}
+
+message AddProductsToCollectionResponse {
+}
+
+message RemoveProductsFromCollectionRequest {
+    //Collection ID. Cannot be used to remove products from All Products
+    string id = 1 [(wix.api.format) = GUID];
+    //IDs of the products to remove from the collection.
+    repeated string product_ids = 2 [(wix.api.maxSize) = 1000];
+}
+
+message RemoveProductsFromCollectionResponse {
+}
+
+message DeleteProductMediaRequest {
+    //Product ID.
+    string id = 1;
+}
+
+message DeleteProductMediaResponse {
+}
+
+message AddProductMediaRequest {
+    //Product ID.
+    string id = 1;
+    // Sources of media items already uploaded to the Wix site.
+    repeated MediaDataForWrite media = 2 [(wix.api.minSize) = 1, (wix.api.maxSize) = 50];
+}
+
+message AddProductMediaResponse {
+}
+
+message RemoveProductMediaRequest {
+    //Product ID.
+    string id = 1;
+    //List of media IDs to remove. Pass an empty array to delete all media items for the product.
+    repeated string media_ids = 2 [(wix.api.maxSize) = 50];
+}
+
+message RemoveProductMediaResponse {
+}
+
+message DeleteProductOptionsRequest {
+    // ID of the product with options to delete.
+    string id = 1;
+}
+
+message DeleteProductOptionsResponse {
+}
+
+message ResetAllVariantDataRequest {
+    //Product ID.
+    string id = 1;
+}
+
+message ResetAllVariantDataResponse {
+
+}
+
+message AddProductMediaToChoicesRequest {
+    // Product ID.
+    string id = 1;
+
+    // Product media items and the choices to add the media to.
+    repeated MediaAssignmentToChoice media = 2 [(wix.api.minSize) = 1, (wix.api.maxSize) = 10];
+}
+
+message AddProductMediaToChoicesResponse {
+
+}
+
+message RemoveProductMediaFromChoicesRequest {
+    // Product ID from whose choices to remove media items.
+    string id = 1;
+    // Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.
+    repeated MediaAssignmentToChoice media = 2 [(wix.api.minSize) = 1, (wix.api.maxSize) = 10];
+}
+
+message RemoveProductMediaFromChoicesResponse {
+
+}
+
+
+message SetCustomFieldsRequest {
+    //Product ID.
+    string id = 1;
+    //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.
+    map<string, google.protobuf.Value> custom_fields = 2;
+}
+
+message SetCustomFieldsResponse {
+}
+
+message RemoveCustomFieldsRequest {
+    //Product ID.
+    string id = 1;
+    //Custom fields to be removed (by name).
+    repeated string names = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+}
+
+message RemoveCustomFieldsResponse {
+}
+
+message RemoveProductBrandRequest {
+    //Product ID.
+    string id = 1;
+}
+
+message RemoveProductBrandResponse {
+}
+
+message BulkSetCustomFieldsRequest {
+    // Filter string.
+    google.protobuf.StringValue filter = 1;
+    //Custom field that will be added, if a custom field with same name already exists, the value of the custom field will be overridden.
+    map<string, google.protobuf.Value> custom_fields = 2;
+}
+
+message BulkSetCustomFieldsResponse {
+}
+
+message BulkRemoveCustomFieldsRequest {
+    // Filter string.
+    google.protobuf.StringValue filter = 1;
+    //Custom fields names.
+    repeated string names = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+}
+
+message BulkRemoveCustomFieldsResponse {
+}
+
+enum CustomFieldName {
+    UNKNOWN_CUSTOM_FIELD_NAME = 0;
+    SHIPPING_GROUP_ID = 1;
+    PLAN_IDS = 2;
+    HIDDEN_PLAN_IDS = 3;
+    ONE_TIME_PURCHASE = 4;
+    FULFILLER_ID = 5;
+    READY_TO_SELL_STORES_EXTERNAL_PRODUCT_REFERENCE = 6;
+    READY_TO_SELL_STORES_EXTERNAL_APP_ID = 7;
+    HIDE_FROM_POS = 8;
+    WISH_STATUS = 9;
+    GOOGLE_STATUS = 10; // StoresChannels integration status of the product within store's Google catalog
+    PRINT_ON_DEMAND = 11;
+}
+
+message CreateCollectionRequest {
+    // Collection info.
+    Collection collection = 1;
+}
+
+message CreateCollectionResponse {
+    // Collection.
+    Collection collection = 1;
+}
+
+message UpdateCollectionRequest {
+    // Collection info.
+    Collection collection = 1;
+}
+
+message UpdateCollectionResponse {
+    // Updated collection.
+    Collection collection = 1;
+}
+
+message GetCollectionBySlugResponse {
+    // The requested collection.
+    Collection collection = 1;
+}
+
+message DeleteCollectionRequest {
+    // ID of the collection to delete. Cannot be used to delete All Products
+    string id = 1 [(wix.api.format) = GUID];
+}
+
+message DeleteCollectionResponse {
+}
+
+message RemoveProductRibbonRequest {
+    //Product ID.
+    string id = 1;
+}
+
+message RemoveProductRibbonResponse {
+}
+
+message BulkUpdateProductsRequest {
+    // Product IDs.
+    repeated string ids = 1 [(.wix.api.minSize) = 1, (.wix.api.maxSize) = 100];
+    // Field to update.
+    SetValue set = 2;
+}
+
+message BulkUpdateProductsResponse {
+    // Bulk action results.
+    repeated BulkProductResult results = 1;
+    // Bulk action metadata.
+    .wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}
+
+message BulkUpdateProductsByFilterSyncRequest {
+    // Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort).
+    google.protobuf.Struct filter = 1;
+    // The field to update.
+    SetValue set = 2;
+}
+
+message BulkUpdateProductsByFilterSyncResponse {
+    // Items updated by bulk action.
+    repeated BulkProductResult results = 1;
+    // Bulk action metadata.
+    .wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}
+
+message SetValue {
+    oneof value {
+        // 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.
+        double price = 1 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+        // 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.
+        double cost = 2 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+        // 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.
+        double weight = 3 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+        // Set product ribbon. Pass empty string to remove existing ribbon.
+        string ribbon = 4 [(wix.api.maxLength) = 30];
+        // Set product brand. Pass empty string to remove existing brand.
+        string brand = 5 [(wix.api.maxLength) = 50];
+    }
+}
+
+message BulkAdjustProductPropertiesRequest {
+    // Product IDs.
+    repeated string ids = 1 [(.wix.api.minSize) = 1, (.wix.api.maxSize) = 100];
+    // Numerical property to adjust.
+    AdjustValue adjust = 2;
+}
+
+message BulkAdjustProductPropertiesResponse {
+    // Bulk action results.
+    repeated BulkProductResult results = 1;
+    // Bulk action metadata.
+    .wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}
+
+message BulkAdjustProductPropertiesByFilterSyncRequest {
+    // Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort).
+    google.protobuf.Struct filter = 1;
+    // Numerical property to adjust.
+    AdjustValue adjust = 2;
+}
+
+message BulkAdjustProductPropertiesByFilterSyncResponse {
+    // Items updated by bulk action.
+    repeated BulkProductResult results = 1;
+    // Bulk action metadata.
+    .wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}
+
+message AdjustValue {
+    oneof value {
+        // 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.
+        PropertyAdjustmentData price = 1;
+        // 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.
+        PropertyAdjustmentData cost = 2;
+        // 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.
+        PropertyAdjustmentData weight = 3;
+    }
+}
+
+message PropertyAdjustmentData {
+    oneof by {
+        // Adjust by percentage.
+        PercentageData percentage = 1;
+        // Adjust by amount.
+        double amount = 2 [(wix.api.min) = -999999999.99, (wix.api.max) = 999999999.99];
+    }
+}
+
+message 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.
+    bool roundToInt = 1;
+    // 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).
+    int32 rate = 2 [(wix.api.min) = -100, (wix.api.max) = 1000];
+}