# Schema Types

Table of Contents

# Query

Field Argument Type Description
acquirers [Acquirer]

# GET routes

Arguments

  • id: Variant's id (optional)
airlines [Airline]

# GET routes

Arguments

  • id: Variant's id (optional)
airports [Airport]

# GET routes

Arguments

  • id: Variant's id (optional)
apps [App]

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String
version String
editable Boolean
appLogic String
uuid String!
version String
appGroups [AppGroup]
installedApps [App]
appReleases [AppRelease]
uuid String!
installedAppLogic [AppLogic]
appOrganizations [Organization]
appByNamespace App
namespace String!
definition AppDefinition
appErrors [AppError]

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String!
availableTimeSlots [AvailableTimeSlot]

# GET Available Time Slots for an item

Arguments

  • item: Items's uuid (required)
  • organization: Organization's uuid (required)
  • channel: Channel's uuid (required)
  • location: Location's uuid (optional)
sessionToken String!
item String
startTimeInMillis Float!
endTimeInMillis Float!
organization String!
channel String!
location String
deliveryService String
order String
items [ItemReference]
billing [Billing]

# GET Billing

Returns an organizations invoices for SalesCloud usage Arguments

availableCredit Price
bookings [Booking]

# GET routes

Arguments

  • id: Variant's id (optional)
item String
limit Int
skip Int
booking Booking
bookingUUID String!
organizationUUID String
bookingsByItem [Booking]
organization String!
item String!
organizationByCardAcceptor String
cardAcceptor String!
cart Order
sessionToken String!
channel String!
cartQueue Queue
uuid String
category Category

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String!
categories [Category]
type String!
uuid String
attributes [Category]
organization String!
channel ChannelOption

# GET routes

Arguments

  • id: Variant's id (optional)
organization String!
uuid String!
channels [Channel]
uuid String
channelsList [ChannelOption]
organization String
checkinButton [CheckinButton]
checkoutSections [CheckoutSection]

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String
checkoutSectionList [CheckoutSectionOption]
organization String!
checkoutSectionInstances [CheckoutSectionInstance]

# GET routes

Arguments

  • id: Variant's id (optional)
organization String!
channel String!
checkoutSectionInstanceList [CheckoutSectionInstanceOption]
organization String!
channel String!
disabledTimeSlots [timeSlotOption]
organization String!
date String
checkoutSteps [CheckoutStep]

# Checkout Steps

Get a list of checkout steps.

checkoutStepList [CheckoutStepOption]

# Checkout Steps

Get a list of checkout step options.

organization String!
companies [Company]

# GET routes

Arguments

  • id: Variant's id (optional)
label String
contacts [Contact]

# GET routes

Arguments

  • id: Variant's id (optional)
countries [Country]

# GET routes

Arguments

  • id: Variant's id (optional)
country Country
name String
defaultCountry Country
coupon Coupon

# GET routes

Arguments

  • id: Variant's id (optional)
code String!
organization String!
coupons [Coupon]
credit [CreditTransaction]

# GET routes

Arguments

  • id: Variant's id (optional)
startTimeInMillis Float!
endTimeInMillis Float!
channels [String]
locations [String]
creditSummary [CreditTransaction]
startTimeInMillis Float!
endTimeInMillis Float!
channels [String]
locations [String]
currencies [Currency]

# GET routes

Arguments

  • id: Variant's id (optional)
defaultCurrency Currency
customers [Customer]

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String
customerProfiles [CustomerProfile]

# GET routes

Arguments

  • id: Variant's id (optional)
dash DashRender

# GET routes

uuid String!
startTimeInMillis Float
endTimeInMillis Float
channels [String]
locations [String]
uiValues String
dashByNamespace DashRender
namespace String!
startTimeInMillis Float
endTimeInMillis Float
channels [String]
locations [String]
uiValues String
dashCollections [DashCollection]

# GET routes

dashTypes [DashType]

# GET routes

Arguments

  • id: Variant's id (optional)
dashType DashType
namespace String!
debit [DebitTransaction]

# GET routes

Arguments

  • id: Variant's id (optional)
startTimeInMillis Float!
endTimeInMillis Float!
channels [String]
locations [String]
debitSummary [DebitTransaction]
startTimeInMillis Float!
endTimeInMillis Float!
channels [String]
locations [String]
deliveryMethods [DeliveryMethod]

# GET routes

Arguments

  • id: Variant's id (optional)
organization String
deliveryMethod DeliveryMethod
namespace String!
deliveryMethodInstances [DeliveryMethodInstance]

# GET routes

Arguments

  • id: Variant's id (optional)
deliveryMethodInstance DeliveryMethodInstance
namespace String!
deliveryServices [DeliveryMethodInstanceOption]
organization String!
channel String
order String
newOrder NewOrder
deliveryServiceRateLegacyOrder Price
deliveryMethodInstance String!
order String!
organization String
deliveryServiceProcessLegacyOrder DeliveryMethodInstanceProcessResult
deliveryMethodInstance String!
order String!
organization String
deliverySummary [DeliverySummary]

# GET Billing

Returns an organizations invoices for SalesCloud usage Arguments

organization String!
date String!
devices [Device]

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String!
device Device
SerialNumber String
deviceSettings DeviceSettings
SerialNumber String!
deviceSignup DeviceSignup
SerialNumber String!
deviceErrors [DeviceError]

# GET routes

Arguments

  • id: Variant's id (optional)
SerialNumber String
deviceEvents [DeviceEvent]

# GET routes

Arguments

  • id: Variant's id (optional)
SerialNumber String
deviceLogs [DeviceLog]

# GET routes

Arguments

  • id: Variant's id (optional)
SerialNumber String
limit Int
discounts [Discount]

# GET routes

Arguments

  • id: Variant's id (optional)
discountsList [DiscountOption]
organization String!
discount DiscountOption
organization String!
uuid String!
documentTypes [DocumentType]

# GET routes

Arguments

  • id: Variant's id (optional)
namespace String
documentRender String
namespace String!
version String!
order_id String!
etag eTag

# GET routes

Arguments

  • id: Variant's id (optional)
tagID String
etags [eTag]
uuid String!
unclaimedEtags [eTag]
events [Event]

# GET routes

Arguments

  • id: Variant's id (optional)
file File

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String!
formsOfPayment [FormOfPayment]

# GET routes

Arguments

  • id: Variant's id (optional)
giftcard Giftcard

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String!
organization String!
hardwareModels [HardwareModel]

# GET routes

Arguments

  • id: Variant's id (optional)
hardwareModel HardwareModel
sku String
items [Item]

# GET products

Arguments

  • product_id: Product's id (optional)
uuid String
itemsByCategory [Item]
categories [String]
itemsList [ItemOption]
organization String
categories [String]
item Item
uuid String
totalAmountBought Price
organization String!
uuid String!
top100Amounts [Price]
organization String!
uuid String!
totalAmountCount Int
organization String!
uuid String!
itemTypes [ItemType]

# GET routes

Arguments

  • id: Variant's id (optional)
itemType ItemType
namespace String!
lineItems [LineItem]

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String
lineItemTypes [LineItemType]

# GET routes

Arguments

  • id: Variant's id (optional)
lineItemType LineItemType
namespace String!
localeStrings [LocaleString]

# GET routes

Arguments

  • id: Variant's id (optional)
keys [String!]
location Location
organization String!
uuid String!
locations [Location]
locationOptions [LocationOption]
organization String!
messageButtons [MessageButton]
organization String!
messengerMethodInstances [MessengerMethodInstance]

# GET products

Arguments

  • product_id: Product's id (optional)
messages [Message]

# GET routes

Arguments

  • id: Variant's id (optional)
messengerMethods [MessengerMethod]

# GET routes

Arguments

  • id: Variant's id (optional)
messengerMethod MessengerMethod
namespace String!
notes [Note]

# GET routes

Arguments

  • id: Variant's id (optional)
receiptAsHTML Receipt

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String!
receiptAsPDF Receipt
uuid String!
estimateAsPDF Receipt
uuid String!
invoiceAsPDF Receipt
uuid String!
voucherAsPDF Receipt
uuid String!
orders [Order]
customer String
channel String
location String
startTimeInMillis Float
endTimeInMillis Float
skip Int
limit Int
order Order
uuid String!
orderStates [OrderStateOption]

# GET routes

Arguments

  • id: Variant's id (optional)
organizations [Organization]

# GET routes

Arguments

  • id: Variant's id (optional)
currentOrganization Organization
organization Organization
uuid String!
organizationByChannel String
channel String!
organizationRoles [OrganizationRole]

# GET routes

Arguments

  • id: Variant's id (optional)
partner Partner

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String!
partnerOrganizations [PartnerOrganization]
uuid String!
payments [PaymentTransaction]

# GET routes

Arguments

  • id: Variant's id (optional)
serialNumbers [String]
locations [String]
channels [String]
orders [String]
customers [String]
states [PaymentTransactionStatus]
namespaces [String]
startTimeInMillis Float
endTimeInMillis Float
limit Int
skip Int
sort QuerySort
payment PaymentTransaction
uuid String!
paymentMethods [PaymentMethod]

# GET routes

Arguments

  • id: Variant's id (optional)
paymentMethodList [PaymentMethodOption]
organization String!
paymentMethod PaymentMethod
namespace String!
paymentMethodInstances [PaymentMethodInstance]

# GET routes

Arguments

  • id: Variant's id (optional)
uuid String
checkout Boolean
terminal Boolean
paymentMethodInstanceList [PaymentMethodInstanceOption]
organization String!
checkout Boolean
terminal Boolean
paymentMethodInstanceOption PaymentMethodInstanceOption
organization String!
uuid String!
paymentstates [PaymentState]

# GET routes

Arguments

  • id: Variant's id (optional)
persons [Person]

# GET routes

Arguments

  • id: Variant's id (optional)
platforms [Platform]

# GET routes

Arguments

  • id: Variant's id (optional)
posFragments [PosFragment]

# GET routes

Arguments

  • id: Variant's id (optional)
namespace String
printerSMSMessages [printerSMSMessage]

# GET routes

Arguments

  • id: Variant's id (optional)
printJobs [PrintJob]

# GET routes

Arguments

  • id: Variant's id (optional)
MacAddress String
printJobByUUID PrintJob
UUID String
buttons Boolean
roles [Role]

# GET routes

Arguments

  • id: Variant's id (optional)
routes [Route]

# GET routes

Arguments

  • id: Variant's id (optional)
platform String
services [Service]

# GET routes

Arguments

  • id: Variant's id (optional)
anonymousSession Session

# GET routes

Arguments

  • id: Variant's id (optional)
sessionToken String!
channel String!
sites [Site]

# GET routes

Arguments

  • id: Variant's id (optional)
isSitesRegistered Boolean
ssoSitesLink String
site_name String
staff [Staff]

# GET routes

Arguments

  • id: Variant's id (optional)
limit Int
skip Int
sort QuerySort
verifyStaffPin Boolean
organization String!
ssn String!
pin String!
stockCollections [StockCollection]

# GET routes

stockEntries [StockEntry]

# GET routes

collection String!
subscriptions [RecurringSubscription]

# GET routes

Arguments

  • id: Variant's id (optional)
limit Int
skip Int
sort QuerySort
systemTimeInMillis Float

# GET routes

Arguments

  • id: Variant's id (optional)
primaryColor String
randomString String
taxes [Tax]

# GET routes

Arguments

  • id: Variant's id (optional)
team [Team]

# GET routes

Arguments

  • id: Variant's id (optional)
siteTemplates [SiteTemplate]

# GET routes

Arguments

  • id: Variant's id (optional)
emailTemplates [EmailTemplate]
users [User]

# GET routes

Arguments

  • id: Variant's id (optional)
user User
uid String
whoAmI User
Organization String
userExistsByEmail Boolean
email String!
userExistsByDisplayName Boolean
displayName String!
variants [Variant]

# GET variants

Arguments

  • id: Variant's id (optional)
id Int
variationOption VariationOption

# List of variationOptions

Sorted by weight

organization String!
uuid String!
variationOptions [VariationOption]
uuid String
widgetList [Widget]

# List of widgets

Sorted by newest widget in the top

organization String!
work [Work]

# List of work

Sorted by newest work in the top

limit Int
skip Int
sort QuerySort
workToVerify [Work]
organization String!
ssn String!
pin String!

# Mutation

Field Argument Type Description
runApp RunAppResult
app String!
version String!
mockEvent RunAppResult
app String!
version String!
event String!
saveApp AppSaveResponse
app SaveApp
saveAppRoles Boolean
uuid String!
roles SaveAppRoles
saveAppSettings Boolean
uuid String!
settings SaveAppSettings
newApp App
app NewApp
installApp AppInstall
app InstallApp!
uninstallApp Boolean
app String!
deleteApp Boolean
uuid String!
updateApp Boolean
uuid String!
releaseApp Boolean
release ReleaseApp!
updateInstalledAppSettings Boolean
uuid String!
settings String!
generateAppSecret String
uuid String
reserveAvailableTimeSlot Boolean
sessionToken String!
item String
startTimeInMillis Float!
endTimeInMillis Float!
organization String!
order String
releaseAvailableTimeSlot Boolean
sessionToken String!
item String
startTimeInMillis Float!
endTimeInMillis Float!
organization String!
order String
blockAvailableTimeSlot Boolean
startTimeInMillis Float!
endTimeInMillis Float!
organization String!
channel String!
location String
unblockAvailableTimeSlot Boolean
startTimeInMillis Float!
endTimeInMillis Float!
organization String!
channel String!
location String
redeemBooking Boolean
uuid String!
createBooking Booking
booking NewBooking!
updateBooking Booking
booking UpdateBooking!
registerCardAcceptor Boolean
uuid String!
cardAcceptor String!
addToCart LineItem

# GET routes

Arguments

  • id: Variant's id (optional)
sessionToken String!
channel String!
item String!
quantity String!
options [String]
language String
uiValues String
removeFromCart Boolean
sessionToken String!
channel String!
lineItem String!
queueToCart String
sessionToken String!
channel String!
item String!
quantity String!
language String
updateCategoryEpt eptUpdate
uuid String!
ept Int!
updateCategory Category
category UpdateCategory!
createCategory Category
category CreateCategory!
updateChannelEpt eptUpdate
uuid String!
organizationUuid String!
ept Int!
insertDisabledTimeSlot eptUpdate
organization String!
timeSlot timeSlot
deleteDisabledTimeSlot eptUpdate
organization String!
timeSlot timeSlot
processCheckoutStep ProcessCheckoutStepResult

# Process Checkout Step

Process a checkout step.

sessionToken String!
organization String!
channel String!
step String!
values [CheckoutSectionValues]
createCoupon Coupon
coupon NewCoupon!
updateCoupon Coupon
coupon UpdateCoupon
createCustomer Customer
customer NewCustomer!
updateCustomer Customer
customer UpdateCustomer
createDash Dash
collection String!
dash NewDash!
updateDash Dash
dash UpdateDash!
deleteDash Boolean
dash String!
createDashCollection DashCollection
name String!
updateDashCollection DashCollection
collection UpdateDashCollection!
createDeliveryMethodInstance DeliveryMethodInstance
deliveryMethodInstance NewDeliveryMethodInstance
updateDeliveryMethodInstance DeliveryMethodInstance
deliveryMethodInstance UpdateDeliveryMethodInstance
deliveryServiceProcessOrder Boolean
deliveryMethodInstance String
order NewOrder
newDeviceScreenshot Boolean
DeviceScreenshot NewDeviceScreenshot
registerDevice Device
Device NewDevice
sendDeviceMessage Boolean
DeviceMessage NewDeviceMessage
createEtag eTag
tag NewEtag!
updateEtag eTag
etag UpdateEtag!
claimEtag eTag
etag ClaimEtag!
releaseEtag Boolean
tagID String
saveFile File
file NewFile!
createItem Item
item NewItem!
updateItem Item
item UpdateItem
updateLocationEPT eptUpdate
organization String!
uuid String!
ept Int!
reserveLocationVariation Boolean
organization String!
channel String!
partnerKey String
locationVariation String
messageButtonAdd MessageButton
message NewMessageButton
organization String!
createMessage Message
message NewMessage!
createNote Note
note CreateNote!
saveNote Note
note UpdateNote!
deleteNote Boolean
uuid String!
updateOrderState Boolean
uuid String!
state OrderState!
createOrganization Organization
organization NewOrganization
removeUserFromOrganization Boolean
user RemoveUserFromOrganization
inviteUserToOrganization Response
user InviteUserToOrganization
signupOrganizationAndUser Response
signupOrganizationAndUser SignupOrganizationAndUser!
sendPushMessage Boolean
PushMessage NewPushMessage
createPayment PaymentTransaction
payment NewPayment!
cancelPayment PaymentTransaction
uuid String!
creditPayment PaymentTransaction
uuid String!
resolvePayment PaymentTransaction
uuid String!
smsMessageAdd printerSMSMessage
message NewSMSMessage
notifyPrintRecipient Boolean
message String
uuid String
createNewPrintJob Boolean
printJob NewPrintJob!
newAnonymousSession Session
updateSite Site
site UpdateSite
createSite Site
template CreateSite
deleteSite Boolean
site DeleteSite
createStaffLegacy Staff
staff NewStaff
updateStaff Staff
staff UpdateStaff
inviteStaffToWorkReview Boolean
uuid String!
optionalMessage String
createStockCollection StockCollection
name String!
resumeSubscription Boolean
uuid String!
notify Boolean
pauseSubscription Boolean
uuid String!
notify Boolean
cancelSubscription Boolean
uuid String!
notify Boolean
userInsert User
user NewUser
userClaims User
user NewClaims
userInvite User
invite UserInvite
userAvatar String
base64Image String
signInWithUsernameAndPassword AccessToken
username String!
password String!
state String!
scope String
signInWithEmailAndPassword AccessToken
email String!
password String!
state String!
scope String
resetPasswordByEmail Boolean
email String!
createWorkLegacy Work
work NewWork
updateWorkLegacy Work
work UpdateWork
adjustWorkForApproval Work
organization String!
ssn String!
pin String!
work UpdateWorkForApproval!
submitWorkForApproval Work
organization String!
ssn String!
pin String!
work NewWorkForApproval!
approveWork Boolean
organization String!
workId String!

# Objects

# AccessToken

Field Argument Type Description
token String!
expiresIn Int
state String!

# Acquirer

Field Argument Type Description
name String
website String
phone String
email String

# Address

Field Argument Type Description
name_line String
first_name String
last_name String
thoroughfare String
locality String
country String
sub_administrative_area String
administrative_area String
dependent_locality String
postal_code String
premise String
sub_premise String
organisation_name String

# Airline

Field Argument Type Description
name String
icao String
iata String
status Int

# Airport

Field Argument Type Description
name String
icao String
iata String
status Int

# App

Field Argument Type Description
uuid String
name String
group AppGroupKey
images [File]
author User
icon File
description String
shortDescription String
version String
url String
installed Boolean
system Boolean
dev_mode Boolean
settings String
config String
visibility AppVisibility
publicKey String
roles AppRoles
price Price
created Float
changed Float
defines AppDefinitions

# AppDefinitions

Field Argument Type Description
documentTypes [DocumentType]
configFields [InputField]
posFragments [PosFragment]
paymentMethods [PaymentMethod]

# AppError

Field Argument Type Description
id String
error_class String
message String
context String
severity String
events Int
unthrottled_occurrence_count Int
users Int
first_seen String
last_seen String
first_seen_unfiltered String
last_seen_unfiltered String
status String
release_stages [String]
serial_number String

# AppGroup

Field Argument Type Description
key String!
label String!

# AppInstall

Field Argument Type Description
version String!
installUUID String!
success Boolean!
code Int
message String
redirectUrl String

# AppLogic

Field Argument Type Description
app App
logic String!

# AppRelease

Field Argument Type Description
created Float
version Int
changeNotes String

# AppRoles

Field Argument Type Description
owner User
developers [User]
editors [User]

# AppSaveResponse

Field Argument Type Description
success Boolean

# Availability

Field Argument Type Description
current Int
target Int
threshold Int
infinite Boolean

# AvailableTimeSlot

Field Argument Type Description
label String!
timestampInMillis Float!
paddingInMillis Float!
reservedForCurrentSession Boolean
isBlocked Boolean!

# Billing

Field Argument Type Description
uuid String!
invoiceNumber String
totalAmount Price
balance Price
state BillingState
created Float

# Booking

Field Argument Type Description
uuid String!
item Item
booking_id Int
line_item_id String
lineItem LineItem
description String
customer Customer
customer_id Int
remote_id String
co Customer
created Float
changed Float
status String
redeemedAt Float
namespace String
organization ReferencedOrganization
startsAtTime Float
endsAtTime Float

# BooleanDeviceSetting

Field Argument Type Description
key String!
value Boolean!

# BooleanSetting

Field Argument Type Description
key String!
value Boolean
secure Boolean

# Category

Field Argument Type Description
uuid String!
name String!
weight Int
parent [Category]
required Boolean
single Boolean
administrative Boolean
opening_hours [OpeningHours]
ept Int
primary_color String
image Image
allowSplitByHalf Boolean

# Channel

Field Argument Type Description
uuid String!
label String!
description String
hostname String
created Int
changed Int
status Boolean
uid Int
checkin_buttons [CheckinButton]
ept String
data String

# ChannelOption

Field Argument Type Description
label String!
uuid String!
description String
hostname String
created Int
changed Int
status Boolean
ept String
data String

# CheckinButton

Field Argument Type Description
label String
value String

# CheckoutSection

Field Argument Type Description
namespace String!
title String!
description String!
uiFields [InputField]
configFields [InputField]

# CheckoutSectionError

Field Argument Type Description
namespace String!
uiField String!
message String!

# CheckoutSectionInstance

Field Argument Type Description
namespace String!
title String
description String
weight Int
collapsible Boolean
collapsed Boolean
review Boolean
enabled Boolean
step String
data String
uiFields [InputField]

# CheckoutSectionInstanceOption

Field Argument Type Description
title String!
description String
namespace String
uuid String!
step String!
weight Int
review Boolean
data String
uiFields [InputField]

# CheckoutSectionOption

Field Argument Type Description
namespace String!
title String!
description String!
uiFields [InputField]

# CheckoutStep

Field Argument Type Description
namespace String!
title String!
description String!
weight Int
enabled Boolean

# CheckoutStepOption

Field Argument Type Description
namespace String!
title String!
description String!

# Company

Field Argument Type Description
id ID!
label String
description String
ssn Int
phone String
created Int
changed Int
status Boolean

# Contact

Field Argument Type Description
name String
phone String

# Country

Field Argument Type Description
name String
code String

# Coupon

Field Argument Type Description
uuid String!
label String!
description String
code String!
maxRedemptions Int!
timesRedeemed Int!
discounts [Discount]
percentOff Float
validFrom Float
validUntil Float
effectiveStartingAtTimestampInMillis Float
effectiveEndingAtTimestampInMillis Float
validWeekdays [Int]
created Float!
changed Float!
active Boolean!

# CreditTransaction

Field Argument Type Description
uuid String!
dateInMillis Float!
createdInMillis Float!
label String!
key String
type DebitType!
namespace String!
amount Float!
currencyCode String!
channel String!
location String

# Currency

Field Argument Type Description
code String!
name String
code_placement String
code_spacer String
conversion_rate String
decimal_seperator String
major_unit String
minor_unit String
numeric_code Int
rounding_step Float
symbol String
symbol_spacer String
thousands_seperator String

# Customer

Field Argument Type Description
uuid String!
customer_id Int
label String
ssn String
email String
phone String
discount Int
address Address
created Float
changed Float
status String
language String
currency Currency
gender String
passport String
passport_expiration_date String
birthday String
exclusive Boolean
active Boolean

# CustomerProfile

Field Argument Type Description
uuid String!
label String!
description String
hostname String
created Int
changed Int
status Boolean
uid Int
checkin_buttons [CheckinButton]
ept String

# Dash

Field Argument Type Description
uuid String!
namespace String!
title String!
description String!
weight Int
cols Int
content String
data String

# DashCollection

Field Argument Type Description
uuid String!
name String!
dashes [Dash]
period DashCollectionPeriod
channel String
channels [String]
data String

# DashRender

Field Argument Type Description
type String!
content String!

# DashType

Field Argument Type Description
namespace String!
title String!
description String!
icon String!
configFields [InputField]
uiFields [InputField]

# DebitTransaction

Field Argument Type Description
uuid String!
dateInMillis Float!
createdInMillis Float!
label String!
key String
type DebitType!
namespace String!
amount Float!
currencyCode String!
channel String!
location String

# DefaultCardReaderDevice

Field Argument Type Description
address String
name String

# DeliveryMethod

Field Argument Type Description
namespace String!
title String!
short_description String!
description String!
icon String!
configFields [InputField]
uiFields [InputField]
app String!

# DeliveryMethodInstance

Field Argument Type Description
uuid String
title String!
namespace String!
description String
data String!
enabled Boolean
available DeliveryMethodInstanceAvailable
price Price
uiFields [InputField]

# DeliveryMethodInstanceAvailable

Field Argument Type Description
isAvailable Boolean
message String

# DeliveryMethodInstanceOption

Field Argument Type Description
uuid String
title String!
description String
namespace String
data String!
enabled Boolean
available DeliveryMethodInstanceAvailable
price Price
uiFields [InputField]

# DeliveryMethodInstanceProcessResult

Field Argument Type Description
success Boolean!
message String
internalBarcode String
externalBarcode String

# DeliverySummary

Field Argument Type Description
date String!
uuid String!
label String!
quantity Float

# Description

Field Argument Type Description
value String
summary String
format String

# Device

Field Argument Type Description
Board String
Brand String
BuildType String
DefaultChannel String
Display String
DnsServers [String]
FreeExternalMemory Float
FreeInternalMemory Float
FreeSystemMemory Float
IpAddress String
LastOffline Float
Manufacturer String
Model String
Product String
SDK Int
ScreenTimeOut Int
Timestamp Float
VersionCode Int
WifiSSID String
DeviceType HardwareModel
SerialNumber String
RegisteredByUser String
DefaultCardReaderDevice DefaultCardReaderDevice
MostRecentPrinterCommunicationMessage DeviceCommunicationMessage
MostRecentCardReaderCommunicationMessage DeviceCommunicationMessage
DeviceSettings DeviceSettings
Screenshot String
WifiList [WifiList]

# DeviceCommunicationMessage

Field Argument Type Description
Timestamp Float

# DeviceError

Field Argument Type Description
id String
error_class String
message String
context String
severity String
events Int
unthrottled_occurrence_count Int
users Int
first_seen String
last_seen String
first_seen_unfiltered String
last_seen_unfiltered String
status String
release_stages [String]
serial_number String

# DeviceEvent

Field Argument Type Description
SerialNumber String
Type String
Timestamp Float

# DeviceLog

Field Argument Type Description
SerialNumber String
Model String
Manufacturer String
Brand String
Board String
Display String
Product String
BuildType String
SDK Int
VersionCode String
FreeInternalMemory Float
FreeExternalMemory Float
FreeSystemMemory Float
Timestamp Float
DefaultChannel String
IpAddress String
LastOffline Float
WifiSSID String
Organization String
DnsServers [String]
DefaultCardReaderDevice DefaultCardReaderDevice
MostRecentPrinterCommunicationMessage DeviceCommunicationMessage
MostRecentCardReaderCommunicationMessage DeviceCommunicationMessage
InitialGraphData InitialGraphData
ActiveTab String

# DeviceSettings

Field Argument Type Description
booleans [BooleanDeviceSetting]
strings [StringDeviceSetting]

# DeviceSignup

Field Argument Type Description
SerialNumber String!
Username String!
Password String!
Processed Boolean

# Discount

Field Argument Type Description
discount_id String
name String
status Boolean
offer DiscountOffer
conditions [DiscountCondition]
compatibility_strategy String

# DiscountCondition

Field Argument Type Description
name String
negate Boolean
condition_logic_operator String
data String

# DiscountOffer

Field Argument Type Description
type String!
commerce_percentage String
percentage String
fixedAmount Price

# DiscountOption

Field Argument Type Description
uuid String
title String
type String
offer DiscountOffer
conditions [DiscountCondition]
compatibility_strategy String
commerce_compatibility_selection String

# DocumentType

Field Argument Type Description
namespace String!
title String!
description String!

# DocumentTypeOption

Field Argument Type Description
title String!
namespace String!

# EmailTemplate

Field Argument Type Description
name String
mjml String

# Event

Field Argument Type Description
key String!
name String!
mockData String

# File

Field Argument Type Description
filename String
mime String
size Float
url String
created Float
changed Float
public Boolean

# FormOfPayment

Field Argument Type Description
uuid String
customer Customer
paymentMethod String
paymentMethodInstance PaymentMethodInstance
remoteID String
amount Float
cardType String
cardName String
expiryMonth Int
expiryYear Int
created Float
changed Float
active Boolean

# Giftcard

Field Argument Type Description
remoteID String!
amount Float
expiryMonth String
expiryYear String
cardType String
created Float
changed Float
paymentMethod String
paymentMethodInstance PaymentMethod
active Boolean
customer Customer
organization ReferencedOrganization

# HardwareModel

Field Argument Type Description
name String
sku String
model String
type String
manufacturer String
description String
image String
available Boolean

# Image

Field Argument Type Description
title String
alt String
file LegacyFile

# InitialGraphData

Field Argument Type Description
installedAppLogic [AppLogic]

# InputField

Field Argument Type Description
key String!
type InputFieldType!
label String!
description String
required Boolean
value String
cols Int
placeholder String
hint String
options [InputOption]
group InputFieldGroup
multiple Boolean

# InputFieldGroup

Field Argument Type Description
key String!
label String!

# InputOption

Field Argument Type Description
key String
label String!

# IntegerSetting

Field Argument Type Description
key String!
value Int
secure Boolean

# Invoice

Field Argument Type Description
html String
pdf String
number String
invoiceNumber String
amount String
date String
lineItems [LineItem]
organization ReferencedOrganization

# Item

Field Argument Type Description
uuid String
vuuid String
sku String!
title String!
barcode String
description Description
type String!
namespace String!
created Float
changed Float
start_date Float
end_date Float
language String!
status Boolean!
price Price
cost_price Price
sale_price Price
recurring_price Price
exclude_discounts Boolean
inital_price Price
categories [Category]
sorting_weight Int
terms_and_conditions Description
availability Availability
images [Image]
organization ReferencedOrganization
variations [Variation]
default_variations [Variation]
uiValues String

# ItemOption

Field Argument Type Description
uuid String!
title String!
barcode String
sku String!
type String!
namespace String!
price Price!
sale_price Price
description Description
status Boolean!
sorting_weight Int
images [Image]
variations [VariationOption]
categories [Category]
default_variations [VariationOption]
exclude_discounts Boolean

# ItemType

Field Argument Type Description
namespace String!
title String!
short_description String!
description String!
icon String!
configFields [InputField]
uiFields [InputField]

# LegacyFile

Field Argument Type Description
fid ID!
name String
mime String
size Int
type String
timestamp Int
uuid String
sources Sources

# LineItem

Field Argument Type Description
line_item_label String
label String
type String
item Item
namespace String
quantity String
channel String
location Location
created Float
changed Float
status String
printed Boolean
processed Boolean
unitPrice Price
totalPrice Price
entangleKey String
deliveryDate Float
locked Boolean
uuid String
dynamicDescription String
bookings [Booking]
data String
externalBarcode String

# LineItemType

Field Argument Type Description
namespace String!
title String!
short_description String!
description String!
icon String!
configFields [InputField]
uiFields [InputField]

# LocaleString

Field Argument Type Description
key String
text String

# Location

Field Argument Type Description
uuid String!
label String!
description String
address Address
opening_hours [OpeningHours]
opening_rule String
variations [LocationVariation]
active Boolean
created Float
changed Float
ept Int

# LocationOption

Field Argument Type Description
uuid String!
label String!
description String
address Address
opening_hours [OpeningHours]
opening_rule String
variations [LocationVariation]
ept Int

# LocationVariation

Field Argument Type Description
label String
status Boolean
uuid Int
zone Category
shape String
x Float
y Float
created Float
changed Float

# Message

Field Argument Type Description
uuid String!
namespace String!
origin String
destination String
created Float
changed Float
time_of_departure Float
time_of_arrival Float
state MessageState!
content String
remote_id String
message String
payload String
params String
context String
type MessageType!

# MessageButton

Field Argument Type Description
label String!
text String!
uuid String!

# MessengerMethod

Field Argument Type Description
namespace String!
title String!
short_description String!
description String!
icon String!
configFields [InputField]
uiFields [InputField]
app String!

# MessengerMethodInstance

Field Argument Type Description
uuid String
label String
description String
method_id String
created Int
changed Int
is_default Boolean

# Note

Field Argument Type Description
uuid String!
title String
body String
created Int
changed Int
author String!
state String!

# OpeningHours

Field Argument Type Description
day String!
starthours String
endhours String
comment String

# Order

Field Argument Type Description
email String
billingInformation CustomerProfile
shippingInformation CustomerProfile
type String!
orderId String!
created Float!
changed Float!
state String!
lineItems [LineItem]
payments [PaymentTransaction]
balance Price
orderTotal Price
tasks String
data String
entangleKey String!
deliveryTime Float
deliveryService DeliveryMethodInstance
location LocationOption
channel ChannelOption
uuid String!
owner Customer
externalBarcode String

# OrderStateOption

Field Argument Type Description
key String
name String

# Organization

Field Argument Type Description
label String
uuid String
email String
description String
phone String
logo Image
primary_color String
accent_color String
address Address
settings Settings

# OrganizationRole

Field Argument Type Description
name String
role_id Int

# ParentCategory

Field Argument Type Description
uuid String
name String
weight Int

# Partner

Field Argument Type Description
uuid String!
name String!
email String!
phone String!
website String!
logo String!

# PartnerOrganization

Field Argument Type Description
uuid String!
label String!
description String
primary_color String
accent_color String

# PaymentMethod

Field Argument Type Description
namespace String!
title String!
short_description String
description String
icon String
configFields [InputField]
uiFields [InputField]
app String!

# PaymentMethodInstance

Field Argument Type Description
namespace String!
uuid String!
checkout Boolean
terminal Boolean
status Boolean
icon String
title String
description String
short_description String
data String
uiFields [InputField]

# PaymentMethodInstanceOption

Field Argument Type Description
icon String
title String!
description String
namespace String!
uuid String!
checkout Boolean
terminal Boolean
uiFields [InputField]

# PaymentMethodOption

Field Argument Type Description
namespace String!
title String!
short_description String
description String
icon String
uiFields [InputField]
app String!

# PaymentState

Field Argument Type Description
key String
group String
name String

# PaymentTransaction

Field Argument Type Description
uuid String!
amount String!
currency_code String!
namespace String!
instance PaymentMethodInstance!
payload String
created Float!
changed Float!
status PaymentTransactionStatus!
remoteId String
verified Boolean
message String
friendlyMessage String
channel Channel
location Location
customer Customer

# Person

Field Argument Type Description
uuid String!
type String!
address Address
email String
phone String
created Int
changed Int
status Boolean

# Platform

Field Argument Type Description
key String
name String
url String
path String
icon String

# PosFragment

Field Argument Type Description
namespace String!
title String!
description String!

# PosFragmentOption

Field Argument Type Description
title String!
namespace String!

# Price

Field Argument Type Description
amount Float
currency_code String

# PriceComponent

Field Argument Type Description
amount Float!
currency_code String!

# PriceData

Field Argument Type Description
components [PriceComponent]

# PrintJob

Field Argument Type Description
UUID String
MacAddress String
Organization String
Channel String
Type String
Content String
StatusCode String
Timestamp Float
CheckinButtons [CheckinButton]

# ProcessCheckoutStepResult

Field Argument Type Description
success Boolean!
message String!
errorLevel Int
errors [CheckoutSectionError]

# Queue

Field Argument Type Description
pending String
position String
request Request

# Receipt

Field Argument Type Description
html String
pdf String
number String
invoiceNumber String
amount String
date String
lineItems [LineItem]
organization ReferencedOrganization

# RecurringSubscription

Field Argument Type Description
uuid String!
label String
item Item!
payer Customer!
receiver Customer!
recurringPrice Price
nextPayment Float
paused Boolean
quantity Float!
discount Int
cycle Int!
expires Float
created Float
changed Float
active Boolean

# ReferencedOrganization

Field Argument Type Description
uuid String
label String
phone String
email String
primary_color String
accent_color String
logo Image

# Request

Field Argument Type Description
status String
url String

# Response

Field Argument Type Description
success Boolean
text String

# Role

Field Argument Type Description
role_id Int!
name String!

# Route

Field Argument Type Description
icon String
title String!
path String!
template String
group String
platform String!
weight Int
routes [Route]
type RouteType!

# RunAppResult

Field Argument Type Description
success Boolean
logs [String]

# Service

Field Argument Type Description
key String
name String
description String
isPlatform Boolean

# Session

Field Argument Type Description
session_token String
ttl Int
error_code Int
cart String
expiresAt Float

# Settings

Field Argument Type Description
booleans [BooleanSetting]
strings [StringSetting]
stringLists [StringListSetting]
integers [IntegerSetting]

# Site

Field Argument Type Description
site_name String
template_id Int
preview_site_url String
force_https Boolean
lang String
publish_status String

# SiteTemplate

Field Argument Type Description
template_name String
preview_url String
thumbnail_url String
desktop_thumbnail_url String
template_id Int

# Sources

Field Argument Type Description
original String
medium String
large String
thumbnail String

# Staff

Field Argument Type Description
uuid String
person_id String
label String
address Address
ssn String
phone String
email String
employment String
pin String
is_pos_admin Boolean
allowed_discounts [Int]
created Float
changed Float
active Boolean
standardRate Price
eveningRate Price
weekendRate Price
publicHolidayRate Price
majorPublicHolidayRate Price

# StockCollection

Field Argument Type Description
uuid String!
name String!
entries [StockEntry]

# StockEntry

Field Argument Type Description
currentStock String!
unitOfMeasure String!
unitOfChange String!

# StringDeviceSetting

Field Argument Type Description
key String!
value String!

# StringListSetting

Field Argument Type Description
key String!
value [String]!
secure Boolean

# StringSetting

Field Argument Type Description
key String!
value String!
secure Boolean

# Tax

Field Argument Type Description
uuid String!
title String!
description String
namespace String!
rate Float!
priceComponent String!
displayTitle String!

# TaxonomyTerm

Field Argument Type Description
tid Int
name String
vid String

# Team

Field Argument Type Description
role_id Int
organization String
user User

# User

Field Argument Type Description
uid String
displayName String
email String
emailVerified Boolean
isAnonymous Boolean
metadata UserMetadata
providerId String
refreshToken String
phoneNumber String
photoUrl String
lastSignIn String
customClaims UserClaims
organization Organization
active Boolean
isDevice Boolean

# UserClaims

Field Argument Type Description
admin Boolean

# UserMetadata

Field Argument Type Description
creationTime String
lastSignInTime String

# Variant

Field Argument Type Description
id ID!
name String!
shortDescription String

# Variation

Field Argument Type Description
_id ID!
uuid String!
label String!
description String
created Float
changed Float
type String!
status Boolean
sorting_weight Int
price Price
attribute Category
is_default Boolean
cost_price Price
availability Availability

# VariationOption

Field Argument Type Description
_id ID!
uuid String!
label String!
attribute Category
price Price
default Boolean
sorting_weight Int
created Float
changed Float
type String
status Boolean
owner String
owner_id String

# Widget

Field Argument Type Description
_id ID!
label String!
description String
namespace String!
created Float
changed Float
active Boolean

# WifiList

Field Argument Type Description
SSID String!

# Work

Field Argument Type Description
uuid String!
label String
type String!
staff Staff!
start_date Float
end_date Float
standard_hours Float
evening_hours Float
weekend_hours Float
festive_hours Float
public_holiday_hours Float
total_hours Float
standard_rate Price
evening_rate Price
weekend_rate Price
festive_rate Price
total_cost Price
created Int
changed Int
channel Channel
location Location
status Boolean
requiresApproval Boolean

# eTag

Field Argument Type Description
uuid String!
tagID String!
type String!
property String!
unitID String
organization String

# eptUpdate

Field Argument Type Description
success Boolean!
message String

# printerSMSMessage

Field Argument Type Description
uid String
message String
organizationUUID String
printerMacAdress String
timestamp Int

# timeSlotOption

Field Argument Type Description
timestamp Float!
label String
active Boolean

# Inputs

# AppUser

Field Type Description
email String

# CheckoutSectionValues

Field Type Description
namespace String!
data String!

# ClaimEtag

Field Type Description
tagID String!
channel String!
paymentInstance String!
unit String!
location String!
categories [String]
hideListPictures Boolean
singlePageCategories Boolean
landingPage Boolean
showWaitingTime Boolean
showSubCategoryMenu Boolean
showOtherItems Boolean
disableVariationSelection Boolean
language String
currencyFormatRule String
hideClosedCategories Boolean
hideItemDetails Boolean
singlePageVariations Boolean
primaryColor String
accentColor String
include [String]
exclude [String]
excludeCategories [String]

# CreateCategory

Field Type Description
uuid String
name String
description DescriptionInput

# CreateNote

Field Type Description
title String
body String
created Int
changed Int
state String

# CreateSite

Field Type Description
template_id Int!

# CustomerCurrency

Field Type Description
code String

# DeleteSite

Field Type Description
site_name String!

# DescriptionInput

Field Type Description
value String
summary String
format String

# DeviceCommand

Field Type Description
Type String!
Value String!

# ExistingFile

Field Type Description
filename String!

# InstallApp

Field Type Description
uuid String!
version String
settings String

# InviteUserToOrganization

Field Type Description
email String!
displayName String!
phone String!
role_id String!
password String

# ItemReference

Field Type Description
quantity Float!
uuid String!

# NewAddress

Field Type Description
name_line String
first_name String
last_name String
thoroughfare String
locality String
country String
sub_administrative_area String
administrative_area String
dependent_locality String
postal_code String
premise String
sub_premise String
organisation_name String

# NewApp

Field Type Description
name String!
description String!
icon String!
visibility String!
group String!

# NewBooking

Field Type Description
uuid String
item String!
booking_id Int
line_item String
description String
customer String!
co String
remote_id String
namespace String!
created Float
changed Float
status String
startsAtTime Float
endsAtTime Float
sendTicket Boolean

# NewClaims

Field Type Description
uid String!
claims NewInputClaims!

# NewCoupon

Field Type Description
label String!
description String
code String!
maxRedemptions Int!
timesRedeemed Int!
percentOff Float
effectiveStartingAtTimestampInMillis Float
effectiveEndingAtTimestampInMillis Float
validWeekdays [Int]
active Boolean!

# NewCustomer

Field Type Description
uuid String
customer_id Int
label String
ssn String
email String
phone String
discount Int
address NewAddress
created Float
changed Float
status String
language String
currency CustomerCurrency
gender String
passport String
passport_expiration_date String
birthday String
exclusive Boolean
active Boolean

# NewDash

Field Type Description
namespace String!
title String!
description String!
data String
cols Int

# NewDeliveryMethodInstance

Field Type Description
title String!
namespace String!
description String
data String
enabled Boolean!

# NewDevice

Field Type Description
SerialNumber String

# NewDeviceMessage

Field Type Description
SerialNumber String!
DeviceCommand DeviceCommand!

# NewDeviceScreenshot

Field Type Description
SerialNumber String!
Screenshot String!

# NewEtag

Field Type Description
tagID String!
channel String!
paymentInstance String!
unit String!
location String!
categories [String]
hideListPictures Boolean
singlePageCategories Boolean
landingPage Boolean
showWaitingTime Boolean
showSubCategoryMenu Boolean
showOtherItems Boolean
disableVariationSelection Boolean
language String
currencyFormatRule String
hideClosedCategories Boolean
hideItemDetails Boolean
singlePageVariations Boolean
primaryColor String
accentColor String
include [String]
exclude [String]
excludeCategories [String]

# NewFile

Field Type Description
filename String!
base64Data String!
public Boolean!
global Boolean

# NewInputClaims

Field Type Description
admin Boolean

# NewItem

Field Type Description
sku String!
title String!
type String
barcode String
categories [String]
price PriceInput
cost_price PriceInput
sale_price PriceInput
description DescriptionInput
sorting_weight Int
status Boolean
uiValues String

# NewLineItem

Field Type Description
quantity Float!
unitPrice PriceInput!
item String!

# NewMessage

Field Type Description
uuid String!
namespace String!
origin String!
destination String!
created Float
changed Float
time_of_departure Float
time_of_arrival Float
state MessageState!
content String
remote_id String
message String
payload String
params String
type MessageType!
context String

# NewMessageButton

Field Type Description
label String!
text String!
uuid String!

# NewOrder

Field Type Description
email String
uuid String
entangleKey String
deliveryTime Float
location String
channel String
lineItems [NewLineItem]
orderTotal PriceInput

# NewOrganization

Field Type Description
label String!
description String
email String
phone String
tax_id String
vat_id String
primary_color String
accent_color String
currencies [String]
default_currency String
default_language String
vat [String]
address NewAddress

# NewPayment

Field Type Description
uuid String!
amount String!
currency_code String!
namespace String!
instance String
payload String
created Float
changed Float
status PaymentTransactionStatus
remote_id String
verified Boolean
message String
order String
acquirer String
channel String
details String
entangle_key String
friendly_message String
process String
remote_status String
resolved Boolean
response_code String
serial_number String
type String

# NewPrintJob

Field Type Description
MacAddress String!
Phone String
Channel String
Content String

# NewPushMessage

Field Type Description
Authkey String!
Message String!
Topic String!

# NewSMSMessage

Field Type Description
uid String!
message String!
organizationUUID String
printerMacAdress String!
timestamp Int

# NewSession

Field Type Description
username String
password String

# NewStaff

Field Type Description
uuid String
person_id String
label String
address NewAddress
ssn String
employment String
phone String
email String
pin String
is_pos_admin Boolean
allowed_discounts [Int]
created Float
changed Float
active Boolean
standardRate PriceInput
eveningRate PriceInput
weekendRate PriceInput
publicHolidayRate PriceInput
majorPublicHolidayRate PriceInput

# NewUser

Field Type Description
email String!
displayName String!
password String!

# NewWork

Field Type Description
uuid String
label String
type String
staff String
start_date String
end_date String

# NewWorkForApproval

Field Type Description
staff String
start_date Float
end_date Float

# PaymentRequest

Field Type Description
amount Int
currency_code String
payment_method String
status String

# PriceInput

Field Type Description
amount Float
currency_code String

# ReleaseApp

Field Type Description
uuid String!
changeNotes String!

# RemoveUserFromOrganization

Field Type Description
uid String!
organization String!

# SaveApp

Field Type Description
name String!
description String!
shortDescription String
uuid String!
logic String!
author String
owner AppUser
developers [AppUser]
editors [AppUser]
group String!
url String
active Boolean
dev_mode Boolean
visibility String!
publicKey String
created Float
changed Float

# SaveAppRoles

Field Type Description
owner AppUser!
developers [AppUser]
editors [AppUser]

# SaveAppSettings

Field Type Description
name String!
description String!
group String!
visibility String!
price PriceInput
icon ExistingFile
dev_mode Boolean
images [ExistingFile]

# SignupOrganizationAndUser

Field Type Description
organizationName String!
organizationCountry String!
userEmail String!
userPassword String!
userDisplayName String!

# UpdateBooking

Field Type Description
uuid String!
item String!
booking_id Int
customer String!
co String
remote_id String
namespace String!
created Float
changed Float
status Boolean
startsAtTime Float
endsAtTime Float
sendTicket Boolean

# UpdateCategory

Field Type Description
uuid String
name String
description DescriptionInput

# UpdateCoupon

Field Type Description
uuid String!
label String!
description String
maxRedemptions Int!
timesRedeemed Int!
percentOff Float
effectiveStartingAtTimestampInMillis Float
effectiveEndingAtTimestampInMillis Float
validWeekdays [Int]
active Boolean!

# UpdateCustomer

Field Type Description
uuid String
customer_id Int
label String
ssn String
email String
phone String
discount Int
address NewAddress
created Float
changed Float
status String
language String
currency CustomerCurrency
gender String
passport String
passport_expiration_date String
birthday String
exclusive Boolean
active Boolean

# UpdateDash

Field Type Description
uuid String!
title String
description String
data String
weight Int
cols Int

# UpdateDashCollection

Field Type Description
uuid String!
name String
period DashCollectionPeriod
channel String
channels [String]
data String

# UpdateDeliveryMethodInstance

Field Type Description
uuid String!
title String
description String
data String
enabled Boolean

# UpdateEtag

Field Type Description
tagID String!
channel String
paymentInstance String
unit String
location String
categories [String]
hideListPictures Boolean
singlePageCategories Boolean
landingPage Boolean
showWaitingTime Boolean
showSubCategoryMenu Boolean
showOtherItems Boolean
disableVariationSelection Boolean
language String
currencyFormatRule String
hideClosedCategories Boolean
hideItemDetails Boolean
singlePageVariations Boolean
primaryColor String
accentColor String
include [String]
exclude [String]
excludeCategories [String]

# UpdateItem

Field Type Description
uuid String!
sku String
title String
barcode String
categories [String]
price PriceInput
cost_price PriceInput
sale_price PriceInput
description DescriptionInput
sorting_weight Int
status Boolean
uiValues String

# UpdateNote

Field Type Description
uuid String!
title String
body String
created Int
changed Int
state String

# UpdateSite

Field Type Description
external_uid String!
site_name String!

# UpdateStaff

Field Type Description
uuid String!
person_id String
label String
address NewAddress
ssn String
employment String
phone String
email String
pin String
is_pos_admin Boolean
allowed_discounts [Int]
created Float
changed Float
active Boolean
standardRate PriceInput
eveningRate PriceInput
weekendRate PriceInput
publicHolidayRate PriceInput
majorPublicHolidayRate PriceInput

# UpdateWork

Field Type Description
uuid String
label String
type String
staff String
start_date String
end_date String

# UpdateWorkForApproval

Field Type Description
uuid String!
start_date Float
end_date Float

# UserInvite

Field Type Description
email String!
displayName String!
role_id Int!

# timeSlot

Field Type Description
timestamp Float!
label String
active Boolean

# Enums

# AppDefinition

Value Description
paymentMethod
messengerMethod
deliveryMethod
itemType
documentType
lineItemType
workJob

# AppGroupKey

Value Description
point_of_sale
hospitality
payment_method
messenger_method
mapping_method
accounting
analytics
dashlet
ecommerce
delivery
marketing
scheduling
printing
documents
calendar

# AppVisibility

Value Description
public
private
secret
closed

# BillingState

Value Description
canceled
new
paid
pending
billing_pending_payment

# CreditType

Value Description
sale

# DashCollectionPeriod

Value Description
today
yesterday
current_month
current_week
previous_month
previous_week
custom

# DashRenderType

Value Description
html
singleValue
gchart

# DebitType

Value Description
payment

# InputFieldType

Value Description
password
checkbox
textarea
textfield
address
country
email
phone
select
text
date
number
calendar
radios
buttons
price
dimension
weight
switch
channels
channel
timezones
timezone
locations
location

# MessageState

Value Description
delivered
failure
pending

# MessageType

Value Description
push
pull

# OrderState

Value Description
pending
cart
checkout
new
processing
completed
delivered
billing_pending_payment
billing_pending_line_item

# PaymentTransactionStatus

Value Description
success
failure
pending

# QuerySort

Value Description
asc
desc

# RouteType

Value Description
nativeNormal
nativeDynamic
foreignNormal
foreignDynamic
nativeHidden

# Scalars

# Boolean

The Boolean scalar type represents true or false.

# Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754 (opens new window).

# ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

# Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

# String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.