{"id":"8b66004d-79f0-4adc-9666-69d3658727d7","createdDate":"2024-08-29T09:23:09.839Z","updatedDate":"2024-08-29T09:23:09.839Z","resourceId":"343e8ce4-0292-4b05-b188-8e1a5ebda8d1","api":{"schema":{"object":{"displayName":"Reservation Object","description":"The reservation domain object.","slug":"reservation-object","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","legacyExamples":[{"title":"Reservation","content":"{\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\",\n \"1786ac8a-c3cc-473c-86c2-a71bf4d3a55b\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"tablesWithReservationConflicts\": [\n {\n \"tableId\": \"1786ac8a-c3cc-473c-86c2-a71bf4d3a55b\",\n \"reservationIds\": [\n \"d6ea9e80-3a8c-4d7a-8ec4-707167a16848\",\n \"4de34810-45e9-4e2a-a7b6-8d3a6e839b34\"\n ]\n }\n ],\n \"revision\": \"1\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"methods":[{"summary":"List Reservations","description":"Retrieves a list of up to 100 reservations.","operationId":"wix.table_reservations.reservation.v1.ReservationsService.ListReservations","parameters":[{"name":"paging","in":"query","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`.","required":false,"schema":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"sort","in":"query","description":"Defines how reservations in the response are sorted.","required":false,"schema":{"description":"Defines how reservations in the response are sorted.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Sorting","summary":"sort","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"startDateFrom","in":"query","description":"Only reservations starting after this date are returned.","required":false,"schema":{"description":"Only reservations starting after this date are returned.","title":"startDateFrom","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"startDateTo","in":"query","description":"Only reservations starting before this date are returned.","required":false,"schema":{"description":"Only reservations starting before this date are returned.","title":"startDateTo","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"status","in":"query","description":"Only reservations with this status are returned.\n\n* `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n* `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n* `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n* `RESERVED`: The reservation is confirmed.\n* `SEATED`: The customer is currently occupying the table.\n* `CANCELED`: The reservation is canceled.\n* `NO_SHOW`: The customer didn't show up for their reservation.\n* `FINISHED`: The reservation completed successfully.","required":false,"schema":{"description":"Only reservations with this status are returned.\n\n* `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n* `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n* `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n* `RESERVED`: The reservation is confirmed.\n* `SEATED`: The customer is currently occupying the table.\n* `CANCELED`: The reservation is canceled.\n* `NO_SHOW`: The customer didn't show up for their reservation.\n* `FINISHED`: The reservation completed successfully.","title":"status","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.StatusEnum.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.ListReservationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.ListReservationsRequest","responseMessage":"wix.table_reservations.reservation.v1.ListReservationsResponse"},"legacyExamples":[{"name":"ListReservations","type":"METHOD","content":{"title":"List reservations","request":"curl 'https://www.wixapis.com/table-reservations/reservations/v1/reservations?fieldsets=FULL&cursorPaging.limit=1&sort.fieldName=createdDate&sort.order=DESC' \\\n -H 'Authorization: '","response":"{\n \"reservations\": [\n {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": \"6c85916ce13a00fb7b50cce6bebef2073124c082.Eg4qDAoKCgQkYW5kEgIyABotCgxfY3JlYXRlZERhdGUQARobKhkKFwoKJHRpbWVzdGFtcBIJEQCwjdxwdXhCIiQwOWI5ZWQ3NC1jZTkyLTQxMDItODJkZC0yNGMxYzQ5NDFjM2M\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"get","path":"/v1/reservations","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.ListReservationsRequest","responseMessage":"wix.table_reservations.reservation.v1.ListReservationsResponse"},"legacyExamples":[{"name":"ListReservations","type":"METHOD","content":{"title":"List reservations","request":"curl 'https://www.wixapis.com/table-reservations/reservations/v1/reservations?fieldsets=FULL&cursorPaging.limit=1&sort.fieldName=createdDate&sort.order=DESC' \\\n -H 'Authorization: '","response":"{\n \"reservations\": [\n {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": \"6c85916ce13a00fb7b50cce6bebef2073124c082.Eg4qDAoKCgQkYW5kEgIyABotCgxfY3JlYXRlZERhdGUQARobKhkKFwoKJHRpbWVzdGFtcBIJEQCwjdxwdXhCIiQwOWI5ZWQ3NC1jZTkyLTQxMDItODJkZC0yNGMxYzQ5NDFjM2M\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"List Reservations","slugifiedName":"list-reservations"},"permissionScopes":[{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Create Reservation","description":"Creates a new reservation.\n\n`Create Reservation` accepts and requires different fields depending on the `status` and `source` provided, and the permissions of the user calling the endpoint.\n\n### Status and source\n\nIf a `status` is not provided, it will be set to:\n* `RESERVED` if manual approval is not required for confirmation\n* `REQUESTED` if manual approval is required for confirmation.\n\nA reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.\nAttempting to create a reservation without these fields results in an error.\n\n### Permissions\n\nThe fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, and `ignoreTableCombinationConflicts` should only be included in the request if the call is made by a user with the `MANAGE RESERVATIONS (FULL)` permission scope.\nIncluding these fields in the request without the required permissions results in an application error.\n\nIf `source` is not provided, its value is set depending on the permissions of the user making the call.\nIf the user has the `MANAGE RESERVATIONS (FULL)` permission scope the `source` is set to `UNDEFINED`. Otherwise, the `source` is set to `ONLINE`.\n\n>**Note:** `Create Reservation` requires all details of the reservation upfront. The process of creating a reservation can be broken up using [`Create Held Reservation`](#create-held-reservation). `Create Held Reservation` creates a temporary reservation that expires automatically unless it is completed with the addition of more details using [`Reserve Reservation`](#reserve-reservation).","operationId":"wix.table_reservations.reservation.v1.ReservationsService.CreateReservation","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.CreateReservationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateReservationRequest","description":"","properties":{"reservation":{"description":"Reservation details.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ignoreTableCombinationConflicts":{"description":"Ignore table combination conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n\nPossible values:\n* `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n* `\"TOO_BIG\"`: The party is too big for the selected table.\n* `\"TOO_SMALL\"`: The party is too small for the selected table.\n* `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.","maxItems":10,"title":"ignoreTableCombinationConflicts","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.TableCombinationConflict.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ignoreReservationLocationConflicts":{"description":"Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n\nPossible values:\n* `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n* `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.","maxItems":10,"title":"ignoreReservationLocationConflicts","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.ReservationLocationConflict.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["reservation","reservation.details","reservation.details.reservationLocationId","reservation.details.startDate","reservation.details.partySize"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Reservation Created","description":"Triggered when a reservation is created.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_created","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TIME_NOT_AVAILABLE","errorSchemaName":"wix.table_reservations.reservation.v1.ReservationDetailsConflicts"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_CREATE","TABLE_RESERVATIONS.RESERVATION_CREATE_FORCE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.CreateReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.CreateReservationResponse"},"legacyExamples":[{"name":"CreateReservation","type":"METHOD","content":{"title":"Create a reservation","request":"curl -X POST 'https://www.wixapis.com/table-reservations/reservations/v1/reservations' \\\n -H 'Authorization: '\n --data-binary '{\n \"reservation\": {\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false\n },\n \"status\": \"RESERVED\"\n }\n }'","response":"{\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"post","path":"/v1/reservations","rpcOnly":false,"triggeredEvents":[{"title":"Reservation Created","description":"Triggered when a reservation is created.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_created","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TIME_NOT_AVAILABLE","errorSchemaName":"wix.table_reservations.reservation.v1.ReservationDetailsConflicts"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_CREATE","TABLE_RESERVATIONS.RESERVATION_CREATE_FORCE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.CreateReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.CreateReservationResponse"},"legacyExamples":[{"name":"CreateReservation","type":"METHOD","content":{"title":"Create a reservation","request":"curl -X POST 'https://www.wixapis.com/table-reservations/reservations/v1/reservations' \\\n -H 'Authorization: '\n --data-binary '{\n \"reservation\": {\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false\n },\n \"status\": \"RESERVED\"\n }\n }'","response":"{\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Create Reservation","slugifiedName":"create-reservation"},"permissionScopes":[{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"summary":"Get Reservation","description":"Retrieves a reservation.\n\nThe `FULL` fieldset can only be retrieved by users with the `MANAGE RESERVATIONS (MEDIUM)` or `MANAGE RESERVATIONS (FULL)` permission scopes.","operationId":"wix.table_reservations.reservation.v1.ReservationsService.GetReservation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"reservationId","description":"Reservation ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fieldsets","in":"query","description":"Array of named, predefined sets of projected fields to be returned.\n\n- `PUBLIC`: Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`.\n`configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n- `FULL`: Returns all fields.\n\nDefault: If `fields` is omitted from the request, `PUBLIC`.","required":false,"schema":{"description":"Array of named, predefined sets of projected fields to be returned.\n\n- `PUBLIC`: Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`.\n`configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n- `FULL`: Returns all fields.\n\nDefault: If `fields` is omitted from the request, `PUBLIC`.","maxItems":1,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.FieldSet.Set"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.GetReservationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_READ","TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.GetReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.GetReservationResponse"},"legacyExamples":[{"name":"GetReservation","type":"METHOD","content":{"title":"Get a reservation","request":"curl 'https://www.wixapis.com/table-reservations/reservations/v1/reservations/09b9ed74-ce92-4102-82dd-24c1c4941c3c?fieldsets=FULL'\n -H 'Authorization: '","response":"{\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"get","path":"/v1/reservations/{reservationId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_READ","TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.GetReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.GetReservationResponse"},"legacyExamples":[{"name":"GetReservation","type":"METHOD","content":{"title":"Get a reservation","request":"curl 'https://www.wixapis.com/table-reservations/reservations/v1/reservations/09b9ed74-ce92-4102-82dd-24c1c4941c3c?fieldsets=FULL'\n -H 'Authorization: '","response":"{\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Get Reservation","slugifiedName":"get-reservation"},"permissionScopes":[{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"summary":"Delete Reservation","description":"Deletes a reservation. Only reservations with the `HELD` status can be deleted.","operationId":"wix.table_reservations.reservation.v1.ReservationsService.DeleteReservation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"reservationId","description":"Reservation ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.DeleteReservationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_DELETE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.DeleteReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.DeleteReservationResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"delete","path":"/v1/reservations/{reservationId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_DELETE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.DeleteReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.DeleteReservationResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Delete Reservation","slugifiedName":"delete-reservation"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"summary":"Update Reservation","description":"Updates a reservation.\n\nThe fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, and `ignoreTableCombinationConflicts` should only be included in the request if the call is made by a user with the `MANAGE RESERVATIONS (FULL)` permission scope.\nIncluding these fields in the request without the required permissions results in an application error.\n\nEach time the reservation is updated, revision increments by 1. The existing revision must be included when updating the reservation. This ensures you're working with the latest reservation information, and it prevents unintended overwrites.","operationId":"wix.table_reservations.reservation.v1.ReservationsService.UpdateReservation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"reservation.id","description":"Reservation ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.UpdateReservationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateReservationRequest","description":"","properties":{"reservation":{"description":"Reservation information to update.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ignoreTableCombinationConflicts":{"description":"Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n\nPossible values:\n* `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n* `\"TOO_BIG\"`: The party is too big for the selected table.\n* `\"TOO_SMALL\"`: The party is too small for the selected table.\n* `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.","maxItems":10,"title":"ignoreTableCombinationConflicts","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.TableCombinationConflict.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ignoreReservationLocationConflicts":{"description":"Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n\nPossible values:\n* `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n* `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.","maxItems":10,"title":"ignoreReservationLocationConflicts","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.ReservationLocationConflict.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["reservation","reservation.id","reservation.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Reservation Updated","description":"Triggered when a reservation is updated.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_updated","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TIME_NOT_AVAILABLE","errorSchemaName":"wix.table_reservations.reservation.v1.ReservationDetailsConflicts"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_UPDATE","TABLE_RESERVATIONS.RESERVATION_UPDATE_FORCE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.UpdateReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.UpdateReservationResponse"},"legacyExamples":[{"name":"UpdateReservation","type":"METHOD","content":{"title":"Update a reservation","request":"curl -X PATCH 'https://www.wixapis.com/table-reservations\\\n /reservations/v1/reservations/52b1af0a-12e5-4835-a453-7992ab86339c' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"reservation\": {\n \"details\": {\n \"partySize\": 3\n },\n \"reservee\": {\n \"firstName\": \"Pedro\",\n \"email\": \"pedro.doe@mail.com\"\n },\n \"revision\": \"1\"\n }\n }'","response":"{\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 3\n },\n \"reservee\": {\n \"firstName\": \"Pedro\",\n \"lastName\": \"Doe\",\n \"email\": \"pedro.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T15:07:21.577Z\",\n \"revision\": \"2\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"patch","path":"/v1/reservations/{reservation.id}","rpcOnly":false,"triggeredEvents":[{"title":"Reservation Updated","description":"Triggered when a reservation is updated.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_updated","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TIME_NOT_AVAILABLE","errorSchemaName":"wix.table_reservations.reservation.v1.ReservationDetailsConflicts"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_UPDATE","TABLE_RESERVATIONS.RESERVATION_UPDATE_FORCE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.UpdateReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.UpdateReservationResponse"},"legacyExamples":[{"name":"UpdateReservation","type":"METHOD","content":{"title":"Update a reservation","request":"curl -X PATCH 'https://www.wixapis.com/table-reservations\\\n /reservations/v1/reservations/52b1af0a-12e5-4835-a453-7992ab86339c' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"reservation\": {\n \"details\": {\n \"partySize\": 3\n },\n \"reservee\": {\n \"firstName\": \"Pedro\",\n \"email\": \"pedro.doe@mail.com\"\n },\n \"revision\": \"1\"\n }\n }'","response":"{\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 3\n },\n \"reservee\": {\n \"firstName\": \"Pedro\",\n \"lastName\": \"Doe\",\n \"email\": \"pedro.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T15:07:21.577Z\",\n \"revision\": \"2\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Update Reservation","slugifiedName":"update-reservation"},"permissionScopes":[{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Create Held Reservation","description":"Creates a new temporary reservation and holds it for the customer for 10 minutes.\n\nCreates a new reservation with the `HELD` status. `HELD` reservations are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the `HELD` status are only valid for 10 minutes. Trying to change a `HELD` reservation’s status after 10 minutes returns an error.\n\nYou cannot call [`Update Reservation`](#update-reservation) to change a reservation’s status from `HELD`. Trying to do so returns an error. Instead, you should use [`Reserve Reservation`](#reserve-reservation).\n\nIf you do not wish to have `HELD` reservations in your flow, you can create a reservation with all required details using [`Create Reservation`](#create-reservation).","operationId":"wix.table_reservations.reservation.v1.ReservationsService.CreateHeldReservation","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.CreateHeldReservationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateHeldReservationRequest","description":"","properties":{"reservationDetails":{"description":"Held reservation information to update.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.HeldReservationDetails","summary":"reservationDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["reservationDetails","reservationDetails.reservationLocationId","reservationDetails.startDate","reservationDetails.partySize"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Reservation Created","description":"Triggered when a held reservation is created.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_created","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MUST_BE_PREMIUM"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_CREATE_HELD"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.CreateHeldReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.CreateHeldReservationResponse"},"legacyExamples":[{"name":"CreateHeldReservation","type":"METHOD","content":{"title":"Create a held reservation","request":"curl -X POST 'https://www.wixapis.com/table-reservations/reservations/v1/reservations/hold' \\\n -H 'Authorization: '\n --data-binary '{\n \"reservationDetails\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"startDate\": \"2023-05-26T12:30:00Z\",\n \"partySize\": 2\n }\n }'","response":"{\n \"reservation\": {\n \"id\": \"af878917-e3ab-42e1-9587-e8ee217418af\",\n \"status\": \"HELD\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [],\n \"startDate\": \"2023-05-26T12:30:00Z\",\n \"endDate\": \"2023-05-26T14:00:00Z\",\n \"partySize\": 2\n },\n \"createdDate\": \"2023-04-06T14:43:31.926Z\",\n \"updatedDate\": \"2023-04-06T14:43:31.926Z\",\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"post","path":"/v1/reservations/hold","rpcOnly":false,"triggeredEvents":[{"title":"Reservation Created","description":"Triggered when a held reservation is created.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_created","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MUST_BE_PREMIUM"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_CREATE_HELD"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.CreateHeldReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.CreateHeldReservationResponse"},"legacyExamples":[{"name":"CreateHeldReservation","type":"METHOD","content":{"title":"Create a held reservation","request":"curl -X POST 'https://www.wixapis.com/table-reservations/reservations/v1/reservations/hold' \\\n -H 'Authorization: '\n --data-binary '{\n \"reservationDetails\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"startDate\": \"2023-05-26T12:30:00Z\",\n \"partySize\": 2\n }\n }'","response":"{\n \"reservation\": {\n \"id\": \"af878917-e3ab-42e1-9587-e8ee217418af\",\n \"status\": \"HELD\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [],\n \"startDate\": \"2023-05-26T12:30:00Z\",\n \"endDate\": \"2023-05-26T14:00:00Z\",\n \"partySize\": 2\n },\n \"createdDate\": \"2023-04-06T14:43:31.926Z\",\n \"updatedDate\": \"2023-04-06T14:43:31.926Z\",\n \"revision\": \"1\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Create Held Reservation","slugifiedName":"create-held-reservation"},"permissionScopes":[{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"summary":"Reserve Reservation","description":"Reserves or requests a held reservation.\n\nHeld reservations are temporary reservations with the `HELD` status created by the [`Create Held Reservation`](#create-held-reservation) endpoint.\nThey are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the `HELD` status are only valid for 10 minutes. Trying to call `Reserve Reservation` with a held reservation older than 10 minutes returns an error.\n\n`Reserve Reservation` changes a reservation's `HELD` status to:\n* `RESERVED` if the reservation's reservation location does not require manual approval.\n* `REQUESTED` if the reservation's reservation location requires manual approval.","operationId":"wix.table_reservations.reservation.v1.ReservationsService.ReserveReservation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"reservationId","description":"Reservation ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.ReserveReservationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ReserveReservationRequest","description":"","properties":{"reservee":{"description":"Reservee details.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.Reservee","summary":"reservee","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number.\n\nInclude the existing `revision` to prevent conflicting updates to reservations.","title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["reservationId","reservee","reservee.firstName","reservee.phone","revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Reservation Updated","description":"Triggered when a reservation is reserved.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_updated","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MUST_BE_PREMIUM"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CAN_NOT_BE_UPDATED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_RESERVE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.ReserveReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.ReserveReservationResponse"},"legacyExamples":[{"name":"ReserveReservation","type":"METHOD","content":{"title":"Reserve a reservation","request":"curl -X POST 'https://www.wixapis.com/table-reservations/reservations/v1\\\n /reservations/52b1af0a-12e5-4835-a453-7992ab86339c/reserve' \\\n -H 'Authorization: '\n --data-binary '{\n \"revision\": \"1\",\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+380661234567\"\n }\n }'","response":"{\n \"reservation\": {\n \"id\": \"af878917-e3ab-42e1-9587-e8ee217418af\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [],\n \"startDate\": \"2023-05-26T12:30:00Z\",\n \"endDate\": \"2023-05-26T14:00:00Z\",\n \"partySize\": 2\n },\n \"createdDate\": \"2023-04-06T14:43:31.926Z\",\n \"revision\": \"2\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"post","path":"/v1/reservations/{reservationId}/reserve","rpcOnly":false,"triggeredEvents":[{"title":"Reservation Updated","description":"Triggered when a reservation is reserved.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_updated","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MUST_BE_PREMIUM"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CAN_NOT_BE_UPDATED"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_RESERVE"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.ReserveReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.ReserveReservationResponse"},"legacyExamples":[{"name":"ReserveReservation","type":"METHOD","content":{"title":"Reserve a reservation","request":"curl -X POST 'https://www.wixapis.com/table-reservations/reservations/v1\\\n /reservations/52b1af0a-12e5-4835-a453-7992ab86339c/reserve' \\\n -H 'Authorization: '\n --data-binary '{\n \"revision\": \"1\",\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+380661234567\"\n }\n }'","response":"{\n \"reservation\": {\n \"id\": \"af878917-e3ab-42e1-9587-e8ee217418af\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [],\n \"startDate\": \"2023-05-26T12:30:00Z\",\n \"endDate\": \"2023-05-26T14:00:00Z\",\n \"partySize\": 2\n },\n \"createdDate\": \"2023-04-06T14:43:31.926Z\",\n \"revision\": \"2\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Reserve Reservation","slugifiedName":"reserve-reservation"},"permissionScopes":[{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"summary":"Cancel Reservation","description":"Cancels a reservation.\n\nSets the reservation status to `CANCELED`.","operationId":"wix.table_reservations.reservation.v1.ReservationsService.CancelReservation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"reservationId","description":"Reservation ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.CancelReservationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CancelReservationRequest","description":"","properties":{"revision":{"description":"Revision number.\n\nInclude the existing `revision` to prevent conflicting updates to reservations.","title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"The phone number that was provided when the reservation was created.\n\nThis is required for reservations with any `source` other than `WALK_IN`.\n\nThis requirement provides additional security by ensuring that the canceling party knows both the reservation's `reservationId` and the reservee's `phone`.","format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["reservationId","revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Reservation Updated","description":"Triggered when a reservation is canceled.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_updated","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PHONE_NUMBER_REQUIRED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PHONE_NUMBER_INCORRECT"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_CANCEL"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.CancelReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.CancelReservationResponse"},"legacyExamples":[{"name":"CancelReservation","type":"METHOD","content":{"title":"Cancel a reservation","request":"curl -X POST 'https://www.wixapis.com/table-reservations/reservations/v1\\\n /reservations/0310d65b-7af2-4f06-b139-38c01255d2ae/cancel' \\\n -H 'Authorization: '\n --data-binary '{ \"revision\": \"2\", \"phone\": \"+380661234567\" }'","response":"{\n \"reservation\": {\n \"id\": \"af878917-e3ab-42e1-9587-e8ee217418af\",\n \"status\": \"CANCELED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [],\n \"startDate\": \"2023-05-26T12:30:00Z\",\n \"endDate\": \"2023-05-26T14:00:00Z\",\n \"partySize\": 2\n },\n \"createdDate\": \"2023-04-06T14:43:31.926Z\",\n \"revision\": \"3\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"post","path":"/v1/reservations/{reservationId}/cancel","rpcOnly":false,"triggeredEvents":[{"title":"Reservation Updated","description":"Triggered when a reservation is canceled.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.table_reservations.v1.reservation_updated","sourceRepo":"git@github.com:wix-private/table-reservations-server.git"}],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PHONE_NUMBER_REQUIRED"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PHONE_NUMBER_INCORRECT"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_CANCEL"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.CancelReservationRequest","responseMessage":"wix.table_reservations.reservation.v1.CancelReservationResponse"},"legacyExamples":[{"name":"CancelReservation","type":"METHOD","content":{"title":"Cancel a reservation","request":"curl -X POST 'https://www.wixapis.com/table-reservations/reservations/v1\\\n /reservations/0310d65b-7af2-4f06-b139-38c01255d2ae/cancel' \\\n -H 'Authorization: '\n --data-binary '{ \"revision\": \"2\", \"phone\": \"+380661234567\" }'","response":"{\n \"reservation\": {\n \"id\": \"af878917-e3ab-42e1-9587-e8ee217418af\",\n \"status\": \"CANCELED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [],\n \"startDate\": \"2023-05-26T12:30:00Z\",\n \"endDate\": \"2023-05-26T14:00:00Z\",\n \"partySize\": 2\n },\n \"createdDate\": \"2023-04-06T14:43:31.926Z\",\n \"revision\": \"3\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Cancel Reservation","slugifiedName":"cancel-reservation"},"permissionScopes":[{"name":"Manage Reservations (Basic)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"summary":"Query Reservations","description":"Retrieves a list of reservations given the provided paging, filtering, and sorting. Up to 100 reservations can be returned per request.\n\nFor a detailed list of supported operations, see the [Sorting, Filtering, and Search](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.\nTo learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","operationId":"wix.table_reservations.reservation.v1.ReservationsService.QueryReservations","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.QueryReservationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryReservationsRequest","description":"","properties":{"query":{"description":"Query to select reservations.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.QueryReservationsRequest","responseMessage":"wix.table_reservations.reservation.v1.QueryReservationsResponse"},"legacyExamples":[{"name":"QueryReservations","type":"METHOD","content":{"title":"Query reservations","request":"curl 'https://www.wixapis.com/table-reservations/reservations/v1/reservations/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ],\n \"cursorPaging\": {\n \"limit\": 1\n }\n }\n }'","response":"{\n \"reservations\": [\n {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": \"5cad31e33ba0753b2597d260476a320da9c5c815.Gi0KDF9jcmVhdGVkRGF0ZRABGhsqGQoXCgokdGltZXN0YW1wEgkRALCN3HB1eEIiJDA5YjllZDc0LWNlOTItNDEwMi04MmRkLTI0YzFjNDk0MWMzYw\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"post","path":"/v1/reservations/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.QueryReservationsRequest","responseMessage":"wix.table_reservations.reservation.v1.QueryReservationsResponse"},"legacyExamples":[{"name":"QueryReservations","type":"METHOD","content":{"title":"Query reservations","request":"curl 'https://www.wixapis.com/table-reservations/reservations/v1/reservations/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"DESC\"\n }\n ],\n \"cursorPaging\": {\n \"limit\": 1\n }\n }\n }'","response":"{\n \"reservations\": [\n {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": \"5cad31e33ba0753b2597d260476a320da9c5c815.Gi0KDF9jcmVhdGVkRGF0ZRABGhsqGQoXCgokdGltZXN0YW1wEgkRALCN3HB1eEIiJDA5YjllZDc0LWNlOTItNDEwMi04MmRkLTI0YzFjNDk0MWMzYw\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Query Reservations","slugifiedName":"query-reservations"},"permissionScopes":[{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Search Reservations","description":"Use this endpoint to search the fields of the table reservations on a site for a given expression.\n\nYou can also use this endpoint to perform data aggregations on a site's table reservation fields.\nFor a detailed list of supported operations, see the [Sorting, Filtering, and Search](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.","operationId":"wix.table_reservations.reservation.v1.ReservationsService.SearchReservations","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.SearchReservationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/table-reservations/reservations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/table-reservations/reservations","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SearchReservationsRequest","description":"","properties":{"search":{"description":"Search query.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["search"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.SearchReservationsRequest","responseMessage":"wix.table_reservations.reservation.v1.SearchReservationsResponse"},"legacyExamples":[{"name":"SearchReservations","type":"METHOD","content":{"title":"Search reservations","request":"curl 'https://www.wixapis.com/table-reservations/reservations/v1/reservations/search' \\\n -H 'Authorization: '\n --data-binary '{\n \"search\": {\n \"sort\": [],\n \"filter\": [],\n \"search\": {\n \"expression\": \"John\"\n },\n \"cursorPaging\": {\n \"limit\": 1\n }\n }\n }'","response":"{\n \"reservations\": [\n {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": \"5cad31e33ba0753b2597d260476a320da9c5c815.Gi0KDF9jcmVhdGVkRGF0ZRABGhsqGQoXCgokdGltZXN0YW1wEgkRALCN3HB1eEIiJDA5YjllZDc0LWNlOTItNDEwMi04MmRkLTI0YzFjNDk0MWMzYw\",\n \"prev\": \"null\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git"},"httpMethod":"post","path":"/v1/reservations/search","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.table_reservations.reservation.v1.ReservationsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"protoArtifactId":"com.wixpress.table-reservations:reservations","serviceArtifactId":"com.wixpress.table-reservations.reservations","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.table_reservations.reservation.v1.SearchReservationsRequest","responseMessage":"wix.table_reservations.reservation.v1.SearchReservationsResponse"},"legacyExamples":[{"name":"SearchReservations","type":"METHOD","content":{"title":"Search reservations","request":"curl 'https://www.wixapis.com/table-reservations/reservations/v1/reservations/search' \\\n -H 'Authorization: '\n --data-binary '{\n \"search\": {\n \"sort\": [],\n \"filter\": [],\n \"search\": {\n \"expression\": \"John\"\n },\n \"cursorPaging\": {\n \"limit\": 1\n }\n }\n }'","response":"{\n \"reservations\": [\n {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\n \"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"\n ],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": {\n \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\"\n },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": \"5cad31e33ba0753b2597d260476a320da9c5c815.Gi0KDF9jcmVhdGVkRGF0ZRABGhsqGQoXCgokdGltZXN0YW1wEgkRALCN3HB1eEIiJDA5YjllZDc0LWNlOTItNDEwMi04MmRkLTI0YzFjNDk0MWMzYw\",\n \"prev\": \"null\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","contentLink":{"displayName":"Search Reservations","slugifiedName":"search-reservations"},"permissionScopes":[{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true}],"webhooks":[{"summary":"Reservation Delayed","title":"Reservation Delayed","description":"","permissions":[],"payload":{"schemaName":"wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"delayed","eventTopic":"table-reservations-reservation-delayed","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[],"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent","contentLink":{"displayName":"Reservation Delayed","slugifiedName":"reservation-delayed"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Reservation Created","title":"Reservation Created","description":"Triggered when a held reservation is created.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"eventType":"wix.table_reservations.v1.reservation_created","legacyExamples":[{"name":"ReservationCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"slug\": \"created\",\n \"id\": \"1d034196-3347-4a66-988a-3f30d7e51b9d\",\n \"createdEvent\": {\n \"entity\": {\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": { \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\" },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T14:52:13.915Z\",\n \"revision\": \"1\"\n }\n }\n },\n \"entityFqdn\": \"wix.table_reservations.v1.reservation\",\n \"eventTime\": \"2023-04-06T14:52:13.915Z\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","contentLink":{"displayName":"Reservation Created","slugifiedName":"reservation-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Reservation Updated","title":"Reservation Updated","description":"Triggered when a reservation is canceled.","permissions":["TABLE_RESERVATIONS.RESERVATION_READ_FULL"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.table_reservations.v1.reservation","serviceName":"wix.table_reservations.reservation.v1.ReservationsService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"eventType":"wix.table_reservations.v1.reservation_updated","legacyExamples":[{"name":"ReservationUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"slug\": \"updated\",\n \"id\": \"1d034196-3347-4a66-988a-3f30d7e51b9d\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"reservation\": {\n \"id\": \"09b9ed74-ce92-4102-82dd-24c1c4941c3c\",\n \"status\": \"RESERVED\",\n \"details\": {\n \"reservationLocationId\": \"28bca9ee-e5b9-4081-9f45-a6dded8593a1\",\n \"tableIds\": [\"c215fb2a-0eb9-43d9-b7a7-8957e24c66e7\"],\n \"startDate\": \"2023-07-22T12:30:00Z\",\n \"endDate\": \"2023-07-22T14:00:00Z\",\n \"partySize\": 2\n },\n \"reservee\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@mail.com\",\n \"phone\": \"+38055325555\",\n \"marketingConsent\": false,\n \"contactId\": \"91c03323-c8bb-41e1-967c-bbf182e99be4\"\n },\n \"reservedBy\": { \"contactId\": \"0274f02a-2170-452f-bfe8-452aacc70d0a\" },\n \"createdDate\": \"2023-04-06T14:52:13.915Z\",\n \"updatedDate\": \"2023-04-06T15:50:10.115Z\",\n \"revision\": \"2\"\n }\n }\n },\n \"entityFqdn\": \"wix.table_reservations.v1.reservation\",\n \"eventTime\": \"2023-04-06T15:50:10.115Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/table-reservations-server.git","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","contentLink":{"displayName":"Reservation Updated","slugifiedName":"reservation-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Reservations (Full)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL"},{"name":"Manage Reservations (Medium)","scopeId":"SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Reservations API allows you to create and manage reservations at restaurants. \n\nThis API provides all the necessary functionality to move a reservation through the phases of its [lifecycle](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::the-reservation-lifecycle*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/the-reservation-lifecycle), such as from the reservation request until completion.\n\nThe Reservations API works together with the [Reservation Locations API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::d9b7ee6a-87cb-4d9a-bfed-9848389d81dfslug::introduction*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservation-locations/introduction), which provides information about the physical location of a restaurant, as well as that restaurant’s availability and reservation conditions. \n\nThe Reservations API also works together with the [Time Slots API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::69e46f13-77ec-4140-8ed5-87fa0b5b2eeaslug::introduction*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/time-slots/introduction), which allows you to retrieve availability information about time slots at a restaurant on a specific date and for a specific party size. \n\nWith the Reservations API, you can:\n* Create and manage reservations at a restaurant.\n* Get information about existing reservations at a restaurant.\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n* The site owner must install the Wix Table Reservations app.\n* The site owner must have at least 1 location configured in their Dashboard under [Business Info](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fbusiness-info).\n\n\n## Use Cases\n[Reservation app for restaurants on a Wix site](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::03b65e54-6b8e-47eb-a5f9-72edc580978b#reservation-app-for-restaurants-on-a-wix-site*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/sample-flows#reservation-app-for-restaurants-on-a-wix-site)\n\n## Terminology\nFor a comprehensive glossary of Reservations terms, see [Terminology](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f6bd7c6a-43de-4e5d-a2ad-7db0036151c9*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/terminology).\n"},{"displayName":"Sorting, Filtering, and Search","slugifyName":"sorting-filtering-and-search","content":"# Reservations: Supported Filters, Sorting, and Search\n\nThis article covers field support for filtering, sorting, and searching in the Reservations API.\n\n\n## Query Reservations\n\nThe following table shows field support for filters and sorting\nfor the reservation object when using Query Reservations:\n\n| Field | Supported Filters | Sortable |\n| ----------------------------------- | ---------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$in` | |\n| `status` | `$eq`, `$ne`, `$in` | |\n| `details.startDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Reservations](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::query-reservations*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/query-reservations)\n\n## Search Reservations\n\nThe following table shows field support for filters and sorting\nfor the reservation object when using Search Reservations:\n\n| Field | Supported Filters | Sortable |\n| ----------------------------------- | ---------------------------------------------- | -------- |\n| `source` | `$eq`, `$ne`, `$in` | |\n| `status` | `$eq`, `$ne`, `$in` | |\n| `details.reservationLocationId` | `$eq`, `$ne`, `$in` | |\n| `reservee.contactId` | `$eq`, `$ne`, `$in` | |\n| `details.tableIds` | `$eq`, `$has_all`, `$has_some`, `$empty` | |\n| `details.startDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `details.partySize` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n\n\nThe following fields in the reservation object are searchable:\n- `reservee.firstName`\n- `reservee.lastName`\n- `reservee.phone`\n- `reservee.email`\n\n__Related content:__\n[Search Reservations](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::search-reservations*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/search-reservations)\n"},{"displayName":"The Reservation Lifecycle","slugifyName":"the-reservation-lifecycle","content":"# The Reservation Lifecycle\n\nReservations progress from creation to completion through a series of phases. Each phase is represented by a status, which is stored as an enum in the `status` field of a `reservation` object. \n\nThis article explains the available statuses, and how a reservation can progress using the Reservations API.\n\nNote:\nReservations can also be created and progress through phases as a result of actions on a Wix site or dashboard. For more information see the Wix Restaurants [Table Reservations articles](fallback::https://support.wix.com/en/table-reservations).\n\n## Statuses\nThe following statuses are listed roughly in order of their position in the reservation lifecycle.\n* `HELD` - The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n* `REQUESTED` - A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n* `DECLINED` - The restaurant’s owner or staff declined the customer’s request to make the reservation.\n* `RESERVED` - The reservation is confirmed.\n* `SEATED` - The customer is currently occupying the table.\n* `CANCELED` - The reservation is canceled.\n* `NO_SHOW` - The customer didn't show up for their reservation.\n* `FINISHED` - The reservation completed successfully.\n* `PAYMENT_PENDING` - The reservation is temporary and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reservation is in HELD status and reserve reservation endpoint is called and payment is needed. After payment is completed status will be changed automatically to RESERVED.\n\n\n## Managing the reservation lifecycle\nThis section explains how reservations can be created and progressed through their lifecycle.\n\n### Create a reservation\nThis API provides 2 endpoints for creating reservations.\n\n[`Create Held Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::create-held-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/create-held-reservation) - This endpoint creates a reservation with the `HELD` status. Reservations with the `HELD` status are only valid for 10 minutes. Trying to change a `HELD` reservation’s status after 10 minutes returns an error. \n\nThe Reservations pages created by the Table Reservations app on Wix sites use this endpoint to temporarily reserve time slots selected by customers while they enter further details.\n\nAfter a customer completes the reservation process, call [`Reserve Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::reserve-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/reserve-reservation) to change the reservation’s status to `RESERVED` or `REQUESTED`, depending on whether the site requires manual approval for online reservations.\n\nYou cannot call [`Update Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::update-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/update-reservation) to change a reservation’s status from `HELD`. Trying to do so returns an error.\n\n[`Create Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::create-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/create-reservation) - This endpoint creates a reservation with either the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation (see manual approval below).\n\nWith the `MANAGE RESERVATIONS (FULL)` permission scope, you can set more properties of the reservation in the `Create Reservation` request. This allows you to create the reservation with a status of your choice and gives you the option to override the restaurant’s rules regarding online availability and table management. \n\n### Requiring manual approval\nTo require manual approval for `REQUESTED` reservations at a location before they’re confirmed (`RESERVED`), set `configuration.onlineReservations.manualApproval.enabled` to `true` for that reservation location. Manual approval can also be set through a site’s [Table Reservations app](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Frestaurants/table-reservations) in the dashboard.\n\nIf manual approval is enabled for online reservations at a reservation location, reservations made using the [`Reserve Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::reserve-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/reserve-reservation) endpoint or through the restaurant’s dashboard are automatically created with the `REQUESTED` status. This setting does not affect offline reservations.\n\n### Reserving or declining reservations\nTo use the Reservations API to approve or decline a reservation, call [`Update Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::update-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/update-reservation) and change the reservation’s status to `RESERVED` or `DECLINED` respectively.\n\n### Seating customers\n\nOnce customers have been seated (or the equivalent if your restaurant doesn’t have seats), change the status of the reservation to `SEATED` using [`Update Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::update-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/update-reservation).\n\n### Ending a Reservation\n\nA reservation can end as `DECLINED`, `CANCELED`, `NO_SHOW`, or `FINISHED`.\nIn each case, change the status using [`Update Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::update-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/update-reservation). Once any of the above statuses are set, the reservation is considered complete.\n\n## Lifecycle flow examples\n\nThe following are examples of possible paths a reservation could take from creation to completion:\n\n**Finished**\n\nA customer selects a time slot for a reservation on the restaurant’s website. They proceed to enter their details and confirm their reservation request. The restaurant owner approves the reservation. The customer arrives and is seated. They finish their meal, pay, and leave. \n\nThis flow would be represented by:\n`HELD` > `REQUESTED` > `RESERVED` > `SEATED` > `FINISHED`\n\n**Cancelation**\n\nA customer calls the restaurant and makes a reservation, but their car breaks down and they call again to cancel.\n\nThis flow would be represented by:\n`RESERVED` > `CANCELED`\n\n**No Show**\n\nA customer makes a reservation using the restaurant’s app. The restaurant owner approves the reservation, but the customer never shows up.\n\nThis flow would be represented by:\n`REQUESTED` > `RESERVED` > `NO_SHOW`\n\n"}],"components":{"schemas":{"wix.table_reservations.reservation.v1.Reservation":{"type":"object","properties":{"id":{"description":"Reservation ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Status of the reservation.\n\n* `HELD`: The reservation is temporary and will expire in 10 minutes unless the customer moves forward with the reservation flow. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n* `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n* `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n* `RESERVED`: The reservation is confirmed.\n* `SEATED`: The customer is currently occupying the table.\n* `CANCELED`: The reservation is canceled.\n* `NO_SHOW`: The customer didn't show up for their reservation.\n* `FINISHED`: The reservation completed successfully.\n* `PAYMENT_PENDING`: The reservation is temporary and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reservation is in HELD status and reserve reservation endpoint is called and payment is needed. After payment is completed status will be changed automatically to RESERVED.\n\nSee the [Reservation Lifecycle article](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/the-reservation-lifecycle) for an explanation of the role of statuses in the reservation lifecycle.","title":"status","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.StatusEnum.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"source":{"description":"Reservation source.\n\nThis indicates how the reservation was made.\n* `ONLINE` indicates that the customer made the reservation through a website or app.\n* `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.\n* `WALK-IN` indicates that the customer did not make a reservation beforehand, and the reservation was entered into the system by a restaurant employee when the customer arrived at the restaurant.","title":"source","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.SourceEnum.Source","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"details":{"description":"Reservation details.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.Details","summary":"details","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservee":{"description":"Information about the person the reservation is being made for.\n\nA reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.\nAttempting to create a reservation without these fields results in an error.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.Reservee","summary":"reservee","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservedBy":{"description":"Information about the person making the reservation.\n\nThis field is required if the reservation's `status` is anything other than `WALK_IN`.","readOnly":true,"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.ReservedBy","summary":"reservedBy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"teamMessage":{"description":"Team message.\n\nA message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.","maxLength":10000,"title":"teamMessage","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the reservation was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the reservation was changed.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the reservation is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the reservation.\n\nIgnored when creating a reservation.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"declineReason":{"description":"The reason the reservation was declined.","maxLength":1000,"title":"declineReason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentStatus":{"description":"Payment status.","readOnly":true,"title":"paymentStatus","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.PaymentStatusEnum.PaymentStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Reservation","description":"The reservation domain object."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","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.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","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.table_reservations.reservation.v1.Reservation.StatusEnum.Status":{"type":"string","description":"","title":"Status","enum":["UNKNOWN","HELD","RESERVED","CANCELED","FINISHED","NO_SHOW","SEATED","REQUESTED","DECLINED","PAYMENT_PENDING"]},"wix.table_reservations.reservation.v1.Reservation.SourceEnum.Source":{"type":"string","description":"","title":"Source","enum":["UNKNOWN","OFFLINE","ONLINE","WALK_IN"]},"wix.table_reservations.reservation.v1.Reservation.Details":{"type":"object","properties":{"reservationLocationId":{"description":"ID of the reservation location at which this reservation will be made.","format":"GUID","title":"reservationLocationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tableIds":{"description":"IDs of tables used for this reservation.","format":"GUID","maxItems":100,"title":"tableIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startDate":{"description":"Start date and time of the reservation.","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endDate":{"description":"End date and time of the reservation.","title":"endDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"partySize":{"description":"Party size.","minimum":1,"maximum":1000,"title":"partySize","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Details","description":"Reservation details."},"wix.table_reservations.reservation.v1.Reservation.Reservee":{"type":"object","properties":{"firstName":{"description":"First name.\n\nThis field is required if the reservation's `status` is anything other than `WALK_IN`.","maxLength":1000,"title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastName":{"description":"Last name.","maxLength":1000,"title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Email address.","format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Phone number.\n\nThis property should begin with a +, followed by the country code, and then the rest of the phone number. For example, `\"+972555555555\"`.\n\nThis field is required if the reservation's `status` is anything other than `WALK_IN`.","format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"marketingConsent":{"description":"Whether the reservee has given marketing consent.","title":"marketingConsent","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customFields":{"description":"Custom fields for the reservee in key-value pairs.\n\nThe key is the custom field's ID, and the value is the custom field's value. For example, a custom field for allergies might have the key-value pair `f4283b2d-6340-4cf9-bae7-8769e6b62127 : \"Nuts, Seafood\"`.\n\nEmpty fields are not returned.","title":"customFields","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactId":{"description":"Contact ID. If a contact with this ID does not exist on the site, one will be created.","format":"GUID","readOnly":true,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Reservee","description":"The person the reservation is being made for."},"wix.table_reservations.reservation.v1.Reservation.ReservedBy":{"type":"object","properties":{"contactId":{"description":"Contact ID for the person who made the reservation. If a contact with this ID does not exist on the site, one will be created.","format":"GUID","readOnly":true,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservedBy","description":"A person making reservation."},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"wix.table_reservations.reservation.v1.Reservation.MigrationNote":{"type":"object","properties":{},"title":"MigrationNote","description":"Migration note."},"wix.table_reservations.reservation.v1.Reservation.TableWithReservationConflicts":{"type":"object","properties":{"tableId":{"description":"Table id.","format":"GUID","title":"tableId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservationIds":{"description":"List of reservation ids.","format":"GUID","maxItems":1000,"title":"reservationIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TableWithReservationConflicts","description":"Table with reservation conflicts."},"wix.table_reservations.reservation.v1.Reservation.PaymentStatusEnum.PaymentStatus":{"type":"string","description":"","title":"PaymentStatus","enum":["UNKNOWN","FREE","NOT_PAID","PAID","PARTIALLY_REFUNDED","FULLY_REFUNDED","PARTIALLY_PAID"]},"wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent":{"type":"object","properties":{},"title":"ReservationDelayedDomainEvent","description":"","oneOf":[{"description":"","summary":"bodyType","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent.bodyType"}]},"wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent.bodyType":{"type":"object","title":"bodyType","properties":{"reservationCreated":{"description":"Body of a created reservation event.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent.ReservationCreated","summary":"reservationCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservationUpdated":{"description":"Body of a updated reservation event.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent.ReservationUpdated","summary":"reservationUpdated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservationCanceled":{"description":"Body of a canceled reservation event.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent.ReservationCanceled","summary":"reservationCanceled","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent.ReservationCreated":{"type":"object","properties":{"createdReservation":{"description":"Created reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"createdReservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationCreated","description":""},"wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent.ReservationUpdated":{"type":"object","properties":{"updatedReservation":{"description":"Updated reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"updatedReservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"modifiedFields":{"description":"Modified fields of previous entity","title":"modifiedFields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationUpdated","description":""},"wix.table_reservations.reservation.v1.ReservationDelayedDomainEvent.ReservationCanceled":{"type":"object","properties":{"canceledReservation":{"description":"Canceled reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"canceledReservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationCanceled","description":""},"wix.table_reservations.reservation.v1.CreateReservationRequest":{"type":"object","properties":{"reservation":{"description":"Reservation details.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ignoreTableCombinationConflicts":{"description":"Ignore table combination conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n\nPossible values:\n* `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n* `\"TOO_BIG\"`: The party is too big for the selected table.\n* `\"TOO_SMALL\"`: The party is too small for the selected table.\n* `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.","maxItems":10,"title":"ignoreTableCombinationConflicts","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.TableCombinationConflict.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ignoreReservationLocationConflicts":{"description":"Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n\nPossible values:\n* `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n* `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.","maxItems":10,"title":"ignoreReservationLocationConflicts","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.ReservationLocationConflict.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateReservationRequest","description":""},"wix.table_reservations.time_slot.v1.TableCombinationConflict.Type":{"type":"string","description":"","title":"Type","enum":["UNKNOWN","RESERVED","TOO_BIG","TOO_SMALL","OFFLINE_ONLY"]},"wix.table_reservations.time_slot.v1.ReservationLocationConflict.Type":{"type":"string","description":"","title":"Type","enum":["UNKNOWN","PARTY_PACING","SEAT_PACING"]},"wix.table_reservations.reservation.v1.CreateReservationResponse":{"type":"object","properties":{"reservation":{"description":"Reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateReservationResponse","description":""},"wix.table_reservations.reservation.v1.ReservationDetailsConflicts":{"type":"object","properties":{"tableCombinationConflicts":{"description":"Table combinations conflicts.","maxItems":10,"title":"tableCombinationConflicts","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.TableCombinationConflict"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservationLocationConflicts":{"description":"Reservation location conflicts.","maxItems":10,"title":"reservationLocationConflicts","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.ReservationLocationConflict"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationDetailsConflicts","description":""},"wix.table_reservations.time_slot.v1.TableCombinationConflict":{"type":"object","properties":{"type":{"description":"Conflict type.","title":"type","type":"string","$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.TableCombinationConflict.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TableCombinationConflict","description":""},"wix.table_reservations.time_slot.v1.ReservationLocationConflict":{"type":"object","properties":{"type":{"description":"Reservation location conflict type.","title":"type","type":"string","$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.ReservationLocationConflict.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationLocationConflict","description":""},"wix.table_reservations.reservation.v1.GetReservationRequest":{"type":"object","properties":{"reservationId":{"description":"Reservation ID.","format":"GUID","title":"reservationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Array of named, predefined sets of projected fields to be returned.\n\n- `PUBLIC`: Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`.\n`configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n- `FULL`: Returns all fields.\n\nDefault: If `fields` is omitted from the request, `PUBLIC`.","maxItems":1,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.FieldSet.Set"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetReservationRequest","description":""},"wix.table_reservations.reservation.v1.FieldSet.Set":{"type":"string","description":"","title":"Set","enum":["PUBLIC","FULL"]},"wix.table_reservations.reservation.v1.GetReservationResponse":{"type":"object","properties":{"reservation":{"description":"Reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetReservationResponse","description":""},"wix.table_reservations.reservation.v1.UpdateReservationRequest":{"type":"object","properties":{"reservation":{"description":"Reservation information to update.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ignoreTableCombinationConflicts":{"description":"Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n\nPossible values:\n* `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n* `\"TOO_BIG\"`: The party is too big for the selected table.\n* `\"TOO_SMALL\"`: The party is too small for the selected table.\n* `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.","maxItems":10,"title":"ignoreTableCombinationConflicts","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.TableCombinationConflict.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ignoreReservationLocationConflicts":{"description":"Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n\nPossible values:\n* `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n* `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.","maxItems":10,"title":"ignoreReservationLocationConflicts","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.table_reservations.time_slot.v1.ReservationLocationConflict.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateReservationRequest","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.table_reservations.reservation.v1.UpdateReservationResponse":{"type":"object","properties":{"reservation":{"description":"Reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateReservationResponse","description":""},"wix.table_reservations.reservation.v1.ReservationDataUpdated":{"type":"object","properties":{"reservation":{"description":"Reserved reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldReservation":{"description":"Old reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"oldReservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationDataUpdated","description":""},"wix.table_reservations.reservation.v1.CreateHeldReservationRequest":{"type":"object","properties":{"reservationDetails":{"description":"Held reservation information to update.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.HeldReservationDetails","summary":"reservationDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateHeldReservationRequest","description":""},"wix.table_reservations.reservation.v1.HeldReservationDetails":{"type":"object","properties":{"reservationLocationId":{"description":"ID of the reservation location where the reservation is made.","format":"GUID","title":"reservationLocationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startDate":{"description":"Start date and time of the reservation.","title":"startDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"partySize":{"description":"Party size.","minimum":1,"maximum":1000,"title":"partySize","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HeldReservationDetails","description":"Reservation details when create reservation in status HELD."},"wix.table_reservations.reservation.v1.CreateHeldReservationResponse":{"type":"object","properties":{"reservation":{"description":"Reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateHeldReservationResponse","description":""},"wix.table_reservations.reservation.v1.ReserveReservationRequest":{"type":"object","properties":{"reservationId":{"description":"Reservation ID.","format":"GUID","title":"reservationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reservee":{"description":"Reservee details.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.Reservee","summary":"reservee","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number.\n\nInclude the existing `revision` to prevent conflicting updates to reservations.","title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReserveReservationRequest","description":""},"wix.table_reservations.reservation.v1.ReserveReservationResponse":{"type":"object","properties":{"reservation":{"description":"Reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReserveReservationResponse","description":""},"wix.table_reservations.reservation.v1.CancelReservationRequest":{"type":"object","properties":{"reservationId":{"description":"Reservation ID.","format":"GUID","title":"reservationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number.\n\nInclude the existing `revision` to prevent conflicting updates to reservations.","title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"The phone number that was provided when the reservation was created.\n\nThis is required for reservations with any `source` other than `WALK_IN`.\n\nThis requirement provides additional security by ensuring that the canceling party knows both the reservation's `reservationId` and the reservee's `phone`.","format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CancelReservationRequest","description":""},"wix.table_reservations.reservation.v1.CancelReservationResponse":{"type":"object","properties":{"reservation":{"description":"Reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CancelReservationResponse","description":""},"wix.table_reservations.reservation.v1.ReservationCanceled":{"type":"object","properties":{"reservation":{"description":"Reserved reservation.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReservationCanceled","description":""},"wix.table_reservations.reservation.v1.DeleteReservationRequest":{"type":"object","properties":{"reservationId":{"description":"Reservation ID.","format":"GUID","title":"reservationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteReservationRequest","description":""},"wix.table_reservations.reservation.v1.DeleteReservationResponse":{"type":"object","properties":{},"title":"DeleteReservationResponse","description":""},"wix.table_reservations.reservation.v1.ListReservationsRequest":{"type":"object","properties":{"paging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Defines how reservations in the response are sorted.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Sorting","summary":"sort","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startDateFrom":{"description":"Only reservations starting after this date are returned.","title":"startDateFrom","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startDateTo":{"description":"Only reservations starting before this date are returned.","title":"startDateTo","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Only reservations with this status are returned.\n\n* `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n* `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n* `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n* `RESERVED`: The reservation is confirmed.\n* `SEATED`: The customer is currently occupying the table.\n* `CANCELED`: The reservation is canceled.\n* `NO_SHOW`: The customer didn't show up for their reservation.\n* `FINISHED`: The reservation completed successfully.","title":"status","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation.StatusEnum.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListReservationsRequest","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.\n\nUse `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.","title":"order","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.table_reservations.reservation.v1.ListReservationsResponse":{"type":"object","properties":{"reservations":{"description":"List of reservations.","title":"reservations","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Metadata for the paginated results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListReservationsResponse","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Offset that was requested.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Indicates if there are more results after the current page.\nIf `true`, another page of results can be retrieved.\nIf `false`, this is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"wix.table_reservations.reservation.v1.QueryReservationsRequest":{"type":"object","properties":{"query":{"description":"Query to select reservations.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReservationsRequest","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\n\nFor a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.\nTo learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorQuery.pagingMethod"}]},"wix.table_reservations.reservation.v1.upstream.wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.table_reservations.reservation.v1.QueryReservationsResponse":{"type":"object","properties":{"reservations":{"description":"List of reservations.","title":"reservations","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Metadata for the paginated results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReservationsResponse","description":""},"wix.table_reservations.reservation.v1.SearchReservationsRequest":{"type":"object","properties":{"search":{"description":"Search query.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchReservationsRequest","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.CursorSearch":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nFor a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","maxItems":100,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregations":{"description":"A search method for grouping data into various categories (facets) and providing summaries for each category.\nFor example, use aggregations to allow site visitors to narrow down their search results by selecting specific reservation statuses, party sizes, etc.","maxItems":100,"title":"aggregations","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"Time zone to adjust date-time-based filters and aggregations. ISO 8601 or IANA time zone database format.","maxLength":100,"title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorSearch","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorSearch.pagingMethod"}]},"wix.table_reservations.reservation.v1.upstream.wix.common.CursorSearch.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor pointing to a page of results. Can't be used together with 'paging'. 'cursorPaging.cursor' can't be used together with 'filter' or 'sort'.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation":{"type":"object","properties":{"name":{"description":"","maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"","title":"type","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"","maxLength":1000,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Aggregation","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.kind"}]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.kind":{"type":"object","title":"kind","properties":{"value":{"description":"A value aggregation calculates metrics such as \"count\" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.\nFor example, to get the number of reservations by party size for each week, first perform a date histogram aggregation on `details.startDate` with the interval `WEEK`, and a second value aggregation on `details.partySize`.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.NestedAggregation","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.RangeAggregation.RangeBucket":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range. Required if `to` is not provided.","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range. Required if `from` is not provided.","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeBucket","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.SortType":{"type":"string","description":"","title":"SortType","enum":["COUNT","VALUE"]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.SortDirection":{"type":"string","description":"","title":"SortDirection","enum":["DESC","ASC"]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.MissingValues":{"type":"string","description":"","title":"MissingValues","enum":["EXCLUDE","INCLUDE"]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions":{"type":"object","properties":{"addToBucket":{"description":"Specify a custom name for the bucket containing the missing values. Defaults are \"N/A\" for strings, \"0\" for integers, and \"false\" for booleans.","maxLength":1000,"title":"addToBucket","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncludeMissingValuesOptions","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.ScalarType":{"type":"string","description":"","title":"ScalarType","enum":["UNKNOWN_SCALAR_TYPE","COUNT_DISTINCT","MIN","MAX","SUM","AVG"]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationType":{"type":"string","description":"","title":"NestedAggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM"]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation":{"type":"object","properties":{"sortType":{"description":"Whether to sort by the number of matches or the value of the field.","title":"sortType","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.SortType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortDirection":{"description":"Whether to sort in ascending or descending order.","title":"sortDirection","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.SortDirection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Number of aggregation results to return.\nMin: `1`\nMax: `250`\nDefault: `10`","title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"missingValues":{"description":"Whether missing values should be included or excluded from the aggregation results.\nDefault: `EXCLUDE`.","title":"missingValues","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.MissingValues","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregation","description":"","oneOf":[{"description":"","summary":"options","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.options"}]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.options":{"type":"object","title":"options","properties":{"includeOptions":{"description":"Options for including missing values in results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions","summary":"includeOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.RangeAggregation":{"type":"object","properties":{"buckets":{"description":"List of range buckets. During aggregation each entity will be placed in the first bucket its value falls into based on the provided range bounds.","maxItems":1000,"title":"buckets","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.RangeAggregation.RangeBucket"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregation","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ScalarAggregation":{"type":"object","properties":{"type":{"description":"Operation type for the scalar aggregation.","title":"type","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarAggregation","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.DateHistogramAggregation":{"type":"object","properties":{"interval":{"description":"Interval for date histogram aggregation.","title":"interval","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.DateHistogramAggregation.Interval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramAggregation","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.DateHistogramAggregation.Interval":{"type":"string","description":"","title":"Interval","enum":["UNKNOWN_INTERVAL","YEAR","MONTH","WEEK","DAY","HOUR","MINUTE","SECOND"]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem":{"type":"object","properties":{"name":{"description":"Aggregation name displayed in the return.","maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation to perform.","title":"type","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by.","title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationItem","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind"}]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind":{"type":"object","title":"kind","properties":{"value":{"description":"A value aggregation calculates metrics such as \"count\" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationType":{"type":"string","description":"","title":"AggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM","NESTED"]},"wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.NestedAggregation":{"type":"object","properties":{"nestedAggregations":{"description":"Flattened list of aggregations, where each aggregation is nested within the previous one.","minItems":2,"maxItems":10,"title":"nestedAggregations","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.Aggregation.NestedAggregation.NestedAggregationItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregation","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.SearchDetails":{"type":"object","properties":{"mode":{"description":"Boolean search mode. Defines how separate search terms in the `expression` are combined.","title":"mode","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.SearchDetails.Mode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expression":{"description":"Search term or expression.","maxLength":100,"title":"expression","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to search in.\n\nSearchable fields are `reservee.firstName`, `reservee.lastName`, `reservee.phone`, and `reservee.email`.\n\nIf the array is empty, all fields are searched.","maxItems":100,"maxLength":1000,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fuzzy":{"description":"Whether to allow the search function to automatically correct typos or minor mistakes in the search expression.\nThe search function uses an algorithm to find results that are close to what the site visitor typed.","title":"fuzzy","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchDetails","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.SearchDetails.Mode":{"type":"string","description":"","title":"Mode","enum":["OR","AND"]},"wix.table_reservations.reservation.v1.SearchReservationsResponse":{"type":"object","properties":{"reservations":{"description":"List of Reservations.","title":"reservations","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Cursor paging metadata.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregationData":{"description":"Aggregation data.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData","summary":"aggregationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchReservationsResponse","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData":{"type":"object","properties":{"results":{"description":"List of the aggregated data results.","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationData","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregationResult","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range.","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range.","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in the range.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregationResult","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults":{"type":"object","properties":{"name":{"description":"Aggregation name defined in the request.","maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation performed.","title":"type","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field the data was aggregated by.","maxLength":1000,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults.result"}]},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"List of the value aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"List of the range aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"List of the scalar aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations.","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResults","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults":{"type":"object","properties":{"results":{"description":"List of ranges returned in same order as requested.","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResults","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.ScalarResult":{"type":"object","properties":{"type":{"description":"Type of scalar aggregation.","title":"type","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Value of the scalar aggregation.","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult":{"type":"object","properties":{"value":{"description":"","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nestedResults":{"description":"","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedAggregationResults","summary":"nestedResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedValueAggregationResult","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult":{"type":"object","properties":{"value":{"description":"Value of the field.","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResult","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.RangeResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range.","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range.","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in the range.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResult","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult":{"type":"object","properties":{"value":{"description":"Scalar aggregation results.","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue":{"type":"object","properties":{},"title":"NestedResultValue","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result"}]},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result":{"type":"object","title":"result","properties":{"value":{"description":"Value aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.RangeResult","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.Results":{"type":"object","properties":{"results":{"description":"List of nested aggregation results.","title":"results","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Results","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult":{"type":"object","properties":{"value":{"description":"Date in ISO 8601 format.","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in the interval.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResult","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults":{"type":"object","properties":{"results":{"description":"","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupByValueResults","description":"deprecated"},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults":{"type":"object","properties":{"results":{"description":"List of date histogram aggregations.","maxItems":200,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResults","description":""},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults":{"type":"object","properties":{"results":{"description":"List of nested aggregation results.","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults.Results"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedResults","description":"Results of `NESTED` aggregation type in a flattened form.\nAggregations in the resulting array are keyed by the requested aggregation `name`."},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults":{"type":"object","properties":{"name":{"description":"Aggregation name defined in the request.","maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that was performed.","title":"type","type":"string","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field the data was aggregated by.","maxLength":1000,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.result"}]},"wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupedByValue":{"description":"deprecated","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.GroupByValueResults","summary":"groupedByValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.DateHistogramResults","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation results.","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.upstream.wix.common.AggregationData.AggregationResults.NestedResults","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"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":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"wix.table_reservations.reservation.v1.RemoveReservationMigrationNotesRequest":{"type":"object","properties":{"reservationId":{"description":"Reservation ID.","format":"GUID","title":"reservationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveReservationMigrationNotesRequest","description":""},"wix.table_reservations.reservation.v1.RemoveReservationMigrationNotesResponse":{"type":"object","properties":{"reservation":{"description":"","$ref":"#/components/schemas/wix.table_reservations.reservation.v1.Reservation","summary":"reservation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveReservationMigrationNotesResponse","description":""},"com.wixpress.rest.RawHttpRequest":{"type":"object","properties":{"body":{"description":"","title":"body","type":"bytes","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pathParams":{"description":"","title":"pathParams","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.rest.PathParametersEntry"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"queryParams":{"description":"","title":"queryParams","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.rest.QueryParametersEntry"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headers":{"description":"","title":"headers","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.rest.HeadersEntry"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"method":{"description":"","title":"method","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rawPath":{"description":"","title":"rawPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rawQuery":{"description":"","title":"rawQuery","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RawHttpRequest","description":""},"com.wixpress.rest.PathParametersEntry":{"type":"object","properties":{"key":{"description":"","title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PathParametersEntry","description":""},"com.wixpress.rest.QueryParametersEntry":{"type":"object","properties":{"key":{"description":"","title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryParametersEntry","description":""},"com.wixpress.rest.HeadersEntry":{"type":"object","properties":{"key":{"description":"","title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HeadersEntry","description":""},"com.wixpress.rest.RawHttpResponse":{"type":"object","properties":{"body":{"description":"","title":"body","type":"bytes","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"statusCode":{"description":"","title":"statusCode","type":"integer","format":"uint32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headers":{"description":"","title":"headers","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.rest.HeadersEntry"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RawHttpResponse","description":""},"google.protobuf.UInt32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UInt32Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Reservation","description":"The reservation domain object.","fqdn":"wix.table_reservations.v1.reservation"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Reservations API allows you to create and manage reservations at restaurants. \n\nThis API provides all the necessary functionality to move a reservation through the phases of its [lifecycle](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::the-reservation-lifecycle*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/the-reservation-lifecycle), such as from the reservation request until completion.\n\nThe Reservations API works together with the [Reservation Locations API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::d9b7ee6a-87cb-4d9a-bfed-9848389d81dfslug::introduction*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservation-locations/introduction), which provides information about the physical location of a restaurant, as well as that restaurant’s availability and reservation conditions. \n\nThe Reservations API also works together with the [Time Slots API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::69e46f13-77ec-4140-8ed5-87fa0b5b2eeaslug::introduction*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/time-slots/introduction), which allows you to retrieve availability information about time slots at a restaurant on a specific date and for a specific party size. \n\nWith the Reservations API, you can:\n* Create and manage reservations at a restaurant.\n* Get information about existing reservations at a restaurant.\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n* The site owner must install the Wix Table Reservations app.\n* The site owner must have at least 1 location configured in their Dashboard under [Business Info](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fbusiness-info).\n\n\n## Use Cases\n[Reservation app for restaurants on a Wix site](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::03b65e54-6b8e-47eb-a5f9-72edc580978b#reservation-app-for-restaurants-on-a-wix-site*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/sample-flows#reservation-app-for-restaurants-on-a-wix-site)\n\n## Terminology\nFor a comprehensive glossary of Reservations terms, see [Terminology](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f6bd7c6a-43de-4e5d-a2ad-7db0036151c9*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/terminology).\n"},{"displayName":"Sorting, Filtering, and Search","slugifyName":"sorting-filtering-and-search","content":"# Reservations: Supported Filters, Sorting, and Search\n\nThis article covers field support for filtering, sorting, and searching in the Reservations API.\n\n\n## Query Reservations\n\nThe following table shows field support for filters and sorting\nfor the reservation object when using Query Reservations:\n\n| Field | Supported Filters | Sortable |\n| ----------------------------------- | ---------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$in` | |\n| `status` | `$eq`, `$ne`, `$in` | |\n| `details.startDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Reservations](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::query-reservations*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/query-reservations)\n\n## Search Reservations\n\nThe following table shows field support for filters and sorting\nfor the reservation object when using Search Reservations:\n\n| Field | Supported Filters | Sortable |\n| ----------------------------------- | ---------------------------------------------- | -------- |\n| `source` | `$eq`, `$ne`, `$in` | |\n| `status` | `$eq`, `$ne`, `$in` | |\n| `details.reservationLocationId` | `$eq`, `$ne`, `$in` | |\n| `reservee.contactId` | `$eq`, `$ne`, `$in` | |\n| `details.tableIds` | `$eq`, `$has_all`, `$has_some`, `$empty` | |\n| `details.startDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `details.partySize` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n\n\nThe following fields in the reservation object are searchable:\n- `reservee.firstName`\n- `reservee.lastName`\n- `reservee.phone`\n- `reservee.email`\n\n__Related content:__\n[Search Reservations](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::search-reservations*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/search-reservations)\n"},{"displayName":"The Reservation Lifecycle","slugifyName":"the-reservation-lifecycle","content":"# The Reservation Lifecycle\n\nReservations progress from creation to completion through a series of phases. Each phase is represented by a status, which is stored as an enum in the `status` field of a `reservation` object. \n\nThis article explains the available statuses, and how a reservation can progress using the Reservations API.\n\nNote:\nReservations can also be created and progress through phases as a result of actions on a Wix site or dashboard. For more information see the Wix Restaurants [Table Reservations articles](fallback::https://support.wix.com/en/table-reservations).\n\n## Statuses\nThe following statuses are listed roughly in order of their position in the reservation lifecycle.\n* `HELD` - The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n* `REQUESTED` - A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n* `DECLINED` - The restaurant’s owner or staff declined the customer’s request to make the reservation.\n* `RESERVED` - The reservation is confirmed.\n* `SEATED` - The customer is currently occupying the table.\n* `CANCELED` - The reservation is canceled.\n* `NO_SHOW` - The customer didn't show up for their reservation.\n* `FINISHED` - The reservation completed successfully.\n* `PAYMENT_PENDING` - The reservation is temporary and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reservation is in HELD status and reserve reservation endpoint is called and payment is needed. After payment is completed status will be changed automatically to RESERVED.\n\n\n## Managing the reservation lifecycle\nThis section explains how reservations can be created and progressed through their lifecycle.\n\n### Create a reservation\nThis API provides 2 endpoints for creating reservations.\n\n[`Create Held Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::create-held-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/create-held-reservation) - This endpoint creates a reservation with the `HELD` status. Reservations with the `HELD` status are only valid for 10 minutes. Trying to change a `HELD` reservation’s status after 10 minutes returns an error. \n\nThe Reservations pages created by the Table Reservations app on Wix sites use this endpoint to temporarily reserve time slots selected by customers while they enter further details.\n\nAfter a customer completes the reservation process, call [`Reserve Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::reserve-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/reserve-reservation) to change the reservation’s status to `RESERVED` or `REQUESTED`, depending on whether the site requires manual approval for online reservations.\n\nYou cannot call [`Update Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::update-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/update-reservation) to change a reservation’s status from `HELD`. Trying to do so returns an error.\n\n[`Create Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::create-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/create-reservation) - This endpoint creates a reservation with either the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation (see manual approval below).\n\nWith the `MANAGE RESERVATIONS (FULL)` permission scope, you can set more properties of the reservation in the `Create Reservation` request. This allows you to create the reservation with a status of your choice and gives you the option to override the restaurant’s rules regarding online availability and table management. \n\n### Requiring manual approval\nTo require manual approval for `REQUESTED` reservations at a location before they’re confirmed (`RESERVED`), set `configuration.onlineReservations.manualApproval.enabled` to `true` for that reservation location. Manual approval can also be set through a site’s [Table Reservations app](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Frestaurants/table-reservations) in the dashboard.\n\nIf manual approval is enabled for online reservations at a reservation location, reservations made using the [`Reserve Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::reserve-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/reserve-reservation) endpoint or through the restaurant’s dashboard are automatically created with the `REQUESTED` status. This setting does not affect offline reservations.\n\n### Reserving or declining reservations\nTo use the Reservations API to approve or decline a reservation, call [`Update Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::update-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/update-reservation) and change the reservation’s status to `RESERVED` or `DECLINED` respectively.\n\n### Seating customers\n\nOnce customers have been seated (or the equivalent if your restaurant doesn’t have seats), change the status of the reservation to `SEATED` using [`Update Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::update-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/update-reservation).\n\n### Ending a Reservation\n\nA reservation can end as `DECLINED`, `CANCELED`, `NO_SHOW`, or `FINISHED`.\nIn each case, change the status using [`Update Reservation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::343e8ce4-0292-4b05-b188-8e1a5ebda8d1slug::update-reservation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/update-reservation). Once any of the above statuses are set, the reservation is considered complete.\n\n## Lifecycle flow examples\n\nThe following are examples of possible paths a reservation could take from creation to completion:\n\n**Finished**\n\nA customer selects a time slot for a reservation on the restaurant’s website. They proceed to enter their details and confirm their reservation request. The restaurant owner approves the reservation. The customer arrives and is seated. They finish their meal, pay, and leave. \n\nThis flow would be represented by:\n`HELD` > `REQUESTED` > `RESERVED` > `SEATED` > `FINISHED`\n\n**Cancelation**\n\nA customer calls the restaurant and makes a reservation, but their car breaks down and they call again to cancel.\n\nThis flow would be represented by:\n`RESERVED` > `CANCELED`\n\n**No Show**\n\nA customer makes a reservation using the restaurant’s app. The restaurant owner approves the reservation, but the customer never shows up.\n\nThis flow would be represented by:\n`REQUESTED` > `RESERVED` > `NO_SHOW`\n\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}