inner content

{"id":"e6eb1a39-bae4-4b8e-b5f1-bbc6508484a0","createdDate":"2024-06-02T10:46:53.314Z","updatedDate":"2024-06-02T10:46:53.314Z","resourceId":"ddd7c621-7b08-406b-ae54-d14d68f4ae81","api":{"schema":{"object":{"displayName":"Service Options And Variants Object","description":"The `serviceOptionsAndVariants` object links a service to its variants.\nYou can use it to offer customers different prices for a service,\ndepending on which choices they book.\nRead more about [service options and variants](https://wix.wixanswers.com/app/kb/article/2e91a25b-b3c2-4cf7-9005-429a4929fc36/en).","slug":"service-options-and-variants-object","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","legacyExamples":[{"title":"ServiceOptionsAndVariants","content":"title: Example of custom options and variants\n\n\n{\n \"id\": \"82802f2e-a54f-404f-a1b2-de5a9a9b9885\",\n \"serviceId\": \"7a5fa965-ba64-46a5-9fbb-76fde4401d28\",\n \"options\": {\n \"values\": [\n {\n \"id\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Client Type\",\n \"choices\": [\n \"Student\",\n \"Adult\"\n ]\n }\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"5\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"22\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"minPrice\": {\n \"value\": \"5\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"22\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n}\n"},{"title":"ServiceOptionsAndVariants","content":"title: Example of staff member-based options and variants\n\n\n{\n \"serviceOptionsAndVariants\": {\n \"id\": \"0cf0c708-58f0-408b-a10f-a6d9b6e2a6de\",\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [\n {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n }\n ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n }\n ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n }\n ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n }\n ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/scheduler.git"},"methods":[{"summary":"Create Service Options And Variants","description":"Creates options and variants for a service.\n\nBefore creating the `serviceOptionsAndVariants` object you need to anticipate and manually define\nall variants based on the defined options and their choices. You then pass\nthe `options` and `variants` arrays in the\nrequest. Variants aren't automatically calculated from the defined options and choices.\n\n__Current Limitations:__\n\n+ Only a single `serviceOptionsAndVariants` object is supported per service.\n\n+ Only a single option is supported per `serviceOptionsAndVariants` object. This means that services are limited to a single option. Therefore, `variants`provides pricing details for either all choices of the single option (for `CUSTOM` options) or all staff members providing the service (for `STAFF_MEMBER` options).\n\nFor a list of error messages, see [Create Service Options and Variants Errors](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/error-messages#service-options-and-variants_error-messages_create-service-options-and-variants-errors).","operationId":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService.CreateServiceOptionsAndVariants","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.CreateServiceOptionsAndVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/bookings/v1/serviceOptionsAndVariants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/bookings/v1/serviceOptionsAndVariants","destinationPath":"/v1/serviceOptionsAndVariants","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateServiceOptionsAndVariantsRequest","description":"","properties":{"serviceOptionsAndVariants":{"description":"Service options and variants to create.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceOptionsAndVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["serviceOptionsAndVariants","serviceOptionsAndVariants.serviceId","serviceOptionsAndVariants.options","serviceOptionsAndVariants.variants"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Service Options And Variants Created","description":"Triggered when a `serviceOptionsAndVariants` object is created.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_created","sourceRepo":"git@github.com:wix-private/scheduler.git"}],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNKNOWN_OPTION_IDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MULTIPLE_CURRENCIES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_OPTION_TYPE"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNKNOWN_STAFF_IDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_STAFF_VARIANTS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"IDENTICAL_CHOICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_CUSTOM_CHOICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NEGATIVE_PRICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_OPTION_DATA"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_CREATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.CreateServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.CreateServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"CreateServiceOptionsAndVariants","type":"METHOD","order":1,"content":{"title":"Create custom options and variants for a service","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants' \\\n-H 'Authorization: ' \\\n-d '{\n \"serviceOptionsAndVariants\": {\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [ {\n \"customData\": {\n \"choices\": [\"Student\",\"Adult\"],\n \"name\": \"Customer Type\"\n },\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\"\n }\n ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n } ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"3\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n } ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"12\"\n }\n } ]\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\",\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [ {\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Customer Type\",\n \"choices\": [\"Student\",\"Adult\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n } ],\n \"price\": {\n \"value\": \"3\",\n \"currency\": \"EUR\"\n } \n },\n {\n \"choices\": [ {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n } ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"3\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}},{"name":"CreateServiceOptionsAndVariants","type":"METHOD","order":2,"content":{"title":"Create staff member-based options and variants for a service","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants' \\\n-H 'Authorization: ' \\\n-d '{\n \"serviceOptionsAndVariants\": {\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [ {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\",\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\"\n } ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"55\"\n }\n },\n {\n \"choices\": [ {\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\",\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\"\n } ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"105\"\n }\n },\n {\n \"choices\": [\n {\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\",\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\"\n }\n ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"50\"\n }\n },\n {\n \"choices\": [\n {\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\",\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\"\n }\n ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"60\"\n }\n }\n ]\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"0cf0c708-58f0-408b-a10f-a6d9b6e2a6de\",\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [ {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n } ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n } ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n } ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git"},"httpMethod":"post","path":"/v1/serviceOptionsAndVariants","rpcOnly":false,"triggeredEvents":[{"title":"Service Options And Variants Created","description":"Triggered when a `serviceOptionsAndVariants` object is created.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_created","sourceRepo":"git@github.com:wix-private/scheduler.git"}],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNKNOWN_OPTION_IDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MULTIPLE_CURRENCIES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_OPTION_TYPE"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNKNOWN_STAFF_IDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_STAFF_VARIANTS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"IDENTICAL_CHOICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_CUSTOM_CHOICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NEGATIVE_PRICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_OPTION_DATA"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_CREATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.CreateServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.CreateServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"CreateServiceOptionsAndVariants","type":"METHOD","order":1,"content":{"title":"Create custom options and variants for a service","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants' \\\n-H 'Authorization: ' \\\n-d '{\n \"serviceOptionsAndVariants\": {\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [ {\n \"customData\": {\n \"choices\": [\"Student\",\"Adult\"],\n \"name\": \"Customer Type\"\n },\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\"\n }\n ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n } ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"3\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n } ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"12\"\n }\n } ]\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\",\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [ {\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Customer Type\",\n \"choices\": [\"Student\",\"Adult\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n } ],\n \"price\": {\n \"value\": \"3\",\n \"currency\": \"EUR\"\n } \n },\n {\n \"choices\": [ {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n } ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"3\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}},{"name":"CreateServiceOptionsAndVariants","type":"METHOD","order":2,"content":{"title":"Create staff member-based options and variants for a service","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants' \\\n-H 'Authorization: ' \\\n-d '{\n \"serviceOptionsAndVariants\": {\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [ {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\",\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\"\n } ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"55\"\n }\n },\n {\n \"choices\": [ {\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\",\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\"\n } ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"105\"\n }\n },\n {\n \"choices\": [\n {\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\",\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\"\n }\n ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"50\"\n }\n },\n {\n \"choices\": [\n {\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\",\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\"\n }\n ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"60\"\n }\n }\n ]\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"0cf0c708-58f0-408b-a10f-a6d9b6e2a6de\",\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [ {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n } ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n } ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n } ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git","contentLink":{"displayName":"Create Service Options And Variants","slugifiedName":"create-service-options-and-variants"}},{"summary":"Clone Service Options And Variants","description":"Clones a `serviceOptionsAndVariants` object. This endpoint can be called, for example, to duplicate a service.\nThe cloned service contains all the original service options and variants.\n\nEach option\nin the cloned service has a newly-generated ID that is copied to all choices of the variants in the\nclone. The cloned service references the service provided in the request by `target_service_id`.","operationId":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService.CloneServiceOptionsAndVariants","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"cloneFromId","description":"ID of the `serviceOptionsAndVariants` object to clone.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.CloneServiceOptionsAndVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/bookings/v1/serviceOptionsAndVariants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/bookings/v1/serviceOptionsAndVariants","destinationPath":"/v1/serviceOptionsAndVariants","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CloneServiceOptionsAndVariantsRequest","description":"","properties":{"targetServiceId":{"description":"ID of the service that will be set for the cloned `serviceOptionsAndVariants`","format":"GUID","title":"targetServiceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["cloneFromId","targetServiceId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Service Options And Variants Created","description":"Triggered when a `serviceOptionsAndVariants` object is created by cloning from the source object.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_created","sourceRepo":"git@github.com:wix-private/scheduler.git"}],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_CREATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.CloneServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.CloneServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"CloneServiceOptionsAndVariants","type":"METHOD","content":{"title":"Clone options and variants for a service","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/0cf0c708-58f0-408b-a10f-a6d9b6e2a6de/clone' \\\n-H 'Authorization: ' \\\n-d '{\n \"targetServiceId\": \"cea2bc29-9f05-4523-a4d7-cd52983b43dc\"\n}'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"6f6a0b65-dd9f-497f-8e29-88518b6aed26\",\n \"serviceId\": \"cea2bc29-9f05-4523-a4d7-cd52983b43dc\",\n \"options\": {\n \"values\": [ {\n \"id\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n }\n ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n }\n ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n }\n ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git"},"httpMethod":"post","path":"/v1/serviceOptionsAndVariants/{cloneFromId}/clone","rpcOnly":false,"triggeredEvents":[{"title":"Service Options And Variants Created","description":"Triggered when a `serviceOptionsAndVariants` object is created by cloning from the source object.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_created","sourceRepo":"git@github.com:wix-private/scheduler.git"}],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_CREATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.CloneServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.CloneServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"CloneServiceOptionsAndVariants","type":"METHOD","content":{"title":"Clone options and variants for a service","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/0cf0c708-58f0-408b-a10f-a6d9b6e2a6de/clone' \\\n-H 'Authorization: ' \\\n-d '{\n \"targetServiceId\": \"cea2bc29-9f05-4523-a4d7-cd52983b43dc\"\n}'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"6f6a0b65-dd9f-497f-8e29-88518b6aed26\",\n \"serviceId\": \"cea2bc29-9f05-4523-a4d7-cd52983b43dc\",\n \"options\": {\n \"values\": [ {\n \"id\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n }\n ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n }\n ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"e60a6e55-bd30-4610-8d7e-dfa8ecd2293a\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n }\n ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git","contentLink":{"displayName":"Clone Service Options And Variants","slugifiedName":"clone-service-options-and-variants"}},{"summary":"Get Service Options And Variants","description":"Retrieves a `serviceOptionsAndVariants` object by `service_options_and_variants_id`.","operationId":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService.GetServiceOptionsAndVariants","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"serviceOptionsAndVariantsId","description":"ID of the `serviceOptionsAndVariants` object to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.GetServiceOptionsAndVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/bookings/v1/serviceOptionsAndVariants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/bookings/v1/serviceOptionsAndVariants","destinationPath":"/v1/serviceOptionsAndVariants","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"GetServiceOptionsAndVariants","type":"METHOD","content":{"title":"Retrieve options and variants by ID","request":"curl -X GET \\ \n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/0cf0c708-58f0-408b-a10f-a6d9b6e2a6de' \\\n-H 'Authorization: '","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"0cf0c708-58f0-408b-a10f-a6d9b6e2a6de\",\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [ {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n }\n ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n }\n ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n }\n ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git"},"httpMethod":"get","path":"/v1/serviceOptionsAndVariants/{serviceOptionsAndVariantsId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"GetServiceOptionsAndVariants","type":"METHOD","content":{"title":"Retrieve options and variants by ID","request":"curl -X GET \\ \n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/0cf0c708-58f0-408b-a10f-a6d9b6e2a6de' \\\n-H 'Authorization: '","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"0cf0c708-58f0-408b-a10f-a6d9b6e2a6de\",\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [ {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n }\n ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n }\n ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n }\n ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git","contentLink":{"displayName":"Get Service Options And Variants","slugifiedName":"get-service-options-and-variants"}},{"summary":"Delete Service Options And Variants","description":"Deletes a `serviceOptionsAndVariants` object.\n\n\nBecause each service has only a single `serviceOptionsAndVariants` object, the\nservice won't have any supported options and variants any longer. Instead,\nthe standard Wix Bookings service price calculation is used.","operationId":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService.DeleteServiceOptionsAndVariants","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"serviceOptionsAndVariantsId","description":"ID of the `serviceOptionsAndVariants` object to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"revision","in":"query","description":"Revision of the `serviceOptionsAndVariants` object to delete.","required":false,"schema":{"description":"Revision of the `serviceOptionsAndVariants` object to delete.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.DeleteServiceOptionsAndVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/bookings/v1/serviceOptionsAndVariants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/bookings/v1/serviceOptionsAndVariants","destinationPath":"/v1/serviceOptionsAndVariants","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Service Options And Variants Deleted","description":"Triggered when a `serviceOptionsAndVariants` object is deleted.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_deleted","sourceRepo":"git@github.com:wix-private/scheduler.git"}],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_DELETE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.DeleteServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.DeleteServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"DeleteServiceOptionsAndVariants","type":"METHOD","content":{"title":"Delete a set of options and variants","request":"curl -X DELETE \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/cee77f8c-2ad3-11ed-a261-0242ac120002' \\\n-H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git"},"httpMethod":"delete","path":"/v1/serviceOptionsAndVariants/{serviceOptionsAndVariantsId}","rpcOnly":false,"triggeredEvents":[{"title":"Service Options And Variants Deleted","description":"Triggered when a `serviceOptionsAndVariants` object is deleted.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_deleted","sourceRepo":"git@github.com:wix-private/scheduler.git"}],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_DELETE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.DeleteServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.DeleteServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"DeleteServiceOptionsAndVariants","type":"METHOD","content":{"title":"Delete a set of options and variants","request":"curl -X DELETE \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/cee77f8c-2ad3-11ed-a261-0242ac120002' \\\n-H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git","contentLink":{"displayName":"Delete Service Options And Variants","slugifiedName":"delete-service-options-and-variants"}},{"summary":"Get Service Options And Variants By Service Id","description":"Retrieves a service's options and variants by `service_id`.","operationId":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService.GetServiceOptionsAndVariantsByServiceId","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"serviceId","description":"ID of the service to retrieve options and variants for.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.GetServiceOptionsAndVariantsByServiceIdResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/bookings/v1/serviceOptionsAndVariants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/bookings/v1/serviceOptionsAndVariants","destinationPath":"/v1/serviceOptionsAndVariants","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsByServiceIdRequest","responseMessage":"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsByServiceIdResponse"},"legacyExamples":[{"name":"GetServiceOptionsAndVariantsByServiceId","type":"METHOD","content":{"title":"Retrieve options and variants for a specific service","request":"curl -X GET \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/service_id/33340481-e57e-4285-8e31-4f0b5ca0a6b5' \\\n-H 'Authorization: '","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"0cf0c708-58f0-408b-a10f-a6d9b6e2a6de\",\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [ {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n } ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n } ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n } ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git"},"httpMethod":"get","path":"/v1/serviceOptionsAndVariants/service_id/{serviceId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsByServiceIdRequest","responseMessage":"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsByServiceIdResponse"},"legacyExamples":[{"name":"GetServiceOptionsAndVariantsByServiceId","type":"METHOD","content":{"title":"Retrieve options and variants for a specific service","request":"curl -X GET \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/service_id/33340481-e57e-4285-8e31-4f0b5ca0a6b5' \\\n-H 'Authorization: '","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"0cf0c708-58f0-408b-a10f-a6d9b6e2a6de\",\n \"serviceId\": \"33340481-e57e-4285-8e31-4f0b5ca0a6b5\",\n \"options\": {\n \"values\": [ {\n \"id\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"55\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n } ],\n \"price\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n } ],\n \"price\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"ae6ecb80-5013-4e6c-95f4-20708583f72d\",\n \"staffMemberId\": \"9a3d4d6c-0ff9-4671-9fad-0aa2cbcd8b0f\"\n } ],\n \"price\": {\n \"value\": \"60\",\n \"currency\": \"EUR\"\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"50\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"105\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git","contentLink":{"displayName":"Get Service Options And Variants By Service Id","slugifiedName":"get-service-options-and-variants-by-service-id"}},{"summary":"Update Service Options And Variants","description":"Updates the specified fields of the `serviceOptionsAndVariants` object.\n\nCurrently, only a single option is supported per `serviceOptionsAndVariants` object.\n\nIf you want to update `variants`, you must pass the full list of supported variants.\n\nIf you want to update `options`, you must pass the full list of supported options.\n\nFor a list of error messages, see [Update Service Options and Variants Errors](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/error-messages#service-options-and-variants_error-messages_update-service-options-and-variants-errors).","operationId":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService.UpdateServiceOptionsAndVariants","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"serviceOptionsAndVariants.id","description":"ID of the `serviceOptionsAndVariants` object.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.UpdateServiceOptionsAndVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/bookings/v1/serviceOptionsAndVariants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/bookings/v1/serviceOptionsAndVariants","destinationPath":"/v1/serviceOptionsAndVariants","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateServiceOptionsAndVariantsRequest","description":"","properties":{"serviceOptionsAndVariants":{"description":"`ServiceOptionsAndVariants` object to update.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceOptionsAndVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["serviceOptionsAndVariants","serviceOptionsAndVariants.id","serviceOptionsAndVariants.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Service Options And Variants Updated","description":"Triggered when a `serviceOptionsAndVariants` object is updated.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_updated","sourceRepo":"git@github.com:wix-private/scheduler.git"}],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNKNOWN_OPTION_IDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MULTIPLE_CURRENCIES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_OPTION_TYPE"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNKNOWN_STAFF_IDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_STAFF_VARIANTS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"IDENTICAL_CHOICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_CUSTOM_CHOICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NEGATIVE_PRICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_OPTION_DATA"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_UPDATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.UpdateServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.UpdateServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"UpdateServiceOptionsAndVariants","type":"METHOD","order":2,"content":{"title":"Update the price of a single variant.","request":"curl -X PATCH \\ \n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/7e7eac53-21c9-41fd-844b-25b287aa38ce' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"serviceOptionsAndVariants\": {\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [\n {\n \"customData\": {\n \"choices\": [\n \"Student\",\n \"Adult\"\n ],\n \"name\": \"Customer Type\"\n },\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\"\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"revision\": \"1\",\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\"\n }\n }'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\",\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [\n {\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Customer Type\",\n \"choices\": [\n \"Student\",\n \"Adult\"\n ]\n }\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"minPrice\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"2\"\n }\n}"}},{"name":"UpdateServiceOptionsAndVariants","type":"METHOD","order":1,"content":{"title":"Full update of a `serviceOptionsAndVariants` object.","request":"curl -X PATCH \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/7e7eac53-21c9-41fd-844b-25b287aa38ce' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"serviceOptionsAndVariants\": {\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [\n {\n \"customData\": {\n \"choices\": [\n \"Student\",\n \"Adult\",\n \"Child\"\n ],\n \"name\": \"Customer Type\"\n },\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\"\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Child\"\n }\n ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"5\"\n }\n }\n ]\n },\n \"revision\": \"1\",\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\"\n }\n }'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\",\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [\n {\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Customer Type\",\n \"choices\": [\n \"Student\",\n \"Adult\",\n \"Child\"\n ]\n }\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Child\"\n }\n ],\n \"price\": {\n \"value\": \"5\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"minPrice\": {\n \"value\": \"5\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"2\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git"},"httpMethod":"patch","path":"/v1/serviceOptionsAndVariants/{serviceOptionsAndVariants.id}","rpcOnly":false,"triggeredEvents":[{"title":"Service Options And Variants Updated","description":"Triggered when a `serviceOptionsAndVariants` object is updated.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_updated","sourceRepo":"git@github.com:wix-private/scheduler.git"}],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNKNOWN_OPTION_IDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MULTIPLE_CURRENCIES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_OPTION_TYPE"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNKNOWN_STAFF_IDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_STAFF_VARIANTS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"IDENTICAL_CHOICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_CUSTOM_CHOICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NEGATIVE_PRICES"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_OPTION_DATA"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_UPDATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.UpdateServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.UpdateServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"UpdateServiceOptionsAndVariants","type":"METHOD","order":2,"content":{"title":"Update the price of a single variant.","request":"curl -X PATCH \\ \n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/7e7eac53-21c9-41fd-844b-25b287aa38ce' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"serviceOptionsAndVariants\": {\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [\n {\n \"customData\": {\n \"choices\": [\n \"Student\",\n \"Adult\"\n ],\n \"name\": \"Customer Type\"\n },\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\"\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"revision\": \"1\",\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\"\n }\n }'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\",\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [\n {\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Customer Type\",\n \"choices\": [\n \"Student\",\n \"Adult\"\n ]\n }\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"minPrice\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"2\"\n }\n}"}},{"name":"UpdateServiceOptionsAndVariants","type":"METHOD","order":1,"content":{"title":"Full update of a `serviceOptionsAndVariants` object.","request":"curl -X PATCH \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/7e7eac53-21c9-41fd-844b-25b287aa38ce' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"serviceOptionsAndVariants\": {\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [\n {\n \"customData\": {\n \"choices\": [\n \"Student\",\n \"Adult\",\n \"Child\"\n ],\n \"name\": \"Customer Type\"\n },\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\"\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Child\"\n }\n ],\n \"price\": {\n \"currency\": \"EUR\",\n \"value\": \"5\"\n }\n }\n ]\n },\n \"revision\": \"1\",\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\"\n }\n }'","response":"{\n \"serviceOptionsAndVariants\": {\n \"id\": \"7e7eac53-21c9-41fd-844b-25b287aa38ce\",\n \"serviceId\": \"6072fbad-5c95-4bf6-a9bc-4280aadc1ae8\",\n \"options\": {\n \"values\": [\n {\n \"id\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Customer Type\",\n \"choices\": [\n \"Student\",\n \"Adult\",\n \"Child\"\n ]\n }\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"0b78af72-0ba0-4e71-ba39-b4386555a353\",\n \"custom\": \"Child\"\n }\n ],\n \"price\": {\n \"value\": \"5\",\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n \"minPrice\": {\n \"value\": \"5\",\n \"currency\": \"EUR\"\n },\n \"maxPrice\": {\n \"value\": \"12\",\n \"currency\": \"EUR\"\n },\n \"revision\": \"2\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git","contentLink":{"displayName":"Update Service Options And Variants","slugifiedName":"update-service-options-and-variants"}},{"summary":"Query Service Options And Variants","description":"Retrieves a list of `serviceOptionsAndVariants`, given the provided paging, filtering, and sorting.\n\nQuery Service Options And Variants runs with these defaults, which you can override:\n\n- `id` is sorted in `ASC` order\n- `cursorPaging.limit` is `100`\n\nFor a detailed list of supported filtering operations see\n[supported filters](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/supported-filters).\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),\nand [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).","operationId":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService.QueryServiceOptionsAndVariants","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.QueryServiceOptionsAndVariantsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/bookings/v1/serviceOptionsAndVariants","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/bookings/v1/serviceOptionsAndVariants","destinationPath":"/v1/serviceOptionsAndVariants","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryServiceOptionsAndVariantsRequest","description":"","properties":{"query":{"description":"Information about filters, paging, and returned fields.","$ref":"#/components/schemas/wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.QueryServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.QueryServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"QueryServiceOptionsAndVariants","type":"METHOD","order":2,"content":{"title":"Query custom options and variants, sorting by service ID and limiting the responses to 3 items","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/query ' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"sort\": [ {\n \"fieldName\": \"serviceId\",\n \"order\": \"DESC\"\n } ],\n \"fieldsets\": [],\n \"fields\": [],\n \"cursorPaging\": {\n \"limit\": 3\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariantsList\": [ {\n \"id\": \"15a1d2e7-167c-4c15-b345-aa45fd389256\",\n \"serviceId\": \"e0a9379b-d5d4-422e-8238-1ed3b4671ea9\",\n \"options\": {\n \"values\": [ {\n \"id\": \"2dd1dfa1-37ee-4aaa-9a3c-38fc7df1b728\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Age\",\n \"choices\": [ \"1-5\", \"5-16\", \"16+\" ] }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"2dd1dfa1-37ee-4aaa-9a3c-38fc7df1b728\",\n \"custom\": \"1-5\"\n } ],\n \"price\": {\n \"value\": \"2\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"2dd1dfa1-37ee-4aaa-9a3c-38fc7df1b728\",\n \"custom\": \"5-16\"\n } ],\n \"price\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"2dd1dfa1-37ee-4aaa-9a3c-38fc7df1b728\",\n \"custom\": \"16+\"\n } ],\n \"price\": {\n \"value\": \"20\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"2\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"20\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"4\"\n },\n {\n \"id\": \"a7b1ca08-d297-465b-869b-58496eb51b72\",\n \"serviceId\": \"da1bb1b9-541e-4a27-b1a1-59b7d6cdf07d\",\n \"options\": {\n \"values\": [ {\n \"id\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Favourite number\",\n \"choices\": [ \"1\", \"2\", \"3\", \"4\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"1\"\n } ],\n \"price\": {\n \"value\": \"2\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"2\"\n } ],\n \"price\": {\n \"value\": \"5\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"3\"\n } ],\n \"price\": {\n \"value\": \"6\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"4\"\n } ],\n \"price\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"2\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"3\"\n },\n {\n \"id\": \"5b31b4d4-b612-49e1-91b8-234bbd6413d2\",\n \"serviceId\": \"c0ecbd12-bea6-436a-8298-af4051f8256a\",\n \"options\": {\n \"values\": [ {\n \"id\": \"bd03f2e7-23ca-477f-9701-ee3eb84e711d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"bd03f2e7-23ca-477f-9701-ee3eb84e711d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"70\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"bd03f2e7-23ca-477f-9701-ee3eb84e711d\",\n \"staffMemberId\": \"9c32bba9-c381-43f7-af46-1319a8580120\"\n } ],\n \"price\": {\n \"value\": \"45\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"45\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"70\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"3\"\n } ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"offset\": null,\n \"total\": null,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": \"d86a982cdc306046bacbd2724e9a3ac0ad102341.GjUKCXNlcnZpY2VJZBABGiYaJGMwZWNiZDEyLWJlYTYtNDM2YS04Mjk4LWFmNDA1MWY4MjU2YSIkNWIzMWI0ZDQtYjYxMi00OWUxLTkxYjgtMjM0YmJkNjQxM2Qy\",\n \"prev\": null\n },\n \"hasNext\": true\n }\n}"}},{"name":"QueryServiceOptionsAndVariants","type":"METHOD","order":3,"content":{"title":"Query options and variants with a cursor from a previous request","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/query' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"sort\": [],\n \"fieldsets\": [],\n \"fields\": [],\n \"cursorPaging\": {\n \"limit\": 3,\n \"cursor\": \"d86a982cdc306046bacbd2724e9a3ac0ad102341.GjUKCXNlcnZpY2VJZBABGiYaJGMwZWNiZDEyLWJlYTYtNDM2YS04Mjk4LWFmNDA1MWY4MjU2YSIkNWIzMWI0ZDQtYjYxMi00OWUxLTkxYjgtMjM0YmJkNjQxM2Qy\"\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariantsList\": [ {\n \"id\": \"01634326-b960-483e-9a65-6cbfc778788e\",\n \"serviceId\": \"90d5a2e9-572d-4d7d-9c94-92e1ea986fc6\",\n \"options\": {\n \"values\": [ {\n \"id\": \"c13341d2-9781-49d9-a21a-3892da4b4384\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Color\",\n \"choices\": [\"Yellow\", \"Blue\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"c13341d2-9781-49d9-a21a-3892da4b4384\",\n \"custom\": \"Yellow\"\n } ],\n \"price\": null\n },\n {\n \"choices\": [ {\n \"optionId\": \"c13341d2-9781-49d9-a21a-3892da4b4384\",\n \"custom\": \"Blue\"\n } ],\n \"price\": null\n } ]\n },\n \"minPrice\": null,\n \"maxPrice\": null,\n \"revision\": \"3\"\n },\n {\n \"id\": \"82802f2e-a54f-404f-a1b2-de5a9a9b9885\",\n \"serviceId\": \"7a5fa965-ba64-46a5-9fbb-76fde4401d28\",\n \"options\": {\n \"values\": [ {\n \"id\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Color\",\n \"choices\": [\"Blue\",\"White\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"Blue\"\n } ],\n \"price\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"White\"\n } ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"8\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"1\"\n },\n {\n \"id\": \"e9e352fc-3ce4-4ad8-9360-0b107b909eb1\",\n \"serviceId\": \"7613837a-846e-4a2d-b218-77d17af7d082\",\n \"options\": {\n \"values\": [ {\n \"id\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"type\": \"STAFFMEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n } ],\n \"price\": {\n \"value\": \"15\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"staffMemberId\": \"76570209-101f-409b-af97-b445bdb63125\"\n } ],\n \"price\": {\n \"value\": \"16\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n } ],\n \"price\": {\n \"value\": \"17\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"12\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"17\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"2\"\n } ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"offset\": null,\n \"total\": null,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": \"d2f32c5a6ea98a7eaa394f66e605526d4a3e8521.GjUKCXNlcnZpY2VJZBABGiYaJDc2MTM4MzdhLTg0NmUtNGEyZC1iMjE4LTc3ZDE3YWY3ZDA4MiIkZTllMzUyZmMtM2NlNC00YWQ4LTkzNjAtMGIxMDdiOTA5ZWIx\",\n \"prev\": \"51fdf45d8387922752bee21bcf978d2f6fa3aeee.CAEaNQoJc2VydmljZUlkEAEaJhokOTBkNWEyZTktNTcyZC00ZDdkLTljOTQtOTJlMWVhOTg2ZmM2IiQwMTYzNDMyNi1iOTYwLTQ4M2UtOWE2NS02Y2JmYzc3ODc4OGU\"\n },\n \"hasNext\": true\n }\n}"}},{"name":"QueryServiceOptionsAndVariants","type":"METHOD","order":1,"content":{"title":"Query custom options and variants, filtering by option name","request":"curl -X POST \\ \n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/query' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"sort\": [],\n \"fieldsets\": [],\n \"fields\": [],\n \"filter\": {\n \"options.values.optionSpecificData.customData.name\": {\n \"$hasSome\": [\"Client type\"]\n }\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariantsList\": [ {\n \"id\": \"28b44cf3-e52d-4f49-a9fb-4fc31bb5147b\",\n \"serviceId\": \"1e016051-f008-46e8-a6da-b4b26134e36a\",\n \"options\": {\n \"values\": [ {\n \"id\": \"07ea0b3b-6138-4ed6-85d7-2f9101cc8353\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Client type\",\n \"choices\": [\"Adult\" , \"Child\" , \"Student\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"07ea0b3b-6138-4ed6-85d7-2f9101cc8353\",\n \"custom\": \"Adult\"\n } ],\n \"price\": {\n \"value\": \"16\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"07ea0b3b-6138-4ed6-85d7-2f9101cc8353\",\n \"custom\": \"Child\"\n } ],\n \"price\": {\n \"value\": \"3\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"07ea0b3b-6138-4ed6-85d7-2f9101cc8353\",\n \"custom\": \"Student\"\n } ],\n \"price\": {\n \"value\": \"10\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"3\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"16\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"4\"\n },\n {\n \"id\": \"76668eb0-fd3e-42fe-8810-896a9df830a7\",\n \"serviceId\": \"cf6f3f7f-d5d3-4461-b670-276cc8573fe9\",\n \"options\": {\n \"values\": [ {\n \"id\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Client type\",\n \"choices\": [ \"Adult\", \"Child\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Adult\"\n } ],\n \"price\": {\n \"value\": \"100\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Child\"\n } ],\n \"price\": {\n \"value\": \"40\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"40\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"100\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"3\"\n } ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": null,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git"},"httpMethod":"post","path":"/v1/serviceOptionsAndVariants/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"protoArtifactId":"com.wixpress.bookings.catalog:service-options-and-variants","serviceArtifactId":"com.wixpress.bookings.catalog.service-options-and-variants","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.bookings.catalog.v1.QueryServiceOptionsAndVariantsRequest","responseMessage":"wix.bookings.catalog.v1.QueryServiceOptionsAndVariantsResponse"},"legacyExamples":[{"name":"QueryServiceOptionsAndVariants","type":"METHOD","order":2,"content":{"title":"Query custom options and variants, sorting by service ID and limiting the responses to 3 items","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/query ' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"sort\": [ {\n \"fieldName\": \"serviceId\",\n \"order\": \"DESC\"\n } ],\n \"fieldsets\": [],\n \"fields\": [],\n \"cursorPaging\": {\n \"limit\": 3\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariantsList\": [ {\n \"id\": \"15a1d2e7-167c-4c15-b345-aa45fd389256\",\n \"serviceId\": \"e0a9379b-d5d4-422e-8238-1ed3b4671ea9\",\n \"options\": {\n \"values\": [ {\n \"id\": \"2dd1dfa1-37ee-4aaa-9a3c-38fc7df1b728\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Age\",\n \"choices\": [ \"1-5\", \"5-16\", \"16+\" ] }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"2dd1dfa1-37ee-4aaa-9a3c-38fc7df1b728\",\n \"custom\": \"1-5\"\n } ],\n \"price\": {\n \"value\": \"2\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"2dd1dfa1-37ee-4aaa-9a3c-38fc7df1b728\",\n \"custom\": \"5-16\"\n } ],\n \"price\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"2dd1dfa1-37ee-4aaa-9a3c-38fc7df1b728\",\n \"custom\": \"16+\"\n } ],\n \"price\": {\n \"value\": \"20\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"2\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"20\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"4\"\n },\n {\n \"id\": \"a7b1ca08-d297-465b-869b-58496eb51b72\",\n \"serviceId\": \"da1bb1b9-541e-4a27-b1a1-59b7d6cdf07d\",\n \"options\": {\n \"values\": [ {\n \"id\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Favourite number\",\n \"choices\": [ \"1\", \"2\", \"3\", \"4\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"1\"\n } ],\n \"price\": {\n \"value\": \"2\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"2\"\n } ],\n \"price\": {\n \"value\": \"5\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"3\"\n } ],\n \"price\": {\n \"value\": \"6\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"4\"\n } ],\n \"price\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"2\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"3\"\n },\n {\n \"id\": \"5b31b4d4-b612-49e1-91b8-234bbd6413d2\",\n \"serviceId\": \"c0ecbd12-bea6-436a-8298-af4051f8256a\",\n \"options\": {\n \"values\": [ {\n \"id\": \"bd03f2e7-23ca-477f-9701-ee3eb84e711d\",\n \"type\": \"STAFF_MEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"bd03f2e7-23ca-477f-9701-ee3eb84e711d\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"70\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"bd03f2e7-23ca-477f-9701-ee3eb84e711d\",\n \"staffMemberId\": \"9c32bba9-c381-43f7-af46-1319a8580120\"\n } ],\n \"price\": {\n \"value\": \"45\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"45\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"70\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"3\"\n } ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"offset\": null,\n \"total\": null,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": \"d86a982cdc306046bacbd2724e9a3ac0ad102341.GjUKCXNlcnZpY2VJZBABGiYaJGMwZWNiZDEyLWJlYTYtNDM2YS04Mjk4LWFmNDA1MWY4MjU2YSIkNWIzMWI0ZDQtYjYxMi00OWUxLTkxYjgtMjM0YmJkNjQxM2Qy\",\n \"prev\": null\n },\n \"hasNext\": true\n }\n}"}},{"name":"QueryServiceOptionsAndVariants","type":"METHOD","order":3,"content":{"title":"Query options and variants with a cursor from a previous request","request":"curl -X POST \\\n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/query' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"sort\": [],\n \"fieldsets\": [],\n \"fields\": [],\n \"cursorPaging\": {\n \"limit\": 3,\n \"cursor\": \"d86a982cdc306046bacbd2724e9a3ac0ad102341.GjUKCXNlcnZpY2VJZBABGiYaJGMwZWNiZDEyLWJlYTYtNDM2YS04Mjk4LWFmNDA1MWY4MjU2YSIkNWIzMWI0ZDQtYjYxMi00OWUxLTkxYjgtMjM0YmJkNjQxM2Qy\"\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariantsList\": [ {\n \"id\": \"01634326-b960-483e-9a65-6cbfc778788e\",\n \"serviceId\": \"90d5a2e9-572d-4d7d-9c94-92e1ea986fc6\",\n \"options\": {\n \"values\": [ {\n \"id\": \"c13341d2-9781-49d9-a21a-3892da4b4384\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Color\",\n \"choices\": [\"Yellow\", \"Blue\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"c13341d2-9781-49d9-a21a-3892da4b4384\",\n \"custom\": \"Yellow\"\n } ],\n \"price\": null\n },\n {\n \"choices\": [ {\n \"optionId\": \"c13341d2-9781-49d9-a21a-3892da4b4384\",\n \"custom\": \"Blue\"\n } ],\n \"price\": null\n } ]\n },\n \"minPrice\": null,\n \"maxPrice\": null,\n \"revision\": \"3\"\n },\n {\n \"id\": \"82802f2e-a54f-404f-a1b2-de5a9a9b9885\",\n \"serviceId\": \"7a5fa965-ba64-46a5-9fbb-76fde4401d28\",\n \"options\": {\n \"values\": [ {\n \"id\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Color\",\n \"choices\": [\"Blue\",\"White\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"Blue\"\n } ],\n \"price\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"7fdf831a-145e-4f2c-83d8-dd0131a7fd05\",\n \"custom\": \"White\"\n } ],\n \"price\": {\n \"value\": \"8\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"7\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"8\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"1\"\n },\n {\n \"id\": \"e9e352fc-3ce4-4ad8-9360-0b107b909eb1\",\n \"serviceId\": \"7613837a-846e-4a2d-b218-77d17af7d082\",\n \"options\": {\n \"values\": [ {\n \"id\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"type\": \"STAFFMEMBER\"\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"staffMemberId\": \"5a79026c-36f9-4839-ad4a-9a3132af5895\"\n } ],\n \"price\": {\n \"value\": \"12\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"staffMemberId\": \"963c5a66-e4be-490c-9e79-556c9a4d8807\"\n } ],\n \"price\": {\n \"value\": \"15\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"staffMemberId\": \"76570209-101f-409b-af97-b445bdb63125\"\n } ],\n \"price\": {\n \"value\": \"16\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"3319f61a-e045-482d-9d5d-2350b18dade2\",\n \"staffMemberId\": \"59581285-876b-4581-8f4c-cf90452d94e9\"\n } ],\n \"price\": {\n \"value\": \"17\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"12\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"17\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"2\"\n } ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"offset\": null,\n \"total\": null,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": \"d2f32c5a6ea98a7eaa394f66e605526d4a3e8521.GjUKCXNlcnZpY2VJZBABGiYaJDc2MTM4MzdhLTg0NmUtNGEyZC1iMjE4LTc3ZDE3YWY3ZDA4MiIkZTllMzUyZmMtM2NlNC00YWQ4LTkzNjAtMGIxMDdiOTA5ZWIx\",\n \"prev\": \"51fdf45d8387922752bee21bcf978d2f6fa3aeee.CAEaNQoJc2VydmljZUlkEAEaJhokOTBkNWEyZTktNTcyZC00ZDdkLTljOTQtOTJlMWVhOTg2ZmM2IiQwMTYzNDMyNi1iOTYwLTQ4M2UtOWE2NS02Y2JmYzc3ODc4OGU\"\n },\n \"hasNext\": true\n }\n}"}},{"name":"QueryServiceOptionsAndVariants","type":"METHOD","order":1,"content":{"title":"Query custom options and variants, filtering by option name","request":"curl -X POST \\ \n'https://wixapis.com/bookings/v1/serviceOptionsAndVariants/query' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"sort\": [],\n \"fieldsets\": [],\n \"fields\": [],\n \"filter\": {\n \"options.values.optionSpecificData.customData.name\": {\n \"$hasSome\": [\"Client type\"]\n }\n }\n }\n}'","response":"{\n \"serviceOptionsAndVariantsList\": [ {\n \"id\": \"28b44cf3-e52d-4f49-a9fb-4fc31bb5147b\",\n \"serviceId\": \"1e016051-f008-46e8-a6da-b4b26134e36a\",\n \"options\": {\n \"values\": [ {\n \"id\": \"07ea0b3b-6138-4ed6-85d7-2f9101cc8353\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Client type\",\n \"choices\": [\"Adult\" , \"Child\" , \"Student\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"07ea0b3b-6138-4ed6-85d7-2f9101cc8353\",\n \"custom\": \"Adult\"\n } ],\n \"price\": {\n \"value\": \"16\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"07ea0b3b-6138-4ed6-85d7-2f9101cc8353\",\n \"custom\": \"Child\"\n } ],\n \"price\": {\n \"value\": \"3\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"07ea0b3b-6138-4ed6-85d7-2f9101cc8353\",\n \"custom\": \"Student\"\n } ],\n \"price\": {\n \"value\": \"10\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"3\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"16\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"4\"\n },\n {\n \"id\": \"76668eb0-fd3e-42fe-8810-896a9df830a7\",\n \"serviceId\": \"cf6f3f7f-d5d3-4461-b670-276cc8573fe9\",\n \"options\": {\n \"values\": [ {\n \"id\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Client type\",\n \"choices\": [ \"Adult\", \"Child\"]\n }\n } ]\n },\n \"variants\": {\n \"values\": [ {\n \"choices\": [ {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Adult\"\n } ],\n \"price\": {\n \"value\": \"100\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n },\n {\n \"choices\": [ {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Child\"\n } ],\n \"price\": {\n \"value\": \"40\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n }\n } ]\n },\n \"minPrice\": {\n \"value\": \"40\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"maxPrice\": {\n \"value\": \"100\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"revision\": \"3\"\n } ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": null,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/scheduler.git","contentLink":{"displayName":"Query Service Options And Variants","slugifiedName":"query-service-options-and-variants"}}],"webhooks":[{"summary":"Service Options And Variants Created","title":"Service Options And Variants Created","description":"Triggered when a `serviceOptionsAndVariants` object is created by cloning from the source object.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_created","legacyExamples":[{"name":"ServiceOptionsAndVariantsCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"7d9665e1-cb17-49a7-8a96-7f8dc4bb66e0\",\n \"entityFqdn\": \"wix.bookings.catalog.v1.service_options_and_variants\",\n \"slug\": \"created\",\n \"entityId\": \"1597eb06-dc2e-4f69-a73c-df0bcbbf04bd\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"1597eb06-dc2e-4f69-a73c-df0bcbbf04bd\",\n \"serviceId\": \"7c2609bb-1c22-4231-b80a-eb6dceada32f\",\n \"options\": {\n \"values\": [\n {\n \"id\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Client Type\",\n \"choices\": [\"Adult\", \"Child\"]\n }\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": { \"value\": \"15\", \"currency\": \"EUR\" }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Child\"\n }\n ],\n \"price\": { \"value\": \"5\", \"currency\": \"EUR\" }\n }\n ]\n },\n \"minPrice\": { \"value\": \"5\", \"currency\": \"EUR\" },\n \"maxPrice\": { \"value\": \"15\", \"currency\": \"EUR\" },\n \"revision\": \"1\"\n }\n },\n \"eventTime\": \"2022-09-08T10:45:49.288290Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/scheduler.git","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","contentLink":{"displayName":"Service Options And Variants Created","slugifiedName":"service-options-and-variants-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Service Options And Variants Updated","title":"Service Options And Variants Updated","description":"Triggered when a `serviceOptionsAndVariants` object is updated.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_updated","legacyExamples":[{"name":"ServiceOptionsAndVariantsUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"1c14fdca-9b35-4c09-ae60-d1fc4c00df0f\",\n \"entityFqdn\": \"wix.bookings.catalog.v1.service_options_and_variants\",\n \"slug\": \"updated\",\n \"entityId\": \"1597eb06-dc2e-4f69-a73c-df0bcbbf04bd\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"1597eb06-dc2e-4f69-a73c-df0bcbbf04bd\",\n \"serviceId\": \"7c2609bb-1c22-4231-b80a-eb6dceada32f\",\n \"options\": {\n \"values\": [\n {\n \"id\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"type\": \"CUSTOM\",\n \"customData\": {\n \"name\": \"Client Type\",\n \"choices\": [\"Adult\", \"Child\", \"Student\"]\n }\n }\n ]\n },\n \"variants\": {\n \"values\": [\n {\n \"choices\": [\n {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Adult\"\n }\n ],\n \"price\": { \"value\": \"15\", \"currency\": \"EUR\" }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Child\"\n }\n ],\n \"price\": { \"value\": \"5\", \"currency\": \"EUR\" }\n },\n {\n \"choices\": [\n {\n \"optionId\": \"85ad3b32-e324-4af1-95d6-746f2a8a4019\",\n \"custom\": \"Student\"\n }\n ],\n \"price\": { \"value\": \"10\", \"currency\": \"EUR\" }\n }\n ]\n },\n \"minPrice\": { \"value\": \"5\", \"currency\": \"EUR\" },\n \"maxPrice\": { \"value\": \"15\", \"currency\": \"EUR\" },\n \"revision\": \"2\"\n }\n },\n \"eventTime\": \"2022-09-08T10:48:17.575396Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/scheduler.git","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","contentLink":{"displayName":"Service Options And Variants Updated","slugifiedName":"service-options-and-variants-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Service Options And Variants Deleted","title":"Service Options And Variants Deleted","description":"Triggered when a `serviceOptionsAndVariants` object is deleted.","permissions":["BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.bookings.catalog.v1.service_options_and_variants","serviceName":"wix.bookings.catalog.v1.ServiceOptionsAndVariantsService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Read Bookings - Public Data","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC"},{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"},{"name":"Read Bookings - Including Participants","scopeId":"SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE"},{"name":"Read Bookings - all read permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS"},{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"}],"eventType":"wix.bookings.catalog.v1.service_options_and_variants_deleted","legacyExamples":[{"name":"ServiceOptionsAndVariantsDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"32c7dc9e-6866-4ffd-91bc-51ca50c0c91b\",\n \"entityFqdn\": \"wix.bookings.catalog.v1.service_options_and_variants\",\n \"slug\": \"deleted\",\n \"entityId\": \"1597eb06-dc2e-4f69-a73c-df0bcbbf04bd\",\n \"deletedEvent\": {\n \"movedToTrash\": true\n },\n \"eventTime\": \"2022-09-08T10:49:47.623822Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/scheduler.git","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","contentLink":{"displayName":"Service Options And Variants Deleted","slugifiedName":"service-options-and-variants-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Wix Bookings Service Options and Variants API\n\n\nWith the Wix Bookings Service Options and Variants API, you can manage custom options \nand variants for services. This allows site owners to offer different prices for the \nsame service based on their customers' choices. \n\n\nYou can read more about using the:\n+ [Wix Bookings Pricing API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ef82416f-27e1-4092-98cc-68e6f8732988slug::introduction*fallback::https://dev.wix.com/api/rest/wix-bookings/pricing/introduction) to preview and calculate the price.\n+ [Wix Bookings Pricing Provider service plugin](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ef82416f-27e1-4092-98cc-68e6f8732988slug::introduction*fallback::https://dev.wix.com/api/rest/wix-bookings/pricing-integration-spi/introduction) that allows site owners to implement custom pricing logic.\n\n\n## Checking for Existing Pricing Options \n\nYou can check whether a service has existing pricing options, and what they are, by retrieving the\n`rate` object of the service's active schedule. Check [this flow](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::sample-flows#create-staff-member-based-service-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/sample-flows#create-staff-member-based-service-variants) for more details. \n\nThere are 3 different possible rates:\n\n + `labeledPriceOptions`: For services with the standard Wix Bookings pricing.\n + `priceText`: For services with prices manually set by the business.\n + `defaultPrice`: For services with [varied pricing](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ef82416f-27e1-4092-98cc-68e6f8732988slug::introduction*fallback::https://dev.wix.com/api/rest/wix-bookings/pricing/introduction).\n\nIf any of these 3 rates are defined in the service's active schedule, pricing options have already been defined.\n\n\n## Terminology\n\nFor a comprehensive glossary of Wix Bookings terms, see [Terminology](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/terminology).\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n+ Only a single [`serviceOptionsAndVariants`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::service-options-and-variants-object*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/service-options-and-variants-object) object is supported per service.\n\n+ Currently, only a single option is supported per `serviceOptionsAndVariants` object.\n\n+ You need to manually calculate and then pass all variants in the request of \n [Create Service Options And Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::create-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/create-service-options-and-variants). \n Variants aren't automatically calculated from the specified options.\n\n+ New variants are automatically created for services with staff member-based \n options whenever a new staff member is added to the service. The new \n variant gets the default price specified in the service's\n `schedule.rate.default_varied_price`.\n\n+ Variants are automatically deleted for services with staff member based \n options whenever a staff member is removed from the service or the \n business.\n","sourceRepo":"git@github.com:wix-private/scheduler.git","path":"proto/docs/Intro.md"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flows\n\nThis article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.\n\n## Create staff member-based service variants\n\n\nYour app can set up staff member-based service variants. This allows the site \nowner to offer customers different service prices depending on which \nstaff member is providing the service.\n\n1. Identify the relevant service ID. For example, call \n [List services](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::5eae4d27-844a-493f-aaf0-99a6899c3dfbslug::list-services*fallback::https://dev.wix.com/api/rest/wix-bookings/services/service/list-services) \n and choose the service you want to create options and variants for.\n\n1. Pass the `serviceId` inside the `scheduleOwnerIds` array in the \n [List schedules](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::92d4aa03-937b-4091-bcb9-b6df0aeca354slug::list-schedules*fallback::https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/list-schedules) \n call. This retrieves all schedules related to the service.\n\n1. Identify the active schedule from retrieved schedules. The active schedule \n has a `status` of `CREATED` in contrast to all other retrieved schedules.\n\n1. Save the `scheduleOwnerId` from the active schedule's \n `availability.linkedSchedules` array. These are the IDs of the staff members \n providing this service.\n\n1. Call [Create Service Options and Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::create-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/create-service-options-and-variants) \n and pass the relevant `serviceId`, `STAFF_MEMBER` (in the `options.type` field), \n as well as the IDs of all staff members providing the service in the \n `variants.choices` array. You can specify the price for each staff member \n in `variants.price`.\n\n\n## Create service variants based on the booked equipment \n\nYour app can set up service variants based on the booked equipment. This allows \nthem to offer customers different service prices depending on what \nequipment the customer has booked.\n\n1. Identify the relevant service ID. For example, call \n [List services](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::5eae4d27-844a-493f-aaf0-99a6899c3dfbslug::list-services*fallback::https://dev.wix.com/api/rest/wix-bookings/services/service/list-services) \n and choose the service you want to create options and variants for.\n\n1. Call [Create Service Options and Variants](fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-andvariants/create-service-options-and-variants) \n and pass the relevant `serviceId`, `CUSTOM` (in the `options.type` field), \n `Equipment` (in the `options.customData.name` field), as well as all \n supported equipment in the `options.customData.choices` array. Make sure to \n also pass all supported `variants`. You can specify the price for each \n variant in `variants.price`.\n","sourceRepo":"git@github.com:wix-private/scheduler.git","path":"proto/docs/SampleFlows.md"},{"displayName":"Supported Filters","slugifyName":"supported-filters","content":"# Service Variants and Options: Supported Filters and Sorting\n\nQuery endpoints allow you to filter and sort results based on service variant and\noptions properties. This article covers field support for filtering and sorting.\n\n## Filtering\n\nSpecify the [Query Service Options and Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::query-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/query-service-options-and-variants) `filter` object in the following format: \n\n```json\n\"filter\" : \n { \n \"fieldName\": \"value\",\n }\n```\n\n\nThe following table shows field support for filters and sorting\nfor the `serviceOptionsAndVariants` object:\n\n| Field | Supported Filters | Sortable |\n| --------------- | --------------------------------------------- | --------------- |\n| `id` | `$eq`, `$ne`, `$in` | Sortable |\n| `serviceId` | `$eq`, `$ne`, `$in` | |\n| `options.values` | `$exists` | | \n| `options.values.id` | `$hasSome`, `$hasAll` | | \n| `options.values.type` | `$hasSome`, `$hasAll` | | \n| `options.values.optionSpecificData.customData.name` | `$hasSome`, `$hasAll` | | \n| `variants.values` | `$exists` | | \n| `variants.values.choices.choice.custom.value` | `$hasSome`, `$hasAll` | | \n| `variants.values.price` | `$hasSome`, `$hasAll` | |\n| `variants.values.choices.optionId` | `$hasSome`, `$hasAll` | |\n\n\n\n## Sorting \n\n[Query Service Options and Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::query-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/query-service-options-and-variants) \nruns with this default:\n\n- sorted by `id` in `ASC` order\n\n\nSpecify the `sort` object in the following format:\n\n```json\n\"sort\" : [ \n { \n \"fieldName\":\"sortField1\",\n \"order\":\"ASC\"\n },\n { \n \"fieldName\":\"sortField2\",\n \"order\":\"ASC\"\n },\n]\n```\n\n\n## Paging \n\nBy default `pagingMetadata.cursors` are returned, unless you specifically pass \n`query.paging`.\n\nThe maximum for `cursorPaging.limit` is `100`.\n\nIf you pass a cursor token that you have received in a previous query response, \npassing additional sort or filter information results in an invalid cursor \nerror. This is because the received cursor token already holds all the needed information \nfor sort and filter. Changing the sort and filter properties during the span of \na cursor query isn't supported. You may provide a different limit though.\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+ [Sorting and Paging](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::070cf69c-a779-4b95-b522-a094d30dff2f*fallback::https://dev.wix.com/api/rest/getting-started/sorting-and-paging)\n+ [Field Projection](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::eaf4d3d6-5b76-489f-8839-f66476be32e6*fallback::https://dev.wix.com/api/rest/getting-started/field-projection)\n+ [Query Service Options and Variants endpoint](fallback::https://dev.wix.com/api/rest/wix-bookings/services/query-service-options-and-variants)\n","sourceRepo":"git@github.com:wix-private/scheduler.git","path":"proto/docs/Filters.md"},{"displayName":"Error Messages","slugifyName":"error-messages","content":"# Wix Bookings Service Options and Variants Errors\n\n\nThis articles outlines error messages that might be issued when calling \nendpoints of the Wix Bookings Service Options and Variants API.\n\n\n## Create Service Options and Variants Errors\n\n\nThe [Create Service Options and Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::create-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/create-service-options-and-variants) endpoint might issue the following error messages:\n\n|

HTTP status

Error code

Error message

Troubleshooting

HTTP status

Error code

Error message

Troubleshooting

|\n|--------------------------------------------|-------------------------------------------|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `INVALID_ARGUMENT (400)` | `UNKNOWN_OPTION_IDS` | Unknown option IDs `` aren't supported in the variants array. | Make sure that all option IDs in the variants array align with the corresponding option IDs. |\n| `INVALID_ARGUMENT (400)` | `MULTIPLE_CURRENCIES` | Multiple currencies `` aren't supported in the variants array. | Make sure that all variants use the same currency. |\n| `INVALID_ARGUMENT (400)` | `UNSUPPORTED_OPTION_TYPE` | Option type `` isn't supported for service ``. | You can only define staff member based variants in case the service has connected staff members. If the service has no staff members you can call [Update Schedule](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::92d4aa03-937b-4091-bcb9-b6df0aeca354slug::update-schedule*fallback::https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/update-schedule) to add them. To do so, add the relevant staff member IDs as `scheduleOwnerId` to the active schedule's `availability.linkedSchedules` array. |\n| `INVALID_ARGUMENT (400)` | `UNKNOWN_STAFF_IDS` | Staff members `` aren't connected to service ``. | Some staff members specified in the variants array aren't connected to the service. Either call [Update Schedule](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::92d4aa03-937b-4091-bcb9-b6df0aeca354slug::update-schedule*fallback::https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/update-schedule) to add them. To do so, add the relevant staff member IDs as `scheduleOwnerId` to the active schedule's `availability.linkedSchedules` array. Or remove the staff members from the `variants` array. |\n| `INVALID_ARGUMENT (400)` | `MISSING_STAFF_VARIANTS` | Staff members `` are missing in the variants array. | Not all staff members providing the service are specified in the variants array. Either call [Update Schedule](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::92d4aa03-937b-4091-bcb9-b6df0aeca354slug::update-schedule*fallback::https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/update-schedule) to remove staff members from the service. To do so, remove the relevant `scheduleOwnerId`s from the active schedule's `availability.linkedSchedules` array. Or remove the relevant staff members from the `variants` array. |\n| `INVALID_ARGUMENT (400)` | `IDENTICAL_CHOICES` | Identical choices `` aren't supported. | Make sure to remove identical choices from the request. Choices aren't case sensitive. For example, \"Student\" and \"student\" are considered to be the same choice. |\n| `INVALID_ARGUMENT (400)` | `MISSING_CUSTOM_CHOICES` | Choices `` are missing in the variants array. | Make sure to provide all custom choices in the variants array. You could either add missing variants or remove unnecessary choices. | \n| `INVALID_ARGUMENT (400)` | `NEGATIVE_PRICES` | Prices must have positive values. | Make sure that all prices have positive values. |\n| `INVALID_ARGUMENT (400)` | `UNSUPPORTED_OPTION_SPECIFIC_DATA` | Option data isn't supported for option type ``. | Make sure to pass `customData` for custom options or no data for staff member based options. |","sourceRepo":"git@github.com:wix-private/scheduler.git","path":"proto/docs/ErrorMessages.md"}],"components":{"schemas":{"wix.bookings.catalog.v1.ServiceOptionsAndVariants":{"type":"object","properties":{"id":{"description":"ID of the `serviceOptionsAndVariants` object.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceId":{"description":"ID of the service related to these options and variants.","format":"GUID","immutable":true,"title":"serviceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Service options. Note that currently only a single option is supported per service.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants.ServiceOptions","summary":"options","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variants":{"description":"Information about the service's variants.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants.ServiceVariants","summary":"variants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"minPrice":{"description":"Price of the cheapest service variant.","readOnly":true,"$ref":"#/components/schemas/wix.common.Money","summary":"minPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxPrice":{"description":"Price of the most expensive service variant.","readOnly":true,"$ref":"#/components/schemas/wix.common.Money","summary":"maxPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the `serviceOptionsAndVariants` object is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating and deleting the `serviceOptionsAndVariants` object.\n\nIgnored when creating a `serviceOptionsAndVariants` object.","immutable":true,"title":"revision","type":"integer","format":"uint64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceOptionsAndVariants","description":"The `serviceOptionsAndVariants` object links a service to its variants.\nYou can use it to offer customers different prices for a service,\ndepending on which choices they book.\nRead more about [service options and variants](https://wix.wixanswers.com/app/kb/article/2e91a25b-b3c2-4cf7-9005-429a4929fc36/en)."},"wix.bookings.catalog.v1.ServiceOption":{"type":"object","properties":{"id":{"description":"ID of the service option.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of the service option.","title":"type","type":"string","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionTypeEnum.ServiceOptionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceOption","description":"","oneOf":[{"description":"","summary":"optionSpecificData","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOption.optionSpecificData"}]},"wix.bookings.catalog.v1.ServiceOption.optionSpecificData":{"type":"object","title":"optionSpecificData","properties":{"customData":{"description":"Details about the custom option. Available only for `CUSTOM` options.","$ref":"#/components/schemas/wix.bookings.catalog.v1.CustomServiceOption","summary":"customData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.bookings.catalog.v1.ServiceOptionTypeEnum.ServiceOptionType":{"type":"string","description":"","title":"ServiceOptionType","enum":["UNKNOWN","CUSTOM","STAFF_MEMBER"]},"wix.bookings.catalog.v1.CustomServiceOption":{"type":"object","properties":{"name":{"description":"Name of the service option. For example, `Age group`, `Location`, `Equipment`,\nor `Time`.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"choices":{"description":"Available choices for the service option. For example, `child`, `student`,\n`adult`, and `senior` for a service option named `Age group`. Each value must\nbe unique. The value's case is ignored, meaning `Child` and `child` are\nconsidered to be identical. Currently, only a single choice is supported\nbecause a service can have only a single option.\n\nMax: 1 choice","title":"choices","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomServiceOption","description":""},"wix.bookings.catalog.v1.ServiceVariant":{"type":"object","properties":{"choices":{"description":"Choices for the service option. Currently, only a single choice is supported\nbecause a service can have only a single option.\n\nMax: 1 choice","minItems":1,"maxItems":1,"title":"choices","type":"array","items":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceChoice"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Information about the service variant's price.","$ref":"#/components/schemas/wix.common.Money","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceVariant","description":""},"wix.bookings.catalog.v1.ServiceChoice":{"type":"object","properties":{"optionId":{"description":"ID of the service option.","format":"GUID","title":"optionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceChoice","description":"","oneOf":[{"description":"","summary":"choice","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceChoice.choice"}]},"wix.bookings.catalog.v1.ServiceChoice.choice":{"type":"object","title":"choice","properties":{"custom":{"description":"Name of the custom choice.","title":"custom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"staffMemberId":{"description":"ID of the staff member providing the service. This ID is the equivalent of the `resourceId`\nof the staff member or the `scheduleOwnerId` of the relevant\n[schedule's](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object)\n`availability.linkedSchedules`.","format":"GUID","title":"staffMemberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.Money":{"type":"object","properties":{"value":{"description":"Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.","format":"DECIMAL_VALUE","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"Currency code. Must be valid ISO 4217 currency code (e.g., USD).","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedValue":{"description":"Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.","title":"formattedValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Money","description":"Money.\nDefault format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"wix.bookings.catalog.v1.ServiceOptionsAndVariants.ServiceOptions":{"type":"object","properties":{"values":{"description":"Values of the service options.\n\nMax: 1 service option","minItems":1,"maxItems":1,"title":"values","type":"array","items":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOption"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceOptions","description":""},"wix.bookings.catalog.v1.ServiceOptionsAndVariants.ServiceVariants":{"type":"object","properties":{"values":{"description":"Values of the service variants.","minItems":1,"title":"values","type":"array","items":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceVariant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceVariants","description":""},"google.protobuf.UInt64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UInt64Value","description":""},"wix.bookings.catalog.v1.CreateServiceOptionsAndVariantsRequest":{"type":"object","properties":{"serviceOptionsAndVariants":{"description":"Service options and variants to create.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceOptionsAndVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateServiceOptionsAndVariantsRequest","description":""},"wix.bookings.catalog.v1.CreateServiceOptionsAndVariantsResponse":{"type":"object","properties":{"serviceOptionsAndVariants":{"description":"Information about the created service options and variants.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceOptionsAndVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateServiceOptionsAndVariantsResponse","description":""},"wix.bookings.catalog.v1.CloneServiceOptionsAndVariantsRequest":{"type":"object","properties":{"cloneFromId":{"description":"ID of the `serviceOptionsAndVariants` object to clone.","format":"GUID","title":"cloneFromId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"targetServiceId":{"description":"ID of the service that will be set for the cloned `serviceOptionsAndVariants`","format":"GUID","title":"targetServiceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CloneServiceOptionsAndVariantsRequest","description":""},"wix.bookings.catalog.v1.CloneServiceOptionsAndVariantsResponse":{"type":"object","properties":{"serviceOptionsAndVariants":{"description":"The cloned `serviceOptionsAndVariants` object.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceOptionsAndVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CloneServiceOptionsAndVariantsResponse","description":""},"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsRequest":{"type":"object","properties":{"serviceOptionsAndVariantsId":{"description":"ID of the `serviceOptionsAndVariants` object to retrieve.","format":"GUID","title":"serviceOptionsAndVariantsId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetServiceOptionsAndVariantsRequest","description":""},"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsResponse":{"type":"object","properties":{"serviceOptionsAndVariants":{"description":"Retrieved `serviceOptionsAndVariants` object.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceOptionsAndVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetServiceOptionsAndVariantsResponse","description":""},"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsByServiceIdRequest":{"type":"object","properties":{"serviceId":{"description":"ID of the service to retrieve options and variants for.","format":"GUID","title":"serviceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetServiceOptionsAndVariantsByServiceIdRequest","description":""},"wix.bookings.catalog.v1.GetServiceOptionsAndVariantsByServiceIdResponse":{"type":"object","properties":{"serviceVariants":{"description":"Retrieved `serviceOptionsAndVariants` object.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetServiceOptionsAndVariantsByServiceIdResponse","description":""},"wix.bookings.catalog.v1.UpdateServiceOptionsAndVariantsRequest":{"type":"object","properties":{"serviceOptionsAndVariants":{"description":"`ServiceOptionsAndVariants` object to update.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceOptionsAndVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateServiceOptionsAndVariantsRequest","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.bookings.catalog.v1.UpdateServiceOptionsAndVariantsResponse":{"type":"object","properties":{"serviceOptionsAndVariants":{"description":"Updated `serviceOptionsAndVariants` object.","$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants","summary":"serviceOptionsAndVariants","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateServiceOptionsAndVariantsResponse","description":""},"wix.bookings.catalog.v1.DeleteServiceOptionsAndVariantsRequest":{"type":"object","properties":{"serviceOptionsAndVariantsId":{"description":"ID of the `serviceOptionsAndVariants` object to delete.","format":"GUID","title":"serviceOptionsAndVariantsId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision of the `serviceOptionsAndVariants` object to delete.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteServiceOptionsAndVariantsRequest","description":""},"wix.bookings.catalog.v1.DeleteServiceOptionsAndVariantsResponse":{"type":"object","properties":{},"title":"DeleteServiceOptionsAndVariantsResponse","description":""},"wix.bookings.catalog.v1.QueryServiceOptionsAndVariantsRequest":{"type":"object","properties":{"query":{"description":"Information about filters, paging, and returned fields.","$ref":"#/components/schemas/wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryServiceOptionsAndVariantsRequest","description":""},"wix.common.QueryV2":{"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\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fieldsets","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.QueryV2.pagingMethod"}]},"wix.common.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"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":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"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\nPass the relevant cursor token from 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":""},"wix.bookings.catalog.v1.QueryServiceOptionsAndVariantsResponse":{"type":"object","properties":{"serviceOptionsAndVariantsList":{"description":"Retrieved `serviceOptionsAndVariants` objects.","title":"serviceOptionsAndVariantsList","type":"array","items":{"$ref":"#/components/schemas/wix.bookings.catalog.v1.ServiceOptionsAndVariants"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryServiceOptionsAndVariantsResponse","description":""},"wix.common.PagingMetadataV2":{"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"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the 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 the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.bookings.resources.core.api.v1.resource.ResourceNotification":{"type":"object","properties":{"resource":{"description":"Updated resource entity.\n'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.","$ref":"#/components/schemas/com.wixpress.bookings.resources.core.api.v1.resource.Resource","summary":"resource","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"event":{"description":"Event type.","title":"event","type":"string","$ref":"#/components/schemas/com.wixpress.bookings.resources.core.api.v1.resource.ResourceNotification.Event","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ResourceNotification","description":""},"com.wixpress.bookings.resources.core.api.v1.resource.Resource":{"type":"object","properties":{"id":{"description":"Resource ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Resource name.","maxLength":1200,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Resource email address.","maxLength":500,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Resource phone number.","maxLength":500,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Resource description.","maxLength":500,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tag":{"description":"Deprecated. Please use tags.","maxLength":500,"title":"tag","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"tags":{"description":"Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.","maxLength":200,"title":"tags","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"images":{"description":"Resource images.","title":"images","type":"array","items":{"$ref":"#/components/schemas/wix.common.Image"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"schedules":{"description":"Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.","title":"schedules","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"scheduleIds":{"description":"List of IDs of schedules owned by this resource.","format":"GUID","readOnly":true,"title":"scheduleIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Resource status.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.bookings.resources.core.api.v1.resource.Resource.ResourceStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"Wix user ID, if the resource is associated with the Wix user.\nA staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.","format":"GUID","readOnly":true,"title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Resource","description":""},"wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","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":""},"com.wix.bookings.schedules.api.v1.Schedule":{"type":"object","properties":{"id":{"description":"Schedule ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleOwnerId":{"description":"ID of the schedule's owner entity. This may be a resource ID or a service ID.","title":"scheduleOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.\nDerived from the Wix Business time zone.","readOnly":true,"title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"intervals":{"description":"Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead.","title":"intervals","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.RecurringInterval"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"title":{"description":"Default title for the schedule's sessions. Maximum length: 6000 characters.","maxLength":6000,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tags":{"description":"__Deprecated.__\nTags for grouping schedules. These tags are the default tags for the schedule's sessions.\nThe Wix Bookings app uses the following predefined tags to set schedule type: `\"INDIVIDUAL\"`, `\"GROUP\"`, and `\"COURSE\"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.","title":"tags","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"location":{"description":"Default location for the schedule's sessions.","$ref":"#/components/schemas/com.wix.bookings.common.api.v1.Location","summary":"location","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"capacity":{"description":"Maximum number of participants that can be added to the schedule's sessions.\nMust be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.","minimum":1,"maximum":1000,"title":"capacity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rate":{"description":"Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.","$ref":"#/components/schemas/com.wix.bookings.common.api.v1.Rate","summary":"rate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"availability":{"description":"__Deprecated.__","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Availability","summary":"availability","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"totalNumberOfParticipants":{"description":"Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.","readOnly":true,"title":"totalNumberOfParticipants","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"participants":{"description":"*Partial list** of participants which are registered to sessions in this schedule.\nParticipants who are registered in the schedule are automatically registered to any session that is created for the schedule.\nTo retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).","readOnly":true,"title":"participants","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Participant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalCalendarOverrides":{"description":"__Deprecated.__","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ExternalCalendarOverrides","summary":"externalCalendarOverrides","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"status":{"description":"Schedule status.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule.ScheduleStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"created":{"description":"Schedule creation date.","readOnly":true,"title":"created","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updated":{"description":"Schedule last update date.","readOnly":true,"title":"updated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"Schedule version number, updated each time the schedule is updated.","readOnly":true,"title":"version","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inheritedFields":{"description":"Fields which were inherited from the Business Info page under Settings in the Dashboard.","readOnly":true,"title":"inheritedFields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"conferenceProvider":{"description":"__Deprecated.__","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ConferenceProvider","summary":"conferenceProvider","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"calendarConference":{"description":"A conference created for the schedule. This is used when a participant is added to a schedule.\n**Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.CalendarConference","summary":"calendarConference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},"title":"Schedule","description":""},"com.wix.bookings.schedules.api.v1.RecurringInterval":{"type":"object","properties":{"id":{"description":"The recurring interval identifier.","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"start":{"description":"The start time of the recurring interval. Required.","title":"start","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"end":{"description":"The end time of the recurring interval. Optional. Empty value indicates that there is no end time.","title":"end","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"interval":{"description":"The interval rules. The day, hour and minutes the interval is recurring.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Interval","summary":"interval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"frequency":{"description":"The frequency of the interval. Optional. The default is frequency with the default repetition.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Frequency","summary":"frequency","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"affectedSchedules":{"description":"Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval.","title":"affectedSchedules","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.LinkedSchedule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"intervalType":{"description":"The type of recurring interval.","title":"intervalType","type":"string","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.RecurringInterval.RecurringIntervalType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RecurringInterval","description":""},"com.wix.bookings.schedules.api.v1.Interval":{"type":"object","properties":{"daysOfWeek":{"description":"The day the interval accrue. Optional. The default is the day of the recurring interval's start time.","title":"daysOfWeek","type":"string","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Interval.Day","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hourOfDay":{"description":"The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23.","minimum":0,"maximum":23,"title":"hourOfDay","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"minuteOfHour":{"description":"The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59.","minimum":0,"maximum":59,"title":"minuteOfHour","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"duration":{"description":"The duration of the interval in minutes. Required. Part of the session end time calculation.","minimum":0,"title":"duration","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Interval","description":""},"com.wix.bookings.schedules.api.v1.Interval.Day":{"type":"string","description":"","title":"Day","enum":["UNDEFINED","MON","TUE","WED","THU","FRI","SAT","SUN"]},"com.wix.bookings.schedules.api.v1.Frequency":{"type":"object","properties":{"repetition":{"description":"The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52.","minimum":1,"maximum":52,"title":"repetition","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Frequency","description":""},"com.wix.bookings.schedules.api.v1.LinkedSchedule":{"type":"object","properties":{"scheduleId":{"description":"Schedule ID.","format":"GUID","title":"scheduleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transparency":{"description":"Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `\"BUSY\"`.\nIf set to `\"BUSY\"`, this schedule cannot have any available slots during the linked schedule's sessions.\nIf set to `\"FREE\"`, this schedule can have available slots during the linked schedule's sessions.","title":"transparency","type":"string","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.LinkedSchedule.Transparency","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleOwnerId":{"description":"Owner ID, of the linked schedule.","readOnly":true,"title":"scheduleOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LinkedSchedule","description":""},"com.wix.bookings.schedules.api.v1.LinkedSchedule.Transparency":{"type":"string","description":"","title":"Transparency","enum":["UNDEFINED","FREE","BUSY"]},"com.wix.bookings.schedules.api.v1.RecurringInterval.RecurringIntervalType":{"type":"string","description":"","title":"RecurringIntervalType","enum":["UNDEFINED","EVENT","TIME_AVAILABILITY","AVAILABILITY"]},"com.wix.bookings.common.api.v1.Location":{"type":"object","properties":{"locationType":{"description":"Location type.\nOne of:\n- `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n- `\"OWNER_CUSTOM\"` The address as set when creating the service.\n- `\"CUSTOM\"` The address set for the individual session.","title":"locationType","type":"string","$ref":"#/components/schemas/com.wix.bookings.common.api.v1.Location.LocationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"address":{"description":"Free text address used when locationType is `OWNER_CUSTOM`.","title":"address","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"customAddress":{"description":"Custom address, used when locationType is `\"OWNER_CUSTOM\"`. Might be used when locationType is `\"CUSTOM\"` in case the owner sets a custom address for the session which is different from the default.","$ref":"#/components/schemas/com.wix.bookings.upstream.wix.common.Address","summary":"customAddress","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Location","description":""},"com.wix.bookings.common.api.v1.Location.LocationType":{"type":"string","description":"","title":"LocationType","enum":["UNDEFINED","OWNER_BUSINESS","OWNER_CUSTOM","CUSTOM"]},"com.wix.bookings.upstream.wix.common.Address":{"type":"object","properties":{"country":{"description":"Country code.","format":"COUNTRY","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subdivision":{"description":"Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).","title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"city":{"description":"City name.","title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"postalCode":{"description":"Zip/postal code.","title":"postalCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addressLine2":{"description":"Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.","title":"addressLine2","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedAddress":{"description":"A string containing the full address of this location.","title":"formattedAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hint":{"description":"Free text to help find the address.","title":"hint","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"geocode":{"description":"Coordinates of the physical address.","$ref":"#/components/schemas/com.wix.bookings.upstream.wix.common.AddressLocation","summary":"geocode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"countryFullname":{"description":"Country full name.","title":"countryFullname","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subdivisions":{"description":"Multi-level subdivisions from top to bottom.","title":"subdivisions","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.upstream.wix.common.Subdivision"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Address","description":"Physical address","oneOf":[{"description":"","summary":"street","$ref":"#/components/schemas/com.wix.bookings.upstream.wix.common.Address.street"}]},"com.wix.bookings.upstream.wix.common.Address.street":{"type":"object","title":"street","properties":{"streetAddress":{"description":"Street name, number and apartment number.","$ref":"#/components/schemas/com.wix.bookings.upstream.wix.common.StreetAddress","summary":"streetAddress","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addressLine":{"description":"Main address line, usually street and number, as free text.","title":"addressLine","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.bookings.upstream.wix.common.StreetAddress":{"type":"object","properties":{"number":{"description":"Street number.","title":"number","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Street name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"apt":{"description":"Apartment number.","title":"apt","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StreetAddress","description":""},"com.wix.bookings.upstream.wix.common.AddressLocation":{"type":"object","properties":{"latitude":{"description":"Address latitude.","title":"latitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"longitude":{"description":"Address longitude.","title":"longitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddressLocation","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"com.wix.bookings.upstream.wix.common.Subdivision":{"type":"object","properties":{"code":{"description":"Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Subdivision full name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Subdivision","description":""},"com.wixpress.locations.Location":{"type":"object","properties":{"id":{"description":"Location ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Location name.","maxLength":150,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Location description.","maxLength":500,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"default":{"description":"Whether this is the default location. There can only be one default location per site. The default location can't be archived.","readOnly":true,"title":"default","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Location status. Defaults to `ACTIVE`.\n__Notes:__\n- [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\ndoesn't affect the location's status.\n- `INACTIVE` status is currently not supported.","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.locations.LocationStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locationType":{"description":"Location type.\n\n**Note:** Currently not supported.","title":"locationType","type":"string","$ref":"#/components/schemas/com.wixpress.locations.LocationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"fax":{"description":"Fax number.","title":"fax","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"Timezone in `America/New_York` format.","title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Email address.","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Phone number.","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"address":{"description":"Address.","$ref":"#/components/schemas/com.wixpress.locations.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"businessSchedule":{"description":"Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n\n__Note:__ Not supported by Wix Bookings.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessSchedule","summary":"businessSchedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the location is updated.\nTo prevent conflicting changes, the existing revision must be used when updating a location.","title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"archived":{"description":"Whether the location is archived. Archived locations can't be updated.\n__Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\ndoesn't affect its `status`.","readOnly":true,"title":"archived","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locationTypes":{"description":"Location types.","maxItems":10,"title":"locationTypes","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.locations.LocationType"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Location","description":""},"com.wixpress.locations.LocationStatus":{"type":"string","description":"For future use","title":"LocationStatus","enum":["ACTIVE","INACTIVE"]},"com.wixpress.locations.LocationType":{"type":"string","description":"For future use","title":"LocationType","enum":["UNKNOWN","BRANCH","OFFICES","RECEPTION","HEADQUARTERS","INVENTORY"]},"com.wixpress.locations.Address":{"type":"object","properties":{"country":{"description":"2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.","format":"COUNTRY","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subdivision":{"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.","title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"city":{"description":"City name.","title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"postalCode":{"description":"Postal or zip code.","title":"postalCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"streetAddress":{"description":"Street address. Includes street name, number, and apartment number in separate fields.","$ref":"#/components/schemas/com.wixpress.locations.StreetAddress","summary":"streetAddress","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedAddress":{"description":"Full address of the location.","title":"formattedAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hint":{"description":"Extra information that helps finding the location.","maxLength":500,"title":"hint","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"geocode":{"description":"Geographic coordinates of location.","$ref":"#/components/schemas/com.wixpress.locations.AddressLocation","summary":"geocode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Address","description":""},"com.wixpress.locations.StreetAddress":{"type":"object","properties":{"number":{"description":"Street number.","title":"number","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Street name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"apt":{"description":"Apartment number.","title":"apt","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StreetAddress","description":"Street address. Includes street name, number, and apartment number in separate fields."},"com.wixpress.locations.AddressLocation":{"type":"object","properties":{"latitude":{"description":"Latitude of the location. Must be between -90 and 90.","title":"latitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"longitude":{"description":"Longitude of the location. Must be between -180 and 180.","title":"longitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddressLocation","description":"Address Geolocation"},"com.wixpress.siteproperties.api.v4.BusinessSchedule":{"type":"object","properties":{"periods":{"description":"Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.","maxItems":100,"title":"periods","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.TimePeriod"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"specialHourPeriod":{"description":"Exceptions to the business's regular hours. The business can be open or closed during the exception.","maxItems":100,"title":"specialHourPeriod","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SpecialHourPeriod"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BusinessSchedule","description":"Business schedule. Regular and exceptional time periods when the business is open or the service is available."},"com.wixpress.siteproperties.api.v4.TimePeriod":{"type":"object","properties":{"openDay":{"description":"Day of the week the period starts on.","title":"openDay","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.DayOfWeek","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"openTime":{"description":"Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\nmidnight at the end of the specified day.","title":"openTime","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"closeDay":{"description":"Day of the week the period ends on.","title":"closeDay","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.DayOfWeek","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"closeTime":{"description":"Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\nmidnight at the end of the specified day.\n\n__Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.","title":"closeTime","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TimePeriod","description":"Weekly recurring time periods when the business is regularly open or the service is available."},"com.wixpress.siteproperties.api.v4.DayOfWeek":{"type":"string","description":"Enumerates the days of the week.","title":"DayOfWeek","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"com.wixpress.siteproperties.api.v4.SpecialHourPeriod":{"type":"object","properties":{"startDate":{"description":"Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).","title":"startDate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endDate":{"description":"End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).","title":"endDate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isClosed":{"description":"Whether the business is closed (or the service is not available) during the exception.\n\nDefault: `true`.","title":"isClosed","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"comment":{"description":"Additional info about the exception. For example, \"We close earlier on New Year's Eve.\"","title":"comment","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SpecialHourPeriod","description":"Exception to the business's regular hours. The business can be open or closed during the exception."},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wix.bookings.common.api.v1.Rate":{"type":"object","properties":{"labeledPriceOptions":{"description":"Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.\nWhen present in an update request, the `default_varied_price` is ignored to support backward compatibility.","title":"labeledPriceOptions","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/com.wix.bookings.common.api.v1.Price"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"priceText":{"description":"Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.\nWhen present in an update request, the `default_varied_price` is ignored to support backward compatibility.","title":"priceText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Rate","description":""},"com.wix.bookings.common.api.v1.Price":{"type":"object","properties":{"amount":{"description":"Required payment amount.","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"Currency in which the amount is quoted.","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"downPayAmount":{"description":"Amount of a down payment or deposit as part of the transaction.","format":"DECIMAL_VALUE","title":"downPayAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Price","description":""},"com.wix.bookings.schedules.api.v1.Availability":{"type":"object","properties":{"start":{"description":"Date and time the schedule starts to be available for booking.","title":"start","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"end":{"description":"Date and time the schedule stops being available for booking. No value indicates no end time.","title":"end","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"linkedSchedules":{"description":"Other schedules that impact the availability calculation. Relevant only when there are availability constraints.","title":"linkedSchedules","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.LinkedSchedule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"constraints":{"description":"Constraints for calculating the schedule's availability.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.AvailabilityConstraints","summary":"constraints","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Availability","description":""},"com.wix.bookings.schedules.api.v1.AvailabilityConstraints":{"type":"object","properties":{"slotDurations":{"description":"A list of duration options for slots, in minutes. Minimum value for a duration is 1.\nThe availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.","minimum":1,"title":"slotDurations","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeBetweenSlots":{"description":"The number of minutes between the `end` of one slot, and the `start` of the next.\nMinimum value is 0, maximum value is 120.","minimum":0,"maximum":720,"title":"timeBetweenSlots","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"splitInterval":{"description":"Specify how to split the slots in intervals of minutes.\nThis value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).\nOptional. The default is the first duration in slot_durations field.\nDeprecated. Use the `split_slots_interval.value_in_minutes`.","title":"splitInterval","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"slotsSplitInterval":{"description":"An object defining the time between available slots' start times. For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.","readOnly":true,"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.SplitInterval","summary":"slotsSplitInterval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AvailabilityConstraints","description":"Describes how to calculate the specific slots that are available for booking."},"com.wix.bookings.schedules.api.v1.SplitInterval":{"type":"object","properties":{"sameAsDuration":{"description":"Whether the slot duration is used as the split interval value.\nIf `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in\n`schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.","title":"sameAsDuration","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"valueInMinutes":{"description":"Number of minutes between available slots' start times when `same_as_duration` is `false`.","title":"valueInMinutes","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SplitInterval","description":"The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc."},"com.wix.bookings.schedules.api.v1.Participant":{"type":"object","properties":{"id":{"description":"Participant ID. Currently represents the booking.id.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactId":{"description":"Contact ID.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Participant's name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Participant's phone number.","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Participant's email address.","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"partySize":{"description":"Group or party size. The number of people attending. Defaults to 0. Maximum is 250.","minimum":0,"title":"partySize","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"approvalStatus":{"description":"Approval status for the participant.\n","title":"approvalStatus","type":"string","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Participant.ApprovalStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inherited":{"description":"Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.","readOnly":true,"title":"inherited","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Participant","description":""},"com.wix.bookings.schedules.api.v1.Participant.ApprovalStatus":{"type":"string","description":"","title":"ApprovalStatus","enum":["UNDEFINED","PENDING","APPROVED","DECLINED"]},"com.wix.bookings.schedules.api.v1.ExternalCalendarOverrides":{"type":"object","properties":{"title":{"description":"Synced title of the external calendar event.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Synced description of the external calendar event.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExternalCalendarOverrides","description":""},"com.wix.bookings.schedules.api.v1.Schedule.ScheduleStatus":{"type":"string","description":"","title":"ScheduleStatus","enum":["UNDEFINED","CREATED","CANCELLED"]},"com.wix.bookings.schedules.api.v1.Schedule.Version":{"type":"object","properties":{"scheduleVersion":{"description":"Schedule version number, updated each time the schedule is updated.","title":"scheduleVersion","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"participantsVersion":{"description":"Participants version number, updated each time the schedule participants are updated.","title":"participantsVersion","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Version","description":""},"com.wix.bookings.schedules.api.v1.ConferenceProvider":{"type":"object","properties":{"providerId":{"description":"Conferencing provider ID","title":"providerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ConferenceProvider","description":""},"com.wix.bookings.schedules.api.v1.CalendarConference":{"type":"object","properties":{"id":{"description":"Wix Calendar conference ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalId":{"description":"Conference meeting ID in the provider's conferencing system.","title":"externalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerId":{"description":"Conference provider ID.","title":"providerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hostUrl":{"description":"URL used by the host to start the conference.","title":"hostUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"guestUrl":{"description":"URL used by a guest to join the conference.","title":"guestUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"password":{"description":"Password to join the conference.","title":"password","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Conference description.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"conferenceType":{"description":"Conference type.","title":"conferenceType","type":"string","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.CalendarConference.ConferenceType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"accountOwnerId":{"description":"ID of the account owner in the video conferencing service.","title":"accountOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalendarConference","description":""},"com.wix.bookings.schedules.api.v1.CalendarConference.ConferenceType":{"type":"string","description":"","title":"ConferenceType","enum":["UNDEFINED","ONLINE_MEETING_PROVIDER","CUSTOM"]},"com.wixpress.bookings.resources.core.api.v1.resource.Resource.ResourceStatus":{"type":"string","description":"","title":"ResourceStatus","enum":["UNDEFINED","CREATED","DELETED","UPDATED"]},"com.wixpress.bookings.resources.core.api.v1.resource.BusinessLocation":{"type":"object","properties":{"locationId":{"description":"The ID of the business location. Has to be non-empty","format":"GUID","title":"locationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BusinessLocation","description":""},"com.wixpress.bookings.resources.core.api.v1.resource.ResourceNotification.Event":{"type":"string","description":"","title":"Event","enum":["UNDEFINED","Updated","Deleted","Created","Schedule_Updated"]},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.bookings.services.api.v1.ServiceNotification":{"type":"object","properties":{"service":{"description":"Updated service entity.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.Service","summary":"service","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"event":{"description":"","title":"event","type":"string","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.ServiceNotification.Event","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"policy":{"description":"","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.BusinessServicesPolicy","summary":"policy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceNotification","description":"An event sent in the system once the service is changed.","oneOf":[{"description":"","summary":"metadata","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.ServiceNotification.metadata"}],"x-wix-docs":{"deprecated":{"replacedBy":"Service","targetRemovalDate":"2024-06-01"}}},"com.wixpress.bookings.services.api.v1.ServiceNotification.metadata":{"type":"object","title":"metadata","properties":{"deleteMetadata":{"description":"","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.DeleteMetadata","summary":"deleteMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.bookings.services.api.v1.Service":{"type":"object","properties":{"id":{"description":"Service ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"info":{"description":"Information about the service.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.ServiceInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"policy":{"description":"Description of the bookings policy for the service.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.BookingPolicy","summary":"policy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentOptions":{"description":"Payment options available for use when booking the service.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.PaymentOptions","summary":"paymentOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryId":{"description":"ID of the category to which the service belongs.","format":"GUID","title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bookingFormId":{"description":"ID of the form that visitors fill out when booking the service.","format":"GUID","title":"bookingFormId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleIds":{"description":"List of schedule IDs for the sessions and slots that can be booked for the service.\nThe list can include schedules with any `status` values, however the Bookings application only uses the schedules with a `status` of `\"CREATED\"`. There is only one schedule with a status of `\"CREATED\"` per service. The ID of that schedule must always be the first in the list.","readOnly":true,"title":"scheduleIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customProperties":{"description":"Set of custom properties for the service.","maxItems":256,"title":"customProperties","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Service status.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.Service.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortOrder":{"description":"Sort order of the service within its category.","title":"sortOrder","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"advancedSeoData":{"description":"Advanced SEO data","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema","summary":"advancedSeoData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"seoData":{"description":"SEO data","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema","summary":"seoData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeConferenceOption":{"description":"Whether a conference is to be generated for the service.","title":"includeConferenceOption","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Service","description":"A service describes the business offering that a business provides to its customers.","x-wix-docs":{"deprecated":{"replacedBy":"Service","targetRemovalDate":"2024-06-01"}}},"com.wixpress.bookings.services.api.v1.ServiceInfo":{"type":"object","properties":{"name":{"description":"Service name.","maxLength":400,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Service description.","maxLength":7000,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"images":{"description":"Images associated with the service. Deprecated.","maxItems":100,"title":"images","type":"array","items":{"$ref":"#/components/schemas/wix.common.Image"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"tagLine":{"description":"Short service description.","maxLength":6000,"title":"tagLine","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"media":{"description":"Images associated with the service. Optional. Not supported yet.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.Media","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceInfo","description":"Information describing the service.","x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.Media":{"type":"object","properties":{"items":{"description":"Images associated with the service.","maxItems":100,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.MediaItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mainMedia":{"description":"Primary image associated with the service.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.MediaItem","summary":"mainMedia","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"coverMedia":{"description":"Cover image associated with the service.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.MediaItem","summary":"coverMedia","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Media","description":"","x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.MediaItem":{"type":"object","properties":{},"title":"MediaItem","description":"","oneOf":[{"description":"","summary":"item","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.MediaItem.item"}],"x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.MediaItem.item":{"type":"object","title":"item","properties":{"image":{"description":"Image metadata.","$ref":"#/components/schemas/wix.common.Image","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.bookings.services.api.v1.BookingPolicy":{"type":"object","properties":{"maxParticipantsPerBooking":{"description":"Maximum number of participants for a single booking. Defaults to 1.","minimum":0,"title":"maxParticipantsPerBooking","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bookUpToXMinutesBefore":{"description":"Minimum number of minutes before the start of a session that a booking can be made. For a schedule, this is relative to the start time of the next session, excluding past sessions. Default value is taken form BusinessServicesPolicy.","minimum":0,"title":"bookUpToXMinutesBefore","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancelRescheduleUpToXMinutesBefore":{"description":"Minimum number of minutes before the start of a session that a booking can be canceled or rescheduled. Default value is taken form BusinessServicesPolicy.","minimum":0,"title":"cancelRescheduleUpToXMinutesBefore","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isBookOnlineAllowed":{"description":"Whether online booking is available. Defaults to true.","title":"isBookOnlineAllowed","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isCancelAllowed":{"description":"Whether bookings for the service can be canceled. Defaults to true.","title":"isCancelAllowed","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isRescheduleAllowed":{"description":"Whether bookings for the service can be rescheduled. Defaults to true.","title":"isRescheduleAllowed","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"futureBookingsPolicy":{"description":"How far in advance a booking can be made. Default value is taken form BusinessServicesPolicy.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.FutureBookingPolicy","summary":"futureBookingsPolicy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"waitingListPolicy":{"description":"Waitlist policy for the service. Default value is taken form BusinessServicesPolicy.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.WaitingListPolicy","summary":"waitingListPolicy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bookingsApprovalPolicy":{"description":"Bookings approval policy for the service. Empty by default.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.BookingsApprovalPolicy","summary":"bookingsApprovalPolicy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"overrideBusinessPolicyFields":{"description":"A list of booking policy field names of fields that override the respective values of the default business booking policy.\nCurrently only 'service.policy.bookUpToXMinutesBefore' field is supported","title":"overrideBusinessPolicyFields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancellationPolicy":{"description":"User defined cancellation policy message.","readOnly":true,"title":"cancellationPolicy","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BookingPolicy","description":"A set of rules defining the policies for booking the service for visitors and members.","x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.FutureBookingPolicy":{"type":"object","properties":{"shouldLimit":{"description":"Whether a limit is imposed on advance bookings.","title":"shouldLimit","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limitXMinutesToTheFuture":{"description":"How far in advance, in minutes, a session can be booked. Defaults to 10,080 minutes (3 days).","minimum":0,"title":"limitXMinutesToTheFuture","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FutureBookingPolicy","description":"","x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.WaitingListPolicy":{"type":"object","properties":{"isEnabled":{"description":"Whether waitlisting is enabled for the service.","title":"isEnabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"capacity":{"description":"Number of spots available in the waitlist. Defaults to 10 spots.","minimum":0,"title":"capacity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeWindowMinutes":{"description":"Amount of time a participant is given to book, once notified that a spot is available. Defaults to 10 minutes.","minimum":0,"title":"timeWindowMinutes","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"WaitingListPolicy","description":"","x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.BookingsApprovalPolicy":{"type":"object","properties":{"isBusinessApprovalRequired":{"description":"Whether bookings to the service require approval.","title":"isBusinessApprovalRequired","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"requestsAffectsAvailability":{"description":"Whether the booking requests affect the session or slot availability. For example, 3 booking requests for a 10-person session will cause the session to have 7 available spots, before the requests are approved.","title":"requestsAffectsAvailability","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BookingsApprovalPolicy","description":"","x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.PaymentOptions":{"type":"object","properties":{"wixPayOnline":{"description":"Whether a booking made for the service can be paid online through Wix.","title":"wixPayOnline","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixPayInPerson":{"description":"Whether a booking made for the service can be paid in person.","title":"wixPayInPerson","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Whether a booking made for the service can be paid in a customized way, defined by the API.","title":"custom","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixPaidPlan":{"description":"Whether a booking made for the service can be paid using Wix Pricing Plans.","title":"wixPaidPlan","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PaymentOptions","description":"Payment options for the service. Multiple payment options can be enabled. For example:\nFor a service to be paid only online using WiX, then set wix_pay_online=true and the rest should be set to false.\nFor a service to accept payment online via Wix or in person, set the wix_pay_online=true & wix_pay_in_person=true.","x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.Service.Status":{"type":"string","description":"","title":"Status","enum":["CREATED","DELETED"]},"com.wixpress.advanced.seo.SeoSchema":{"type":"object","properties":{"tags":{"description":"SEO tag information.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"settings":{"description":"SEO general settings.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Settings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SeoSchema","description":"The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\nThe search engines use this information for ranking purposes, or to display snippets in the search results.\nThis data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself."},"com.wixpress.advanced.seo.SeoSchema.Keyword":{"type":"object","properties":{"term":{"description":"Keyword value.","title":"term","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isMain":{"description":"Whether the keyword is the main focus keyword.","title":"isMain","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Keyword","description":""},"com.wixpress.advanced.seo.SeoSchema.Tag":{"type":"object","properties":{"type":{"description":"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"props":{"description":"A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\nFor example: `{'name': 'description', 'content': 'the description itself'}`.","title":"props","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"meta":{"description":"SEO tag meta data. For example, `{height: 300, width: 240}`.","title":"meta","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"children":{"description":"SEO tag inner content. For example, ` inner content `.","title":"children","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Whether the tag is a custom tag.","title":"custom","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disabled":{"description":"Whether the tag is disabled.","title":"disabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tag","description":""},"com.wixpress.advanced.seo.SeoSchema.Settings":{"type":"object","properties":{"preventAutoRedirect":{"description":"Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n\n\nDefault: `false` (Auto Redirect is enabled.)","title":"preventAutoRedirect","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"keywords":{"description":"User-selected keyword terms for a specific page.","maxItems":5,"title":"keywords","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Keyword"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"com.wixpress.bookings.services.api.v1.ServiceNotification.Event":{"type":"string","description":"","title":"Event","enum":["Unspecified","Updated","Deleted","Created"]},"com.wixpress.bookings.services.api.v1.BusinessServicesPolicy":{"type":"object","properties":{"bookUpToXMinutesBefore":{"description":"Minimum amount of time to make a booking before the start of the booked item. For sessions, this is relative to the start time of the session. For schedules, this is relative to the start time of the first session, excluding past sessions. Defaults to 0.","title":"bookUpToXMinutesBefore","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancelRescheduleUpToXMinutesBefore":{"description":"Minimum time that a booking can be canceled or rescheduled before the session starts. Defaults to 0.","title":"cancelRescheduleUpToXMinutesBefore","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"futureBookingsPolicy":{"description":"An object specifying how far in advance a booking can be made.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.FutureBookingPolicy","summary":"futureBookingsPolicy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"waitingListPolicy":{"description":"Waitlist policy for the service. Empty by default.","$ref":"#/components/schemas/com.wixpress.bookings.services.api.v1.WaitingListPolicy","summary":"waitingListPolicy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancellationPolicy":{"description":"User defined cancellation policy message.","title":"cancellationPolicy","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BusinessServicesPolicy","description":"Defines the Bookings Policy applied to the business's services. The policy can be overridden for a service when setting the `Service.BookingsPolicy` property.\nUnless overridden, each service inherits the settings in the business policy.","x-wix-docs":{"deprecated":{}}},"com.wixpress.bookings.services.api.v1.DeleteMetadata":{"type":"object","properties":{"preserveFutureSessionsWithParticipants":{"description":"","title":"preserveFutureSessionsWithParticipants","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"participantNotification":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ParticipantNotification","summary":"participantNotification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteMetadata","description":"","x-wix-docs":{"deprecated":{}}},"com.wix.bookings.schedules.api.v1.ParticipantNotification":{"type":"object","properties":{"notifyParticipants":{"description":"Whether to send the message about the changes to the customer.\n\nDefault: `false`","title":"notifyParticipants","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"Custom message to send to the participants about the changes to the booking.","title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ParticipantNotification","description":""},"com.wix.bookings.schedules.api.v1.ScheduleNotification":{"type":"object","properties":{"preserveFutureSessionsWithParticipants":{"description":"","title":"preserveFutureSessionsWithParticipants","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"notifyParticipants":{"description":"Whether to notify participants about changed sessions. deprecated, use participant_notification","title":"notifyParticipants","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"siteProperties":{"description":"site properties. Optional. Given in create schedule notification.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.SitePropertiesOnScheduleCreation","summary":"siteProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScheduleNotification","description":"","oneOf":[{"description":"","summary":"event","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ScheduleNotification.event"}]},"com.wix.bookings.schedules.api.v1.ScheduleNotification.event":{"type":"object","title":"event","properties":{"scheduleCreated":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ScheduleCreated","summary":"scheduleCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleUpdated":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ScheduleUpdated","summary":"scheduleUpdated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleCancelled":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ScheduleCancelled","summary":"scheduleCancelled","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sessionCreated":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.SessionCreated","summary":"sessionCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sessionUpdated":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.SessionUpdated","summary":"sessionUpdated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sessionCancelled":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.SessionCancelled","summary":"sessionCancelled","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"availabilityPolicyUpdated":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.AvailabilityPolicyUpdated","summary":"availabilityPolicyUpdated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"intervalSplit":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.IntervalSplit","summary":"intervalSplit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"recurringSessionSplit":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.RecurringSessionSplit","summary":"recurringSessionSplit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleUnassignedFromUser":{"description":"Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ScheduleUnassignedFromUser","summary":"scheduleUnassignedFromUser","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}}},"com.wix.bookings.schedules.api.v1.ScheduleCreated":{"type":"object","properties":{"schedule":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule","summary":"schedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScheduleCreated","description":""},"com.wix.bookings.schedules.api.v1.ScheduleUpdated":{"type":"object","properties":{"oldSchedule":{"description":"The old schedule before the update.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule","summary":"oldSchedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newSchedule":{"description":"The new schedule after the update.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule","summary":"newSchedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"recurringSessions":{"description":"Recurring sessions updated event. If this field is given, the reason for the schedule updated event was\nupdating at least one of the given schedule's recurring sessions.\nThis event is triggered by create/update/delete recurring session apis.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.RecurringSessionsUpdated","summary":"recurringSessions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"participantNotification":{"description":"Whether to notify participants about the change and an optional custom message","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ParticipantNotification","summary":"participantNotification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether this notification was created as a result of an anonymization request, such as GDPR.\nAn anonymized participant will have the following details:\nname = \"deleted\"\nphone = \"deleted\"\nemail = \"deleted@deleted.com\"","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScheduleUpdated","description":""},"com.wix.bookings.schedules.api.v1.RecurringSessionsUpdated":{"type":"object","properties":{"oldRecurringSessions":{"description":"Old schedule's recurring session list.","title":"oldRecurringSessions","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newRecurringSessions":{"description":"New schedule's recurring session list.","title":"newRecurringSessions","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RecurringSessionsUpdated","description":""},"com.wix.bookings.schedules.api.v1.Session":{"type":"object","properties":{"id":{"description":"Session ID.","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleId":{"description":"ID of the schedule that the session belongs to.","immutable":true,"title":"scheduleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleOwnerId":{"description":"ID of the resource or service that the session's schedule belongs to.","readOnly":true,"title":"scheduleOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalStart":{"description":"Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format.","title":"originalStart","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"start":{"description":"An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.CalendarDateTime","summary":"start","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"end":{"description":"An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.\nIf the session is a recurring session, `end` must contain a `localDateTime`.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.CalendarDateTime","summary":"end","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"affectedSchedules":{"description":"An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.\nThe array is inherited from the schedule and can be overridden even if the session is a recurring session.","title":"affectedSchedules","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.LinkedSchedule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Session title.\nThe value is inherited from the schedule and can be overridden unless the session is a recurring session.","maxLength":6000,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tags":{"description":"__Deprecated.__\nTags for the session.\nThe value is inherited from the schedule and can be overridden unless the session is a recurring session.","maxLength":200,"title":"tags","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"location":{"description":"An object describing the location where the session takes place.\nDefaults to the schedule location.\nFor single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.","$ref":"#/components/schemas/com.wix.bookings.common.api.v1.Location","summary":"location","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"capacity":{"description":"Maximum number of participants that can be added to the session. Defaults to the schedule capacity.\nThe value is inherited from the schedule and can be overridden unless the session is a recurring session.","minimum":0,"maximum":1000,"title":"capacity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rate":{"description":"Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.","$ref":"#/components/schemas/com.wix.bookings.common.api.v1.Rate","summary":"rate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"timeReservedAfter":{"description":"Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.\nIf the session is a recurring session, this field must be empty.","title":"timeReservedAfter","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"notes":{"description":"Additional information about the session.\nNotes are not supported for recurring sessions.","maxLength":10000,"title":"notes","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalNumberOfParticipants":{"description":"The number of participants booked for the session. Read-only.\nCalculated as the sum of the party sizes.","readOnly":true,"title":"totalNumberOfParticipants","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"participants":{"description":"*Partial list** list of participants booked for the session.\nThe list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.\nIf the session is a recurring session, this field must be empty.\nTo retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).","title":"participants","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Participant"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inheritedFields":{"description":"A list of properties for which values were inherited from the schedule.\nThis does not include participants that were inherited from the schedule.","readOnly":true,"title":"inheritedFields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalCalendarOverrides":{"description":"__Deprecated.__","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ExternalCalendarOverrides","summary":"externalCalendarOverrides","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"status":{"description":"Session status.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"recurringIntervalId":{"description":"Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.\nFor exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.\nThis field is omitted for single sessions or instances of recurring sessions.\nSpecified when the session was originally generated from a schedule recurring interval.\nDeprecated. Use `recurringSessionId`.","readOnly":true,"title":"recurringIntervalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"recurringSessionId":{"description":"The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.","readOnly":true,"title":"recurringSessionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Session type.","title":"type","type":"string","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.SessionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"calendarConference":{"description":"A conference created for the session according to the details set in the schedule's conference provider information.\nIf the session is a recurring session, this field is inherited from the schedule.\n**Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.CalendarConference","summary":"calendarConference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"recurrence":{"description":"A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\nIf the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.\nThe RRULE defines a rule for repeating a session.\nSupported parameters are:\n\n|Keyword|Description|Supported values|\n|--|--|---|\n|`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n|`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n|`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n|`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n\n\nFor example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n`\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n\n","title":"recurrence","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceOfRecurrence":{"description":"A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.\nEmpty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.","readOnly":true,"title":"instanceOfRecurrence","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"The session version.\nComposed by the schedule, session and participants versions.","readOnly":true,"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session.Version","summary":"version","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Session","description":""},"com.wix.bookings.schedules.api.v1.CalendarDateTime":{"type":"object","properties":{"timestamp":{"description":"UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\nRequired if `localDateTime` is not specified.\nIf `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"localDateTime":{"description":"An object containing the local date and time for the business's time zone.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.LocalDateTime","summary":"localDateTime","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"The time zone. Optional. Derived from the schedule's time zone.\nIn case this field is associated with recurring session, this field is empty.","readOnly":true,"title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalendarDateTime","description":""},"com.wix.bookings.schedules.api.v1.LocalDateTime":{"type":"object","properties":{"year":{"description":"Year. 4-digit format.","title":"year","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"monthOfYear":{"description":"Month number, from 1-12.","minimum":1,"maximum":12,"title":"monthOfYear","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dayOfMonth":{"description":"Day of the month, from 1-31.","title":"dayOfMonth","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hourOfDay":{"description":"Hour of the day in 24-hour format, from 0-23.","minimum":0,"maximum":23,"title":"hourOfDay","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"minutesOfHour":{"description":"Minute, from 0-59.","minimum":0,"maximum":59,"title":"minutesOfHour","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LocalDateTime","description":""},"com.wix.bookings.schedules.api.v1.ExternalCalendarInfo":{"type":"object","properties":{"calendarType":{"description":"The external calendar type (e.g. Google Calendar, iCal, etc).","title":"calendarType","type":"string","$ref":"#/components/schemas/com.wix.bookings.externalcalendar.spi.v1.CalendarTypeEnum.CalendarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExternalCalendarInfo","description":""},"com.wix.bookings.externalcalendar.spi.v1.CalendarTypeEnum.CalendarType":{"type":"string","description":"","title":"CalendarType","enum":["UNDEFINED","GOOGLE","I_CAL","OUTLOOK","OFFICE_365","MICROSOFT","OTHER"]},"com.wix.bookings.schedules.api.v1.Session.Status":{"type":"string","description":"","title":"Status","enum":["UNDEFINED","CONFIRMED","CANCELLED"]},"com.wix.bookings.schedules.api.v1.SessionType":{"type":"string","description":"","title":"SessionType","enum":["UNDEFINED","EVENT","WORKING_HOURS","TIME_AVAILABILITY","AVAILABILITY"]},"com.wix.bookings.schedules.api.v1.Session.Version":{"type":"object","properties":{"number":{"description":"Incremental version number, which is updated on each change to the session or on changes affecting the session.","title":"number","type":"integer","format":"uint64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Version","description":""},"com.wix.bookings.schedules.api.v1.ScheduleCancelled":{"type":"object","properties":{"schedule":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule","summary":"schedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"participantNotification":{"description":"Whether to notify participants about the change and an optional custom message","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ParticipantNotification","summary":"participantNotification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldSchedule":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule","summary":"oldSchedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScheduleCancelled","description":""},"com.wix.bookings.schedules.api.v1.SessionCreated":{"type":"object","properties":{"session":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session","summary":"session","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SessionCreated","description":""},"com.wix.bookings.schedules.api.v1.SessionUpdated":{"type":"object","properties":{"oldSession":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session","summary":"oldSession","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newSession":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session","summary":"newSession","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"participantNotification":{"description":"Whether to notify participants about the change and an optional custom message","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ParticipantNotification","summary":"participantNotification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether this notification was created as a result of an anonymization request, such as GDPR.\nAn anonymized participant will have the following details:\nname = \"deleted\"\nphone = \"deleted\"\nemail = \"deleted@deleted.com\"","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SessionUpdated","description":""},"com.wix.bookings.schedules.api.v1.SessionCancelled":{"type":"object","properties":{"session":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session","summary":"session","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"participantNotification":{"description":"Whether to notify participants about the change and an optional custom message","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ParticipantNotification","summary":"participantNotification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SessionCancelled","description":""},"com.wix.bookings.schedules.api.v1.AvailabilityPolicyUpdated":{"type":"object","properties":{"availabilityPolicy":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.AvailabilityPolicy","summary":"availabilityPolicy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AvailabilityPolicyUpdated","description":""},"com.wix.bookings.schedules.api.v1.AvailabilityPolicy":{"type":"object","properties":{"splitInterval":{"description":"Specify how to split the schedule slots in intervals of minutes.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.SplitInterval","summary":"splitInterval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AvailabilityPolicy","description":"Availability policy applied to all site schedules."},"com.wix.bookings.schedules.api.v1.IntervalSplit":{"type":"object","properties":{"scheduleId":{"description":"","title":"scheduleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"intervals":{"description":"","title":"intervals","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.RecurringInterval"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newScheduleVersion":{"description":"","title":"newScheduleVersion","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldScheduleVersion":{"description":"","title":"oldScheduleVersion","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IntervalSplit","description":"","x-wix-docs":{"deprecated":{}}},"com.wix.bookings.schedules.api.v1.RecurringSessionSplit":{"type":"object","properties":{"scheduleId":{"description":"","title":"scheduleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"recurringSessions":{"description":"","title":"recurringSessions","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newScheduleVersion":{"description":"","title":"newScheduleVersion","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldScheduleVersion":{"description":"","title":"oldScheduleVersion","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RecurringSessionSplit","description":""},"com.wix.bookings.schedules.api.v1.ScheduleUnassignedFromUser":{"type":"object","properties":{"userId":{"description":"The Wix user id.","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"schedule":{"description":"The schedule that was unassigned from the user.","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule","summary":"schedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScheduleUnassignedFromUser","description":"Schedule unassigned from user."},"com.wix.bookings.schedules.api.v1.MultipleSessionsCreated":{"type":"object","properties":{"schedulesWithSessions":{"description":"","title":"schedulesWithSessions","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.ScheduleWithSessions"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MultipleSessionsCreated","description":""},"com.wix.bookings.schedules.api.v1.ScheduleWithSessions":{"type":"object","properties":{"schedule":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Schedule","summary":"schedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteProperties":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.SitePropertiesOnScheduleCreation","summary":"siteProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sessions":{"description":"","title":"sessions","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.Session"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScheduleWithSessions","description":""},"com.wix.bookings.schedules.api.v1.SitePropertiesOnScheduleCreation":{"type":"object","properties":{"timeZone":{"description":"The global time zone value.","title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SitePropertiesOnScheduleCreation","description":"","x-wix-docs":{"deprecated":{}}},"com.wix.bookings.schedules.api.v1.MigrationEvent":{"type":"object","properties":{"migrationData":{"description":"","$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.MigrationData","summary":"migrationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MigrationEvent","description":""},"com.wix.bookings.schedules.api.v1.MigrationData":{"type":"object","properties":{"businessId":{"description":"","title":"businessId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"staffs":{"description":"","title":"staffs","type":"array","items":{"$ref":"#/components/schemas/com.wix.bookings.schedules.api.v1.MigrationData.StaffData"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MigrationData","description":""},"com.wix.bookings.schedules.api.v1.MigrationData.StaffData":{"type":"object","properties":{"resourceId":{"description":"","title":"resourceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"syncRequestEmail":{"description":"","title":"syncRequestEmail","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refreshToken":{"description":"","title":"refreshToken","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StaffData","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":""},"com.wixpress.siteproperties.api.v4.SitePropertiesNotification":{"type":"object","properties":{"metasiteId":{"description":"The site ID for which this update notification applies.","title":"metasiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"event":{"description":"The actual update event.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SitePropertiesEvent","summary":"event","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translations":{"description":"A convenience set of mappings from the MetaSite ID to its constituent services.","maxItems":500,"title":"translations","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Translation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"changeContext":{"description":"Context of the notification","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ChangeContext","summary":"changeContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SitePropertiesNotification","description":"Encapsulates all details written to the Greyhound topic when a site's properties are updated."},"com.wixpress.siteproperties.api.v4.SitePropertiesEvent":{"type":"object","properties":{"version":{"description":"Version of the site's properties represented by this update.","title":"version","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"properties":{"description":"Updated properties.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Properties","summary":"properties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SitePropertiesEvent","description":"The actual update event for a particular notification."},"com.wixpress.siteproperties.api.v4.Properties":{"type":"object","properties":{"categories":{"description":"Site categories.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Categories","summary":"categories","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locale":{"description":"Site locale.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Locale","summary":"locale","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Site language.\n\nTwo-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentCurrency":{"description":"Site currency format used to bill customers.\n\nThree-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.","title":"paymentCurrency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"Timezone in `America/New_York` format.","title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Email address.","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Phone number.","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fax":{"description":"Fax number.","title":"fax","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"address":{"description":"Address.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteDisplayName":{"description":"Site display name.","title":"siteDisplayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"businessName":{"description":"Business name.","title":"businessName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"logo":{"description":"Path to the site's logo in Wix Media (without Wix Media base URL).","title":"logo","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Site description.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"businessSchedule":{"description":"Business schedule. Regular and exceptional time periods when the business is open or the service is available.\n\n__Note:__ Not supported by Wix Bookings.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessSchedule","summary":"businessSchedule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"multilingual":{"description":"Supported languages of a site and the primary language.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Multilingual","summary":"multilingual","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consentPolicy":{"description":"Cookie policy the site owner defined for their site (before the users interacts with/limits it).","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ConsentPolicy","summary":"consentPolicy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"businessConfig":{"description":"Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.\n\nSite business type.","title":"businessConfig","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalSiteUrl":{"description":"External site url that uses Wix as its headless business solution","title":"externalSiteUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackClicksAnalytics":{"description":"Track clicks analytics","title":"trackClicksAnalytics","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Properties","description":""},"com.wixpress.siteproperties.api.v4.Categories":{"type":"object","properties":{"primary":{"description":"Primary site category.","title":"primary","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"secondary":{"description":"Secondary site category.","maxItems":50,"title":"secondary","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"businessTermId":{"description":"Business Term Id","title":"businessTermId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Categories","description":""},"com.wixpress.siteproperties.api.v4.Locale":{"type":"object","properties":{"languageCode":{"description":"Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.","title":"languageCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"country":{"description":"Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Locale","description":""},"com.wixpress.siteproperties.api.v4.Address":{"type":"object","properties":{"street":{"description":"Street name.","title":"street","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"city":{"description":"City name.","title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"country":{"description":"Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"state":{"description":"State.","title":"state","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"zip":{"description":"Zip or postal code.","title":"zip","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hint":{"description":"Extra information to be displayed in the address.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.AddressHint","summary":"hint","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isPhysical":{"description":"Whether this address represents a physical location.","title":"isPhysical","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"googleFormattedAddress":{"description":"Google-formatted version of this address.","title":"googleFormattedAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"streetNumber":{"description":"Street number.","title":"streetNumber","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"apartmentNumber":{"description":"Apartment number.","title":"apartmentNumber","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"coordinates":{"description":"Geographic coordinates of location.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.GeoCoordinates","summary":"coordinates","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Address","description":""},"com.wixpress.siteproperties.api.v4.AddressHint":{"type":"object","properties":{"text":{"description":"Extra text displayed next to, or instead of, the actual address.","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"placement":{"description":"Where the extra text should be displayed.","title":"placement","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.PlacementType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddressHint","description":"Extra information on displayed addresses.\nThis is used for display purposes. Used to add additional data about the address, such as \"In the passage\".\nFree text. In addition the user can state where he wants that additional description - before, after, or instead\nthe address string."},"com.wixpress.siteproperties.api.v4.PlacementType":{"type":"string","description":"Where the extra text should be displayed: before, after or instead of the actual address.","title":"PlacementType","enum":["BEFORE","AFTER","REPLACE"]},"com.wixpress.siteproperties.api.v4.GeoCoordinates":{"type":"object","properties":{"latitude":{"description":"Latitude of the location. Must be between -90 and 90.","title":"latitude","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"longitude":{"description":"Longitude of the location. Must be between -180 and 180.","title":"longitude","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GeoCoordinates","description":"Geocoordinates for a particular address."},"com.wixpress.siteproperties.api.v4.Multilingual":{"type":"object","properties":{"supportedLanguages":{"description":"Supported languages list.","maxItems":200,"title":"supportedLanguages","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SupportedLanguage"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"autoRedirect":{"description":"Whether to redirect to user language.","title":"autoRedirect","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Multilingual","description":""},"com.wixpress.siteproperties.api.v4.SupportedLanguage":{"type":"object","properties":{"languageCode":{"description":"Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.","title":"languageCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locale":{"description":"Locale.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Locale","summary":"locale","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isPrimary":{"description":"Whether the supported language is the primary language for the site.","title":"isPrimary","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"countryCode":{"description":"Language icon.","title":"countryCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"resolutionMethod":{"description":"How the language will be resolved. For internal use.","title":"resolutionMethod","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ResolutionMethod","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SupportedLanguage","description":""},"com.wixpress.siteproperties.api.v4.ResolutionMethod":{"type":"string","description":"","title":"ResolutionMethod","enum":["QUERY_PARAM","SUBDOMAIN","SUBDIRECTORY"]},"com.wixpress.siteproperties.api.v4.ConsentPolicy":{"type":"object","properties":{"essential":{"description":"Whether the site uses cookies that are essential to site operation.","title":"essential","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"functional":{"description":"Whether the site uses cookies that affect site performance and other functional measurements.","title":"functional","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"analytics":{"description":"Whether the site uses cookies that collect analytics about how the site is used (in order to improve it).","title":"analytics","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"advertising":{"description":"Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor.","title":"advertising","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataToThirdParty":{"description":"CCPA compliance flag.","title":"dataToThirdParty","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ConsentPolicy","description":""},"com.wixpress.siteproperties.api.v4.Translation":{"type":"object","properties":{"serviceType":{"description":"The service type.","title":"serviceType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appDefId":{"description":"The application definition ID; this only applies to services of type ThirdPartyApps.","title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The instance ID of the service.","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Translation","description":"A single mapping from the MetaSite ID to a particular service."},"com.wixpress.siteproperties.api.v4.ChangeContext":{"type":"object","properties":{},"title":"ChangeContext","description":"","oneOf":[{"description":"","summary":"payload","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ChangeContext.payload"}]},"com.wixpress.siteproperties.api.v4.ChangeContext.payload":{"type":"object","title":"payload","properties":{"propertiesChange":{"description":"Properties were updated.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.PropertiesChange","summary":"propertiesChange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteCreated":{"description":"Default properties were created on site creation.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SiteCreated","summary":"siteCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteCloned":{"description":"Properties were cloned on site cloning.","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SiteCloned","summary":"siteCloned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.siteproperties.api.v4.PropertiesChange":{"type":"object","properties":{},"title":"PropertiesChange","description":""},"com.wixpress.siteproperties.api.v4.SiteCreated":{"type":"object","properties":{"originTemplateId":{"description":"Origin template site id.","title":"originTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteCreated","description":""},"com.wixpress.siteproperties.api.v4.SiteCloned":{"type":"object","properties":{"originMetaSiteId":{"description":"Origin site id.","title":"originMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteCloned","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":"Service Options And Variants","description":"The `serviceOptionsAndVariants` object links a service to its variants.\nYou can use it to offer customers different prices for a service,\ndepending on which choices they book.\nRead more about [service options and variants](https://wix.wixanswers.com/app/kb/article/2e91a25b-b3c2-4cf7-9005-429a4929fc36/en).","fqdn":"wix.bookings.catalog.v1.service_options_and_variants"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Wix Bookings Service Options and Variants API\n\n\nWith the Wix Bookings Service Options and Variants API, you can manage custom options \nand variants for services. This allows site owners to offer different prices for the \nsame service based on their customers' choices. \n\n\nYou can read more about using the:\n+ [Wix Bookings Pricing API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ef82416f-27e1-4092-98cc-68e6f8732988slug::introduction*fallback::https://dev.wix.com/api/rest/wix-bookings/pricing/introduction) to preview and calculate the price.\n+ [Wix Bookings Pricing Provider service plugin](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ef82416f-27e1-4092-98cc-68e6f8732988slug::introduction*fallback::https://dev.wix.com/api/rest/wix-bookings/pricing-integration-spi/introduction) that allows site owners to implement custom pricing logic.\n\n\n## Checking for Existing Pricing Options \n\nYou can check whether a service has existing pricing options, and what they are, by retrieving the\n`rate` object of the service's active schedule. Check [this flow](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::sample-flows#create-staff-member-based-service-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/sample-flows#create-staff-member-based-service-variants) for more details. \n\nThere are 3 different possible rates:\n\n + `labeledPriceOptions`: For services with the standard Wix Bookings pricing.\n + `priceText`: For services with prices manually set by the business.\n + `defaultPrice`: For services with [varied pricing](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ef82416f-27e1-4092-98cc-68e6f8732988slug::introduction*fallback::https://dev.wix.com/api/rest/wix-bookings/pricing/introduction).\n\nIf any of these 3 rates are defined in the service's active schedule, pricing options have already been defined.\n\n\n## Terminology\n\nFor a comprehensive glossary of Wix Bookings terms, see [Terminology](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/terminology).\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n+ Only a single [`serviceOptionsAndVariants`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::service-options-and-variants-object*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/service-options-and-variants-object) object is supported per service.\n\n+ Currently, only a single option is supported per `serviceOptionsAndVariants` object.\n\n+ You need to manually calculate and then pass all variants in the request of \n [Create Service Options And Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::create-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/create-service-options-and-variants). \n Variants aren't automatically calculated from the specified options.\n\n+ New variants are automatically created for services with staff member-based \n options whenever a new staff member is added to the service. The new \n variant gets the default price specified in the service's\n `schedule.rate.default_varied_price`.\n\n+ Variants are automatically deleted for services with staff member based \n options whenever a staff member is removed from the service or the \n business.\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flows\n\nThis article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.\n\n## Create staff member-based service variants\n\n\nYour app can set up staff member-based service variants. This allows the site \nowner to offer customers different service prices depending on which \nstaff member is providing the service.\n\n1. Identify the relevant service ID. For example, call \n [List services](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::5eae4d27-844a-493f-aaf0-99a6899c3dfbslug::list-services*fallback::https://dev.wix.com/api/rest/wix-bookings/services/service/list-services) \n and choose the service you want to create options and variants for.\n\n1. Pass the `serviceId` inside the `scheduleOwnerIds` array in the \n [List schedules](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::92d4aa03-937b-4091-bcb9-b6df0aeca354slug::list-schedules*fallback::https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/list-schedules) \n call. This retrieves all schedules related to the service.\n\n1. Identify the active schedule from retrieved schedules. The active schedule \n has a `status` of `CREATED` in contrast to all other retrieved schedules.\n\n1. Save the `scheduleOwnerId` from the active schedule's \n `availability.linkedSchedules` array. These are the IDs of the staff members \n providing this service.\n\n1. Call [Create Service Options and Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::create-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/create-service-options-and-variants) \n and pass the relevant `serviceId`, `STAFF_MEMBER` (in the `options.type` field), \n as well as the IDs of all staff members providing the service in the \n `variants.choices` array. You can specify the price for each staff member \n in `variants.price`.\n\n\n## Create service variants based on the booked equipment \n\nYour app can set up service variants based on the booked equipment. This allows \nthem to offer customers different service prices depending on what \nequipment the customer has booked.\n\n1. Identify the relevant service ID. For example, call \n [List services](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::5eae4d27-844a-493f-aaf0-99a6899c3dfbslug::list-services*fallback::https://dev.wix.com/api/rest/wix-bookings/services/service/list-services) \n and choose the service you want to create options and variants for.\n\n1. Call [Create Service Options and Variants](fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-andvariants/create-service-options-and-variants) \n and pass the relevant `serviceId`, `CUSTOM` (in the `options.type` field), \n `Equipment` (in the `options.customData.name` field), as well as all \n supported equipment in the `options.customData.choices` array. Make sure to \n also pass all supported `variants`. You can specify the price for each \n variant in `variants.price`.\n"},{"displayName":"Supported Filters","slugifyName":"supported-filters","content":"# Service Variants and Options: Supported Filters and Sorting\n\nQuery endpoints allow you to filter and sort results based on service variant and\noptions properties. This article covers field support for filtering and sorting.\n\n## Filtering\n\nSpecify the [Query Service Options and Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::query-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/query-service-options-and-variants) `filter` object in the following format: \n\n```json\n\"filter\" : \n { \n \"fieldName\": \"value\",\n }\n```\n\n\nThe following table shows field support for filters and sorting\nfor the `serviceOptionsAndVariants` object:\n\n| Field | Supported Filters | Sortable |\n| --------------- | --------------------------------------------- | --------------- |\n| `id` | `$eq`, `$ne`, `$in` | Sortable |\n| `serviceId` | `$eq`, `$ne`, `$in` | |\n| `options.values` | `$exists` | | \n| `options.values.id` | `$hasSome`, `$hasAll` | | \n| `options.values.type` | `$hasSome`, `$hasAll` | | \n| `options.values.optionSpecificData.customData.name` | `$hasSome`, `$hasAll` | | \n| `variants.values` | `$exists` | | \n| `variants.values.choices.choice.custom.value` | `$hasSome`, `$hasAll` | | \n| `variants.values.price` | `$hasSome`, `$hasAll` | |\n| `variants.values.choices.optionId` | `$hasSome`, `$hasAll` | |\n\n\n\n## Sorting \n\n[Query Service Options and Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::query-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/query-service-options-and-variants) \nruns with this default:\n\n- sorted by `id` in `ASC` order\n\n\nSpecify the `sort` object in the following format:\n\n```json\n\"sort\" : [ \n { \n \"fieldName\":\"sortField1\",\n \"order\":\"ASC\"\n },\n { \n \"fieldName\":\"sortField2\",\n \"order\":\"ASC\"\n },\n]\n```\n\n\n## Paging \n\nBy default `pagingMetadata.cursors` are returned, unless you specifically pass \n`query.paging`.\n\nThe maximum for `cursorPaging.limit` is `100`.\n\nIf you pass a cursor token that you have received in a previous query response, \npassing additional sort or filter information results in an invalid cursor \nerror. This is because the received cursor token already holds all the needed information \nfor sort and filter. Changing the sort and filter properties during the span of \na cursor query isn't supported. You may provide a different limit though.\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+ [Sorting and Paging](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::070cf69c-a779-4b95-b522-a094d30dff2f*fallback::https://dev.wix.com/api/rest/getting-started/sorting-and-paging)\n+ [Field Projection](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::eaf4d3d6-5b76-489f-8839-f66476be32e6*fallback::https://dev.wix.com/api/rest/getting-started/field-projection)\n+ [Query Service Options and Variants endpoint](fallback::https://dev.wix.com/api/rest/wix-bookings/services/query-service-options-and-variants)\n"},{"displayName":"Error Messages","slugifyName":"error-messages","content":"# Wix Bookings Service Options and Variants Errors\n\n\nThis articles outlines error messages that might be issued when calling \nendpoints of the Wix Bookings Service Options and Variants API.\n\n\n## Create Service Options and Variants Errors\n\n\nThe [Create Service Options and Variants](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ddd7c621-7b08-406b-ae54-d14d68f4ae81slug::create-service-options-and-variants*fallback::https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/create-service-options-and-variants) endpoint might issue the following error messages:\n\n|

HTTP status

Error code

Error message

Troubleshooting

HTTP status

Error code

Error message

Troubleshooting

Get Service Options And Variants By Service Id

Permission Scopes