Price Check

post

https://gotab.io/api/loc/{location}/price-check

Performs a price check on one or more items.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

A price check is a way to virtually determine the balances, taxes, fees and discounts, of a tab prior to actually creating it. This is necessary because the existence of certain items on the tab may add extra fees or discounts.

Additionally, certain users may belong to "segments" which may entitle them to even more discounts. These fees and discounts are represented as items and these items will also be returned with the price check for your consideration.

Path Params

location

string

required

The uuid or url_name the location in which to simulate the tab.

Body Params

A JSON object containing information about the Tab to be created.

externalId

string

An external ID for the tab. This is used to identify the tab in the external system.

openTab

boolean

Whether or not the tab should be automatically submitted in this request and paid.

scheduledDate

date-time

The scheduled time of the tab. Omit to set as ASAP.

spotUuid

string

The uuid of the spot the order will be set to.

coverCount

number

The number of guests on a tab.

phoneNumber

string

phone number to associate with the tab. Must be provided if openTab is false and a customerId is not provided.

items

array of objects

items

tabAdjustments

array of objects

An array of price adjustments to be added to the tab.

tabAdjustments

customerId

string

Optional customer id to associate with the tab. Must be provided if openTab is false and a phoneNumber is not provided.

evaluateOrderRules

boolean

Defaults to false

When true, membership/loyalty order rules are evaluated for the associated customer so their discounts and rewards are applied to the tab (and reflected in the price check). Used by the kiosk loyalty/membership check-in flow.

waitForProcessorAccounts

boolean

Defaults to false

When true, the response waits for any gift cards purchased on the tab to be issued and returns them in a processorAccounts array. Only applies to a tab that is paid in this request (payments given, openTab false). Omit to return as soon as the tab is created and receive the cards through the GIFT_CARD_CREATED webhook instead; the processorAccounts field is then absent from the response.

checkIn

object

How the customer identified themselves at check-in, recorded against the tab for reporting. Used by the kiosk, where the check-in happens before the tab exists. Ignored unless the identifier resolves to customerId.

name

string

The name of the tab (and the order). Required when openTab is false.

employeeId

string

The id of the employee creating the tab.

payments

array of objects

An array of payments and payment methods to be added to the tab

payments

orderDetails

object

Custom metadata for the order.

preauthSourceTab

object

fiscalDate

date

^\d{4}-\d{2}-\d{2}$

Fiscal day in YYYY-MM-DD format representing the local business day to be assigned to the tab, only if a future date is required. Must be within 90 days of the current fiscal day.

Response

200

Successful response