{"id":"d3850f9d-97d6-4450-929f-2355cd5600b7","createdDate":"2024-07-04T11:43:07.194Z","updatedDate":"2024-07-04T11:43:07.194Z","resourceId":"4c1c53e0-a1ac-454e-8f00-73cbeafc4bc7","api":{"schema":{"object":{"displayName":"Item Variant Object","description":"","slug":"item-variant-object","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"methods":[{"summary":"List Variants","description":"> **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n\nRetrieves a list of up to 100 item variants.","operationId":"wix.restaurants.menus_item_variant.v1.VariantsService.ListVariants","parameters":[{"name":"variantIds","in":"query","description":"Item variant IDs.","required":false,"schema":{"description":"Item variant IDs.","format":"GUID","maxItems":200,"title":"variantIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"paging","in":"query","description":"The metadata of the paginated results.","required":false,"schema":{"description":"The metadata of the paginated results.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.ListVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/item-variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/item-variants","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.ListVariantsRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.ListVariantsResponse"},"legacyExamples":[{"name":"ListVariants","type":"METHOD","content":{"title":"List all variants","request":"curl -X GET https://www.wixapis.com/restaurants/item-variants/v1/variants \\\n -H 'Authorization: '","response":"{\n \"variants\": [\n {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a62\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-03T21:23:33.861Z\",\n \"updatedDate\": \"2023-12-03T21:23:33.861Z\",\n \"name\": \"Small\",\n },\n {\n \"id\": \"0517e5d4-8fd3-4b28-a743-68cf631e534a\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-03T21:23:33.861Z\",\n \"updatedDate\": \"2023-12-03T21:23:33.861Z\",\n \"name\": \"Medium\",\n },\n {\n \"id\": \"1c1ca051-b460-4064-b7a2-5f9df47f2d3c\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-03T21:23:33.861Z\",\n \"updatedDate\": \"2023-12-03T21:23:33.861Z\",\n \"name\": \"Large\",\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"get","path":"/v1/variants","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.ListVariantsRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.ListVariantsResponse"},"legacyExamples":[{"name":"ListVariants","type":"METHOD","content":{"title":"List all variants","request":"curl -X GET https://www.wixapis.com/restaurants/item-variants/v1/variants \\\n -H 'Authorization: '","response":"{\n \"variants\": [\n {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a62\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-03T21:23:33.861Z\",\n \"updatedDate\": \"2023-12-03T21:23:33.861Z\",\n \"name\": \"Small\",\n },\n {\n \"id\": \"0517e5d4-8fd3-4b28-a743-68cf631e534a\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-03T21:23:33.861Z\",\n \"updatedDate\": \"2023-12-03T21:23:33.861Z\",\n \"name\": \"Medium\",\n },\n {\n \"id\": \"1c1ca051-b460-4064-b7a2-5f9df47f2d3c\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-03T21:23:33.861Z\",\n \"updatedDate\": \"2023-12-03T21:23:33.861Z\",\n \"name\": \"Large\",\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"List Variants","slugifiedName":"list-variants"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Create Variant","description":"> **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n\nCreates an item variant.\n\nTo create multiple item variants at once, use [Bulk Create Variants](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/bulk-create-variants).","operationId":"wix.restaurants.menus_item_variant.v1.VariantsService.CreateVariant","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.CreateVariantResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/item-variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/item-variants","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateVariantRequest","description":"","properties":{"variant":{"description":"Item variant info.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["variant","variant.name"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Item Variant Created","description":"Triggered when an item variant is created.","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.restaurants.menus.v1.item_variant_created","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.CreateVariantRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.CreateVariantResponse"},"legacyExamples":[{"name":"CreateVariant","type":"METHOD","content":{"title":"Create a variant","request":"curl -X POST https://www.wixapis.com/restaurants/item-variants/v1/restaurants-menus-item-variant \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"variant\": {\n \"name\": \"Small\"\n }'","response":"{\n \"variant\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"name\": \"Small\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v1/variants","rpcOnly":false,"triggeredEvents":[{"title":"Item Variant Created","description":"Triggered when an item variant is created.","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.restaurants.menus.v1.item_variant_created","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.CreateVariantRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.CreateVariantResponse"},"legacyExamples":[{"name":"CreateVariant","type":"METHOD","content":{"title":"Create a variant","request":"curl -X POST https://www.wixapis.com/restaurants/item-variants/v1/restaurants-menus-item-variant \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"variant\": {\n \"name\": \"Small\"\n }'","response":"{\n \"variant\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"name\": \"Small\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Create Variant","slugifiedName":"create-variant"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Get Variant","description":"> **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n\nRetrieves an item variant by the ID.","operationId":"wix.restaurants.menus_item_variant.v1.VariantsService.GetVariant","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"variantId","description":"ID of the item variant to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.GetVariantResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/item-variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/item-variants","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.GetVariantRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.GetVariantResponse"},"legacyExamples":[{"name":"GetVariant","type":"METHOD","content":{"title":"Retrieve a variant","request":"curl -X GET https://www.wixapis.com/restaurants/item-variants/v1/variants/02042f01-58ab-441c-b5db-55f51c855a62\n-H 'Authorization: '","response":"{\n \"variant\": {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a62\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-03T21:23:33.861Z\",\n \"updatedDate\": \"2023-12-03T21:23:33.861Z\",\n \"name\": \"Small\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"get","path":"/v1/variants/{variantId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.GetVariantRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.GetVariantResponse"},"legacyExamples":[{"name":"GetVariant","type":"METHOD","content":{"title":"Retrieve a variant","request":"curl -X GET https://www.wixapis.com/restaurants/item-variants/v1/variants/02042f01-58ab-441c-b5db-55f51c855a62\n-H 'Authorization: '","response":"{\n \"variant\": {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a62\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-03T21:23:33.861Z\",\n \"updatedDate\": \"2023-12-03T21:23:33.861Z\",\n \"name\": \"Small\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Get Variant","slugifiedName":"get-variant"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Variant","description":"> **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n\nUpdates an item variant.\n\nTo update multiple item variants at once, use [Bulk Update Variants](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/bulk-update-variants).\n\nEach time an item variant is updated, revision increments by 1. The existing revision must be included when updating the variant. This ensures you're working with the latest variant information, and it prevents unintended overwrites.","operationId":"wix.restaurants.menus_item_variant.v1.VariantsService.UpdateVariant","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"variant.id","description":"Item variant ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.UpdateVariantResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/item-variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/item-variants","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateVariantRequest","description":"","properties":{"variant":{"description":"Item variant to update.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["variant","variant.id","variant.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Item Variant Updated","description":"Triggered when an item variant is updated.","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.restaurants.menus.v1.item_variant_updated","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.UpdateVariantRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.UpdateVariantResponse"},"legacyExamples":[{"name":"UpdateVariant","type":"METHOD","content":{"title":"Update a variant","request":"curl -X PATCH https://www.wixapis.com/restaurants/item-variants/v1/variants/02042f01-58ab-441c-b5db-55f51c855a11?variantId=02042f01-58ab-441c-b5db-55f51c855a11 \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"variant\": {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a11\",\n \"revision\": \"1\",\n \"name\": \"Medium\"\n },\n \"mask\": {\n \"paths\": [\n \"name\"\n ]\n }\n }'","response":"{\n \"variant\": {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a11\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-12-04T08:12:01.896Z\",\n \"updatedDate\": \"2023-12-04T08:38:47.940Z\",\n \"name\": \"Medium\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"patch","path":"/v1/variants/{variant.id}","rpcOnly":false,"triggeredEvents":[{"title":"Item Variant Updated","description":"Triggered when an item variant is updated.","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.restaurants.menus.v1.item_variant_updated","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.UpdateVariantRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.UpdateVariantResponse"},"legacyExamples":[{"name":"UpdateVariant","type":"METHOD","content":{"title":"Update a variant","request":"curl -X PATCH https://www.wixapis.com/restaurants/item-variants/v1/variants/02042f01-58ab-441c-b5db-55f51c855a11?variantId=02042f01-58ab-441c-b5db-55f51c855a11 \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"variant\": {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a11\",\n \"revision\": \"1\",\n \"name\": \"Medium\"\n },\n \"mask\": {\n \"paths\": [\n \"name\"\n ]\n }\n }'","response":"{\n \"variant\": {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a11\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-12-04T08:12:01.896Z\",\n \"updatedDate\": \"2023-12-04T08:38:47.940Z\",\n \"name\": \"Medium\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Update Variant","slugifiedName":"update-variant"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Bulk Create Variants","description":"> **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n\nCreates multiple item variants.","operationId":"wix.restaurants.menus_item_variant.v1.VariantsService.BulkCreateVariants","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.BulkCreateVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/item-variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/item-variants","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateVariantsRequest","description":"","properties":{"variants":{"description":"Item variants details.","maxItems":100,"title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to receive the created item variants in the response.","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["variants"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Item Variant Created","description":"","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.restaurants.menus.v1.item_variant_created","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.BulkCreateVariantsRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.BulkCreateVariantsResponse"},"legacyExamples":[{"name":"BulkCreateVariants","type":"METHOD","content":{"title":"Create multiple variants","request":"curl -X POST https://www.wixapis.com/restaurants/item-variants/v1/bulk/variants/create \\\n -H 'Authorization: '\n --data-binary '{\n \"variants\": [\n {\n \"name\": \"Small\"\n },\n {\n \"name\": \"Medium\"\n },\n {\n \"name\": \"Large\"\n }\n ],\n \"returnEntity\": false\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"02042f01-58ab-441c-33db-55221c855c11\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"02022fe1-58ab-ee1c-33db-45521c855e11\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 3,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v1/bulk/variants/create","rpcOnly":false,"triggeredEvents":[{"title":"Item Variant Created","description":"","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.restaurants.menus.v1.item_variant_created","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.BulkCreateVariantsRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.BulkCreateVariantsResponse"},"legacyExamples":[{"name":"BulkCreateVariants","type":"METHOD","content":{"title":"Create multiple variants","request":"curl -X POST https://www.wixapis.com/restaurants/item-variants/v1/bulk/variants/create \\\n -H 'Authorization: '\n --data-binary '{\n \"variants\": [\n {\n \"name\": \"Small\"\n },\n {\n \"name\": \"Medium\"\n },\n {\n \"name\": \"Large\"\n }\n ],\n \"returnEntity\": false\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"02042f01-58ab-441c-33db-55221c855c11\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"02022fe1-58ab-ee1c-33db-45521c855e11\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 3,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Bulk Create Variants","slugifiedName":"bulk-create-variants"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Bulk Update Variants","description":"> **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n\nUpdates multiple item variants.\n\nEach time an item variant is updated, revision increments by 1. The existing revision must be included when updating variant. This ensures you're working with the latest item information, and it prevents unintended overwrites.\n\nUp to 100 item variants can be returned per request.","operationId":"wix.restaurants.menus_item_variant.v1.VariantsService.BulkUpdateVariants","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.BulkUpdateVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/item-variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/item-variants","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateVariantsRequest","description":"","properties":{"variants":{"description":"Item variants to be updated.","minItems":1,"maxItems":100,"title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.MaskedVariant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to receive the updated item variants in the response.","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["variants"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Item Variant Updated","description":"","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.restaurants.menus.v1.item_variant_updated","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.BulkUpdateVariantsRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.BulkUpdateVariantsResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v1/bulk/variants/update","rpcOnly":false,"triggeredEvents":[{"title":"Item Variant Updated","description":"","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.restaurants.menus.v1.item_variant_updated","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.BulkUpdateVariantsRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.BulkUpdateVariantsResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Bulk Update Variants","slugifiedName":"bulk-update-variants"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Query Variants","description":"> **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n\nRetrieves a list of item variants given the provided paging, filtering, and sorting. Up to 100 item variants can be returned per request.\n\nFor a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/supported-filters-and-sorting) article. To learn how to query item variants, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)","operationId":"wix.restaurants.menus_item_variant.v1.VariantsService.QueryVariants","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.QueryVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/restaurants/item-variants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/restaurants/item-variants","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryVariantsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.query.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.QueryVariantsRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.QueryVariantsResponse"},"legacyExamples":[{"name":"QueryVariants","type":"METHOD","content":{"title":"Query all variants by the name","request":"curl -X POST https://www.wixapis.com/restaurants/item-variants/v1/variants/query \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"sort\": [],\n \"filter\": {\n \"name\": \"Small\"\n }\n }\n }'","response":"{\n \"variants\": [\n {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a10\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-04T08:12:10.571Z\",\n \"updatedDate\": \"2023-12-04T08:12:10.571Z\",\n \"name\": \"Small\",\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v1/variants/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["RESTAURANTS.VARIANT_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.restaurants:restaurants-menus-item-variant","serviceArtifactId":"com.wixpress.restaurants.restaurants-menus-item-variant","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.restaurants.menus_item_variant.v1.QueryVariantsRequest","responseMessage":"wix.restaurants.menus_item_variant.v1.QueryVariantsResponse"},"legacyExamples":[{"name":"QueryVariants","type":"METHOD","content":{"title":"Query all variants by the name","request":"curl -X POST https://www.wixapis.com/restaurants/item-variants/v1/variants/query \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"sort\": [],\n \"filter\": {\n \"name\": \"Small\"\n }\n }\n }'","response":"{\n \"variants\": [\n {\n \"id\": \"02042f01-58ab-441c-b5db-55f51c855a10\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-04T08:12:10.571Z\",\n \"updatedDate\": \"2023-12-04T08:12:10.571Z\",\n \"name\": \"Small\",\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Query Variants","slugifiedName":"query-variants"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"webhooks":[{"summary":"Item Variant Created","title":"Item Variant Created","description":"","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"eventType":"wix.restaurants.menus.v1.item_variant_created","legacyExamples":[{"name":"ItemVariantCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.restaurants.menus.v1.item_variant\",\n \"slug\": \"created\",\n \"entityId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\":1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"name\": \"Small\"\n }\n },\n \"eventTime\": \"2020-10-18T13:40:58.304800Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","contentLink":{"displayName":"Item Variant Created","slugifiedName":"item-variant-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Item Variant Updated","title":"Item Variant Updated","description":"","permissions":["RESTAURANTS.VARIANT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.restaurants.menus.v1.item_variant","serviceName":"wix.restaurants.menus_item_variant.v1.VariantsService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Restaurants Menus","scopeId":"SCOPE.RESTAURANTS.MODIFY_MENUS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"eventType":"wix.restaurants.menus.v1.item_variant_updated","legacyExamples":[{"name":"ItemVariantUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.restaurants.menus.v1.item_variant\",\n \"slug\": \"updated\",\n \"entityId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-01-14T12:41:35.833Z\",\n \"updatedDate\": \"2024-01-14T12:42:53.067Z\", \n \"name\": \"Medium\"\n }\n },\n \"eventTime\": \"2020-10-18T13:40:58.304800Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"2\"\n}"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","contentLink":{"displayName":"Item Variant Updated","slugifiedName":"item-variant-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Item Variants\n\nThe Item Variants API allows you to manage the pricing options applied to menu items. Item variants are determined by specific parameters like size, base ingredient, quantity and other customizable attributes. For example, you can have a raspberry lemonade with sizes \"small\", \"medium\", and \"large\", where pricing for each size is different. \n\nThe same item variant can be used across various menu items for better flexibility and consistency. \n\nWith the Item Variants API, you can:\n\n- Create, delete, and update item variants.\n- Retrieve the information about item variants.\n\n## Before you begin\n\nIt's important to note the following point before starting to code:\n\n- The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](fallback::https://www.wix.com/app-market/wix-restaurants-menus-new).\n\n## Use cases\n\n- [Sync pizza menu across all sites](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4c1c53e0-a1ac-454e-8f00-73cbeafc4bc7slug::sample-uses-cases-and-flows*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/sample-uses-cases-and-flows)\n","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","path":"proto/appendices/docs/introduction.md"},{"displayName":"Sample Uses Cases and Flows","slugifyName":"sample-uses-cases-and-flows","content":"# Item Variants: Sample Use Cases & Flows\n\nThis article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.\n\n## Sync pizza menu across all sites\n\nIf you have several pizzeria sites that use your app you might need to sync menu across those sites. For example, if there are new variants for a drink called \"Small\", \"Medium\", and \"Large\", this change also needs to be reflected on other sites. \n\nTo sync the pizza menu across all sites:\n\n1. Call [Query Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4c1c53e0-a1ac-454e-8f00-73cbeafc4bc7slug::query-variants*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/query-variants) by the `name` field on the site where you updated the menu.\n1. Extract all 3 `variant.name` field values.\n1. Call [Bulk Create Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4c1c53e0-a1ac-454e-8f00-73cbeafc4bc7slug::bulk-create-variants*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/bulk-create-variants) for your other sites and pass the new variants to each.\n1. Call [Update Item](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ad26d386-d18b-4166-9c20-7c04fa3d5e12slug::update-item*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item/update-item) and add the new variant IDs to the `item.priceVariants.variants` array.","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","path":"proto/appendices/docs/sample-flows.md"},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Item Variants: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the item variants object:\n\n| Field | Supported Filters | Sortable |\n| -------------------------------------------------| ------------------------------------------ | -------- |\n| `id` | `$eq`, `$ne`, `$in`, `$nin` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `name` | `$eq`, `$ne`, `$in`, `$nin` | Sortable |\n\n**Related content:**\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Variants](fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/menus/item-variants/query-variants).\n","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","path":"proto/appendices/docs/supported-filters-and-sorting.md"}],"components":{"schemas":{"wix.restaurants.menus_item_variant.v1.Variant":{"type":"object","properties":{"id":{"description":"Item variant ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the item variant is updated. To prevent conflicting changes, the current revision must be passed when updating the item variant. Ignored when creating an item variant.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the item variant was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the item variant was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Item variant name.","minLength":1,"maxLength":40,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Extended fields.","$ref":"#/components/schemas/wix.common.data.dataextensions.ExtendedFields","summary":"extendedFields","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Variant","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.common.data.dataextensions.ExtendedFields":{"type":"object","properties":{"namespaces":{"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).","title":"namespaces","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Struct"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedFields","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache":{"type":"object","properties":{"reason":{"description":"tell us why you're invalidating the cache. You don't need to add your app name","maxLength":256,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"localDc":{"description":"Is local DS","title":"localDc","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvalidateCache","description":"","oneOf":[{"description":"","summary":"getBy","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.getBy"}]},"com.wixpress.html.cache.invalidate.InvalidateCache.getBy":{"type":"object","title":"getBy","properties":{"metaSiteId":{"description":"Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"app":{"description":"Invalidate by App","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.App","summary":"app","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"page":{"description":"Invalidate by page id","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.Page","summary":"page","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uri":{"description":"Invalidate by URI path","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.URI","summary":"uri","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"file":{"description":"Invalidate by file (for media files such as PDFs)","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.File","summary":"file","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.html.cache.invalidate.InvalidateCache.App":{"type":"object","properties":{"appDefId":{"description":"The AppDefId","minLength":1,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The instance Id","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"App","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.Page":{"type":"object","properties":{"metaSiteId":{"description":"the msid the page is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageId":{"description":"Invalidate by Page ID","minLength":1,"title":"pageId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Page","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.URI":{"type":"object","properties":{"metaSiteId":{"description":"the msid the URI is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uriPath":{"description":"URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes","minLength":1,"title":"uriPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"URI","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.File":{"type":"object","properties":{"metaSiteId":{"description":"the msid the file is related to","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Invalidate by filename (for media files such as PDFs)","minLength":1,"maxLength":256,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"File","description":""},"wix.restaurants.menus_item_variant.v1.CreateVariantRequest":{"type":"object","properties":{"variant":{"description":"Item variant info.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateVariantRequest","description":""},"wix.restaurants.menus_item_variant.v1.CreateVariantResponse":{"type":"object","properties":{"variant":{"description":"Item variant.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateVariantResponse","description":""},"wix.restaurants.menus_item_variant.v1.GetVariantRequest":{"type":"object","properties":{"variantId":{"description":"ID of the item variant to retrieve.","format":"GUID","title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetVariantRequest","description":""},"wix.restaurants.menus_item_variant.v1.GetVariantResponse":{"type":"object","properties":{"variant":{"description":"Item variant.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetVariantResponse","description":""},"wix.restaurants.menus_item_variant.v1.ListVariantsRequest":{"type":"object","properties":{"variantIds":{"description":"Item variant IDs.","format":"GUID","maxItems":200,"title":"variantIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"The metadata of the paginated results.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListVariantsRequest","description":""},"wix.restaurants.menus_item_variant.v1.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":200,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.restaurants.menus_item_variant.v1.ListVariantsResponse":{"type":"object","properties":{"variants":{"description":"The retrieved item variants.","title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"The metadata of the paginated results.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.common.CursorPagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListVariantsResponse","description":""},"wix.restaurants.menus_item_variant.v1.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Offset that was requested.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Indicates if there are more results after the current page.\nIf `true`, another page of results can be retrieved.\nIf `false`, this is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.restaurants.menus_item_variant.v1.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.restaurants.menus_item_variant.v1.UpdateVariantRequest":{"type":"object","properties":{"variant":{"description":"Item variant to update.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateVariantRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.restaurants.menus_item_variant.v1.UpdateVariantResponse":{"type":"object","properties":{"variant":{"description":"Updated item variant.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateVariantResponse","description":""},"wix.restaurants.menus_item_variant.v1.BulkCreateVariantsRequest":{"type":"object","properties":{"variants":{"description":"Item variants details.","maxItems":100,"title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to receive the created item variants in the response.","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateVariantsRequest","description":""},"wix.restaurants.menus_item_variant.v1.BulkCreateVariantsResponse":{"type":"object","properties":{"results":{"description":"Information about the created item variants.","title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.BulkVariantResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Metadata for the API call.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateVariantsResponse","description":""},"wix.restaurants.menus_item_variant.v1.BulkVariantResult":{"type":"object","properties":{"itemMetadata":{"description":"Metadata for creation of item variants.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variant":{"description":"Created item variants. Only returned if the `returnEntity` value is `true`.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkVariantResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"wix.restaurants.menus_item_variant.v1.BulkUpdateVariantsRequest":{"type":"object","properties":{"variants":{"description":"Item variants to be updated.","minItems":1,"maxItems":100,"title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.MaskedVariant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to receive the updated item variants in the response.","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateVariantsRequest","description":""},"wix.restaurants.menus_item_variant.v1.MaskedVariant":{"type":"object","properties":{"variant":{"description":"Item variant to update.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant","summary":"variant","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedVariant","description":""},"wix.restaurants.menus_item_variant.v1.BulkUpdateVariantsResponse":{"type":"object","properties":{"results":{"description":"Information about the updated item variants.","minItems":1,"maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.BulkVariantResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Metadata for the API call.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateVariantsResponse","description":""},"wix.restaurants.menus_item_variant.v1.DeleteVariantRequest":{"type":"object","properties":{"variantId":{"description":"Item variant ID.","format":"GUID","title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteVariantRequest","description":""},"wix.restaurants.menus_item_variant.v1.DeleteVariantResponse":{"type":"object","properties":{},"title":"DeleteVariantResponse","description":""},"wix.restaurants.menus_item_variant.v1.QueryVariantsRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.query.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryVariantsRequest","description":""},"wix.restaurants.menus_item_variant.v1.upstream.wix.query.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","maxItems":4,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.query.CursorQuery.pagingMethod"}]},"wix.restaurants.menus_item_variant.v1.upstream.wix.query.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.restaurants.menus_item_variant.v1.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":64,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.restaurants.menus_item_variant.v1.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.restaurants.menus_item_variant.v1.QueryVariantsResponse":{"type":"object","properties":{"variants":{"description":"Retrieved item variants.","title":"variants","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.Variant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Metadata of the paginated results.","$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryVariantsResponse","description":""},"wix.restaurants.menus_item_variant.v1.CloneVariantsRequest":{"type":"object","properties":{"metaSiteId":{"description":"The MetaSiteId to clone from","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CloneVariantsRequest","description":""},"wix.restaurants.menus_item_variant.v1.CloneVariantsResponse":{"type":"object","properties":{},"title":"CloneVariantsResponse","description":""},"wix.restaurants.menus_item_variant.v1.BulkDeleteVariantsRequest":{"type":"object","properties":{"ids":{"description":"Item variant IDs.","format":"GUID","maxItems":200,"title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteVariantsRequest","description":""},"wix.restaurants.menus_item_variant.v1.BulkDeleteVariantsResponse":{"type":"object","properties":{"results":{"description":"Information about the deleted variants.","title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.restaurants.menus_item_variant.v1.BulkDeleteVariantsResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Metadata for the API call.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteVariantsResponse","description":""},"wix.restaurants.menus_item_variant.v1.BulkDeleteVariantsResult":{"type":"object","properties":{"itemMetadata":{"description":"Metadata for variants deletion.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteVariantsResult","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Item Variant","description":"","fqdn":"wix.restaurants.menus.v1.item_variant"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Item Variants\n\nThe Item Variants API allows you to manage the pricing options applied to menu items. Item variants are determined by specific parameters like size, base ingredient, quantity and other customizable attributes. For example, you can have a raspberry lemonade with sizes \"small\", \"medium\", and \"large\", where pricing for each size is different. \n\nThe same item variant can be used across various menu items for better flexibility and consistency. \n\nWith the Item Variants API, you can:\n\n- Create, delete, and update item variants.\n- Retrieve the information about item variants.\n\n## Before you begin\n\nIt's important to note the following point before starting to code:\n\n- The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](fallback::https://www.wix.com/app-market/wix-restaurants-menus-new).\n\n## Use cases\n\n- [Sync pizza menu across all sites](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4c1c53e0-a1ac-454e-8f00-73cbeafc4bc7slug::sample-uses-cases-and-flows*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/sample-uses-cases-and-flows)\n"},{"displayName":"Sample Uses Cases and Flows","slugifyName":"sample-uses-cases-and-flows","content":"# Item Variants: Sample Use Cases & Flows\n\nThis article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.\n\n## Sync pizza menu across all sites\n\nIf you have several pizzeria sites that use your app you might need to sync menu across those sites. For example, if there are new variants for a drink called \"Small\", \"Medium\", and \"Large\", this change also needs to be reflected on other sites. \n\nTo sync the pizza menu across all sites:\n\n1. Call [Query Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4c1c53e0-a1ac-454e-8f00-73cbeafc4bc7slug::query-variants*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/query-variants) by the `name` field on the site where you updated the menu.\n1. Extract all 3 `variant.name` field values.\n1. Call [Bulk Create Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4c1c53e0-a1ac-454e-8f00-73cbeafc4bc7slug::bulk-create-variants*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/bulk-create-variants) for your other sites and pass the new variants to each.\n1. Call [Update Item](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ad26d386-d18b-4166-9c20-7c04fa3d5e12slug::update-item*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item/update-item) and add the new variant IDs to the `item.priceVariants.variants` array."},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Item Variants: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the item variants object:\n\n| Field | Supported Filters | Sortable |\n| -------------------------------------------------| ------------------------------------------ | -------- |\n| `id` | `$eq`, `$ne`, `$in`, `$nin` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `name` | `$eq`, `$ne`, `$in`, `$nin` | Sortable |\n\n**Related content:**\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Variants](fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/menus/item-variants/query-variants).\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Field	Supported Filters	Sortable
`id`	`$eq`, `$ne`, `$in`, `$nin`	Sortable
`createdDate`	`$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`	Sortable
`updatedDate`	`$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`	Sortable
`name`	`$eq`, `$ne`, `$in`, `$nin`	Sortable