Reservation Data Model

A unique identifier for the reservation. This identifier will not change no matter what edits have been made to the reservation. Transferred reservations will get new unique identifiers and are considered new reservations.

Details about the business this reservation is for; useful for business groups that have multiple businesses supported by Tock.

The start time of the reservation in the business time zone of the form HH:MM using the 24 hour clock and excluding seconds (e.g. 4:15pm would have a dateTime of "16:15").

The size of the party on the reservation.

The experience assigned to the reservation in Tock. This is present even if no money is attached to the reservation and will not be present for walk-ins.

Any add-on(s) or menu item(s) that has been booked along with this reservation. This is present even if no money is attached to this option and will not be present for walk-ins.

Any fee(s) charged automatically to the party as part of the reservation. This does not include any custom fees applied to the reservation from the Tock Dashboard.

Any custom charges charged to the party as part of the reservation through the Tock Dashboard.

Any metadata associated with this reservation collected during the checkout process. Examples of potential metadata are UTM tracking parameters indicating how the guest originally came to make the reservation.

The total amount of all complimentary discounts applied through the Tock Dashboard to a paid reservation.

The subtotal given on the receipt for the reservation.

If tax has been applied to the subtotal and not for individual purchased items, this is the tax rate applied to the subtotal. If using multiple tax rates for individual items, this field will not be present.

The total amount of tax collected for the reservation.

If a service charge has been applied to the reservation, this field is the rate applied to the subtotal.

If a service charge has been applied to the reservation, this field is the amount of service charge added to the total price.

If gratuity has been added to the reservation by the party through choosing a fixed percentage, this field is the gratuity rate selected and applied to the subtotal. If a custom gratuity was chosen manually, this field will be zero.

The gratuity applied by the party to the reservation and added to the total price.

For reservations to events where a fee is applied, the event fee rate applied to the subtotal.

For reservations to events where a fee is applied, the total amount of that fee added to the total price.

If applied to the reservation from the Tock Dashboard, this field contains the custom fee rate applied to the subtotal and added to the total price.

If applied to the reservation from the Tock Dashboard, this field contains the custom fee amount applied to the subtotal and added to the total price.

If applied to the reservation from the Tock Dashboard, this field contains the name of the custom fee applied to the total price.

The total price of the reservation including all fees, charges, taxes.

Any discounts applied to the total price of the reservation, either automatically during checkout or through application in the Tock Dashboard. This does not include complimentary discounts applied to the reservation (see compAmountCents for that value).

The amount that has been charged to the party for this reservation. Does not need to be the same as the total price of the reservation.

The amount that is still due to cover the total price of the reservation. This will be the totalPriceCents field less the netAmountPaidCents field.

The timestamp for when this reservation was first created, in milliseconds since the Unix Epoch.

The timestamp for the last modification to this reservation, in milliseconds since the Unix Epoch.

The timestamp for the start time of the reservation, in milliseconds since the Unix Epoch. This is a convenience field as it does not require the business timezone.

Whether the reservation has been transferred to a different party.

If this reservation has been transferred to a different party, the amount the original owner charged the transferee for the reservation.

Whether this reservation has been marked as cancelled, either by the user or through the Tock Dashboard. No modifications can happen to a reservation after it is cancelled.

The "owner" patron is the one who initiated payment for the reservation. It is most commonly the same as the "diner" patron unless it booked through a concierge or altered directly from the Tock Dashboard.

The patron whose name will appear on the reservation in the Tock Dashboard. Is is most commonly the same as the ownerPatron unless booked through a concierge or altered directly from the Tock Dashboard.

A version identifier used by Tock to indicate how many edits have been made to the original reservation. This is for Tock internal use only and a better indication of the number of edits is in the sequenceId field.

If the reservation was made by a patron that has linked their loyalty program account, this field contains the unique number used to identify the loyalty card used.

The results of answering any questions about the reservation after the party has visited.

Any tags applied to the reservation in the Tock Dashboard specific to this reservation and not to the guest as a whole.

All payments made to secure this reservation. Payments take many forms (credit cards, gift cards, reward points, etc.) and the type of payment used is indicated inside the nested objects.

Any refunds applied to any payments made on this reservation. Refunds are applied in the Tock Dashboard through edits to the reservation or applying any form of discount. These refunds are applied to the original form(s) of payment to secure the reservation.

The current state of the party within the Tock Dashboard.

An identifier that starts at zero and increases by one for each edit to the reservation. Use this field to denote that the reservation has changed since the previous sequenceId.

The reservation confirmation code given to the party. Currently always eight characters. This field is not set for walk-ins.

The employees names used to serve the party for the reservation. If multiple employees were assigned, they will be delimited with the word "and" (e.g. Luci and Dezi).

Used only for encoding walk-in data, maps to the visit id

A note that has been attached to this reservation or guest through actions in the Tock Dashboard. Imported reservations may also have notes.

Any questions answered by the party about this reservation prior to the service date.

Table(s) assigned to the reservation sorted alphabetically by ascending order.

An area of the floor plan (also known as seating area)

A unique identifier for the seating option. Used internally by Tock.

The name given to the seating option which is displayed within the Tock Dashboard.

This field indicates whether or not the seating option is outdoors.

A unique identifier for the experience. Used internally by Tock.

The name given to the experience which is displayed prominently when booking or within the Tock Dashboard.

The amount added to the total price for the experience and does not contain any values associated with add-on(s) or menu item(s).

If assigned by the business from the Tock Dashboard, this field will be the SKU denoting the experience.

The type of experience being offered by the business.

A unique identifier for the option. Used internally by Tock.

The name assigned in the Tock Dashboard to this optional item.

The amount added to the total price for just this one option purchased along with the experience.

If assigned by the business from the Tock Dashboard, this field will be the SKU denoting the option.

A unique identifier for the fee. Used internally by Tock.

The name assigned in the Tock Dashboard to this additional fee.

The amount added to the total price for this additional fee.

If assigned by the business from the Tock Dashboard, this field will be the SKU denoting the fee.

The name given to the custom charge when created on the reservation in the Tock Dashboard.

The amount added to the total price for this custom charge.

The name of the metadata attribute.

The value of the metadata attribute.

A unique identifier assigned to the payment. Used internally by Tock.

The amount of the reservation that was paid using the paymentType.

The Tock-generated payout that includes this payment as a credit to the business bank account. If the business connects to Tock for payment processing using Stripe this field will not be present.

The form of payment used for this portion of total price on the reservation.

A unique identifier assigned to the payment by the payment processor indicated by the paymentType.

The amount the payment processor kept from the payment to perform the service.

The fee that Tock kept from the payment to perform the service.

A unique identifier assigned to the refund. Used internally by Tock.

The amount of the original payment that was refunded. This value will always be a positive number.

This field indicates whether this refund was issued because of a lost chargeback dispute.

The current status of the refund within the payment processor that serviced the original payment.

The Tock-generated payout that includes this refund as a debit to the business bank account. If the business connects to Tock for payment processing using Stripe this field will not be present.

A unique identifier assigned to the refund by the payment processor indicated by the paymentType.

The amount the of the payment processor fee that was returned as a result of the refund.

The amount of the Tock fee that was returned as a result of the refund.

A unique identifier assigned to the payout. Used internally by Tock.

The date that this payout is expected to arrive in the business bank account pending any potential rejections by the bank.

The name of the tag assigned to the reservation.

The type of note being described by this object.

The full text of the note.

The short name of this question assigned in the Tock Dashboard.

All responses to the question. If the guest was presented with checkboxes to answer the question there may be multiple responses listed through this field.

A textual description of the discount.

The amount of the discount applied in some manner to the total price. This value will always be a positive number.

Where and how the discount is applied to the total price.

If a gift card was used to apply the discount to the total price, this field will contain extra information about the gift card used.

If a gift card was used to apply the discount to the total price, this field will contain a confirmation number from the gift card provider that can be used to reconcile between Tock and the provider.

If the discount is applied through a promotional code, this field will be the short name of promo code as configured in the Tock Dashboard.

If the discount is applied through a promotional code, this field is a unique identifier assigned to promotional code. Used internally by Tock.

If the discount is for redeeming loyalty rewards program points, this field will contain extra information about the loyalty program used.

The provider of the gift card service for the business.

The identifier of the card used for reconciliation with the gift card provider.

If provided, the security pin used to authenticate the owner of the gift card.

The loyalty program provider used when securing the reservation.

If known, the account identifier for the owner patron within the loyalty program.

A unique identifier for this feedback. Used internally by Tock.

Deprecated. The rating supplied by the guest indicating their opinion about the experience.

A custom message included with the feedback from the guest.

Feedback can be altered until a message is given along with the rating. This indicates whether the feedback has been locked with a message and is unable to be altered again.

The timestamp for when the feedback was submitted by the guest, in seconds from the Unix Epoch.

The rating scale of feedback request

The rating supplied by the guest indicating their opinion about the experience.

A unique identifier. Used internally by Tock.

The name of the table.

The room the table resides in.

ID used by external integrations

A unique identifier for the business. Used internally by Tock.

The name given to the business in the Tock Dashboard.

The unique section of exploretock.com that is devoted to showing inventory and allowing guests to book reservations. The top-level URL will be of the form https://exploretock.com/{domainName}/.

The locale that the business presents in using the ISO-3166 country code and ISO-639 language code (e.g. en-us for US English, es-es for Spain Spanish).

The ISO 4217 three letter currency code that the business presents on exploretock.coms (e.g. "USD" for US Dollar, "GBP" for Great Britain Pound).

The time zone in which the business operates in the IANA named format (e.g. "America/Chicago").

A unique identifier assigned to the patron. Used internally by Tock.

The email address of the patron. No two patrons can have the same email address, but an email address is not required of all patrons.

If known, the first name of the patron.

If known, the last name of the patron.

If known, the phone number of the patron without the country code.

If known, the country code for the patron using the prefix code and the ISO 3166-1 alpha-2 country code (e.g. "+1 US").

If known, the zip code given by the patron in their Tock profile.

If known, a URL to a public image of the patron.

If known, the ISO 3166-1 alpha-2 country code where the patron lives.

If known and if the business participates in an integrated loyalty program, this field contains the card number given to the patron by the business.

If known and if the business participates in an integrated loyalty program, this field contains the account identifier given to the patron by the business.