> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: Reservations

# Type: Reservation Object

# Link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/reservations/reservations/reservation-object.md

## Description: The reservation domain object.

## Schema:

```json
 Type: Reservation Object | type: Reservation
 Description: The reservation domain object.
       - name: id  | type: string | description: Reservation ID.
           - name: value  | type: string | description: 
       - name: status  | type: string | description: Status of the reservation.  See the [Reservation Lifecycle article](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/the-reservation-lifecycle.md) for an explanation of the role of statuses in the reservation lifecycle.
           enum: HELD, RESERVED, CANCELED, FINISHED, NO_SHOW, SEATED, REQUESTED, DECLINED, PAYMENT_INFORMATION_PENDING
       - name: source  | type: string | description: Reservation source.  This indicates how the reservation was made.
           enum: OFFLINE, ONLINE, WALK_IN
       - name: details  | type: Details | description: Reservation details.
           - name: reservationLocationId  | type: string | description: ID of the reservation location at which this reservation will be made.
           - name: tableIds  | type: Array<StringValue> | description: IDs of tables used for this reservation.
           - name: tables  | type: Tables | description: Tables used for this reservation.
               - name: ids  | type: Array<string> | description: IDs of tables used for this reservation. If you don't specify an `ids` array, or you specify an empty array, no tables are assigned.
           - name: startDate  | type: string | description: Start date and time of the reservation.
               - name: seconds  | type: string | description: 
               - name: nanos  | type: number | description: 
           - name: endDate  | type: string | description: End date and time of the reservation.
           - name: partySize  | type: number | description: Party size.
               - name: value  | type: number | description: 
       - name: reservee  | type: Reservee | description: Information about the person the reservation is being made for.  A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields. Attempting to create a reservation without these fields results in an error.
           - name: firstName  | type: string | description: First name.  This field is required if the reservation's `source` is anything other than `WALK_IN`.
           - name: lastName  | type: string | description: Last name.
           - name: email  | type: string | description: Email address.
           - name: phone  | type: string | description: Phone number.  This property should begin with a +, followed by the country code, and then the rest of the phone number. For example, `"+972555555555"`.  This field is required if the reservation's `source` is anything other than `WALK_IN`.
           - name: marketingConsent  | type: boolean | description: Whether the reservee has given marketing consent.
               - name: value  | type: boolean | description: 
           - name: customFields  | type: Struct | description: Custom fields for the reservee in key-value pairs.  The 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"`.  Empty fields are not returned.
               - name: fields  | type: object | description: 
           - name: contactId  | type: string | description: Contact ID. If a contact with this ID does not exist on the site, one will be created.
       - name: reservedBy  | type: ReservedBy | description: Information about the person making the reservation.  This field is required if the reservation's `source` is anything other than `WALK_IN`.
           - name: contactId  | type: string | 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.
       - name: teamMessage  | type: string | description: Team message.  A message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.
       - name: createdDate  | type: string | description: Date and time the reservation was created.
       - name: updatedDate  | type: string | description: Date and time the reservation was changed.
       - name: revision  | type: string | description: Revision number, which increments by 1 each time the reservation is updated. To prevent conflicting changes, the current revision must be specified when updating the reservation.  Ignored when creating a reservation.
           - name: value  | type: string | description: 
       - name: declineReason  | type: string | description: The reason the reservation was declined.
       - name: paymentStatus  | type: string | description: Payment status.
           enum: FREE, NOT_PAID, PAID, PARTIALLY_REFUNDED, FULLY_REFUNDED, PARTIALLY_PAID
       - name: extendedFields  | type: ExtendedFields | description: Custom field data for the reservation object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls.
           - name: namespaces  | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
       - name: archived  | type: boolean | description: Whether the reservation is archived.  Archived reservations aren't shown in the dashboard along with other reservations. However, they can still be viewed in a separate section. Archived reservations can't be updated with Update Reservation.

```