# Schema Types
Table of Contents
- Query
- Mutation
- Objects
- AccessToken
- Acquirer
- Address
- Airline
- Airport
- App
- AppDefinitions
- AppError
- AppGroup
- AppInstall
- AppLogic
- AppPartnerDiscount
- AppProfile
- AppProfileGroup
- AppRelease
- AppRoles
- AppSaveResponse
- AppUninstall
- AppUser
- AppUserBooking
- AppUserCardOnFile
- AppUserCoupon
- AppUserDiscount
- AppUserGiftcard
- AppUserOrder
- AppUserSignin
- Availability
- AvailableTimeSlot
- Billing
- BlockedBookingDay
- BlockedTimeSlot
- Booking
- BookingOption
- BookingsCount
- BooleanDeviceSetting
- BooleanSetting
- BulkOperation
- BulkOperationResult
- CallToAction
- CallToActionResult
- Category
- CategoryDiscount
- Channel
- ChannelOption
- CheckinButton
- CheckoutSection
- CheckoutSectionError
- CheckoutSectionInstance
- CheckoutSectionInstanceOption
- CheckoutSectionOption
- CheckoutStep
- CheckoutStepOption
- Company
- Country
- Coupon
- CouponAwardingCondition
- CouponResponse
- CreditTransaction
- CreditUsage
- Currency
- Customer
- CustomerProfile
- Dash
- DashAlert
- DashCollection
- DashRender
- DashType
- DebitCredit
- DebitTransaction
- DefaultCardReaderDevice
- DeliveryMethod
- DeliveryMethodInstance
- DeliveryMethodInstanceAvailable
- DeliveryMethodInstanceOption
- DeliveryMethodInstanceProcessResult
- DeliverySummary
- Description
- Device
- DeviceCommunicationMessage
- DeviceError
- DeviceEvent
- DeviceLog
- DeviceSettingCategory
- DeviceSettings
- DeviceSignup
- Dimensions
- Discount
- DiscountCondition
- DiscountOffer
- DiscountOption
- Distance
- DocumentType
- DocumentTypeOption
- EmailTemplate
- Event
- ExternalDeliveryResult
- File
- FormOfPayment
- GPS
- Gate
- GateLog
- GateSettings
- Giftcard
- GoLive
- HardwareModel
- HeroSignIn
- HeroUser
- Image
- InitialGraphData
- InputField
- InputFieldGroup
- InputOption
- IntegerSetting
- Invoice
- InvoiceDocument
- Item
- ItemLocationBlock
- ItemOption
- ItemType
- LegacyFile
- LineItem
- LineItemType
- LocaleString
- Location
- LocationOption
- LocationStock
- LocationVariation
- LocationVariationCombination
- LocationZone
- Mapping
- MarketPlace
- Menu
- Message
- MessageButton
- MessengerMethod
- MessengerMethodInstance
- NewYessUserResult
- OpeningHours
- Order
- OrderOption
- OrderReference
- OrderStateOption
- Organization
- OrganizationRole
- ParentCategory
- PayLinkEvent
- PaymentBatch
- PaymentBatchItem
- PaymentMethod
- PaymentMethodInstance
- PaymentMethodInstanceOption
- PaymentMethodOption
- PaymentState
- PaymentTransaction
- Platform
- PosFragment
- PosFragmentOption
- Price
- PriceComponent
- PriceData
- PrintJob
- Printer
- ProcessCheckoutStepResult
- ProcessDisplaySystem
- Puck
- PuckPing
- PunchCard
- PunchCardOffer
- PunchCardTemplate
- Queue
- ReadAccessToken
- Receipt
- RecurringPeriod
- RecurringSubscription
- RedeemBooking
- RedeemedCoupon
- ReferencedOrganization
- Request
- ReservationWidget
- Response
- Role
- Route
- RouteTab
- RuleAction
- RuleCondition
- RuleEvent
- RunAppResult
- ScheduleWidget
- SeasonalDuration
- SeasonalPrice
- Service
- Session
- Settings
- Shift
- Site
- SiteTemplate
- Slot
- SoftPos
- Sources
- Staff
- StateColors
- StatusResponse
- StockEntry
- StreamEntry
- StringDeviceSetting
- StringListSetting
- StringSetting
- Subscription
- SubscriptionState
- Tablet
- Task
- TaxRate
- TaxonomyTerm
- Team
- TestSub
- TimeSlotReservationResult
- TransactionResponse
- TranslatedContent
- Translation
- User
- UserClaims
- UserMetadata
- ValidHours
- Variant
- Variation
- VariationOption
- VerifyCheckoutResult
- Video
- WaitingGuest
- WeekdayDuration
- WeekdayPrice
- Weight
- Widget
- WifiList
- WithdrawalPerson
- Work
- eTag
- eptUpdate
- notifyPrintRecipientResult
- printerSMSMessage
- timeSlotOption
- Inputs
- CartItem
- CheckoutSectionValues
- ClaimEtag
- ContactOrganization
- ContactSalesCloud
- CreateCategory
- CreateSite
- CustomerCurrency
- DeleteSite
- DescriptionInput
- DeviceCommand
- ExistingFile
- ImageInput
- InstallApp
- InviteUserToOrganization
- ItemReference
- NewAddress
- NewApp
- NewAppUser
- NewBooking
- NewChannel
- NewClaims
- NewCommitLineItem
- NewCoupon
- NewCustomer
- NewDash
- NewDeliveryMethodInstance
- NewDevice
- NewDeviceMessage
- NewDeviceScreenshot
- NewEtag
- NewFile
- NewGPS
- NewGateLog
- NewGiftcard
- NewGiftcards
- NewHeroUser
- NewInputClaims
- NewItem
- NewLineItem
- NewLocation
- NewLocationVariation
- NewLocationVariationCombination
- NewLocationZone
- NewMessage
- NewMessageButton
- NewOpeningHours
- NewOrder
- NewOrganization
- NewPaymentTransaction
- NewPosLineItem
- NewPosOrder
- NewPrintJob
- NewProcessDisplaySystem
- NewPuck
- NewPuckPing
- NewPushMessage
- NewReservationWidget
- NewSMSMessage
- NewScheduleWidget
- NewSeasonalDuration
- NewSeasonalPrice
- NewServicePrintJob
- NewSession
- NewShift
- NewSlot
- NewSort
- NewStaff
- NewTableGuest
- NewTranslatedContent
- NewTranslation
- NewUser
- NewWeekdayDuration
- NewWeekdayPrice
- NewWork
- NewWorkForApproval
- NewYessGroup
- NewYessPartnerDiscount
- NewYessProfile
- NewYessUser
- PaymentRequest
- PriceInput
- PunchCardNew
- PunchCardTemplateNew
- PunchCardTemplateUpdated
- PunchCardUpdated
- QueryCondition
- ReleaseApp
- RemoveUserFromOrganization
- RescheduleBooking
- SaveApp
- SaveAppRoles
- SaveAppSettings
- SignupOrganizationAndUser
- TranslationItem
- UpdateBooking
- UpdateCategory
- UpdateChannel
- UpdateCoupon
- UpdateCustomer
- UpdateDash
- UpdateDashCollection
- UpdateDeliveryMethodInstance
- UpdateEtag
- UpdateFormOfPayment
- UpdateGiftcard
- UpdateHeroUser
- UpdateItem
- UpdateItemSortingWeight
- UpdateLineItem
- UpdateLocation
- UpdateLocationVariation
- UpdateLocationZone
- UpdateParentCategory
- UpdatePosOrder
- UpdateProcessDisplaySystem
- UpdateRecurringSubscription
- UpdateReservationWidget
- UpdateScheduleWidget
- UpdateSite
- UpdateSlot
- UpdateStaff
- UpdateStateColors
- UpdateWork
- UpdateWorkForApproval
- UpdateYessGroup
- UpdateYessProfile
- UpdatedLocationVariationCombination
- UserInvite
- YessClubRegistration
- YessRegistration
- YessUserLogin
- newValidHours
- timeSlot
- Enums
- AppDefinition
- AppGroupKey
- AppProfileType
- AppVisibility
- BillingAccountState
- BillingState
- BookingOrigin
- BookingState
- BusinessType
- CouponAwardingMechanism
- CreditType
- DashCollectionPeriod
- DashRenderType
- DebitType
- InputFieldType
- ItemReservationMode
- LedgerType
- LocationOpeningRule
- MeasureOfDistance
- MessageState
- MessageType
- OrderState
- PaymentBatchItemState
- PaymentBatchState
- PaymentTransactionStatus
- QueryOperator
- QuerySort
- RouteType
- TaskState
- UnitOfMeasure
- WorkType
- Scalars
# Query
| Field | Argument | Type | Description |
|---|---|---|---|
| readAccessToken | ReadAccessToken | # GET routesArguments
| |
| tokenUUID | String! | ||
| organizationUUID | String | ||
| readAccessTokens | [ReadAccessToken] | ||
| organizationUUID | String | ||
| acquirers | [Acquirer] | # GET routesArguments
| |
| airlines | [Airline] | # GET routesArguments
| |
| airports | [Airport] | # GET routesArguments
| |
| apps | [App] | # GET routesArguments
| |
| 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 routesArguments
| |
| uuid | String! | ||
| allAttributes | [Category] | ||
| availableTimeSlots | [AvailableTimeSlot] | # GET Available Time Slots for an itemArguments
| |
| sessionToken | String! | ||
| category | String | ||
| item | String | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| organization | String! | ||
| channel | String! | ||
| location | String | ||
| locationVariation | String | ||
| deliveryService | String | ||
| order | String | ||
| items | [ItemReference] | ||
| interval | Int | ||
| quantity | Int | ||
| openingRule | LocationOpeningRule | ||
| blockedTimeSlots | [BlockedTimeSlot] | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| findNextAvailableLocationVariations | [LocationVariation] | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| item | String! | ||
| location | String! | ||
| quantity | Int! | ||
| billing | [Billing] | # GET BillingReturns an organizations invoices for SalesCloud usage Arguments | |
| billingAccountState | BillingAccountState | ||
| availableCredit | Price | ||
| bookings | [Booking] | # Get bookingsArguments
| |
| item | String | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| conditions | [QueryCondition] | ||
| booking | Booking | ||
| bookingUUID | String! | ||
| organizationUUID | String | ||
| bookingByID | Booking | ||
| bookingID | String! | ||
| organizationUUID | String! | ||
| String! | |||
| datesWithBookings | [String] | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| location | String | ||
| bookingsByOrder | [Booking] | ||
| organization | String | ||
| order | String | ||
| key | String | ||
| bookingsCountByItem | Int | ||
| organization | String! | ||
| item | String! | ||
| location | String | ||
| category | String | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| bookingsCountPerDay | [BookingsCount] | ||
| organization | String | ||
| item | String | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| location | String | ||
| bookingsGetBlockedDays | [BlockedBookingDay] | ||
| organization | String | ||
| location | String | ||
| bulkOperations | [BulkOperation] | # GET routesArguments
| |
| callToActions | [CallToAction] | # GET routesArguments
| |
| organizationByCardAcceptor | String | ||
| cardAcceptor | String! | ||
| cart | Order | ||
| sessionToken | String! | ||
| channel | String! | ||
| cartQueue | Queue | ||
| uuid | String | ||
| category | Category | # GET routesArguments
| |
| uuid | String! | ||
| categories | [Category] | ||
| type | String! | ||
| uuid | String | ||
| attributes | [Category] | ||
| organization | String | ||
| channel | ChannelOption | # GET routesArguments
| |
| organization | String! | ||
| uuid | String! | ||
| channelsList | [ChannelOption] | ||
| organization | String | ||
| checkinButton | [CheckinButton] | ||
| checkoutSections | [CheckoutSection] | # GET routesArguments
| |
| uuid | String | ||
| checkoutSectionList | [CheckoutSectionOption] | ||
| organization | String! | ||
| checkoutSectionInstances | [CheckoutSectionInstance] | # GET routesArguments
| |
| organization | String! | ||
| channel | String! | ||
| checkoutSectionInstanceList | [CheckoutSectionInstanceOption] | # CheckoutSectionInstanceListGet a list of channel checkout sections on an organization Arguments
| |
| organization | String! | ||
| channel | String! | ||
| order | String | ||
| quantity | Float | ||
| unmanagedObject | String | ||
| disabledTimeSlots | [timeSlotOption] | ||
| organization | String! | ||
| date | String | ||
| checkoutSteps | [CheckoutStep] | # Checkout StepsGet a list of checkout steps. | |
| checkoutStepList | [CheckoutStepOption] | # Checkout StepsGet a list of checkout step options. | |
| organization | String! | ||
| companies | [Company] | # GET routesArguments
| |
| label | String | ||
| countries | [Country] | # GET routesArguments
| |
| country | Country | ||
| name | String | ||
| defaultCountry | Country | ||
| coupon | Coupon | # GET routesArguments
| |
| code | String! | ||
| organization | String! | ||
| order | NewOrder | ||
| couponByUUID | Coupon | ||
| uuid | String! | ||
| organization | String! | ||
| coupons | [Coupon] | ||
| redeemableCoupon | CouponResponse | ||
| code | String | ||
| organization | String! | ||
| order | NewOrder | ||
| generateCode | String | ||
| codeExists | Boolean | ||
| code | String! | ||
| redeemedCoupons | [RedeemedCoupon] | ||
| redeemedCouponsByUUID | [RedeemedCoupon] | ||
| uuid | String! | ||
| credit | [CreditTransaction] | # GET routesArguments
| |
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| channels | [String] | ||
| locations | [String] | ||
| creditSummary | [CreditTransaction] | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| channels | [String] | ||
| locations | [String] | ||
| creditUsage | [CreditUsage] | ||
| currencies | [Currency] | # GET routesArguments
| |
| defaultCurrency | Currency | ||
| customers | [Customer] | # GET routesArguments
| |
| uuid | String | ||
| conditions | [QueryCondition] | ||
| limit | Int | ||
| skip | Int | ||
| searchQuery | String | ||
| customer | Customer | ||
| uuid | String! | ||
| isCustomerExclusive | Boolean | ||
| organization | String! | ||
| id | String! | ||
| customerProfiles | [CustomerProfile] | # GET routesArguments
| |
| dash | DashRender | # GET routes | |
| uuid | String! | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| channels | [String] | ||
| locations | [String] | ||
| uiValues | String | ||
| timeIntervalFrom | String | ||
| timeIntervalTo | String | ||
| dashByNamespace | DashRender | ||
| namespace | String! | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| channels | [String] | ||
| locations | [String] | ||
| uiValues | String | ||
| timeIntervalFrom | String | ||
| timeIntervalTo | String | ||
| config | JSON | ||
| dashCollections | [DashCollection] | # GET routes | |
| dashTypes | [DashType] | # GET routesArguments
| |
| dashType | DashType | ||
| namespace | String! | ||
| debit | [DebitTransaction] | # GET routesArguments
| |
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| channels | [String] | ||
| locations | [String] | ||
| debitSummary | [DebitTransaction] | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| channels | [String] | ||
| locations | [String] | ||
| debitCredit | [DebitCredit] | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| deliveryMethods | [DeliveryMethod] | # GET routesArguments
| |
| organization | String | ||
| deliveryMethod | DeliveryMethod | ||
| namespace | String! | ||
| deliveryMethodInstances | [DeliveryMethodInstance] | # GET routesArguments
| |
| deliveryMethodInstance | DeliveryMethodInstance | ||
| namespace | String! | ||
| deliveryServices | [DeliveryMethodInstanceOption] | ||
| organization | String! | ||
| channel | String | ||
| order | String | ||
| newOrder | NewOrder | ||
| uiValues | String | ||
| deliveryServiceRateLegacyOrder | Price | ||
| deliveryMethodInstance | String! | ||
| order | String! | ||
| uiValues | String | ||
| organization | String | ||
| deliveryServiceProcessLegacyOrder | DeliveryMethodInstanceProcessResult | ||
| deliveryMethodInstance | String! | ||
| order | String! | ||
| organization | String | ||
| deliverySummary | [DeliverySummary] | # GET BillingReturns an organizations invoices for SalesCloud usage Arguments | |
| organization | String! | ||
| date | String! | ||
| devices | [Device] | # GET routesArguments
| |
| namespace | String! | ||
| device | Device | ||
| SerialNumber | String | ||
| deviceSettings | DeviceSettings | ||
| id | String! | ||
| deviceSignup | DeviceSignup | ||
| SerialNumber | String! | ||
| deviceSettingCategories | [DeviceSettingCategory] | ||
| defaultDeviceSettings | DeviceSettings | ||
| deviceErrors | [DeviceError] | # GET routesArguments
| |
| SerialNumber | String | ||
| deviceEvents | [DeviceEvent] | # GET routesArguments
| |
| SerialNumber | String | ||
| deviceLogs | [DeviceLog] | # GET routesArguments
| |
| SerialNumber | String | ||
| limit | Int | ||
| discounts | [Discount] | # GET routesArguments
| |
| discountsList | [DiscountOption] | ||
| organization | String! | ||
| discount | DiscountOption | ||
| organization | String! | ||
| uuid | String! | ||
| documentTypes | [DocumentType] | # GET routesArguments
| |
| namespace | String | ||
| documentRender | String | ||
| namespace | String! | ||
| version | String! | ||
| order_id | String! | ||
| etag | eTag | # GET routesArguments
| |
| tagID | String | ||
| etags | [eTag] | ||
| uuid | String! | ||
| unclaimedEtags | [eTag] | ||
| events | [Event] | # GET routesArguments
| |
| file | File | # GET routesArguments
| |
| uuid | String! | ||
| formsOfPayment | [FormOfPayment] | # GET routesArguments
| |
| uuid | String | ||
| conditions | [QueryCondition] | ||
| limit | Int | ||
| skip | Int | ||
| gates | [Gate] | ||
| gateLogs | [GateLog] | ||
| gate | Gate | ||
| uuid | String! | ||
| giftcard | Giftcard | # GET routesArguments
| |
| uuid | String! | ||
| organization | String! | ||
| giftCardStatus | StatusResponse | ||
| code | String! | ||
| organization | String! | ||
| cart | [CartItem] | ||
| totalAmount | PriceInput | ||
| yayCardStatus | StatusResponse | ||
| code | String! | ||
| organization | String! | ||
| instance | String! | ||
| hardwareModels | [HardwareModel] | # GET routesArguments
| |
| hardwareModel | HardwareModel | ||
| sku | String | ||
| getHeroUsers | [HeroUser] | # GET routesArguments
| |
| getHeroUser | HeroUser | getHeroUser(heroUserUUID: String!): HeroUser | |
| heroUserUUID | String! | ||
| invoices | [Invoice] | # GET routesArguments
| |
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| limit | Int | ||
| skip | Int | ||
| sort | QuerySort | ||
| conditions | [QueryCondition] | ||
| items | [Item] | # GET productsArguments
| |
| uuid | String | ||
| itemsByCategory | [Item] | ||
| categories | [String] | ||
| itemsList | [ItemOption] | ||
| organization | String | ||
| categories | [String] | ||
| item | Item | ||
| uuid | String! | ||
| organization | String! | ||
| itemLocationBlocks | [ItemLocationBlock] | ||
| organization | String! | ||
| totalAmountBought | Price | ||
| organization | String! | ||
| uuid | String! | ||
| top100Amounts | [Price] | ||
| organization | String! | ||
| uuid | String! | ||
| totalAmountCount | Int | ||
| organization | String! | ||
| uuid | String! | ||
| itemTypes | [ItemType] | # GET routesArguments
| |
| itemType | ItemType | ||
| namespace | String! | ||
| lineItems | [LineItem] | # GET routesArguments
| |
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| conditions | [QueryCondition] | ||
| posLineItems | [LineItem] | ||
| channel | String! | ||
| entangleKey | String! | ||
| lineItemTypes | [LineItemType] | # GET routesArguments
| |
| lineItemType | LineItemType | ||
| namespace | String! | ||
| localeStrings | [LocaleString] | # GET routesArguments
| |
| keys | [String!] | ||
| location | Location | ||
| organization | String! | ||
| uuid | String! | ||
| locations | [Location] | ||
| locationOptions | [LocationOption] | ||
| organization | String! | ||
| availableLocationVariations | [LocationVariation] | ||
| location | String! | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| quantity | Int | ||
| locationVariationCombinations | [LocationVariationCombination] | ||
| locationStocks | [LocationStock] | ||
| location | String | ||
| item | String | ||
| zones | [LocationZone] | ||
| mappings | [Mapping] | locationZones(location: String!): [LocationZone] # returns all zones on a given location # GET routesArguments
| |
| marketplaces | [MarketPlace] | # GET routesArguments
| |
| marketplace | MarketPlace | ||
| namespace | String! | ||
| menus | [Menu] | # GET routesArguments
| |
| messageButtons | [MessageButton] | ||
| organization | String! | ||
| messengerMethodInstances | [MessengerMethodInstance] | # GET productsArguments
| |
| message | Message | # GET routesArguments
| |
| uuid | String! | ||
| messages | [Message] | ||
| namespace | String | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| searchMessageDestination | String | ||
| messagesByContext | [Message] | ||
| ctx | String! | ||
| unprintedPrintJobs | [Message] | ||
| messengerMethods | [MessengerMethod] | # GET routesArguments
| |
| messengerMethod | MessengerMethod | ||
| namespace | String! | ||
| paylinkOrder | Receipt | # GET routesArguments
| |
| uuid | String! | ||
| receiptAsHTML | Receipt | ||
| uuid | String! | ||
| receiptAsPDF | Receipt | ||
| uuid | String! | ||
| estimateAsPDF | Receipt | ||
| uuid | String! | ||
| invoiceAsPDF | Receipt | ||
| uuid | String! | ||
| voucherAsPDF | Receipt | ||
| uuid | String! | ||
| payLinkEvents | [PayLinkEvent] | ||
| organization | String! | ||
| uuid | String | ||
| orders | [Order] | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| skip | Int | ||
| limit | Int | ||
| sort | QuerySort | ||
| conditions | [QueryCondition] | ||
| order | Order | ||
| uuid | String! | ||
| orderReference | OrderReference | ||
| orderUUID | String! | ||
| organizationUUID | String! | ||
| ordersByPickupTime | [Order] | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| orderOption | OrderOption | ||
| organization | String! | ||
| order | String! | ||
| posOrders | [Order] | ||
| channels | [String!] | ||
| location | String | ||
| posOrder | Order | ||
| organization | String! | ||
| channel | String! | ||
| uuid | String! | ||
| orderStates | [OrderStateOption] | # GET routesArguments
| |
| organizations | [Organization] | # GET routesArguments
| |
| currentOrganization | Organization | ||
| organization | ReferencedOrganization | ||
| uuid | String! | ||
| organizationByChannel | String | ||
| channel | String! | ||
| organizationRoles | [OrganizationRole] | # GET routesArguments
| |
| payments | [PaymentTransaction] | # GET routesArguments
| |
| serialNumbers | [String] | ||
| locations | [String] | ||
| channels | [String] | ||
| orders | [String] | ||
| customers | [String] | ||
| states | [PaymentTransactionStatus] | ||
| namespaces | [String] | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| limit | Int | ||
| skip | Int | ||
| sort | QuerySort | ||
| conditions | [QueryCondition] | ||
| search | String | ||
| payment | PaymentTransaction | ||
| uuid | String! | ||
| paymentBatchItem | PaymentBatchItem | # GET routesArguments
| |
| uuid | String! | ||
| paymentBatches | [PaymentBatch] | ||
| paymentBatchItems | [PaymentBatchItem] | ||
| batch | String! | ||
| paymentMethods | [PaymentMethod] | # GET routesArguments
| |
| paymentMethodList | [PaymentMethodOption] | ||
| organization | String! | ||
| paymentMethod | PaymentMethod | ||
| namespace | String! | ||
| paymentMethodInstances | [PaymentMethodInstance] | # GET routesArguments
| |
| uuid | String | ||
| checkout | Boolean | ||
| terminal | Boolean | ||
| paymentMethodInstanceList | [PaymentMethodInstanceOption] | ||
| organization | String! | ||
| checkout | Boolean | ||
| terminal | Boolean | ||
| paymentMethodInstanceOption | PaymentMethodInstanceOption | ||
| organization | String! | ||
| uuid | String! | ||
| paymentstates | [PaymentState] | # GET routesArguments
| |
| platforms | [Platform] | # GET routesArguments
| |
| posFragments | [PosFragment] | # GET routesArguments
| |
| namespace | String | ||
| printerSMSMessages | [printerSMSMessage] | # GET routesArguments
| |
| printJobs | [PrintJob] | # GET routesArguments
| |
| MacAddress | String | ||
| printJobByUUID | PrintJob | ||
| UUID | String | ||
| buttons | Boolean | ||
| processDisplaySystem | ProcessDisplaySystem | # GET routesArguments
| |
| uuid | String | ||
| processDisplaySystems | [ProcessDisplaySystem] | ||
| pucks | [Puck] | ||
| pendingPuckPing | PuckPing | ||
| pinger | String! | ||
| punchCard | PunchCard | ||
| uuid | String! | ||
| organization | String | ||
| user | String | ||
| punchCardList | [PunchCard] | ||
| organization | String | ||
| user | String | ||
| punchCardTemplate | PunchCardTemplate | ||
| uuid | String! | ||
| organization | String | ||
| punchCardTemplateList | PunchCardTemplate | ||
| organization | String! | ||
| reservationWidget | ReservationWidget | ||
| uuid | String! | ||
| reservationWidgets | [ReservationWidget] | ||
| roles | [Role] | # GET routesArguments
| |
| routes | [Route] | # GET routesArguments
| |
| platform | String | ||
| ruleConditions | [RuleCondition] | # GET routesArguments
| |
| ruleEvents | [RuleEvent] | ||
| ruleActions | [RuleAction] | ||
| services | [Service] | # GET routesArguments
| |
| anonymousSession | Session | # GET routesArguments
| |
| sessionToken | String! | ||
| channel | String! | ||
| shift | Shift | ||
| shiftUUID | String! | ||
| shifts | [Shift] | ||
| staffUUID | String | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| sites | [Site] | # GET routesArguments
| |
| isSitesRegistered | Boolean | ||
| ssoSitesLink | String | ||
| site_name | String | ||
| slots | [Slot] | # GET routesArguments
| |
| softpos | SoftPos | # GET routesArguments
| |
| id | String! | ||
| staff | [Staff] | # GET routesArguments
| |
| limit | Int | ||
| skip | Int | ||
| sort | QuerySort | ||
| verifyStaffPin | Boolean | ||
| organization | String! | ||
| ssn | String! | ||
| pin | String! | ||
| stockEntries | [StockEntry] | # GET routes | |
| entityType | String! | ||
| entityId | String! | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| conditions | [QueryCondition] | ||
| stream | [StreamEntry] | # GET routesArguments
| |
| subscriptions | [RecurringSubscription] | # GET routesArguments
| |
| limit | Int | ||
| skip | Int | ||
| sort | QuerySort | ||
| conditions | [QueryCondition] | ||
| subscriptionsByOrder | [RecurringSubscription] | ||
| organization | String | ||
| order | String! | ||
| subscriptionOrders | [Order] | ||
| uuid | String! | ||
| subscriptionState | SubscriptionState | ||
| uuid | String! | ||
| systemTimeInMillis | Float | # GET routesArguments
| |
| primaryColor | String | ||
| randomString | String | ||
| goLives | [GoLive] | ||
| tablets | [Tablet] | ||
| printers | [Printer] | ||
| tasks | [Task] | # GET routesArguments
| |
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| conditions | [QueryCondition] | ||
| taxes | [TaxRate] | # GET routesArguments
| |
| team | [Team] | # GET routesArguments
| |
| siteTemplates | [SiteTemplate] | # GET routesArguments
| |
| emailTemplates | [EmailTemplate] | ||
| etagTemplates | [EmailTemplate] | ||
| organization | String | ||
| lookupNameBySSN | String | ||
| ssn | String! | ||
| organizationTranslations | [Translation] | ||
| organization | String | ||
| organizationTranslationsI18nFormatted | JSON | ||
| organization | String | ||
| users | [User] | # GET routesArguments
| |
| user | User | ||
| uid | String | ||
| whoAmI | User | ||
| Organization | String | ||
| userExistsByEmail | Boolean | ||
| String! | |||
| userExistsByDisplayName | Boolean | ||
| displayName | String! | ||
| variants | [Variant] | # GET variantsArguments
| |
| id | Int | ||
| variationOption | VariationOption | # List of variationOptionsSorted by weight | |
| organization | String! | ||
| uuid | String! | ||
| variationOptions | [VariationOption] | ||
| uuid | String | ||
| organization | String | ||
| variations | [Variation] | ||
| type | String | ||
| waitlist | [WaitingGuest] | # GET routesArguments
| |
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| widgetList | [Widget] | # List of widgetsSorted by newest widget in the top | |
| organization | String! | ||
| scheduleWidget | ScheduleWidget | Returns an active schedule widget | |
| uuid | String! | ||
| scheduleWidgets | [ScheduleWidget] | ||
| work | [Work] | # List of workSorted by newest work in the top | |
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| conditions | [QueryCondition] | ||
| sort | QuerySort | ||
| workToVerify | [Work] | ||
| organization | String! | ||
| ssn | String! | ||
| pin | String! | ||
| workByPeriod | [Work] | ||
| organization | String! | ||
| ssn | String! | ||
| pin | String! | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| workTypes | [String] | ||
| xReport | String | ||
| channel | String! | ||
| location | String! | ||
| serialNumber | String! | ||
| yessProfiles | [AppProfile] | # GET routesArguments
| |
| namespace | String | ||
| appProfiles | [AppProfile] | ||
| namespace | String! | ||
| yessGroups | [AppProfileGroup] | ||
| namespace | String | ||
| yessUser | AppUser | ||
| namespace | String | ||
| yessUserDiscounts | [AppUserDiscount] | ||
| yessUserOrders | [AppUserOrder] | ||
| yessUserBookings | [AppUserBooking] | ||
| yessUserGiftcards | [AppUserGiftcard] | ||
| yessUserCoupons | [AppUserCoupon] | ||
| yessUserFavorites | [String] | ||
| yessUserPartners | [Organization] | ||
| yessUserCardsOnFile | [AppUserCardOnFile] | ||
| discoverYessUserData | Boolean | ||
| yessPartners | [Organization] | ||
| namespace | String | ||
| appPartners | [Organization] | ||
| namespace | String | ||
| yessEvents | [ItemOption] | ||
| namespace | String | ||
| yessPartnerDiscounts | [AppPartnerDiscount] | ||
| organization | String | ||
| partner | String | ||
| namespace | String | ||
| zReport | String | ||
| channel | String! | ||
| location | String! | ||
| serialNumber | 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 | AppUninstall | ||
| 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 | TimeSlotReservationResult | ||
| sessionToken | String! | ||
| item | String | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| organization | String! | ||
| location | String | ||
| order | String | ||
| quantity | Int | ||
| skipLock | Boolean | ||
| includeLocationVariations | Boolean | ||
| releaseAvailableTimeSlot | Boolean | ||
| uuid | String | ||
| sessionToken | String! | ||
| item | String | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| organization | String! | ||
| order | String | ||
| skipLock | Boolean | ||
| blockAvailableTimeSlot | Boolean | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| organization | String! | ||
| channel | String! | ||
| location | String! | ||
| locationVariation | String | ||
| item | String | ||
| comment | String | ||
| unblockAvailableTimeSlot | Boolean | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| organization | String! | ||
| channel | String! | ||
| location | String! | ||
| item | String | ||
| sendBooking | Boolean | ||
| uuid | String | ||
| String | |||
| phone | String | ||
| redeemBooking | Boolean | ||
| uuid | String! | ||
| organization | String | ||
| redeemBookingByUUID | Response | ||
| uuid | String! | ||
| organization | String! | ||
| redeemBookingByID | RedeemBooking | ||
| id | String! | ||
| organization | String! | ||
| redeemMultipleBookings | [RedeemBooking] | ||
| bookings | [String]! | ||
| organization | String | ||
| createBooking | Booking | ||
| booking | NewBooking! | ||
| createMultipleBookings | [Booking] | ||
| bookings | [NewBooking!]! | ||
| updateBooking | Booking | ||
| booking | UpdateBooking! | ||
| updateMultipleBookings | [Booking] | ||
| bookings | [UpdateBooking!]! | ||
| rescheduleBooking | Booking | ||
| booking | RescheduleBooking! | ||
| organizationUUID | String! | ||
| bookingsToggleBlockedDay | Boolean | ||
| location | String! | ||
| date | String! | ||
| executeBulkOperation | BulkOperationResult | ||
| namespace | String! | ||
| route | String! | ||
| uiValues | JSON | ||
| payload | JSON | ||
| executeCallToAction | CallToActionResult | ||
| namespace | String! | ||
| route | String! | ||
| uiValues | JSON | ||
| payload | JSON | ||
| registerCardAcceptor | Boolean | ||
| uuid | String! | ||
| cardAcceptor | String! | ||
| addToCart | LineItem | # GET routesArguments
| |
| sessionToken | String! | ||
| channel | String! | ||
| item | String! | ||
| quantity | String! | ||
| options | [String] | ||
| language | String | ||
| location | String | ||
| uiValues | String | ||
| removeFromCart | Boolean | ||
| sessionToken | String! | ||
| channel | String! | ||
| lineItem | String! | ||
| queueToCart | String | ||
| sessionToken | String! | ||
| channel | String! | ||
| item | String! | ||
| quantity | String! | ||
| language | String | ||
| addMultipleItemsToCart | Order | ||
| sessionToken | String! | ||
| channel | String! | ||
| items | [CartItem] | ||
| language | String | ||
| location | String | ||
| updateCategoryEpt | eptUpdate | ||
| uuid | String! | ||
| ept | Int! | ||
| updateCategory | Category | ||
| category | UpdateCategory! | ||
| updateCategoryTranslations | Boolean | ||
| category | TranslationItem | ||
| createCategory | Category | ||
| category | CreateCategory! | ||
| createChannel | Channel | ||
| channel | NewChannel! | ||
| updateChannel | Channel | ||
| channel | UpdateChannel! | ||
| updateChannelEpt | eptUpdate | ||
| uuid | String! | ||
| organizationUuid | String! | ||
| ept | Int! | ||
| insertDisabledTimeSlot | eptUpdate | ||
| organization | String! | ||
| timeSlot | timeSlot | ||
| deleteDisabledTimeSlot | eptUpdate | ||
| organization | String! | ||
| timeSlot | timeSlot | ||
| processCheckoutStep | ProcessCheckoutStepResult | # Process Checkout StepProcess a checkout step. | |
| sessionToken | String! | ||
| organization | String! | ||
| channel | String! | ||
| step | String! | ||
| values | [CheckoutSectionValues] | ||
| checkoutValidation | VerifyCheckoutResult | ||
| organization | String! | ||
| channel | String! | ||
| values | [CheckoutSectionValues] | ||
| items | [String] | ||
| createCoupon | Coupon | ||
| coupon | NewCoupon! | ||
| updateCoupon | Coupon | ||
| coupon | UpdateCoupon | ||
| redeemCoupon | Response | Redeem Coupon Arguments
| |
| organization | String! | ||
| coupon | String! | ||
| location | String | ||
| quantity | Int! | ||
| reference | String | ||
| user | String | ||
| redeemMultipleCoupons | [Response] | ||
| coupons | [String!]! | ||
| location | String | ||
| createCustomer | Customer | ||
| customer | NewCustomer! | ||
| updateCustomer | Customer | ||
| customer | UpdateCustomer | ||
| createDash | Dash | ||
| collection | String! | ||
| dash | NewDash! | ||
| updateDash | Dash | ||
| dash | UpdateDash! | ||
| deleteDash | Boolean | ||
| dash | String! | ||
| updateDashCollectionOrder | [Dash] | ||
| dashes | [UpdateDash!]! | ||
| createDashCollection | DashCollection | ||
| name | String! | ||
| updateDashCollection | DashCollection | ||
| collection | UpdateDashCollection! | ||
| deleteDashCollection | Boolean | ||
| uuid | String! | ||
| 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 | ||
| updateBooleanDeviceSetting | Boolean | ||
| device | String! | ||
| key | String! | ||
| value | Boolean | ||
| updateStringDeviceSetting | Boolean | ||
| device | String! | ||
| key | String! | ||
| value | Boolean | ||
| createEtag | eTag | ||
| tag | NewEtag! | ||
| updateEtag | eTag | ||
| etag | UpdateEtag! | ||
| claimEtag | eTag | ||
| etag | ClaimEtag! | ||
| releaseEtag | Boolean | ||
| tagID | String | ||
| saveFile | File | ||
| file | NewFile! | ||
| updateFormOfPayment | FormOfPayment | ||
| formOfPayment | UpdateFormOfPayment! | ||
| createGateLog | Boolean | ||
| log | NewGateLog! | ||
| createGiftcard | Giftcard | ||
| giftcard | NewGiftcard! | ||
| updateGiftcard | Giftcard | ||
| giftcard | UpdateGiftcard! | ||
| createMultipleGiftcards | [Giftcard] | ||
| giftcard | NewGiftcards | ||
| quantity | Int | ||
| createHeroUser | HeroUser | ||
| user | NewHeroUser | ||
| updateHeroUser | HeroUser | ||
| user | UpdateHeroUser | ||
| sendInvoice | Boolean | ||
| String! | |||
| message | String | ||
| invoice | String! | ||
| creditInvoice | Invoice | ||
| invoice | String! | ||
| comment | String | ||
| enableItemStockControl | Boolean | ||
| item | String! | ||
| targetStock | Int | ||
| thresholdStock | Int | ||
| currentSock | Int | ||
| disableItemStockControl | Boolean | ||
| item | String! | ||
| createItem | Item | ||
| item | NewItem! | ||
| updateItem | Item | ||
| item | UpdateItem | ||
| updateItemTranslations | Boolean | ||
| item | TranslationItem | ||
| updateItemsSortingWeight | [Item] | ||
| items | [UpdateItemSortingWeight!] | ||
| blockItemForLocation | Boolean | ||
| organization | String! | ||
| item | String! | ||
| location | String! | ||
| releaseItemForLocation | Boolean | ||
| organization | String! | ||
| item | String! | ||
| location | String! | ||
| commitLineItems | Boolean | ||
| entangleKey | String! | ||
| lineItems | [NewCommitLineItem] | ||
| updateLineItem | LineItem | ||
| lineItem | UpdateLineItem! | ||
| updatePosLineItemState | Boolean | ||
| uuid | String! | ||
| state | String! | ||
| createAndAddLineItemsToPosOrder | Boolean | ||
| order | String! | ||
| channel | String! | ||
| lineItems | [NewPosLineItem] | ||
| tableId | String | ||
| incrementLocationStock | Boolean | ||
| location | String! | ||
| item | String! | ||
| incrementBy | Float! | ||
| note | String | ||
| decrementLocationStock | Boolean | ||
| location | String! | ||
| item | String! | ||
| decrementBy | Float! | ||
| note | String | ||
| updateLocation | Location | ||
| location | UpdateLocation | ||
| createLocation | Location | ||
| location | NewLocation! | ||
| updateLocationEPT | eptUpdate | ||
| organization | String! | ||
| uuid | String! | ||
| ept | Int! | ||
| createLocationVariation | LocationVariation | ||
| locationVariation | NewLocationVariation! | ||
| generateLocationVariations | [LocationVariation] | Generates multiple location variations | |
| text | String! | ||
| startsAt | Int! | ||
| endsAt | Int! | ||
| location | String! | ||
| zone | String! | ||
| updateLocationVariation | LocationVariation | ||
| locationVariation | UpdateLocationVariation! | ||
| reserveLocationVariation | Boolean | ||
| organization | String! | ||
| channel | String! | ||
| partnerKey | String | ||
| locationVariation | String | ||
| updateLocationVariationCombination | LocationVariationCombination | ||
| combination | UpdatedLocationVariationCombination! | ||
| createLocationVariationCombination | LocationVariationCombination | ||
| combination | NewLocationVariationCombination! | ||
| createMultipleLocationVariationCombinations | [LocationVariationCombination] | ||
| combinations | [NewLocationVariationCombination]! | ||
| disableLocationVariationCombination | LocationVariationCombination | ||
| uuid | String! | ||
| enableLocationVariationCombination | LocationVariationCombination | ||
| uuid | String! | ||
| createLocationZone | LocationZone | ||
| zone | NewLocationZone! | ||
| updateLocationZone | LocationZone | ||
| zone | UpdateLocationZone! | ||
| messageButtonAdd | MessageButton | ||
| message | NewMessageButton | ||
| organization | String! | ||
| createMessage | Message | ||
| message | NewMessage! | ||
| updateOrderState | Boolean | ||
| uuid | String! | ||
| state | OrderState! | ||
| updatePosOrderState | Boolean | ||
| uuid | String! | ||
| state | OrderState! | ||
| updateOrderData | Boolean | ||
| uuid | String! | ||
| data | JSON | ||
| updatePosOrder | Order | ||
| channel | String! | ||
| location | String | ||
| uuid | String | ||
| order | UpdatePosOrder! | ||
| createPosOrder | Order | ||
| channel | String! | ||
| location | String | ||
| uuid | String | ||
| order | NewPosOrder! | ||
| sendReceipt | Boolean | ||
| uuid | String! | ||
| String | |||
| sendReceiptToEmail | Boolean | ||
| uuid | String! | ||
| organization | String! | ||
| String! | |||
| sendPayLink | Boolean | ||
| order | String! | ||
| String | |||
| message | String | ||
| createOrganization | Organization | ||
| organization | NewOrganization | ||
| removeUserFromOrganization | Boolean | ||
| user | RemoveUserFromOrganization | ||
| inviteUserToOrganization | Response | ||
| user | InviteUserToOrganization | ||
| signupOrganizationAndUser | Response | ||
| signupOrganizationAndUser | SignupOrganizationAndUser! | ||
| addNewGuestToTable | Response | ||
| organization | String! | ||
| guest | NewTableGuest! | ||
| sendPushMessage | Boolean | ||
| PushMessage | NewPushMessage | ||
| redeemPass | Booking | ||
| organization | String! | ||
| passUUID | String! | ||
| unvoidTestPass | Boolean | ||
| createPayment | PaymentTransaction | ||
| payment | NewPaymentTransaction! | ||
| cancelPayment | PaymentTransaction | ||
| uuid | String! | ||
| creditPayment | PaymentTransaction | ||
| uuid | String! | ||
| resolvePayment | PaymentTransaction | ||
| uuid | String! | ||
| createPosPayment | PaymentTransaction | ||
| payment | NewPaymentTransaction! | ||
| organization | String! | ||
| channel | String! | ||
| cancelPaymentBatchItem | Boolean | ||
| uuid | String! | ||
| pausePaymentBatch | Boolean | ||
| uuid | String! | ||
| resumePaymentBatch | Boolean | ||
| uuid | String! | ||
| processPaymentBatchItem | Boolean | ||
| uuid | String! | ||
| updatePaymentMethodInstancesOrder | [PaymentMethodInstance] | ||
| instances | [NewSort!] | ||
| startPhoneNumberVerification | Boolean | ||
| organization | String! | ||
| service | String! | ||
| phoneNumber | String! | ||
| completePhoneNumberVerification | String | ||
| organization | String! | ||
| service | String! | ||
| phoneNumber | String! | ||
| code | String | ||
| smsMessageAdd | printerSMSMessage | ||
| message | NewSMSMessage | ||
| notifyPrintRecipient | notifyPrintRecipientResult | ||
| message | String | ||
| uuid | String | ||
| createNewPrintJob | Boolean | ||
| printJob | NewPrintJob! | ||
| reprintPrintJob | Boolean | ||
| uuid | String | ||
| orderUUID | String | ||
| createProcessDisplaySystem | ProcessDisplaySystem | ||
| processDisplaySystem | NewProcessDisplaySystem | ||
| updateProcessDisplaySystem | ProcessDisplaySystem | ||
| processDisplaySystem | UpdateProcessDisplaySystem | ||
| createPuck | Puck | ||
| puck | NewPuck! | ||
| createPuckPing | Boolean | ||
| ping | NewPuckPing! | ||
| completePendingPuckPing | Boolean | ||
| pinger | String! | ||
| ping | String! | ||
| addNewPunchCardTemplate | TransactionResponse | ||
| template | PunchCardTemplateNew! | ||
| updatePunchCardTemplate | TransactionResponse | ||
| template | PunchCardTemplateUpdated! | ||
| disablePunchCardTemplate | TransactionResponse | ||
| uuid | String! | ||
| enablePunchCardTemplate | TransactionResponse | ||
| uuid | String! | ||
| addNewPunchCardToUser | TransactionResponse | ||
| newPunchCard | PunchCardNew! | ||
| disablePunchCard | TransactionResponse | ||
| uuid | String! | ||
| enablePunchCard | TransactionResponse | ||
| uuid | String! | ||
| addOnePunch | TransactionResponse | ||
| uuid | String! | ||
| cancelPunch | TransactionResponse | ||
| uuid | String! | ||
| createReservationWidget | ReservationWidget | ||
| reservationWidget | NewReservationWidget | ||
| updateReservationWidget | ReservationWidget | ||
| reservationWidget | UpdateReservationWidget | ||
| newAnonymousSession | Session | ||
| setBooleanSetting | Boolean | # Create Setting | |
| key | String | ||
| value | Boolean | ||
| setStringSetting | Boolean | ||
| key | String | ||
| value | String | ||
| createShift | Shift | ||
| shift | NewShift! | ||
| createMultipleShifts | [Shift] | ||
| shifts | [NewShift!]! | ||
| updateSite | Site | ||
| site | UpdateSite | ||
| createSite | Site | ||
| template | CreateSite | ||
| deleteSite | Boolean | ||
| site | DeleteSite | ||
| addSlot | Slot | ||
| slot | NewSlot! | ||
| updateSlot | Slot | ||
| slot | UpdateSlot! | ||
| removeSlot | Boolean | ||
| slot | String! | ||
| createStaffLegacy | Staff | ||
| staff | NewStaff | ||
| updateStaff | Staff | ||
| staff | UpdateStaff | ||
| inviteStaffToWorkReview | Boolean | ||
| uuid | String! | ||
| optionalMessage | String | ||
| startHeroSignin | HeroSignIn | ||
| organizationUUID | String! | ||
| String! | |||
| phone | String! | ||
| completeHeroSignin | HeroSignIn | ||
| organizationUUID | String! | ||
| String! | |||
| phone | String! | ||
| code | String! | ||
| staffUUID | String! | ||
| updateSubscription | Boolean | ||
| subscription | UpdateRecurringSubscription! | ||
| notify | Boolean | ||
| updateMultipleSubscriptions | [RecurringSubscription] | ||
| subscriptions | [UpdateRecurringSubscription!]! | ||
| resumeSubscription | Boolean | ||
| uuid | String! | ||
| notify | Boolean | ||
| nextPayment | Float! | ||
| pauseSubscription | Boolean | ||
| uuid | String! | ||
| notify | Boolean | ||
| cancelSubscription | Boolean | ||
| uuid | String! | ||
| notify | Boolean | ||
| addTranslation | Boolean | ||
| translation | NewTranslation! | ||
| 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 | ||
| String! | |||
| password | String! | ||
| state | String! | ||
| scope | String | ||
| refreshAccessToken | AccessToken | ||
| refreshToken | String! | ||
| resetPasswordByEmail | Boolean | ||
| String! | |||
| notifyBookingOwner | Boolean | ||
| subject | String! | ||
| message | String! | ||
| bookings | [String!]! | ||
| createScheduleWidget | ScheduleWidget | ||
| widget | NewScheduleWidget | ||
| updateScheduleWidget | ScheduleWidget | ||
| widget | UpdateScheduleWidget | ||
| 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! | ||
| cancelWork | Response | ||
| organization | String! | ||
| workId | String! | ||
| createYessProfile | AppProfile | ||
| profile | NewYessProfile! | ||
| removeYessProfile | Boolean | ||
| profile | String! | ||
| namespace | String! | ||
| updateYessProfile | AppProfile | ||
| profile | UpdateYessProfile! | ||
| disableYessProfile | Boolean | ||
| profile | String! | ||
| namespace | String! | ||
| enableYessProfile | Boolean | ||
| profile | String! | ||
| namespace | String! | ||
| createYessGroup | AppProfileGroup | ||
| group | NewYessGroup! | ||
| updateYessGroup | AppProfileGroup | ||
| group | UpdateYessGroup! | ||
| disableYessGroup | Boolean | ||
| group | String! | ||
| namespace | String! | ||
| enableYessGroup | Boolean | ||
| group | String! | ||
| namespace | String! | ||
| registerToYessClub | Boolean | ||
| register | YessClubRegistration! | ||
| registerYessUser | NewYessUserResult | ||
| user | NewYessUser! | ||
| startYessUserSignin | AppUserSignin | ||
| user | YessUserLogin! | ||
| completeYessUserSignin | AppUserSignin | ||
| user | YessUserLogin! | ||
| addYessUserFavorite | Boolean | ||
| slug | String! | ||
| removeYessUserFavorite | Boolean | ||
| slug | String! | ||
| joinYess | Boolean | ||
| register | YessRegistration! | ||
| contactSalesCloud | Boolean | ||
| info | ContactSalesCloud! | ||
| contactOrganization | Boolean | ||
| info | ContactOrganization! | ||
| savePartnerDiscount | Boolean | ||
| partnerDiscount | NewYessPartnerDiscount! | ||
| savePartnerDiscounts | Boolean | ||
| partnerDiscounts | [NewYessPartnerDiscount!]! | ||
# Objects
# AccessToken
| Field | Argument | Type | Description |
|---|---|---|---|
| token | String! | ||
| expiresIn | Int | ||
| state | String! | ||
| refreshToken | String! | ||
# Acquirer
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| website | String | ||
| phone | String | ||
| 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! | ||
# AppPartnerDiscount
| Field | Argument | Type | Description |
|---|---|---|---|
| discountPercent | Int | ||
| partner | Organization | ||
| organization | Organization | ||
| namespace | String | ||
# AppProfile
type WorkProfile { uuid: String! name: String dayPay: Float! union: Float! orlof: Float! lifeInsurance: Float! payPeriod: [payPeriodDates] workSummary: [String] } type payPeriodDates { startDate: String! endDate: String! }
| Field | Argument | Type | Description |
|---|---|---|---|
| title | String! | ||
| slug | String! | ||
| namespace | String! | ||
| organization | Organization! | ||
| description | String! | ||
| longDescription | String | ||
| type | AppProfileType | ||
| primaryColor | String | ||
| accentColor | String | ||
| bookTableUrl | String | ||
| bookTableItem | ItemOption | ||
| groups | [String] | ||
| location | Location | ||
| categories | [Category] | ||
| cateringCategories | [Category] | ||
| channel | Channel | ||
| weight | Int | ||
| active | Boolean | ||
| logo | File | ||
| cover | File | ||
| deliveryServices | [DeliveryMethodInstanceOption] | ||
| paymentMethodInstance | PaymentMethodInstance | ||
| otherPaymentMethodInstances | [PaymentMethodInstance!] | ||
| items | [ItemOption] | ||
| giftcards | [ItemOption] | ||
| couponItems | [ItemOption] | ||
| discountPercent | Int | ||
| availableActivities | [ItemOption] | ||
# AppProfileGroup
| Field | Argument | Type | Description |
|---|---|---|---|
| slug | String! | ||
| title | String | ||
| description | String | ||
| logo | File | ||
| cover | File | ||
| groups | [String] | ||
| primaryColor | String | ||
| accentColor | String | ||
| redirect | String | ||
| active | Boolean | ||
| mainGroup | String | ||
| weight | Int | ||
| namespace | 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 | ||
# AppUninstall
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean! | ||
| code | Int | ||
| message | String | ||
| redirectUrl | String | ||
# AppUser
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| phoneNumber | String! | ||
| namespace | String | ||
| String | |||
| deviceTokens | [String] | ||
# AppUserBooking
| Field | Argument | Type | Description |
|---|---|---|---|
| organization | Organization | ||
| booking | Booking | ||
| namespace | String | ||
# AppUserCardOnFile
| Field | Argument | Type | Description |
|---|---|---|---|
| token | String! | ||
| fourDigits | String | ||
| cardType | String | ||
| namespace | String | ||
# AppUserCoupon
| Field | Argument | Type | Description |
|---|---|---|---|
| organization | Organization | ||
| coupon | Coupon | ||
| namespace | String | ||
# AppUserDiscount
| Field | Argument | Type | Description |
|---|---|---|---|
| label | String | ||
| partner | Organization | ||
| organization | Organization | ||
| discountPercent | Int | ||
| namespace | String | ||
# AppUserGiftcard
| Field | Argument | Type | Description |
|---|---|---|---|
| organization | Organization | ||
| giftcard | Giftcard | ||
| namespace | String | ||
# AppUserOrder
| Field | Argument | Type | Description |
|---|---|---|---|
| organization | Organization | ||
| order | Order | ||
| namespace | String | ||
# AppUserSignin
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean! | ||
| isRegistered | Boolean! | ||
| code | Int! | ||
| message | String! | ||
| jwt | String | ||
# 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 | ||
| reservationCount | Int | ||
| bookingCount | Int | ||
| availableCount | Int | ||
| locationVariations | [LocationVariation] | ||
| isBlocked | Boolean! | ||
| price | Price | ||
| timezone | String! | ||
# Billing
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| invoiceNumber | String | ||
| totalAmount | Price | ||
| balance | Price | ||
| state | BillingState | ||
| created | Float | ||
# BlockedBookingDay
| Field | Argument | Type | Description |
|---|---|---|---|
| location | String | ||
| date | String | ||
# BlockedTimeSlot
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| startTimeInMillis | Float! | ||
| endTimeInMillis | Float! | ||
| location | Location! | ||
| item | String | ||
| locationVariation | String | ||
| comment | String | ||
# 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 | ||
| state | BookingState | ||
| redeemedAt | Float | ||
| quantity | Float | ||
| unitOfMeasure | UnitOfMeasure | ||
| namespace | String | ||
| organization | ReferencedOrganization | ||
| startsAtTime | Float | ||
| endsAtTime | Float | ||
| location | Location | ||
| locationVariation | Variation | ||
| locationVariations | [LocationVariation] | ||
| internalNote | String | ||
| contactName | String | ||
| contactPhone | String | ||
| contactEmail | String | ||
| externalNote | String | ||
| upsellLineItems | [LineItem] | ||
| externalBookingId | String | ||
| externalDistributionUrl | String | ||
| order | String | ||
| price | Price | ||
| origin | BookingOrigin | ||
| paidInFull | Boolean | ||
| bookingVariation | Variation | ||
| isAcknowledged | Boolean | ||
| channel | String | ||
| notifyCustomer | Boolean | ||
# BookingOption
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| item | Item | ||
| booking_id | Int | ||
| startsAtTime | Float | ||
| endsAtTime | Float | ||
# BookingsCount
| Field | Argument | Type | Description |
|---|---|---|---|
| date | String | ||
| bookingsCount | Int | ||
# BooleanDeviceSetting
| Field | Argument | Type | Description |
|---|---|---|---|
| title | String! | ||
| key | String! | ||
| value | Boolean! | ||
| defaultValue | Boolean | ||
| category | String | ||
# BooleanSetting
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| value | Boolean | ||
| secure | Boolean | ||
# BulkOperation
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| title | String! | ||
| description | String! | ||
| routes | [String] | ||
| uiFields | [InputField] | ||
| whiteListed | Boolean | ||
# BulkOperationResult
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| success | Boolean! | ||
| message | String! | ||
| data | JSON | ||
# CallToAction
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| title | String! | ||
| description | String! | ||
| routes | [String] | ||
| uiFields | [InputField] | ||
# CallToActionResult
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| success | Boolean! | ||
| message | String! | ||
| data | JSON | ||
# Category
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| name | String | ||
| description | String | ||
| weight | Int | ||
| parent | [Category] | ||
| required | Boolean | ||
| single | Boolean | ||
| administrative | Boolean | ||
| opening_hours | [OpeningHours] | ||
| ept | Int | ||
| primary_color | String | ||
| image | Image | ||
| allowSplitByHalf | Boolean | ||
| accountingKey | String | ||
| translatedContent | [TranslatedContent] | ||
| multiple | Boolean | ||
| maxVariations | Int | ||
| color | String | ||
# CategoryDiscount
| Field | Argument | Type | Description |
|---|---|---|---|
| category | Category | ||
| discountPercent | Float! | ||
# Channel
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| label | String! | ||
| description | String | ||
| hostname | String | ||
| created | Int | ||
| changed | Int | ||
| status | Boolean | ||
| active | Boolean | ||
| uid | Int | ||
| checkin_buttons | [CheckinButton] | ||
| ept | String | ||
| data | String | ||
| externalId | String | ||
| color | String | ||
# ChannelOption
| Field | Argument | Type | Description |
|---|---|---|---|
| label | String! | ||
| uuid | String! | ||
| description | String | ||
| hostname | String | ||
| created | Int | ||
| changed | Int | ||
| status | Boolean | ||
| active | Boolean | ||
| ept | String | ||
| data | String | ||
| acceptedPaymentMethodInstances | [PaymentMethodInstanceOption] | ||
| color | 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 | ||
# 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] | ||
| validHours | [ValidHours!] | ||
| validItems | [String!] | ||
| validItemCategories | [String!] | ||
| item | Item | ||
| customer | Customer | ||
| created | Float! | ||
| changed | Float! | ||
| active | Boolean! | ||
| relatedLineItem | LineItem | ||
| validLocations | [String] | ||
| awardingMechanism | CouponAwardingMechanism | ||
| awardingConditions | [CouponAwardingCondition] | ||
| awards | [Item] | ||
# CouponAwardingCondition
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| key | String! | ||
| value | String! | ||
| operator | String! | ||
# CouponResponse
| Field | Argument | Type | Description |
|---|---|---|---|
| status | String | ||
| message | String | ||
| coupon | Coupon | ||
# 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 | ||
# CreditUsage
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| context | String! | ||
| created | Float | ||
| creditsBefore | Price | ||
| creditsAfter | Price | ||
| unitOfChange | Float | ||
# 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 | ||
| decimals | Int | ||
# Customer
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| customer_id | Int | ||
| label | String | ||
| ssn | String | ||
| 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 | ||
| invoiceable | Boolean | ||
| minimumInvoiceableAmount | Price | ||
| maximumInvoiceableAmount | Price | ||
| deliverInvoice | Boolean | ||
| deliverInvoiceToInExchange | Boolean | ||
| deliverInvoiceEmailRecipients | [String] | ||
| invoicePaymentTerms | String | ||
| invoiceCycle | String | ||
| invoicePinCode | String | ||
| optedToMarketingNotifications | Boolean | ||
| categoryDiscounts | [CategoryDiscount] | ||
| 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 | JSON | ||
| uiFields | [InputField] | ||
| disclaimer | String | ||
| alerts | [DashAlert] | ||
# DashAlert
| Field | Argument | Type | Description |
|---|---|---|---|
| type | String! | ||
| content | String! | ||
# DashCollection
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| name | String! | ||
| dashes | [Dash] | ||
| period | DashCollectionPeriod | ||
| channel | String | ||
| channels | [String] | ||
| data | String | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| timeIntervalFrom | String | ||
| timeIntervalTo | String | ||
| deliverToEmails | Boolean | ||
| emailRecipients | [String] | ||
| active | Boolean | ||
# 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] | ||
| supportsLive | Boolean | ||
# DebitCredit
| Field | Argument | Type | Description |
|---|---|---|---|
| date | String! | ||
| amount | Float! | ||
| vat | Float | ||
| currencyCode | String! | ||
| location | Address! | channel: Channel!, | |
| description | String! | ||
| type | LedgerType! | ||
| account | String! | ||
# 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] | ||
| configFields | [InputField] | ||
# DeliveryMethodInstanceAvailable
| Field | Argument | Type | Description |
|---|---|---|---|
| isAvailable | Boolean | ||
| showIsAvailableMessage | Boolean | ||
| message | String | ||
| maxDistance | Distance | ||
| estimatedDeliveryTimeInMillis | Float | ||
# 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 |
|---|---|---|---|
| id | String | ||
| lastSeenInMillis | Float | ||
| namespace | String | ||
| organization | Organization | ||
| channel | Channel | ||
| deviceLog | DeviceLog | ||
| hasSubscription | Boolean | ||
# 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 | DeviceSettings | ||
# DeviceSettingCategory
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String! | ||
| key | String! | ||
# DeviceSettings
| Field | Argument | Type | Description |
|---|---|---|---|
| booleans | [BooleanDeviceSetting] | ||
| strings | [StringDeviceSetting] | ||
# DeviceSignup
| Field | Argument | Type | Description |
|---|---|---|---|
| SerialNumber | String! | ||
| Username | String! | ||
| Password | String! | ||
| Processed | Boolean | ||
# Dimensions
| Field | Argument | Type | Description |
|---|---|---|---|
| height | Float | ||
| width | Float | ||
| length | Float | ||
| unit | String | ||
# 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 | ||
# Distance
| Field | Argument | Type | Description |
|---|---|---|---|
| value | Float! | ||
| unitOfMeasure | MeasureOfDistance | ||
# 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 |
|---|---|---|---|
| uuid | String! | ||
| name | String! | ||
| mjml | String | ||
| isReadOnly | Boolean | ||
| active | Boolean | ||
| subject | String! | ||
| context | String | ||
| namespace | String! | ||
# Event
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| name | String! | ||
| mockData | String | ||
# ExternalDeliveryResult
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String | ||
| message | String | ||
| created | Float | ||
| payload | JSON | ||
| success | Boolean | ||
# 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 | ||
| item | Item | ||
| created | Float | ||
| changed | Float | ||
| active | Boolean | ||
| publicUrl | String | ||
# GPS
| Field | Argument | Type | Description |
|---|---|---|---|
| geom | String | ||
| geo_type | String | ||
| lat | String | ||
| lon | String | ||
| left | String | ||
| top | String | ||
| right | String | ||
| bottom | String | ||
| geohash | String | ||
# Gate
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| location | String | ||
| organization | String | ||
| label | String | ||
| device | String | ||
| settings | GateSettings | ||
| allowedItems | [String] | ||
# GateLog
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| organization | String | ||
| location | String | ||
| type | String | ||
| msg | String | ||
| gateId | String | ||
| created | Float | ||
# GateSettings
| Field | Argument | Type | Description |
|---|---|---|---|
| transitTimeInMillis | Int | ||
| transitTimeoutInMillis | Int | ||
| logging | Boolean | ||
# Giftcard
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| remoteID | String! | ||
| amount | Float | ||
| expiryMonth | String | ||
| expiryYear | String | ||
| cardType | String | ||
| created | Float | ||
| changed | Float | ||
| paymentMethod | String | ||
| paymentMethodInstance | PaymentMethod | ||
| active | Boolean | ||
| customer | Customer | ||
| organization | ReferencedOrganization | ||
| item | ItemOption | ||
# GoLive
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| date | String | ||
# HardwareModel
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| sku | String | ||
| model | String | ||
| type | String | ||
| manufacturer | String | ||
| description | String | ||
| image | String | ||
| available | Boolean | ||
# HeroSignIn
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean | ||
| message | String | ||
| jwt | String | ||
| staffUUID | String | ||
# HeroUser
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| name | String! | ||
| String! | |||
| password | String! | ||
| phone | String | ||
| staffList | [String] | ||
| organizationsList | [String] | ||
| workProfiles | [String] | ||
| created | Float! | ||
| changed | Float | ||
# 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 | ||
| minLength | Int | ||
| maxLength | Int | ||
| weight | Int | ||
# InputFieldGroup
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| label | String! | ||
| multiple | Boolean | ||
# 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 |
|---|---|---|---|
| String | |||
| billingInformation | CustomerProfile | ||
| shippingInformation | CustomerProfile | ||
| type | String! | ||
| orderId | String! | ||
| invoiceNumber | String | ||
| reference | String | ||
| comment | String | ||
| created | Float! | ||
| changed | Float! | ||
| state | String! | ||
| lineItems | [LineItem] | ||
| payments | [PaymentTransaction] | ||
| withdrawalPerson | WithdrawalPerson | ||
| balance | Price | ||
| orderTotal | Price | ||
| totalAmount | Price | ||
| totalVat | Price | ||
| totalCost | Price | ||
| tasks | String | ||
| data | JSON | ||
| entangleKey | String! | ||
| deliveryTime | Float | ||
| deliveryService | DeliveryMethodInstance | ||
| location | LocationOption | ||
| locationVariation | LocationVariation | ||
| channel | ChannelOption | ||
| uuid | String! | ||
| customer | Customer | ||
| externalBarcode | String | ||
| sequence | String | ||
| isCredited | Boolean | ||
| creditInvoice | String | ||
| creditInvoiceMessage | String | ||
| externalDeliveryResults | [ExternalDeliveryResult] | ||
| fbp | String | ||
| fbc | String | ||
# InvoiceDocument
| Field | Argument | Type | Description |
|---|---|---|---|
| html | String | ||
| 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 | ||
| startDate | Float | ||
| endDate | Float | ||
| start_sell_date | Float | ||
| end_sell_date | Float | ||
| language | String! | ||
| status | Boolean! | ||
| price | Price | ||
| cost_price | Price | ||
| sale_price | Price | ||
| event_guest_price | Price | ||
| recurring_price | Price | ||
| recurring_period | RecurringPeriod | ||
| exclude_discounts | Boolean | ||
| inital_price | Price | ||
| categories | [Category] | ||
| mainCategory | Category | ||
| sorting_weight | Int | ||
| terms_and_conditions | Description | ||
| availability | Availability | ||
| availabilityMode | String | ||
| dates | [Float] | ||
| location | Location | ||
| images | [Image] | ||
| video | Video | ||
| organization | ReferencedOrganization | ||
| variations | [Variation] | ||
| variation_sets | [Variation] | ||
| startSellTimeInMillis | Float | ||
| endSellTimeInMillis | Float | ||
| default_variations | [Variation] | ||
| minimumOrderQuantity | Float | ||
| maximumOrderQuantity | Float | ||
| maximumGroupedQuantity | Float | ||
| maxAheadBookingInDays | Float | ||
| aggregateBookings | Boolean | ||
| isAllDayEvent | Boolean | ||
| durationInMinutes | Float | ||
| pauseBetweenEventsInMinutes | Float | ||
| defaultQuantity | Float | ||
| unitOfMeasure | UnitOfMeasure | ||
| unavailableDates | [String] | ||
| reservationMode | ItemReservationMode | ||
| additionalItems | [Item] | ||
| translatedContent | [TranslatedContent] | ||
| isAutoRenewalEnabled | Boolean | ||
| payWhatYouWant | Boolean | ||
| uiValues | String | ||
| redeemableItems | [String] | ||
| ticket_footer | Description | ||
| ticket_info | Description | ||
| legacyId | String | ||
| sellOnline | Boolean | ||
| sellInStore | Boolean | ||
| sellInEtags | Boolean | ||
| sellInLocations | [Location] | ||
| accountingKey | String | ||
| color | String | ||
| weekdayPrices | [WeekdayPrice] | ||
| seasonalPrices | [SeasonalPrice] | ||
| weekdayDurations | [WeekdayDuration] | ||
| seasonalDurations | [SeasonalDuration] | ||
# ItemLocationBlock
| Field | Argument | Type | Description |
|---|---|---|---|
| item | String! | ||
| location | String! | ||
# ItemOption
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| title | String | ||
| barcode | String | ||
| sku | String | ||
| type | String! | ||
| namespace | String! | ||
| price | Price! | ||
| sale_price | Price | ||
| event_guest_price | Price | ||
| description | Description | ||
| status | Boolean! | ||
| startSellTimeInMillis | Float | ||
| endSellTimeInMillis | Float | ||
| sorting_weight | Int | ||
| images | [Image] | ||
| video | Video | ||
| variations | [VariationOption] | ||
| categories | [Category] | ||
| mainCategory | Category | ||
| default_variations | [VariationOption] | ||
| exclude_discounts | Boolean | ||
| minimumOrderQuantity | Float | ||
| maximumOrderQuantity | Float | ||
| maximumGroupedQuantity | Float | ||
| maxAheadBookingInDays | Float | ||
| durationInMinutes | Float | ||
| pauseBetweenEventsInMinutes | Float | ||
| payWhatYouWant | Boolean | ||
| isAllDayEvent | Boolean | ||
| defaultQuantity | Float | ||
| unavailableDates | [String] | ||
| unitOfMeasure | UnitOfMeasure | ||
| availability | Availability | ||
| availabilityMode | String | ||
| reservationMode | ItemReservationMode | ||
| startDate | Float | ||
| endDate | Float | ||
| dates | [Float] | ||
| additionalItems | [ItemOption] | ||
| location | LocationOption | ||
| ticket_footer | Description | ||
| ticket_info | Description | ||
| ticketInfo | Description | ||
| ticketFooter | Description | ||
| redeemableItems | [String] | ||
| translatedContent | [TranslatedContent] | ||
| isAutoRenewalEnabled | Boolean | ||
| color | String | ||
| weekdayPrices | [WeekdayPrice] | ||
| seasonalPrices | [SeasonalPrice] | ||
| weekdayDurations | [WeekdayDuration] | ||
| seasonalDurations | [SeasonalDuration] | ||
# 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 | Float | ||
| comment | String | ||
| channel | String | ||
| location | Location | ||
| created | Float | ||
| changed | Float | ||
| status | String | ||
| printed | Boolean | ||
| processed | Boolean | ||
| unitPrice | Price | ||
| costPrice | Price | ||
| totalPrice | Price | ||
| totalVat | Price | ||
| totalCost | Price | ||
| entangleKey | String | ||
| deliveryDate | Float | ||
| discountPercent | Float | ||
| dimensions | Dimensions | ||
| weight | Weight | ||
| locked | Boolean | ||
| uuid | String | ||
| dynamicDescription | String | ||
| bookings | [Booking] | ||
| data | String | ||
| externalBarcode | String | ||
| staff | Staff | ||
| license_plate | String | ||
| arrival_time | String | ||
| departure_time | String | ||
| variations | [Variation] | ||
# 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 | ||
| phone | String | ||
| String | |||
| taxId | String | ||
| vatId | String | ||
| opening_hours | [OpeningHours] | ||
| opening_rule | String | ||
| gps | GPS | ||
| variations | [LocationVariation] | ||
| active | Boolean | ||
| created | Float | ||
| changed | Float | ||
| logo | Image | ||
| ept | Int | ||
| maxDeliveriesPerSlot | Int | ||
| maximumSalesPerSlot | Float | ||
| minimumNoticeForBookingsInMillis | Float | ||
| intervalBetweenSlotsInMillis | Float | ||
| pauseBetweenSlotsInMillis | Float | ||
| excludedZonesFromBookings | [Category] | ||
| excludedZonesFromOnlineBookings | [Category] | ||
| excludedLocationVariationsFromBookings | [LocationVariation] | ||
| bookableHours | [OpeningHours] | ||
| primaryColor | String | ||
| accentColor | String | ||
# LocationOption
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| label | String! | ||
| description | String | ||
| address | Address | ||
| opening_hours | [OpeningHours] | ||
| opening_rule | String | ||
| variations | [LocationVariation] | ||
| maxDeliveriesPerSlot | Int | ||
| minimumNoticeForBookingsInMillis | Float | ||
| gps | GPS | ||
| ept | Int | ||
| excludedZonesFromBookings | [Category] | ||
| excludedZonesFromOnlineBookings | [Category] | ||
| excludedLocationVariationsFromBookings | [LocationVariation] | ||
| bookableHours | [OpeningHours] | ||
| primaryColor | String | ||
| accentColor | String | ||
| intervalBetweenSlotsInMillis | Float | ||
# LocationStock
| Field | Argument | Type | Description |
|---|---|---|---|
| location | Location | ||
| item | Item | ||
| currentStock | Float | ||
| targetStock | Float | ||
| thresholdStock | Float | ||
# LocationVariation
| Field | Argument | Type | Description |
|---|---|---|---|
| label | String | ||
| status | Boolean | ||
| uuid | Int | ||
| zone | Category | ||
| shape | String | ||
| sorting_weight | Int | ||
| x | Float | ||
| y | Float | ||
| created | Float | ||
| changed | Float | ||
| minimumPersons | Int | ||
| maximumPersons | Int | ||
| standardPersons | Int | ||
| bookable | Boolean | ||
| onlineBookable | Boolean | ||
# LocationVariationCombination
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| label | String! | ||
| location | Location | ||
| locationVariations | [LocationVariation] | ||
| changedTimeInMillis | Float | ||
| createdTimeInMillis | Float | ||
| active | Boolean | ||
# LocationZone
# Zones
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| name | String | ||
| description | String | ||
| weight | String | ||
| active | Boolean | ||
| location | Location | ||
| created | Float | ||
| changed | Float | ||
# Mapping
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| sourceId | String! | ||
| context | String! | ||
| createdInMillis | Float! | ||
| changedInMillis | Float! | ||
| active | Boolean | ||
# MarketPlace
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| name | String! | ||
| description | String! | ||
| logo | String! | ||
| namespace | String! | ||
| organization | Organization | ||
| defaultCurrency | String! | ||
| defaultLanguage | String! | ||
| defaultPhoneExtension | String! | ||
| created | Float! | ||
| changed | Float! | ||
# Menu
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| organization | String! | ||
| channel | String! | ||
| data | JSON | ||
# 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 | ||
# NewYessUserResult
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean! | ||
| code | Int! | ||
| message | String! | ||
| namespace | String! | ||
# OpeningHours
| Field | Argument | Type | Description |
|---|---|---|---|
| day | String! | ||
| starthours | String | ||
| endhours | String | ||
| comment | String | ||
| maximumSalesPerSlot | Float | ||
| intervalBetweenSlotsInMillis | Float | ||
| pauseBetweenSlotsInMillis | Float | ||
# Order
| Field | Argument | Type | Description |
|---|---|---|---|
| String | |||
| billingInformation | CustomerProfile | ||
| shippingInformation | CustomerProfile | ||
| type | String! | ||
| orderId | String! | ||
| invoiceNumber | String | ||
| created | Float! | ||
| changed | Float! | ||
| state | String! | ||
| namespace | String! | ||
| lineItems | [LineItem] | ||
| payments | [PaymentTransaction] | ||
| reference | String | ||
| comment | String | ||
| balance | Price | ||
| orderTotal | Price | ||
| totalAmount | Price | ||
| totalVat | Price | ||
| totalCost | Price | ||
| tasks | String | ||
| data | JSON | ||
| entangleKey | String! | ||
| deliveryTime | Float | ||
| deliveryTimeInMillis | Float | ||
| deliveryService | DeliveryMethodInstance | ||
| location | LocationOption | ||
| locationVariation | LocationVariation | ||
| externalDeliveryResults | [ExternalDeliveryResult] | ||
| channel | ChannelOption | ||
| uuid | String! | ||
| customer | Customer | ||
| externalBarcode | String | ||
| sequence | String | ||
| seller | ReferencedOrganization | ||
| fbp | String | ||
| fbc | String | ||
| tags | [Category] | ||
# OrderOption
| Field | Argument | Type | Description |
|---|---|---|---|
| orderId | String! | ||
| state | String! | ||
| data | JSON | ||
# OrderReference
| Field | Argument | Type | Description |
|---|---|---|---|
| created | Float! | ||
| orderId | String! | ||
| location | LocationOption | ||
| customer | Customer | ||
| seller | ReferencedOrganization | ||
| lineItems | [LineItem] | ||
# OrderStateOption
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String | ||
| name | String | ||
# Organization
| Field | Argument | Type | Description |
|---|---|---|---|
| label | String | ||
| uuid | String | ||
| String | |||
| description | String | ||
| phone | String | ||
| logo | Image | ||
| cover | Image | ||
| primary_color | String | ||
| accent_color | String | ||
| ssn | String | ||
| businessType | [BusinessType] | ||
| credits | Price | ||
| formsOfPayment | [FormOfPayment] | ||
| address | Address | ||
| settings | Settings | ||
| defaultCurrency | Currency | ||
| defaultTimezone | String | ||
| hasDeliveryService | Boolean | ||
| featuredImages | [Image] | ||
# OrganizationRole
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| role_id | Int | ||
# ParentCategory
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| name | String | ||
| weight | Int | ||
# PayLinkEvent
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| message | String! | ||
# PaymentBatch
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| title | String! | ||
| description | String! | ||
| created | Float! | ||
| changed | Float! | ||
| state | PaymentBatchState! | ||
| items | [PaymentBatchItem] | ||
# PaymentBatchItem
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| order | Order | ||
| created | Float! | ||
| changed | Float! | ||
| claimed | Float | ||
| state | PaymentBatchItemState! | ||
| payment | PaymentTransaction | ||
| customer | Customer | ||
| context | String! | ||
# PaymentMethod
| Field | Argument | Type | Description |
|---|---|---|---|
| namespace | String! | ||
| title | String! | ||
| short_description | String | ||
| description | String | ||
| icon | String | ||
| configFields | [InputField] | ||
| uiFields | [InputField] | ||
| supportedCallbacks | [String] | ||
| 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 | ||
| uiFields | [InputField] | ||
| weight | Int | ||
| accountingKey | String | ||
| isApplePayCapable | Boolean | ||
| data | String | ||
| legacyId | String | ||
# PaymentMethodInstanceOption
| Field | Argument | Type | Description |
|---|---|---|---|
| icon | String | ||
| title | String! | ||
| description | String | ||
| namespace | String! | ||
| uuid | String! | ||
| checkout | Boolean | ||
| terminal | Boolean | ||
| uiFields | [InputField] | ||
| isApplePayCapable | Boolean | ||
| weight | Int | ||
| legacyId | String | ||
# 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 | JSON | ||
| created | Float! | ||
| changed | Float! | ||
| status | PaymentTransactionStatus! | ||
| entangleKey | String! | ||
| remoteId | String | ||
| verified | Boolean | ||
| message | String | ||
| friendlyMessage | String | ||
| channel | Channel | ||
| location | Location | ||
| customer | Customer | ||
| staff | Staff | ||
| orderId | String | ||
| transactionId | String | ||
# 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 | ||
| taxRate | TaxRate | ||
| data | PriceData | ||
# PriceComponent
| Field | Argument | Type | Description |
|---|---|---|---|
| amount | Float! | ||
| currency_code | String! | ||
# PriceData
| Field | Argument | Type | Description |
|---|---|---|---|
| components | [PriceComponent] | ||
| include_tax | String | ||
# PrintJob
| Field | Argument | Type | Description |
|---|---|---|---|
| UUID | String | ||
| MacAddress | String | ||
| Organization | String | ||
| Channel | String | ||
| Type | String | ||
| Content | String | ||
| StatusCode | String | ||
| Timestamp | Float | ||
| CheckinButtons | [CheckinButton] | ||
# Printer
| Field | Argument | Type | Description |
|---|---|---|---|
| _id | String | ||
| lastSeenInMillis | Float | ||
# ProcessCheckoutStepResult
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean! | ||
| message | String! | ||
| errorLevel | Int | ||
| errors | [CheckoutSectionError] | ||
# ProcessDisplaySystem
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| title | String | ||
| organization | Organization | ||
| channels | [Channel] | ||
| posChannels | [Channel] | ||
| posChannel | Channel | ||
| location | Location | ||
| categories | [Category] | ||
| states | [String] | ||
| readAccessToken | ReadAccessToken | ||
| active | Boolean | ||
| startingTimeInMillis | Float | ||
| timeOfRed | Float | ||
| timeOfYellow | Float | ||
| clickableLineItems | Boolean | ||
| stateColors | StateColors | ||
| colorWholeCard | Boolean | ||
# Puck
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| name | String! | ||
| barcode | String | ||
| active | Boolean | ||
# PuckPing
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| puck | Puck! | ||
| organization | String! | ||
# PunchCard
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| title | String! | ||
| maxPunches | Int! | ||
| currentPunchAmount | Int! | ||
| offerInterval | Int! | ||
| offers | [PunchCardOffer] | ||
| cardLevel | Int | ||
| created | Float | ||
| changed | Float | ||
| active | Boolean | ||
| user | User | ||
| template | PunchCardTemplate | ||
# PunchCardOffer
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
# PunchCardTemplate
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| title | String! | ||
| maxPunches | Int! | ||
| offerInterval | Int! | ||
| offers | [PunchCardOffer] | ||
| created | Float | ||
| changed | Float | ||
| active | Boolean | ||
| organization | Organization | ||
# Queue
| Field | Argument | Type | Description |
|---|---|---|---|
| pending | String | ||
| position | String | ||
| request | Request | ||
# ReadAccessToken
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| type | String | ||
| token | String | ||
| application | String | ||
# Receipt
| Field | Argument | Type | Description |
|---|---|---|---|
| html | String | ||
| String | |||
| number | String | ||
| invoiceNumber | String | ||
| entangleKey | String | ||
| amount | String | ||
| date | String | ||
| lineItems | [LineItem] | ||
| balance | Price | ||
| totalPrice | Price | ||
| channel | String | ||
| organization | ReferencedOrganization | ||
| location | Location | ||
| state | String | ||
# RecurringPeriod
| Field | Argument | Type | Description |
|---|---|---|---|
| interval | String | ||
| period | String | ||
# RecurringSubscription
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| label | String | ||
| item | Item! | ||
| payer | Customer! | ||
| receiver | Customer! | ||
| recurringPrice | Price | ||
| nextPayment | Float | ||
| paused | Boolean | ||
| quantity | Float! | ||
| units | Float! | ||
| discount | Int | ||
| cycle | Int! | ||
| cycles | Int | ||
| expires | Float | ||
| created | Float | ||
| changed | Float | ||
| active | Boolean | ||
| order | String | ||
| externalId | String | ||
| externalDistributionUrl | String | ||
| hasCardOnFile | Boolean | ||
# RedeemBooking
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean | ||
| message | String | ||
| redeemedAt | Float | ||
# RedeemedCoupon
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| type | String | ||
| coupon | Coupon | ||
| quantity | Float | ||
| location | LocationOption | ||
| reference | String | ||
| redeemedBy | String | ||
| redeemedAt | String | ||
| created | Float | ||
| changed | Float | ||
# ReferencedOrganization
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| label | String | ||
| phone | String | ||
| String | |||
| ssn | String | ||
| description | String | ||
| primary_color | String | ||
| accent_color | String | ||
| logo | Image | ||
| address | Address | ||
| settings | Settings | ||
| businessType | [BusinessType] | ||
| cover | Image | ||
| defaultCurrency | Currency | ||
| defaultTimezone | String | ||
| featuredImages | [Image] | ||
# Request
| Field | Argument | Type | Description |
|---|---|---|---|
| status | String | ||
| url | String | ||
# ReservationWidget
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| label | String | ||
| defaultLanguage | String | ||
| darkTheme | Boolean | ||
| organization | Organization | ||
| channel | ChannelOption | ||
| location | LocationOption | ||
| item | ItemOption | ||
| active | Boolean | ||
| created | Float | ||
| changed | Float | ||
# Response
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean | ||
| text | String | ||
| message | 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! | ||
| tabs | [RouteTab] | ||
# RouteTab
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| title | String! | ||
# RuleAction
| Field | Argument | Type | Description |
|---|---|---|---|
| title | String! | ||
| description | String! | ||
| namespace | String! | ||
# RuleCondition
| Field | Argument | Type | Description |
|---|---|---|---|
| title | String! | ||
| description | String! | ||
| namespace | String! | ||
# RuleEvent
| Field | Argument | Type | Description |
|---|---|---|---|
| title | String! | ||
| description | String! | ||
| namespace | String! | ||
# RunAppResult
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean | ||
| logs | [String] | ||
# ScheduleWidget
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| label | String | ||
| active | Boolean | ||
| created | Float | ||
| changed | Float | ||
| organization | ReferencedOrganization | ||
| channel | ChannelOption | ||
| location | LocationOption | ||
| items | [ItemOption] | ||
| categories | [Category] | ||
| darkTheme | Boolean | ||
| showImages | Boolean | ||
| booking | String | ||
| defaultLanguage | String | ||
| hideExtraInfo | Boolean | ||
| showUpsellItemsAsSwitch | Boolean | ||
| mode | String | ||
| mainButtonsRounded | Boolean | ||
| mainButtonsCapitalized | Boolean | ||
| mainButtonsColor | String | ||
| backgroundColor | String | ||
| textColor | String | ||
| primaryColor | String | ||
| minimalFooter | Boolean | ||
| hideItemPrice | Boolean | ||
| useSlotPrices | Boolean | ||
| activitiesCategory | Category | ||
| activities | [ItemOption] | ||
# SeasonalDuration
| Field | Argument | Type | Description |
|---|---|---|---|
| startInMillis | Float | ||
| endInMillis | Float | ||
| durationInMinutes | Float | ||
| active | Boolean | ||
# SeasonalPrice
| Field | Argument | Type | Description |
|---|---|---|---|
| startInMillis | Float | ||
| endInMillis | Float | ||
| price | Price | ||
| active | Boolean | ||
# 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] | ||
# Shift
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| created | Float | ||
| changed | Float | ||
| startsAtTime | Float | ||
| endsAtTime | Float | ||
| location | Location | ||
| staff | [Staff] | ||
| comment | String | ||
# 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 | ||
# Slot
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| item | String | ||
| dayOfWeek | Int | ||
| startsAt | String | ||
| endsAt | String | ||
| lengthInMillis | Float | ||
| location | String | ||
| maxBookings | Int | ||
| weekday | Int | ||
# SoftPos
| Field | Argument | Type | Description |
|---|---|---|---|
| _id | String! | ||
| channel | ChannelOption! | ||
| organization | Organization! | ||
| active | Boolean | ||
| created | Float! | ||
| changed | Float! | ||
# 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 | ||
| String | |||
| contract | [Image] | ||
| 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 | ||
| hideInEpos | Boolean | ||
# StateColors
| Field | Argument | Type | Description |
|---|---|---|---|
| new | String | ||
| pending | String | ||
| processing | String | ||
| completed | String | ||
| delivered | String | ||
# StatusResponse
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean! | ||
| message | String | ||
| payload | JSON | ||
# StockEntry
NOTE: GraphQL throws an error anytime a field contains "union" type workProfile { organizationID: String! dayPay: Float nightPay: Float union: Float unionField: Float }
| Field | Argument | Type | Description |
|---|---|---|---|
| priorAmount | Float! | ||
| newAmount | Float! | ||
| unitOfMeasure | String! | ||
| unitOfChange | Float! | ||
| note | String | ||
| lineItem | LineItem | ||
| location | Location | ||
| channel | Channel | ||
| timestamp | Float | ||
# StreamEntry
| Field | Argument | Type | Description |
|---|---|---|---|
| timestampInMillis | Float! | ||
| namespace | String! | ||
| message | String! | ||
# StringDeviceSetting
| Field | Argument | Type | Description |
|---|---|---|---|
| title | String! | ||
| key | String! | ||
| value | String! | ||
| defaultValue | String | ||
| category | String | ||
# StringListSetting
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| value | [String]! | ||
| secure | Boolean | ||
# StringSetting
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| value | String! | ||
| secure | Boolean | ||
# Subscription
| Field | Argument | Type | Description |
|---|---|---|---|
| dash | DashRender | ||
| uuid | String! | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| channels | [String] | ||
| locations | [String] | ||
| uiValues | String | ||
| timeIntervalFrom | String | ||
| timeIntervalTo | String | ||
| testSubscriptions | TestSub | ||
| orderChanged | Order | ||
| uuid | String! | ||
| ordersChanged | [Order] | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| conditions | [QueryCondition] | ||
| posOrdersChanged | [Order] | ||
| channels | [String!] | ||
| processDisplaySystem | ProcessDisplaySystem | ||
| uuid | String | ||
# SubscriptionState
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String | ||
| paidInFull | Boolean | ||
| lastPaymentAttempt | Float | ||
| paymentAttemptsCount | Int | ||
| message | String | ||
# Tablet
| Field | Argument | Type | Description |
|---|---|---|---|
| _id | String | ||
| lastSeenInMillis | Float | ||
# Task
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| namespace | String! | ||
| staff | Staff | ||
| order | String | ||
| entangleKey | String! | ||
| created | Float! | ||
| changed | Float! | ||
| status | TaskState! | ||
| line_item | LineItem | ||
# TaxRate
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| title | String! | ||
| description | String | ||
| namespace | String! | ||
| rate | Float! | ||
| priceComponent | String! | ||
| displayTitle | String! | ||
| externalId | String | ||
# TaxonomyTerm
| Field | Argument | Type | Description |
|---|---|---|---|
| tid | Int | ||
| name | String | ||
| vid | String | ||
# Team
| Field | Argument | Type | Description |
|---|---|---|---|
| role_id | Int | ||
| organization | String | ||
| user | User | ||
# TestSub
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean! | ||
# TimeSlotReservationResult
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| success | Boolean | ||
| expires | Float! | ||
# TransactionResponse
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean | ||
| message | String | ||
# TranslatedContent
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| value | String! | ||
| language | String! | ||
# Translation
| Field | Argument | Type | Description |
|---|---|---|---|
| _id | String! | ||
| uuid | String! | ||
| key | String! | ||
| language | String! | ||
| value | String! | ||
| type | String! | ||
| changed | Float | ||
| created | Float | ||
# User
| Field | Argument | Type | Description |
|---|---|---|---|
| uid | String | ||
| displayName | String | ||
| String | |||
| emailVerified | Boolean | ||
| isAnonymous | Boolean | ||
| metadata | UserMetadata | ||
| providerId | String | ||
| refreshToken | String | ||
| phoneNumber | String | ||
| photoUrl | String | ||
| lastSignIn | String | ||
| customClaims | UserClaims | ||
| organization | Organization | ||
| accessibleOrganizations | [Organization] | ||
| app | App | ||
| active | Boolean | ||
| isDevice | Boolean | ||
# UserClaims
| Field | Argument | Type | Description |
|---|---|---|---|
| admin | Boolean | ||
# UserMetadata
| Field | Argument | Type | Description |
|---|---|---|---|
| creationTime | String | ||
| lastSignInTime | String | ||
# ValidHours
| Field | Argument | Type | Description |
|---|---|---|---|
| startTime | String | ||
| endTime | 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 | ||
| value | Boolean | ||
| translatedContent | [TranslatedContent] | ||
# 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 | ||
| value | Boolean | ||
| translatedContent | [TranslatedContent] | ||
# VerifyCheckoutResult
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean! | ||
| message | String! | ||
# Video
| Field | Argument | Type | Description |
|---|---|---|---|
| title | String | ||
| url | String! | ||
# WaitingGuest
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String! | ||
| phone | String | ||
| internalComment | String | ||
| externalComment | String | ||
| createdInMillis | Float | ||
# WeekdayDuration
| Field | Argument | Type | Description |
|---|---|---|---|
| weekday | Int | ||
| hourStart | String | ||
| hourEnd | String | ||
| durationInMinutes | Float | ||
| active | Boolean | ||
# WeekdayPrice
| Field | Argument | Type | Description |
|---|---|---|---|
| weekday | Int | ||
| hourStart | String | ||
| hourEnd | String | ||
| price | Price | ||
| active | Boolean | ||
# Weight
| Field | Argument | Type | Description |
|---|---|---|---|
| weight | Float | ||
| unit | 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! | ||
# WithdrawalPerson
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| created | Float! | ||
| changed | Float! | ||
| phone | String | ||
| String | |||
| ssn | String | ||
# Work
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| label | String | ||
| type | WorkType! | ||
| 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 | Float | ||
| changed | Float | ||
| channel | Channel | ||
| location | Location | ||
| status | String | ||
| requiresApproval | Boolean | ||
| comment | String | ||
# eTag
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| tagID | String! | ||
| type | String! | ||
| property | String! | ||
| unitID | String | ||
| organization | String | ||
| description | String | ||
| isClaimable | Boolean | ||
# eptUpdate
| Field | Argument | Type | Description |
|---|---|---|---|
| success | Boolean! | ||
| message | String | ||
# notifyPrintRecipientResult
| 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
# CartItem
| Field | Type | Description | |
|---|---|---|---|
| item | String! | ||
| quantity | Float | ||
| variations | [String!] | ||
| uiValues | 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] | ||
| limitCategoryOpeningHoursCheck | Boolean | ||
| property | String | ||
| mandatoryCartItems | [String] | ||
| enableReservationMode | Boolean | ||
| slug | String | ||
| widgetUUID | String | ||
| followLocationOpeningHours | Boolean | ||
| roomServiceTakeaway | Boolean | ||
| excludePaymentMethods | [String] | ||
| hideBlockedItems | Boolean | ||
| eventsMode | Boolean | ||
# ContactOrganization
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| String! | |||
| phone | String! | ||
| message | String! | ||
| namespace | String | ||
| organizationUUID | String! | ||
| organizationEmail | String! | ||
# ContactSalesCloud
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| String! | |||
| phone | String! | ||
| message | String! | ||
| namespace | String | ||
# CreateCategory
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| description | String | ||
| weight | Int | ||
| required | Boolean | ||
| single | Boolean | ||
| administrative | Boolean | ||
| ept | Int | ||
| primary_color | String | ||
| allowSplitByHalf | Boolean | ||
| accountingKey | String | ||
| parent | [UpdateCategory] | ||
| opening_hours | [NewOpeningHours] | ||
| image | ImageInput | ||
# 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! | ||
# ImageInput
| Field | Type | Description | |
|---|---|---|---|
| title | String | ||
| alt | String | ||
| file | String | ||
# InstallApp
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| version | String | ||
| settings | String | ||
# InviteUserToOrganization
| Field | Type | Description | |
|---|---|---|---|
| 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! | ||
# NewAppUser
| Field | Type | Description | |
|---|---|---|---|
| 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 | ||
| location | String | ||
| locationVariation | String | ||
| locationVariations | [String] | ||
| quantity | Float | ||
| internalNote | String | ||
| contactName | String | ||
| contactPhone | String | ||
| contactEmail | String | ||
| externalNote | String | ||
| price | PriceInput | ||
| origin | String | ||
| paidInFull | Boolean | ||
| bookingVariation | String | ||
| notifyCustomer | Boolean | ||
# NewChannel
| Field | Type | Description | |
|---|---|---|---|
| label | String! | ||
| description | String! | ||
# NewClaims
| Field | Type | Description | |
|---|---|---|---|
| uid | String! | ||
| claims | NewInputClaims! | ||
# NewCommitLineItem
| Field | Type | Description | |
|---|---|---|---|
| quantity | Float! | ||
| item | String! | ||
# NewCoupon
| Field | Type | Description | |
|---|---|---|---|
| label | String! | ||
| description | String | ||
| code | String | ||
| maxRedemptions | Int! | ||
| timesRedeemed | Int! | ||
| percentOff | Float | ||
| effectiveStartingAtTimestampInMillis | Float | ||
| effectiveEndingAtTimestampInMillis | Float | ||
| validWeekdays | [Int] | ||
| validHours | [newValidHours] | ||
| validItems | [String] | ||
| validItemCategories | [String] | ||
| active | Boolean! | ||
| item | String | ||
| customerName | String | ||
| customerPhone | String | ||
| customerEmail | String | ||
| validLocations | [String] | ||
# NewCustomer
| Field | Type | Description | |
|---|---|---|---|
| uuid | String | ||
| customer_id | Int | ||
| label | String | ||
| ssn | String | ||
| 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 | ||
| invoiceable | Boolean | ||
| deliverInvoice | Boolean | ||
# NewDash
| Field | Type | Description | |
|---|---|---|---|
| namespace | String! | ||
| title | String! | ||
| description | String! | ||
| data | JSON | ||
| 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] | ||
| limitCategoryOpeningHoursCheck | Boolean | ||
| property | String | ||
| mandatoryCartItems | [String] | ||
| enableReservationMode | Boolean | ||
| slug | String | ||
| widgetUUID | String | ||
| followLocationOpeningHours | Boolean | ||
| roomServiceTakeaway | Boolean | ||
| excludePaymentMethods | [String] | ||
| hideBlockedItems | Boolean | ||
| eventsMode | Boolean | ||
# NewFile
| Field | Type | Description | |
|---|---|---|---|
| filename | String! | ||
| base64Data | String! | ||
| public | Boolean! | ||
| global | Boolean | ||
# NewGPS
| Field | Type | Description | |
|---|---|---|---|
| geom | String | ||
| geo_type | String | ||
| lat | String | ||
| lon | String | ||
| left | String | ||
| top | String | ||
| right | String | ||
| bottom | String | ||
| geohash | String | ||
# NewGateLog
| Field | Type | Description | |
|---|---|---|---|
| organization | String! | ||
| location | String! | ||
| type | String! | ||
| msg | String! | ||
| gateId | String! | ||
| itemId | String! | ||
# NewGiftcard
| Field | Type | Description | |
|---|---|---|---|
| amount | Float! | ||
| item | String! | ||
| expiryMonth | String! | ||
| expiryYear | String! | ||
| customerName | String | ||
| customerEmail | String | ||
| customerPhone | String | ||
| active | Boolean | ||
# NewGiftcards
| Field | Type | Description | |
|---|---|---|---|
| amount | Float! | ||
| item | String! | ||
| expiryMonth | String! | ||
| expiryYear | String! | ||
| customerName | String | ||
| customerEmail | String | ||
| customerPhone | String | ||
| active | Boolean | ||
# NewHeroUser
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| String | |||
| password | String! | ||
| phone | String | ||
| created | Float | ||
| changed | Float | ||
# 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 | ||
| weekdayPrices | [NewWeekdayPrice!] | ||
| seasonalPrices | [NewSeasonalPrice!] | ||
| weekdayDurations | [NewWeekdayDuration!] | ||
| seasonalDurations | [NewSeasonalDuration!] | ||
# NewLineItem
| Field | Type | Description | |
|---|---|---|---|
| quantity | Float! | ||
| unitPrice | PriceInput! | ||
| item | String! | ||
# NewLocation
| Field | Type | Description | |
|---|---|---|---|
| label | String! | ||
| description | String | ||
| address | NewAddress | ||
| active | Boolean | ||
| opening_hours | [NewOpeningHours] | ||
| bookableHours | [NewOpeningHours] | ||
| opening_rule | String | ||
| gps | NewGPS | ||
| maxDeliveriesPerSlot | Int | ||
| maximumSalesPerSlot | Float | ||
| intervalBetweenSlotsInMillis | Float | ||
| pauseBetweenSlotsInMillis | Float | ||
| excludedZonesFromBookings | [String] | ||
| excludedZonesFromOnlineBookings | [String] | ||
| excludedLocationVariationsFromBookings | [String] | ||
| phone | String | ||
| String | |||
# NewLocationVariation
| Field | Type | Description | |
|---|---|---|---|
| label | String! | ||
| status | Boolean | ||
| location | String! | ||
| zone | String! | ||
| shape | String | ||
| x | Float | ||
| y | Float | ||
| minimumPersons | Int | ||
| maximumPersons | Int | ||
| standardPersons | Int | ||
| sorting_weight | Int | ||
# NewLocationVariationCombination
| Field | Type | Description | |
|---|---|---|---|
| label | String! | ||
| location | String! | ||
| locationVariations | [String] | ||
| active | Boolean | ||
# NewLocationZone
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| description | String | ||
| weight | Int | ||
| location | 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! | ||
# NewOpeningHours
| Field | Type | Description | |
|---|---|---|---|
| day | String! | ||
| starthours | String | ||
| endhours | String | ||
| comment | String | ||
| maximumSalesPerSlot | Float | ||
| intervalBetweenSlotsInMillis | Float | ||
| pauseBetweenSlotsInMillis | Float | ||
# NewOrder
| Field | Type | Description | |
|---|---|---|---|
| String | |||
| uuid | String | ||
| entangleKey | String | ||
| deliveryTime | Float | ||
| location | String | ||
| channel | String | ||
| lineItems | [NewLineItem] | ||
| orderTotal | PriceInput | ||
# NewOrganization
| Field | Type | Description | |
|---|---|---|---|
| label | String! | ||
| description | String | ||
| 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 | ||
# NewPaymentTransaction
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| amount | String! | ||
| currency_code | String! | ||
| namespace | String! | ||
| instance | String! | ||
| payload | String | ||
| created | Float | ||
| changed | Float | ||
| status | PaymentTransactionStatus! | ||
| remoteId | String | ||
| verified | Boolean | ||
| message | String | ||
| order | String | ||
| acquirer | String | ||
| channel | String | ||
| details | String | ||
| entangleKey | String! | ||
| friendlyMessage | String | ||
| process | String | ||
| remoteStatus | String | ||
| resolved | Boolean | ||
| responseCode | String | ||
| serialNumber | String | ||
# NewPosLineItem
| Field | Type | Description | |
|---|---|---|---|
| quantity | Float! | ||
| item | String! | ||
| comment | String | ||
# NewPosOrder
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
# NewPrintJob
| Field | Type | Description | |
|---|---|---|---|
| MacAddress | String! | ||
| Phone | String | ||
| Channel | String | ||
| Content | String | ||
# NewProcessDisplaySystem
| Field | Type | Description | |
|---|---|---|---|
| title | String! | ||
| channels | [String!] | ||
| posChannel | String | ||
| posChannels | [String] | ||
| location | String! | ||
| categories | [String] | ||
| states | [String] | ||
| startingTimeInMillis | Float | ||
| timeOfRed | Float | ||
| timeOfYellow | Float | ||
| clickableLineItems | Boolean | ||
| stateColors | UpdateStateColors | ||
| colorWholeCard | Boolean | ||
# NewPuck
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| barcode | String | ||
# NewPuckPing
| Field | Type | Description | |
|---|---|---|---|
| puck | String! | ||
# NewPushMessage
| Field | Type | Description | |
|---|---|---|---|
| Authkey | String! | ||
| Message | String! | ||
| Topic | String! | ||
# NewReservationWidget
| Field | Type | Description | |
|---|---|---|---|
| label | String! | ||
| channel | String! | ||
| location | String! | ||
| item | String! | ||
| defaultLanguage | String! | ||
| darkTheme | Boolean! | ||
| active | Boolean! | ||
# NewSMSMessage
| Field | Type | Description | |
|---|---|---|---|
| uid | String! | ||
| message | String! | ||
| organizationUUID | String | ||
| printerMacAdress | String! | ||
| timestamp | Int | ||
# NewScheduleWidget
| Field | Type | Description | |
|---|---|---|---|
| label | String! | ||
| organization | String! | ||
| channel | String | ||
| location | String | ||
| items | [String!] | ||
| categories | [String!] | ||
| darkTheme | Boolean | ||
| showImages | Boolean | ||
| booking | String | ||
| defaultLanguage | String | ||
| hideExtraInfo | Boolean | ||
| showUpsellItemsAsSwitch | Boolean | ||
| mode | String | ||
| mainButtonsRounded | Boolean | ||
| mainButtonsCapitalized | Boolean | ||
| mainButtonsColor | String | ||
| backgroundColor | String | ||
| textColor | String | ||
| primaryColor | String | ||
| minimalFooter | Boolean | ||
| hideItemPrice | Boolean | ||
| useSlotPrices | Boolean | ||
| activitiesCategory | String | ||
# NewSeasonalDuration
| Field | Type | Description | |
|---|---|---|---|
| startInMillis | Float | ||
| endInMillis | Float | ||
| durationInMinutes | Float | ||
| active | Boolean | ||
# NewSeasonalPrice
| Field | Type | Description | |
|---|---|---|---|
| startInMillis | Float | ||
| endInMillis | Float | ||
| price | PriceInput | ||
| active | Boolean | ||
# NewServicePrintJob
| Field | Type | Description | |
|---|---|---|---|
| UnitID | String! | ||
| Organization | String! | ||
# NewSession
| Field | Type | Description | |
|---|---|---|---|
| username | String | ||
| password | String | ||
# NewShift
| Field | Type | Description | |
|---|---|---|---|
| startsAtTime | Float! | ||
| endsAtTime | Float! | ||
| location | String! | ||
| staff | [String!]! | ||
| comment | String | ||
# NewSlot
| Field | Type | Description | |
|---|---|---|---|
| item | String | ||
| dayOfWeek | Int | ||
| startsAt | String | ||
| endsAt | String | ||
| lengthInMillis | Float | ||
| location | String | ||
| maxBookings | Int | ||
| weekday | Int | ||
# NewSort
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| index | Int | ||
# NewStaff
| Field | Type | Description | |
|---|---|---|---|
| uuid | String | ||
| person_id | String | ||
| label | String | ||
| address | NewAddress | ||
| ssn | String | ||
| employment | String | ||
| phone | String | ||
| String | |||
| contract | [ImageInput] | ||
| 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 | ||
| hideInEpos | Boolean | ||
# NewTableGuest
| Field | Type | Description | |
|---|---|---|---|
| organization | String! | ||
| location | String! | ||
| tableId | String! | ||
| customerName | String! | ||
| customerKennitala | String | ||
| customerPhone | String | ||
# NewTranslatedContent
| Field | Type | Description | |
|---|---|---|---|
| key | String! | ||
| value | String! | ||
| language | String! | ||
# NewTranslation
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| key | String! | ||
| language | String! | ||
| value | String! | ||
| type | String! | ||
# NewUser
| Field | Type | Description | |
|---|---|---|---|
| String! | |||
| displayName | String! | ||
| password | String! | ||
# NewWeekdayDuration
| Field | Type | Description | |
|---|---|---|---|
| weekday | Int | ||
| hourStart | String | ||
| hourEnd | String | ||
| durationInMinutes | Float | ||
| active | Boolean | ||
# NewWeekdayPrice
| Field | Type | Description | |
|---|---|---|---|
| weekday | Int | ||
| hourStart | String | ||
| hourEnd | String | ||
| price | PriceInput | ||
| active | Boolean | ||
# NewWork
| Field | Type | Description | |
|---|---|---|---|
| uuid | String | ||
| label | String | ||
| type | WorkType | ||
| staff | String | ||
| start_date | String | ||
| end_date | String | ||
| comment | String | ||
# NewWorkForApproval
| Field | Type | Description | |
|---|---|---|---|
| staff | String | ||
| start_date | Float | ||
| end_date | Float | ||
# NewYessGroup
| Field | Type | Description | |
|---|---|---|---|
| slug | String! | ||
| title | String! | ||
| description | String! | ||
| logo | ExistingFile | ||
| cover | ExistingFile | ||
| primaryColor | String | ||
| accentColor | String | ||
| redirect | String | ||
| namespace | String! | ||
# NewYessPartnerDiscount
| Field | Type | Description | |
|---|---|---|---|
| discountPercent | Int! | ||
| partner | String! | ||
| organization | String! | ||
| namespace | String! | ||
# NewYessProfile
| Field | Type | Description | |
|---|---|---|---|
| title | String! | ||
| slug | String! | ||
| description | String! | ||
| longDescription | String | ||
| organization | String! | ||
| primaryColor | String | ||
| accentColor | String | ||
| bookTableUrl | String | ||
| location | String | ||
| categories | [String] | ||
| cateringCategories | [String] | ||
| groups | [String] | ||
| channel | String | ||
| type | AppProfileType | ||
| logo | ExistingFile | ||
| cover | ExistingFile | ||
| bookTableItem | String | ||
| discountPercent | Int | ||
| otherPaymentMethodInstances | [String!] | ||
| namespace | String! | ||
| availableActivities | [String!] | ||
| active | Boolean | ||
# NewYessUser
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| phone | String! | ||
| namespace | String | ||
# PaymentRequest
| Field | Type | Description | |
|---|---|---|---|
| amount | Int | ||
| currency_code | String | ||
| payment_method | String | ||
| status | String | ||
# PriceInput
| Field | Type | Description | |
|---|---|---|---|
| amount | Float | ||
| currency_code | String | ||
# PunchCardNew
| Field | Type | Description | |
|---|---|---|---|
| template | String | ||
| user | String | ||
# PunchCardTemplateNew
| Field | Type | Description | |
|---|---|---|---|
| title | String! | ||
| maxPunches | Int! | ||
| offerInterval | Int! | ||
| offers | [String] | ||
# PunchCardTemplateUpdated
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| title | String | ||
| maxPunches | Int | ||
| offerInterval | Int | ||
| offers | [String] | ||
| active | Boolean | ||
# PunchCardUpdated
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| title | String | ||
| currentPunchAmount | Int | ||
| active | Boolean | ||
# QueryCondition
| Field | Type | Description | |
|---|---|---|---|
| operator | QueryOperator! | ||
| property | String! | ||
| value | String | ||
| values | [String] | ||
| intValue | Int | ||
| floatValue | Float | ||
| floatValues | [Float] | ||
| booleanValue | Boolean | ||
# ReleaseApp
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| changeNotes | String! | ||
# RemoveUserFromOrganization
| Field | Type | Description | |
|---|---|---|---|
| uid | String! | ||
| organization | String! | ||
# RescheduleBooking
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| startsAtTime | Float! | ||
| endsAtTime | Float! | ||
| notifyCustomer | Boolean | ||
# SaveApp
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| description | String! | ||
| shortDescription | String | ||
| uuid | String! | ||
| logic | String! | ||
| author | String | ||
| owner | NewAppUser | ||
| developers | [NewAppUser] | ||
| editors | [NewAppUser] | ||
| group | String! | ||
| url | String | ||
| active | Boolean | ||
| dev_mode | Boolean | ||
| visibility | String! | ||
| publicKey | String | ||
| created | Float | ||
| changed | Float | ||
# SaveAppRoles
| Field | Type | Description | |
|---|---|---|---|
| owner | NewAppUser! | ||
| developers | [NewAppUser] | ||
| editors | [NewAppUser] | ||
# 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! | ||
# TranslationItem
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| translatedContent | NewTranslatedContent! | ||
# 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 | ||
| location | String | ||
| locationVariation | String | ||
| locationVariations | [String] | ||
| quantity | Float | ||
| internalNote | String | ||
| externalNote | String | ||
| contactName | String | ||
| contactPhone | String | ||
| contactEmail | String | ||
| notifyCustomer | Boolean | ||
| price | PriceInput | ||
| origin | String | ||
| paidInFull | Boolean | ||
| bookingVariation | String | ||
# UpdateCategory
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| name | String! | ||
| description | String | ||
| weight | Int | ||
| required | Boolean | ||
| single | Boolean | ||
| administrative | Boolean | ||
| ept | Int | ||
| primary_color | String | ||
| allowSplitByHalf | Boolean | ||
| accountingKey | String | ||
| parent | [UpdateCategory] | ||
| opening_hours | [NewOpeningHours] | ||
| image | ImageInput | ||
# UpdateChannel
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| label | String | ||
| description | String | ||
# UpdateCoupon
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| label | String! | ||
| description | String | ||
| maxRedemptions | Int! | ||
| timesRedeemed | Int | ||
| percentOff | Float | ||
| code | String! | ||
| effectiveStartingAtTimestampInMillis | Float | ||
| effectiveEndingAtTimestampInMillis | Float | ||
| validWeekdays | [Int] | ||
| validHours | [newValidHours] | ||
| validItems | [String] | ||
| validItemCategories | [String] | ||
| active | Boolean! | ||
| item | String | ||
| customerName | String | ||
| customerPhone | String | ||
| customerEmail | String | ||
| validLocations | [String] | ||
# UpdateCustomer
| Field | Type | Description | |
|---|---|---|---|
| uuid | String | ||
| customer_id | Int | ||
| label | String | ||
| ssn | String | ||
| 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 | ||
| deliverInvoice | Boolean | ||
# UpdateDash
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| title | String | ||
| description | String | ||
| data | JSON | ||
| weight | Int | ||
| cols | Int | ||
# UpdateDashCollection
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| name | String | ||
| period | DashCollectionPeriod | ||
| channel | String | ||
| channels | [String] | ||
| data | String | ||
| startTimeInMillis | Float | ||
| endTimeInMillis | Float | ||
| timeIntervalFrom | String | ||
| timeIntervalTo | String | ||
| active | Boolean | ||
# 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] | ||
| limitCategoryOpeningHoursCheck | Boolean | ||
| property | String | ||
| mandatoryCartItems | [String] | ||
| enableReservationMode | Boolean | ||
| slug | String | ||
| widgetUUID | String | ||
| followLocationOpeningHours | Boolean | ||
| roomServiceTakeaway | Boolean | ||
| excludePaymentMethods | [String] | ||
| hideBlockedItems | Boolean | ||
| eventsMode | Boolean | ||
# UpdateFormOfPayment
| Field | Type | Description | |
|---|---|---|---|
| uuid | String | ||
| card_id | String | ||
| amount | Float | ||
| paymentMethod | String | ||
| paymentMethodInstance | String | ||
| expiryMonth | String | ||
| expiryYear | String | ||
| customer | String | ||
| active | Boolean | ||
# UpdateGiftcard
| Field | Type | Description | |
|---|---|---|---|
| uuid | String | ||
| card_id | String | ||
| amount | Float | ||
| paymentMethod | String | ||
| paymentMethodInstance | String | ||
| expiryMonth | String | ||
| expiryYear | String | ||
| customer | String | ||
| active | Boolean | ||
# UpdateHeroUser
input AddStaff { staffID: }
| Field | Type | Description | |
|---|---|---|---|
| name | String | ||
| String | |||
| phone | String | password: String | |
| changed | Float | staffList: [UpdateStaff] organizationsList: [NewOrganization]#No UpdateOrganization? created: Float | |
# 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 | ||
| weekdayPrices | [NewWeekdayPrice!] | ||
| seasonalPrices | [NewSeasonalPrice!] | ||
| weekdayDurations | [NewWeekdayDuration!] | ||
| seasonalDurations | [NewSeasonalDuration!] | ||
# UpdateItemSortingWeight
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| sorting_weight | Int | ||
| legacyId | String | ||
# UpdateLineItem
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| quantity | Float | ||
| unitPrice | PriceInput | ||
| status | String | ||
# UpdateLocation
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| location_id | Int | ||
| label | String | ||
| description | String | ||
| address | NewAddress | ||
| active | Boolean | ||
| opening_hours | [NewOpeningHours] | ||
| bookableHours | [NewOpeningHours] | ||
| opening_rule | String | ||
| gps | NewGPS | ||
| maxDeliveriesPerSlot | Int | ||
| maximumSalesPerSlot | Float | ||
| intervalBetweenSlotsInMillis | Float | ||
| pauseBetweenSlotsInMillis | Float | ||
| excludedZonesFromBookings | [String] | ||
| excludedZonesFromOnlineBookings | [String] | ||
| excludedLocationVariationsFromBookings | [String] | ||
| phone | String | ||
| String | |||
# UpdateLocationVariation
| Field | Type | Description | |
|---|---|---|---|
| uuid | Int! | ||
| label | String | ||
| status | Boolean | ||
| location | String! | ||
| zone | String! | ||
| shape | String | ||
| x | Float | ||
| y | Float | ||
| minimumPersons | Int | ||
| maximumPersons | Int | ||
| standardPersons | Int | ||
| sorting_weight | Int | ||
# UpdateLocationZone
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| name | String | ||
| description | String | ||
| weight | Int | ||
| location | String | ||
| active | Boolean | ||
# UpdateParentCategory
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
# UpdatePosOrder
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
# UpdateProcessDisplaySystem
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| title | String | ||
| channels | [String] | ||
| posChannel | String | ||
| posChannels | [String] | ||
| location | String | ||
| categories | [String] | ||
| states | [String] | ||
| active | Boolean | ||
| startingTimeInMillis | Float | ||
| timeOfRed | Float | ||
| timeOfYellow | Float | ||
| clickableLineItems | Boolean | ||
| stateColors | UpdateStateColors | ||
| colorWholeCard | Boolean | ||
# UpdateRecurringSubscription
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| expires | Float | ||
| nextPayment | Float | ||
# UpdateReservationWidget
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| label | String | ||
| channel | String | ||
| location | String | ||
| item | String | ||
| defaultLanguage | String | ||
| darkTheme | Boolean | ||
| active | Boolean | ||
# UpdateScheduleWidget
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| active | Boolean | ||
| label | String | ||
| organization | String | ||
| channel | String | ||
| location | String | ||
| items | [String!] | ||
| categories | [String!] | ||
| darkTheme | Boolean | ||
| showImages | Boolean | ||
| booking | String | ||
| defaultLanguage | String | ||
| hideExtraInfo | Boolean | ||
| showUpsellItemsAsSwitch | Boolean | ||
| mode | String | ||
| mainButtonsRounded | Boolean | ||
| mainButtonsCapitalized | Boolean | ||
| mainButtonsColor | String | ||
| backgroundColor | String | ||
| textColor | String | ||
| primaryColor | String | ||
| minimalFooter | Boolean | ||
| hideItemPrice | Boolean | ||
| useSlotPrices | Boolean | ||
| specialEventsCategory | String | ||
# UpdateSite
| Field | Type | Description | |
|---|---|---|---|
| external_uid | String! | ||
| site_name | String! | ||
# UpdateSlot
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| item | String | ||
| dayOfWeek | Int | ||
| startsAt | String | ||
| endsAt | String | ||
| lengthInMillis | Float | ||
| location | String | ||
| maxBookings | Int | ||
| weekday | Int | ||
# UpdateStaff
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| person_id | String | ||
| label | String | ||
| address | NewAddress | ||
| ssn | String | ||
| employment | String | ||
| phone | String | ||
| String | |||
| contract | [ImageInput] | ||
| 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 | ||
| hideInEpos | Boolean | ||
# UpdateStateColors
| Field | Type | Description | |
|---|---|---|---|
| new | String | ||
| pending | String | ||
| processing | String | ||
| completed | String | ||
| delivered | String | ||
# UpdateWork
| Field | Type | Description | |
|---|---|---|---|
| uuid | String | ||
| label | String | ||
| type | WorkType | ||
| staff | String | ||
| start_date | String | ||
| end_date | String | ||
| comment | String | ||
# UpdateWorkForApproval
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| start_date | Float | ||
| end_date | Float | ||
# UpdateYessGroup
| Field | Type | Description | |
|---|---|---|---|
| slug | String! | ||
| title | String | ||
| description | String | ||
| logo | ExistingFile | ||
| cover | ExistingFile | ||
| primaryColor | String | ||
| accentColor | String | ||
| redirect | String | ||
| namespace | String! | ||
# UpdateYessProfile
| Field | Type | Description | |
|---|---|---|---|
| title | String | ||
| slug | String! | ||
| description | String | ||
| longDescription | String | ||
| primaryColor | String | ||
| accentColor | String | ||
| bookTableUrl | String | ||
| channel | String | ||
| groups | [String] | ||
| type | AppProfileType | ||
| categories | [String] | ||
| cateringCategories | [String] | ||
| location | String | ||
| logo | ExistingFile | ||
| cover | ExistingFile | ||
| bookTableItem | String | ||
| discountPercent | Int | ||
| otherPaymentMethodInstances | [String!] | ||
| namespace | String! | ||
| availableActivities | [String!] | ||
| active | Boolean | ||
# UpdatedLocationVariationCombination
| Field | Type | Description | |
|---|---|---|---|
| uuid | String! | ||
| label | String | ||
| location | String | ||
| locationVariations | [String] | ||
| active | Boolean | ||
# UserInvite
| Field | Type | Description | |
|---|---|---|---|
| String! | |||
| displayName | String! | ||
| role_id | Int! | ||
# YessClubRegistration
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| String! | |||
| phone | String! | ||
| namespace | String | ||
# YessRegistration
| Field | Type | Description | |
|---|---|---|---|
| name | String! | ||
| organization | String | ||
| String! | |||
| phone | String! | ||
| begin | String | ||
| namespace | String | ||
# YessUserLogin
| Field | Type | Description | |
|---|---|---|---|
| phone | String! | ||
| code | String | ||
| name | String | ||
| String | |||
| namespace | String | ||
# newValidHours
| Field | Type | Description | |
|---|---|---|---|
| startTime | String | ||
| endTime | String | ||
# 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 |
# AppProfileType
| Value | Description |
|---|---|
| food | |
| activity | |
| partner | |
| promoter | |
| artist |
# AppVisibility
| Value | Description |
|---|---|
| public | |
| private | |
| secret | |
| closed |
# BillingAccountState
| Value | Description |
|---|---|
| current | |
| late | |
| risk |
# BillingState
| Value | Description |
|---|---|
| canceled | |
| new | |
| paid | |
| pending | |
| billing_pending_payment |
# BookingOrigin
| Value | Description |
|---|---|
| admin | |
| online |
# BookingState
| Value | Description |
|---|---|
| active | |
| canceled | |
| reserved | |
| seated | |
| completed | |
| arrived |
# BusinessType
| Value | Description |
|---|---|
| pizza | |
| burger | |
| bakery | |
| finedine | |
| gastropub | |
| italian | |
| indian | |
| mexican | |
| activity |
# CouponAwardingMechanism
| Value | Description |
|---|---|
| prepaid | |
| fullyRedeemed |
# 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 | |
| combobox | |
| textarea | |
| textfield | |
| address | |
| country | |
| phone | |
| select | |
| text | |
| date | |
| number | |
| calendar | |
| radios | |
| buttons | |
| price | |
| dimension | |
| weight | |
| switch | |
| channels | |
| channel | |
| timezones | |
| timezone | |
| locations | |
| location | |
| html |
# ItemReservationMode
| Value | Description |
|---|---|
| relaxed | |
| strict |
# LedgerType
| Value | Description |
|---|---|
| payment | |
| sale |
# LocationOpeningRule
| Value | Description |
|---|---|
| location_is_always_closed | |
| location_is_always_open |
# MeasureOfDistance
| Value | Description |
|---|---|
| meters | |
| kilometers | |
| miles |
# 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 |
# PaymentBatchItemState
| Value | Description |
|---|---|
| pending | |
| processed | |
| cancelled | |
| completed |
# PaymentBatchState
| Value | Description |
|---|---|
| open | |
| closed | |
| pending | |
| paused | |
| cancelled | |
| completed | |
| processed |
# PaymentTransactionStatus
| Value | Description |
|---|---|
| success | |
| failure | |
| pending |
# QueryOperator
| Value | Description |
|---|---|
| equals | |
| greaterThan | |
| lessThan | |
| greaterThanOrEqualTo | |
| lessThanOrEqualTo | |
| contains | |
| isNotEmpty | |
| isEmpty | |
| between |
# QuerySort
| Value | Description |
|---|---|
| asc | |
| desc |
# RouteType
| Value | Description |
|---|---|
| nativeNormal | |
| nativeDynamic | |
| foreignNormal | |
| foreignDynamic | |
| nativeHidden |
# TaskState
| Value | Description |
|---|---|
| pending | |
| completed | |
| canceled | |
| error |
# UnitOfMeasure
| Value | Description |
|---|---|
| pieces | |
| piece | |
| milliliter | |
| centiliter | |
| liter | |
| people | |
| compartment | |
| stall | |
| hours | |
| minutes | |
| days | |
| slot | |
| room | |
| seats | |
| child | |
| children | |
| ticket | |
| table | |
| board |
# WorkType
| Value | Description |
|---|---|
| log | |
| sick_leave |
# 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.
# JSON
# 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.