inner content

{"id":"80f2f663-579f-452d-83d9-c221d263bb4c","createdDate":"2024-09-17T15:02:59.685Z","updatedDate":"2024-09-17T15:02:59.685Z","resourceId":"6623518e-0657-4085-a3b2-79163c1cf7f8","api":{"schema":{"object":{"displayName":"Ticket Definition Object","description":"","slug":"ticket-definition-object","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","legacyExamples":[{"title":"TicketDefinition","content":"{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T11:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policy_text\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 3,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n}"}],"sourceRepo":"git@github.com:wix-private/events.git"},"methods":[{"summary":"Create Ticket Definition","description":"Creates a ticket definition. Allowed to create up to 100 definitions per event.","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.CreateTicketDefinition","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.CreateTicketDefinitionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateTicketDefinitionRequest","description":"","properties":{"ticketDefinition":{"description":"Ticket definition info.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ticketDefinition","ticketDefinition.eventId","ticketDefinition.name","ticketDefinition.pricingMethod.price","ticketDefinition.pricingMethod","ticketDefinition.feeType"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_EVENT_TYPE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TICKET_DEFINITIONS_LIMIT_REACHED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SALE_PERIOD"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.CreateTicketDefinitionRequest","responseMessage":"wix.events.ticketdef.v3.CreateTicketDefinitionResponse"},"legacyExamples":[{"name":"CreateTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","order":2,"content":{"title":"Create ticket definition with donation","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"ticketDefinition\": {\n \"eventId\": \"39d16ecc-0ec8-4764-8077-8e991f20ef9d\",\n \"name\": \"Gospel Concert\",\n \"description\": \"Experience the uplifting power of gospel music at our awe-inspiring Gospel Concert. Join us for an unforgettable evening filled with soul-stirring melodies, powerful harmonies, and heartfelt performances by renowned gospel artists. Let your spirit soar as you immerse yourself in the joyous celebration of faith, music, and unity at this not-to-be-missed event.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"initialLimit\": 50,\n \"pricingMethod\": {\n \"guestPrice\": {\n \"value\": \"2.00\",\n \"currency\": \"USD\"\n }\n },\n \"feeType\": \"FEE_ADDED_AT_CHECKOUT\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-28T10:00:00Z\",\n \"endDate\": \"2023-07-08T00:00:00Z\",\n \"displayNotOnSale\": false\n }\n },\n \"fields\": [\"SALES_DETAILS\"]\n}'","response":"{\n \"ticketDefinition\": {\n \"id\": \"7ffbabb4-708c-449b-a956-78d153cd1faa\",\n \"eventId\": \"39d16ecc-0ec8-4764-8077-8e991f20ef9d\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T12:06:15.815Z\",\n \"updatedDate\": \"2023-05-25T12:06:15.815Z\",\n \"name\": \"Gospel Concert\",\n \"description\": \"Experience the uplifting power of gospel music at our awe-inspiring Gospel Concert. Join us for an unforgettable evening filled with soul-stirring melodies, powerful harmonies, and heartfelt performances by renowned gospel artists. Let your spirit soar as you immerse yourself in the joyous celebration of faith, music, and unity at this not-to-be-missed event.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 50,\n \"actualLimit\": 50,\n \"pricingMethod\": {\n \"guestPrice\": {\n \"value\": \"2.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"DONATION\",\n \"free\": false\n },\n \"feeType\": \"FEE_ADDED_AT_CHECKOUT\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-28T10:00:00Z\",\n \"endDate\": \"2023-07-08T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 50,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n}"}},{"name":"CreateTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","order":3,"content":{"title":"Create ticket definition with with adult/student prices","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"ticketDefinition\": {\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"name\": \"Shoemaking for Beginners\",\n \"description\": \"Embark on a fascinating journey into the world of shoemaking at our Shoemaking for Beginners event. Discover the art and craftsmanship behind creating your own pair of shoes as our expert instructors guide you through each step of the process. From designing to pattern-making and assembling, this hands-on workshop is your gateway to mastering the fundamentals of shoemaking and unleashing your inner designer.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"initialLimit\": 12,\n \"\"pricingMethod\": {\n \"pricingOptions\": {\n \"optionDetails\": [\n {\n \"id\": \"e63f7f77-ce5d-487b-b585-af30d103fbc8\",\n \"name\": \"Regular Ticket\",\n \"price\": {\n \"value\": \"50.00\",\n \"currency\": \"USD\"\n }\n },\n {\n \"optionId\": \"6e409caa-6183-47f1-b0d6-c78b7047f3b2\",\n \"name\": \"Student Ticket\",\n \"price\": {\n \"value\": \"25.00\",\n \"currency\": \"USD\"\n }\n }\n ]\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-07-14T10:00:00Z\",\n \"endDate\": \"2023-07-22T00:00:00Z\",\n \"displayNotOnSale\": false\n }\n },\n \"fields\": [\"SALES_DETAILS\"]\n}'","response":"{\n \"ticketDefinition\": {\n \"id\": \"625115fd-31cb-4f64-b7bd-06c3137486c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T12:41:24.422Z\",\n \"updatedDate\": \"2023-05-25T12:41:24.422Z\",\n \"name\": \"Shoemaking for Beginners\",\n \"description\": \"Embark on a fascinating journey into the world of shoemaking at our Shoemaking for Beginners event. Discover the art and craftsmanship behind creating your own pair of shoes as our expert instructors guide you through each step of the process. From designing to pattern-making and assembling, this hands-on workshop is your gateway to mastering the fundamentals of shoemaking and unleashing your inner designer.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 12,\n \"actualLimit\": 12,\n \"pricingMethod\": {\n \"pricingOptions\": {\n \"optionDetails\": [\n {\n \"optionId\": \"e63f7f77-ce5d-487b-b585-af30d103fbc8\",\n \"name\": \"Regular Ticket\",\n \"price\": {\n \"value\": \"50.00\",\n \"currency\": \"USD\"\n }\n },\n {\n \"optionId\": \"6e409caa-6183-47f1-b0d6-c78b7047f3b2\",\n \"name\": \"Student Ticket\",\n \"price\": {\n \"value\": \"25.00\",\n \"currency\": \"USD\"\n }\n }\n ]\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-07-14T10:00:00Z\",\n \"endDate\": \"2023-07-22T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 12,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n}"}},{"name":"CreateTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","order":1,"content":{"title":"Create ticket definition with a fixed price","request":"curl -X POST 'cv3/ticket-definitions' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"ticketDefinition\": {\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"initialLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200\",\n \"currency\": \"USD\"\n }\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n }\n },\n \"fields\": [\"SALES_DETAILS\"]\n}'","response":"{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T11:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 3,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"post","path":"/v3/ticket-definitions","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_EVENT_TYPE"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TICKET_DEFINITIONS_LIMIT_REACHED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SALE_PERIOD"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.CreateTicketDefinitionRequest","responseMessage":"wix.events.ticketdef.v3.CreateTicketDefinitionResponse"},"legacyExamples":[{"name":"CreateTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","order":2,"content":{"title":"Create ticket definition with donation","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"ticketDefinition\": {\n \"eventId\": \"39d16ecc-0ec8-4764-8077-8e991f20ef9d\",\n \"name\": \"Gospel Concert\",\n \"description\": \"Experience the uplifting power of gospel music at our awe-inspiring Gospel Concert. Join us for an unforgettable evening filled with soul-stirring melodies, powerful harmonies, and heartfelt performances by renowned gospel artists. Let your spirit soar as you immerse yourself in the joyous celebration of faith, music, and unity at this not-to-be-missed event.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"initialLimit\": 50,\n \"pricingMethod\": {\n \"guestPrice\": {\n \"value\": \"2.00\",\n \"currency\": \"USD\"\n }\n },\n \"feeType\": \"FEE_ADDED_AT_CHECKOUT\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-28T10:00:00Z\",\n \"endDate\": \"2023-07-08T00:00:00Z\",\n \"displayNotOnSale\": false\n }\n },\n \"fields\": [\"SALES_DETAILS\"]\n}'","response":"{\n \"ticketDefinition\": {\n \"id\": \"7ffbabb4-708c-449b-a956-78d153cd1faa\",\n \"eventId\": \"39d16ecc-0ec8-4764-8077-8e991f20ef9d\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T12:06:15.815Z\",\n \"updatedDate\": \"2023-05-25T12:06:15.815Z\",\n \"name\": \"Gospel Concert\",\n \"description\": \"Experience the uplifting power of gospel music at our awe-inspiring Gospel Concert. Join us for an unforgettable evening filled with soul-stirring melodies, powerful harmonies, and heartfelt performances by renowned gospel artists. Let your spirit soar as you immerse yourself in the joyous celebration of faith, music, and unity at this not-to-be-missed event.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 50,\n \"actualLimit\": 50,\n \"pricingMethod\": {\n \"guestPrice\": {\n \"value\": \"2.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"DONATION\",\n \"free\": false\n },\n \"feeType\": \"FEE_ADDED_AT_CHECKOUT\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-28T10:00:00Z\",\n \"endDate\": \"2023-07-08T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 50,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n}"}},{"name":"CreateTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","order":3,"content":{"title":"Create ticket definition with with adult/student prices","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"ticketDefinition\": {\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"name\": \"Shoemaking for Beginners\",\n \"description\": \"Embark on a fascinating journey into the world of shoemaking at our Shoemaking for Beginners event. Discover the art and craftsmanship behind creating your own pair of shoes as our expert instructors guide you through each step of the process. From designing to pattern-making and assembling, this hands-on workshop is your gateway to mastering the fundamentals of shoemaking and unleashing your inner designer.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"initialLimit\": 12,\n \"\"pricingMethod\": {\n \"pricingOptions\": {\n \"optionDetails\": [\n {\n \"id\": \"e63f7f77-ce5d-487b-b585-af30d103fbc8\",\n \"name\": \"Regular Ticket\",\n \"price\": {\n \"value\": \"50.00\",\n \"currency\": \"USD\"\n }\n },\n {\n \"optionId\": \"6e409caa-6183-47f1-b0d6-c78b7047f3b2\",\n \"name\": \"Student Ticket\",\n \"price\": {\n \"value\": \"25.00\",\n \"currency\": \"USD\"\n }\n }\n ]\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-07-14T10:00:00Z\",\n \"endDate\": \"2023-07-22T00:00:00Z\",\n \"displayNotOnSale\": false\n }\n },\n \"fields\": [\"SALES_DETAILS\"]\n}'","response":"{\n \"ticketDefinition\": {\n \"id\": \"625115fd-31cb-4f64-b7bd-06c3137486c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T12:41:24.422Z\",\n \"updatedDate\": \"2023-05-25T12:41:24.422Z\",\n \"name\": \"Shoemaking for Beginners\",\n \"description\": \"Embark on a fascinating journey into the world of shoemaking at our Shoemaking for Beginners event. Discover the art and craftsmanship behind creating your own pair of shoes as our expert instructors guide you through each step of the process. From designing to pattern-making and assembling, this hands-on workshop is your gateway to mastering the fundamentals of shoemaking and unleashing your inner designer.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 12,\n \"actualLimit\": 12,\n \"pricingMethod\": {\n \"pricingOptions\": {\n \"optionDetails\": [\n {\n \"optionId\": \"e63f7f77-ce5d-487b-b585-af30d103fbc8\",\n \"name\": \"Regular Ticket\",\n \"price\": {\n \"value\": \"50.00\",\n \"currency\": \"USD\"\n }\n },\n {\n \"optionId\": \"6e409caa-6183-47f1-b0d6-c78b7047f3b2\",\n \"name\": \"Student Ticket\",\n \"price\": {\n \"value\": \"25.00\",\n \"currency\": \"USD\"\n }\n }\n ]\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-07-14T10:00:00Z\",\n \"endDate\": \"2023-07-22T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 12,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n}"}},{"name":"CreateTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","order":1,"content":{"title":"Create ticket definition with a fixed price","request":"curl -X POST 'cv3/ticket-definitions' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"ticketDefinition\": {\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"initialLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200\",\n \"currency\": \"USD\"\n }\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n }\n },\n \"fields\": [\"SALES_DETAILS\"]\n}'","response":"{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T11:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 3,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Create Ticket Definition","slugifiedName":"create-ticket-definition"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true},{"summary":"Update Ticket Definition","description":"Updates a ticket definition.\n\nEach time the ticket definition is updated, `revision` increments by 1. The existing `revision` must be included when updating the ticket definition. This ensures you're working with the latest ticket definition and prevents unintended overwrites.","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.UpdateTicketDefinition","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"ticketDefinition.id","description":"Ticket definition ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.UpdateTicketDefinitionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateTicketDefinitionRequest","description":"","properties":{"ticketDefinition":{"description":"Ticket definition to update.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ticketDefinition","ticketDefinition.revision","ticketDefinition.id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SALE_PERIOD"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.UpdateTicketDefinitionRequest","responseMessage":"wix.events.ticketdef.v3.UpdateTicketDefinitionResponse"},"legacyExamples":[{"name":"UpdateTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Update ticket definition","request":"curl -X PATCH 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/aaf51c30-a61c-473e-96be-a42dfa5064c0' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"name\": \"Leather Workshop\",\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n }\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-08T10:00:00Z\"\n },\n },\n \"mask\": {\n \"salePeriod.startDate\"\n }\n}'","response":"{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T13:44:58.775Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-08T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_STARTED\",\n \"salesDetails\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"patch","path":"/v3/ticket-definitions/{ticketDefinition.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_SALE_PERIOD"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.UpdateTicketDefinitionRequest","responseMessage":"wix.events.ticketdef.v3.UpdateTicketDefinitionResponse"},"legacyExamples":[{"name":"UpdateTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Update ticket definition","request":"curl -X PATCH 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/aaf51c30-a61c-473e-96be-a42dfa5064c0' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"name\": \"Leather Workshop\",\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n }\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-08T10:00:00Z\"\n },\n },\n \"mask\": {\n \"salePeriod.startDate\"\n }\n}'","response":"{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T13:44:58.775Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-08T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_STARTED\",\n \"salesDetails\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Update Ticket Definition","slugifiedName":"update-ticket-definition"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true},{"summary":"Get Ticket Definition","description":"Retrieves a ticket definition by ID.","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.GetTicketDefinition","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"ticketDefinitionId","description":"Ticket definition ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fields","in":"query","description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","required":false,"schema":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.GetTicketDefinitionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.GetTicketDefinitionRequest","responseMessage":"wix.events.ticketdef.v3.GetTicketDefinitionResponse"},"legacyExamples":[{"name":"GetTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Get ticket definition","request":"curl -X GET 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/aaf51c30-a61c-473e-96be-a42dfa5064c0' \\\n-H 'Authorization: '","response":"{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T11:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"get","path":"/v3/ticket-definitions/{ticketDefinitionId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.GetTicketDefinitionRequest","responseMessage":"wix.events.ticketdef.v3.GetTicketDefinitionResponse"},"legacyExamples":[{"name":"GetTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Get ticket definition","request":"curl -X GET 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/aaf51c30-a61c-473e-96be-a42dfa5064c0' \\\n-H 'Authorization: '","response":"{\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T11:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Get Ticket Definition","slugifiedName":"get-ticket-definition"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true},{"summary":"Delete Ticket Definition","description":"Permanently deletes a ticket definition.","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.DeleteTicketDefinition","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"ticketDefinitionId","description":"ID of the ticket definition to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.DeleteTicketDefinitionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.DeleteTicketDefinitionRequest","responseMessage":"wix.events.ticketdef.v3.DeleteTicketDefinitionResponse"},"legacyExamples":[{"name":"DeleteTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Delete ticket definition","request":"curl -X DELETE 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/625115fd-31cb-4f64-b7bd-06c3137486c0' \\\n-H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"delete","path":"/v3/ticket-definitions/{ticketDefinitionId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.DeleteTicketDefinitionRequest","responseMessage":"wix.events.ticketdef.v3.DeleteTicketDefinitionResponse"},"legacyExamples":[{"name":"DeleteTicketDefinition","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Delete ticket definition","request":"curl -X DELETE 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/625115fd-31cb-4f64-b7bd-06c3137486c0' \\\n-H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Delete Ticket Definition","slugifiedName":"delete-ticket-definition"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true},{"summary":"Reorder Ticket Definitions","description":"Changes ticket definitions order in an event dashboard and the list of available tickets in the ticket picker.\n> **Note:** It is possible to use both `beforeTicketDefinitionId` and `afterTicketDefinitionId` at the same time but only the last one defined will be executed.","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.ReorderTicketDefinitions","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.ReorderTicketDefinitionsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ReorderTicketDefinitionsRequest","description":"","properties":{"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ticketDefinitionId":{"description":"Ticket definition ID.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"referenceDefinition","$ref":"#/components/schemas/wix.events.ticketdef.v3.ReorderTicketDefinitionsRequest.referenceDefinition"}],"required":["ticketDefinitionId","eventId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_REORDER_INSTRUCTION"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.ReorderTicketDefinitionsRequest","responseMessage":"wix.events.ticketdef.v3.ReorderTicketDefinitionsResponse"},"legacyExamples":[{"name":"ReorderTicketDefinitions","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Reorder ticket definitions","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/reorder' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"ticketDefinitionId\": \"625115fd-31cb-4f64-b7bd-06c3137486c0\",\n \"beforeTicketDefinitionId\": \"7ffbabb4-708c-449b-a956-78d153cd1faa\"\n}'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"post","path":"/v3/ticket-definitions/reorder","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_REORDER_INSTRUCTION"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.ReorderTicketDefinitionsRequest","responseMessage":"wix.events.ticketdef.v3.ReorderTicketDefinitionsResponse"},"legacyExamples":[{"name":"ReorderTicketDefinitions","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Reorder ticket definitions","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/reorder' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"ticketDefinitionId\": \"625115fd-31cb-4f64-b7bd-06c3137486c0\",\n \"beforeTicketDefinitionId\": \"7ffbabb4-708c-449b-a956-78d153cd1faa\"\n}'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Reorder Ticket Definitions","slugifiedName":"reorder-ticket-definitions"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true},{"summary":"Query Ticket Definitions","description":"Retrieves a list of ticket definitions, given the provided paging, filtering, and sorting.\nQuery Ticket Definitions runs with these defaults, which you can override:\n- `createdDate` is sorted in `ASC` order\n- `paging.limit` is `100`\n- `paging.offset` is `0`\n
\nFor field support for filters and sorting, see [Ticket Definitions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/filter-and-sort).\nTo learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.QueryTicketDefinitions","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.QueryTicketDefinitionsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryTicketDefinitionsRequest","description":"","properties":{"query":{"description":"Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.QueryTicketDefinitionsRequest","responseMessage":"wix.events.ticketdef.v3.QueryTicketDefinitionsResponse"},"legacyExamples":[{"name":"QueryTicketDefinitions","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Query ticket definitions by created date with sales details","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2023-05-25T00:00:00.000Z\"\n }\n },\n \"fields\": [ \"SALES_DETAILS\" ]\n }\n}'","response":"{\n \"ticketDefinitions\": [\n {\n \"id\": \"625115fd-31cb-4f64-b7bd-06c3137486c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T12:41:24.422Z\",\n \"updatedDate\": \"2023-05-25T12:41:24.422Z\",\n \"name\": \"Shoemaking for Beginners\",\n \"description\": \"Embark on a fascinating journey into the world of shoemaking at our Shoemaking for Beginners event. Discover the art and craftsmanship behind creating your own pair of shoes as our expert instructors guide you through each step of the process. From designing to pattern-making and assembling, this hands-on workshop is your gateway to mastering the fundamentals of shoemaking and unleashing your inner designer.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 12,\n \"actualLimit\": 12,\n \"pricingMethod\": {\n \"pricingOptions\": {\n \"optionDetails\": [\n {\n \"optionId\": \"e63f7f77-ce5d-487b-b585-af30d103fbc8\",\n \"name\": \"Regular Ticket\",\n \"price\": {\n \"value\": \"50.00\",\n \"currency\": \"USD\"\n }\n },\n {\n \"optionId\": \"6e409caa-6183-47f1-b0d6-c78b7047f3b2\",\n \"name\": \"Student Ticket\",\n \"price\": {\n \"value\": \"25.00\",\n \"currency\": \"USD\"\n }\n }\n ]\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-07-14T10:00:00Z\",\n \"endDate\": \"2023-07-22T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 12,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n },\n {\n \"id\": \"7ffbabb4-708c-449b-a956-78d153cd1faa\",\n \"eventId\": \"39d16ecc-0ec8-4764-8077-8e991f20ef9d\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T12:06:15.815Z\",\n \"updatedDate\": \"2023-05-25T12:06:15.815Z\",\n \"name\": \"Gospel Concert\",\n \"description\": \"Experience the uplifting power of gospel music at our awe-inspiring Gospel Concert. Join us for an unforgettable evening filled with soul-stirring melodies, powerful harmonies, and heartfelt performances by renowned gospel artists. Let your spirit soar as you immerse yourself in the joyous celebration of faith, music, and unity at this not-to-be-missed event.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 50,\n \"actualLimit\": 50,\n \"pricingMethod\": {\n \"guestPrice\": {\n \"value\": \"2.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"DONATION\",\n \"free\": false\n },\n \"feeType\": \"FEE_ADDED_AT_CHECKOUT\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-28T10:00:00Z\",\n \"endDate\": \"2023-07-08T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 3,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": null,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"post","path":"/v3/ticket-definitions/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.QueryTicketDefinitionsRequest","responseMessage":"wix.events.ticketdef.v3.QueryTicketDefinitionsResponse"},"legacyExamples":[{"name":"QueryTicketDefinitions","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Query ticket definitions by created date with sales details","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/query' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"query\": {\n \"filter\": {\n \"createdDate\": {\n \"$gt\": \"2023-05-25T00:00:00.000Z\"\n }\n },\n \"fields\": [ \"SALES_DETAILS\" ]\n }\n}'","response":"{\n \"ticketDefinitions\": [\n {\n \"id\": \"625115fd-31cb-4f64-b7bd-06c3137486c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T12:41:24.422Z\",\n \"updatedDate\": \"2023-05-25T12:41:24.422Z\",\n \"name\": \"Shoemaking for Beginners\",\n \"description\": \"Embark on a fascinating journey into the world of shoemaking at our Shoemaking for Beginners event. Discover the art and craftsmanship behind creating your own pair of shoes as our expert instructors guide you through each step of the process. From designing to pattern-making and assembling, this hands-on workshop is your gateway to mastering the fundamentals of shoemaking and unleashing your inner designer.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 12,\n \"actualLimit\": 12,\n \"pricingMethod\": {\n \"pricingOptions\": {\n \"optionDetails\": [\n {\n \"optionId\": \"e63f7f77-ce5d-487b-b585-af30d103fbc8\",\n \"name\": \"Regular Ticket\",\n \"price\": {\n \"value\": \"50.00\",\n \"currency\": \"USD\"\n }\n },\n {\n \"optionId\": \"6e409caa-6183-47f1-b0d6-c78b7047f3b2\",\n \"name\": \"Student Ticket\",\n \"price\": {\n \"value\": \"25.00\",\n \"currency\": \"USD\"\n }\n }\n ]\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-07-14T10:00:00Z\",\n \"endDate\": \"2023-07-22T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 12,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n },\n {\n \"id\": \"7ffbabb4-708c-449b-a956-78d153cd1faa\",\n \"eventId\": \"39d16ecc-0ec8-4764-8077-8e991f20ef9d\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T12:06:15.815Z\",\n \"updatedDate\": \"2023-05-25T12:06:15.815Z\",\n \"name\": \"Gospel Concert\",\n \"description\": \"Experience the uplifting power of gospel music at our awe-inspiring Gospel Concert. Join us for an unforgettable evening filled with soul-stirring melodies, powerful harmonies, and heartfelt performances by renowned gospel artists. Let your spirit soar as you immerse yourself in the joyous celebration of faith, music, and unity at this not-to-be-missed event.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 50,\n \"actualLimit\": 50,\n \"pricingMethod\": {\n \"guestPrice\": {\n \"value\": \"2.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"DONATION\",\n \"free\": false\n },\n \"feeType\": \"FEE_ADDED_AT_CHECKOUT\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-28T10:00:00Z\",\n \"endDate\": \"2023-07-08T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\",\n \"salesDetails\": {\n \"unsoldCount\": 3,\n \"soldCount\": 0,\n \"reservedCount\": 0,\n \"soldOut\": false\n }\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": null,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Query Ticket Definitions","slugifiedName":"query-ticket-definitions"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true},{"summary":"Count Ticket Definitions","description":"Counts ticket definitions by the `saleStatus` and `hidden` fields.

\nTo learn about working with _query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.CountTicketDefinitions","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.CountTicketDefinitionsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CountTicketDefinitionsRequest","description":"","properties":{"filter":{"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"facet":{"description":"Parameters to count ticket definitions by.\n\n- Max: 20 facets.","maxLength":100,"maxItems":20,"title":"facet","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FILTER_PARSER_ERROR"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.CountTicketDefinitionsRequest","responseMessage":"wix.events.ticketdef.v3.CountTicketDefinitionsResponse"},"legacyExamples":[{"name":"CountTicketDefinitions","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Count ticket definitions by the \"Sale started\" status","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/count' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"saleStatus\": {\n \"$eq\": \"SALE_STARTED\"\n }\n },\n \"facet\": [\"saleStatus\"]\n}'","response":"{\n \"metadata\": {\n \"total\": 4\n },\n \"facets\": {\n \"saleStatus\": {\n \"counts\": {\n \"SALE_STARTED\": 4\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"post","path":"/v3/ticket-definitions/count","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"FILTER_PARSER_ERROR"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.CountTicketDefinitionsRequest","responseMessage":"wix.events.ticketdef.v3.CountTicketDefinitionsResponse"},"legacyExamples":[{"name":"CountTicketDefinitions","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Count ticket definitions by the \"Sale started\" status","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/ticket-definitions/count' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"filter\": {\n \"saleStatus\": {\n \"$eq\": \"SALE_STARTED\"\n }\n },\n \"facet\": [\"saleStatus\"]\n}'","response":"{\n \"metadata\": {\n \"total\": 4\n },\n \"facets\": {\n \"saleStatus\": {\n \"counts\": {\n \"SALE_STARTED\": 4\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Count Ticket Definitions","slugifiedName":"count-ticket-definitions"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true},{"summary":"Bulk Delete Ticket Definitions By Filter","description":"Deletes multiple ticket definitions.\n\nAll ticket definitions that meet the specified `filter` criteria are deleted.","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.BulkDeleteTicketDefinitionsByFilter","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.BulkDeleteTicketDefinitionsByFilterResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteTicketDefinitionsByFilterRequest","description":"","properties":{"filter":{"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`.

**Example:**
`\"filter\" : { \"eventId\": \"3d3d5c04-ece0-45a8-85f0-11a58edaa192\" }`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["filter"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.BulkDeleteTicketDefinitionsByFilterRequest","responseMessage":"wix.events.ticketdef.v3.BulkDeleteTicketDefinitionsByFilterResponse"},"legacyExamples":[{"name":"BulkDeleteTicketDefinitionsByFilter","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Bulk delete ticket definitions by filter","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/bulk/ticket-definitions/delete' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n \"filter\": {\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"post","path":"/v3/bulk/ticket-definitions/delete","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.BulkDeleteTicketDefinitionsByFilterRequest","responseMessage":"wix.events.ticketdef.v3.BulkDeleteTicketDefinitionsByFilterResponse"},"legacyExamples":[{"name":"BulkDeleteTicketDefinitionsByFilter","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Bulk delete ticket definitions by filter","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/events-ticket-definitions/v3/bulk/ticket-definitions/delete' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n \"filter\": {\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\"\n }\n}'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Bulk Delete Ticket Definitions By Filter","slugifiedName":"bulk-delete-ticket-definitions-by-filter"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true},{"summary":"Change Currency","description":"Changes ticket price currency per event.","operationId":"wix.events.ticketdef.v3.TicketDefinitionManagement.ChangeCurrency","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.ChangeCurrencyResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/events-ticket-definitions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/events-ticket-definitions","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ChangeCurrencyRequest","description":"","properties":{"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.","minLength":3,"maxLength":3,"title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["eventId","currency"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CURRENCY_LOCKED"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.ChangeCurrencyRequest","responseMessage":"wix.events.ticketdef.v3.ChangeCurrencyResponse"},"legacyExamples":[{"name":"ChangeCurrency","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Change currency","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/v3/ticket-definitions/currency' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"currency\": \"USD\"\n}'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git"},"httpMethod":"post","path":"/v3/ticket-definitions/currency","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.events.ticketdef.v3.TicketDefinitionManagement","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CURRENCY_LOCKED"}],"exposure":"PUBLIC","maturity":"GA","permissions":["WIX_EVENTS.MANAGE_TICKET_DEFINITIONS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"protoArtifactId":"com.wixpress.events:events-ticket-definitions","serviceArtifactId":"com.wixpress.events.events-ticket-definitions","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.events.ticketdef.v3.ChangeCurrencyRequest","responseMessage":"wix.events.ticketdef.v3.ChangeCurrencyResponse"},"legacyExamples":[{"name":"ChangeCurrency","serviceName":"TicketDefinitionManagement","type":"METHOD","content":{"title":"Change currency","request":"curl -X POST 'https://www.wixapis.com/events-ticket-definitions/v3/ticket-definitions/currency' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"currency\": \"USD\"\n}'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/events.git","contentLink":{"displayName":"Change Currency","slugifiedName":"change-currency"},"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"isAdminMethod":true}],"webhooks":[{"summary":"Ticket Definition Created","title":"Ticket Definition Created","description":"Triggered when a ticket definition is created.","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.events.v3.ticket_definition","serviceName":"","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"eventType":"wix.events.v3.ticket_definition_created","legacyExamples":[{"name":"TicketDefinitionCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"9aca3895-8c58-48b7-84a5-35bcd431c125\",\n \"entityFqdn\": \"wix.events.ticketdef.v3.ticket_definition\",\n \"slug\": \"created\",\n \"entityId\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T11:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_SCHEDULED\"\n }\n },\n \"eventTime\": \"2023-05-25T11:39:26.278160Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}"}],"$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","contentLink":{"displayName":"Ticket Definition Created","slugifiedName":"ticket-definition-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}]},{"summary":"Ticket Definition Updated","title":"Ticket Definition Updated","description":"Triggered when a ticket definition is updated.","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.events.v3.ticket_definition","serviceName":"","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"eventType":"wix.events.v3.ticket_definition_updated","legacyExamples":[{"name":"TicketDefinitionUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"7cf9dc1b-be64-4394-b748-21de6bed31f1\",\n \"entityFqdn\": \"wix.events.ticketdef.v3.ticket_definition\",\n \"slug\": \"updated\",\n \"entityId\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"afterUpdate\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"2\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T13:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_SCHEDULED\"\n }\n }\n },\n \"eventTime\": \"2023-05-25T13:44:59.129216Z\",\n \"triggeredByAnonymizeRequest\": false\n} "}],"$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","contentLink":{"displayName":"Ticket Definition Updated","slugifiedName":"ticket-definition-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}]},{"summary":"Ticket Definition Deleted","title":"Ticket Definition Deleted","description":"Triggered when a ticket definition is deleted.","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.events.v3.ticket_definition","serviceName":"","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"eventType":"wix.events.v3.ticket_definition_deleted","legacyExamples":[{"name":"TicketDefinitionDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"85deb868-5896-4a44-8f0a-3544eb432216\",\n \"entityFqdn\": \"wix.events.ticketdef.v3.ticket_definition\",\n \"slug\": \"deleted\",\n \"entityId\": \"077766f0-ffa4-4fa1-bdf8-dbb0439c1892\",\n \"deletedEvent\": {},\n \"eventTime\": \"2023-05-25T10:57:03.945444Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","contentLink":{"displayName":"Ticket Definition Deleted","slugifiedName":"ticket-definition-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}]},{"summary":"Ticket Definition Sale Period Updated","title":"Ticket Definition Sale Period Updated","description":"Triggered when a sale period is updated.","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"payload":{"schemaName":"wix.events.ticketdef.v3.TicketDefinition.SalePeriodUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"sale_period_updated","eventTopic":"domain_events_wix.events.v3.ticket_definition","serviceName":"","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"eventType":"wix.events.v3.ticket_definition_sale_period_updated","legacyExamples":[{"name":"TicketDefinitionSalePeriodUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"7cf9dc1b-be64-4394-b748-21de6bed31f1\",\n \"entityFqdn\": \"wix.events.ticketdef.v3.ticket_definition\",\n \"slug\": \"sale_period_updated\",\n \"entityId\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"afterUpdate\": {\n \"startDate\": \"2023-06-08T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n }\n }\n },\n \"eventTime\": \"2023-05-25T13:44:59.129216Z\",\n \"triggeredByAnonymizeRequest\": false\n} "}],"$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition.SalePeriodUpdated","contentLink":{"displayName":"Ticket Definition Sale Period Updated","slugifiedName":"ticket-definition-sale-period-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}]},{"summary":"Ticket Definition Sale Started","title":"Ticket Definition Sale Started","description":"Triggered when a ticket sale starts. Sales details are not included in the payload.","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"payload":{"schemaName":"wix.events.ticketdef.v3.TicketDefinition.TicketDefinitionSaleStarted"},"exposure":"PUBLIC","maturity":"GA","slug":"sale_started","eventTopic":"domain_events_wix.events.v3.ticket_definition","serviceName":"","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"eventType":"wix.events.v3.ticket_definition_sale_started","legacyExamples":[{"name":"TicketDefinitionSaleStarted","eventType":"STARTED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"7cf9dc1b-be64-4394-b748-21de6bed31f1\",\n \"entityFqdn\": \"wix.events.ticketdef.v3.ticket_definition\",\n \"slug\": \"sale_started\",\n \"entityId\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"actionEvent\": {\n \"body\": {\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T11:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_STARTED\"\n }\n }\n },\n \"eventTime\": \"2023-05-25T13:44:59.129216Z\",\n \"triggeredByAnonymizeRequest\": false\n} "}],"$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition.TicketDefinitionSaleStarted","contentLink":{"displayName":"Ticket Definition Sale Started","slugifiedName":"ticket-definition-sale-started"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}]},{"summary":"Ticket Definition Sale Ended","title":"Ticket Definition Sale Ended","description":"Triggered when a ticket sale ends. Sales details are not included in the payload.","permissions":["WIX_EVENTS.READ_TICKET_DEFINITIONS"],"payload":{"schemaName":"wix.events.ticketdef.v3.TicketDefinition.TicketDefinitionSaleEnded"},"exposure":"PUBLIC","maturity":"GA","slug":"sale_ended","eventTopic":"domain_events_wix.events.v3.ticket_definition","serviceName":"","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}],"eventType":"wix.events.v3.ticket_definition_sale_ended","legacyExamples":[{"name":"TicketDefinitionSaleEnded","eventType":"ENDED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"7cf9dc1b-be64-4394-b748-21de6bed31f1\",\n \"entityFqdn\": \"wix.events.ticketdef.v3.ticket_definition\",\n \"slug\": \"sale_ended\",\n \"entityId\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"actionEvent\": {\n \"body\": {\n \"ticketDefinition\": {\n \"id\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventId\": \"9d720f99-1b5a-4141-9877-d32985391e18\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-05-25T11:39:26.108Z\",\n \"updatedDate\": \"2023-05-25T11:39:26.108Z\",\n \"name\": \"Leather Workshop\",\n \"description\": \"Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.\",\n \"policyText\": \"This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!\",\n \"hidden\": false,\n \"limited\": true,\n \"initialLimit\": 3,\n \"actualLimit\": 3,\n \"pricingMethod\": {\n \"fixedPrice\": {\n \"value\": \"200.00\",\n \"currency\": \"USD\"\n },\n \"pricingType\": \"STANDARD\",\n \"free\": false\n },\n \"feeType\": \"FEE_INCLUDED\",\n \"salePeriod\": {\n \"startDate\": \"2023-06-07T10:00:00Z\",\n \"endDate\": \"2023-06-30T00:00:00Z\",\n \"displayNotOnSale\": false\n },\n \"saleStatus\": \"SALE_ENDED\"\n }\n }\n },\n \"eventTime\": \"2023-05-25T13:44:59.129216Z\",\n \"triggeredByAnonymizeRequest\": false\n} "}],"$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition.TicketDefinitionSaleEnded","contentLink":{"displayName":"Ticket Definition Sale Ended","slugifiedName":"ticket-definition-sale-ended"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Events - all permissions","scopeId":"SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-EVENTS.MANAGE-ORDERS"},{"name":"Manage Ticket Definitions","scopeId":"SCOPE.DC-EVENTS.MANAGE-TICKET-DEF"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Ticket Definitions v3\n\nWith the Ticket Definitions API, you can create definitions for tickets. A definition includes the following ticket settings:\n\n- Fee type. Determine whether the fee will be paid by a guest or a seller.\n- Pricing. Define different ticket prices based on factors such as early bird discounts, VIP packages, group rates, or special promotions. Several pricing methods are available for you to select from: **Fixed price**, **Guest price**, **Free**. Additionally, you can customize prices for different groups of people using **Price options**.\n- Availability. Set the ticket limit available to buy. Also, you are able to check number of purchased or reserved tickets.\n- Sale period. Set the sale start and end dates. Also, when defining the sale period, it is possible to choose to display event tickets to customers even before the sale starts.\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n- Install the **Wix Events & Tickets** app from [Wix App Market](fallback::https://www.wix.com/app-market/wix-events).\n- Ticket definition is not the same as ticket. Ticket definitions are used to define settings for a set of tickets. After paying for selected tickets, the [Checkout API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7dcf1b07-43e0-492f-904b-f52e4546486fslug::checkout*fallback::https://dev.wix.com/docs/rest/business-solutions/events/events/order-checkout/checkout) automatically generates the ticket.\n\n## Use cases\n\n- [Add a specific-price ticket counter for an event](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::sample-use-cases-and-flows#add-a-specific-price-ticket-counter-for-an-event*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/sample-use-cases-and-flows#add-a-specific-price-ticket-counter-for-an-event)\n- [Sync ticket definitions with external ticketing system](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::sample-use-cases-and-flows#sync-ticket-definitions-with-an-external-ticketing-system*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/sample-use-cases-and-flows#sync-ticket-definitions-with-an-external-ticketing-system)\n- [Notify when tickets go on sale](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::sample-use-cases-and-flows#notify-customers-when-tickets-go-on-sale*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/sample-use-cases-and-flows#notify-customers-when-tickets-go-on-sale)\n\n## Terminology\n\n- **Pricing method**: Different pricing methods are available for an event:\n - **Fixed price**: All tickets in the same definition are sold at the exact same price, regardless of when they are purchased or other factors.\n - **Guest price**: The guest enters the ticket price. Optionally, you can set the minimum price guests must pay for a ticket. This pricing method is applied to donation.\n - **Price options**: All tickets in the same ticket definition are priced at different rates, such as different prices for adults, children, and students.\n- **Ticket availability**: The status of ticket inventory, indicating whether tickets are available or sold out. This type can also include availability limits and timeframes for ticket sales.\n- **Sale period**: Duration of time during which event tickets are available for purchase. \n- **Event Dashboard**: Control center in the Wix site UI for managing site event settings and features.","sourceRepo":"git@github.com:wix-private/events.git","path":"proto/docs/intro.md"},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Ticket Definitions v3: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the Ticket Definition object:\n\n| Field | Query Filter Operators | Sortable |\n|----------------------------------------|-----------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `eventId` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `name` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `description` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `limit` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `pricing_method.pricing_type` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `feeType` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `saleStatus` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable | \n| `updatedDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `hidden` | `$eq`, `$ne`, `$in`, `$nin`, `$exists` | Sortable |\n| `pricing_method.free` | `$eq`, `$ne`, `$in`, `$nin`, `$exists` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Ticket Definitions Query endpoint](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::query-ticket-definitions*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/query-ticket-definitions)","sourceRepo":"git@github.com:wix-private/events.git","path":"proto/docs/filter-and-sort.md"},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Ticket Definitions v3: Sample Use Cases & Flows\n\nThis article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation. \n\n## Add a specific-price ticket counter for an event\n\nThis use case demonstrates how you can update your event site with a ticket counter for specific-price tickets. This counter provides real-time information on the availability of tickets for customers to see. For example, your page can have a counter that says \"Only 3 tickets left for this price.\" By displaying the number of tickets remaining, you can motivate customers to buy tickets promptly. \n\n> **Note**: This flow assumes you have already created the UI component of the counter for your site.\n\nTo create a ticket counter, follow these steps:\n \n1. Call [Get Ticket Definition](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::get-ticket-definition*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/get-ticket-definition) and retrieve either:\n - The `salesDetails.unsoldCount` and `fixedPrice.value` values (for `fixedPrice` pricing method).\n - The `salesDetails.unsoldCount` and `pricingOptions.optionDetails.price.value` field values (for `optionalPrice` pricing method).\n\n1. Pass these retrieved values in your app to initialize the counter on your website, displaying the number of available tickets at the specified price.\n\n1. On an ongoing basis, listen for each new ticket purchase using the [Order Confirmed Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7dcf1b07-43e0-492f-904b-f52e4546486fslug::order-confirmed*fallback::https://dev.wix.com/docs/rest/business-solutions/events/events/order-checkout/order-confirmed).\n\n1. When the webhook is triggered, you'll receive an order in the payload. Retrieve the `ticketDefinitionId` value from the event data.\n\n1. Send the extracted `ticketDefinitionId` value to your site and compare it with the ticket definition ID for which the counter is set. If they match, call [Get Ticket Definition](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::get-ticket-definition*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/get-ticket-definition) again to retrieve the updated `salesDetails.unsoldCount` value. Send this new decreased value to your website to update the ticket counter.\n\n## Sync ticket definitions with an external ticketing system\n\nIf you're using a Wix site to manage events and another system to handle ticketing, you can synchronize ticket definitions between them whenever a definition is updated on the site. This includes aspects such as ticket types, pricing, availability, and any other relevant ticket settings. This synchronization eliminates the need for manual updates and reduces the risk of discrepancies between systems.\n\nTo upload and update all ticket definitions defined on the Wix site to your external system for the first time, follow these flows:\n\n- [Initial setup](fallback::#part-1-initial-setup)\n- [Synchronize to the external system](fallback::#part-2-synchronize-to-the-external-system)\n\n### Part 1: Initial setup\n\n1. Create a custom field in your system that stores the ticket definition ID for a particular event to ensure a 1-to-1 relationship with the external ticketing system. Craft your code so that this ID won't be overwritten by future updates from your app.\n\n1. Create a mapping from the site ticket definition fields to the system fields that will be used whenever site ticket definitions and the external system are synchronized.\n\n1. [Query Ticket Definitions](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::query-ticket-definitions*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/query-ticket-definitions) by `eventId` and send the relevant information to the external ticketing system.\n\n### Part 2: Synchronize to the external system\n\n1. On an ongoing basis, listen for changes to site ticket definitions with these webhooks:\n\n - [Ticket Definition Created Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::ticket-definition-created*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/ticket-definition-created)\n - [Ticket Definition Updated Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::ticket-definition-updated*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/ticket-definition-updated)\n - [Ticket Definition Deleted Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::ticket-definition-deleted*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/ticket-definition-deleted)\n \n1. When one of the above webhooks is triggered, you'll receive the ticket definition in the payload. You can bring those changes to the ticketing system by retrieving the relevant info from the payload, and use mapping to take action on the external system:\n\n - For created and updated ticket definitions retrieve the relevant info from the `createdEvent.currentEntity` object.\n\n - For deleted ticket definitions retrieve the `createdEvent.currentEntity.id` value.\n\n## Notify customers when tickets go on sale \n\nLet customers know when ticket sales for an event begin. You can send automated notifications to customers with email or push notifications. These notifications make customers aware of ticket availability so they can secure their tickets promptly.\n\n> **Note**: This flow assumes your customers already have the ability to subscribe to your newsletters.\n\nTo send notifications about the start of ticket sales, follow these steps:\n\n1. [Get Ticket Definition](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::get-ticket-definition*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/get-ticket-definition).\n\n2. Retrieve the `salePeriod.startDate` field value, and write your code so that the value can be passed to your marketing tool.\n\n3. Request and filter the list of subscribers in your external marketing tool based on customers subscription status for the current event. \n\n4. When the ticket sale start date arrives, send notifications to your customers who have opted in to receive marketing emails.\n","sourceRepo":"git@github.com:wix-private/events.git","path":"proto/docs/sample-use-cases-and-flows.md"}],"components":{"schemas":{"wix.events.ticketdef.v3.TicketDefinition":{"type":"object","properties":{"id":{"description":"Ticket definition ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID to which the ticket definition belongs.","format":"GUID","immutable":true,"title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time when the ticket definition was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time when the ticket definition was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Ticket definition name.","minLength":1,"maxLength":30,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Ticket definition description.","maxLength":500,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"policyText":{"description":"Ticket definition policy.","maxLength":1000,"title":"policyText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hidden":{"description":"Whether this ticket definition is hidden to site visitors and can't be purchased.","title":"hidden","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limited":{"description":"Whether the ticket has a limited maximum quantity.","readOnly":true,"title":"limited","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialLimit":{"description":"The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead.","title":"initialLimit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actualLimit":{"description":"The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`.","readOnly":true,"title":"actualLimit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricingMethod":{"description":"Ticket pricing method.","$ref":"#/components/schemas/wix.events.ticketdef.v3.PricingMethod","summary":"pricingMethod","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"feeType":{"description":"Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:\n- `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75.\n- `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total.","title":"feeType","type":"string","$ref":"#/components/schemas/wix.events.ticketdef.v3.FeeTypeEnum.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salePeriod":{"description":"Ticket sale period.","$ref":"#/components/schemas/wix.events.ticketdef.v3.SalePeriod","summary":"salePeriod","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"saleStatus":{"description":"Ticket sale status. Possible values:\n- `SALE_SCHEDULED`: Tickets are not on sale yet.\n- `SALE_STARTED`: Tickets are on sale.\n- `SALE_ENDED`: Tickets are not on sale.","readOnly":true,"title":"saleStatus","type":"string","$ref":"#/components/schemas/wix.events.ticketdef.v3.SaleStatusEnum.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"salesDetails":{"description":"Ticket sales information.
\n**Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request.","$ref":"#/components/schemas/wix.events.ticketdef.v3.SalesDetails","summary":"salesDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limitPerCheckout":{"description":"Number of tickets that can be purchased per checkout.
\n**Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.","readOnly":true,"minimum":0,"maximum":50,"title":"limitPerCheckout","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Data extensions.","$ref":"#/components/schemas/wix.common.data.dataextensions.ExtendedFields","summary":"extendedFields","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TicketDefinition","description":""},"wix.events.ticketdef.v3.SalePeriod":{"type":"object","properties":{"startDate":{"description":"Ticket sale start timestamp.","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endDate":{"description":"Ticket sale end timestamp.","title":"endDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayNotOnSale":{"description":"Whether to display the ticket if it's not available to buy.","title":"displayNotOnSale","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SalePeriod","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":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.events.ticketdef.v3.PricingMethod":{"type":"object","properties":{"pricingType":{"description":"Ticket price type. Possible values:\n- `STANDARD`: All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`.\n- `DONATION`: All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method.","readOnly":true,"title":"pricingType","type":"string","$ref":"#/components/schemas/wix.events.ticketdef.v3.PricingTypeEnum.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"free":{"description":"Whether the ticket is free. To create a free ticket, enter `0` in the `pricingMethod.fixedPrice.value` field.","readOnly":true,"title":"free","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PricingMethod","description":"","oneOf":[{"description":"","summary":"price","$ref":"#/components/schemas/wix.events.ticketdef.v3.PricingMethod.price"}]},"wix.events.ticketdef.v3.PricingMethod.price":{"type":"object","title":"price","properties":{"fixedPrice":{"description":"Same ticket price for everyone.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.Money","summary":"fixedPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"guestPrice":{"description":"Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or make the ticket free(enter `0` in the request). The price can be updated to a higher amount by a guest during the checkout.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.Money","summary":"guestPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pricingOptions":{"description":"Sets of various ticket prices. For example, you can charge different prices for children and adults.","$ref":"#/components/schemas/wix.events.ticketdef.v3.PricingOptions","summary":"pricingOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.events.ticketdef.v3.upstream.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 a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD).","format":"CURRENCY","title":"currency","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."},"wix.events.ticketdef.v3.PricingOptions":{"type":"object","properties":{"optionDetails":{"description":"Ticket price option details.","maxItems":100,"title":"optionDetails","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.OptionDetails"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PricingOptions","description":""},"wix.events.ticketdef.v3.OptionDetails":{"type":"object","properties":{"optionId":{"description":"Ticket price option ID.","format":"GUID","title":"optionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Ticket price option name, such as \"Child Ticket\".","minLength":1,"maxLength":200,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Ticket price.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.Money","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OptionDetails","description":""},"wix.events.ticketdef.v3.PricingTypeEnum.Type":{"type":"string","description":"","title":"Type","enum":["UNKNOWN_PRICING_TYPE","STANDARD","DONATION"]},"wix.events.ticketdef.v3.FeeTypeEnum.Type":{"type":"string","description":"","title":"Type","enum":["UNKNOWN_FEE_TYPE","FEE_INCLUDED","FEE_ADDED_AT_CHECKOUT","NO_FEE"]},"wix.events.ticketdef.v3.SaleStatusEnum.Status":{"type":"string","description":"","title":"Status","enum":["UNKNOWN_SALE_STATUS","SALE_SCHEDULED","SALE_STARTED","SALE_ENDED"]},"wix.events.ticketdef.v3.SalesDetails":{"type":"object","properties":{"unsoldCount":{"description":"Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited.","readOnly":true,"title":"unsoldCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"soldCount":{"description":"Number of purchased tickets.","readOnly":true,"title":"soldCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservedCount":{"description":"Number of reserved tickets.","readOnly":true,"title":"reservedCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"soldOut":{"description":"Whether the tickets are sold out.","readOnly":true,"title":"soldOut","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SalesDetails","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.data.dataextensions.ExtendedFields":{"type":"object","properties":{"namespaces":{"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).","title":"namespaces","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Struct"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedFields","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.events.ticketdef.v3.TicketDefinition.SalePeriodUpdated":{"type":"object","properties":{"afterUpdate":{"description":"Ticket definition sale period after update.","$ref":"#/components/schemas/wix.events.ticketdef.v3.SalePeriod","summary":"afterUpdate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SalePeriodUpdated","description":""},"wix.events.ticketdef.v3.TicketDefinition.TicketDefinitionSaleStarted":{"type":"object","properties":{"ticketDefinition":{"description":"Ticket definition.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TicketDefinitionSaleStarted","description":""},"wix.events.ticketdef.v3.TicketDefinition.TicketDefinitionSaleEnded":{"type":"object","properties":{"ticketDefinition":{"description":"Ticket definition.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TicketDefinitionSaleEnded","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 in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","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"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","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.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"]},"com.wixpress.html.cache.invalidate.InvalidateCache":{"type":"object","properties":{"reason":{"description":"tell us why you're invalidating the cache. You don't need to add your app name","maxLength":256,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"localDc":{"description":"Is local DS","title":"localDc","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvalidateCache","description":"","oneOf":[{"description":"","summary":"getBy","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.getBy"}]},"com.wixpress.html.cache.invalidate.InvalidateCache.getBy":{"type":"object","title":"getBy","properties":{"metaSiteId":{"description":"Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"app":{"description":"Invalidate by App","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.App","summary":"app","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"page":{"description":"Invalidate by page id","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.Page","summary":"page","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uri":{"description":"Invalidate by URI path","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.URI","summary":"uri","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"file":{"description":"Invalidate by file (for media files such as PDFs)","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.File","summary":"file","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.html.cache.invalidate.InvalidateCache.App":{"type":"object","properties":{"appDefId":{"description":"The AppDefId","minLength":1,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The instance Id","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"App","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.Page":{"type":"object","properties":{"metaSiteId":{"description":"the msid the page is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageId":{"description":"Invalidate by Page ID","minLength":1,"title":"pageId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Page","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.URI":{"type":"object","properties":{"metaSiteId":{"description":"the msid the URI is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uriPath":{"description":"URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes","minLength":1,"title":"uriPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"URI","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.File":{"type":"object","properties":{"metaSiteId":{"description":"the msid the file is related to","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Invalidate by filename (for media files such as PDFs)","minLength":1,"maxLength":256,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"File","description":""},"wix.events.ticketdef.v3.GetTicketDefinitionSummaryRequest":{"type":"object","properties":{"ticketDefinitionId":{"description":"Ticket definition id.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTicketDefinitionSummaryRequest","description":""},"wix.events.ticketdef.v3.GetTicketDefinitionSummaryResponse":{"type":"object","properties":{"summary":{"description":"Summary.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinitionSummary","summary":"summary","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTicketDefinitionSummaryResponse","description":""},"wix.events.ticketdef.v3.TicketDefinitionSummary":{"type":"object","properties":{"definitionId":{"description":"Ticket definition ID.","format":"GUID","readOnly":true,"title":"definitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID to which the ticket definition summary belongs.","format":"GUID","readOnly":true,"title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservedCount":{"description":"Reserved count.","readOnly":true,"title":"reservedCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"soldCount":{"description":"Sold count.","readOnly":true,"title":"soldCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paidExists":{"description":"Paid exists.","readOnly":true,"title":"paidExists","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TicketDefinitionSummary","description":""},"wix.events.ticketdef.v3.ListEventTicketingSummaryRequest":{"type":"object","properties":{"eventId":{"description":"Event ID.","format":"GUID","minItems":1,"maxItems":1000,"title":"eventId","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListEventTicketingSummaryRequest","description":""},"wix.events.ticketdef.v3.ListEventTicketingSummaryResponse":{"type":"object","properties":{"summaries":{"description":"Ticketing summaries.","title":"summaries","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.EventTicketingSummary"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListEventTicketingSummaryResponse","description":""},"wix.events.ticketdef.v3.EventTicketingSummary":{"type":"object","properties":{"eventId":{"description":"Event ID to which the ticketing summary belongs.","format":"GUID","readOnly":true,"title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"soldOut":{"description":"Whether all tickets are sold for this event.","readOnly":true,"title":"soldOut","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lowestTicketPrice":{"description":"Price of lowest priced ticket.","readOnly":true,"$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.Money","summary":"lowestTicketPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"highestTicketPrice":{"description":"Price of highest priced ticket.","readOnly":true,"$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.Money","summary":"highestTicketPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"Currency used in event transactions.","minLength":3,"maxLength":3,"readOnly":true,"title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lowestTicketPriceFormatted":{"description":"Formatted price of lowest priced ticket.","maxLength":50,"readOnly":true,"title":"lowestTicketPriceFormatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"highestTicketPriceFormatted":{"description":"Formatted price of highest priced ticket.","maxLength":50,"readOnly":true,"title":"highestTicketPriceFormatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventTicketingSummary","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"wix.events.ticketing.events.ReservationCreated":{"type":"object","properties":{"timestamp":{"description":"Reservation created timestamp in ISO UTC format.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservationId":{"description":"Reservation ID.\nCan be used to retrieve a reservation invoice.","format":"GUID","title":"reservationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expires":{"description":"Reservation expiration timestamp.","title":"expires","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Reservation status.","title":"status","type":"string","$ref":"#/components/schemas/wix.events.ticketing.ReservationStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantities":{"description":"Reservation ticket quantities.","maxItems":50,"title":"quantities","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketing.events.TicketQuantity"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Reservation update timestamp.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"counts":{"description":"Reservation counts.","maxItems":50,"title":"counts","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketing.events.ReservationCount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationCreated","description":""},"wix.events.ticketing.ReservationStatus":{"type":"string","description":"","title":"ReservationStatus","enum":["RESERVATION_PENDING","RESERVATION_CONFIRMED","RESERVATION_CANCELED","RESERVATION_CANCELED_MANUALLY","RESERVATION_EXPIRED"]},"wix.events.ticketing.events.TicketQuantity":{"type":"object","properties":{"ticketDefinitionId":{"description":"Ticket definition ID.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Quantity.","title":"quantity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Quantity update timestamp.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TicketQuantity","description":""},"wix.events.ticketing.events.ReservationCount":{"type":"object","properties":{"timestamp":{"description":"Reservation Count snapshot timestamp.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ticketDefinitionId":{"description":"Ticket Definition ID.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"confirmedCount":{"description":"Confirmed reservation count.","title":"confirmedCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pendingCount":{"description":"Pending reservation count.","title":"pendingCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paidExists":{"description":"True if paid ticket reservation exist.","title":"paidExists","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationCount","description":""},"wix.events.ticketing.events.ReservationUpdated":{"type":"object","properties":{"timestamp":{"description":"Reservation updated timestamp.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservationId":{"description":"Reservation ID.\nCan be used to retrieve a reservation invoice.","format":"GUID","title":"reservationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Reservation status.","title":"status","type":"string","$ref":"#/components/schemas/wix.events.ticketing.ReservationStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expires":{"description":"Reservation expiration timestamp.","title":"expires","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantities":{"description":"Reservation ticket quantities.","maxItems":50,"title":"quantities","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketing.events.TicketQuantity"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Reservation update timestamp.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"counts":{"description":"Reservation counts.","maxItems":50,"title":"counts","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketing.events.ReservationCount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationUpdated","description":""},"wix.events.events.EventDeleted":{"type":"object","properties":{"timestamp":{"description":"Event deleted timestamp in ISO UTC format.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Event title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userId":{"description":"Event creator user ID.","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventDeleted","description":""},"wix.events.ticketdef.v3.CreateTicketDefinitionRequest":{"type":"object","properties":{"ticketDefinition":{"description":"Ticket definition info.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTicketDefinitionRequest","description":""},"wix.events.ticketdef.v3.RequestedFields.Field":{"type":"string","description":"","title":"Field","enum":["UNKNOWN_REQUESTED_FIELD","SALES_DETAILS"]},"wix.events.ticketdef.v3.CreateTicketDefinitionResponse":{"type":"object","properties":{"ticketDefinition":{"description":"Created ticket definition.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTicketDefinitionResponse","description":""},"wix.events.ticketdef.v3.UpdateTicketDefinitionRequest":{"type":"object","properties":{"ticketDefinition":{"description":"Ticket definition to update.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTicketDefinitionRequest","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.events.ticketdef.v3.UpdateTicketDefinitionResponse":{"type":"object","properties":{"ticketDefinition":{"description":"The updated ticket definition.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTicketDefinitionResponse","description":""},"wix.events.ticketdef.v3.GetTicketDefinitionRequest":{"type":"object","properties":{"ticketDefinitionId":{"description":"Ticket definition ID.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTicketDefinitionRequest","description":""},"wix.events.ticketdef.v3.GetTicketDefinitionResponse":{"type":"object","properties":{"ticketDefinition":{"description":"The requested ticket definition.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTicketDefinitionResponse","description":""},"wix.events.ticketdef.v3.DeleteTicketDefinitionRequest":{"type":"object","properties":{"ticketDefinitionId":{"description":"ID of the ticket definition to delete.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteTicketDefinitionRequest","description":""},"wix.events.ticketdef.v3.DeleteTicketDefinitionResponse":{"type":"object","properties":{},"title":"DeleteTicketDefinitionResponse","description":""},"wix.events.ticketdef.v3.ReorderTicketDefinitionsRequest":{"type":"object","properties":{"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ticketDefinitionId":{"description":"Ticket definition ID.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReorderTicketDefinitionsRequest","description":"","oneOf":[{"description":"","summary":"referenceDefinition","$ref":"#/components/schemas/wix.events.ticketdef.v3.ReorderTicketDefinitionsRequest.referenceDefinition"}]},"wix.events.ticketdef.v3.ReorderTicketDefinitionsRequest.referenceDefinition":{"type":"object","title":"referenceDefinition","properties":{"beforeDefinitionId":{"description":"Move the given `definitionId` before the referenced ticket definition.","format":"GUID","title":"beforeDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"afterDefinitionId":{"description":"Move the given `definitionId` after the referenced ticket definition.","format":"GUID","title":"afterDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.events.ticketdef.v3.ReorderTicketDefinitionsResponse":{"type":"object","properties":{},"title":"ReorderTicketDefinitionsResponse","description":""},"wix.events.ticketdef.v3.UpdateTicketDefinitionSortIndexRequest":{"type":"object","properties":{"ticketDefinitionId":{"description":"Ticket definition ID","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"The revision of the ticket definition","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortIndex":{"description":"the sort index of a ticket definition to set","title":"sortIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Requested fields.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTicketDefinitionSortIndexRequest","description":""},"wix.events.ticketdef.v3.UpdateTicketDefinitionSortIndexResponse":{"type":"object","properties":{"ticketDefinition":{"description":"the updated ticket definition","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTicketDefinitionSortIndexResponse","description":""},"wix.events.ticketdef.v3.QueryTicketDefinitionsRequest":{"type":"object","properties":{"query":{"description":"Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTicketDefinitionsRequest","description":""},"wix.events.ticketdef.v3.upstream.wix.common.QueryV2":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\", \"fieldName2\":{\"$operator\":\"value2\"} }`.

**Example:**
`\"filter\" : { \"id\": \"2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5\", \"revision\": {\"$ne\":\"1\"} }`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:
`[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`

**Example:**
`[{\"fieldName\":\"createdDate\",\"direction\":\"DESC\"}]`

See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information.","maxItems":10,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.QueryV2.pagingMethod"}]},"wix.events.ticketdef.v3.upstream.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.events.ticketdef.v3.upstream.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` parameters.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.events.ticketdef.v3.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":100,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Defaults to `ASC`","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.events.ticketdef.v3.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load per page.","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":""},"wix.events.ticketdef.v3.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load per page.","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.\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.events.ticketdef.v3.QueryTicketDefinitionsResponse":{"type":"object","properties":{"ticketDefinitions":{"description":"List of ticket definitions.","title":"ticketDefinitions","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Metadata for the paginated results.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.PagingMetadataV2","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTicketDefinitionsResponse","description":""},"wix.events.ticketdef.v3.upstream.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.events.ticketdef.v3.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"wix.events.ticketdef.v3.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","maxLength":36,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","maxLength":36,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"wix.events.ticketdef.v3.QueryAvailableTicketDefinitionsRequest":{"type":"object","properties":{"query":{"description":"Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Predefined sets of fields to return.\n- `SALES_DETAILS`: Returns `salesDetails`.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryAvailableTicketDefinitionsRequest","description":""},"wix.events.ticketdef.v3.QueryAvailableTicketDefinitionsResponse":{"type":"object","properties":{"ticketDefinitions":{"description":"List of ticket definitions.","title":"ticketDefinitions","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Metadata for the paginated results.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.PagingMetadataV2","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryAvailableTicketDefinitionsResponse","description":""},"wix.events.ticketdef.v3.CountTicketDefinitionsRequest":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"facet":{"description":"Parameters to count ticket definitions by.\n\n- Max: 20 facets.","maxLength":100,"maxItems":20,"title":"facet","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountTicketDefinitionsRequest","description":""},"wix.events.ticketdef.v3.CountTicketDefinitionsResponse":{"type":"object","properties":{"metadata":{"description":"Metadata for the paginated results.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.PagingMetadataV2","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"facets":{"description":"Filter facets.","title":"facets","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.FacetCounts"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountTicketDefinitionsResponse","description":""},"wix.events.ticketdef.v3.FacetCounts":{"type":"object","properties":{"counts":{"description":"Facet counts aggregated per value","title":"counts","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"integer"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FacetCounts","description":""},"wix.events.ticketdef.v3.CountAvailableTicketDefinitionsRequest":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountAvailableTicketDefinitionsRequest","description":""},"wix.events.ticketdef.v3.CountAvailableTicketDefinitionsResponse":{"type":"object","properties":{"metadata":{"description":"Metadata for the paginated results.","$ref":"#/components/schemas/wix.events.ticketdef.v3.upstream.wix.common.PagingMetadataV2","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountAvailableTicketDefinitionsResponse","description":""},"wix.events.ticketdef.v3.BulkDeleteTicketDefinitionsByFilterRequest":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`.

**Example:**
`\"filter\" : { \"eventId\": \"3d3d5c04-ece0-45a8-85f0-11a58edaa192\" }`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteTicketDefinitionsByFilterRequest","description":""},"wix.events.ticketdef.v3.BulkDeleteTicketDefinitionsByFilterResponse":{"type":"object","properties":{},"title":"BulkDeleteTicketDefinitionsByFilterResponse","description":""},"wix.events.ticketdef.v3.ChangeCurrencyRequest":{"type":"object","properties":{"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.","minLength":3,"maxLength":3,"title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ChangeCurrencyRequest","description":""},"wix.events.ticketdef.v3.ChangeCurrencyResponse":{"type":"object","properties":{},"title":"ChangeCurrencyResponse","description":""},"wix.events.ticketdef.v3.BulkCopyTicketDefinitionsByEventIdRequest":{"type":"object","properties":{"originInstanceId":{"description":"Origin instance ID.","format":"GUID","title":"originInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originEventId":{"description":"Origin Event ID.","format":"GUID","title":"originEventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"targetEventId":{"description":"Target Event ID.","format":"GUID","title":"targetEventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCopyTicketDefinitionsByEventIdRequest","description":""},"wix.events.ticketdef.v3.BulkCopyTicketDefinitionsByEventIdResponse":{"type":"object","properties":{"definitions":{"description":"Copied ticket definitions.","title":"definitions","type":"array","items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.BulkCopyTicketDefinitionsByEventIdResponse.CopiedTicketDefinition"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCopyTicketDefinitionsByEventIdResponse","description":""},"wix.events.ticketdef.v3.BulkCopyTicketDefinitionsByEventIdResponse.CopiedTicketDefinition":{"type":"object","properties":{"originTicketDefinitionId":{"description":"Origin Ticket definition ID.","format":"GUID","title":"originTicketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ticketDefinitionId":{"description":"Ticket definition ID.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CopiedTicketDefinition","description":""},"wix.events.events.EventCanceled":{"type":"object","properties":{"timestamp":{"description":"Event canceled timestamp in ISO UTC format.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Event title","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userId":{"description":"Event creator user ID.","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventCanceled","description":""},"wix.events.events.EventEnded":{"type":"object","properties":{"timestamp":{"description":"Event end timestamp in ISO UTC format.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventEnded","description":""},"wix.events.events.EventCreated":{"type":"object","properties":{"timestamp":{"description":"Event created timestamp in ISO UTC format.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"location":{"description":"Event location.","$ref":"#/components/schemas/wix.events.Location","summary":"location","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleConfig":{"description":"Event schedule configuration.","$ref":"#/components/schemas/wix.events.ScheduleConfig","summary":"scheduleConfig","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Event title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userId":{"description":"Event creator user ID.","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Event status.","title":"status","type":"string","$ref":"#/components/schemas/wix.events.EventStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"derivedFromInstanceId":{"description":"Instance ID. Indicates the original app instance which current event was derived from.","format":"GUID","title":"derivedFromInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"derivedFromEventId":{"description":"Event ID. Indicates the original event which current event was derived from.","format":"GUID","title":"derivedFromEventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"event":{"description":"Event that was created.","$ref":"#/components/schemas/wix.events.Event","summary":"event","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventCreated","description":""},"wix.events.Location":{"type":"object","properties":{"name":{"description":"Location name.","maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"coordinates":{"description":"Location map coordinates.","$ref":"#/components/schemas/wix.events.MapCoordinates","summary":"coordinates","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"address":{"description":"Single line address representation.","maxLength":150,"title":"address","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Location type.","title":"type","type":"string","$ref":"#/components/schemas/wix.events.Location.LocationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fullAddress":{"description":"Full address derived from formatted single line `address`.\nWhen `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.\nIf provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.\n\nMigration notes:\n- `full_address.formatted_address` is equivalent to `address`.\n- `full_address.geocode` is equivalent to `coordinates`.","$ref":"#/components/schemas/com.wix.events.upstream.wix.common.Address","summary":"fullAddress","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tbd":{"description":"Defines event location as TBD (To Be Determined).\nWhen event location is not yet defined, `name` is displayed instead of location address.\n`coordinates`, `address`, `type` and `full_address` are not required when location is TBD.","title":"tbd","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Location","description":""},"wix.events.MapCoordinates":{"type":"object","properties":{"lat":{"description":"Latitude.","minimum":-90,"maximum":90,"title":"lat","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lng":{"description":"Longitude.","minimum":-180,"maximum":180,"title":"lng","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MapCoordinates","description":""},"wix.events.Location.LocationType":{"type":"string","description":"","title":"LocationType","enum":["VENUE","ONLINE"]},"com.wix.events.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 or region) code according to 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, Floor","title":"addressLine2","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedAddress":{"description":"A string containing the human-readable address of this location","title":"formattedAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hint":{"description":"Free text for human-to-human textual orientation aid purposes","title":"hint","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"geocode":{"description":"coordinates of the physical address","$ref":"#/components/schemas/com.wix.events.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","maxItems":6,"title":"subdivisions","type":"array","items":{"$ref":"#/components/schemas/com.wix.events.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.events.upstream.wix.common.Address.street"}]},"com.wix.events.upstream.wix.common.Address.street":{"type":"object","title":"street","properties":{"streetAddress":{"description":"a break down of the street to number and street name","$ref":"#/components/schemas/com.wix.events.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.events.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"}}},"title":"StreetAddress","description":""},"com.wix.events.upstream.wix.common.AddressLocation":{"type":"object","properties":{"latitude":{"description":"address latitude coordinates","minimum":-90,"maximum":90,"title":"latitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"longitude":{"description":"address longitude coordinates","minimum":-180,"maximum":180,"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.events.upstream.wix.common.Subdivision":{"type":"object","properties":{"code":{"description":"subdivision short code","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":""},"wix.common.Subdivision.SubdivisionType":{"type":"string","description":"","title":"SubdivisionType","enum":["UNKNOWN_SUBDIVISION_TYPE","ADMINISTRATIVE_AREA_LEVEL_1","ADMINISTRATIVE_AREA_LEVEL_2","ADMINISTRATIVE_AREA_LEVEL_3","ADMINISTRATIVE_AREA_LEVEL_4","ADMINISTRATIVE_AREA_LEVEL_5","COUNTRY"]},"wix.events.ScheduleConfig":{"type":"object","properties":{"scheduleTbd":{"description":"Defines event as TBD (To Be Determined) schedule.\nWhen event time is not yet defined, TBD message is displayed instead of event start and end times.\n`startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.","title":"scheduleTbd","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleTbdMessage":{"description":"TBD message.","maxLength":100,"title":"scheduleTbdMessage","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startDate":{"description":"Event start timestamp.","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endDate":{"description":"Event end timestamp.","title":"endDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZoneId":{"description":"Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.","maxLength":100,"title":"timeZoneId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endDateHidden":{"description":"Whether end date is hidden in the formatted schedule.","title":"endDateHidden","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showTimeZone":{"description":"Whether time zone is displayed in formatted schedule.","title":"showTimeZone","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"recurrences":{"description":"Event recurrences.","$ref":"#/components/schemas/wix.events.Recurrences","summary":"recurrences","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScheduleConfig","description":""},"wix.events.Recurrences":{"type":"object","properties":{"occurrences":{"description":"Event occurrences.","maxItems":1000,"title":"occurrences","type":"array","items":{"$ref":"#/components/schemas/wix.events.Occurrence"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryId":{"description":"Recurring event category ID.","readOnly":true,"title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Recurrence status.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/wix.events.RecurrenceStatus.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Recurrences","description":""},"wix.events.Occurrence":{"type":"object","properties":{"startDate":{"description":"Event start timestamp.","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endDate":{"description":"Event end timestamp.","title":"endDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZoneId":{"description":"Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.","maxLength":100,"title":"timeZoneId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"showTimeZone":{"description":"Whether time zone is displayed in formatted schedule.","title":"showTimeZone","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Occurrence","description":""},"wix.events.RecurrenceStatus.Status":{"type":"string","description":"","title":"Status","enum":["ONE_TIME","RECURRING","RECURRING_NEXT","RECURRING_LAST_ENDED","RECURRING_LAST_CANCELED"]},"wix.events.EventStatus":{"type":"string","description":"","title":"EventStatus","enum":["SCHEDULED","STARTED","ENDED","CANCELED","DRAFT"]},"wix.events.Event":{"type":"object","properties":{"id":{"description":"Event ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"location":{"description":"Event location.","$ref":"#/components/schemas/wix.events.Location","summary":"location","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduling":{"description":"Event scheduling.","$ref":"#/components/schemas/wix.events.Scheduling","summary":"scheduling","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Event title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Event description.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"about":{"description":"Rich-text content displayed in Wix UI - \"About Event\" section (HTML).","title":"about","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mainImage":{"description":"Main event image.","$ref":"#/components/schemas/com.wix.events.upstream.wix.common.Image","summary":"mainImage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Event slug URL (generated from event title).","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"ISO 639-1 language code of the event (used in content translations).","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"created":{"description":"Event creation timestamp.","title":"created","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"modified":{"description":"Event modified timestamp.","title":"modified","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Event status.","title":"status","type":"string","$ref":"#/components/schemas/wix.events.EventStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"registration":{"description":"RSVP or ticketing registration details.","$ref":"#/components/schemas/wix.events.Registration","summary":"registration","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"calendarLinks":{"description":"\"Add to calendar\" URLs.","$ref":"#/components/schemas/wix.events.CalendarLinks","summary":"calendarLinks","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventPageUrl":{"description":"Event page URL components.","$ref":"#/components/schemas/wix.events.SiteUrl","summary":"eventPageUrl","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"form":{"description":"Event registration form.","$ref":"#/components/schemas/wix.events.form.Form","summary":"form","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dashboard":{"description":"Event dashboard summary of RSVP / ticket sales.","$ref":"#/components/schemas/wix.events.Dashboard","summary":"dashboard","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Instance ID of the site where event is hosted.","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"guestListConfig":{"description":"Guest list configuration.","$ref":"#/components/schemas/wix.events.GuestListConfig","summary":"guestListConfig","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userId":{"description":"Event creator user ID.","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"feed":{"description":"Event discussion feed. For internal use.","$ref":"#/components/schemas/wix.events.Feed","summary":"feed","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"onlineConferencing":{"description":"Online conferencing details.","$ref":"#/components/schemas/wix.events.OnlineConferencing","summary":"onlineConferencing","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"seoSettings":{"description":"SEO settings.","$ref":"#/components/schemas/wix.events.SeoSettings","summary":"seoSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assignedContactsLabel":{"description":"Assigned contacts label key.","title":"assignedContactsLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"agenda":{"description":"Agenda details.","$ref":"#/components/schemas/wix.events.Agenda","summary":"agenda","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categories":{"description":"Categories this event is assigned to.","title":"categories","type":"array","items":{"$ref":"#/components/schemas/wix.events.categories.Category"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventDisplaySettings":{"description":"Visual settings for event.","$ref":"#/components/schemas/wix.events.EventDisplaySettings","summary":"eventDisplaySettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Event","description":""},"wix.events.Scheduling":{"type":"object","properties":{"config":{"description":"Schedule configuration.","$ref":"#/components/schemas/wix.events.ScheduleConfig","summary":"config","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formatted":{"description":"Formatted schedule representation.","title":"formatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startDateFormatted":{"description":"Formatted start date of the event (empty for TBD schedules).","title":"startDateFormatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startTimeFormatted":{"description":"Formatted start time of the event (empty for TBD schedules).","title":"startTimeFormatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endDateFormatted":{"description":"Formatted end date of the event (empty for TBD schedules or when end date is hidden).","title":"endDateFormatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endTimeFormatted":{"description":"Formatted end time of the event (empty for TBD schedules or when end date is hidden).","title":"endTimeFormatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Scheduling","description":""},"com.wix.events.upstream.wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","minLength":1,"maxLength":200,"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.","title":"height","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","title":"width","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text. Optional.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"wix.events.Registration":{"type":"object","properties":{"type":{"description":"Event type.","title":"type","type":"string","$ref":"#/components/schemas/wix.events.EventType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Event registration status.","title":"status","type":"string","$ref":"#/components/schemas/wix.events.RegistrationStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rsvpCollection":{"description":"RSVP collection details.","$ref":"#/components/schemas/wix.events.RsvpCollection","summary":"rsvpCollection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ticketing":{"description":"Ticketing details.","$ref":"#/components/schemas/wix.events.Ticketing","summary":"ticketing","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"external":{"description":"External registration details.","$ref":"#/components/schemas/wix.events.ExternalEvent","summary":"external","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restrictedTo":{"description":"Types of users allowed to register.","title":"restrictedTo","type":"string","$ref":"#/components/schemas/wix.events.VisitorType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialType":{"description":"Initial event type which was set when creating an event.","title":"initialType","type":"string","$ref":"#/components/schemas/wix.events.EventType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Registration","description":""},"wix.events.EventType":{"type":"string","description":"","title":"EventType","enum":["NA_EVENT_TYPE","RSVP","TICKETS","EXTERNAL","NO_REGISTRATION"]},"wix.events.RegistrationStatus":{"type":"string","description":"","title":"RegistrationStatus","enum":["NA_REGISTRATION_STATUS","CLOSED","CLOSED_MANUALLY","OPEN_RSVP","OPEN_RSVP_WAITLIST","OPEN_TICKETS","OPEN_EXTERNAL","SCHEDULED_RSVP"]},"wix.events.RsvpCollection":{"type":"object","properties":{"config":{"description":"RSVP collection configuration.","$ref":"#/components/schemas/wix.events.RsvpCollectionConfig","summary":"config","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RsvpCollection","description":""},"wix.events.RsvpCollectionConfig":{"type":"object","properties":{"rsvpStatusOptions":{"description":"Defines the supported RSVP statuses.","title":"rsvpStatusOptions","type":"string","$ref":"#/components/schemas/wix.events.RsvpCollectionConfig.RsvpStatusOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Total guest limit available to register to the event.\nAdditional guests per RSVP are counted towards total guests.","title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"waitlist":{"description":"Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status.","title":"waitlist","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startDate":{"description":"Registration start timestamp.","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endDate":{"description":"Registration end timestamp.","title":"endDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RsvpCollectionConfig","description":""},"wix.events.RsvpCollectionConfig.RsvpStatusOptions":{"type":"string","description":"","title":"RsvpStatusOptions","enum":["YES_ONLY","YES_AND_NO"]},"wix.events.Ticketing":{"type":"object","properties":{"lowestPrice":{"description":"Deprecated.","title":"lowestPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"highestPrice":{"description":"Deprecated.","title":"highestPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"currency":{"description":"Currency used in event transactions.","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"config":{"description":"Ticketing configuration.","$ref":"#/components/schemas/wix.events.TicketingConfig","summary":"config","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lowestTicketPrice":{"description":"Price of lowest priced ticket.","readOnly":true,"$ref":"#/components/schemas/wix.events.Money","summary":"lowestTicketPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"highestTicketPrice":{"description":"Price of highest priced ticket.","readOnly":true,"$ref":"#/components/schemas/wix.events.Money","summary":"highestTicketPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lowestTicketPriceFormatted":{"description":"Formatted price of lowest priced ticket.","readOnly":true,"title":"lowestTicketPriceFormatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"highestTicketPriceFormatted":{"description":"Formatted price of highest priced ticket.","readOnly":true,"title":"highestTicketPriceFormatted","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"soldOut":{"description":"Whether all tickets are sold for this event.","readOnly":true,"title":"soldOut","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Ticketing","description":""},"wix.events.TicketingConfig":{"type":"object","properties":{"guestAssignedTickets":{"description":"Whether the form must be filled out separately for each ticket.","title":"guestAssignedTickets","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxConfig":{"description":"Tax configuration.","$ref":"#/components/schemas/wix.events.TaxConfig","summary":"taxConfig","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ticketLimitPerOrder":{"description":"Limit of tickets that can be purchased per order, default 20.","minimum":0,"maximum":50,"title":"ticketLimitPerOrder","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservationDurationInMinutes":{"description":"Duration for which the tickets being bought are reserved.","minimum":5,"maximum":30,"title":"reservationDurationInMinutes","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TicketingConfig","description":""},"wix.events.TaxConfig":{"type":"object","properties":{"type":{"description":"Tax application settings.","title":"type","type":"string","$ref":"#/components/schemas/wix.events.TaxType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Tax name.","minLength":1,"maxLength":10,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rate":{"description":"Tax rate (e.g.,`21.55`).","title":"rate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0.001","lte":"100","maxScale":3}}},"appliesToDonations":{"description":"Applies taxes for donations, default true.","title":"appliesToDonations","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TaxConfig","description":""},"wix.events.TaxType":{"type":"string","description":"","title":"TaxType","enum":["INCLUDED","ADDED","ADDED_AT_CHECKOUT"]},"wix.events.Money":{"type":"object","properties":{"amount":{"description":"*Deprecated:** Use `value` instead.","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"currency":{"description":"ISO 4217 format of the currency e.g., `USD`.","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.","format":"DECIMAL_VALUE","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Money","description":""},"wix.events.ExternalEvent":{"type":"object","properties":{"registration":{"description":"External event registration URL.","title":"registration","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExternalEvent","description":""},"wix.events.VisitorType":{"type":"string","description":"","title":"VisitorType","enum":["VISITOR","MEMBER","VISITOR_OR_MEMBER"]},"wix.events.CalendarLinks":{"type":"object","properties":{"google":{"description":"\"Add to Google calendar\" URL.","title":"google","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ics":{"description":"\"Download ICS calendar file\" URL.","title":"ics","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalendarLinks","description":""},"wix.events.SiteUrl":{"type":"object","properties":{"base":{"description":"Base URL. For premium sites, this will be the domain.\nFor free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)","title":"base","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"path":{"description":"The path to that page - e.g `/my-events/weekly-meetup-2`","title":"path","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteUrl","description":"Site URL components"},"wix.events.form.Form":{"type":"object","properties":{"controls":{"description":"Nested fields as an ordered list.","title":"controls","type":"array","items":{"$ref":"#/components/schemas/wix.events.form.InputControl"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"messages":{"description":"Set of configured form messages.","$ref":"#/components/schemas/wix.events.form.FormMessages","summary":"messages","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Form","description":"The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).\nIt also contains customizable messages and labels.\n\n\nA form is an ordered list of controls (blocks), which accept guest information into a field input.\n\nEach control contains one or more nested inputs. For example, `Name` control has two inputs:\n- First Name\n- Last Name\n\nBy default, name and email controls are always required and are pinned to the top of the form."},"wix.events.form.InputControl":{"type":"object","properties":{"type":{"description":"Field control type.","title":"type","type":"string","$ref":"#/components/schemas/wix.events.form.InputControlType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"system":{"description":"Whether control is mandatory (such as name & email). When true, only label can be changed.","title":"system","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Deprecated: Use `id`.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"inputs":{"description":"Child inputs.","title":"inputs","type":"array","items":{"$ref":"#/components/schemas/wix.events.form.Input"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"label":{"description":"Deprecated: use `inputs.label`.","title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"orderIndex":{"description":"Field controls are sorted by this value in ascending order.","title":"orderIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"Unique control ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleted":{"description":"Whether input control is deleted.","readOnly":true,"title":"deleted","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InputControl","description":"A block of nested fields.\nUsed to aggregate similar inputs like First Name and Last Name."},"wix.events.form.InputControlType":{"type":"string","description":"","title":"InputControlType","enum":["INPUT","TEXTAREA","DROPDOWN","RADIO","CHECKBOX","NAME","GUEST_CONTROL","ADDRESS_SHORT","ADDRESS_FULL","DATE"]},"wix.events.form.Input":{"type":"object","properties":{"name":{"description":"Field name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"array":{"description":"Deprecated: use `ValueType.TEXT_ARRAY`.","title":"array","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"label":{"description":"Main field label","title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"additionalLabels":{"description":"Additional labels for multi-valued fields such as address.","title":"additionalLabels","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Predefined choice options for fields, such as dropdown.","title":"options","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mandatory":{"description":"Whether field is mandatory.","title":"mandatory","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxLength":{"description":"Maximum number of accepted characters (relevant for text fields).","title":"maxLength","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type which determines field format.\nUsed to validate submitted response.","title":"type","type":"string","$ref":"#/components/schemas/wix.events.form.ValueType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxSize":{"description":"A maximum accepted values for array input.\nOnly applicable for inputs of valueType: TEXT_ARRAY.","title":"maxSize","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"defaultOptionSelection":{"description":"Preselected option.\nCurrently only applicable for dropdown.","$ref":"#/components/schemas/wix.events.form.OptionSelection","summary":"defaultOptionSelection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labels":{"description":"Additional labels for multi-valued fields such as address.","readOnly":true,"title":"labels","type":"array","items":{"$ref":"#/components/schemas/wix.events.form.Label"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Input","description":"An input of one or multiple text values"},"wix.events.form.ValueType":{"type":"string","description":"","title":"ValueType","enum":["TEXT","NUMBER","TEXT_ARRAY","DATE_TIME","ADDRESS"]},"wix.events.form.OptionSelection":{"type":"object","properties":{},"title":"OptionSelection","description":"Describes initially selected option when an input has multiple choices.\nDefaults to first (0th) option if not configured.","oneOf":[{"description":"","summary":"selectedOption","$ref":"#/components/schemas/wix.events.form.OptionSelection.selectedOption"}]},"wix.events.form.OptionSelection.selectedOption":{"type":"object","title":"selectedOption","properties":{"optionIndex":{"description":"0-based index from predefined `input.options` which is selected initially.","minimum":0,"maximum":199,"title":"optionIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"placeholderText":{"description":"Placeholder hint describing expected choices (such as \"Please select\").\nConsidered an empty choice.","maxLength":200,"title":"placeholderText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.events.form.Label":{"type":"object","properties":{"name":{"description":"Field name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"label":{"description":"Field label.","title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Label","description":""},"wix.events.form.FormMessages":{"type":"object","properties":{"rsvp":{"description":"RSVP form messages.","$ref":"#/components/schemas/wix.events.form.RsvpFormMessages","summary":"rsvp","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"checkout":{"description":"Checkout form messages.","$ref":"#/components/schemas/wix.events.form.CheckoutFormMessages","summary":"checkout","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"registrationClosed":{"description":"Messages shown when event registration is closed.","$ref":"#/components/schemas/wix.events.form.RegistrationClosedMessages","summary":"registrationClosed","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ticketsUnavailable":{"description":"Messages shown when event tickets are unavailable.","$ref":"#/components/schemas/wix.events.form.TicketsUnavailableMessages","summary":"ticketsUnavailable","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FormMessages","description":"Defines form messages shown in UI before, during, and after registration flow.\nIt enables configuration of form titles, response labels, \"thank you\" messages, and call-to-action texts."},"wix.events.form.RsvpFormMessages":{"type":"object","properties":{"rsvpYesOption":{"description":"Label text indicating RSVP `YES` response.","title":"rsvpYesOption","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rsvpNoOption":{"description":"Label text indicating RSVP `NO` response.","title":"rsvpNoOption","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"positiveMessages":{"description":"Messages shown for RSVP = `YES`.","$ref":"#/components/schemas/wix.events.form.RsvpFormMessages.Positive","summary":"positiveMessages","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"waitlistMessages":{"description":"Messages shown for RSVP = `WAITING` (when event is full and waitlist is available).","$ref":"#/components/schemas/wix.events.form.RsvpFormMessages.Positive","summary":"waitlistMessages","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"negativeMessages":{"description":"Messages shown for RSVP = `NO`.","$ref":"#/components/schemas/wix.events.form.RsvpFormMessages.Negative","summary":"negativeMessages","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"submitActionLabel":{"description":"\"Submit form\" call-to-action label text.","title":"submitActionLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RsvpFormMessages","description":""},"wix.events.form.RsvpFormMessages.Positive.ResponseConfirmation":{"type":"object","properties":{"title":{"description":"Confirmation message title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"Confirmation message text.","title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addToCalendarActionLabel":{"description":"\"Add to calendar\" call-to-action label text.","title":"addToCalendarActionLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shareActionLabel":{"description":"\"Share event\" call-to-action label text.","title":"shareActionLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ResponseConfirmation","description":"Confirmation messages shown after registration."},"wix.events.form.RsvpFormMessages.Negative.ResponseConfirmation":{"type":"object","properties":{"title":{"description":"Confirmation message title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shareActionLabel":{"description":"\"Share event\" call-to-action label text.","title":"shareActionLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ResponseConfirmation","description":"Confirmation messages shown after registration."},"wix.events.form.RsvpFormMessages.Positive":{"type":"object","properties":{"title":{"description":"Main form title for positive response.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"confirmation":{"description":"Confirmation messages shown after registration.","$ref":"#/components/schemas/wix.events.form.RsvpFormMessages.Positive.ResponseConfirmation","summary":"confirmation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Positive","description":"Set of messages shown during registration when RSVP response is positive."},"wix.events.form.RsvpFormMessages.Negative":{"type":"object","properties":{"title":{"description":"Main form title for negative response.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"confirmation":{"description":"Confirmation messages shown after registration.","$ref":"#/components/schemas/wix.events.form.RsvpFormMessages.Negative.ResponseConfirmation","summary":"confirmation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Negative","description":"A set of messages shown during registration with negative response"},"wix.events.form.CheckoutFormMessages":{"type":"object","properties":{"title":{"description":"Main form title for response.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"submitActionLabel":{"description":"Submit form call-to-action label text.","title":"submitActionLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"confirmation":{"description":"Confirmation messages shown after checkout.","$ref":"#/components/schemas/wix.events.form.CheckoutFormMessages.ResponseConfirmation","summary":"confirmation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CheckoutFormMessages","description":""},"wix.events.form.CheckoutFormMessages.ResponseConfirmation":{"type":"object","properties":{"title":{"description":"Confirmation message title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"Confirmation message text.","title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"downloadTicketsLabel":{"description":"\"Download tickets\" call-to-action label text.","title":"downloadTicketsLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addToCalendarLabel":{"description":"\"Add to calendar\" call-to-action label text.","title":"addToCalendarLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shareEventLabel":{"description":"\"Share event\" call-to-action label text.","title":"shareEventLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ResponseConfirmation","description":"Confirmation messages shown after checkout."},"wix.events.form.RegistrationClosedMessages":{"type":"object","properties":{"message":{"description":"Message shown when event registration is closed.","title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"exploreEventsActionLabel":{"description":"\"Explore other events\" call-to-action label text.","title":"exploreEventsActionLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RegistrationClosedMessages","description":""},"wix.events.form.TicketsUnavailableMessages":{"type":"object","properties":{"message":{"description":"Message shown when event tickets are unavailable.","title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"exploreEventsActionLabel":{"description":"\"Explore other events\" call-to-action label text.","title":"exploreEventsActionLabel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TicketsUnavailableMessages","description":""},"wix.events.Dashboard":{"type":"object","properties":{"rsvpSummary":{"description":"Guest RSVP summary.","$ref":"#/components/schemas/wix.events.Dashboard.RsvpSummary","summary":"rsvpSummary","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ticketingSummary":{"description":"Summary of revenue and tickets sold.\n(Archived orders are not included).","$ref":"#/components/schemas/wix.events.Dashboard.TicketingSummary","summary":"ticketingSummary","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Dashboard","description":""},"wix.events.Dashboard.RsvpSummary":{"type":"object","properties":{"total":{"description":"Total number of RSVPs.","title":"total","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"yes":{"description":"Number of RSVPs with status `YES`.","title":"yes","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"no":{"description":"Number of RSVPs with status `NO`.","title":"no","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"waitlist":{"description":"Number of RSVPs in waitlist.","title":"waitlist","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RsvpSummary","description":""},"wix.events.Dashboard.TicketingSummary":{"type":"object","properties":{"tickets":{"description":"Number of tickets sold.","title":"tickets","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revenue":{"description":"Total revenue, excluding fees.\n(taxes and payment provider fees are not deducted.)","$ref":"#/components/schemas/wix.events.Money","summary":"revenue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currencyLocked":{"description":"Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created).","title":"currencyLocked","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"orders":{"description":"Number of orders placed.","title":"orders","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalSales":{"description":"Total balance of confirmed transactions.","$ref":"#/components/schemas/wix.events.Money","summary":"totalSales","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TicketingSummary","description":""},"wix.events.GuestListConfig":{"type":"object","properties":{"publicGuestList":{"description":"Whether members can see other members attending the event (defaults to true).","title":"publicGuestList","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GuestListConfig","description":""},"wix.events.Feed":{"type":"object","properties":{"token":{"description":"Event discussion feed token.","title":"token","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Feed","description":""},"wix.events.OnlineConferencing":{"type":"object","properties":{"config":{"description":"","$ref":"#/components/schemas/wix.events.OnlineConferencingConfig","summary":"config","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"session":{"description":"","$ref":"#/components/schemas/wix.events.OnlineConferencingSession","summary":"session","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OnlineConferencing","description":""},"wix.events.OnlineConferencingConfig":{"type":"object","properties":{"enabled":{"description":"Whether online conferencing is enabled (not supported for TBD schedules).\nWhen enabled, links to join conferencing are generated and provided to guests.","title":"enabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerId":{"description":"Conferencing provider ID.","format":"GUID","title":"providerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"conferenceType":{"description":"Conference type","title":"conferenceType","type":"string","$ref":"#/components/schemas/wix.events.ConferenceType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OnlineConferencingConfig","description":""},"wix.events.ConferenceType":{"type":"string","description":"","title":"ConferenceType","enum":["MEETING","WEBINAR"]},"wix.events.OnlineConferencingSession":{"type":"object","properties":{"hostLink":{"description":"Link for event host to start the online conference session.","readOnly":true,"title":"hostLink","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"guestLink":{"description":"Link for guests to join the online conference session.","readOnly":true,"title":"guestLink","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"password":{"description":"The password required to join online conferencing session (when relevant).","readOnly":true,"title":"password","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sessionCreated":{"description":"Indicates that session was created successfully on providers side.","readOnly":true,"title":"sessionCreated","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sessionId":{"description":"Unique session id","readOnly":true,"title":"sessionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OnlineConferencingSession","description":""},"wix.events.SeoSettings":{"type":"object","properties":{"slug":{"description":"URL slug","maxLength":130,"title":"slug","type":"string","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"}},"hidden":{"description":"Hidden from SEO Site Map","readOnly":true,"title":"hidden","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SeoSettings","description":""},"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"}},"origin":{"description":"Who added the keyword to the settings","maxLength":1000,"title":"origin","type":"string","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":""},"wix.events.Agenda":{"type":"object","properties":{"enabled":{"description":"Whether the schedule is enabled for the event.","title":"enabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageUrl":{"description":"Agenda page URL.","readOnly":true,"$ref":"#/components/schemas/wix.events.SiteUrl","summary":"pageUrl","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Agenda","description":""},"wix.events.categories.Category":{"type":"object","properties":{"id":{"description":"Category ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Category name.","minLength":1,"maxLength":30,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time when category was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"counts":{"description":"The total number of draft and published events assigned to the category.","readOnly":true,"$ref":"#/components/schemas/wix.events.categories.CategoryCounts","summary":"counts","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"states":{"description":"Category state. Possible values:\n\n`MANUAL`: Category is created manually by the user.\n`AUTO`: Category is created automatically.\n`RECURRING_EVENT`: Category is created automatically when publishing recurring events.\n`HIDDEN`: Category can't be seen.\n\nDefault: `MANUAL`.\n\n**Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.","maxItems":3,"title":"states","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.CategoryState.State"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Category","description":""},"wix.events.categories.CategoryCounts":{"type":"object","properties":{"assignedEventsCount":{"description":"Total number of draft events assigned to the category.","title":"assignedEventsCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assignedDraftEventsCount":{"description":"Total number of published events assigned to the category. Deleted events are excluded.","title":"assignedDraftEventsCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CategoryCounts","description":""},"wix.events.CategoryState.State":{"type":"string","description":"","title":"State","enum":["MANUAL","AUTO","RECURRING_EVENT","HIDDEN","COMPONENT"]},"wix.events.EventDisplaySettings":{"type":"object","properties":{"hideEventDetailsButton":{"description":"Whether event details button is hidden. Only available for events with no registration.","title":"hideEventDetailsButton","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventDisplaySettings","description":""},"wix.events.LabellingSettings":{"type":"object","properties":{},"title":"LabellingSettings","description":""},"wix.events.events.EventUpdated":{"type":"object","properties":{"timestamp":{"description":"Event update timestamp in ISO UTC format.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventId":{"description":"Event ID.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"location":{"description":"Event location.","$ref":"#/components/schemas/wix.events.Location","summary":"location","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleConfig":{"description":"Event schedule configuration.","$ref":"#/components/schemas/wix.events.ScheduleConfig","summary":"scheduleConfig","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Event title.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduleConfigUpdated":{"description":"Whether schedule configuration was updated.","title":"scheduleConfigUpdated","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"event":{"description":"Updated event","$ref":"#/components/schemas/wix.events.Event","summary":"event","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EventUpdated","description":""},"com.wixpress.seating.SeatingPlanCategoriesSummaryUpdated":{"type":"object","properties":{"seatingPlanId":{"description":"Seating plan id","format":"GUID","title":"seatingPlanId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalSeatingPlanId":{"description":"External seating plan id","title":"externalSeatingPlanId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categories":{"description":"Ticket counts by category","maxItems":100,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.seating.CategoryDetails"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Summary revision.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SeatingPlanCategoriesSummaryUpdated","description":""},"com.wixpress.seating.CategoryDetails":{"type":"object","properties":{"seatingPlanId":{"description":"Seating plan id","format":"GUID","readOnly":true,"title":"seatingPlanId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalSeatingPlanId":{"description":"External seating plan id","minLength":1,"maxLength":100,"readOnly":true,"title":"externalSeatingPlanId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalCategoryId":{"description":"External category id","minLength":1,"maxLength":100,"readOnly":true,"title":"externalCategoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalCapacity":{"description":"Total capacity in the category","readOnly":true,"title":"totalCapacity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reserved":{"description":"Already reserved capacity","readOnly":true,"title":"reserved","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CategoryDetails","description":""},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent":{"type":"object","properties":{"metaSiteId":{"description":"A meta site id.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A meta site version. Monotonically increasing.","title":"version","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timestamp":{"description":"A timestamp of the event.","title":"timestamp","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assets":{"description":"A list of \"assets\" (applications). The same as MetaSiteContext.","maxItems":400,"title":"assets","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MetaSiteSpecialEvent","description":"","oneOf":[{"description":"","summary":"payload","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload"}]},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload":{"type":"object","title":"payload","properties":{"siteCreated":{"description":"Emitted on a meta site creation.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreated","summary":"siteCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteTransferred":{"description":"Emitted on a meta site transfer completion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteTransferred","summary":"siteTransferred","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteDeleted":{"description":"Emitted on a meta site deletion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteDeleted","summary":"siteDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUndeleted":{"description":"Emitted on a meta site restoration.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUndeleted","summary":"siteUndeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sitePublished":{"description":"Emitted on the first* publish of the meta site (* switching from unpublished to published state).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SitePublished","summary":"sitePublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUnpublished":{"description":"Emitted on a meta site unpublish.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUnpublished","summary":"siteUnpublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsTemplate":{"description":"Emitted when meta site is marked as template.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsTemplate","summary":"siteMarkedAsTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsWixSite":{"description":"Emitted when meta site is marked as a WixSite.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsWixSite","summary":"siteMarkedAsWixSite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceProvisioned":{"description":"Emitted when an application is provisioned (installed).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceProvisioned","summary":"serviceProvisioned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceRemoved":{"description":"Emitted when an application is removed (uninstalled).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceRemoved","summary":"serviceRemoved","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteRenamedPayload":{"description":"Emitted when meta site name (URL slug) is changed.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteRenamed","summary":"siteRenamedPayload","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hardDeleted":{"description":"Emitted when meta site was permanently deleted.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteHardDeleted","summary":"hardDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceChanged":{"description":"Emitted on a namespace change.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.NamespaceChanged","summary":"namespaceChanged","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioAssigned":{"description":"Emitted when Studio is attached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioAssigned","summary":"studioAssigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioUnassigned":{"description":"Emitted when Studio is detached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioUnassigned","summary":"studioUnassigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.metasite.event.api.Asset":{"type":"object","properties":{"appDefId":{"description":"An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"An instance id. For legacy reasons may be UUID or a string.","maxLength":200,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"state":{"description":"An application state.","title":"state","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset.State","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Asset","description":""},"com.wixpress.metasite.event.api.Asset.State":{"type":"string","description":"","title":"State","enum":["UNKNOWN","ENABLED","DISABLED","PENDING","DEMO"]},"com.wixpress.metasite.event.api.SiteCreated":{"type":"object","properties":{"originTemplateId":{"description":"A template identifier (empty if not created from a template).","maxLength":36,"title":"originTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ownerId":{"description":"An account id of the owner.","format":"GUID","title":"ownerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"context":{"description":"A context in which meta site was created.","title":"context","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreatedContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originMetaSiteId":{"description":"A meta site id from which this site was created.\n\nIn case of a creation from a template it's a template id.\nIn case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.","format":"GUID","title":"originMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteName":{"description":"A meta site name (URL slug).","maxLength":20,"title":"siteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"A namespace.","title":"namespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteCreated","description":""},"com.wixpress.metasite.event.api.SiteCreatedContext":{"type":"string","description":"","title":"SiteCreatedContext","enum":["OTHER","FROM_TEMPLATE","DUPLICATE_BY_SITE_TRANSFER","DUPLICATE","OLD_SITE_TRANSFER","FLASH"]},"com.wixpress.metasite.event.api.MetaSite.Namespace":{"type":"string","description":"","title":"Namespace","enum":["UNKNOWN_NAMESPACE","WIX","SHOUT_OUT","ALBUMS","WIX_STORES_TEST_DRIVE","HOTELS","CLUBS","ONBOARDING_DRAFT","DEV_SITE","LOGOS","VIDEO_MAKER","PARTNER_DASHBOARD","DEV_CENTER_COMPANY","HTML_DRAFT","SITELESS_BUSINESS","CREATOR_ECONOMY","DASHBOARD_FIRST","ANYWHERE","HEADLESS","ACCOUNT_MASTER_CMS","RISE","BRANDED_FIRST","NOWNIA"]},"com.wixpress.metasite.event.api.SiteTransferred":{"type":"object","properties":{"oldOwnerId":{"description":"A previous owner id (user that transfers meta site).","format":"GUID","title":"oldOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newOwnerId":{"description":"A new owner id (user that accepts meta site).","format":"GUID","title":"newOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteTransferred","description":"Site transferred to another user."},"com.wixpress.metasite.event.api.SiteDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteDeleted","description":"Soft deletion of the meta site. Could be restored."},"com.wixpress.metasite.event.api.DeleteContext":{"type":"object","properties":{"dateDeleted":{"description":"When the meta site was deleted.","title":"dateDeleted","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteStatus":{"description":"A status.","title":"deleteStatus","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext.DeleteStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteOrigin":{"description":"A reason (flow).","maxLength":255,"title":"deleteOrigin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initiatorId":{"description":"A service that deleted it.","maxLength":255,"title":"initiatorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteContext","description":""},"com.wixpress.metasite.event.api.DeleteContext.DeleteStatus":{"type":"string","description":"","title":"DeleteStatus","enum":["UNKNOWN","TRASH","DELETED","PENDING_PURGE"]},"com.wixpress.metasite.event.api.SiteUndeleted":{"type":"object","properties":{},"title":"SiteUndeleted","description":"Restoration of the meta site."},"com.wixpress.metasite.event.api.SitePublished":{"type":"object","properties":{},"title":"SitePublished","description":"First publish of a meta site. Or subsequent publish after unpublish."},"com.wixpress.metasite.event.api.SiteUnpublished":{"type":"object","properties":{"urls":{"description":"A list of URLs previously associated with the meta site.","maxLength":4000,"maxItems":10000,"title":"urls","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteUnpublished","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsTemplate":{"type":"object","properties":{},"title":"SiteMarkedAsTemplate","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsWixSite":{"type":"object","properties":{},"title":"SiteMarkedAsWixSite","description":""},"com.wixpress.metasite.event.api.ServiceProvisioned":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originInstanceId":{"description":"An instance id from which this instance is originated.","maxLength":36,"title":"originInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":50,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceProvisioned","description":""},"com.wixpress.metasite.event.api.ServiceRemoved":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":50,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceRemoved","description":""},"com.wixpress.metasite.event.api.SiteRenamed":{"type":"object","properties":{"newSiteName":{"description":"A new meta site name (URL slug).","maxLength":20,"title":"newSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldSiteName":{"description":"A previous meta site name (URL slug).","maxLength":255,"title":"oldSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteRenamed","description":"Rename of the site. Meaning, free public url has been changed as well."},"com.wixpress.metasite.event.api.SiteHardDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteHardDeleted","description":"Hard deletion of the meta site.\n\nCould not be restored. Therefore it's desirable to cleanup data."},"com.wixpress.metasite.event.api.NamespaceChanged":{"type":"object","properties":{"oldNamespace":{"description":"A previous namespace.","title":"oldNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newNamespace":{"description":"A new namespace.","title":"newNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NamespaceChanged","description":""},"com.wixpress.metasite.event.api.StudioAssigned":{"type":"object","properties":{},"title":"StudioAssigned","description":"Assigned Studio editor"},"com.wixpress.metasite.event.api.StudioUnassigned":{"type":"object","properties":{},"title":"StudioUnassigned","description":"Unassigned Studio editor"},"wix.events.ticketdef.v3.GetTicketDefinitionFromTrashBinRequest":{"type":"object","properties":{"ticketDefinitionId":{"description":"Ticket definition ID.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Requested fields. Not implemented.","maxItems":1,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.events.ticketdef.v3.RequestedFields.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTicketDefinitionFromTrashBinRequest","description":""},"wix.events.ticketdef.v3.GetTicketDefinitionFromTrashBinResponse":{"type":"object","properties":{"ticketDefinition":{"description":"The requested ticket definition.","$ref":"#/components/schemas/wix.events.ticketdef.v3.TicketDefinition","summary":"ticketDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTicketDefinitionFromTrashBinResponse","description":""},"wix.events.ticketdef.v3.ScheduleLegacyTimeCapsuleTaskRequest":{"type":"object","properties":{"ticketDefinitionId":{"description":"Definition ID.","format":"GUID","title":"ticketDefinitionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScheduleLegacyTimeCapsuleTaskRequest","description":""}}},"title":"Ticket Definition","description":"","fqdn":"wix.events.v3.ticket_definition"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Ticket Definitions v3\n\nWith the Ticket Definitions API, you can create definitions for tickets. A definition includes the following ticket settings:\n\n- Fee type. Determine whether the fee will be paid by a guest or a seller.\n- Pricing. Define different ticket prices based on factors such as early bird discounts, VIP packages, group rates, or special promotions. Several pricing methods are available for you to select from: **Fixed price**, **Guest price**, **Free**. Additionally, you can customize prices for different groups of people using **Price options**.\n- Availability. Set the ticket limit available to buy. Also, you are able to check number of purchased or reserved tickets.\n- Sale period. Set the sale start and end dates. Also, when defining the sale period, it is possible to choose to display event tickets to customers even before the sale starts.\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n- Install the **Wix Events & Tickets** app from [Wix App Market](fallback::https://www.wix.com/app-market/wix-events).\n- Ticket definition is not the same as ticket. Ticket definitions are used to define settings for a set of tickets. After paying for selected tickets, the [Checkout API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7dcf1b07-43e0-492f-904b-f52e4546486fslug::checkout*fallback::https://dev.wix.com/docs/rest/business-solutions/events/events/order-checkout/checkout) automatically generates the ticket.\n\n## Use cases\n\n- [Add a specific-price ticket counter for an event](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::sample-use-cases-and-flows#add-a-specific-price-ticket-counter-for-an-event*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/sample-use-cases-and-flows#add-a-specific-price-ticket-counter-for-an-event)\n- [Sync ticket definitions with external ticketing system](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::sample-use-cases-and-flows#sync-ticket-definitions-with-an-external-ticketing-system*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/sample-use-cases-and-flows#sync-ticket-definitions-with-an-external-ticketing-system)\n- [Notify when tickets go on sale](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::sample-use-cases-and-flows#notify-customers-when-tickets-go-on-sale*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/sample-use-cases-and-flows#notify-customers-when-tickets-go-on-sale)\n\n## Terminology\n\n- **Pricing method**: Different pricing methods are available for an event:\n - **Fixed price**: All tickets in the same definition are sold at the exact same price, regardless of when they are purchased or other factors.\n - **Guest price**: The guest enters the ticket price. Optionally, you can set the minimum price guests must pay for a ticket. This pricing method is applied to donation.\n - **Price options**: All tickets in the same ticket definition are priced at different rates, such as different prices for adults, children, and students.\n- **Ticket availability**: The status of ticket inventory, indicating whether tickets are available or sold out. This type can also include availability limits and timeframes for ticket sales.\n- **Sale period**: Duration of time during which event tickets are available for purchase. \n- **Event Dashboard**: Control center in the Wix site UI for managing site event settings and features."},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Ticket Definitions v3: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the Ticket Definition object:\n\n| Field | Query Filter Operators | Sortable |\n|----------------------------------------|-----------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `eventId` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `name` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `description` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `limit` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `pricing_method.pricing_type` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `feeType` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `saleStatus` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable | \n| `updatedDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |\n| `hidden` | `$eq`, `$ne`, `$in`, `$nin`, `$exists` | Sortable |\n| `pricing_method.free` | `$eq`, `$ne`, `$in`, `$nin`, `$exists` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Ticket Definitions Query endpoint](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::query-ticket-definitions*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/query-ticket-definitions)"},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Ticket Definitions v3: Sample Use Cases & Flows\n\nThis article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation. \n\n## Add a specific-price ticket counter for an event\n\nThis use case demonstrates how you can update your event site with a ticket counter for specific-price tickets. This counter provides real-time information on the availability of tickets for customers to see. For example, your page can have a counter that says \"Only 3 tickets left for this price.\" By displaying the number of tickets remaining, you can motivate customers to buy tickets promptly. \n\n> **Note**: This flow assumes you have already created the UI component of the counter for your site.\n\nTo create a ticket counter, follow these steps:\n \n1. Call [Get Ticket Definition](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::get-ticket-definition*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/get-ticket-definition) and retrieve either:\n - The `salesDetails.unsoldCount` and `fixedPrice.value` values (for `fixedPrice` pricing method).\n - The `salesDetails.unsoldCount` and `pricingOptions.optionDetails.price.value` field values (for `optionalPrice` pricing method).\n\n1. Pass these retrieved values in your app to initialize the counter on your website, displaying the number of available tickets at the specified price.\n\n1. On an ongoing basis, listen for each new ticket purchase using the [Order Confirmed Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7dcf1b07-43e0-492f-904b-f52e4546486fslug::order-confirmed*fallback::https://dev.wix.com/docs/rest/business-solutions/events/events/order-checkout/order-confirmed).\n\n1. When the webhook is triggered, you'll receive an order in the payload. Retrieve the `ticketDefinitionId` value from the event data.\n\n1. Send the extracted `ticketDefinitionId` value to your site and compare it with the ticket definition ID for which the counter is set. If they match, call [Get Ticket Definition](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::get-ticket-definition*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/get-ticket-definition) again to retrieve the updated `salesDetails.unsoldCount` value. Send this new decreased value to your website to update the ticket counter.\n\n## Sync ticket definitions with an external ticketing system\n\nIf you're using a Wix site to manage events and another system to handle ticketing, you can synchronize ticket definitions between them whenever a definition is updated on the site. This includes aspects such as ticket types, pricing, availability, and any other relevant ticket settings. This synchronization eliminates the need for manual updates and reduces the risk of discrepancies between systems.\n\nTo upload and update all ticket definitions defined on the Wix site to your external system for the first time, follow these flows:\n\n- [Initial setup](fallback::#part-1-initial-setup)\n- [Synchronize to the external system](fallback::#part-2-synchronize-to-the-external-system)\n\n### Part 1: Initial setup\n\n1. Create a custom field in your system that stores the ticket definition ID for a particular event to ensure a 1-to-1 relationship with the external ticketing system. Craft your code so that this ID won't be overwritten by future updates from your app.\n\n1. Create a mapping from the site ticket definition fields to the system fields that will be used whenever site ticket definitions and the external system are synchronized.\n\n1. [Query Ticket Definitions](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::query-ticket-definitions*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/query-ticket-definitions) by `eventId` and send the relevant information to the external ticketing system.\n\n### Part 2: Synchronize to the external system\n\n1. On an ongoing basis, listen for changes to site ticket definitions with these webhooks:\n\n - [Ticket Definition Created Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::ticket-definition-created*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/ticket-definition-created)\n - [Ticket Definition Updated Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::ticket-definition-updated*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/ticket-definition-updated)\n - [Ticket Definition Deleted Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::ticket-definition-deleted*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/ticket-definition-deleted)\n \n1. When one of the above webhooks is triggered, you'll receive the ticket definition in the payload. You can bring those changes to the ticketing system by retrieving the relevant info from the payload, and use mapping to take action on the external system:\n\n - For created and updated ticket definitions retrieve the relevant info from the `createdEvent.currentEntity` object.\n\n - For deleted ticket definitions retrieve the `createdEvent.currentEntity.id` value.\n\n## Notify customers when tickets go on sale \n\nLet customers know when ticket sales for an event begin. You can send automated notifications to customers with email or push notifications. These notifications make customers aware of ticket availability so they can secure their tickets promptly.\n\n> **Note**: This flow assumes your customers already have the ability to subscribe to your newsletters.\n\nTo send notifications about the start of ticket sales, follow these steps:\n\n1. [Get Ticket Definition](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::6623518e-0657-4085-a3b2-79163c1cf7f8slug::get-ticket-definition*fallback::https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/get-ticket-definition).\n\n2. Retrieve the `salePeriod.startDate` field value, and write your code so that the value can be passed to your marketing tool.\n\n3. Request and filter the list of subscribers in your external marketing tool based on customers subscription status for the current event. \n\n4. When the ticket sale start date arrives, send notifications to your customers who have opted in to receive marketing emails.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}