Price Check

post

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

Performs a price check on one or more items.

Path Params

location

string

required

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

Body Params

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.

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

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

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here!