speedlo GQL documentation
Generated by Anvil SpectaQL
API Endpoints
https://app.dev.speedlo.cloud/graphqlQueries
allergens
Description
Index all records of Allergen
ALLOWED ROLES: [admin, editor_menu, editor_orders, guest, super_admin, support, user]
Response
Returns [Allergen!]!
Example
Query
query allergens {
allergens {
category
code
enum
id
rawCode
}
}
Response
{
"data": {
"allergens": [
{
"category": 987,
"code": "abc123",
"enum": "CEREALS_WITH_GLUTTEN",
"id": "4",
"rawCode": "xyz789"
}
]
}
}
applicationSettings
Description
List setting for application (styles, header text, homepage url)
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor, editor_company, editor_company_branch, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user, vam]
Response
Returns an ApplicationSettings!
Example
Query
query applicationSettings(
$brand: ID,
$companyBranch: ID
) {
applicationSettings(
brand: $brand,
companyBranch: $companyBranch
) {
dynamicTranslations {
...DynamicTranslationsTranslationsFragment
}
headerText
homepageUrl
promoHeaderEnabled
promoHeaderText
promoHeaderTranslations {
...PromoHeaderTranslationFragment
}
styles {
...GraphicStyleFragment
}
userAccountsEnabledForCustomer
wifiAppInstructions {
...WiFiAppInstructionFragment
}
}
}
Variables
{"brand": 4, "companyBranch": 4}
Response
{
"data": {
"applicationSettings": {
"dynamicTranslations": DynamicTranslationsTranslations,
"headerText": "xyz789",
"homepageUrl": "abc123",
"promoHeaderEnabled": false,
"promoHeaderText": "abc123",
"promoHeaderTranslations": [PromoHeaderTranslation],
"styles": GraphicStyle,
"userAccountsEnabledForCustomer": false,
"wifiAppInstructions": [WiFiAppInstruction]
}
}
}
board
Description
Get details of Board
ALLOWED ROLES: [admin, branch_owner, brand_owner, guest, sales_representative, super_admin, supervisor, support, user]
Example
Query
query board($id: ID!) {
board(id: $id) {
backgroundImage
backgroundVideo
boardScreens {
...BoardScreenFragment
}
boardTemplate {
...BoardTemplateFragment
}
colors
companyBranch {
...CompanyBranchFragment
}
features {
...BoardFeaturesFragment
}
id
logo
name
}
}
Variables
{"id": 4}
Response
{
"data": {
"board": {
"backgroundImage": "xyz789",
"backgroundVideo": "xyz789",
"boardScreens": [BoardScreen],
"boardTemplate": BoardTemplate,
"colors": ["abc123"],
"companyBranch": CompanyBranch,
"features": BoardFeatures,
"id": 4,
"logo": "abc123",
"name": "abc123"
}
}
}
boardScreen
Description
Get details of BoardScreen
ALLOWED ROLES: [admin, branch_owner, brand_owner, guest, sales_representative, super_admin, supervisor, support, user]
Response
Returns a BoardScreen!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query boardScreen($id: ID!) {
boardScreen(id: $id) {
backgroundImage
backgroundVideo
board {
...BoardFragment
}
id
name
wareCategories {
...WareCategoryFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"boardScreen": {
"backgroundImage": "abc123",
"backgroundVideo": "xyz789",
"board": Board,
"id": 4,
"name": "xyz789",
"wareCategories": [WareCategory]
}
}
}
boardScreens
Description
Index boards
ALLOWED ROLES: [admin, branch_owner, brand_owner, guest, sales_representative, super_admin, supervisor, support, user]
Response
Returns [BoardScreen!]!
Arguments
| Name | Description |
|---|---|
board - [ID!]!
|
Example
Query
query boardScreens($board: [ID!]!) {
boardScreens(board: $board) {
backgroundImage
backgroundVideo
board {
...BoardFragment
}
id
name
wareCategories {
...WareCategoryFragment
}
}
}
Variables
{"board": [4]}
Response
{
"data": {
"boardScreens": [
{
"backgroundImage": "xyz789",
"backgroundVideo": "xyz789",
"board": Board,
"id": "4",
"name": "abc123",
"wareCategories": [WareCategory]
}
]
}
}
boardTemplate
Description
Get details of BoardTemplate
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns a BoardTemplate!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query boardTemplate($id: ID!) {
boardTemplate(id: $id) {
features {
...BoardTemplateFeaturesFragment
}
id
name
preview
styles
}
}
Variables
{"id": 4}
Response
{
"data": {
"boardTemplate": {
"features": BoardTemplateFeatures,
"id": 4,
"name": "xyz789",
"preview": "xyz789",
"styles": "xyz789"
}
}
}
boardTemplates
Description
Index board templates
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [BoardTemplate!]!
Arguments
| Name | Description |
|---|---|
features - InputBoardTemplateFeaturesIndex
|
Example
Query
query boardTemplates($features: InputBoardTemplateFeaturesIndex) {
boardTemplates(features: $features) {
features {
...BoardTemplateFeaturesFragment
}
id
name
preview
styles
}
}
Variables
{"features": InputBoardTemplateFeaturesIndex}
Response
{
"data": {
"boardTemplates": [
{
"features": BoardTemplateFeatures,
"id": "4",
"name": "xyz789",
"preview": "xyz789",
"styles": "xyz789"
}
]
}
}
boards
Description
Index boards
ALLOWED ROLES: [admin, branch_owner, brand_owner, guest, sales_representative, super_admin, supervisor, support, user]
Response
Returns [Board!]!
Example
Query
query boards(
$companyBranches: [ID!],
$boardTemplates: [ID!]
) {
boards(
companyBranches: $companyBranches,
boardTemplates: $boardTemplates
) {
backgroundImage
backgroundVideo
boardScreens {
...BoardScreenFragment
}
boardTemplate {
...BoardTemplateFragment
}
colors
companyBranch {
...CompanyBranchFragment
}
features {
...BoardFeaturesFragment
}
id
logo
name
}
}
Variables
{"companyBranches": null, "boardTemplates": null}
Response
{
"data": {
"boards": [
{
"backgroundImage": "xyz789",
"backgroundVideo": "xyz789",
"boardScreens": [BoardScreen],
"boardTemplate": BoardTemplate,
"colors": ["xyz789"],
"companyBranch": CompanyBranch,
"features": BoardFeatures,
"id": "4",
"logo": "abc123",
"name": "abc123"
}
]
}
}
businessHour
Description
Get details of BusinessHour
ALLOWED ROLES: [admin, branch_owner, brand_owner, editor_business_hour, editor_business_hours, guest, merchant, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns a BusinessHour!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query businessHour($id: ID!) {
businessHour(id: $id) {
closeAt
closed
closedNote
companyBranch {
...CompanyBranchFragment
}
id
mode
openAt
smsLabel
specificDate
specificDateLocalized
type
webLabel
weekDay {
...WeekDayFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"businessHour": {
"closeAt": "10:15:30Z",
"closed": false,
"closedNote": "abc123",
"companyBranch": CompanyBranch,
"id": 4,
"mode": "ONLINE",
"openAt": "10:15:30Z",
"smsLabel": "xyz789",
"specificDate": "2007-12-03",
"specificDateLocalized": "xyz789",
"type": "REGULAR",
"webLabel": "abc123",
"weekDay": WeekDay
}
}
}
businessHours
Description
Get all business hours based on specified filtering
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns [BusinessHour!]!
Arguments
| Name | Description |
|---|---|
companyBranch - ID!
|
|
specific - Boolean
|
Default = false |
mode - BusinessHoursModeEnum
|
Default = ONLINE |
Example
Query
query businessHours(
$companyBranch: ID!,
$specific: Boolean,
$mode: BusinessHoursModeEnum
) {
businessHours(
companyBranch: $companyBranch,
specific: $specific,
mode: $mode
) {
closeAt
closed
closedNote
companyBranch {
...CompanyBranchFragment
}
id
mode
openAt
smsLabel
specificDate
specificDateLocalized
type
webLabel
weekDay {
...WeekDayFragment
}
}
}
Variables
{"companyBranch": 4, "specific": false, "mode": "ONLINE"}
Response
{
"data": {
"businessHours": [
{
"closeAt": "10:15:30Z",
"closed": false,
"closedNote": "xyz789",
"companyBranch": CompanyBranch,
"id": 4,
"mode": "ONLINE",
"openAt": "10:15:30Z",
"smsLabel": "abc123",
"specificDate": "2007-12-03",
"specificDateLocalized": "abc123",
"type": "REGULAR",
"webLabel": "abc123",
"weekDay": WeekDay
}
]
}
}
companies
Description
Index of companies of appropriate type
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns [Company!]!
Arguments
| Name | Description |
|---|---|
companyType - CompanyTypeEnum
|
Example
Query
query companies($companyType: CompanyTypeEnum) {
companies(companyType: $companyType) {
account
address {
...AddressFragment
}
companyBranches {
...CompanyBranchFragment
}
companyConsents {
...ConsentCompanyFragment
}
companyType {
...CompanyTypeFragment
}
defaultLanguage
deliveryEnabled
dynamicTranslations {
...DynamicTranslationsTranslationsFragment
}
hasCreditsGroups
headerText
homepageUrl
id
internalNumber
mobileApplicationSetting {
...MobileApplicationSettingFragment
}
name
number
pickupEnabled
promoBanners {
...PromoBannerFragment
}
promoHeaderEnabled
promoHeaderText
promoHeaderTranslations {
...PromoHeaderTranslationFragment
}
settings {
...SettingCompanyFragment
}
styles {
...GraphicStyleFragment
}
subdomain
supportedLanguages
url
userAccountsEnabledForCustomer
vatIdent
vatPayer
wac
wareCategorySharingAllowed
wifiAppInstructions {
...WiFiAppInstructionFragment
}
}
}
Variables
{"companyType": "CLIENT"}
Response
{
"data": {
"companies": [
{
"account": "xyz789",
"address": Address,
"companyBranches": [CompanyBranch],
"companyConsents": [ConsentCompany],
"companyType": CompanyType,
"defaultLanguage": "CS",
"deliveryEnabled": false,
"dynamicTranslations": DynamicTranslationsTranslations,
"hasCreditsGroups": false,
"headerText": "xyz789",
"homepageUrl": "abc123",
"id": "4",
"internalNumber": "abc123",
"mobileApplicationSetting": MobileApplicationSetting,
"name": "abc123",
"number": "xyz789",
"pickupEnabled": true,
"promoBanners": [PromoBanner],
"promoHeaderEnabled": false,
"promoHeaderText": "abc123",
"promoHeaderTranslations": [
PromoHeaderTranslation
],
"settings": SettingCompany,
"styles": GraphicStyle,
"subdomain": "abc123",
"supportedLanguages": ["CS"],
"url": "abc123",
"userAccountsEnabledForCustomer": false,
"vatIdent": "xyz789",
"vatPayer": true,
"wac": "xyz789",
"wareCategorySharingAllowed": false,
"wifiAppInstructions": [WiFiAppInstruction]
}
]
}
}
company
Description
Get details of Company
ALLOWED ROLES: [admin, branch_owner, brand_owner, driver, editor_company, guest, sales_representative, super_admin, supervisor, support, user, vam]
Example
Query
query company($id: ID!) {
company(id: $id) {
account
address {
...AddressFragment
}
companyBranches {
...CompanyBranchFragment
}
companyConsents {
...ConsentCompanyFragment
}
companyType {
...CompanyTypeFragment
}
defaultLanguage
deliveryEnabled
dynamicTranslations {
...DynamicTranslationsTranslationsFragment
}
hasCreditsGroups
headerText
homepageUrl
id
internalNumber
mobileApplicationSetting {
...MobileApplicationSettingFragment
}
name
number
pickupEnabled
promoBanners {
...PromoBannerFragment
}
promoHeaderEnabled
promoHeaderText
promoHeaderTranslations {
...PromoHeaderTranslationFragment
}
settings {
...SettingCompanyFragment
}
styles {
...GraphicStyleFragment
}
subdomain
supportedLanguages
url
userAccountsEnabledForCustomer
vatIdent
vatPayer
wac
wareCategorySharingAllowed
wifiAppInstructions {
...WiFiAppInstructionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"company": {
"account": "abc123",
"address": Address,
"companyBranches": [CompanyBranch],
"companyConsents": [ConsentCompany],
"companyType": CompanyType,
"defaultLanguage": "CS",
"deliveryEnabled": false,
"dynamicTranslations": DynamicTranslationsTranslations,
"hasCreditsGroups": false,
"headerText": "abc123",
"homepageUrl": "abc123",
"id": "4",
"internalNumber": "abc123",
"mobileApplicationSetting": MobileApplicationSetting,
"name": "xyz789",
"number": "xyz789",
"pickupEnabled": true,
"promoBanners": [PromoBanner],
"promoHeaderEnabled": true,
"promoHeaderText": "abc123",
"promoHeaderTranslations": [PromoHeaderTranslation],
"settings": SettingCompany,
"styles": GraphicStyle,
"subdomain": "abc123",
"supportedLanguages": ["CS"],
"url": "abc123",
"userAccountsEnabledForCustomer": true,
"vatIdent": "xyz789",
"vatPayer": true,
"wac": "abc123",
"wareCategorySharingAllowed": true,
"wifiAppInstructions": [WiFiAppInstruction]
}
}
}
companyBranch
Description
Get details of CompanyBranch
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor, editor_company_branch, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user, vam]
Response
Returns a CompanyBranch!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query companyBranch($id: ID!) {
companyBranch(id: $id) {
accountNumber
address {
...AddressFragment
}
allowedCategories
brand {
...CompanyFragment
}
businessHours {
...BusinessHourFragment
}
businessHoursIntervals {
...BusinessHourIntervalFragment
}
businessHoursMidnight
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
company {
...CompanyFragment
}
covers {
...RecipeFragment
}
creditsGroupMembership {
...CreditsGroupMembershipFragment
}
currencies {
...CurrencyFragment
}
currentDeliveryTime
currentInterval {
...BusinessHourIntervalFragment
}
currentPickupTime
defaultCurrency {
...CurrencyFragment
}
defaultDeliveryTime
defaultDeliveryTimeEnabled
defaultLanguage
defaultPickupTime
defaultPickupTimeEnabled
defaultVats {
...VatPriceTypeFragment
}
delayedDeliveryEnabled
delayedDeliveryIntervals {
...BusinessHourIntervalFragment
}
delayedDeliveryLimit
deliveryAsapEnabled
deliveryEnabled
driverOrderAssignments {
...UserDeliveringOrdersAssignmentTypeFragment
}
driverSmsText
dynamicTranslations {
...DynamicTranslationsTranslationsFragment
}
earlyDriverAssignment
eetCertificate {
...EETCertificateFragment
}
employers {
...UserFragment
}
enabled
foodMenuUrl
gpTomIntegrationAllowed
gps {
...GeoPointFragment
}
headerText
homepageUrl
id
incomingStockTransfer {
...StockTransferFragment
}
infoMessage
internalNumber
isOpen
kitchenModuleEnabled
lastInvoiceSequence
lastResettableInvoiceSequence
maxCartSize
mobileApplicationSetting {
...MobileApplicationSettingFragment
}
name
occasions {
...OccasionFragment
}
oldOrderThreshold
outcomingStockTransfer {
...StockTransferFragment
}
overriddenDeliveryTime {
...OrderProcessTimeFragment
}
overriddenPickupTime {
...OrderProcessTimeFragment
}
paymentMethods {
...PaymentMethodBranchFragment
}
phone
pickupAsapEnabled
pickupEnabled
pohodaEnabled
popUpMessage
popUpMessageFromBranch
promoBanners {
...PromoBannerFragment
}
promoCodeLimit
promoHeaderEnabled
promoHeaderText
promoHeaderTranslations {
...PromoHeaderTranslationFragment
}
settings {
...SettingCompanyBranchFragment
}
shifts {
...ShiftFragment
}
stockItemsCanBeNegative
styles {
...GraphicStyleFragment
}
supportedLanguages
url
urlPath
userAccountsEnabledForCustomer
wac
wareCategories {
...WareCategoryFragment
}
wifiAppInstructions {
...WiFiAppInstructionFragment
}
willCloseAt
willOpenAt
zones {
...ZoneFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"companyBranch": {
"accountNumber": "xyz789",
"address": Address,
"allowedCategories": ["MAIN"],
"brand": Company,
"businessHours": [BusinessHour],
"businessHoursIntervals": [BusinessHourInterval],
"businessHoursMidnight": "10:15:30Z",
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"company": Company,
"covers": [Recipe],
"creditsGroupMembership": CreditsGroupMembership,
"currencies": [Currency],
"currentDeliveryTime": 987,
"currentInterval": BusinessHourInterval,
"currentPickupTime": 987,
"defaultCurrency": Currency,
"defaultDeliveryTime": 123,
"defaultDeliveryTimeEnabled": true,
"defaultLanguage": "CS",
"defaultPickupTime": 123,
"defaultPickupTimeEnabled": false,
"defaultVats": [VatPriceType],
"delayedDeliveryEnabled": false,
"delayedDeliveryIntervals": [BusinessHourInterval],
"delayedDeliveryLimit": 987,
"deliveryAsapEnabled": false,
"deliveryEnabled": true,
"driverOrderAssignments": [
UserDeliveringOrdersAssignmentType
],
"driverSmsText": "xyz789",
"dynamicTranslations": DynamicTranslationsTranslations,
"earlyDriverAssignment": false,
"eetCertificate": EETCertificate,
"employers": [User],
"enabled": false,
"foodMenuUrl": "abc123",
"gpTomIntegrationAllowed": false,
"gps": GeoPoint,
"headerText": "abc123",
"homepageUrl": "abc123",
"id": 4,
"incomingStockTransfer": [StockTransfer],
"infoMessage": "xyz789",
"internalNumber": "abc123",
"isOpen": true,
"kitchenModuleEnabled": false,
"lastInvoiceSequence": 987,
"lastResettableInvoiceSequence": 987,
"maxCartSize": 987,
"mobileApplicationSetting": MobileApplicationSetting,
"name": "abc123",
"occasions": [Occasion],
"oldOrderThreshold": 987,
"outcomingStockTransfer": [StockTransfer],
"overriddenDeliveryTime": OrderProcessTime,
"overriddenPickupTime": OrderProcessTime,
"paymentMethods": [PaymentMethodBranch],
"phone": "abc123",
"pickupAsapEnabled": true,
"pickupEnabled": false,
"pohodaEnabled": true,
"popUpMessage": "abc123",
"popUpMessageFromBranch": false,
"promoBanners": [PromoBanner],
"promoCodeLimit": 123,
"promoHeaderEnabled": false,
"promoHeaderText": "abc123",
"promoHeaderTranslations": [PromoHeaderTranslation],
"settings": SettingCompanyBranch,
"shifts": [Shift],
"stockItemsCanBeNegative": false,
"styles": GraphicStyle,
"supportedLanguages": ["CS"],
"url": "xyz789",
"urlPath": "abc123",
"userAccountsEnabledForCustomer": false,
"wac": "xyz789",
"wareCategories": [WareCategory],
"wifiAppInstructions": [WiFiAppInstruction],
"willCloseAt": "2007-12-03T10:15:30Z",
"willOpenAt": "2007-12-03T10:15:30Z",
"zones": [Zone]
}
}
}
companyBranchLookUp
Description
Find a suitable company branch.
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor, editor_company_branch, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user, vam]
Response
Returns a CompanyBrandLookUp!
Example
Query
query companyBranchLookUp(
$hostUrl: String,
$findNearestCompanyBranch: Boolean
) {
companyBranchLookUp(
hostUrl: $hostUrl,
findNearestCompanyBranch: $findNearestCompanyBranch
) {
analyticsCodes {
...AnalyticsCodeFragment
}
brand {
...CompanyFragment
}
companyBranch {
...CompanyBranchFragment
}
companyBranches {
...CompanyBranchFragment
}
googleAnalyticsCode
isBrandUrl
isBrandWac
isMobileApp
knownBasePath
orderOrigin
redirectUrl
sector {
...SectorFragment
}
userDefaultLanguage
}
}
Variables
{
"hostUrl": "abc123",
"findNearestCompanyBranch": false
}
Response
{
"data": {
"companyBranchLookUp": {
"analyticsCodes": [AnalyticsCode],
"brand": Company,
"companyBranch": CompanyBranch,
"companyBranches": [CompanyBranch],
"googleAnalyticsCode": "xyz789",
"isBrandUrl": true,
"isBrandWac": false,
"isMobileApp": false,
"knownBasePath": "abc123",
"orderOrigin": "DAME_JIDLO",
"redirectUrl": "abc123",
"sector": Sector,
"userDefaultLanguage": "CS"
}
}
}
companyBranches
Description
Get all company branches of defined company
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor, editor_company_branch, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user, vam]
Response
Returns [CompanyBranch!]!
Example
Query
query companyBranches(
$ids: [ID!],
$company: ID,
$brand: ID,
$portal: Boolean,
$woltMenuSync: Boolean
) {
companyBranches(
ids: $ids,
company: $company,
brand: $brand,
portal: $portal,
woltMenuSync: $woltMenuSync
) {
accountNumber
address {
...AddressFragment
}
allowedCategories
brand {
...CompanyFragment
}
businessHours {
...BusinessHourFragment
}
businessHoursIntervals {
...BusinessHourIntervalFragment
}
businessHoursMidnight
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
company {
...CompanyFragment
}
covers {
...RecipeFragment
}
creditsGroupMembership {
...CreditsGroupMembershipFragment
}
currencies {
...CurrencyFragment
}
currentDeliveryTime
currentInterval {
...BusinessHourIntervalFragment
}
currentPickupTime
defaultCurrency {
...CurrencyFragment
}
defaultDeliveryTime
defaultDeliveryTimeEnabled
defaultLanguage
defaultPickupTime
defaultPickupTimeEnabled
defaultVats {
...VatPriceTypeFragment
}
delayedDeliveryEnabled
delayedDeliveryIntervals {
...BusinessHourIntervalFragment
}
delayedDeliveryLimit
deliveryAsapEnabled
deliveryEnabled
driverOrderAssignments {
...UserDeliveringOrdersAssignmentTypeFragment
}
driverSmsText
dynamicTranslations {
...DynamicTranslationsTranslationsFragment
}
earlyDriverAssignment
eetCertificate {
...EETCertificateFragment
}
employers {
...UserFragment
}
enabled
foodMenuUrl
gpTomIntegrationAllowed
gps {
...GeoPointFragment
}
headerText
homepageUrl
id
incomingStockTransfer {
...StockTransferFragment
}
infoMessage
internalNumber
isOpen
kitchenModuleEnabled
lastInvoiceSequence
lastResettableInvoiceSequence
maxCartSize
mobileApplicationSetting {
...MobileApplicationSettingFragment
}
name
occasions {
...OccasionFragment
}
oldOrderThreshold
outcomingStockTransfer {
...StockTransferFragment
}
overriddenDeliveryTime {
...OrderProcessTimeFragment
}
overriddenPickupTime {
...OrderProcessTimeFragment
}
paymentMethods {
...PaymentMethodBranchFragment
}
phone
pickupAsapEnabled
pickupEnabled
pohodaEnabled
popUpMessage
popUpMessageFromBranch
promoBanners {
...PromoBannerFragment
}
promoCodeLimit
promoHeaderEnabled
promoHeaderText
promoHeaderTranslations {
...PromoHeaderTranslationFragment
}
settings {
...SettingCompanyBranchFragment
}
shifts {
...ShiftFragment
}
stockItemsCanBeNegative
styles {
...GraphicStyleFragment
}
supportedLanguages
url
urlPath
userAccountsEnabledForCustomer
wac
wareCategories {
...WareCategoryFragment
}
wifiAppInstructions {
...WiFiAppInstructionFragment
}
willCloseAt
willOpenAt
zones {
...ZoneFragment
}
}
}
Variables
{
"ids": ["4"],
"company": "4",
"brand": "4",
"portal": false,
"woltMenuSync": false
}
Response
{
"data": {
"companyBranches": [
{
"accountNumber": "xyz789",
"address": Address,
"allowedCategories": ["MAIN"],
"brand": Company,
"businessHours": [BusinessHour],
"businessHoursIntervals": [BusinessHourInterval],
"businessHoursMidnight": "10:15:30Z",
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"company": Company,
"covers": [Recipe],
"creditsGroupMembership": CreditsGroupMembership,
"currencies": [Currency],
"currentDeliveryTime": 987,
"currentInterval": BusinessHourInterval,
"currentPickupTime": 987,
"defaultCurrency": Currency,
"defaultDeliveryTime": 123,
"defaultDeliveryTimeEnabled": false,
"defaultLanguage": "CS",
"defaultPickupTime": 987,
"defaultPickupTimeEnabled": false,
"defaultVats": [VatPriceType],
"delayedDeliveryEnabled": false,
"delayedDeliveryIntervals": [
BusinessHourInterval
],
"delayedDeliveryLimit": 123,
"deliveryAsapEnabled": true,
"deliveryEnabled": false,
"driverOrderAssignments": [
UserDeliveringOrdersAssignmentType
],
"driverSmsText": "xyz789",
"dynamicTranslations": DynamicTranslationsTranslations,
"earlyDriverAssignment": false,
"eetCertificate": EETCertificate,
"employers": [User],
"enabled": false,
"foodMenuUrl": "xyz789",
"gpTomIntegrationAllowed": true,
"gps": GeoPoint,
"headerText": "xyz789",
"homepageUrl": "xyz789",
"id": "4",
"incomingStockTransfer": [StockTransfer],
"infoMessage": "abc123",
"internalNumber": "abc123",
"isOpen": true,
"kitchenModuleEnabled": true,
"lastInvoiceSequence": 123,
"lastResettableInvoiceSequence": 987,
"maxCartSize": 123,
"mobileApplicationSetting": MobileApplicationSetting,
"name": "abc123",
"occasions": [Occasion],
"oldOrderThreshold": 123,
"outcomingStockTransfer": [StockTransfer],
"overriddenDeliveryTime": OrderProcessTime,
"overriddenPickupTime": OrderProcessTime,
"paymentMethods": [PaymentMethodBranch],
"phone": "abc123",
"pickupAsapEnabled": true,
"pickupEnabled": true,
"pohodaEnabled": false,
"popUpMessage": "xyz789",
"popUpMessageFromBranch": false,
"promoBanners": [PromoBanner],
"promoCodeLimit": 987,
"promoHeaderEnabled": true,
"promoHeaderText": "abc123",
"promoHeaderTranslations": [
PromoHeaderTranslation
],
"settings": SettingCompanyBranch,
"shifts": [Shift],
"stockItemsCanBeNegative": false,
"styles": GraphicStyle,
"supportedLanguages": ["CS"],
"url": "abc123",
"urlPath": "xyz789",
"userAccountsEnabledForCustomer": false,
"wac": "abc123",
"wareCategories": [WareCategory],
"wifiAppInstructions": [WiFiAppInstruction],
"willCloseAt": "2007-12-03T10:15:30Z",
"willOpenAt": "2007-12-03T10:15:30Z",
"zones": [Zone]
}
]
}
}
companyBranchesLookUp
Description
Obtain all company branches that deliver to appropriate address
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor, editor_company_branch, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user, vam]
Response
Returns a CompanyBranchesLookUp!
Example
Query
query companyBranchesLookUp(
$address: String!,
$companyBranchIds: [ID!]
) {
companyBranchesLookUp(
address: $address,
companyBranchIds: $companyBranchIds
) {
finalAddress {
...JsonAddressFragment
}
finalAddressFormatted
gpsCoordinates {
...GeoPointFragment
}
isResolved
isValidAddress
resolvedBranches {
...ResolvedCompanyBranchFragment
}
}
}
Variables
{
"address": "xyz789",
"companyBranchIds": [4]
}
Response
{
"data": {
"companyBranchesLookUp": {
"finalAddress": JsonAddress,
"finalAddressFormatted": "xyz789",
"gpsCoordinates": GeoPoint,
"isResolved": true,
"isValidAddress": false,
"resolvedBranches": [ResolvedCompanyBranch]
}
}
}
consent
Description
Get details of Consent
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Example
Query
query consent($id: ID!) {
consent(id: $id) {
description
expiration
id
isMandatory
name
oneTime
parent {
...ConsentFragment
}
type {
...ConsentsTypeFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"consent": {
"description": "abc123",
"expiration": 123,
"id": 4,
"isMandatory": true,
"name": "xyz789",
"oneTime": true,
"parent": Consent,
"type": ConsentsType
}
}
}
consentRevokeTypes
Description
Index all records of ConsentRevokeType
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [ConsentsRevokeType!]!
Example
Query
query consentRevokeTypes {
consentRevokeTypes {
code
enum
id
rawCode
}
}
Response
{
"data": {
"consentRevokeTypes": [
{
"code": "xyz789",
"enum": "ONE_TIME",
"id": "4",
"rawCode": "xyz789"
}
]
}
}
consentTypes
Description
Index all records of ConsentType
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [ConsentsType!]!
Example
Query
query consentTypes {
consentTypes {
code
enum
id
rawCode
}
}
Response
{
"data": {
"consentTypes": [
{
"code": "abc123",
"enum": "TERMS_AND_CONDITIONS",
"id": "4",
"rawCode": "abc123"
}
]
}
}
countries
Description
Index all records of Country
ALLOWED ROLES: [admin, editor_country, editor_menu, guest, operator, super_admin, support, user]
Response
Returns [Country!]!
Example
Query
query countries {
countries {
cashPaymentDecimals
cashPaymentUnit
cashlessWalletLimit
code
countryVats {
...VatFragment
}
currency {
...CurrencyFragment
}
enum
id
phonePrefix
rawCode
}
}
Response
{
"data": {
"countries": [
{
"cashPaymentDecimals": 987,
"cashPaymentUnit": 123.45,
"cashlessWalletLimit": 123.45,
"code": "abc123",
"countryVats": [Vat],
"currency": Currency,
"enum": "RSA",
"id": "4",
"phonePrefix": "xyz789",
"rawCode": "xyz789"
}
]
}
}
country
Description
Get details of Country
ALLOWED ROLES: [admin, editor_country, editor_menu, guest, operator, super_admin, support, user]
Example
Query
query country($id: ID!) {
country(id: $id) {
cashPaymentDecimals
cashPaymentUnit
cashlessWalletLimit
code
countryVats {
...VatFragment
}
currency {
...CurrencyFragment
}
enum
id
phonePrefix
rawCode
}
}
Variables
{"id": 4}
Response
{
"data": {
"country": {
"cashPaymentDecimals": 987,
"cashPaymentUnit": 123.45,
"cashlessWalletLimit": 987.65,
"code": "abc123",
"countryVats": [Vat],
"currency": Currency,
"enum": "RSA",
"id": 4,
"phonePrefix": "xyz789",
"rawCode": "xyz789"
}
}
}
creditsCashlessWallet
Description
Lookup a Cashless Wallet by NFC ID
ALLOWED ROLES: [admin, cashier_pos, customer, editor_wallet_credits, editor_wallet_credits_refund, guest, super_admin, support]
Response
Returns a CreditsCashlessWalletLookup!
Arguments
| Name | Description |
|---|---|
nfcId - String!
|
Example
Query
query creditsCashlessWallet($nfcId: String!) {
creditsCashlessWallet(nfcId: $nfcId) {
wallet {
...CreditsWalletFragment
}
}
}
Variables
{"nfcId": "abc123"}
Response
{
"data": {
"creditsCashlessWallet": {"wallet": CreditsWallet}
}
}
creditsWallet
Description
Details of a Wallet
ALLOWED ROLES: [admin, cashier_pos, customer, editor_wallet_credits, editor_wallet_credits_refund, guest, super_admin, support]
Response
Returns a CreditsWallet!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query creditsWallet($id: ID!) {
creditsWallet(id: $id) {
balance {
...CreditsPriceConvertedFragment
}
canTopUpMax {
...PriceConvertedFragment
}
cashPaymentDecimals
cashPaymentUnit
closedAt
companyBranches {
...CompanyBranchFragment
}
creditsExpiringSoon {
...CreditsWalletActivityConnectionFragment
}
creditsPendingRewards {
...CreditsRewardConnectionFragment
}
creditsRewards {
...CreditsRewardConnectionFragment
}
creditsWalletActivities {
...CreditsWalletActivityConnectionFragment
}
currency {
...CurrencyFragment
}
currentBalanceLimit {
...PriceConvertedFragment
}
currentBalanceLimitLeft {
...PriceConvertedFragment
}
currentBalanceLimitUsage {
...PriceConvertedFragment
}
group {
...CreditsGroupFragment
}
id
isClosed
name
nfcId
refundRequest {
...CreditsRefundRequestFragment
}
topUpLimit {
...PriceConvertedFragment
}
topUpLimitLeft {
...PriceConvertedFragment
}
topUpLimitUsage {
...PriceConvertedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"creditsWallet": {
"balance": CreditsPriceConverted,
"canTopUpMax": PriceConverted,
"cashPaymentDecimals": 123,
"cashPaymentUnit": 987.65,
"closedAt": "2007-12-03T10:15:30Z",
"companyBranches": [CompanyBranch],
"creditsExpiringSoon": CreditsWalletActivityConnection,
"creditsPendingRewards": CreditsRewardConnection,
"creditsRewards": CreditsRewardConnection,
"creditsWalletActivities": CreditsWalletActivityConnection,
"currency": Currency,
"currentBalanceLimit": PriceConverted,
"currentBalanceLimitLeft": PriceConverted,
"currentBalanceLimitUsage": PriceConverted,
"group": CreditsGroup,
"id": "4",
"isClosed": true,
"name": "abc123",
"nfcId": "abc123",
"refundRequest": CreditsRefundRequest,
"topUpLimit": PriceConverted,
"topUpLimitLeft": PriceConverted,
"topUpLimitUsage": PriceConverted
}
}
}
creditsWalletActivity
Description
Details of a WalletActivity
ALLOWED ROLES: [admin, customer, guest, super_admin, support]
Response
Returns a CreditsWalletActivity!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query creditsWalletActivity($id: ID!) {
creditsWalletActivity(id: $id) {
activityType {
...CreditsWalletActivityTypeFragment
}
amount {
...CreditsPriceConvertedFragment
}
cashPaymentDecimals
cashPaymentUnit
companyBranch {
...CompanyBranchFragment
}
createdAt
currency {
...CurrencyFragment
}
expiresAt
group {
...CreditsGroupFragment
}
id
isExpired
isExpiringSoon
order {
...OrderFragment
}
remainingAmount {
...CreditsPriceConvertedFragment
}
wallet {
...CreditsWalletFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"creditsWalletActivity": {
"activityType": CreditsWalletActivityType,
"amount": CreditsPriceConverted,
"cashPaymentDecimals": 987,
"cashPaymentUnit": 987.65,
"companyBranch": CompanyBranch,
"createdAt": "2007-12-03T10:15:30Z",
"currency": Currency,
"expiresAt": "2007-12-03T10:15:30Z",
"group": CreditsGroup,
"id": 4,
"isExpired": false,
"isExpiringSoon": false,
"order": Order,
"remainingAmount": CreditsPriceConverted,
"wallet": CreditsWallet
}
}
}
currencies
Description
Index all records of Currency
ALLOWED ROLES: [admin, editor_currency, guest, super_admin, support, user]
Response
Returns [Currency!]!
Example
Query
query currencies {
currencies {
code
decimalRound
enum
exchangeRate
id
rawCode
}
}
Response
{
"data": {
"currencies": [
{
"code": "abc123",
"decimalRound": 987,
"enum": "CZK",
"exchangeRate": 123.45,
"id": "4",
"rawCode": "xyz789"
}
]
}
}
currency
Description
Get details of Currency
ALLOWED ROLES: [admin, editor_currency, guest, super_admin, support, user]
Example
Query
query currency($id: ID!) {
currency(id: $id) {
code
decimalRound
enum
exchangeRate
id
rawCode
}
}
Variables
{"id": "4"}
Response
{
"data": {
"currency": {
"code": "xyz789",
"decimalRound": 123,
"enum": "CZK",
"exchangeRate": 987.65,
"id": "4",
"rawCode": "xyz789"
}
}
}
deliverySlots
Description
Get all delivery slots from now + default_order_process_time until delayed_delivery_limit. If a Zone is passed in as argument, its delivery_deviation_minutes is added to the delayed_delivery_limit.
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [DeliverySlot!]!
Example
Query
query deliverySlots(
$companyBranch: ID!,
$deliveryType: DeliveryTypeEnum!,
$zone: ID,
$taken: Boolean,
$empty: Boolean,
$full: Boolean
) {
deliverySlots(
companyBranch: $companyBranch,
deliveryType: $deliveryType,
zone: $zone,
taken: $taken,
empty: $empty,
full: $full
) {
capacity
capacityTaken
companyBranch {
...CompanyBranchFragment
}
deliveryType {
...DeliveryTypeFragment
}
endAt
id
isFull
startAt
userEdited
}
}
Variables
{
"companyBranch": 4,
"deliveryType": "PICKUP",
"zone": null,
"taken": false,
"empty": false,
"full": false
}
Response
{
"data": {
"deliverySlots": [
{
"capacity": 987,
"capacityTaken": 987,
"companyBranch": CompanyBranch,
"deliveryType": DeliveryType,
"endAt": "2007-12-03T10:15:30Z",
"id": 4,
"isFull": false,
"startAt": "2007-12-03T10:15:30Z",
"userEdited": true
}
]
}
}
deliveryTypes
Description
Index all records of DeliveryType
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [DeliveryType!]!
Example
Query
query deliveryTypes {
deliveryTypes {
code
enum
id
rawCode
}
}
Response
{
"data": {
"deliveryTypes": [
{
"code": "xyz789",
"enum": "PICKUP",
"id": "4",
"rawCode": "xyz789"
}
]
}
}
greeting
Description
Generate a customised greeting for the current user.
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns a Greeting!
Arguments
| Name | Description |
|---|---|
arguments - GreetingsInputArgumentsRead
|
Example
Query
query greeting($arguments: GreetingsInputArgumentsRead) {
greeting(arguments: $arguments) {
message
}
}
Variables
{"arguments": GreetingsInputArgumentsRead}
Response
{
"data": {
"greeting": {"message": "xyz789"}
}
}
languages
Description
Index all records of Language
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [Language!]!
Example
Query
query languages {
languages {
code
enum
id
rawCode
}
}
Response
{
"data": {
"languages": [
{
"code": "abc123",
"enum": "CS",
"id": "4",
"rawCode": "abc123"
}
]
}
}
mobileApplicationSettings
Description
List setting for mobile application
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor, editor_company_branch, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user, vam]
Response
Returns a MobileApplicationSetting
Arguments
| Name | Description |
|---|---|
companyBranch - ID!
|
|
platform - MobilePlatformEnum!
|
Example
Query
query mobileApplicationSettings(
$companyBranch: ID!,
$platform: MobilePlatformEnum!
) {
mobileApplicationSettings(
companyBranch: $companyBranch,
platform: $platform
) {
icon
title
url
}
}
Variables
{"companyBranch": 4, "platform": "ANDROID"}
Response
{
"data": {
"mobileApplicationSettings": {
"icon": "abc123",
"title": "abc123",
"url": "abc123"
}
}
}
order
Description
Get appropriate order
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Example
Query
query order($id: ID!) {
order(id: $id) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"order": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 987,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": 4,
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 123,
"isAnonymous": true,
"isCancelable": true,
"isCustomerRegistered": true,
"isFinalized": true,
"isPaidWithCard": false,
"isPartiallyFinalized": true,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
orderMenuAdmin
Description
Get categories of recipes
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier_menu, editor_menu, editor_ware_category, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns [OrderMenu!]!
Arguments
| Name | Description |
|---|---|
companyBranch - ID!
|
|
wareCategoryType - WareCategoryTypeEnum!
|
|
orderOriginCategory - OrderOriginCategoryEnum!
|
|
language - LanguageEnum
|
Example
Query
query orderMenuAdmin(
$companyBranch: ID!,
$wareCategoryType: WareCategoryTypeEnum!,
$orderOriginCategory: OrderOriginCategoryEnum!,
$language: LanguageEnum
) {
orderMenuAdmin(
companyBranch: $companyBranch,
wareCategoryType: $wareCategoryType,
orderOriginCategory: $orderOriginCategory,
language: $language
) {
availabilities {
...AvailabilityFragment
}
id
isAvailable
nameLabel
pictogram
recipes {
...OrderMenuRecipeFragment
}
wareCategoryColor {
...WareCategoryColorFragment
}
}
}
Variables
{
"companyBranch": "4",
"wareCategoryType": "MAIN",
"orderOriginCategory": "DOVEZE",
"language": "CS"
}
Response
{
"data": {
"orderMenuAdmin": [
{
"availabilities": [Availability],
"id": 4,
"isAvailable": true,
"nameLabel": "xyz789",
"pictogram": "abc123",
"recipes": [OrderMenuRecipe],
"wareCategoryColor": WareCategoryColor
}
]
}
}
orderOnlinePaymentStatus
Description
Reload information about payment status from external service
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an OrderOnlinePaymentStatus!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query orderOnlinePaymentStatus($id: ID!) {
orderOnlinePaymentStatus(id: $id) {
csobUrl
gopayUrl
gpWebpayUrl
isProcessing
isSuccess
order {
...OrderFragment
}
payFastUrl
payuUrl
userErrors
}
}
Variables
{"id": "4"}
Response
{
"data": {
"orderOnlinePaymentStatus": {
"csobUrl": "xyz789",
"gopayUrl": "abc123",
"gpWebpayUrl": "abc123",
"isProcessing": true,
"isSuccess": false,
"order": Order,
"payFastUrl": "xyz789",
"payuUrl": "abc123",
"userErrors": ["xyz789"]
}
}
}
orderOriginCategories
Description
Index all records of OrderOriginCategory
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [OrderOriginCategory!]!
Example
Query
query orderOriginCategories {
orderOriginCategories {
code
enum
id
rawCode
}
}
Response
{
"data": {
"orderOriginCategories": [
{
"code": "abc123",
"enum": "DOVEZE",
"id": 4,
"rawCode": "xyz789"
}
]
}
}
orderOrigins
Description
Index all records of OrderOrigin
ALLOWED ROLES: [admin, editor_orders, guest, super_admin, support, user]
Response
Returns [OrderOrigin!]!
Example
Query
query orderOrigins {
orderOrigins {
code
enum
id
rawCode
}
}
Response
{
"data": {
"orderOrigins": [
{
"code": "xyz789",
"enum": "DAME_JIDLO",
"id": 4,
"rawCode": "abc123"
}
]
}
}
orderRecipe
Description
Read Order Recipe
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order_recipe, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an OrderRecipe!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
companyBranch - ID
|
|
language - LanguageEnum
|
Example
Query
query orderRecipe(
$id: ID!,
$companyBranch: ID,
$language: LanguageEnum
) {
orderRecipe(
id: $id,
companyBranch: $companyBranch,
language: $language
) {
appliedRules
automatic
covers {
...OrderRecipeFragment
}
hasDynamicPrice
id
note
order {
...OrderFragment
}
orderRecipeState {
...OrderRecipeStateFragment
}
parent {
...OrderRecipeFragment
}
price {
...PriceConvertedFragment
}
priceWithSideDishes {
...PriceConvertedFragment
}
promoTag {
...PromoTagFragment
}
recipe {
...RecipeFragment
}
sideDishes {
...OrderRecipeFragment
}
wareCategory {
...WareCategoryFragment
}
}
}
Variables
{"id": 4, "companyBranch": 4, "language": "CS"}
Response
{
"data": {
"orderRecipe": {
"appliedRules": ["abc123"],
"automatic": true,
"covers": [OrderRecipe],
"hasDynamicPrice": false,
"id": "4",
"note": "xyz789",
"order": Order,
"orderRecipeState": OrderRecipeState,
"parent": OrderRecipe,
"price": PriceConverted,
"priceWithSideDishes": PriceConverted,
"promoTag": PromoTag,
"recipe": Recipe,
"sideDishes": [OrderRecipe],
"wareCategory": WareCategory
}
}
}
orderRecipes
Description
Get items of order
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order_recipe, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Response
Returns [OrderRecipe!]!
Arguments
| Name | Description |
|---|---|
order - ID!
|
|
recipe - ID
|
|
orderRecipeState - OrderRecipeStateEnum
|
Example
Query
query orderRecipes(
$order: ID!,
$recipe: ID,
$orderRecipeState: OrderRecipeStateEnum
) {
orderRecipes(
order: $order,
recipe: $recipe,
orderRecipeState: $orderRecipeState
) {
appliedRules
automatic
covers {
...OrderRecipeFragment
}
hasDynamicPrice
id
note
order {
...OrderFragment
}
orderRecipeState {
...OrderRecipeStateFragment
}
parent {
...OrderRecipeFragment
}
price {
...PriceConvertedFragment
}
priceWithSideDishes {
...PriceConvertedFragment
}
promoTag {
...PromoTagFragment
}
recipe {
...RecipeFragment
}
sideDishes {
...OrderRecipeFragment
}
wareCategory {
...WareCategoryFragment
}
}
}
Variables
{"order": 4, "recipe": 4, "orderRecipeState": "FRESH"}
Response
{
"data": {
"orderRecipes": [
{
"appliedRules": ["abc123"],
"automatic": true,
"covers": [OrderRecipe],
"hasDynamicPrice": false,
"id": "4",
"note": "xyz789",
"order": Order,
"orderRecipeState": OrderRecipeState,
"parent": OrderRecipe,
"price": PriceConverted,
"priceWithSideDishes": PriceConverted,
"promoTag": PromoTag,
"recipe": Recipe,
"sideDishes": [OrderRecipe],
"wareCategory": WareCategory
}
]
}
}
orderStateCategories
Description
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [OrderStateCategory!]!
Arguments
| Name | Description |
|---|---|
target - OrderStateCategoryTargetEnum
|
Example
Query
query orderStateCategories($target: OrderStateCategoryTargetEnum) {
orderStateCategories(target: $target) {
code
enum
id
orderStates
rawCode
}
}
Variables
{"target": "BACKEND"}
Response
{
"data": {
"orderStateCategories": [
{
"code": "xyz789",
"enum": "MAIN",
"id": 4,
"orderStates": ["IN_CART"],
"rawCode": "abc123"
}
]
}
}
orderStates
Description
Index all records of OrderState
ALLOWED ROLES: [admin, editor_orders, guest, super_admin, support, user]
Response
Returns [OrderState!]!
Example
Query
query orderStates {
orderStates {
code
enum
id
orderStateCategory {
...OrderStateCategoryFragment
}
rawCode
}
}
Response
{
"data": {
"orderStates": [
{
"code": "abc123",
"enum": "IN_CART",
"id": "4",
"orderStateCategory": OrderStateCategory,
"rawCode": "xyz789"
}
]
}
}
orders
Description
Get orders with using of additional filters
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Response
Returns [Order!]!
Arguments
| Name | Description |
|---|---|
order - InputOrderIndex
|
Default = {} |
pagination - InputPaginationParams
|
Example
Query
query orders(
$order: InputOrderIndex,
$pagination: InputPaginationParams
) {
orders(
order: $order,
pagination: $pagination
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": {}, "pagination": InputPaginationParams}
Response
{
"data": {
"orders": [
{
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["xyz789"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": true,
"isCancelable": false,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": false,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
]
}
}
ordersCategoryCount
Description
Count number of orders for specified user
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Response
Returns [OrderStateCategoryCount!]!
Arguments
| Name | Description |
|---|---|
companyBranches - [ID!]!
|
|
orderStateCategoriesOR - [OrderStateCategoryEnum!]
|
|
orderStateCategoryTarget - OrderStateCategoryTargetEnum
|
Default = FE_ADMIN |
includeOldFinished - Boolean
|
Default = false |
Example
Query
query ordersCategoryCount(
$companyBranches: [ID!]!,
$orderStateCategoriesOR: [OrderStateCategoryEnum!],
$orderStateCategoryTarget: OrderStateCategoryTargetEnum,
$includeOldFinished: Boolean
) {
ordersCategoryCount(
companyBranches: $companyBranches,
orderStateCategoriesOR: $orderStateCategoriesOR,
orderStateCategoryTarget: $orderStateCategoryTarget,
includeOldFinished: $includeOldFinished
) {
orderStateCategory {
...OrderStateCategoryFragment
}
ordersCount
}
}
Variables
{
"companyBranches": ["4"],
"orderStateCategoriesOR": ["MAIN"],
"orderStateCategoryTarget": "FE_ADMIN",
"includeOldFinished": false
}
Response
{
"data": {
"ordersCategoryCount": [
{
"orderStateCategory": OrderStateCategory,
"ordersCount": 123
}
]
}
}
ordersCount
Description
Count number of orders for specified user
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
companyBranches - [ID!]
|
|
orderStatesOR - [OrderStateEnum!]
|
|
orderStateCategoriesOR - [OrderStateCategoryEnum!]
|
|
orderStateCategoryTarget - OrderStateCategoryTargetEnum
|
Default = FE_ADMIN |
includeOldFinished - Boolean
|
removed from query. Default = true |
companyBranch - ID
|
Use companyBranches instead |
orderStates - [OrderStateEnum!]
|
Use orderStatesOR instead |
orderStateCategories - [OrderStateCategoryEnum!]
|
Use orderStateCategoriesOR instead |
Example
Query
query ordersCount(
$companyBranches: [ID!],
$orderStatesOR: [OrderStateEnum!],
$orderStateCategoriesOR: [OrderStateCategoryEnum!],
$orderStateCategoryTarget: OrderStateCategoryTargetEnum,
$includeOldFinished: Boolean,
$companyBranch: ID,
$orderStates: [OrderStateEnum!],
$orderStateCategories: [OrderStateCategoryEnum!]
) {
ordersCount(
companyBranches: $companyBranches,
orderStatesOR: $orderStatesOR,
orderStateCategoriesOR: $orderStateCategoriesOR,
orderStateCategoryTarget: $orderStateCategoryTarget,
includeOldFinished: $includeOldFinished,
companyBranch: $companyBranch,
orderStates: $orderStates,
orderStateCategories: $orderStateCategories
)
}
Variables
{
"companyBranches": ["4"],
"orderStatesOR": ["IN_CART"],
"orderStateCategoriesOR": ["MAIN"],
"orderStateCategoryTarget": "FE_ADMIN",
"includeOldFinished": true,
"companyBranch": 4,
"orderStates": ["IN_CART"],
"orderStateCategories": ["MAIN"]
}
Response
{"data": {"ordersCount": 123}}
paymentMethod
Description
Get details of PaymentMethod
ALLOWED ROLES: [admin, editor_payment_method, guest, super_admin, support, user]
Response
Returns a PaymentMethod!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query paymentMethod($id: ID!) {
paymentMethod(id: $id) {
country {
...CountryFragment
}
description
id
paymentGate {
...PaymentGateFragment
}
paymentType {
...PaymentTypeFragment
}
price {
...PriceConvertedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"paymentMethod": {
"country": Country,
"description": "xyz789",
"id": 4,
"paymentGate": PaymentGate,
"paymentType": PaymentType,
"price": PriceConverted
}
}
}
paymentMethods
Description
List of payment methods used by branch
ALLOWED ROLES: [admin, editor_payment_method, guest, super_admin, support, user]
Response
Returns [PaymentMethod!]!
Arguments
| Name | Description |
|---|---|
paymentMethod - InputPaymentMethodIndex!
|
Example
Query
query paymentMethods($paymentMethod: InputPaymentMethodIndex!) {
paymentMethods(paymentMethod: $paymentMethod) {
country {
...CountryFragment
}
description
id
paymentGate {
...PaymentGateFragment
}
paymentType {
...PaymentTypeFragment
}
price {
...PriceConvertedFragment
}
}
}
Variables
{"paymentMethod": InputPaymentMethodIndex}
Response
{
"data": {
"paymentMethods": [
{
"country": Country,
"description": "xyz789",
"id": "4",
"paymentGate": PaymentGate,
"paymentType": PaymentType,
"price": PriceConverted
}
]
}
}
permissions
Description
Obtain global user permissions for specified set of actions
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns a UserPermission!
Example
Query
query permissions {
permissions {
canCancelOrders
canCreateOrder
canIndexOrders
}
}
Response
{
"data": {
"permissions": {
"canCancelOrders": false,
"canCreateOrder": true,
"canIndexOrders": true
}
}
}
promoTag
Description
Get details of promo tag
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns a PromoTag!
Example
Query
query promoTag(
$id: ID,
$enum: String
) {
promoTag(
id: $id,
enum: $enum
) {
code
enum
id
rawCode
}
}
Variables
{
"id": "4",
"enum": "xyz789"
}
Response
{
"data": {
"promoTag": {
"code": "xyz789",
"enum": "PROMO_CART",
"id": 4,
"rawCode": "abc123"
}
}
}
promoTags
Description
Index all records of PromoTag
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [PromoTag!]!
Example
Query
query promoTags {
promoTags {
code
enum
id
rawCode
}
}
Response
{
"data": {
"promoTags": [
{
"code": "abc123",
"enum": "PROMO_CART",
"id": 4,
"rawCode": "abc123"
}
]
}
}
recipe
Description
Read recipe
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, driver, editor_menu, editor_orders, editor_recipe, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns a Recipe!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
companyBranch - ID
|
|
language - LanguageEnum
|
Example
Query
query recipe(
$id: ID!,
$companyBranch: ID,
$language: LanguageEnum
) {
recipe(
id: $id,
companyBranch: $companyBranch,
language: $language
) {
ageControl
allergens {
...AllergenFragment
}
associatedRecipes {
...RecipeRelationFragment
}
availabilities {
...AvailabilityFragment
}
availableAmount
bistroId
code
dependentRules
descriptionLabel
descriptionLabelTranslated
dotykackaId
enabled
enabledByOwner
groups {
...GroupFragment
}
hasMandatoryCategories
id
image
ingredients {
...IngredientFragment
}
internalCode
internalNote
isAvailable
isCombinationMeal
isCover
isDynamicPricingEnabled
isMain
isSideDish
mainCombinationMealPrice {
...PriceConvertedFragment
}
nameLabel
nameLabelTranslated
orderRecipeCount
pictogram
price {
...PriceConvertedFragment
}
prices {
...RecipePriceFragment
}
primaryWareCategory {
...WareCategoryFragment
}
recipeColor {
...RecipeColorFragment
}
recipeTagRelations {
...RecipeTagRelationFragment
}
recipeTags {
...RecipeTagFragment
}
rejectedPaymentMethods {
...PaymentMethodFragment
}
shared
sideDishCombinationMealPrices {
...PriceComboSideDishFragment
}
sideDishesWareCategories {
...WareCategoryFragment
}
sideDishesWareCategoriesCount
soldOut
stockItems {
...StockItemFragment
}
translations {
...RecipeTranslationFragment
}
video
ware {
...WareFragment
}
wareCategories {
...WareCategoryFragment
}
wareCategoriesCount
wareCategoryType {
...WareCategoryTypeFragment
}
}
}
Variables
{
"id": 4,
"companyBranch": "4",
"language": "CS"
}
Response
{
"data": {
"recipe": {
"ageControl": false,
"allergens": [Allergen],
"associatedRecipes": [RecipeRelation],
"availabilities": [Availability],
"availableAmount": 123,
"bistroId": "4",
"code": "abc123",
"dependentRules": ["xyz789"],
"descriptionLabel": "abc123",
"descriptionLabelTranslated": "xyz789",
"dotykackaId": "4",
"enabled": false,
"enabledByOwner": true,
"groups": [Group],
"hasMandatoryCategories": true,
"id": "4",
"image": "abc123",
"ingredients": [Ingredient],
"internalCode": "xyz789",
"internalNote": "abc123",
"isAvailable": true,
"isCombinationMeal": false,
"isCover": true,
"isDynamicPricingEnabled": false,
"isMain": false,
"isSideDish": false,
"mainCombinationMealPrice": PriceConverted,
"nameLabel": "abc123",
"nameLabelTranslated": "xyz789",
"orderRecipeCount": 123,
"pictogram": "xyz789",
"price": PriceConverted,
"prices": [RecipePrice],
"primaryWareCategory": WareCategory,
"recipeColor": RecipeColor,
"recipeTagRelations": [RecipeTagRelation],
"recipeTags": [RecipeTag],
"rejectedPaymentMethods": [PaymentMethod],
"shared": false,
"sideDishCombinationMealPrices": [
PriceComboSideDish
],
"sideDishesWareCategories": [WareCategory],
"sideDishesWareCategoriesCount": 123,
"soldOut": true,
"stockItems": [StockItem],
"translations": [RecipeTranslation],
"video": "xyz789",
"ware": Ware,
"wareCategories": [WareCategory],
"wareCategoriesCount": 123,
"wareCategoryType": WareCategoryType
}
}
}
recipeTag
Description
Get details of promo tag
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns a RecipeTag!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
skipSystemTagFallback - Boolean
|
By default, any missing attribute on a company recipeTag fallbacks to the relevant attribute on its system recipeTag (i.e. instead of returning null, the value of the system recipeTag's attribute is returned). This fallback can optionally be skipped. Default = false |
Example
Query
query recipeTag(
$id: ID!,
$skipSystemTagFallback: Boolean
) {
recipeTag(
id: $id,
skipSystemTagFallback: $skipSystemTagFallback
) {
color
company {
...CompanyFragment
}
id
image
label
pictogram
recipeTagCategoryType {
...RecipeTagCategoryTypeFragment
}
systemRecipeTag {
...RecipeTagFragment
}
translations {
...RecipeTagTranslationFragment
}
}
}
Variables
{"id": "4", "skipSystemTagFallback": false}
Response
{
"data": {
"recipeTag": {
"color": "abc123",
"company": Company,
"id": 4,
"image": "abc123",
"label": "abc123",
"pictogram": "xyz789",
"recipeTagCategoryType": RecipeTagCategoryType,
"systemRecipeTag": RecipeTag,
"translations": [RecipeTagTranslation]
}
}
}
recipeTagCategoryTypes
Description
Index all records of RecipeTagCategoryType
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [RecipeTagCategoryType!]!
Example
Query
query recipeTagCategoryTypes {
recipeTagCategoryTypes {
code
enum
id
rawCode
}
}
Response
{
"data": {
"recipeTagCategoryTypes": [
{
"code": "abc123",
"enum": "WARE_TYPE",
"id": "4",
"rawCode": "abc123"
}
]
}
}
recipeTagRelation
Description
Get details of RecipeTagRelation
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns a RecipeTagRelation!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query recipeTagRelation($id: ID!) {
recipeTagRelation(id: $id) {
id
inherited
parentRelation {
...RecipeTagRelationFragment
}
recipeTag {
...RecipeTagFragment
}
taggable {
... on Recipe {
...RecipeFragment
}
... on WareCategory {
...WareCategoryFragment
}
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"recipeTagRelation": {
"id": 4,
"inherited": true,
"parentRelation": RecipeTagRelation,
"recipeTag": RecipeTag,
"taggable": Recipe
}
}
}
recipeTagRelations
Description
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [RecipeTagRelation!]!
Example
Query
query recipeTagRelations(
$withRecipeTagsByCompanies: [ID!],
$usedByCompanyBranches: [ID!]
) {
recipeTagRelations(
withRecipeTagsByCompanies: $withRecipeTagsByCompanies,
usedByCompanyBranches: $usedByCompanyBranches
) {
id
inherited
parentRelation {
...RecipeTagRelationFragment
}
recipeTag {
...RecipeTagFragment
}
taggable {
... on Recipe {
...RecipeFragment
}
... on WareCategory {
...WareCategoryFragment
}
}
}
}
Variables
{
"withRecipeTagsByCompanies": ["4"],
"usedByCompanyBranches": ["4"]
}
Response
{
"data": {
"recipeTagRelations": [
{
"id": "4",
"inherited": true,
"parentRelation": RecipeTagRelation,
"recipeTag": RecipeTag,
"taggable": Recipe
}
]
}
}
recipeTags
Description
Returns all RecipeTags available to the User – system RecipeTags + company RecipeTags for the companies the User is in.
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [RecipeTag!]!
Arguments
| Name | Description |
|---|---|
usedByCompanyBranches - [ID!]
|
Filter RecipeTags associated with Recipes or WareCategories on selected CompanyBranches. |
enabledOnBranches - Boolean
|
Filter RecipeTags associated with enabled Recipes or enabled WareCategories on selected CompanyBranches. |
companies - [ID!]
|
|
systemTags - Boolean
|
|
recipeTagCategoryTypes - [ID!]
|
Example
Query
query recipeTags(
$usedByCompanyBranches: [ID!],
$enabledOnBranches: Boolean,
$companies: [ID!],
$systemTags: Boolean,
$recipeTagCategoryTypes: [ID!]
) {
recipeTags(
usedByCompanyBranches: $usedByCompanyBranches,
enabledOnBranches: $enabledOnBranches,
companies: $companies,
systemTags: $systemTags,
recipeTagCategoryTypes: $recipeTagCategoryTypes
) {
color
company {
...CompanyFragment
}
id
image
label
pictogram
recipeTagCategoryType {
...RecipeTagCategoryTypeFragment
}
systemRecipeTag {
...RecipeTagFragment
}
translations {
...RecipeTagTranslationFragment
}
}
}
Variables
{
"usedByCompanyBranches": [4],
"enabledOnBranches": true,
"companies": [4],
"systemTags": false,
"recipeTagCategoryTypes": [4]
}
Response
{
"data": {
"recipeTags": [
{
"color": "xyz789",
"company": Company,
"id": "4",
"image": "xyz789",
"label": "xyz789",
"pictogram": "xyz789",
"recipeTagCategoryType": RecipeTagCategoryType,
"systemRecipeTag": RecipeTag,
"translations": [RecipeTagTranslation]
}
]
}
}
recipes
Description
Index recipe records
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, driver, editor_menu, editor_orders, editor_recipe, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns [Recipe!]!
Arguments
| Name | Description |
|---|---|
companyBranch - ID!
|
|
ware - ID
|
|
enabled - Boolean
|
|
isAvailable - Boolean
|
Return only ware categories available at current time. Also checks if all ingredients are in stock. |
isAvailableAt - DateTime
|
Return only ware categories available specific time. Argument has higher priority than is_available |
orderOriginCategory - OrderOriginCategoryEnum
|
OrderOriginCategory which has to be enabled. Use only with isAvailable argument. |
wareCategory - ID
|
|
wareCategoryType - WareCategoryTypeEnum
|
|
onlyNotInCategory - Boolean
|
Default = false |
language - LanguageEnum
|
|
recipeTags - [ID!]
|
|
ageControl - Boolean
|
|
isCombinationMeal - Boolean
|
Example
Query
query recipes(
$companyBranch: ID!,
$ware: ID,
$enabled: Boolean,
$isAvailable: Boolean,
$isAvailableAt: DateTime,
$orderOriginCategory: OrderOriginCategoryEnum,
$wareCategory: ID,
$wareCategoryType: WareCategoryTypeEnum,
$onlyNotInCategory: Boolean,
$language: LanguageEnum,
$recipeTags: [ID!],
$ageControl: Boolean,
$isCombinationMeal: Boolean
) {
recipes(
companyBranch: $companyBranch,
ware: $ware,
enabled: $enabled,
isAvailable: $isAvailable,
isAvailableAt: $isAvailableAt,
orderOriginCategory: $orderOriginCategory,
wareCategory: $wareCategory,
wareCategoryType: $wareCategoryType,
onlyNotInCategory: $onlyNotInCategory,
language: $language,
recipeTags: $recipeTags,
ageControl: $ageControl,
isCombinationMeal: $isCombinationMeal
) {
ageControl
allergens {
...AllergenFragment
}
associatedRecipes {
...RecipeRelationFragment
}
availabilities {
...AvailabilityFragment
}
availableAmount
bistroId
code
dependentRules
descriptionLabel
descriptionLabelTranslated
dotykackaId
enabled
enabledByOwner
groups {
...GroupFragment
}
hasMandatoryCategories
id
image
ingredients {
...IngredientFragment
}
internalCode
internalNote
isAvailable
isCombinationMeal
isCover
isDynamicPricingEnabled
isMain
isSideDish
mainCombinationMealPrice {
...PriceConvertedFragment
}
nameLabel
nameLabelTranslated
orderRecipeCount
pictogram
price {
...PriceConvertedFragment
}
prices {
...RecipePriceFragment
}
primaryWareCategory {
...WareCategoryFragment
}
recipeColor {
...RecipeColorFragment
}
recipeTagRelations {
...RecipeTagRelationFragment
}
recipeTags {
...RecipeTagFragment
}
rejectedPaymentMethods {
...PaymentMethodFragment
}
shared
sideDishCombinationMealPrices {
...PriceComboSideDishFragment
}
sideDishesWareCategories {
...WareCategoryFragment
}
sideDishesWareCategoriesCount
soldOut
stockItems {
...StockItemFragment
}
translations {
...RecipeTranslationFragment
}
video
ware {
...WareFragment
}
wareCategories {
...WareCategoryFragment
}
wareCategoriesCount
wareCategoryType {
...WareCategoryTypeFragment
}
}
}
Variables
{
"companyBranch": "4",
"ware": 4,
"enabled": false,
"isAvailable": true,
"isAvailableAt": "2007-12-03T10:15:30Z",
"orderOriginCategory": "DOVEZE",
"wareCategory": 4,
"wareCategoryType": "MAIN",
"onlyNotInCategory": false,
"language": "CS",
"recipeTags": ["4"],
"ageControl": false,
"isCombinationMeal": false
}
Response
{
"data": {
"recipes": [
{
"ageControl": false,
"allergens": [Allergen],
"associatedRecipes": [RecipeRelation],
"availabilities": [Availability],
"availableAmount": 123,
"bistroId": "4",
"code": "abc123",
"dependentRules": ["xyz789"],
"descriptionLabel": "xyz789",
"descriptionLabelTranslated": "abc123",
"dotykackaId": "4",
"enabled": true,
"enabledByOwner": true,
"groups": [Group],
"hasMandatoryCategories": false,
"id": 4,
"image": "abc123",
"ingredients": [Ingredient],
"internalCode": "xyz789",
"internalNote": "abc123",
"isAvailable": false,
"isCombinationMeal": true,
"isCover": true,
"isDynamicPricingEnabled": false,
"isMain": false,
"isSideDish": true,
"mainCombinationMealPrice": PriceConverted,
"nameLabel": "abc123",
"nameLabelTranslated": "abc123",
"orderRecipeCount": 987,
"pictogram": "abc123",
"price": PriceConverted,
"prices": [RecipePrice],
"primaryWareCategory": WareCategory,
"recipeColor": RecipeColor,
"recipeTagRelations": [RecipeTagRelation],
"recipeTags": [RecipeTag],
"rejectedPaymentMethods": [PaymentMethod],
"shared": true,
"sideDishCombinationMealPrices": [
PriceComboSideDish
],
"sideDishesWareCategories": [WareCategory],
"sideDishesWareCategoriesCount": 987,
"soldOut": true,
"stockItems": [StockItem],
"translations": [RecipeTranslation],
"video": "xyz789",
"ware": Ware,
"wareCategories": [WareCategory],
"wareCategoriesCount": 987,
"wareCategoryType": WareCategoryType
}
]
}
}
resolveLocation
Description
Obtain correct gps coordinates/address from user defined gps/address. Uses even IP address in case that gps/address is missing.
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns an AddressResolvedLocation!
Example
Query
query resolveLocation(
$brand: ID,
$companyBranch: ID,
$address: String,
$latitude: Float,
$longitude: Float
) {
resolveLocation(
brand: $brand,
companyBranch: $companyBranch,
address: $address,
latitude: $latitude,
longitude: $longitude
) {
companyBranch {
...CompanyBranchFragment
}
finalAddress {
...JsonAddressFragment
}
finalAddressFormatted
gpsCoordinates {
...GeoPointFragment
}
inDeliveryLocation
isResolved
isValidAddress
zone {
...ZoneFragment
}
}
}
Variables
{
"brand": 4,
"companyBranch": "4",
"address": "abc123",
"latitude": 123.45,
"longitude": 123.45
}
Response
{
"data": {
"resolveLocation": {
"companyBranch": CompanyBranch,
"finalAddress": JsonAddress,
"finalAddressFormatted": "xyz789",
"gpsCoordinates": GeoPoint,
"inDeliveryLocation": true,
"isResolved": true,
"isValidAddress": false,
"zone": Zone
}
}
}
sector
Description
Get details of Sector
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, guest, operator, sales_representative, super_admin, supervisor, support, user]
Example
Query
query sector($id: ID!) {
sector(id: $id) {
availabilities {
...AvailabilityFragment
}
code
companyBranch {
...CompanyBranchFragment
}
deliveryType {
...DeliveryTypeFragment
}
eetEnabled
enabled
gps {
...GeoPointFragment
}
id
inheritedAvailabilities {
...AvailabilityFragment
}
inheritedDeliveryType {
...DeliveryTypeFragment
}
inheritedEetEnabled
inheritedEnabled
inheritedOccasionsEnabled
inheritedOrderDelaySeconds
inheritedWarePriceType {
...WarePriceTypeFragment
}
isAvailable
name
occasions {
...OccasionFragment
}
occasionsEnabled
orderDelaySeconds
parent {
...SectorFragment
}
preordableOccasions {
...OccasionFragment
}
sectorType {
...SectorTypeFragment
}
wareCategoryAvailabilities {
...SectorWareCategoryFragment
}
warePriceType {
...WarePriceTypeFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"sector": {
"availabilities": [Availability],
"code": "abc123",
"companyBranch": CompanyBranch,
"deliveryType": DeliveryType,
"eetEnabled": true,
"enabled": true,
"gps": GeoPoint,
"id": "4",
"inheritedAvailabilities": [Availability],
"inheritedDeliveryType": DeliveryType,
"inheritedEetEnabled": true,
"inheritedEnabled": false,
"inheritedOccasionsEnabled": false,
"inheritedOrderDelaySeconds": 987,
"inheritedWarePriceType": WarePriceType,
"isAvailable": false,
"name": "abc123",
"occasions": [Occasion],
"occasionsEnabled": false,
"orderDelaySeconds": 987,
"parent": Sector,
"preordableOccasions": [Occasion],
"sectorType": SectorType,
"wareCategoryAvailabilities": [SectorWareCategory],
"warePriceType": WarePriceType
}
}
}
sectors
Description
Index sector records
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, guest, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns [Sector!]!
Arguments
| Name | Description |
|---|---|
companyBranch - ID
|
|
companyBranches - [ID!]
|
|
sectorType - SectorTypeEnum
|
|
enabled - Boolean
|
Default = true |
isAvailable - Boolean
|
|
orderOriginCategory - OrderOriginCategoryEnum
|
OrderOriginCategory which has to be enabled. Use only with isAvailable field. |
Example
Query
query sectors(
$companyBranch: ID,
$companyBranches: [ID!],
$sectorType: SectorTypeEnum,
$enabled: Boolean,
$isAvailable: Boolean,
$orderOriginCategory: OrderOriginCategoryEnum
) {
sectors(
companyBranch: $companyBranch,
companyBranches: $companyBranches,
sectorType: $sectorType,
enabled: $enabled,
isAvailable: $isAvailable,
orderOriginCategory: $orderOriginCategory
) {
availabilities {
...AvailabilityFragment
}
code
companyBranch {
...CompanyBranchFragment
}
deliveryType {
...DeliveryTypeFragment
}
eetEnabled
enabled
gps {
...GeoPointFragment
}
id
inheritedAvailabilities {
...AvailabilityFragment
}
inheritedDeliveryType {
...DeliveryTypeFragment
}
inheritedEetEnabled
inheritedEnabled
inheritedOccasionsEnabled
inheritedOrderDelaySeconds
inheritedWarePriceType {
...WarePriceTypeFragment
}
isAvailable
name
occasions {
...OccasionFragment
}
occasionsEnabled
orderDelaySeconds
parent {
...SectorFragment
}
preordableOccasions {
...OccasionFragment
}
sectorType {
...SectorTypeFragment
}
wareCategoryAvailabilities {
...SectorWareCategoryFragment
}
warePriceType {
...WarePriceTypeFragment
}
}
}
Variables
{
"companyBranch": 4,
"companyBranches": [4],
"sectorType": "AREA",
"enabled": true,
"isAvailable": true,
"orderOriginCategory": "DOVEZE"
}
Response
{
"data": {
"sectors": [
{
"availabilities": [Availability],
"code": "abc123",
"companyBranch": CompanyBranch,
"deliveryType": DeliveryType,
"eetEnabled": true,
"enabled": true,
"gps": GeoPoint,
"id": "4",
"inheritedAvailabilities": [Availability],
"inheritedDeliveryType": DeliveryType,
"inheritedEetEnabled": true,
"inheritedEnabled": true,
"inheritedOccasionsEnabled": true,
"inheritedOrderDelaySeconds": 123,
"inheritedWarePriceType": WarePriceType,
"isAvailable": true,
"name": "xyz789",
"occasions": [Occasion],
"occasionsEnabled": false,
"orderDelaySeconds": 123,
"parent": Sector,
"preordableOccasions": [Occasion],
"sectorType": SectorType,
"wareCategoryAvailabilities": [
SectorWareCategory
],
"warePriceType": WarePriceType
}
]
}
}
suggestAddress
Description
Obtain correct gps coordinates from seznam suggestions defined gps/address.
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns [AddressResolvedLocation!]!
Arguments
| Name | Description |
|---|---|
brand - ID
|
|
companyBranch - ID
|
|
gps - [InputGeoPointCreate!]!
|
Example
Query
query suggestAddress(
$brand: ID,
$companyBranch: ID,
$gps: [InputGeoPointCreate!]!
) {
suggestAddress(
brand: $brand,
companyBranch: $companyBranch,
gps: $gps
) {
companyBranch {
...CompanyBranchFragment
}
finalAddress {
...JsonAddressFragment
}
finalAddressFormatted
gpsCoordinates {
...GeoPointFragment
}
inDeliveryLocation
isResolved
isValidAddress
zone {
...ZoneFragment
}
}
}
Variables
{
"brand": "4",
"companyBranch": 4,
"gps": [InputGeoPointCreate]
}
Response
{
"data": {
"suggestAddress": [
{
"companyBranch": CompanyBranch,
"finalAddress": JsonAddress,
"finalAddressFormatted": "xyz789",
"gpsCoordinates": GeoPoint,
"inDeliveryLocation": false,
"isResolved": false,
"isValidAddress": true,
"zone": Zone
}
]
}
}
suggestGeolocation
Description
Return list of places with similar name from geolocation service
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns [JsonAddress!]!
Arguments
| Name | Description |
|---|---|
address - String!
|
|
country - CountryEnum
|
Example
Query
query suggestGeolocation(
$address: String!,
$country: CountryEnum
) {
suggestGeolocation(
address: $address,
country: $country
) {
city
country
gps {
...GeoPointFragment
}
houseNumber
original
postCode
state
street
venue
}
}
Variables
{"address": "xyz789", "country": "RSA"}
Response
{
"data": {
"suggestGeolocation": [
{
"city": "abc123",
"country": "xyz789",
"gps": GeoPoint,
"houseNumber": "xyz789",
"original": "abc123",
"postCode": "xyz789",
"state": "xyz789",
"street": "xyz789",
"venue": "xyz789"
}
]
}
}
vamStatus
Description
Query VAM and return its result about user agreements.
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Response
Returns [VAMAgreement!]!
Arguments
| Name | Description |
|---|---|
input - InputVamStatus!
|
Example
Query
query vamStatus($input: InputVamStatus!) {
vamStatus(input: $input) {
description
id
isConfirmed
isMandatory
name
}
}
Variables
{"input": InputVamStatus}
Response
{
"data": {
"vamStatus": [
{
"description": "abc123",
"id": 4,
"isConfirmed": false,
"isMandatory": true,
"name": "abc123"
}
]
}
}
vats
Description
Index of vats
ALLOWED ROLES: [admin, editor_country, editor_menu, guest, operator, super_admin, support, user]
wareCategories
Description
Get categories of recipes
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier_menu, editor_menu, editor_ware_category, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns [WareCategory!]!
Arguments
| Name | Description |
|---|---|
companyBranch - ID!
|
|
enabled - Boolean
|
|
isAvailable - Boolean
|
Return only ware categories available at current time. |
isAvailableAt - DateTime
|
Return only ware categories available specific time. Argument has higher priority than is_available |
language - LanguageEnum
|
|
orderOriginCategory - OrderOriginCategoryEnum
|
OrderOriginCategory which has to be enabled. Use only with isAvailable argument. |
occasion - ID
|
|
public - Boolean
|
|
sector - ID
|
|
wareCategoryType - WareCategoryTypeEnum
|
|
promoTags - [PromoTagEnum!]
|
Return only ware categories that are associated with the provided PromoTags. Given an empty array, categories that have any associated PromoTags are returned. |
withoutPromoTags - [PromoTagEnum!]
|
Return only ware categories that are not associated with the provided PromoTags. Given an empty array, categories with no associated PromoTags are returned. The withoutPromoTags filter is applied to the result of the promoTags filter, i.e. the promoTags filter is applied first and any remaining categories are further filtered using withoutPromoTags. |
recipeTags - [ID!]
|
|
filterByRecipe - InputRecipeFilterType
|
Example
Query
query wareCategories(
$companyBranch: ID!,
$enabled: Boolean,
$isAvailable: Boolean,
$isAvailableAt: DateTime,
$language: LanguageEnum,
$orderOriginCategory: OrderOriginCategoryEnum,
$occasion: ID,
$public: Boolean,
$sector: ID,
$wareCategoryType: WareCategoryTypeEnum,
$promoTags: [PromoTagEnum!],
$withoutPromoTags: [PromoTagEnum!],
$recipeTags: [ID!],
$filterByRecipe: InputRecipeFilterType
) {
wareCategories(
companyBranch: $companyBranch,
enabled: $enabled,
isAvailable: $isAvailable,
isAvailableAt: $isAvailableAt,
language: $language,
orderOriginCategory: $orderOriginCategory,
occasion: $occasion,
public: $public,
sector: $sector,
wareCategoryType: $wareCategoryType,
promoTags: $promoTags,
withoutPromoTags: $withoutPromoTags,
recipeTags: $recipeTags,
filterByRecipe: $filterByRecipe
) {
automaticFinish
availabilities {
...AvailabilityFragment
}
companyBranch {
...CompanyBranchFragment
}
countRecipes
covers {
...RecipeFragment
}
dependentRules
descriptionLabel
descriptionLabelTranslated
dotykackaId
enabled
enabledByOwner
id
image
internalNoteLabel
internalNoteLabelTranslated
isAvailable
mains {
...RecipeFragment
}
maxCount
maxRecipesCount
minCount
nameLabel
nameLabelTranslated
orderOriginCategories
pictogram
promoTags {
...PromoTagFragment
}
public
recipeTagRelations {
...RecipeTagRelationFragment
}
recipeTags {
...RecipeTagFragment
}
recipes {
...RecipeFragment
}
sharedCompanyBranches {
...CompanyBranchFragment
}
sideDishes {
...RecipeFragment
}
translations {
...WareCategoryTranslationFragment
}
wareCategoryColor {
...WareCategoryColorFragment
}
wareCategoryType {
...WareCategoryTypeFragment
}
}
}
Variables
{
"companyBranch": 4,
"enabled": true,
"isAvailable": true,
"isAvailableAt": "2007-12-03T10:15:30Z",
"language": "CS",
"orderOriginCategory": "DOVEZE",
"occasion": "4",
"public": false,
"sector": "4",
"wareCategoryType": "MAIN",
"promoTags": ["PROMO_CART"],
"withoutPromoTags": ["PROMO_CART"],
"recipeTags": ["4"],
"filterByRecipe": InputRecipeFilterType
}
Response
{
"data": {
"wareCategories": [
{
"automaticFinish": true,
"availabilities": [Availability],
"companyBranch": CompanyBranch,
"countRecipes": 987,
"covers": [Recipe],
"dependentRules": ["abc123"],
"descriptionLabel": "abc123",
"descriptionLabelTranslated": "xyz789",
"dotykackaId": "4",
"enabled": false,
"enabledByOwner": true,
"id": "4",
"image": "abc123",
"internalNoteLabel": "abc123",
"internalNoteLabelTranslated": "abc123",
"isAvailable": true,
"mains": [Recipe],
"maxCount": 987,
"maxRecipesCount": 987,
"minCount": 123,
"nameLabel": "abc123",
"nameLabelTranslated": "xyz789",
"orderOriginCategories": ["DOVEZE"],
"pictogram": "abc123",
"promoTags": [PromoTag],
"public": false,
"recipeTagRelations": [RecipeTagRelation],
"recipeTags": [RecipeTag],
"recipes": [Recipe],
"sharedCompanyBranches": [CompanyBranch],
"sideDishes": [Recipe],
"translations": [WareCategoryTranslation],
"wareCategoryColor": WareCategoryColor,
"wareCategoryType": WareCategoryType
}
]
}
}
wareCategoriesPos2
Description
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier_menu, editor_menu, editor_ware_category, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns a WareCategoryIndexPos2!
Arguments
| Name | Description |
|---|---|
companyBranch - ID!
|
|
enabled - Boolean
|
|
isAvailable - Boolean
|
Return only ware categories available at current time. |
isAvailableAt - DateTime
|
Return only ware categories available specific time. Argument has higher priority than is_available |
language - LanguageEnum
|
|
orderOriginCategory - OrderOriginCategoryEnum
|
OrderOriginCategory which has to be enabled. Use only with isAvailable argument. |
occasion - ID
|
|
public - Boolean
|
|
sector - ID
|
|
wareCategoryType - WareCategoryTypeEnum
|
|
promoTags - [PromoTagEnum!]
|
Return only ware categories that are associated with the provided PromoTags. Given an empty array, categories that have any associated PromoTags are returned. |
withoutPromoTags - [PromoTagEnum!]
|
Return only ware categories that are not associated with the provided PromoTags. Given an empty array, categories with no associated PromoTags are returned. The withoutPromoTags filter is applied to the result of the promoTags filter, i.e. the promoTags filter is applied first and any remaining categories are further filtered using withoutPromoTags. |
recipeTags - [ID!]
|
|
filterByRecipe - InputRecipeFilterType
|
Example
Query
query wareCategoriesPos2(
$companyBranch: ID!,
$enabled: Boolean,
$isAvailable: Boolean,
$isAvailableAt: DateTime,
$language: LanguageEnum,
$orderOriginCategory: OrderOriginCategoryEnum,
$occasion: ID,
$public: Boolean,
$sector: ID,
$wareCategoryType: WareCategoryTypeEnum,
$promoTags: [PromoTagEnum!],
$withoutPromoTags: [PromoTagEnum!],
$recipeTags: [ID!],
$filterByRecipe: InputRecipeFilterType
) {
wareCategoriesPos2(
companyBranch: $companyBranch,
enabled: $enabled,
isAvailable: $isAvailable,
isAvailableAt: $isAvailableAt,
language: $language,
orderOriginCategory: $orderOriginCategory,
occasion: $occasion,
public: $public,
sector: $sector,
wareCategoryType: $wareCategoryType,
promoTags: $promoTags,
withoutPromoTags: $withoutPromoTags,
recipeTags: $recipeTags,
filterByRecipe: $filterByRecipe
) {
hashDigest
wareCategories {
...WareCategoryFragment
}
}
}
Variables
{
"companyBranch": "4",
"enabled": true,
"isAvailable": false,
"isAvailableAt": "2007-12-03T10:15:30Z",
"language": "CS",
"orderOriginCategory": "DOVEZE",
"occasion": "4",
"public": true,
"sector": 4,
"wareCategoryType": "MAIN",
"promoTags": ["PROMO_CART"],
"withoutPromoTags": ["PROMO_CART"],
"recipeTags": ["4"],
"filterByRecipe": InputRecipeFilterType
}
Response
{
"data": {
"wareCategoriesPos2": {
"hashDigest": "xyz789",
"wareCategories": [WareCategory]
}
}
}
wareCategory
Description
Read ware category
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier_menu, editor_menu, editor_ware_category, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns a WareCategory!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
companyBranch - ID
|
|
language - LanguageEnum
|
Example
Query
query wareCategory(
$id: ID!,
$companyBranch: ID,
$language: LanguageEnum
) {
wareCategory(
id: $id,
companyBranch: $companyBranch,
language: $language
) {
automaticFinish
availabilities {
...AvailabilityFragment
}
companyBranch {
...CompanyBranchFragment
}
countRecipes
covers {
...RecipeFragment
}
dependentRules
descriptionLabel
descriptionLabelTranslated
dotykackaId
enabled
enabledByOwner
id
image
internalNoteLabel
internalNoteLabelTranslated
isAvailable
mains {
...RecipeFragment
}
maxCount
maxRecipesCount
minCount
nameLabel
nameLabelTranslated
orderOriginCategories
pictogram
promoTags {
...PromoTagFragment
}
public
recipeTagRelations {
...RecipeTagRelationFragment
}
recipeTags {
...RecipeTagFragment
}
recipes {
...RecipeFragment
}
sharedCompanyBranches {
...CompanyBranchFragment
}
sideDishes {
...RecipeFragment
}
translations {
...WareCategoryTranslationFragment
}
wareCategoryColor {
...WareCategoryColorFragment
}
wareCategoryType {
...WareCategoryTypeFragment
}
}
}
Variables
{
"id": 4,
"companyBranch": "4",
"language": "CS"
}
Response
{
"data": {
"wareCategory": {
"automaticFinish": false,
"availabilities": [Availability],
"companyBranch": CompanyBranch,
"countRecipes": 123,
"covers": [Recipe],
"dependentRules": ["xyz789"],
"descriptionLabel": "xyz789",
"descriptionLabelTranslated": "xyz789",
"dotykackaId": 4,
"enabled": true,
"enabledByOwner": true,
"id": "4",
"image": "abc123",
"internalNoteLabel": "abc123",
"internalNoteLabelTranslated": "xyz789",
"isAvailable": false,
"mains": [Recipe],
"maxCount": 123,
"maxRecipesCount": 987,
"minCount": 987,
"nameLabel": "abc123",
"nameLabelTranslated": "abc123",
"orderOriginCategories": ["DOVEZE"],
"pictogram": "abc123",
"promoTags": [PromoTag],
"public": true,
"recipeTagRelations": [RecipeTagRelation],
"recipeTags": [RecipeTag],
"recipes": [Recipe],
"sharedCompanyBranches": [CompanyBranch],
"sideDishes": [Recipe],
"translations": [WareCategoryTranslation],
"wareCategoryColor": WareCategoryColor,
"wareCategoryType": WareCategoryType
}
}
}
wareCategoryPos2
Description
Read updated ware category
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier_menu, editor_menu, editor_ware_category, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
Response
Returns a WareCategoryPos2!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
companyBranch - ID
|
|
language - LanguageEnum
|
Example
Query
query wareCategoryPos2(
$id: ID!,
$companyBranch: ID,
$language: LanguageEnum
) {
wareCategoryPos2(
id: $id,
companyBranch: $companyBranch,
language: $language
) {
hashDigest
wareCategory {
...WareCategoryFragment
}
}
}
Variables
{
"id": 4,
"companyBranch": "4",
"language": "CS"
}
Response
{
"data": {
"wareCategoryPos2": {
"hashDigest": "abc123",
"wareCategory": WareCategory
}
}
}
wareCategoryTypes
Description
Index all records of WareCategoryType
ALLOWED ROLES: [admin, editor_menu, guest, super_admin, support, user]
Response
Returns [WareCategoryType!]!
Example
Query
query wareCategoryTypes {
wareCategoryTypes {
code
enum
id
rawCode
}
}
Response
{
"data": {
"wareCategoryTypes": [
{
"code": "xyz789",
"enum": "MAIN",
"id": "4",
"rawCode": "abc123"
}
]
}
}
weekDays
Description
Index all records of WeekDay
ALLOWED ROLES: [admin, editor_business_hours, editor_orders, guest, super_admin, support, user]
Response
Returns [WeekDay!]!
Example
Query
query weekDays {
weekDays {
code
enum
id
rawCode
}
}
Response
{
"data": {
"weekDays": [
{
"code": "xyz789",
"enum": "MONDAY",
"id": 4,
"rawCode": "xyz789"
}
]
}
}
Mutations
addOrderPromoCode
Description
Assign promo code to order
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an OrderWithErrors!
Example
Query
mutation addOrderPromoCode(
$order: ID!,
$promoCode: String!
) {
addOrderPromoCode(
order: $order,
promoCode: $promoCode
) {
errors
order {
...OrderFragment
}
}
}
Variables
{"order": 4, "promoCode": "abc123"}
Response
{
"data": {
"addOrderPromoCode": {
"errors": ["abc123"],
"order": Order
}
}
}
addOrderState
Description
Add new order state to order
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, cashier_cancel, customer, driver, editor_order_state_relation, guest, operator, owner_cancel, sales_representative, super_admin, supervisor, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
order - ID!
|
|
orderState - OrderStateEnum!
|
|
target - OrderStateCategoryTargetEnum
|
Example
Query
mutation addOrderState(
$order: ID!,
$orderState: OrderStateEnum!,
$target: OrderStateCategoryTargetEnum
) {
addOrderState(
order: $order,
orderState: $orderState,
target: $target
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": 4, "orderState": "IN_CART", "target": "BACKEND"}
Response
{
"data": {
"addOrderState": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 987,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": 4,
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": true,
"isCancelable": false,
"isCustomerRegistered": false,
"isFinalized": false,
"isPaidWithCard": false,
"isPartiallyFinalized": false,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
bulkUpdateInAppNotifications
Description
Update InAppNotification records
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns [InAppNotification!]!
Example
Query
mutation bulkUpdateInAppNotifications(
$ids: [ID!]!,
$isRead: Boolean!
) {
bulkUpdateInAppNotifications(
ids: $ids,
isRead: $isRead
) {
content
createdAt
id
isRead
readAt
title
url
}
}
Variables
{"ids": [4], "isRead": true}
Response
{
"data": {
"bulkUpdateInAppNotifications": [
{
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"isRead": true,
"readAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"url": "abc123"
}
]
}
}
cancelOrders
Description
Cancel multiple orders in one request
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, cashier_cancel, customer, driver, editor_order_state_relation, guest, operator, owner_cancel, sales_representative, super_admin, supervisor, support]
Response
Returns an OrdersBulkCanceledResult!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
mutation cancelOrders($ids: [ID!]!) {
cancelOrders(ids: $ids) {
canceled {
...OrderFragment
}
notCanceled {
...OrderCancelFailedFragment
}
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"cancelOrders": {
"canceled": [Order],
"notCanceled": [OrderCancelFailed]
}
}
}
consentsAppLink
Description
Request a login link to the consents manager app
ALLOWED ROLES: [admin, branch_owner, brand_owner, editor_user, guest, super_admin, supervisor, user]
Response
Returns a String!
Example
Query
mutation consentsAppLink {
consentsAppLink
}
Response
{"data": {"consentsAppLink": "xyz789"}}
createConsentOrder
Description
Create consent assigned to order
ALLOWED ROLES: [admin, guest, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
consentOrder - InputConsentOrderCreate!
|
Example
Query
mutation createConsentOrder($consentOrder: InputConsentOrderCreate!) {
createConsentOrder(consentOrder: $consentOrder) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"consentOrder": InputConsentOrderCreate}
Response
{
"data": {
"createConsentOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": "4",
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": true,
"isCancelable": true,
"isCustomerRegistered": false,
"isFinalized": false,
"isPaidWithCard": false,
"isPartiallyFinalized": true,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
createDeliveryOrder
Description
Create delivery order record
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
order - InputOrderDeliveryCreate!
|
Example
Query
mutation createDeliveryOrder($order: InputOrderDeliveryCreate!) {
createDeliveryOrder(order: $order) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": InputOrderDeliveryCreate}
Response
{
"data": {
"createDeliveryOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["xyz789"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 987,
"isAnonymous": false,
"isCancelable": false,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
createExternalOrder
Description
Create order record for external service
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
Response
Returns a CreatedExternalOrderType!
Arguments
| Name | Description |
|---|---|
inputOrder - InputExternalOrderCreate!
|
Example
Query
mutation createExternalOrder($inputOrder: InputExternalOrderCreate!) {
createExternalOrder(inputOrder: $inputOrder) {
missingStockItems {
...StockItemFragment
}
order {
...OrderFragment
}
userErrors
}
}
Variables
{"inputOrder": InputExternalOrderCreate}
Response
{
"data": {
"createExternalOrder": {
"missingStockItems": [StockItem],
"order": Order,
"userErrors": ["abc123"]
}
}
}
createOrder
Description
Create order record
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
order - InputOrderCreate!
|
Example
Query
mutation createOrder($order: InputOrderCreate!) {
createOrder(order: $order) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": InputOrderCreate}
Response
{
"data": {
"createOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["abc123"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 987,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 123,
"isAnonymous": false,
"isCancelable": false,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": false,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
createOrderRating
Description
Create rating for order
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
ratings - [InputOrderRatingCreate!]!
|
Example
Query
mutation createOrderRating(
$id: ID!,
$ratings: [InputOrderRatingCreate!]!
) {
createOrderRating(
id: $id,
ratings: $ratings
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"id": 4, "ratings": [InputOrderRatingCreate]}
Response
{
"data": {
"createOrderRating": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["xyz789"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": "4",
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 123,
"isAnonymous": true,
"isCancelable": true,
"isCustomerRegistered": false,
"isFinalized": false,
"isPaidWithCard": true,
"isPartiallyFinalized": false,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
createOrderRecipe
Description
Create order recipe record (new item of order)
ALLOWED ROLES: [admin, cashier, customer, editor_order_recipe, guest, operator, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
orderRecipe - InputOrderRecipeCreate!
|
Example
Query
mutation createOrderRecipe($orderRecipe: InputOrderRecipeCreate!) {
createOrderRecipe(orderRecipe: $orderRecipe) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"orderRecipe": InputOrderRecipeCreate}
Response
{
"data": {
"createOrderRecipe": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["abc123"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": 4,
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 123,
"isAnonymous": false,
"isCancelable": false,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": false,
"isPartiallyFinalized": true,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
createPickupOrder
Description
Create pickup order record
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
order - InputOrderPickupCreate!
|
Example
Query
mutation createPickupOrder($order: InputOrderPickupCreate!) {
createPickupOrder(order: $order) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": InputOrderPickupCreate}
Response
{
"data": {
"createPickupOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": 4,
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 123,
"isAnonymous": true,
"isCancelable": false,
"isCustomerRegistered": true,
"isFinalized": false,
"isPaidWithCard": false,
"isPartiallyFinalized": false,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
createRegisteredUser
Description
Create new registered user
ALLOWED ROLES: [admin, branch_owner, brand_owner, editor_user, guest, super_admin, supervisor]
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
user - InputUserRegisteredCreate!
|
Example
Query
mutation createRegisteredUser($user: InputUserRegisteredCreate!) {
createRegisteredUser(user: $user)
}
Variables
{"user": InputUserRegisteredCreate}
Response
{"data": {"createRegisteredUser": 4}}
createStaffOrder
Description
Create staff order record
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
warePriceType - WarePriceTypeEnum!
|
|
cashBox - ID!
|
|
companyBranch - ID
|
|
orderRecipes - [InputOrderRecipeCreates!]
|
|
deliveryType - DeliveryTypeEnum
|
|
sector - ID
|
Example
Query
mutation createStaffOrder(
$warePriceType: WarePriceTypeEnum!,
$cashBox: ID!,
$companyBranch: ID,
$orderRecipes: [InputOrderRecipeCreates!],
$deliveryType: DeliveryTypeEnum,
$sector: ID
) {
createStaffOrder(
warePriceType: $warePriceType,
cashBox: $cashBox,
companyBranch: $companyBranch,
orderRecipes: $orderRecipes,
deliveryType: $deliveryType,
sector: $sector
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{
"warePriceType": "DELIVERY",
"cashBox": 4,
"companyBranch": 4,
"orderRecipes": [InputOrderRecipeCreates],
"deliveryType": "PICKUP",
"sector": 4
}
Response
{
"data": {
"createStaffOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["xyz789"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": 4,
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": true,
"isCancelable": false,
"isCustomerRegistered": false,
"isFinalized": false,
"isPaidWithCard": true,
"isPartiallyFinalized": true,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
createVirtualCashBoxOrder
Description
Create order record for virtual cash box
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
order - InputOrderStaffPosCreate!
|
Example
Query
mutation createVirtualCashBoxOrder($order: InputOrderStaffPosCreate!) {
createVirtualCashBoxOrder(order: $order) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": InputOrderStaffPosCreate}
Response
{
"data": {
"createVirtualCashBoxOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": "4",
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": false,
"isCancelable": true,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": false,
"isPartiallyFinalized": false,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
createWifiOrder
Description
Create wifi order record
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
order - InputOrderWifiCreate!
|
Example
Query
mutation createWifiOrder($order: InputOrderWifiCreate!) {
createWifiOrder(order: $order) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": InputOrderWifiCreate}
Response
{
"data": {
"createWifiOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["xyz789"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 987,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 987,
"isAnonymous": true,
"isCancelable": true,
"isCustomerRegistered": false,
"isFinalized": false,
"isPaidWithCard": true,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
creditsRequestRefund
Description
Request a wallet credits refund
ALLOWED ROLES: [admin, editor_wallet_credits_refund, guest, super_admin]
Response
Returns a CreditsWallet!
Arguments
| Name | Description |
|---|---|
walletId - ID!
|
|
refundInformation - InputRefundRequestType
|
|
cashBoxId - ID
|
Example
Query
mutation creditsRequestRefund(
$walletId: ID!,
$refundInformation: InputRefundRequestType,
$cashBoxId: ID
) {
creditsRequestRefund(
walletId: $walletId,
refundInformation: $refundInformation,
cashBoxId: $cashBoxId
) {
balance {
...CreditsPriceConvertedFragment
}
canTopUpMax {
...PriceConvertedFragment
}
cashPaymentDecimals
cashPaymentUnit
closedAt
companyBranches {
...CompanyBranchFragment
}
creditsExpiringSoon {
...CreditsWalletActivityConnectionFragment
}
creditsPendingRewards {
...CreditsRewardConnectionFragment
}
creditsRewards {
...CreditsRewardConnectionFragment
}
creditsWalletActivities {
...CreditsWalletActivityConnectionFragment
}
currency {
...CurrencyFragment
}
currentBalanceLimit {
...PriceConvertedFragment
}
currentBalanceLimitLeft {
...PriceConvertedFragment
}
currentBalanceLimitUsage {
...PriceConvertedFragment
}
group {
...CreditsGroupFragment
}
id
isClosed
name
nfcId
refundRequest {
...CreditsRefundRequestFragment
}
topUpLimit {
...PriceConvertedFragment
}
topUpLimitLeft {
...PriceConvertedFragment
}
topUpLimitUsage {
...PriceConvertedFragment
}
}
}
Variables
{
"walletId": 4,
"refundInformation": InputRefundRequestType,
"cashBoxId": 4
}
Response
{
"data": {
"creditsRequestRefund": {
"balance": CreditsPriceConverted,
"canTopUpMax": PriceConverted,
"cashPaymentDecimals": 987,
"cashPaymentUnit": 123.45,
"closedAt": "2007-12-03T10:15:30Z",
"companyBranches": [CompanyBranch],
"creditsExpiringSoon": CreditsWalletActivityConnection,
"creditsPendingRewards": CreditsRewardConnection,
"creditsRewards": CreditsRewardConnection,
"creditsWalletActivities": CreditsWalletActivityConnection,
"currency": Currency,
"currentBalanceLimit": PriceConverted,
"currentBalanceLimitLeft": PriceConverted,
"currentBalanceLimitUsage": PriceConverted,
"group": CreditsGroup,
"id": 4,
"isClosed": false,
"name": "abc123",
"nfcId": "abc123",
"refundRequest": CreditsRefundRequest,
"topUpLimit": PriceConverted,
"topUpLimitLeft": PriceConverted,
"topUpLimitUsage": PriceConverted
}
}
}
destroyConsentOrder
Description
Destroy consent assigned to order
ALLOWED ROLES: [admin, guest, super_admin]
Example
Query
mutation destroyConsentOrder($id: ID!) {
destroyConsentOrder(id: $id) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"destroyConsentOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": "4",
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 987,
"isAnonymous": false,
"isCancelable": false,
"isCustomerRegistered": true,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": true,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
destroyMultipleOrderRecipes
Description
Destroy multiple order recipe record
ALLOWED ROLES: [admin, cashier, customer, editor_order_recipe, guest, operator, super_admin]
Example
Query
mutation destroyMultipleOrderRecipes($ids: [ID!]!) {
destroyMultipleOrderRecipes(ids: $ids) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"destroyMultipleOrderRecipes": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["xyz789"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 987,
"isAnonymous": false,
"isCancelable": false,
"isCustomerRegistered": true,
"isFinalized": false,
"isPaidWithCard": true,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
destroyOrderRecipe
Description
Destroy order recipe record
ALLOWED ROLES: [admin, cashier, customer, editor_order_recipe, guest, operator, super_admin]
Example
Query
mutation destroyOrderRecipe($id: ID!) {
destroyOrderRecipe(id: $id) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"destroyOrderRecipe": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["xyz789"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 987,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 123,
"isAnonymous": false,
"isCancelable": false,
"isCustomerRegistered": true,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": false,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
destroyOrderRecipes
Description
Destroy same recipes of one order
ALLOWED ROLES: [admin, cashier, customer, editor_order_recipe, guest, operator, super_admin]
Example
Query
mutation destroyOrderRecipes(
$order: ID!,
$recipe: ID!
) {
destroyOrderRecipes(
order: $order,
recipe: $recipe
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": "4", "recipe": 4}
Response
{
"data": {
"destroyOrderRecipes": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["xyz789"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 123,
"isAnonymous": false,
"isCancelable": true,
"isCustomerRegistered": true,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": false,
"isPriority": false,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
finishExternalOrder
Description
Mark order as finished by external service
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
paymentMethods - [InputOrderPaymentMethodsCreate!]!
|
Example
Query
mutation finishExternalOrder(
$id: ID!,
$paymentMethods: [InputOrderPaymentMethodsCreate!]!
) {
finishExternalOrder(
id: $id,
paymentMethods: $paymentMethods
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{
"id": 4,
"paymentMethods": [InputOrderPaymentMethodsCreate]
}
Response
{
"data": {
"finishExternalOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 987,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 123,
"isAnonymous": true,
"isCancelable": false,
"isCustomerRegistered": true,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": false,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
finishOrder
Description
Mark order as finished
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns a FinishedOrder!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
order - InputOrderFinish!
|
Example
Query
mutation finishOrder(
$id: ID!,
$order: InputOrderFinish!
) {
finishOrder(
id: $id,
order: $order
) {
csobUrl
gopayUrl
gpWebpayUrl
order {
...OrderFragment
}
payFastUrl
payuUrl
userErrors
}
}
Variables
{"id": 4, "order": InputOrderFinish}
Response
{
"data": {
"finishOrder": {
"csobUrl": "abc123",
"gopayUrl": "xyz789",
"gpWebpayUrl": "xyz789",
"order": Order,
"payFastUrl": "abc123",
"payuUrl": "xyz789",
"userErrors": ["xyz789"]
}
}
}
finishStaffOrder
Description
Mark order as finished by staff
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
invoice - String
|
|
paymentMethods - [InputOrderPaymentMethodsCreate!]
|
|
invoiceNumber - Int
|
Example
Query
mutation finishStaffOrder(
$id: ID!,
$invoice: String,
$paymentMethods: [InputOrderPaymentMethodsCreate!],
$invoiceNumber: Int
) {
finishStaffOrder(
id: $id,
invoice: $invoice,
paymentMethods: $paymentMethods,
invoiceNumber: $invoiceNumber
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{
"id": 4,
"invoice": "xyz789",
"paymentMethods": [InputOrderPaymentMethodsCreate],
"invoiceNumber": 987
}
Response
{
"data": {
"finishStaffOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["xyz789"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": "4",
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": true,
"isCancelable": false,
"isCustomerRegistered": false,
"isFinalized": false,
"isPaidWithCard": true,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
finishVirtualCashBoxOrder
Description
Mark order as finished
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns a FinishedOrder!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
order - InputOrderFinish!
|
Example
Query
mutation finishVirtualCashBoxOrder(
$id: ID!,
$order: InputOrderFinish!
) {
finishVirtualCashBoxOrder(
id: $id,
order: $order
) {
csobUrl
gopayUrl
gpWebpayUrl
order {
...OrderFragment
}
payFastUrl
payuUrl
userErrors
}
}
Variables
{"id": 4, "order": InputOrderFinish}
Response
{
"data": {
"finishVirtualCashBoxOrder": {
"csobUrl": "xyz789",
"gopayUrl": "abc123",
"gpWebpayUrl": "abc123",
"order": Order,
"payFastUrl": "abc123",
"payuUrl": "abc123",
"userErrors": ["xyz789"]
}
}
}
importOrders
Description
Create staff order record
ALLOWED ROLES: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
Response
Returns [ImportedOrder!]!
Arguments
| Name | Description |
|---|---|
cashBox - String!
|
|
orders - [InputOrderStaffImport!]!
|
|
lastInvoiceNumber - Int!
|
Example
Query
mutation importOrders(
$cashBox: String!,
$orders: [InputOrderStaffImport!]!,
$lastInvoiceNumber: Int!
) {
importOrders(
cashBox: $cashBox,
orders: $orders,
lastInvoiceNumber: $lastInvoiceNumber
) {
error
id
invoiceSequenceCashBox
success
}
}
Variables
{
"cashBox": "xyz789",
"orders": [InputOrderStaffImport],
"lastInvoiceNumber": 987
}
Response
{
"data": {
"importOrders": [
{
"error": "xyz789",
"id": "4",
"invoiceSequenceCashBox": 987,
"success": false
}
]
}
}
removeOrderPromoCode
Description
Remove promo code from order
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, guest, merchant, operator, sales_representative, super_admin, supervisor]
Example
Query
mutation removeOrderPromoCode(
$order: ID!,
$promoCode: ID!
) {
removeOrderPromoCode(
order: $order,
promoCode: $promoCode
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"order": "4", "promoCode": 4}
Response
{
"data": {
"removeOrderPromoCode": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 123,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": 4,
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 123,
"isAnonymous": false,
"isCancelable": true,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": false,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
removeOrderState
Description
Remove order state for defined order
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order_state_relation, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
order - ID!
|
|
orderState - OrderStateEnum!
|
|
target - OrderStateCategoryTargetEnum
|
Example
Query
mutation removeOrderState(
$order: ID!,
$orderState: OrderStateEnum!,
$target: OrderStateCategoryTargetEnum
) {
removeOrderState(
order: $order,
orderState: $orderState,
target: $target
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{
"order": "4",
"orderState": "IN_CART",
"target": "BACKEND"
}
Response
{
"data": {
"removeOrderState": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["abc123"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 987,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": 4,
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 123,
"isAnonymous": true,
"isCancelable": true,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
requestEmailConfirmationCode
Description
Request sending confirmation code for given phone number
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns a RequestEmailConfirmationCode!
Example
Query
mutation requestEmailConfirmationCode(
$email: String,
$returnUrl: String!
) {
requestEmailConfirmationCode(
email: $email,
returnUrl: $returnUrl
) {
email
}
}
Variables
{"email": null, "returnUrl": "abc123"}
Response
{
"data": {
"requestEmailConfirmationCode": {
"email": "xyz789"
}
}
}
requestPhoneConfirmationCode
Description
Request sending confirmation code for given phone number
ALLOWED ROLES: [admin, guest, super_admin, support, user]
Response
Returns a RequestPhoneConfirmationCode!
Example
Query
mutation requestPhoneConfirmationCode(
$phoneNumber: String!,
$originatorHost: String,
$backgroundExport: ID
) {
requestPhoneConfirmationCode(
phoneNumber: $phoneNumber,
originatorHost: $originatorHost,
backgroundExport: $backgroundExport
) {
phone
}
}
Variables
{
"phoneNumber": "abc123",
"originatorHost": null,
"backgroundExport": "4"
}
Response
{
"data": {
"requestPhoneConfirmationCode": {
"phone": "xyz789"
}
}
}
updateOrder
Description
Update order record
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
order - InputOrderUpdate!
|
Example
Query
mutation updateOrder(
$id: ID!,
$order: InputOrderUpdate!
) {
updateOrder(
id: $id,
order: $order
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"id": 4, "order": InputOrderUpdate}
Response
{
"data": {
"updateOrder": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": 4,
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 123,
"isAnonymous": false,
"isCancelable": false,
"isCustomerRegistered": true,
"isFinalized": false,
"isPaidWithCard": false,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 123,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "xyz789",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
updateOrderPreview
Description
Prepare preview of order record update. Keep in mind that new changes are stored just in-memory, so digging deep inside GraphQL structure may lead to read of inaccurate data.
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns [OrderDiffEntry!]!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
order - InputOrderUpdate!
|
Example
Query
mutation updateOrderPreview(
$id: ID!,
$order: InputOrderUpdate!
) {
updateOrderPreview(
id: $id,
order: $order
) {
attribute
changeType
newData {
... on CompanyBranch {
...CompanyBranchFragment
}
... on DateTimeWrapped {
...DateTimeWrappedFragment
}
... on DeliverySlot {
...DeliverySlotFragment
}
... on DeliveryType {
...DeliveryTypeFragment
}
... on OrderRecipe {
...OrderRecipeFragment
}
... on PriceConverted {
...PriceConvertedFragment
}
}
oldData {
... on CompanyBranch {
...CompanyBranchFragment
}
... on DateTimeWrapped {
...DateTimeWrappedFragment
}
... on DeliverySlot {
...DeliverySlotFragment
}
... on DeliveryType {
...DeliveryTypeFragment
}
... on OrderRecipe {
...OrderRecipeFragment
}
... on PriceConverted {
...PriceConvertedFragment
}
}
}
}
Variables
{
"id": "4",
"order": InputOrderUpdate
}
Response
{
"data": {
"updateOrderPreview": [
{
"attribute": "COMPANY_BRANCH",
"changeType": "REMOVE",
"newData": CompanyBranch,
"oldData": CompanyBranch
}
]
}
}
updateOrderRecipe
Description
Update order recipe record (item of order)
ALLOWED ROLES: [admin, cashier, customer, driver, editor_order_recipe, guest, operator, super_admin, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
orderRecipe - InputOrderRecipeUpdate!
|
Example
Query
mutation updateOrderRecipe(
$id: ID!,
$orderRecipe: InputOrderRecipeUpdate!
) {
updateOrderRecipe(
id: $id,
orderRecipe: $orderRecipe
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{"id": 4, "orderRecipe": InputOrderRecipeUpdate}
Response
{
"data": {
"updateOrderRecipe": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["abc123"],
"appliedRules": ["abc123"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 123,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": false,
"id": 4,
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": false,
"isCancelable": false,
"isCustomerRegistered": true,
"isFinalized": false,
"isPaidWithCard": false,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 987,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
updateOrderRecipeState
Description
Update order recipe record (item of order)
ALLOWED ROLES: [admin, cashier, customer, driver, editor_order_recipe, guest, operator, super_admin, support]
Response
Returns an OrderRecipe!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
orderRecipeState - OrderRecipeStateEnum!
|
|
target - OrderStateCategoryTargetEnum
|
Example
Query
mutation updateOrderRecipeState(
$id: ID!,
$orderRecipeState: OrderRecipeStateEnum!,
$target: OrderStateCategoryTargetEnum
) {
updateOrderRecipeState(
id: $id,
orderRecipeState: $orderRecipeState,
target: $target
) {
appliedRules
automatic
covers {
...OrderRecipeFragment
}
hasDynamicPrice
id
note
order {
...OrderFragment
}
orderRecipeState {
...OrderRecipeStateFragment
}
parent {
...OrderRecipeFragment
}
price {
...PriceConvertedFragment
}
priceWithSideDishes {
...PriceConvertedFragment
}
promoTag {
...PromoTagFragment
}
recipe {
...RecipeFragment
}
sideDishes {
...OrderRecipeFragment
}
wareCategory {
...WareCategoryFragment
}
}
}
Variables
{"id": 4, "orderRecipeState": "FRESH", "target": "BACKEND"}
Response
{
"data": {
"updateOrderRecipeState": {
"appliedRules": ["xyz789"],
"automatic": true,
"covers": [OrderRecipe],
"hasDynamicPrice": false,
"id": "4",
"note": "xyz789",
"order": Order,
"orderRecipeState": OrderRecipeState,
"parent": OrderRecipe,
"price": PriceConverted,
"priceWithSideDishes": PriceConverted,
"promoTag": PromoTag,
"recipe": Recipe,
"sideDishes": [OrderRecipe],
"wareCategory": WareCategory
}
}
}
updateOrderTip
Description
Update order tip. If both absolute and relative values are present, both are applied. If only one is present, the other is updated to zero.
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
orderId - ID!
|
|
tip - InputOrderTipUpdate!
|
Example
Query
mutation updateOrderTip(
$orderId: ID!,
$tip: InputOrderTipUpdate!
) {
updateOrderTip(
orderId: $orderId,
tip: $tip
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{
"orderId": "4",
"tip": InputOrderTipUpdate
}
Response
{
"data": {
"updateOrderTip": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": false,
"allAppliedRules": ["xyz789"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 987,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": true,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 987,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": 4,
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": true,
"isCancelable": false,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": true,
"isPartiallyFinalized": false,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "abc123",
"previousNote": "abc123",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
updateOrderUser
Description
Update the User of an Order
ALLOWED ROLES: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
Response
Returns an Order!
Example
Query
mutation updateOrderUser(
$order: ID!,
$token: String!
) {
updateOrderUser(
order: $order,
token: $token
) {
acceptedAt
address {
...JsonAddressFragment
}
affiliate {
...CompanyFragment
}
ageControl
allAppliedRules
appliedRules
billing {
...OrderBillingFragment
}
canBeUpdatedToPaymentMethods {
...PaymentMethodFragment
}
canRequestCancel
cancelAlreadyRequested
cashBox {
...CashBoxFragment
}
collectFromCustomer {
...PriceConvertedFragment
}
companyBranch {
...CompanyBranchFragment
}
countWares
coverPrice {
...PriceConvertedFragment
}
coveringOrders {
...OrderFragment
}
createdAt
creditsPendingWalletPayment {
...CreditsPendingWalletPaymentFragment
}
creditsReward {
...CreditsRewardFragment
}
currentUserCanFinishOrder
customer {
...JsonCustomerFragment
}
customerJson {
...JsonCustomerFragment
}
customerOrdersCountCurrent
customerOrdersCountTotal
delayedDeliveryTime
deliverAt
deliverAtWorst
deliveredAt
deliverySlot {
...DeliverySlotFragment
}
deliveryType {
...DeliveryTypeFragment
}
discounts {
...PriceWithDescriptionFragment
}
doNotCount
driverWillPickupAt
eet {
...EETTypeFragment
}
externalDeliveryProviders {
...ExternalDeliveryProviderFragment
}
extraCharge {
...PriceConvertedFragment
}
extraFees {
...ExtraFeeFragment
}
extraFeesSum {
...PriceConvertedFragment
}
flatItems {
...OrderRecipeFlatFragment
}
gps {
...GeoPointFragment
}
groupedRecipes {
...GroupedRecipeFragment
}
hasRating
id
invoiceSequence
invoiceSequenceCashBox
invoiceSequenceResettable
isAnonymous
isCancelable
isCustomerRegistered
isFinalized
isPaidWithCard
isPartiallyFinalized
isPriority
items {
...OrderRecipeFragment
}
language {
...LanguageFragment
}
levelsOfTransportFees {
...TransportFeesFragment
}
levelsOfTransportFeesCount
location {
...JsonLocationFragment
}
minimalOrderPrice {
...PriceConvertedFragment
}
minimalOrderPriceRemainder {
...PriceConvertedFragment
}
minimalOrderPriceWithDiscounts
minimalOrderPriceWithTransportFee
nextPossibleTransportFee {
...TransportFeesFragment
}
note
notification {
...NotificationFragment
}
operatingCostRecords {
...OperatingCostRecordFragment
}
orderConsents {
...ConsentOrderFragment
}
orderDeliverySlot {
...OrderDeliverySlotFragment
}
orderGroup {
...OrderGroupFragment
}
orderGroupIndex
orderOnlineState {
...OrderOnlineStateFragment
}
orderOrigin {
...OrderOriginFragment
}
orderPayments {
...OrderPaymentMethodFragment
}
orderStateCategories
orderStateCategory
orderStateCategoryRelations {
...OrderStateCategoryRelationFragment
}
orderStateRelations {
...OrderStateRelationFragment
}
orderStates {
...OrderStateFragment
}
paidPrice {
...PriceConvertedFragment
}
preciseUpdatedAt
previousNote
productTotalSum {
...PriceConvertedFragment
}
promoCodes {
...PromoCodeFragment
}
purchasedCreditsWallet {
...CreditsWalletFragment
}
rating {
...OrderRatingFragment
}
returnPrice {
...PriceConvertedFragment
}
sector {
...SectorFragment
}
tip {
...PriceConvertedFragment
}
totalDiscount {
...PriceConvertedFragment
}
totalSum {
...PriceConvertedFragment
}
totalVouchers {
...PriceConvertedFragment
}
totalWithoutTips {
...PriceConvertedFragment
}
transferOrderFrom {
...OrderFragment
}
transferOrderTo {
...OrderFragment
}
transportFee {
...PriceConvertedFragment
}
updatedAt
user {
...UserFragment
}
userDeliveringOrder {
...UserDeliveringOrderFragment
}
userDeliveringOrders {
...UserDeliveringOrderFragment
}
vouchers {
...PriceWithDescriptionFragment
}
warePriceType {
...WarePriceTypeFragment
}
zone {
...ZoneFragment
}
}
}
Variables
{
"order": "4",
"token": "xyz789"
}
Response
{
"data": {
"updateOrderUser": {
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": false,
"cancelAlreadyRequested": false,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [
ExternalDeliveryProvider
],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": "4",
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 123,
"isAnonymous": true,
"isCancelable": true,
"isCustomerRegistered": false,
"isFinalized": true,
"isPaidWithCard": false,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": false,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
}
}
validateEmailConfirmationCode
Description
Request sending confirmation code for given phone number
ALLOWED ROLES: [admin, guest, super_admin, user]
Response
Returns a RequestEmailConfirmationCode!
Arguments
| Name | Description |
|---|---|
token - String!
|
Example
Query
mutation validateEmailConfirmationCode($token: String!) {
validateEmailConfirmationCode(token: $token) {
email
}
}
Variables
{"token": "abc123"}
Response
{
"data": {
"validateEmailConfirmationCode": {
"email": "abc123"
}
}
}
validatePhoneConfirmationCode
Description
Confirm phone number with given activation code
ALLOWED ROLES: [admin, guest, super_admin, user]
Response
Returns a PhoneCodeValidation
Example
Query
mutation validatePhoneConfirmationCode(
$phoneNumber: String!,
$code: String!
) {
validatePhoneConfirmationCode(
phoneNumber: $phoneNumber,
code: $code
) {
token
userExists
}
}
Variables
{
"phoneNumber": "xyz789",
"code": "xyz789"
}
Response
{
"data": {
"validatePhoneConfirmationCode": {
"token": "xyz789",
"userExists": true
}
}
}
Subscriptions
updatedExternalDelivery
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns an ExternalDeliveryUpdateSubscription!
Arguments
| Name | Description |
|---|---|
companyBranches - [ID!]!
|
Example
Query
subscription updatedExternalDelivery($companyBranches: [ID!]!) {
updatedExternalDelivery(companyBranches: $companyBranches) {
actionType
externalDelivery {
...ExternalDeliveryFragment
}
id
}
}
Variables
{"companyBranches": [4]}
Response
{
"data": {
"updatedExternalDelivery": {
"actionType": "CREATE",
"externalDelivery": ExternalDelivery,
"id": "4"
}
}
}
updatedOrder
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns an OrderUpdateSubscription!
Arguments
| Name | Description |
|---|---|
companyBranches - [ID!]
|
|
orderStateCategoriesOR - [OrderStateCategoryEnum!]
|
|
orderStateCategoryTarget - OrderStateCategoryTargetEnum
|
Default = FE_ADMIN |
includeOldFinished - Boolean
|
Default = true |
sectors - [ID!]
|
|
sectorsWithChildren - Boolean
|
Default = false |
occasions - [ID!]
|
|
groups - [ID!]
|
|
id - ID
|
Example
Query
subscription updatedOrder(
$companyBranches: [ID!],
$orderStateCategoriesOR: [OrderStateCategoryEnum!],
$orderStateCategoryTarget: OrderStateCategoryTargetEnum,
$includeOldFinished: Boolean,
$sectors: [ID!],
$sectorsWithChildren: Boolean,
$occasions: [ID!],
$groups: [ID!],
$id: ID
) {
updatedOrder(
companyBranches: $companyBranches,
orderStateCategoriesOR: $orderStateCategoriesOR,
orderStateCategoryTarget: $orderStateCategoryTarget,
includeOldFinished: $includeOldFinished,
sectors: $sectors,
sectorsWithChildren: $sectorsWithChildren,
occasions: $occasions,
groups: $groups,
id: $id
) {
actionType
id
order {
...OrderFragment
}
}
}
Variables
{
"companyBranches": [4],
"orderStateCategoriesOR": ["MAIN"],
"orderStateCategoryTarget": "FE_ADMIN",
"includeOldFinished": true,
"sectors": ["4"],
"sectorsWithChildren": false,
"occasions": ["4"],
"groups": ["4"],
"id": 4
}
Response
{
"data": {
"updatedOrder": {
"actionType": "CREATE",
"id": 4,
"order": Order
}
}
}
updatedOrderCategoryCount
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns an OrderCategoryCountSubscription!
Arguments
| Name | Description |
|---|---|
companyBranches - [ID!]!
|
|
orderStateCategories - [OrderStateCategoryEnum!]!
|
|
orderStateCategoryTarget - OrderStateCategoryTargetEnum
|
Default = FE_ADMIN |
Example
Query
subscription updatedOrderCategoryCount(
$companyBranches: [ID!]!,
$orderStateCategories: [OrderStateCategoryEnum!]!,
$orderStateCategoryTarget: OrderStateCategoryTargetEnum
) {
updatedOrderCategoryCount(
companyBranches: $companyBranches,
orderStateCategories: $orderStateCategories,
orderStateCategoryTarget: $orderStateCategoryTarget
) {
actionType
id
newOrderStateCategory
oldOrderStateCategory
order {
...OrderFragment
}
}
}
Variables
{
"companyBranches": ["4"],
"orderStateCategories": ["MAIN"],
"orderStateCategoryTarget": "FE_ADMIN"
}
Response
{
"data": {
"updatedOrderCategoryCount": {
"actionType": "CREATE",
"id": "4",
"newOrderStateCategory": "MAIN",
"oldOrderStateCategory": "MAIN",
"order": Order
}
}
}
updatedOrdersCount
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns an OrderCountSubscription!
Arguments
| Name | Description |
|---|---|
companyBranches - [ID!]
|
Example
Query
subscription updatedOrdersCount($companyBranches: [ID!]) {
updatedOrdersCount(companyBranches: $companyBranches) {
actionType
id
ordersCount
}
}
Variables
{"companyBranches": [4]}
Response
{
"data": {
"updatedOrdersCount": {
"actionType": "CREATE",
"id": "4",
"ordersCount": 987
}
}
}
updatedPrintQueue
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns a PrintQueueUpdateSubscription!
Example
Query
subscription updatedPrintQueue(
$targetMac: String!,
$printers: [ID!]!
) {
updatedPrintQueue(
targetMac: $targetMac,
printers: $printers
) {
actionType
id
printQueue {
...PrintQueueFragment
}
}
}
Variables
{"targetMac": "xyz789", "printers": [4]}
Response
{
"data": {
"updatedPrintQueue": {
"actionType": "CREATE",
"id": 4,
"printQueue": PrintQueue
}
}
}
updatedSectorRecipe
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns a SectorRecipeUpdateSubscription!
Arguments
| Name | Description |
|---|---|
companyBranches - [ID!]
|
|
sectors - [ID!]
|
|
sectorsWithChildren - Boolean
|
Default = false |
orderRecipeStateOR - [OrderRecipeStateEnum!]
|
|
groups - [ID!]
|
Example
Query
subscription updatedSectorRecipe(
$companyBranches: [ID!],
$sectors: [ID!],
$sectorsWithChildren: Boolean,
$orderRecipeStateOR: [OrderRecipeStateEnum!],
$groups: [ID!]
) {
updatedSectorRecipe(
companyBranches: $companyBranches,
sectors: $sectors,
sectorsWithChildren: $sectorsWithChildren,
orderRecipeStateOR: $orderRecipeStateOR,
groups: $groups
) {
actionType
id
sectorRecipe {
...SectorRecipeFragment
}
}
}
Variables
{
"companyBranches": [4],
"sectors": [4],
"sectorsWithChildren": false,
"orderRecipeStateOR": ["FRESH"],
"groups": ["4"]
}
Response
{
"data": {
"updatedSectorRecipe": {
"actionType": "CREATE",
"id": 4,
"sectorRecipe": SectorRecipe
}
}
}
updatedTransportationDeviceUser
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Example
Query
subscription updatedTransportationDeviceUser(
$companyBranches: [ID!],
$user: ID,
$transportationDevice: ID
) {
updatedTransportationDeviceUser(
companyBranches: $companyBranches,
user: $user,
transportationDevice: $transportationDevice
) {
actionType
id
transportationDeviceUser {
...TransportationDeviceUserFragment
}
}
}
Variables
{
"companyBranches": ["4"],
"user": 4,
"transportationDevice": 4
}
Response
{
"data": {
"updatedTransportationDeviceUser": {
"actionType": "CREATE",
"id": 4,
"transportationDeviceUser": TransportationDeviceUser
}
}
}
updatedUserCallingCustomer
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns a UserCallingCustomerSubscription!
Example
Query
subscription updatedUserCallingCustomer(
$companyBranches: [ID!],
$user: ID
) {
updatedUserCallingCustomer(
companyBranches: $companyBranches,
user: $user
) {
eventId
isRinging
phone
prefix
}
}
Variables
{"companyBranches": [4], "user": "4"}
Response
{
"data": {
"updatedUserCallingCustomer": {
"eventId": 4,
"isRinging": false,
"phone": "xyz789",
"prefix": "xyz789"
}
}
}
updatedUserDeliveringOrder
Description
ALLOWED ROLES: [access_config, account_manager, accountant, admin, branch_owner, brand_owner, call_center, cashier, cashier_allowed_delivery_types, cashier_basic_recipes, cashier_cancel, cashier_change_delivery_type, cashier_delivery, cashier_isolated_print, cashier_kiosk, cashier_menu, cashier_payment_methods, cashier_pos, cashier_process_time, cashier_reports, cashier_statistics, cashier_transfer_company_branch, cashier_unlimited, cashier_unlimited_customer, cashier_without_print, cashless_supervisor, customer, driver, driver_default, driver_dodo, driver_foodis, driver_foodora_go, driver_liftago, driver_prorozvoz, driver_wolt_drive, editor, editor_address, editor_announcement, editor_availability, editor_billings, editor_business_hour, editor_business_hours, editor_cash_box, editor_company, editor_company_branch, editor_company_branch_currency, editor_company_branch_delivery, editor_company_branch_user, editor_company_order_origin, editor_country, editor_country_vat, editor_country_vat_price_type, editor_country_vat_type_price, editor_currency, editor_event, editor_financial_report, editor_import_log, editor_ingredient, editor_label, editor_label_translation, editor_menu, editor_note, editor_order, editor_order_billing, editor_order_discount, editor_order_origin_price_type, editor_order_payment_method, editor_order_price_modification, editor_order_recipe, editor_order_state_relation, editor_orders, editor_page_element, editor_payment_method, editor_payment_method_branch, editor_promo_code, editor_recipe, editor_recipe_price, editor_recipe_relation, editor_rejected_payment_method, editor_role, editor_setting, editor_shift, editor_shift_user, editor_sorting, editor_stock_item, editor_stock_item_allergen, editor_stock_transfer, editor_transportation_device, editor_transportation_device_user, editor_user, editor_user_delivering_order, editor_user_login_provider, editor_user_personal, editor_wallet_credits, editor_wallet_credits_refund, editor_ware, editor_ware_category, editor_ware_category_relation, editor_zone, editor_zones, export_customers, extern, external_api, gastra_api, guest, liftago, menu_sync, merchant, operator, owner_cancel, request_cancel, request_external_driver, sales_representative, super_admin, supervisor, support, suspended_user, templatable_manager, user, vam]
Response
Returns a UserDeliveringOrderUpdateSubscription!
Example
Query
subscription updatedUserDeliveringOrder(
$companyBranches: [ID!],
$user: ID
) {
updatedUserDeliveringOrder(
companyBranches: $companyBranches,
user: $user
) {
actionType
id
userDeliveringOrder {
...UserDeliveringOrderFragment
}
}
}
Variables
{
"companyBranches": ["4"],
"user": "4"
}
Response
{
"data": {
"updatedUserDeliveringOrder": {
"actionType": "CREATE",
"id": "4",
"userDeliveringOrder": UserDeliveringOrder
}
}
}
Types
Address
Description
Address schema of User, Company or Company Branch. Holds information about location and contact possibilities.
INDEX: [admin, branch_owner, brand_owner, cashier, customer, editor_address, operator, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, cashier, customer, editor_address, operator, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, customer, editor_address, super_admin, support]
UPDATE: [admin, branch_owner, brand_owner, customer, editor_address, operator, sales_representative, super_admin, supervisor, support, user]
DESTROY: [admin, customer, editor_address, super_admin]
Fields
| Field Name | Description |
|---|---|
addressType - AddressType!
|
|
country - Country
|
|
driverNote - String
|
|
emails - [Email!]!
|
possible e-mail contacts |
gps - GeoPoint
|
|
id - ID!
|
|
location - JsonAddress
|
description of location |
phones - [Phone!]!
|
possible phone contacts |
title - String
|
Example
{
"addressType": AddressType,
"country": Country,
"driverNote": "xyz789",
"emails": [Email],
"gps": GeoPoint,
"id": "4",
"location": JsonAddress,
"phones": [Phone],
"title": "xyz789"
}
AddressResolvedLocation
Fields
| Field Name | Description |
|---|---|
companyBranch - CompanyBranch
|
|
finalAddress - JsonAddress
|
|
finalAddressFormatted - String
|
|
gpsCoordinates - GeoPoint
|
|
inDeliveryLocation - Boolean!
|
|
isResolved - Boolean!
|
|
isValidAddress - Boolean!
|
|
zone - Zone
|
Example
{
"companyBranch": CompanyBranch,
"finalAddress": JsonAddress,
"finalAddressFormatted": "abc123",
"gpsCoordinates": GeoPoint,
"inDeliveryLocation": false,
"isResolved": false,
"isValidAddress": false,
"zone": Zone
}
AddressType
Description
Possible AddressType types
INDEX: [admin, operator, super_admin, support, user]
READ: [admin, operator, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - AddressTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
internal - Boolean!
|
mark if this address type is public and should be used in registration |
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "BUSINESS",
"id": "4",
"internal": true,
"rawCode": "xyz789"
}
AddressTypeEnum
Description
AddressType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BUSINESS"
Allergen
Description
Allergen type schema
INDEX: [admin, editor_menu, editor_orders, guest, super_admin, support, user]
READ: [admin, editor_menu, editor_orders, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
category - Int!
|
category of allergen |
code - String!
|
|
enum - AllergenEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"category": 123,
"code": "xyz789",
"enum": "CEREALS_WITH_GLUTTEN",
"id": "4",
"rawCode": "xyz789"
}
AllergenEnum
Description
Allergen enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CEREALS_WITH_GLUTTEN"
AnalyticsCode
Description
Information about available analytics codes
Fields
| Field Name | Description |
|---|---|
analyticsCodeType - AnalyticsCodeType!
|
|
code - String
|
Example
{
"analyticsCodeType": AnalyticsCodeType,
"code": "abc123"
}
AnalyticsCodeType
Description
Possible AnalyticsCodeType types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - AnalyticsCodeTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "GOOGLE_ANALYTICS",
"id": 4,
"rawCode": "xyz789"
}
AnalyticsCodeTypeEnum
Description
AnalyticsCodeType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GOOGLE_ANALYTICS"
ApplicationSettings
Description
Setting attributes for brand or branch
Fields
| Field Name | Description |
|---|---|
dynamicTranslations - DynamicTranslationsTranslations
|
|
headerText - String
|
|
homepageUrl - String
|
|
promoHeaderEnabled - Boolean
|
enabling promo header setting |
promoHeaderText - String
|
inherited promo header text |
promoHeaderTranslations - [PromoHeaderTranslation!]
|
promo header text from setting without inheritance |
styles - GraphicStyle!
|
graphic styles |
Arguments
|
|
userAccountsEnabledForCustomer - Boolean!
|
|
wifiAppInstructions - [WiFiAppInstruction!]!
|
|
Example
{
"dynamicTranslations": DynamicTranslationsTranslations,
"headerText": "xyz789",
"homepageUrl": "xyz789",
"promoHeaderEnabled": true,
"promoHeaderText": "xyz789",
"promoHeaderTranslations": [PromoHeaderTranslation],
"styles": GraphicStyle,
"userAccountsEnabledForCustomer": false,
"wifiAppInstructions": [WiFiAppInstruction]
}
ApplicationSettingsInterface
Fields
| Field Name | Description |
|---|---|
dynamicTranslations - DynamicTranslationsTranslations
|
|
headerText - String
|
|
homepageUrl - String
|
|
promoHeaderEnabled - Boolean
|
enabling promo header setting |
promoHeaderText - String
|
inherited promo header text |
promoHeaderTranslations - [PromoHeaderTranslation!]
|
promo header text from setting without inheritance |
styles - GraphicStyle!
|
graphic styles |
Arguments
|
|
userAccountsEnabledForCustomer - Boolean!
|
|
wifiAppInstructions - [WiFiAppInstruction!]!
|
|
Possible Types
| ApplicationSettingsInterface Types |
|---|
Example
{
"dynamicTranslations": DynamicTranslationsTranslations,
"headerText": "xyz789",
"homepageUrl": "abc123",
"promoHeaderEnabled": true,
"promoHeaderText": "abc123",
"promoHeaderTranslations": [PromoHeaderTranslation],
"styles": GraphicStyle,
"userAccountsEnabledForCustomer": true,
"wifiAppInstructions": [WiFiAppInstruction]
}
Availability
Description
Holds information about usability - what times can be Ware, etc. used
INDEX: [admin, branch_owner, brand_owner, cashier, cashier_menu, editor_availability, editor_menu, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, cashier_menu, editor_availability, editor_menu, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_availability, editor_menu, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_availability, editor_menu, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_availability, editor_menu, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
availabilityType - AvailabilityType!
|
|
available - Boolean!
|
|
dateFrom - Date
|
|
dateTo - Date
|
|
id - ID!
|
|
orderOriginCategories - [OrderOriginCategoryEnum!]!
|
|
periodic - Boolean!
|
|
timeFrom - Time
|
|
timeTo - Time
|
|
weekDay - WeekDay
|
Example
{
"availabilityType": AvailabilityType,
"available": false,
"dateFrom": "2007-12-03",
"dateTo": "2007-12-03",
"id": "4",
"orderOriginCategories": ["DOVEZE"],
"periodic": true,
"timeFrom": "10:15:30Z",
"timeTo": "10:15:30Z",
"weekDay": WeekDay
}
AvailabilityInterface
Fields
| Field Name | Description |
|---|---|
availabilities - [Availability!]!
|
when record is available |
isAvailable - Boolean!
|
is available at specific time? |
Arguments
|
|
Possible Types
| AvailabilityInterface Types |
|---|
Example
{"availabilities": [Availability], "isAvailable": false}
AvailabilityType
Description
Possible AvailabilityType types
INDEX: [admin, editor_menu, super_admin, support, user]
READ: [admin, editor_menu, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - AvailabilityTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "MAIN",
"id": "4",
"rawCode": "xyz789"
}
AvailabilityTypeEnum
Description
AvailabilityType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MAIN"
Board
Description
Board
INDEX: [admin, branch_owner, brand_owner, guest, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, guest, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
backgroundImage - String
|
Converts ActiveStorage attachment to URL |
backgroundVideo - String
|
Converts ActiveStorage attachment to URL |
boardScreens - [BoardScreen!]!
|
Board screens ordered through sorting |
boardTemplate - BoardTemplate!
|
|
colors - [String!]!
|
Custom color set |
companyBranch - CompanyBranch!
|
|
features - BoardFeatures!
|
|
id - ID!
|
|
logo - String
|
Converts ActiveStorage attachment to URL |
name - String!
|
|
Example
{
"backgroundImage": "abc123",
"backgroundVideo": "abc123",
"boardScreens": [BoardScreen],
"boardTemplate": BoardTemplate,
"colors": ["xyz789"],
"companyBranch": CompanyBranch,
"features": BoardFeatures,
"id": "4",
"logo": "abc123",
"name": "xyz789"
}
BoardFeatures
Description
Board features
Example
{
"allergensEnabled": true,
"infoMessageEnabled": false,
"infoMessagePrimary": "abc123",
"infoMessageSecondary": "xyz789",
"logoEnabled": true,
"promoCategory": WareCategory,
"promoEnabled": true,
"titleEnabled": true,
"titleText": "abc123",
"titleUrl": "abc123"
}
BoardScreen
Description
Board screen
INDEX: [admin, branch_owner, brand_owner, guest, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, guest, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, sales_representative, super_admin, supervisor]
Example
{
"backgroundImage": "xyz789",
"backgroundVideo": "xyz789",
"board": Board,
"id": "4",
"name": "xyz789",
"wareCategories": [WareCategory]
}
BoardTemplate
Description
Board template
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Example
{
"features": BoardTemplateFeatures,
"id": "4",
"name": "xyz789",
"preview": "xyz789",
"styles": "abc123"
}
BoardTemplateFeatures
Description
Board template features
Example
{
"allergens": true,
"availableColors": 987,
"infoMessage": true,
"logo": true,
"promo": false,
"screenTitle": true
}
Boolean
Description
Represents true or false values.
Example
true
BusinessHour
Description
Schema of opening hours of Company Branch
INDEX: [admin, branch_owner, brand_owner, editor_business_hour, editor_business_hours, guest, merchant, operator, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, editor_business_hour, editor_business_hours, guest, merchant, operator, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, editor_business_hour, editor_business_hours, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_business_hour, editor_business_hours, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_business_hour, editor_business_hours, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
closeAt - Time!
|
|
closed - Boolean!
|
|
closedNote - String
|
reason of closing |
companyBranch - CompanyBranch!
|
|
id - ID!
|
|
mode - BusinessHoursModeEnum!
|
business hours for online orders or physical location |
openAt - Time!
|
|
smsLabel - String
|
|
specificDate - Date
|
special day |
specificDateLocalized - String
|
localized special day |
type - BusinessHoursTypeEnum!
|
can hours work together with regular ones |
webLabel - String
|
|
weekDay - WeekDay
|
which day of week It is used to |
Example
{
"closeAt": "10:15:30Z",
"closed": false,
"closedNote": "abc123",
"companyBranch": CompanyBranch,
"id": "4",
"mode": "ONLINE",
"openAt": "10:15:30Z",
"smsLabel": "xyz789",
"specificDate": "2007-12-03",
"specificDateLocalized": "abc123",
"type": "REGULAR",
"webLabel": "abc123",
"weekDay": WeekDay
}
BusinessHourInterval
Description
Grouped business hours of company branch
Example
{
"closeAt": "2007-12-03T10:15:30Z",
"closed": false,
"closedNote": "xyz789",
"openAt": "2007-12-03T10:15:30Z",
"relevantDay": "2007-12-03"
}
BusinessHoursInterface
Fields
| Field Name | Description |
|---|---|
businessHours - [BusinessHour!]!
|
|
Arguments |
|
businessHoursIntervals - [BusinessHourInterval!]!
|
|
Arguments |
|
currentInterval - BusinessHourInterval
|
|
Arguments
|
|
delayedDeliveryIntervals - [BusinessHourInterval!]!
|
|
Arguments
|
|
isOpen - Boolean!
|
|
Arguments
|
|
willCloseAt - DateTime
|
|
Arguments
|
|
willOpenAt - DateTime
|
|
Arguments
|
|
Possible Types
| BusinessHoursInterface Types |
|---|
Example
{
"businessHours": [BusinessHour],
"businessHoursIntervals": [BusinessHourInterval],
"currentInterval": BusinessHourInterval,
"delayedDeliveryIntervals": [BusinessHourInterval],
"isOpen": false,
"willCloseAt": "2007-12-03T10:15:30Z",
"willOpenAt": "2007-12-03T10:15:30Z"
}
BusinessHoursModeEnum
Description
BusinessHoursMode enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ONLINE"
BusinessHoursTypeEnum
Description
BusinessHoursType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"REGULAR"
CashBox
Description
Schema of cash boxes of Company Branch
INDEX: [admin, branch_owner, brand_owner, cashier, editor_cash_box, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, editor_cash_box, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_cash_box, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, editor_cash_box, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, editor_cash_box, super_admin]
Fields
| Field Name | Description |
|---|---|
automaticOrderFinish - Boolean!
|
|
companyBranch - CompanyBranch!
|
|
configuration - Json
|
|
deleted - Boolean!
|
|
eetId - String!
|
|
enabled - Boolean!
|
|
id - ID!
|
|
kiosk - Boolean!
|
|
lastInvoiceSequence - Int!
|
|
lastResettableInvoiceSequence - Int!
|
|
name - String!
|
|
resettableInvoicePrefix - Int
|
|
type - CashBoxTypeEnum!
|
|
user - User
|
|
uuid - String!
|
|
virtual - Boolean!
|
Example
{
"automaticOrderFinish": false,
"companyBranch": CompanyBranch,
"configuration": Json,
"deleted": false,
"eetId": "abc123",
"enabled": false,
"id": 4,
"kiosk": false,
"lastInvoiceSequence": 123,
"lastResettableInvoiceSequence": 987,
"name": "xyz789",
"resettableInvoicePrefix": 987,
"type": "KIOSK",
"user": User,
"uuid": "xyz789",
"virtual": true
}
CashBoxTypeEnum
Description
CashBoxType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"KIOSK"
ColorInterface
Possible Types
| ColorInterface Types |
|---|
Example
{
"code": "xyz789",
"color": "xyz789",
"id": "4"
}
Company
Description
Company type
INDEX: [admin, branch_owner, brand_owner, driver, editor_company, guest, sales_representative, super_admin, supervisor, support, user, vam]
READ: [admin, branch_owner, brand_owner, driver, editor_company, guest, sales_representative, super_admin, supervisor, support, user, vam]
CREATE: [admin, editor_company, super_admin, support]
UPDATE: [admin, branch_owner, brand_owner, editor_company, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, editor_company, super_admin]
Fields
| Field Name | Description |
|---|---|
account - String!
|
Company account number |
address - Address
|
Main address of company |
companyBranches - [CompanyBranch!]!
|
Company branches accessible by user |
companyConsents - [ConsentCompany!]!
|
|
companyType - CompanyType!
|
|
defaultLanguage - LanguageEnum!
|
|
deliveryEnabled - Boolean
|
possibility of delivering order at least by one brand branch |
dynamicTranslations - DynamicTranslationsTranslations
|
|
hasCreditsGroups - Boolean!
|
|
headerText - String
|
|
homepageUrl - String
|
|
id - ID!
|
|
internalNumber - String
|
|
mobileApplicationSetting - MobileApplicationSetting
|
|
Arguments
|
|
name - String!
|
|
number - String!
|
|
pickupEnabled - Boolean
|
possibility of personal order pickup at least by one brand branch |
promoBanners - [PromoBanner!]
|
|
Arguments
|
|
promoHeaderEnabled - Boolean
|
enabling promo header setting |
promoHeaderText - String
|
inherited promo header text |
promoHeaderTranslations - [PromoHeaderTranslation!]
|
promo header text from setting without inheritance |
settings - SettingCompany!
|
|
styles - GraphicStyle!
|
graphic styles |
Arguments
|
|
subdomain - String!
|
|
supportedLanguages - [LanguageEnum!]!
|
|
Arguments
|
|
url - String!
|
|
Arguments
|
|
userAccountsEnabledForCustomer - Boolean!
|
|
vatIdent - String
|
|
vatPayer - Boolean!
|
Indicates if Company is payer of VAT. Only for company client type. |
wac - String!
|
|
wareCategorySharingAllowed - Boolean!
|
|
wifiAppInstructions - [WiFiAppInstruction!]!
|
|
Example
{
"account": "xyz789",
"address": Address,
"companyBranches": [CompanyBranch],
"companyConsents": [ConsentCompany],
"companyType": CompanyType,
"defaultLanguage": "CS",
"deliveryEnabled": false,
"dynamicTranslations": DynamicTranslationsTranslations,
"hasCreditsGroups": false,
"headerText": "abc123",
"homepageUrl": "xyz789",
"id": "4",
"internalNumber": "xyz789",
"mobileApplicationSetting": MobileApplicationSetting,
"name": "abc123",
"number": "xyz789",
"pickupEnabled": true,
"promoBanners": [PromoBanner],
"promoHeaderEnabled": true,
"promoHeaderText": "xyz789",
"promoHeaderTranslations": [PromoHeaderTranslation],
"settings": SettingCompany,
"styles": GraphicStyle,
"subdomain": "xyz789",
"supportedLanguages": ["CS"],
"url": "xyz789",
"userAccountsEnabledForCustomer": true,
"vatIdent": "abc123",
"vatPayer": true,
"wac": "abc123",
"wareCategorySharingAllowed": true,
"wifiAppInstructions": [WiFiAppInstruction]
}
CompanyBranch
Description
Company Branch type
INDEX: [admin, branch_owner, brand_owner, cashier, customer, driver, editor, editor_company_branch, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user, vam]
READ: [admin, branch_owner, brand_owner, cashier, customer, driver, editor, editor_company_branch, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user, vam]
CREATE: [admin, editor_company_branch, super_admin, support]
UPDATE: [admin, branch_owner, brand_owner, editor_company_branch, merchant, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, editor_company_branch, super_admin]
Fields
| Field Name | Description |
|---|---|
accountNumber - String!
|
|
address - Address!
|
Main address of company branch |
allowedCategories - [OrderStateCategoryEnum!]!
|
definition of allowed order state categories |
Arguments
|
|
brand - Company!
|
|
businessHours - [BusinessHour!]!
|
|
Arguments |
|
businessHoursIntervals - [BusinessHourInterval!]!
|
|
Arguments |
|
businessHoursMidnight - Time!
|
|
canBeUpdatedToPaymentMethods - [PaymentMethod!]!
|
order payment method can be updated to these values |
Arguments
|
|
company - Company!
|
|
covers - [Recipe!]!
|
all possible covers of company branch |
creditsGroupMembership - CreditsGroupMembership
|
|
currencies - [Currency!]!
|
currencies used by company branch |
currentDeliveryTime - Int!
|
|
currentInterval - BusinessHourInterval
|
|
Arguments
|
|
currentPickupTime - Int!
|
|
defaultCurrency - Currency!
|
|
defaultDeliveryTime - Int!
|
time in minutes that is required to deliver order |
defaultDeliveryTimeEnabled - Boolean!
|
|
defaultLanguage - LanguageEnum!
|
|
defaultPickupTime - Int!
|
time in minutes that is required to pickup order |
defaultPickupTimeEnabled - Boolean!
|
|
defaultVats - [VatPriceType!]!
|
default vat of company branch for defined price type |
delayedDeliveryEnabled - Boolean!
|
|
delayedDeliveryIntervals - [BusinessHourInterval!]!
|
|
Arguments
|
|
delayedDeliveryLimit - Int!
|
|
deliveryAsapEnabled - Boolean
|
|
deliveryEnabled - Boolean!
|
possibility of delivering order |
driverOrderAssignments - [UserDeliveringOrdersAssignmentType!]!
|
|
driverSmsText - String
|
|
dynamicTranslations - DynamicTranslationsTranslations
|
|
earlyDriverAssignment - Boolean!
|
Mark if branch allowing assign driver before order is ready to deliver |
eetCertificate - EETCertificate
|
|
employers - [User!]!
|
|
enabled - Boolean!
|
is company branch working? |
foodMenuUrl - String
|
|
gpTomIntegrationAllowed - Boolean!
|
|
gps - GeoPoint!
|
GPS coordinates of company branch |
headerText - String
|
|
homepageUrl - String
|
|
id - ID!
|
|
incomingStockTransfer - [StockTransfer!]!
|
stock items that are incoming to branch |
infoMessage - String
|
Returns a translated message specific to a company branch. |
internalNumber - String
|
|
isOpen - Boolean!
|
|
Arguments
|
|
kitchenModuleEnabled - Boolean!
|
|
lastInvoiceSequence - Int!
|
|
lastResettableInvoiceSequence - Int!
|
|
maxCartSize - Int!
|
maximal size of cart |
mobileApplicationSetting - MobileApplicationSetting
|
|
Arguments
|
|
name - String!
|
|
occasions - [Occasion!]!
|
|
oldOrderThreshold - Int!
|
how many hours it takes for order to be marked as old |
outcomingStockTransfer - [StockTransfer!]!
|
stock items that are leaving branch |
overriddenDeliveryTime - OrderProcessTime
|
|
overriddenPickupTime - OrderProcessTime
|
|
paymentMethods - [PaymentMethodBranch!]!
|
payment method used by company branch |
Arguments
|
|
phone - String!
|
|
pickupAsapEnabled - Boolean
|
|
pickupEnabled - Boolean!
|
possibility of personal order pickup |
pohodaEnabled - Boolean!
|
|
popUpMessage - String
|
|
Arguments
|
|
popUpMessageFromBranch - Boolean
|
|
Arguments
|
|
promoBanners - [PromoBanner!]
|
|
Arguments |
|
promoCodeLimit - Int!
|
|
promoHeaderEnabled - Boolean
|
enabling promo header setting |
promoHeaderText - String
|
inherited promo header text |
promoHeaderTranslations - [PromoHeaderTranslation!]
|
promo header text from setting without inheritance |
settings - SettingCompanyBranch!
|
|
shifts - [Shift!]!
|
|
stockItemsCanBeNegative - Boolean!
|
|
styles - GraphicStyle!
|
graphic styles |
Arguments
|
|
supportedLanguages - [LanguageEnum!]!
|
|
Arguments
|
|
url - String!
|
|
urlPath - String!
|
|
userAccountsEnabledForCustomer - Boolean!
|
|
wac - String!
|
|
wareCategories - [WareCategory!]!
|
|
wifiAppInstructions - [WiFiAppInstruction!]!
|
|
willCloseAt - DateTime
|
|
Arguments
|
|
willOpenAt - DateTime
|
|
Arguments
|
|
zones - [Zone!]!
|
|
Example
{
"accountNumber": "abc123",
"address": Address,
"allowedCategories": ["MAIN"],
"brand": Company,
"businessHours": [BusinessHour],
"businessHoursIntervals": [BusinessHourInterval],
"businessHoursMidnight": "10:15:30Z",
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"company": Company,
"covers": [Recipe],
"creditsGroupMembership": CreditsGroupMembership,
"currencies": [Currency],
"currentDeliveryTime": 987,
"currentInterval": BusinessHourInterval,
"currentPickupTime": 123,
"defaultCurrency": Currency,
"defaultDeliveryTime": 987,
"defaultDeliveryTimeEnabled": true,
"defaultLanguage": "CS",
"defaultPickupTime": 123,
"defaultPickupTimeEnabled": false,
"defaultVats": [VatPriceType],
"delayedDeliveryEnabled": false,
"delayedDeliveryIntervals": [BusinessHourInterval],
"delayedDeliveryLimit": 987,
"deliveryAsapEnabled": true,
"deliveryEnabled": false,
"driverOrderAssignments": [
UserDeliveringOrdersAssignmentType
],
"driverSmsText": "xyz789",
"dynamicTranslations": DynamicTranslationsTranslations,
"earlyDriverAssignment": false,
"eetCertificate": EETCertificate,
"employers": [User],
"enabled": false,
"foodMenuUrl": "xyz789",
"gpTomIntegrationAllowed": false,
"gps": GeoPoint,
"headerText": "abc123",
"homepageUrl": "abc123",
"id": 4,
"incomingStockTransfer": [StockTransfer],
"infoMessage": "abc123",
"internalNumber": "xyz789",
"isOpen": false,
"kitchenModuleEnabled": true,
"lastInvoiceSequence": 123,
"lastResettableInvoiceSequence": 987,
"maxCartSize": 123,
"mobileApplicationSetting": MobileApplicationSetting,
"name": "xyz789",
"occasions": [Occasion],
"oldOrderThreshold": 987,
"outcomingStockTransfer": [StockTransfer],
"overriddenDeliveryTime": OrderProcessTime,
"overriddenPickupTime": OrderProcessTime,
"paymentMethods": [PaymentMethodBranch],
"phone": "abc123",
"pickupAsapEnabled": false,
"pickupEnabled": true,
"pohodaEnabled": false,
"popUpMessage": "abc123",
"popUpMessageFromBranch": true,
"promoBanners": [PromoBanner],
"promoCodeLimit": 987,
"promoHeaderEnabled": false,
"promoHeaderText": "xyz789",
"promoHeaderTranslations": [PromoHeaderTranslation],
"settings": SettingCompanyBranch,
"shifts": [Shift],
"stockItemsCanBeNegative": true,
"styles": GraphicStyle,
"supportedLanguages": ["CS"],
"url": "abc123",
"urlPath": "xyz789",
"userAccountsEnabledForCustomer": false,
"wac": "xyz789",
"wareCategories": [WareCategory],
"wifiAppInstructions": [WiFiAppInstruction],
"willCloseAt": "2007-12-03T10:15:30Z",
"willOpenAt": "2007-12-03T10:15:30Z",
"zones": [Zone]
}
CompanyBranchPrinter
Description
Company branch printer
INDEX: [admin, branch_owner, brand_owner, cashier, cashier_isolated_print, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, cashier_isolated_print, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, cashier, super_admin, support]
DESTROY: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
companyBranch - CompanyBranch!
|
Company branch |
id - ID!
|
|
printer - Printer!
|
printer |
Example
{
"companyBranch": CompanyBranch,
"id": 4,
"printer": Printer
}
CompanyBranchSettingInterface
Fields
| Field Name | Description |
|---|---|
allowedCategories - [OrderStateCategoryEnum!]!
|
definition of allowed order state categories |
Arguments
|
|
businessHoursMidnight - Time!
|
|
deliveryAsapEnabled - Boolean
|
|
deliveryEnabled - Boolean!
|
possibility of delivering order |
driverOrderAssignments - [UserDeliveringOrdersAssignmentType!]!
|
|
driverSmsText - String
|
|
earlyDriverAssignment - Boolean!
|
Mark if branch allowing assign driver before order is ready to deliver |
foodMenuUrl - String
|
|
gpTomIntegrationAllowed - Boolean!
|
|
kitchenModuleEnabled - Boolean!
|
|
maxCartSize - Int!
|
maximal size of cart |
mobileApplicationSetting - MobileApplicationSetting
|
|
Arguments
|
|
oldOrderThreshold - Int!
|
how many hours it takes for order to be marked as old |
pickupAsapEnabled - Boolean
|
|
pickupEnabled - Boolean!
|
possibility of personal order pickup |
pohodaEnabled - Boolean!
|
|
promoCodeLimit - Int!
|
|
settings - SettingCompanyBranch!
|
|
urlPath - String!
|
|
Possible Types
| CompanyBranchSettingInterface Types |
|---|
Example
{
"allowedCategories": ["MAIN"],
"businessHoursMidnight": "10:15:30Z",
"deliveryAsapEnabled": true,
"deliveryEnabled": true,
"driverOrderAssignments": [
UserDeliveringOrdersAssignmentType
],
"driverSmsText": "xyz789",
"earlyDriverAssignment": true,
"foodMenuUrl": "abc123",
"gpTomIntegrationAllowed": false,
"kitchenModuleEnabled": true,
"maxCartSize": 987,
"mobileApplicationSetting": MobileApplicationSetting,
"oldOrderThreshold": 987,
"pickupAsapEnabled": true,
"pickupEnabled": false,
"pohodaEnabled": true,
"promoCodeLimit": 123,
"settings": SettingCompanyBranch,
"urlPath": "xyz789"
}
CompanyBranchUser
Description
Link between Company Branch and User
INDEX: [admin, branch_owner, brand_owner, driver, editor_company_branch_user, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, driver, editor_company_branch_user, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_company_branch_user, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_company_branch_user, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_company_branch_user, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
companyBranch - CompanyBranch!
|
|
deleted - Boolean!
|
user is no longer employed by company branch |
driverOrderAssignments - [UserDeliveringOrdersAssignmentType!]!
|
|
Arguments
|
|
driverSmsText - String
|
|
id - ID!
|
|
user - User!
|
|
Example
{
"companyBranch": CompanyBranch,
"deleted": true,
"driverOrderAssignments": [
UserDeliveringOrdersAssignmentType
],
"driverSmsText": "abc123",
"id": 4,
"user": User
}
CompanyBranchesLookUp
Fields
| Field Name | Description |
|---|---|
finalAddress - JsonAddress
|
|
finalAddressFormatted - String
|
|
gpsCoordinates - GeoPoint
|
|
isResolved - Boolean!
|
|
isValidAddress - Boolean!
|
|
resolvedBranches - [ResolvedCompanyBranch!]!
|
Example
{
"finalAddress": JsonAddress,
"finalAddressFormatted": "xyz789",
"gpsCoordinates": GeoPoint,
"isResolved": false,
"isValidAddress": true,
"resolvedBranches": [ResolvedCompanyBranch]
}
CompanyBrandLookUp
Fields
| Field Name | Description |
|---|---|
analyticsCodes - [AnalyticsCode!]!
|
|
brand - Company
|
|
companyBranch - CompanyBranch
|
|
companyBranches - [CompanyBranch!]!
|
|
googleAnalyticsCode - String
|
Use analyticsCodes instead. |
isBrandUrl - Boolean!
|
|
isBrandWac - Boolean!
|
Use isBrandUrl instead. |
isMobileApp - Boolean!
|
|
knownBasePath - String!
|
|
orderOrigin - OrderOriginEnum!
|
|
redirectUrl - String
|
|
sector - Sector
|
|
userDefaultLanguage - LanguageEnum!
|
Example
{
"analyticsCodes": [AnalyticsCode],
"brand": Company,
"companyBranch": CompanyBranch,
"companyBranches": [CompanyBranch],
"googleAnalyticsCode": "xyz789",
"isBrandUrl": true,
"isBrandWac": true,
"isMobileApp": false,
"knownBasePath": "xyz789",
"orderOrigin": "DAME_JIDLO",
"redirectUrl": "xyz789",
"sector": Sector,
"userDefaultLanguage": "CS"
}
CompanyType
Description
Possible CompanyType types
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - CompanyTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "CLIENT",
"id": 4,
"rawCode": "xyz789"
}
CompanyTypeEnum
Description
CompanyType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLIENT"
ConfirmationStatusSelectorEnum
Description
Allows to select a only records with a specified confirmation status.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CONFIRMED"
Consent
Description
Details about consent.
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
description - String!
|
Description of consent translated into request language. |
expiration - Int!
|
Value in seconds. Meaning: How long is consent active from users confirmation. |
id - ID!
|
Consent ID |
isMandatory - Boolean!
|
|
name - String!
|
Name of consent translated into request language. |
oneTime - Boolean!
|
Indicates if consent is active just for order processing. |
parent - Consent
|
|
type - ConsentsType!
|
Type of consent |
Example
{
"description": "xyz789",
"expiration": 987,
"id": 4,
"isMandatory": false,
"name": "abc123",
"oneTime": true,
"parent": Consent,
"type": ConsentsType
}
ConsentCompany
ConsentCustomer
Description
Information about customer consent association.
Fields
| Field Name | Description |
|---|---|
consent - Consent!
|
|
customer - Customer!
|
|
history - [ConsentCustomerHistory!]!
|
|
isActive - Boolean!
|
Example
{
"consent": Consent,
"customer": Customer,
"history": [ConsentCustomerHistory],
"isActive": false
}
ConsentCustomerHistory
Description
Historical activity of customers consent association.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
id - ID!
|
|
revokeType - ConsentsRevokeType
|
|
revokedAt - DateTime
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"revokeType": ConsentsRevokeType,
"revokedAt": "2007-12-03T10:15:30Z"
}
ConsentOrder
ConsentsRevokeType
Description
Possible ConsentsRevokeType types
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - ConsentsRevokeTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "ONE_TIME",
"id": 4,
"rawCode": "abc123"
}
ConsentsRevokeTypeEnum
Description
ConsentsRevokeType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ONE_TIME"
ConsentsType
Description
Possible ConsentsType types
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - ConsentsTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "TERMS_AND_CONDITIONS",
"id": 4,
"rawCode": "xyz789"
}
ConsentsTypeEnum
Description
ConsentsType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"TERMS_AND_CONDITIONS"
Country
Description
Holds information about a Country
INDEX: [admin, editor_country, editor_menu, guest, operator, super_admin, support, user]
READ: [admin, editor_country, editor_menu, guest, operator, super_admin, support, user]
CREATE: [admin, editor_country, super_admin, support]
UPDATE: [admin, editor_country, super_admin, support]
DESTROY: [admin, editor_country, super_admin]
Fields
| Field Name | Description |
|---|---|
cashPaymentDecimals - Int!
|
|
cashPaymentUnit - Float!
|
|
cashlessWalletLimit - Float
|
|
code - String!
|
|
countryVats - [Vat!]!
|
|
currency - Currency!
|
default currency for country |
enum - CountryEnum!
|
enum string used to identify object |
id - ID!
|
|
phonePrefix - String!
|
|
rawCode - String!
|
not localized code |
Example
{
"cashPaymentDecimals": 987,
"cashPaymentUnit": 123.45,
"cashlessWalletLimit": 123.45,
"code": "abc123",
"countryVats": [Vat],
"currency": Currency,
"enum": "RSA",
"id": "4",
"phonePrefix": "xyz789",
"rawCode": "xyz789"
}
CountryEnum
Description
Country enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RSA"
CreatedExternalOrderType
Description
Response for created order by external service
Fields
| Field Name | Description |
|---|---|
missingStockItems - [StockItem!]!
|
|
order - Order
|
|
userErrors - [String!]!
|
Example
{
"missingStockItems": [StockItem],
"order": Order,
"userErrors": ["abc123"]
}
CreditsCashlessGroupLimitsInterface
Fields
| Field Name | Description |
|---|---|
canTopUpMax - PriceConverted!
|
|
currentBalanceLimit - PriceConverted!
|
|
topUpLimit - PriceConverted!
|
Possible Types
| CreditsCashlessGroupLimitsInterface Types |
|---|
Example
{
"canTopUpMax": PriceConverted,
"currentBalanceLimit": PriceConverted,
"topUpLimit": PriceConverted
}
CreditsCashlessLimitsInterface
Fields
| Field Name | Description |
|---|---|
canTopUpMax - PriceConverted!
|
|
currentBalanceLimit - PriceConverted!
|
|
currentBalanceLimitLeft - PriceConverted!
|
|
currentBalanceLimitUsage - PriceConverted!
|
|
topUpLimit - PriceConverted!
|
|
topUpLimitLeft - PriceConverted!
|
|
topUpLimitUsage - PriceConverted!
|
Possible Types
| CreditsCashlessLimitsInterface Types |
|---|
Example
{
"canTopUpMax": PriceConverted,
"currentBalanceLimit": PriceConverted,
"currentBalanceLimitLeft": PriceConverted,
"currentBalanceLimitUsage": PriceConverted,
"topUpLimit": PriceConverted,
"topUpLimitLeft": PriceConverted,
"topUpLimitUsage": PriceConverted
}
CreditsCashlessWalletLookup
Fields
| Field Name | Description |
|---|---|
wallet - CreditsWallet
|
Example
{"wallet": CreditsWallet}
CreditsCurrencyInterface
Fields
| Field Name | Description |
|---|---|
cashPaymentDecimals - Int!
|
Alias of self.group.country.cashPaymentDecimals. |
cashPaymentUnit - Float!
|
Alias of self.group.country.cashPaymentUnit. |
currency - Currency!
|
|
group - CreditsGroup!
|
Possible Types
| CreditsCurrencyInterface Types |
|---|
Example
{
"cashPaymentDecimals": 123,
"cashPaymentUnit": 987.65,
"currency": Currency,
"group": CreditsGroup
}
CreditsGroup
Fields
| Field Name | Description |
|---|---|
allMemberships - [CreditsGroupMembership!]!
|
|
canTopUpMax - PriceConverted!
|
|
cashlessRefundFrom - DateTime
|
|
cashlessRefundTo - DateTime
|
|
closedAt - DateTime
|
|
company - Company
|
|
country - Country!
|
|
currentBalanceLimit - PriceConverted!
|
|
id - ID!
|
|
isCashlessRefundWindowOpen - Boolean!
|
|
isClosed - Boolean!
|
|
memberships - [CreditsGroupMembership!]!
|
|
name - String!
|
|
topUpLimit - PriceConverted!
|
Example
{
"allMemberships": [CreditsGroupMembership],
"canTopUpMax": PriceConverted,
"cashlessRefundFrom": "2007-12-03T10:15:30Z",
"cashlessRefundTo": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"company": Company,
"country": Country,
"currentBalanceLimit": PriceConverted,
"id": "4",
"isCashlessRefundWindowOpen": true,
"isClosed": false,
"memberships": [CreditsGroupMembership],
"name": "abc123",
"topUpLimit": PriceConverted
}
CreditsGroupMembership
Fields
| Field Name | Description |
|---|---|
canCollect - Boolean!
|
|
canSpend - Boolean!
|
|
closedAt - DateTime
|
|
companyBranch - CompanyBranch!
|
|
group - CreditsGroup!
|
|
id - ID!
|
|
isClosed - Boolean!
|
Example
{
"canCollect": false,
"canSpend": true,
"closedAt": "2007-12-03T10:15:30Z",
"companyBranch": CompanyBranch,
"group": CreditsGroup,
"id": "4",
"isClosed": false
}
CreditsOverviewInterface
Fields
| Field Name | Description |
|---|---|
creditsExpiringSoon - CreditsWalletActivityConnection
|
|
Arguments
|
|
creditsPendingRewards - CreditsRewardConnection!
|
|
Arguments
|
|
creditsRewards - CreditsRewardConnection!
|
|
Arguments
|
|
creditsWalletActivities - CreditsWalletActivityConnection!
|
|
Arguments
|
|
Possible Types
| CreditsOverviewInterface Types |
|---|
Example
{
"creditsExpiringSoon": CreditsWalletActivityConnection,
"creditsPendingRewards": CreditsRewardConnection,
"creditsRewards": CreditsRewardConnection,
"creditsWalletActivities": CreditsWalletActivityConnection
}
CreditsPendingWalletPayment
Description
Pending wallet credit payments
Fields
| Field Name | Description |
|---|---|
amount - PriceConverted!
|
|
resolvedAt - DateTime!
|
|
unpaid - PriceConverted!
|
Example
{
"amount": PriceConverted,
"resolvedAt": "2007-12-03T10:15:30Z",
"unpaid": PriceConverted
}
CreditsPriceConverted
CreditsRefundRequest
Fields
| Field Name | Description |
|---|---|
accountNumber - String!
|
|
amount - PriceConverted!
|
|
email - String!
|
|
id - ID!
|
|
requestedAt - DateTime!
|
Example
{
"accountNumber": "xyz789",
"amount": PriceConverted,
"email": "abc123",
"id": "4",
"requestedAt": "2007-12-03T10:15:30Z"
}
CreditsReward
Fields
| Field Name | Description |
|---|---|
amount - CreditsPriceConverted!
|
|
cashPaymentDecimals - Int!
|
Alias of self.group.country.cashPaymentDecimals. |
cashPaymentUnit - Float!
|
Alias of self.group.country.cashPaymentUnit. |
createdAt - DateTime
|
|
currency - Currency!
|
|
group - CreditsGroup!
|
|
id - ID
|
|
order - Order!
|
|
state - CreditsRewardState!
|
Example
{
"amount": CreditsPriceConverted,
"cashPaymentDecimals": 123,
"cashPaymentUnit": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"currency": Currency,
"group": CreditsGroup,
"id": "4",
"order": Order,
"state": CreditsRewardState
}
CreditsRewardConnection
Description
The connection type for CreditsReward.
Fields
| Field Name | Description |
|---|---|
edges - [CreditsRewardEdge]
|
A list of edges. |
nodes - [CreditsReward]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [CreditsRewardEdge],
"nodes": [CreditsReward],
"pageInfo": PageInfo,
"totalCount": 987
}
CreditsRewardEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - CreditsReward
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": CreditsReward
}
CreditsRewardState
Description
Possible CreditsRewardState types
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - CreditsRewardStateEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "POTENTIAL",
"id": 4,
"rawCode": "abc123"
}
CreditsRewardStateEnum
Description
CreditsRewardState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"POTENTIAL"
CreditsWallet
Fields
| Field Name | Description |
|---|---|
balance - CreditsPriceConverted!
|
|
canTopUpMax - PriceConverted!
|
|
cashPaymentDecimals - Int!
|
Alias of self.group.country.cashPaymentDecimals. |
cashPaymentUnit - Float!
|
Alias of self.group.country.cashPaymentUnit. |
closedAt - DateTime
|
|
companyBranches - [CompanyBranch!]!
|
|
creditsExpiringSoon - CreditsWalletActivityConnection
|
|
Arguments
|
|
creditsPendingRewards - CreditsRewardConnection!
|
|
Arguments
|
|
creditsRewards - CreditsRewardConnection!
|
|
Arguments
|
|
creditsWalletActivities - CreditsWalletActivityConnection!
|
|
Arguments
|
|
currency - Currency!
|
|
currentBalanceLimit - PriceConverted!
|
|
currentBalanceLimitLeft - PriceConverted!
|
|
currentBalanceLimitUsage - PriceConverted!
|
|
group - CreditsGroup!
|
|
id - ID!
|
|
isClosed - Boolean!
|
|
name - String!
|
|
nfcId - String
|
|
refundRequest - CreditsRefundRequest
|
|
topUpLimit - PriceConverted!
|
|
topUpLimitLeft - PriceConverted!
|
|
topUpLimitUsage - PriceConverted!
|
|
Example
{
"balance": CreditsPriceConverted,
"canTopUpMax": PriceConverted,
"cashPaymentDecimals": 987,
"cashPaymentUnit": 123.45,
"closedAt": "2007-12-03T10:15:30Z",
"companyBranches": [CompanyBranch],
"creditsExpiringSoon": CreditsWalletActivityConnection,
"creditsPendingRewards": CreditsRewardConnection,
"creditsRewards": CreditsRewardConnection,
"creditsWalletActivities": CreditsWalletActivityConnection,
"currency": Currency,
"currentBalanceLimit": PriceConverted,
"currentBalanceLimitLeft": PriceConverted,
"currentBalanceLimitUsage": PriceConverted,
"group": CreditsGroup,
"id": 4,
"isClosed": true,
"name": "abc123",
"nfcId": "abc123",
"refundRequest": CreditsRefundRequest,
"topUpLimit": PriceConverted,
"topUpLimitLeft": PriceConverted,
"topUpLimitUsage": PriceConverted
}
CreditsWalletActivity
Fields
| Field Name | Description |
|---|---|
activityType - CreditsWalletActivityType!
|
|
amount - CreditsPriceConverted!
|
|
cashPaymentDecimals - Int!
|
Alias of self.group.country.cashPaymentDecimals. |
cashPaymentUnit - Float!
|
Alias of self.group.country.cashPaymentUnit. |
companyBranch - CompanyBranch!
|
|
createdAt - DateTime!
|
|
currency - Currency!
|
|
expiresAt - DateTime
|
|
group - CreditsGroup!
|
|
id - ID!
|
|
isExpired - Boolean!
|
|
isExpiringSoon - Boolean!
|
|
order - Order
|
|
remainingAmount - CreditsPriceConverted!
|
|
wallet - CreditsWallet!
|
Example
{
"activityType": CreditsWalletActivityType,
"amount": CreditsPriceConverted,
"cashPaymentDecimals": 987,
"cashPaymentUnit": 987.65,
"companyBranch": CompanyBranch,
"createdAt": "2007-12-03T10:15:30Z",
"currency": Currency,
"expiresAt": "2007-12-03T10:15:30Z",
"group": CreditsGroup,
"id": 4,
"isExpired": false,
"isExpiringSoon": true,
"order": Order,
"remainingAmount": CreditsPriceConverted,
"wallet": CreditsWallet
}
CreditsWalletActivityConnection
Description
The connection type for CreditsWalletActivity.
Fields
| Field Name | Description |
|---|---|
edges - [CreditsWalletActivityEdge]
|
A list of edges. |
nodes - [CreditsWalletActivity]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [CreditsWalletActivityEdge],
"nodes": [CreditsWalletActivity],
"pageInfo": PageInfo,
"totalCount": 123
}
CreditsWalletActivityEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - CreditsWalletActivity
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": CreditsWalletActivity
}
CreditsWalletActivityType
Description
Possible CreditsWalletActivityType types
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - CreditsWalletActivityTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "ORDER_REWARD",
"id": "4",
"rawCode": "abc123"
}
CreditsWalletActivityTypeEnum
Description
CreditsWalletActivityType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ORDER_REWARD"
Currency
Description
Currency type schema
INDEX: [admin, editor_currency, guest, super_admin, support, user]
READ: [admin, editor_currency, guest, super_admin, support, user]
CREATE: [admin, editor_currency, super_admin, support]
UPDATE: [admin, editor_currency, super_admin, support]
DESTROY: [admin, editor_currency, super_admin]
Example
{
"code": "xyz789",
"decimalRound": 123,
"enum": "CZK",
"exchangeRate": 987.65,
"id": 4,
"rawCode": "abc123"
}
CurrencyEnum
Description
Currency enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CZK"
Customer
Description
Holds information about Customer
Fields
| Field Name | Description |
|---|---|
company - Company!
|
|
customerConsents - [ConsentCustomer!]!
|
|
email - String!
|
|
firstName - String!
|
|
id - ID!
|
|
isCustomerRegistered - Boolean!
|
|
lastName - String!
|
|
orders - [Order!]!
|
|
Arguments |
|
phone - String!
|
|
Arguments
|
|
Example
{
"company": Company,
"customerConsents": [ConsentCustomer],
"email": "xyz789",
"firstName": "xyz789",
"id": "4",
"isCustomerRegistered": false,
"lastName": "xyz789",
"orders": [Order],
"phone": "abc123"
}
Date
Description
Date in format YYYY-MM-DD
Example
"2007-12-03"
DateTime
Description
Date in format iso 8601 format
Example
"2007-12-03T10:15:30Z"
DateTimeWrapped
Description
Wrapper for DateTime scalar type. Used in union types.
Fields
| Field Name | Description |
|---|---|
value - DateTime!
|
Example
{"value": "2007-12-03T10:15:30Z"}
DeliverySlot
Description
Schema of a DeliverySlot
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
capacity - Int!
|
|
capacityTaken - Int!
|
|
companyBranch - CompanyBranch!
|
|
deliveryType - DeliveryType!
|
|
endAt - DateTime!
|
|
id - ID!
|
|
isFull - Boolean!
|
|
startAt - DateTime!
|
|
userEdited - Boolean!
|
Example
{
"capacity": 987,
"capacityTaken": 987,
"companyBranch": CompanyBranch,
"deliveryType": DeliveryType,
"endAt": "2007-12-03T10:15:30Z",
"id": 4,
"isFull": true,
"startAt": "2007-12-03T10:15:30Z",
"userEdited": false
}
DeliverySlotElement
Description
Schema of a DeliverySlotElement
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
capacityTaken - Int!
|
|
companyBranch - CompanyBranch!
|
|
deliverySlot - DeliverySlot
|
|
deliveryType - DeliveryType!
|
|
id - ID!
|
|
startAt - DateTime!
|
Example
{
"capacityTaken": 123,
"companyBranch": CompanyBranch,
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"id": "4",
"startAt": "2007-12-03T10:15:30Z"
}
DeliveryStateEnum
Description
DeliveryState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FRESH"
DeliveryStateHistorical
Description
History of delivery state assignments taken from events.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
deliveryState - DeliveryStateEnum!
|
|
user - User!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"deliveryState": "FRESH",
"user": User
}
DeliveryType
Description
Possible DeliveryType types
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - DeliveryTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "PICKUP",
"id": 4,
"rawCode": "abc123"
}
DeliveryTypeEnum
Description
DeliveryType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PICKUP"
DeviceState
Description
Possible DeviceState types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - DeviceStateEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "WORKING",
"id": "4",
"rawCode": "abc123"
}
DeviceStateEnum
Description
DeviceState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"WORKING"
DeviceType
Description
Possible DeviceType types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - DeviceTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "CAR",
"id": "4",
"rawCode": "xyz789"
}
DeviceTypeEnum
Description
DeviceType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CAR"
DotykackaSetting
DriverInterface
Fields
| Field Name | Description |
|---|---|
countUndeliveredOrders - Int!
|
|
transportationDeviceUsers - [TransportationDeviceUser!]!
|
|
usedTransportationDevice - TransportationDeviceUser
|
|
userDeliveringOrders - [UserDeliveringOrder!]!
|
|
Arguments
|
|
Possible Types
| DriverInterface Types |
|---|
Example
{
"countUndeliveredOrders": 987,
"transportationDeviceUsers": [TransportationDeviceUser],
"usedTransportationDevice": TransportationDeviceUser,
"userDeliveringOrders": [UserDeliveringOrder]
}
DynamicTranslationsDeliveryTypeEnum
Description
Possible translation variants for delivery type text.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IN"
DynamicTranslationsOrderDeliveryTime
Description
Specifies the variant of translations related to order delivery time to be used.
Fields
| Field Name | Description |
|---|---|
deliveryType - DynamicTranslationsDeliveryTypeEnum
|
delivery_type_doc |
Example
{"deliveryType": "IN"}
DynamicTranslationsTranslations
Description
Specifies the variant of translations to be used.
Fields
| Field Name | Description |
|---|---|
orderDeliveryTime - DynamicTranslationsOrderDeliveryTime
|
Example
{
"orderDeliveryTime": DynamicTranslationsOrderDeliveryTime
}
EETCertificate
Description
EET certificate informations
INDEX: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Example
{
"mode": "abc123",
"passphrase": "abc123",
"placeId": 123,
"privateKey": "xyz789",
"rootCertificate": "abc123"
}
EETType
Description
EET receipt
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Example
{
"bkp": "xyz789",
"fik": "abc123",
"mode": "abc123",
"pkp": "abc123",
"placeId": "abc123",
"receiptId": "xyz789",
"warnings": ["xyz789"]
}
ExternalDelivery
Description
Status of external delivery request
INDEX: [admin, request_external_driver, super_admin, support]
READ: [admin, request_external_driver, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
errorMessage - String
|
|
externalDeliveryProvider - ExternalDeliveryProvider!
|
|
externalDeliveryState - ExternalDeliveryState!
|
|
externalIdentifier - String
|
|
id - ID!
|
|
order - Order!
|
|
orderNumber - String
|
|
seen - Boolean!
|
Example
{
"errorMessage": "xyz789",
"externalDeliveryProvider": ExternalDeliveryProvider,
"externalDeliveryState": ExternalDeliveryState,
"externalIdentifier": "xyz789",
"id": 4,
"order": Order,
"orderNumber": "abc123",
"seen": false
}
ExternalDeliveryProvider
Description
Possible ExternalDeliveryProvider types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - ExternalDeliveryProviderEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "WOLT",
"id": "4",
"rawCode": "xyz789"
}
ExternalDeliveryProviderEnum
Description
ExternalDeliveryProvider enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"WOLT"
ExternalDeliveryState
Description
Possible ExternalDeliveryState types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - ExternalDeliveryStateEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "REQUESTED",
"id": 4,
"rawCode": "xyz789"
}
ExternalDeliveryStateEnum
Description
ExternalDeliveryState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"REQUESTED"
ExternalDeliveryUpdateSubscription
Description
Subscription of external deliveries statuses
Fields
| Field Name | Description |
|---|---|
actionType - SubscriptionActionType!
|
|
externalDelivery - ExternalDelivery
|
|
id - ID!
|
Example
{
"actionType": "CREATE",
"externalDelivery": ExternalDelivery,
"id": "4"
}
ExtraFee
Description
ExtraFee graphql model
Fields
| Field Name | Description |
|---|---|
code - ExtraFeeType!
|
|
name - String!
|
|
price - PriceConverted!
|
Example
{
"code": "DAME_JIDLO_FEE",
"name": "xyz789",
"price": PriceConverted
}
ExtraFeeType
Description
Possible extra fees
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DAME_JIDLO_FEE"
FieldStateEnum
Description
FieldState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DEFAULT"
FinishedOrder
Example
{
"csobUrl": "abc123",
"gopayUrl": "abc123",
"gpWebpayUrl": "xyz789",
"order": Order,
"payFastUrl": "xyz789",
"payuUrl": "xyz789",
"userErrors": ["xyz789"]
}
FlagAttributesInterface
Fields
| Field Name | Description |
|---|---|
isAnonymous - Boolean!
|
was it non registered user who made order |
isCancelable - Boolean!
|
can user cancel current order |
isFinalized - Boolean!
|
is current order finalized |
isPartiallyFinalized - Boolean!
|
is current order partially finalized |
isPriority - Boolean!
|
is current order marked as high priority |
Possible Types
| FlagAttributesInterface Types |
|---|
Example
{
"isAnonymous": false,
"isCancelable": false,
"isFinalized": true,
"isPartiallyFinalized": false,
"isPriority": false
}
Float
Description
Represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
GeoPoint
GeoPositionWithTimestamp
GraphicStyle
Example
{
"active": "abc123",
"applicationStyles": "abc123",
"backgroundCart": "abc123",
"headerImage": "abc123",
"main": "abc123",
"mainSecondary": "abc123",
"owner": true,
"screensaver": "abc123",
"storeLogo": "abc123",
"storeLogoMobile": "xyz789"
}
Greeting
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
GreetingsFormalityArgumentGlEnum
Description
Formality of the greeting.
Values
| Enum Value | Description |
|---|---|
|
|
Formal style. |
|
|
Informal style. |
|
|
Random style, either formal or informal. |
Example
"FORMAL"
GreetingsInputArgumentsRead
Fields
| Input Field | Description |
|---|---|
time - GreetingsTimeArgumentGlEnum
|
|
formality - GreetingsFormalityArgumentGlEnum
|
Example
{"time": "TIME_BASED", "formality": "FORMAL"}
GreetingsTimeArgumentGlEnum
Description
Whether the greeting should be time-based.
Values
| Enum Value | Description |
|---|---|
|
|
A greeting based on current time of day. |
|
|
A generic greeting. |
|
|
Random greeting, either generic or based on current time of day. |
Example
"TIME_BASED"
Group
Description
Group (workplace) for recipes
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Example
{
"code": "abc123",
"id": "4",
"label": "abc123"
}
GroupedRecipe
ID
Description
Represents a unique identifier that is Base64 obfuscated. It is 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 "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ImportedOrder
Description
Brief information about imported order
Example
{
"error": "abc123",
"id": 4,
"invoiceSequenceCashBox": 123,
"success": false
}
InAppNotification
Description
InAppNotification
Example
{
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"isRead": true,
"readAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"url": "abc123"
}
InAppNotificationConnection
Description
The connection type for InAppNotification.
Fields
| Field Name | Description |
|---|---|
edges - [InAppNotificationEdge]
|
A list of edges. |
nodes - [InAppNotification]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [InAppNotificationEdge],
"nodes": [InAppNotification],
"pageInfo": PageInfo,
"totalCount": 987
}
InAppNotificationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - InAppNotification
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": InAppNotification
}
Ingredient
Description
Holds information about recipe/ware ingredients
INDEX: [admin, branch_owner, brand_owner, editor_ingredient, editor_menu, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, editor_ingredient, editor_menu, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_ingredient, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_ingredient, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_ingredient, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
quantity - Float!
|
|
recipe - Recipe!
|
|
stockItem - StockItem!
|
Example
{
"id": 4,
"quantity": 123.45,
"recipe": Recipe,
"stockItem": StockItem
}
InputBoardTemplateFeaturesIndex
InputConsentOrderCreate
InputCurrencyCreate
Fields
| Input Field | Description |
|---|---|
value - Float!
|
|
currency - CurrencyEnum
|
Example
{"value": 987.65, "currency": "CZK"}
InputCustomerCreate
Fields
| Input Field | Description |
|---|---|
firstName - String
|
|
lastName - String
|
|
emails - [InputEmailCreate!]
|
|
phones - [InputPhoneCreate!]
|
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"emails": [InputEmailCreate],
"phones": [InputPhoneCreate]
}
InputEmailCreate
InputExternalOrderCreate
Fields
| Input Field | Description |
|---|---|
companyBranch - ID!
|
|
orderOrigin - OrderOriginEnum!
|
|
deliverAt - DateTime!
|
|
gps - InputGeoPointCreate
|
|
address - String
|
|
warePriceType - WarePriceTypeEnum
|
|
deliveryType - DeliveryTypeEnum
|
|
orderRecipes - [InputOrderRecipeCreates!]
|
|
customer - InputCustomerCreate
|
|
note - String
|
|
cancelUnpaid - Boolean
|
Example
{
"companyBranch": 4,
"orderOrigin": "DAME_JIDLO",
"deliverAt": "2007-12-03T10:15:30Z",
"gps": InputGeoPointCreate,
"address": "abc123",
"warePriceType": "DELIVERY",
"deliveryType": "PICKUP",
"orderRecipes": [InputOrderRecipeCreates],
"customer": InputCustomerCreate,
"note": "abc123",
"cancelUnpaid": false
}
InputGeoPointCreate
InputLocationCreate
Fields
| Input Field | Description |
|---|---|
tableNumber - Int
|
Example
{"tableNumber": 123}
InputLocationIndex
Fields
| Input Field | Description |
|---|---|
tableNumber - Int
|
Example
{"tableNumber": 987}
InputNotificationCreate
InputOrderCreate
Fields
| Input Field | Description |
|---|---|
companyBranch - ID!
|
|
orderOrigin - OrderOriginEnum!
|
|
warePriceType - WarePriceTypeEnum!
|
|
deliveryType - DeliveryTypeEnum
|
|
language - LanguageEnum
|
|
customer - InputCustomerCreate!
|
|
gps - InputGeoPointCreate
|
Optional for INHOUSE-PICKUP order and for MESSENGER delivering orders associated with Sector, which has defines its GPS. |
address - String
|
Argument is not required for STAFF orders. Also we try to reverse geocode GPS to address, thus argument may be blank. |
resolvedAddress - InputOrderResolvedAddressType
|
|
notification - InputNotificationCreate
|
|
note - String
|
|
deliverAt - DateTime
|
|
location - InputLocationCreate
|
|
callEventId - ID
|
|
sector - ID
|
|
occasion - ID
|
|
deliverySlot - ID
|
|
cashBox - ID
|
Example
{
"companyBranch": 4,
"orderOrigin": "DAME_JIDLO",
"warePriceType": "DELIVERY",
"deliveryType": "PICKUP",
"language": "CS",
"customer": InputCustomerCreate,
"gps": InputGeoPointCreate,
"address": "xyz789",
"resolvedAddress": InputOrderResolvedAddressType,
"notification": InputNotificationCreate,
"note": "xyz789",
"deliverAt": "2007-12-03T10:15:30Z",
"location": InputLocationCreate,
"callEventId": 4,
"sector": "4",
"occasion": "4",
"deliverySlot": 4,
"cashBox": "4"
}
InputOrderDeliveryCreate
Fields
| Input Field | Description |
|---|---|
companyBranch - ID
|
|
brand - ID
|
|
orderOrigin - OrderOriginEnum!
|
|
gps - InputGeoPointCreate!
|
|
deliveryType - DeliveryTypeEnum
|
|
address - String
|
|
deliverySlot - ID
|
Example
{
"companyBranch": 4,
"brand": "4",
"orderOrigin": "DAME_JIDLO",
"gps": InputGeoPointCreate,
"deliveryType": "PICKUP",
"address": "xyz789",
"deliverySlot": 4
}
InputOrderFinish
Fields
| Input Field | Description |
|---|---|
customer - InputCustomerCreate
|
|
paymentMethod - PaymentTypeEnum
|
payment type used to finalize order |
paymentGate - PaymentGateEnum
|
payment gate used to finalize order |
paymentMethodId - ID
|
id of payment method used to finalize order |
deliverAt - DateTime
|
Preferred time of order delivery. In case that argument is null, deliver_at value is computed based on branch opening hours and default delivery times |
note - String
|
|
confirmedAgreements - [ID!]
|
|
tips - Float
|
percentage value of tips |
returnUrl - String
|
The absolute URL to check payment status within the application. Using a relative URL appended to the HTTP referer is deprecated. |
cancelUrl - String
|
|
deliverySlot - ID
|
Example
{
"customer": InputCustomerCreate,
"paymentMethod": "CASH",
"paymentGate": "GOPAY",
"paymentMethodId": 4,
"deliverAt": "2007-12-03T10:15:30Z",
"note": "xyz789",
"confirmedAgreements": ["4"],
"tips": 123.45,
"returnUrl": "abc123",
"cancelUrl": "xyz789",
"deliverySlot": "4"
}
InputOrderIndex
Fields
| Input Field | Description |
|---|---|
companyBranches - [ID!]
|
|
user - ID
|
|
orderStatesAND - [OrderStateEnum!]
|
|
orderStatesOR - [OrderStateEnum!]
|
|
orderStateCategoriesOR - [OrderStateCategoryEnum!]
|
|
orderStateCategoryTarget - OrderStateCategoryTargetEnum
|
|
currency - CurrencyEnum
|
|
location - InputLocationIndex
|
|
stateChangeSince - DateTime
|
Return only records changed after argument value. |
includeOldFinished - Boolean
|
|
sectors - [ID!]
|
|
sectorsWithChildren - Boolean
|
|
occasions - [ID!]
|
|
groups - [ID!]
|
Example
{
"companyBranches": ["4"],
"user": "4",
"orderStatesAND": ["IN_CART"],
"orderStatesOR": ["IN_CART"],
"orderStateCategoriesOR": ["MAIN"],
"orderStateCategoryTarget": "BACKEND",
"currency": "CZK",
"location": InputLocationIndex,
"stateChangeSince": "2007-12-03T10:15:30Z",
"includeOldFinished": false,
"sectors": ["4"],
"sectorsWithChildren": true,
"occasions": [4],
"groups": ["4"]
}
InputOrderPaymentMethodsCreate
Fields
| Input Field | Description |
|---|---|
paymentType - PaymentTypeEnum!
|
|
paymentGate - PaymentGateEnum!
|
|
price - InputCurrencyCreate!
|
Example
{
"paymentType": "CASH",
"paymentGate": "GOPAY",
"price": InputCurrencyCreate
}
InputOrderPickupCreate
Fields
| Input Field | Description |
|---|---|
companyBranch - ID!
|
|
orderOrigin - OrderOriginEnum!
|
|
deliverySlot - ID
|
Example
{
"companyBranch": 4,
"orderOrigin": "DAME_JIDLO",
"deliverySlot": "4"
}
InputOrderRatingCreate
Fields
| Input Field | Description |
|---|---|
orderRatingType - OrderRatingTypeEnum!
|
|
text - String
|
|
value - Int
|
Example
{
"orderRatingType": "RATING",
"text": "abc123",
"value": 987
}
InputOrderRecipeCreate
Fields
| Input Field | Description |
|---|---|
order - ID!
|
|
recipe - ID!
|
|
orderRecipeState - OrderRecipeStateEnum
|
|
parent - ID
|
|
sideDishes - [ID!]
|
|
sideDishRecipes - [InputOrderRecipeSideDishCreate!]
|
|
associatedRecipes - [ID!]
|
|
amount - Int
|
|
note - String
|
|
wareCategory - ID
|
|
promoTag - PromoTagEnum
|
|
dynamicPrice - InputCurrencyCreate
|
Example
{
"order": "4",
"recipe": 4,
"orderRecipeState": "FRESH",
"parent": 4,
"sideDishes": [4],
"sideDishRecipes": [InputOrderRecipeSideDishCreate],
"associatedRecipes": ["4"],
"amount": 123,
"note": "xyz789",
"wareCategory": "4",
"promoTag": "PROMO_CART",
"dynamicPrice": InputCurrencyCreate
}
InputOrderRecipeCreates
Example
{
"recipe": "4",
"sideDishes": [4],
"sideDishRecipes": [InputOrderRecipeSideDishCreate],
"associatedRecipes": ["4"],
"amount": 123,
"note": "xyz789"
}
InputOrderRecipeSideDishCreate
InputOrderRecipeSideDishUpdate
InputOrderRecipeUpdate
Fields
| Input Field | Description |
|---|---|
order - ID
|
|
recipe - ID
|
|
orderRecipeState - OrderRecipeStateEnum
|
|
parent - ID
|
|
sideDishes - [ID!]
|
|
sideDishRecipes - [InputOrderRecipeSideDishUpdate!]
|
|
note - String
|
|
dynamicPrice - InputCurrencyCreate
|
Example
{
"order": 4,
"recipe": "4",
"orderRecipeState": "FRESH",
"parent": 4,
"sideDishes": ["4"],
"sideDishRecipes": [InputOrderRecipeSideDishUpdate],
"note": "abc123",
"dynamicPrice": InputCurrencyCreate
}
InputOrderResolvedAddressType
Example
{
"street": "xyz789",
"city": "xyz789",
"country": "abc123",
"houseNumber": "abc123",
"postCode": "abc123",
"state": "xyz789",
"venue": "xyz789"
}
InputOrderStaffImport
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
warePriceType - WarePriceTypeEnum!
|
|
companyBranch - ID!
|
|
acceptedAt - DateTime
|
|
acceptedAtRaw - String
|
|
orderRecipes - [InputOrderRecipeCreates!]!
|
|
deliveryType - DeliveryTypeEnum
|
|
invoice - String!
|
|
invoiceNumber - Int!
|
|
paymentMethods - [InputOrderPaymentMethodsCreate!]!
|
|
canceled - Boolean
|
|
sector - ID
|
|
recipePrices - [InputRecipePriceCashBox!]
|
|
totalDiscount - InputCurrencyCreate
|
|
forceFinish - Boolean
|
|
fik - String
|
Example
{
"id": 4,
"warePriceType": "DELIVERY",
"companyBranch": 4,
"acceptedAt": "2007-12-03T10:15:30Z",
"acceptedAtRaw": "xyz789",
"orderRecipes": [InputOrderRecipeCreates],
"deliveryType": "PICKUP",
"invoice": "abc123",
"invoiceNumber": 987,
"paymentMethods": [InputOrderPaymentMethodsCreate],
"canceled": false,
"sector": 4,
"recipePrices": [InputRecipePriceCashBox],
"totalDiscount": InputCurrencyCreate,
"forceFinish": false,
"fik": "xyz789"
}
InputOrderStaffPosCreate
Fields
| Input Field | Description |
|---|---|
companyBranch - ID!
|
|
warePriceType - WarePriceTypeEnum!
|
|
deliveryType - DeliveryTypeEnum
|
|
language - LanguageEnum
|
|
customer - InputCustomerCreate!
|
|
gps - InputGeoPointCreate
|
Optional for INHOUSE-PICKUP order and for MESSENGER delivering orders associateg with Sector, which has defines its GPS. |
address - String
|
Argument is not reguired for STAFF orders. Also we try to reverse geocode GPS to address, thus argument may be blank. |
notification - InputNotificationCreate
|
|
note - String
|
|
deliverAt - DateTime
|
|
location - InputLocationCreate
|
|
callEventId - ID
|
|
sector - ID
|
|
occasion - ID
|
|
deliverySlot - ID
|
Example
{
"companyBranch": "4",
"warePriceType": "DELIVERY",
"deliveryType": "PICKUP",
"language": "CS",
"customer": InputCustomerCreate,
"gps": InputGeoPointCreate,
"address": "xyz789",
"notification": InputNotificationCreate,
"note": "abc123",
"deliverAt": "2007-12-03T10:15:30Z",
"location": InputLocationCreate,
"callEventId": 4,
"sector": "4",
"occasion": 4,
"deliverySlot": 4
}
InputOrderTipUpdate
InputOrderUpdate
Fields
| Input Field | Description |
|---|---|
companyBranch - ID
|
|
deliveryType - DeliveryTypeEnum
|
|
language - LanguageEnum
|
|
customer - InputCustomerCreate
|
|
gps - InputGeoPointCreate
|
|
address - String
|
|
resolvedAddress - InputOrderResolvedAddressType
|
|
notification - InputNotificationCreate
|
|
note - String
|
|
deliverAt - DateTime
|
|
location - InputLocationCreate
|
|
warePriceType - WarePriceTypeEnum
|
|
tips - Float
|
percentage value of tips |
orderGroup - ID
|
|
deliverySlot - ID
|
Example
{
"companyBranch": 4,
"deliveryType": "PICKUP",
"language": "CS",
"customer": InputCustomerCreate,
"gps": InputGeoPointCreate,
"address": "abc123",
"resolvedAddress": InputOrderResolvedAddressType,
"notification": InputNotificationCreate,
"note": "abc123",
"deliverAt": "2007-12-03T10:15:30Z",
"location": InputLocationCreate,
"warePriceType": "DELIVERY",
"tips": 987.65,
"orderGroup": "4",
"deliverySlot": "4"
}
InputOrderWifiCreate
Fields
| Input Field | Description |
|---|---|
companyBranch - ID!
|
|
orderOrigin - OrderOriginEnum!
|
|
warePriceType - WarePriceTypeEnum!
|
|
deliveryType - DeliveryTypeEnum
|
|
sector - ID
|
|
occasion - ID
|
Example
{
"companyBranch": 4,
"orderOrigin": "DAME_JIDLO",
"warePriceType": "DELIVERY",
"deliveryType": "PICKUP",
"sector": "4",
"occasion": 4
}
InputPaginationParams
InputPaymentMethodIndex
Fields
| Input Field | Description |
|---|---|
companyBranch - ID!
|
|
orderOrigin - OrderOriginEnum!
|
|
warePriceType - WarePriceTypeEnum!
|
|
paymentType - PaymentTypeEnum!
|
|
paymentGate - PaymentGateEnum!
|
|
enabled - Boolean
|
Example
{
"companyBranch": "4",
"orderOrigin": "DAME_JIDLO",
"warePriceType": "DELIVERY",
"paymentType": "CASH",
"paymentGate": "GOPAY",
"enabled": true
}
InputPhoneCreate
InputRecipeFilterType
Description
These arguments are used to filter ware categories based on their suitability for recipes.
Fields
| Input Field | Description |
|---|---|
isAvailable - Boolean
|
|
isAvailableAt - DateTime
|
|
orderOriginCategory - OrderOriginCategoryEnum
|
OrderOriginCategory which has to be enabled. Use only with isAvailable argument. Ignored if argument is used in resolver call, cause it has higher priority. |
enabled - Boolean
|
Example
{
"isAvailable": false,
"isAvailableAt": "2007-12-03T10:15:30Z",
"orderOriginCategory": "DOVEZE",
"enabled": true
}
InputRecipePriceCashBox
Fields
| Input Field | Description |
|---|---|
recipe - ID!
|
|
price - InputCurrencyCreate!
|
Example
{"recipe": 4, "price": InputCurrencyCreate}
InputRefundRequestType
Example
{
"accountNumber": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"accountHolder": "xyz789",
"phone": "xyz789",
"email": "abc123",
"consentIds": ["4"]
}
InputUserRegisteredCreate
Fields
| Input Field | Description |
|---|---|
token - String!
|
|
email - String!
|
|
returnUrl - String!
|
The absolute URL that the User will visit to confirm the provided email or a relative URL that will be appended to an absolute URL taken from the HTTP referer. |
password - String!
|
|
language - LanguageEnum!
|
Example
{
"token": "xyz789",
"email": "abc123",
"returnUrl": "abc123",
"password": "xyz789",
"language": "CS"
}
InputVamStatus
Int
Description
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
InvoiceSequenceInterface
Possible Types
| InvoiceSequenceInterface Types |
|---|
Example
{"lastInvoiceSequence": 987, "lastResettableInvoiceSequence": 123}
InvoiceSequencesInterface
Fields
| Field Name | Description |
|---|---|
invoiceSequence - String
|
invoice sequence of company branch |
invoiceSequenceCashBox - Int
|
invoice sequence of cash_box |
invoiceSequenceResettable - Int
|
resettable invoice sequence of company branch, e.g. queue number |
Possible Types
| InvoiceSequencesInterface Types |
|---|
Example
{
"invoiceSequence": "xyz789",
"invoiceSequenceCashBox": 123,
"invoiceSequenceResettable": 987
}
Json
Description
Data in json format
Example
Json
JsonAddress
Description
Address data such as city, street, etc. Often obtained automatically with inconsistent information.
Example
{
"city": "xyz789",
"country": "abc123",
"gps": GeoPoint,
"houseNumber": "xyz789",
"original": "xyz789",
"postCode": "abc123",
"state": "xyz789",
"street": "xyz789",
"venue": "xyz789"
}
JsonCustomer
Description
Possible information for anonymous user that made order
Example
{
"defaultEmail": Email,
"defaultPhone": Phone,
"emails": [Email],
"firstName": "xyz789",
"lastName": "abc123",
"phones": [Phone],
"vamAgreements": [VAMAgreement]
}
JsonLocation
Description
Location of order, for example number of table.
Fields
| Field Name | Description |
|---|---|
tableNumber - Int
|
Example
{"tableNumber": 987}
KioskCarouselImage
KioskStylesSetting
Description
Setting attributes for kiosk styles
Fields
| Field Name | Description |
|---|---|
carouselImages - [KioskCarouselImage!]!
|
|
mainIntroImage - String
|
|
Arguments
|
|
Example
{
"carouselImages": [KioskCarouselImage],
"mainIntroImage": "xyz789"
}
Language
Description
Possible Language types
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - LanguageEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "CS",
"id": "4",
"rawCode": "abc123"
}
LanguageEnum
Description
Language enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CS"
LanguageInterface
Fields
| Field Name | Description |
|---|---|
defaultLanguage - LanguageEnum!
|
|
supportedLanguages - [LanguageEnum!]!
|
|
Arguments
|
|
Possible Types
| LanguageInterface Types |
|---|
Example
{"defaultLanguage": "CS", "supportedLanguages": ["CS"]}
MobileApplicationSetting
MobilePlatformEnum
Description
Possible mobile platforms
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ANDROID"
Notification
Occasion
Description
Occasion event information
INDEX: [admin, branch_owner, brand_owner, cashier, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, operator, sales_representative, super_admin, supervisor]
Example
{
"companyBranch": CompanyBranch,
"date": "2007-12-03T10:15:30Z",
"dateFrom": "2007-12-03T10:15:30Z",
"dateTo": "2007-12-03T10:15:30Z",
"id": 4,
"image": "xyz789",
"preorderFrom": "2007-12-03T10:15:30Z",
"preorderTo": "2007-12-03T10:15:30Z",
"title": "abc123",
"titleShort": "xyz789"
}
OnlinePaymentGatesInterface
OperatingCostFrequency
Description
Possible OperatingCostFrequency types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OperatingCostFrequencyEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "AUTOMATIC",
"id": 4,
"rawCode": "xyz789"
}
OperatingCostFrequencyEnum
Description
OperatingCostFrequency enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AUTOMATIC"
OperatingCostFrequencyType
Description
OperatingCostType and OperatingCostFrequency grouping model
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
operatingCostFrequency - OperatingCostFrequency!
|
|
operatingCostType - OperatingCostType!
|
Example
{
"id": 4,
"name": "xyz789",
"operatingCostFrequency": OperatingCostFrequency,
"operatingCostType": OperatingCostType
}
OperatingCostRecord
Description
OperatingCostRecord graphql model
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [super_admin]
Fields
| Field Name | Description |
|---|---|
absoluteValue - PriceConverted!
|
|
canceled - Boolean!
|
|
createdAt - DateTime!
|
|
id - ID!
|
|
operatingCostSetting - OperatingCostSetting!
|
|
percentageValue - PriceConverted!
|
|
recordValue - PriceConverted!
|
Example
{
"absoluteValue": PriceConverted,
"canceled": false,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"operatingCostSetting": OperatingCostSetting,
"percentageValue": PriceConverted,
"recordValue": PriceConverted
}
OperatingCostSetting
Description
OperatingCostSetting graphql model
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [super_admin]
Fields
| Field Name | Description |
|---|---|
absoluteValue - Float!
|
|
cancelable - Boolean!
|
|
closed - Boolean!
|
|
companyBranch - CompanyBranch!
|
|
id - ID!
|
|
month - Date!
|
|
operatingCostFrequencyType - OperatingCostFrequencyType!
|
|
percentageValue - Float!
|
Example
{
"absoluteValue": 987.65,
"cancelable": true,
"closed": false,
"companyBranch": CompanyBranch,
"id": "4",
"month": "2007-12-03",
"operatingCostFrequencyType": OperatingCostFrequencyType,
"percentageValue": 987.65
}
OperatingCostType
Description
Possible OperatingCostType types
INDEX: [admin, branch_owner, brand_owner, cashier_statistics, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier_statistics, sales_representative, super_admin, supervisor, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OperatingCostTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "TMOBILE",
"id": "4",
"rawCode": "xyz789"
}
OperatingCostTypeEnum
Description
OperatingCostType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TMOBILE"
Order
Description
Type holding information about user order
INDEX: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, cashier, customer, editor_order, guest, operator, super_admin, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, customer, editor_order, guest, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, cashier, editor_order, operator, super_admin]
Fields
| Field Name | Description |
|---|---|
acceptedAt - DateTime
|
|
address - JsonAddress!
|
can be address from google - no consistent data |
affiliate - Company
|
|
ageControl - Boolean!
|
|
allAppliedRules - [String!]!
|
rules applied to order and all order wares |
appliedRules - [String!]!
|
rules applied to this order |
billing - [OrderBilling!]!
|
|
canBeUpdatedToPaymentMethods - [PaymentMethod!]!
|
order payment method can be updated to these values |
canRequestCancel - Boolean!
|
|
cancelAlreadyRequested - Boolean!
|
|
cashBox - CashBox
|
|
collectFromCustomer - PriceConverted!
|
how much courier should collect from customer |
Arguments
|
|
companyBranch - CompanyBranch!
|
|
countWares - Int!
|
number of wares |
coverPrice - PriceConverted!
|
|
Arguments
|
|
coveringOrders - [Order!]!
|
array of orders covered by virtual one |
createdAt - DateTime!
|
|
creditsPendingWalletPayment - CreditsPendingWalletPayment
|
|
creditsReward - CreditsReward
|
|
currentUserCanFinishOrder - Boolean!
|
|
customer - JsonCustomer!
|
customer data - can be deleted after order is finished |
customerJson - JsonCustomer!
|
customer data - can be deleted after order is finished |
customerOrdersCountCurrent - Int!
|
count of all customers orders |
customerOrdersCountTotal - Int!
|
sequence of current customers order |
delayedDeliveryTime - DateTime
|
delivery time specified by user |
deliverAt - DateTime
|
time of when should be order delivered |
deliverAtWorst - DateTime
|
time of when should be order delivered in worst case |
deliveredAt - DateTime
|
time of when order was deliver |
deliverySlot - DeliverySlot
|
|
deliveryType - DeliveryType
|
|
discounts - [PriceWithDescription!]!
|
|
doNotCount - Int
|
|
driverWillPickupAt - DateTime
|
|
eet - EETType
|
|
Arguments
|
|
externalDeliveryProviders - [ExternalDeliveryProvider!]!
|
list of available external drivers for order |
extraCharge - PriceConverted!
|
|
Arguments
|
|
extraFees - [ExtraFee!]!
|
List of extra fees |
Arguments
|
|
extraFeesSum - PriceConverted!
|
Sum of all extra fees |
Arguments
|
|
flatItems - [OrderRecipeFlat!]!
|
flat items of orders -- same recipes are grouped together |
Arguments
|
|
gps - GeoPoint
|
|
groupedRecipes - [GroupedRecipe!]!
|
grouped recipe IDs and their quantity in the order |
hasRating - Boolean!
|
|
id - ID!
|
|
invoiceSequence - String
|
invoice sequence of company branch |
invoiceSequenceCashBox - Int
|
invoice sequence of cash_box |
invoiceSequenceResettable - Int
|
resettable invoice sequence of company branch, e.g. queue number |
isAnonymous - Boolean!
|
was it non registered user who made order |
isCancelable - Boolean!
|
can user cancel current order |
isCustomerRegistered - Boolean!
|
|
isFinalized - Boolean!
|
is current order finalized |
isPaidWithCard - Boolean!
|
|
isPartiallyFinalized - Boolean!
|
is current order partially finalized |
isPriority - Boolean!
|
is current order marked as high priority |
items - [OrderRecipe!]!
|
ordered items (recipes) |
language - Language!
|
|
levelsOfTransportFees - [TransportFees!]!
|
array of all possible transport fees for order |
Arguments
|
|
levelsOfTransportFeesCount - Int
|
the number of possible transport fees for order |
location - JsonLocation
|
highly depends on location origin - for example, in restaurant can contain number of table |
minimalOrderPrice - PriceConverted
|
minimal price of order in case of delivery |
Arguments
|
|
minimalOrderPriceRemainder - PriceConverted
|
Return how much should customer add to order to succeed validation. When succeeds, returns nil. |
minimalOrderPriceWithDiscounts - Boolean!
|
Indicates if discounts are included in minimalOrderPrice. When zone is not assignet to order, always return true |
minimalOrderPriceWithTransportFee - Boolean!
|
Indicates if transportFee is included in minimalOrderPrice. When zone is not assignet to order, always return true |
nextPossibleTransportFee - TransportFees
|
the nearest lower value of the transport fee for order |
Arguments
|
|
note - String
|
actual user note |
notification - Notification!
|
what method use for user notification |
operatingCostRecords - [OperatingCostRecord!]!
|
operating cost records related to order |
orderConsents - [ConsentOrder!]!
|
|
orderDeliverySlot - OrderDeliverySlot
|
|
orderGroup - OrderGroup
|
associated orger group |
orderGroupIndex - Int
|
index of order inside associated orger group |
orderOnlineState - OrderOnlineState
|
|
orderOrigin - OrderOrigin!
|
|
orderPayments - [OrderPaymentMethod!]!
|
paid information of order |
orderStateCategories - [OrderStateCategoryEnum!]!
|
OrderStateCategory array where order belongs to Use only orderStateCategory query |
Arguments
|
|
orderStateCategory - OrderStateCategoryEnum!
|
last OrderStateCategory where order belongs to |
Arguments
|
|
orderStateCategoryRelations - [OrderStateCategoryRelation!]!
|
list of relations to order category state |
Arguments
|
|
orderStateRelations - [OrderStateRelation!]!
|
|
orderStates - [OrderState!]!
|
|
paidPrice - PriceConverted!
|
|
Arguments
|
|
preciseUpdatedAt - String
|
order update time to the nearest millisecond |
previousNote - String
|
Note from previous order |
productTotalSum - PriceConverted!
|
Provides the sum of all product prices without covers, delivery fees and discounts. |
Arguments
|
|
promoCodes - [PromoCode!]!
|
active promo codes of order |
purchasedCreditsWallet - CreditsWallet
|
|
rating - [OrderRating!]
|
array of order rating notes |
returnPrice - PriceConverted!
|
|
Arguments
|
|
sector - Sector
|
|
tip - PriceConverted!
|
|
Arguments
|
|
totalDiscount - PriceConverted!
|
|
Arguments
|
|
totalSum - PriceConverted!
|
summarized price of order |
Arguments
|
|
totalVouchers - PriceConverted!
|
|
Arguments
|
|
totalWithoutTips - PriceConverted!
|
summarized price of order without tip |
Arguments
|
|
transferOrderFrom - Order
|
original order which was transferred to current one |
transferOrderTo - Order
|
last order this order was transferred to |
transportFee - PriceConverted!
|
|
Arguments
|
|
updatedAt - DateTime
|
|
user - User
|
|
userDeliveringOrder - UserDeliveringOrder
|
current user delivering order |
userDeliveringOrders - [UserDeliveringOrder!]!
|
all associations of user delivering order |
vouchers - [PriceWithDescription!]!
|
|
warePriceType - WarePriceType!
|
|
zone - Zone
|
|
Example
{
"acceptedAt": "2007-12-03T10:15:30Z",
"address": JsonAddress,
"affiliate": Company,
"ageControl": true,
"allAppliedRules": ["xyz789"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"canRequestCancel": true,
"cancelAlreadyRequested": true,
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"companyBranch": CompanyBranch,
"countWares": 123,
"coverPrice": PriceConverted,
"coveringOrders": [Order],
"createdAt": "2007-12-03T10:15:30Z",
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"creditsReward": CreditsReward,
"currentUserCanFinishOrder": false,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"customerOrdersCountCurrent": 987,
"customerOrdersCountTotal": 987,
"delayedDeliveryTime": "2007-12-03T10:15:30Z",
"deliverAt": "2007-12-03T10:15:30Z",
"deliverAtWorst": "2007-12-03T10:15:30Z",
"deliveredAt": "2007-12-03T10:15:30Z",
"deliverySlot": DeliverySlot,
"deliveryType": DeliveryType,
"discounts": [PriceWithDescription],
"doNotCount": 123,
"driverWillPickupAt": "2007-12-03T10:15:30Z",
"eet": EETType,
"externalDeliveryProviders": [ExternalDeliveryProvider],
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"flatItems": [OrderRecipeFlat],
"gps": GeoPoint,
"groupedRecipes": [GroupedRecipe],
"hasRating": true,
"id": 4,
"invoiceSequence": "abc123",
"invoiceSequenceCashBox": 987,
"invoiceSequenceResettable": 987,
"isAnonymous": false,
"isCancelable": true,
"isCustomerRegistered": true,
"isFinalized": false,
"isPaidWithCard": true,
"isPartiallyFinalized": true,
"isPriority": true,
"items": [OrderRecipe],
"language": Language,
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"location": JsonLocation,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": true,
"nextPossibleTransportFee": TransportFees,
"note": "abc123",
"notification": Notification,
"operatingCostRecords": [OperatingCostRecord],
"orderConsents": [ConsentOrder],
"orderDeliverySlot": OrderDeliverySlot,
"orderGroup": OrderGroup,
"orderGroupIndex": 123,
"orderOnlineState": OrderOnlineState,
"orderOrigin": OrderOrigin,
"orderPayments": [OrderPaymentMethod],
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState],
"paidPrice": PriceConverted,
"preciseUpdatedAt": "xyz789",
"previousNote": "xyz789",
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"purchasedCreditsWallet": CreditsWallet,
"rating": [OrderRating],
"returnPrice": PriceConverted,
"sector": Sector,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"transferOrderFrom": Order,
"transferOrderTo": Order,
"transportFee": PriceConverted,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDeliveringOrder": UserDeliveringOrder,
"userDeliveringOrders": [UserDeliveringOrder],
"vouchers": [PriceWithDescription],
"warePriceType": WarePriceType,
"zone": Zone
}
OrderBilling
Description
Complete billing information about order
INDEX: [accountant, admin, branch_owner, brand_owner, editor_billings, editor_order_billing, merchant, sales_representative, super_admin, supervisor]
READ: [accountant, admin, branch_owner, brand_owner, editor_billings, editor_order_billing, merchant, sales_representative, super_admin, supervisor]
CREATE: [admin, editor_order_billing, super_admin]
UPDATE: [admin, editor_order_billing, super_admin]
DESTROY: [admin, editor_order_billing, super_admin]
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
order - Order!
|
|
orderBillingType - OrderBillingType!
|
Type of billing |
price - PriceConverted
|
price converted to prefered currency |
Arguments
|
|
processed - Boolean
|
|
Example
{
"id": "4",
"order": Order,
"orderBillingType": OrderBillingType,
"price": PriceConverted,
"processed": true
}
OrderBillingType
Description
Possible OrderBillingType types
INDEX: [accountant, admin, editor_billings, super_admin, support, user]
READ: [accountant, admin, editor_billings, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OrderBillingTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "PRICE_SUM",
"id": "4",
"rawCode": "xyz789"
}
OrderBillingTypeEnum
Description
OrderBillingType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PRICE_SUM"
OrderCancelFailed
OrderCategoryCountSubscription
Description
Subscription of order category change
Fields
| Field Name | Description |
|---|---|
actionType - SubscriptionActionType!
|
|
id - ID!
|
|
newOrderStateCategory - OrderStateCategoryEnum!
|
|
oldOrderStateCategory - OrderStateCategoryEnum!
|
|
order - Order!
|
Example
{
"actionType": "CREATE",
"id": "4",
"newOrderStateCategory": "MAIN",
"oldOrderStateCategory": "MAIN",
"order": Order
}
OrderCountSubscription
Description
Subscription of order count changes
Fields
| Field Name | Description |
|---|---|
actionType - SubscriptionActionType!
|
|
id - ID!
|
|
ordersCount - Int!
|
Example
{
"actionType": "CREATE",
"id": "4",
"ordersCount": 987
}
OrderDeliverySlot
Description
Schema of an OrderDeliverySlot
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
applied - Boolean!
|
|
deliverySlotSize - Int!
|
|
firstDeliverySlot - DeliverySlotElement!
|
|
id - ID!
|
|
order - Order!
|
Example
{
"applied": false,
"deliverySlotSize": 987,
"firstDeliverySlot": DeliverySlotElement,
"id": 4,
"order": Order
}
OrderDiffAttribute
Description
Objects which may be returned from OrderUpdatePreview
Types
| Union Types |
|---|
Example
CompanyBranch
OrderDiffAttributeEnum
Description
Possible attributes which may change in updateOrderPreview
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY_BRANCH"
OrderDiffChangeTypeEnum
Description
Possible change types of OrderDiff
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"REMOVE"
OrderDiffEntry
Description
Objects which may be commented on
Fields
| Field Name | Description |
|---|---|
attribute - OrderDiffAttributeEnum!
|
|
changeType - OrderDiffChangeTypeEnum!
|
|
newData - OrderDiffAttribute
|
|
oldData - OrderDiffAttribute
|
Example
{
"attribute": "COMPANY_BRANCH",
"changeType": "REMOVE",
"newData": CompanyBranch,
"oldData": CompanyBranch
}
OrderGroup
Description
Entity grouping multiple orders together.
INDEX: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
color - OrderGroupColor
|
|
id - ID!
|
|
name - String
|
|
orders - [Order!]!
|
|
user - User!
|
Example
{
"color": OrderGroupColor,
"id": "4",
"name": "xyz789",
"orders": [Order],
"user": User
}
OrderGroupColor
Description
Order group color with code and color definition
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Example
{
"code": "abc123",
"color": "abc123",
"id": "4"
}
OrderMenu
Description
OrderMenu
Fields
| Field Name | Description |
|---|---|
availabilities - [Availability!]!
|
when record is available |
id - ID!
|
|
isAvailable - Boolean!
|
is available at specific time? |
Arguments
|
|
nameLabel - String!
|
|
pictogram - String
|
|
recipes - [OrderMenuRecipe!]!
|
|
wareCategoryColor - WareCategoryColor
|
|
Example
{
"availabilities": [Availability],
"id": "4",
"isAvailable": false,
"nameLabel": "xyz789",
"pictogram": "abc123",
"recipes": [OrderMenuRecipe],
"wareCategoryColor": WareCategoryColor
}
OrderMenuRecipe
Description
OrderMenuRecipe
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
descriptionLabel - String
|
|
id - ID!
|
|
internalNote - String
|
|
isDynamicPricingEnabled - Boolean!
|
|
nameLabel - String!
|
|
price - PriceConverted!
|
|
Arguments
|
|
recipeColor - RecipeColor
|
|
sideDishesWareCategoriesCount - Int!
|
|
Example
{
"code": "xyz789",
"descriptionLabel": "abc123",
"id": 4,
"internalNote": "abc123",
"isDynamicPricingEnabled": true,
"nameLabel": "xyz789",
"price": PriceConverted,
"recipeColor": RecipeColor,
"sideDishesWareCategoriesCount": 987
}
OrderOnlinePaymentStatus
Description
Status of payment in external service
Fields
| Field Name | Description |
|---|---|
csobUrl - String
|
|
gopayUrl - String
|
|
gpWebpayUrl - String
|
|
isProcessing - Boolean!
|
Indicates that online payment transaction is processing. |
isSuccess - Boolean!
|
Indicates that online payment transaction finished successfully. |
order - Order!
|
|
payFastUrl - String
|
|
payuUrl - String
|
|
userErrors - [String!]!
|
errors which we should display to user |
Example
{
"csobUrl": "xyz789",
"gopayUrl": "abc123",
"gpWebpayUrl": "xyz789",
"isProcessing": true,
"isSuccess": false,
"order": Order,
"payFastUrl": "xyz789",
"payuUrl": "xyz789",
"userErrors": ["xyz789"]
}
OrderOnlineState
Description
Possible OrderOnlineState types
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OrderOnlineStateEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "CREATED",
"id": "4",
"rawCode": "xyz789"
}
OrderOnlineStateEnum
Description
OrderOnlineState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
OrderOrigin
Description
Possible OrderOrigin types
INDEX: [admin, editor_orders, guest, super_admin, support, user]
READ: [admin, editor_orders, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OrderOriginEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "DAME_JIDLO",
"id": 4,
"rawCode": "xyz789"
}
OrderOriginCategory
Description
Possible OrderOriginCategory types
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OrderOriginCategoryEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "DOVEZE",
"id": "4",
"rawCode": "abc123"
}
OrderOriginCategoryEnum
Description
OrderOriginCategory enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOVEZE"
OrderOriginEnum
Description
OrderOrigin enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAME_JIDLO"
OrderPaymentMethod
Description
Holds information about one payment of order
INDEX: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order_payment_method, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, customer, editor_order_payment_method, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, cashier, editor_order_payment_method, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, editor_order_payment_method, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, cashier, editor_order_payment_method, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
order - Order!
|
|
paymentMethod - PaymentMethod!
|
|
price - PriceConverted!
|
|
Arguments
|
|
Example
{
"id": 4,
"order": Order,
"paymentMethod": PaymentMethod,
"price": PriceConverted
}
OrderProcessTime
Description
Orders default delivery/pickup time overriding
INDEX: [admin, branch_owner, brand_owner, cashier, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, cashier, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, cashier, super_admin, supervisor, support]
Fields
| Field Name | Description |
|---|---|
companyBranch - CompanyBranch!
|
|
createdAt - DateTime!
|
|
deliveryType - DeliveryType!
|
|
expiresAt - DateTime!
|
|
id - ID!
|
|
processTime - Int!
|
Example
{
"companyBranch": CompanyBranch,
"createdAt": "2007-12-03T10:15:30Z",
"deliveryType": DeliveryType,
"expiresAt": "2007-12-03T10:15:30Z",
"id": 4,
"processTime": 987
}
OrderRating
Description
Order rating
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
orderRatingType - OrderRatingType!
|
|
text - String
|
|
value - Int
|
Example
{
"id": 4,
"orderRatingType": OrderRatingType,
"text": "abc123",
"value": 123
}
OrderRatingType
Description
Possible OrderRating types
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OrderRatingTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "RATING",
"id": "4",
"rawCode": "xyz789"
}
OrderRatingTypeEnum
Description
Possible order rating types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"RATING"
OrderRecipe
Description
One item of Order (ordered recipe)
INDEX: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order_recipe, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order_recipe, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, cashier, customer, editor_order_recipe, guest, operator, super_admin, support]
UPDATE: [admin, cashier, customer, driver, editor_order_recipe, guest, operator, super_admin, support]
DESTROY: [admin, cashier, customer, editor_order_recipe, guest, operator, super_admin]
Fields
| Field Name | Description |
|---|---|
appliedRules - [String!]!
|
rules applied to this order |
automatic - Boolean!
|
was item added to order automatically |
covers - [OrderRecipe!]!
|
covers of item |
hasDynamicPrice - Boolean!
|
|
id - ID!
|
|
note - String
|
actual user note |
order - Order!
|
|
orderRecipeState - OrderRecipeState!
|
|
parent - OrderRecipe
|
|
price - PriceConverted!
|
|
Arguments
|
|
priceWithSideDishes - PriceConverted!
|
|
Arguments
|
|
promoTag - PromoTag
|
|
recipe - Recipe!
|
|
sideDishes - [OrderRecipe!]!
|
side dishes of item |
wareCategory - WareCategory
|
|
Example
{
"appliedRules": ["xyz789"],
"automatic": false,
"covers": [OrderRecipe],
"hasDynamicPrice": false,
"id": "4",
"note": "xyz789",
"order": Order,
"orderRecipeState": OrderRecipeState,
"parent": OrderRecipe,
"price": PriceConverted,
"priceWithSideDishes": PriceConverted,
"promoTag": PromoTag,
"recipe": Recipe,
"sideDishes": [OrderRecipe],
"wareCategory": WareCategory
}
OrderRecipeFlat
Description
Grouped recipes of one order. Recipes are grouped when they property are same.
Fields
| Field Name | Description |
|---|---|
automatic - Boolean!
|
|
hasDynamicPrice - Boolean!
|
|
ids - [ID!]!
|
IDs of OrderRecipes that this object groups. |
order - Order!
|
|
price - PriceConverted!
|
|
Arguments
|
|
priceWithSideDishes - PriceConverted!
|
|
Arguments
|
|
quantity - Int!
|
|
recipe - Recipe!
|
|
sideDishes - [OrderRecipeFlat!]!
|
tree structure of wares of order |
Arguments
|
|
wareCategory - WareCategory
|
ware category of order recipe for side dishes |
Example
{
"automatic": false,
"hasDynamicPrice": false,
"ids": [4],
"order": Order,
"price": PriceConverted,
"priceWithSideDishes": PriceConverted,
"quantity": 987,
"recipe": Recipe,
"sideDishes": [OrderRecipeFlat],
"wareCategory": WareCategory
}
OrderRecipeState
Description
Possible OrderRecipeState types
INDEX: [admin, editor_orders, super_admin, support, user]
READ: [admin, editor_orders, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OrderRecipeStateEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "FRESH",
"id": "4",
"rawCode": "xyz789"
}
OrderRecipeStateEnum
Description
OrderRecipeState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FRESH"
OrderState
Description
Order state type schema
INDEX: [admin, editor_orders, guest, super_admin, support, user]
READ: [admin, editor_orders, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OrderStateEnum!
|
enum string used to identify object |
id - ID!
|
|
orderStateCategory - OrderStateCategory!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "IN_CART",
"id": 4,
"orderStateCategory": OrderStateCategory,
"rawCode": "xyz789"
}
OrderStateCategory
Description
Order state category type schema
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - OrderStateCategoryEnum!
|
enum string used to identify object |
id - ID!
|
|
orderStates - [OrderStateEnum!]!
|
|
Arguments
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "MAIN",
"id": "4",
"orderStates": ["IN_CART"],
"rawCode": "abc123"
}
OrderStateCategoryCount
Description
Order state category type schema
Fields
| Field Name | Description |
|---|---|
orderStateCategory - OrderStateCategory!
|
enum string used to identify object |
ordersCount - Int!
|
Example
{
"orderStateCategory": OrderStateCategory,
"ordersCount": 987
}
OrderStateCategoryEnum
Description
OrderStateCategory enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MAIN"
OrderStateCategoryRelation
Description
Order state category relation type schema
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
orderStateCategory - OrderStateCategoryEnum!
|
|
orderStates - [OrderStateHistorical!]!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"orderStateCategory": "MAIN",
"orderStates": [OrderStateHistorical]
}
OrderStateCategoryTargetEnum
Description
OrderStateCategoryTarget enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BACKEND"
OrderStateEnum
Description
OrderState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IN_CART"
OrderStateHistorical
Description
All order states taken from events
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
orderState - OrderStateEnum!
|
|
user - User!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"orderState": "IN_CART",
"user": User
}
OrderStateInterface
Fields
| Field Name | Description |
|---|---|
orderStateCategories - [OrderStateCategoryEnum!]!
|
OrderStateCategory array where order belongs to Use only orderStateCategory query |
Arguments
|
|
orderStateCategory - OrderStateCategoryEnum!
|
last OrderStateCategory where order belongs to |
Arguments
|
|
orderStateCategoryRelations - [OrderStateCategoryRelation!]!
|
list of relations to order category state |
Arguments
|
|
orderStateRelations - [OrderStateRelation!]!
|
|
orderStates - [OrderState!]!
|
|
Possible Types
| OrderStateInterface Types |
|---|
Example
{
"orderStateCategories": ["MAIN"],
"orderStateCategory": "MAIN",
"orderStateCategoryRelations": [
OrderStateCategoryRelation
],
"orderStateRelations": [OrderStateRelation],
"orderStates": [OrderState]
}
OrderStateRelation
Description
Order state relation type schema
INDEX: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order_state_relation, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, customer, driver, editor_order_state_relation, editor_orders, guest, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, cashier, cashier_cancel, customer, driver, editor_order_state_relation, guest, operator, owner_cancel, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, customer, editor_order_state_relation, guest, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, cashier, customer, editor_order_state_relation, guest, operator, sales_representative, super_admin, supervisor, support]
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
id - ID!
|
|
order - Order!
|
|
orderState - OrderState!
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"order": Order,
"orderState": OrderState
}
OrderUpdateSubscription
Description
Subscription of order changes
Fields
| Field Name | Description |
|---|---|
actionType - SubscriptionActionType!
|
|
id - ID!
|
|
order - Order
|
Example
{"actionType": "CREATE", "id": 4, "order": Order}
OrderWithErrors
Description
Provide order information with errors
Fields
| Field Name | Description |
|---|---|
errors - [String!]!
|
|
order - Order!
|
Example
{
"errors": ["abc123"],
"order": Order
}
OrdersBulkCanceledResult
Description
Result of canceling multiple orders
Fields
| Field Name | Description |
|---|---|
canceled - [Order!]!
|
|
notCanceled - [OrderCancelFailed!]!
|
Example
{
"canceled": [Order],
"notCanceled": [OrderCancelFailed]
}
OrdersInterface
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
PaymentGate
Description
Possible PaymentGate types
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - PaymentGateEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "GOPAY",
"id": "4",
"rawCode": "abc123"
}
PaymentGateEnum
Description
PaymentGate enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GOPAY"
PaymentMethod
Description
Holds information about specifications of payment method
INDEX: [admin, editor_payment_method, guest, super_admin, support, user]
READ: [admin, editor_payment_method, guest, super_admin, support, user]
CREATE: [admin, editor_payment_method, super_admin, support]
UPDATE: [admin, editor_payment_method, super_admin, support]
DESTROY: [admin, editor_payment_method, super_admin]
Fields
| Field Name | Description |
|---|---|
country - Country!
|
|
description - String!
|
default description of payment method |
id - ID!
|
|
paymentGate - PaymentGate!
|
|
paymentType - PaymentType!
|
|
price - PriceConverted
|
default value of payment method |
Arguments
|
|
Example
{
"country": Country,
"description": "xyz789",
"id": 4,
"paymentGate": PaymentGate,
"paymentType": PaymentType,
"price": PriceConverted
}
PaymentMethodBranch
Description
Payment methods used by branch
INDEX: [admin, branch_owner, brand_owner, editor_payment_method_branch, guest, operator, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, editor_payment_method_branch, guest, operator, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, editor_payment_method_branch, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_payment_method_branch, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_payment_method_branch, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
companyBranch - CompanyBranch!
|
|
deliveryType - DeliveryType
|
|
enabled - Boolean!
|
|
id - ID!
|
|
maximumAmount - PriceConverted
|
Maximum amount allowed for the payment method |
orderOrigin - OrderOrigin!
|
|
paymentMethod - PaymentMethod!
|
|
warePriceType - WarePriceType!
|
Example
{
"companyBranch": CompanyBranch,
"deliveryType": DeliveryType,
"enabled": false,
"id": 4,
"maximumAmount": PriceConverted,
"orderOrigin": OrderOrigin,
"paymentMethod": PaymentMethod,
"warePriceType": WarePriceType
}
PaymentType
Description
Possible PaymentType types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - PaymentTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "CASH",
"id": 4,
"rawCode": "xyz789"
}
PaymentTypeEnum
Description
PaymentType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CASH"
Phone
Description
Holds information about phone number and its description
Fields
| Field Name | Description |
|---|---|
default - Boolean!
|
is contact method default one |
description - String
|
|
phone - String!
|
|
Arguments
|
|
Example
{
"default": false,
"description": "xyz789",
"phone": "abc123"
}
PhoneCodeValidation
PhonePartSelectorEnum
Description
Allows to select a specific part of a phone number (country code, local number) or the full international number. Without a selection, the default is the full international number.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COUNTRY_CODE"
PriceComboSideDish
Description
Price converted to preferred currency with ware category id
Fields
| Field Name | Description |
|---|---|
price - PriceConverted!
|
|
wareCategoryId - ID!
|
Example
{"price": PriceConverted, "wareCategoryId": 4}
PriceConverted
Description
Price converted to preferred currency
Example
{
"currency": Currency,
"formattedValue": "abc123",
"roundedValue": 123.45,
"value": 987.65
}
PriceInterface
Fields
| Field Name | Description |
|---|---|
allAppliedRules - [String!]!
|
rules applied to order and all order wares |
appliedRules - [String!]!
|
rules applied to this order |
billing - [OrderBilling!]!
|
|
canBeUpdatedToPaymentMethods - [PaymentMethod!]!
|
order payment method can be updated to these values |
cashBox - CashBox
|
|
collectFromCustomer - PriceConverted!
|
how much courier should collect from customer |
Arguments
|
|
coverPrice - PriceConverted!
|
|
Arguments
|
|
creditsPendingWalletPayment - CreditsPendingWalletPayment
|
|
discounts - [PriceWithDescription!]!
|
|
eet - EETType
|
|
Arguments
|
|
extraCharge - PriceConverted!
|
|
Arguments
|
|
extraFees - [ExtraFee!]!
|
List of extra fees |
Arguments
|
|
extraFeesSum - PriceConverted!
|
Sum of all extra fees |
Arguments
|
|
isPaidWithCard - Boolean!
|
|
minimalOrderPrice - PriceConverted
|
minimal price of order in case of delivery |
Arguments
|
|
minimalOrderPriceRemainder - PriceConverted
|
Return how much should customer add to order to succeed validation. When succeeds, returns nil. |
minimalOrderPriceWithDiscounts - Boolean!
|
Indicates if discounts are included in minimalOrderPrice. When zone is not assignet to order, always return true |
minimalOrderPriceWithTransportFee - Boolean!
|
Indicates if transportFee is included in minimalOrderPrice. When zone is not assignet to order, always return true |
operatingCostRecords - [OperatingCostRecord!]!
|
operating cost records related to order |
orderPayments - [OrderPaymentMethod!]!
|
paid information of order |
paidPrice - PriceConverted!
|
|
Arguments
|
|
productTotalSum - PriceConverted!
|
Provides the sum of all product prices without covers, delivery fees and discounts. |
Arguments
|
|
promoCodes - [PromoCode!]!
|
active promo codes of order |
returnPrice - PriceConverted!
|
|
Arguments
|
|
tip - PriceConverted!
|
|
Arguments
|
|
totalDiscount - PriceConverted!
|
|
Arguments
|
|
totalSum - PriceConverted!
|
summarized price of order |
Arguments
|
|
totalVouchers - PriceConverted!
|
|
Arguments
|
|
totalWithoutTips - PriceConverted!
|
summarized price of order without tip |
Arguments
|
|
vouchers - [PriceWithDescription!]!
|
|
Possible Types
| PriceInterface Types |
|---|
Example
{
"allAppliedRules": ["abc123"],
"appliedRules": ["xyz789"],
"billing": [OrderBilling],
"canBeUpdatedToPaymentMethods": [PaymentMethod],
"cashBox": CashBox,
"collectFromCustomer": PriceConverted,
"coverPrice": PriceConverted,
"creditsPendingWalletPayment": CreditsPendingWalletPayment,
"discounts": [PriceWithDescription],
"eet": EETType,
"extraCharge": PriceConverted,
"extraFees": [ExtraFee],
"extraFeesSum": PriceConverted,
"isPaidWithCard": false,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceRemainder": PriceConverted,
"minimalOrderPriceWithDiscounts": true,
"minimalOrderPriceWithTransportFee": true,
"operatingCostRecords": [OperatingCostRecord],
"orderPayments": [OrderPaymentMethod],
"paidPrice": PriceConverted,
"productTotalSum": PriceConverted,
"promoCodes": [PromoCode],
"returnPrice": PriceConverted,
"tip": PriceConverted,
"totalDiscount": PriceConverted,
"totalSum": PriceConverted,
"totalVouchers": PriceConverted,
"totalWithoutTips": PriceConverted,
"vouchers": [PriceWithDescription]
}
PriceWithDescription
Fields
| Field Name | Description |
|---|---|
code - ID!
|
|
description - String!
|
|
price - PriceConverted!
|
|
Arguments
|
|
promoCodes - [String!]!
|
|
Example
{
"code": 4,
"description": "xyz789",
"price": PriceConverted,
"promoCodes": ["xyz789"]
}
PrintQueue
Description
Print queue item
INDEX: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
expiresAt - DateTime!
|
|
id - ID!
|
|
printQueueState - PrintQueueState!
|
|
printTemplateRender - PrintTemplateRender!
|
|
printer - Printer!
|
|
targetMac - String!
|
Printer identification through company branch trigger printer |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"id": 4,
"printQueueState": PrintQueueState,
"printTemplateRender": PrintTemplateRender,
"printer": Printer,
"targetMac": "abc123"
}
PrintQueueState
Description
Possible PrintQueueState types
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - PrintQueueStateEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "FRESH",
"id": "4",
"rawCode": "xyz789"
}
PrintQueueStateEnum
Description
PrintQueueState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FRESH"
PrintQueueUpdateSubscription
Description
Subscription of print queue
Fields
| Field Name | Description |
|---|---|
actionType - SubscriptionActionType!
|
|
id - ID!
|
|
printQueue - PrintQueue!
|
Example
{
"actionType": "CREATE",
"id": "4",
"printQueue": PrintQueue
}
PrintTemplateRender
Description
Print template render
INDEX: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, super_admin]
Example
{
"id": "4",
"printableId": 4,
"printableType": "xyz789",
"renderedContent": "xyz789",
"renderedContentBase64": "abc123"
}
Printer
Description
Printer schema
INDEX: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
companyBranchPrinters - [CompanyBranchPrinter!]!
|
|
id - ID!
|
|
mac - String!
|
|
name - String!
|
|
printerType - PrinterType!
|
|
user - User!
|
Example
{
"companyBranchPrinters": [CompanyBranchPrinter],
"id": 4,
"mac": "xyz789",
"name": "xyz789",
"printerType": PrinterType,
"user": User
}
PrinterType
Description
Possible PrinterType types
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - PrinterTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "W58MM",
"id": "4",
"rawCode": "abc123"
}
PrinterTypeEnum
Description
PrinterType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"W58MM"
ProcessTimeInterface
Fields
| Field Name | Description |
|---|---|
currentDeliveryTime - Int!
|
|
currentPickupTime - Int!
|
|
defaultDeliveryTime - Int!
|
time in minutes that is required to deliver order |
defaultDeliveryTimeEnabled - Boolean!
|
|
defaultPickupTime - Int!
|
time in minutes that is required to pickup order |
defaultPickupTimeEnabled - Boolean!
|
|
delayedDeliveryEnabled - Boolean!
|
|
delayedDeliveryLimit - Int!
|
|
overriddenDeliveryTime - OrderProcessTime
|
|
overriddenPickupTime - OrderProcessTime
|
Possible Types
| ProcessTimeInterface Types |
|---|
Example
{
"currentDeliveryTime": 987,
"currentPickupTime": 123,
"defaultDeliveryTime": 123,
"defaultDeliveryTimeEnabled": false,
"defaultPickupTime": 987,
"defaultPickupTimeEnabled": false,
"delayedDeliveryEnabled": true,
"delayedDeliveryLimit": 987,
"overriddenDeliveryTime": OrderProcessTime,
"overriddenPickupTime": OrderProcessTime
}
PromoBanner
Description
Promo Banner
INDEX: [admin, branch_owner, brand_owner, guest, merchant, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, guest, merchant, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, merchant, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, merchant, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, merchant, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
assignable - PromoBannerAssignable!
|
|
desktopImage - String
|
|
enabled - Boolean!
|
|
id - ID!
|
|
mobileImage - String
|
|
position - PromoBannerPositionEnum!
|
|
promoUrl - String
|
|
recipe - Recipe
|
|
showDuration - Int
|
Provided in milliseconds. |
Example
{
"assignable": Company,
"desktopImage": "xyz789",
"enabled": true,
"id": 4,
"mobileImage": "abc123",
"position": "HOMEPAGE1",
"promoUrl": "xyz789",
"recipe": Recipe,
"showDuration": 987
}
PromoBannerAssignable
Description
Object in which it may belong a PromoBanner
Types
| Union Types |
|---|
Example
Company
PromoBannerPositionEnum
Description
PromoBannerPosition enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HOMEPAGE1"
PromoCode
Description
Information about promo code
INDEX: [admin, branch_owner, brand_owner, cashier, editor_orders, editor_promo_code, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, editor_orders, editor_promo_code, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_promo_code, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_promo_code, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_promo_code, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
company - Company
|
|
companyBranch - CompanyBranch
|
|
enabled - Boolean!
|
|
id - ID!
|
|
maxUsage - Int
|
|
maxUsagePerUser - Int
|
|
public - Boolean!
|
|
type - PromoCodeType!
|
|
validTill - DateTime
|
Example
{
"code": "abc123",
"company": Company,
"companyBranch": CompanyBranch,
"enabled": false,
"id": 4,
"maxUsage": 123,
"maxUsagePerUser": 987,
"public": false,
"type": PromoCodeType,
"validTill": "2007-12-03T10:15:30Z"
}
PromoCodeType
Description
Possible PromoCodeType types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - PromoCodeTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "PROMO_CODE",
"id": 4,
"rawCode": "abc123"
}
PromoCodeTypeEnum
Description
PromoCodeType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PROMO_CODE"
PromoHeaderTranslation
Description
Promo header translations
Fields
| Field Name | Description |
|---|---|
content - String
|
|
language - LanguageEnum!
|
Example
{"content": "abc123", "language": "CS"}
PromoTag
Description
Possible PromoTag types
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - PromoTagEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "PROMO_CART",
"id": "4",
"rawCode": "xyz789"
}
PromoTagEnum
Description
PromoTag enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PROMO_CART"
Recipe
Description
Recipe description for every Ware. Holds information about types of Ware - for example can keep information that Pizza is XXL.
INDEX: [admin, branch_owner, brand_owner, cashier, driver, editor_menu, editor_orders, editor_recipe, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, cashier, driver, editor_menu, editor_orders, editor_recipe, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, editor_menu, editor_recipe, gastra_api, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_menu, editor_recipe, gastra_api, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_recipe, gastra_api, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
ageControl - Boolean!
|
|
allergens - [Allergen!]!
|
possible allergens |
associatedRecipes - [RecipeRelation!]!
|
recipes that are associated with current recipe |
availabilities - [Availability!]!
|
when record is available |
availableAmount - Int!
|
number of items that can be produced based on stock |
bistroId - ID
|
|
code - String!
|
recipe code |
dependentRules - [String!]!
|
Description of rules where current recipe is used. |
descriptionLabel - String
|
|
descriptionLabelTranslated - String
|
|
dotykackaId - ID
|
|
enabled - Boolean!
|
|
enabledByOwner - Boolean!
|
|
groups - [Group!]!
|
Groups (Workplaces) where the recipe belongs to |
hasMandatoryCategories - Boolean!
|
Return true if recipe has at least one mandatory side dish category |
id - ID!
|
|
image - String
|
|
ingredients - [Ingredient!]!
|
ingredients of recipe |
internalCode - String!
|
recipe internal code |
internalNote - String
|
|
isAvailable - Boolean!
|
is available at specific time? |
Arguments
|
|
isCombinationMeal - Boolean!
|
|
isCover - Boolean!
|
|
isDynamicPricingEnabled - Boolean!
|
|
isMain - Boolean!
|
|
isSideDish - Boolean!
|
|
mainCombinationMealPrice - PriceConverted!
|
minimum possible sum of the prices of all recipes from side dishes categories |
Arguments
|
|
nameLabel - String!
|
|
nameLabelTranslated - String
|
|
orderRecipeCount - Int!
|
number recipes that is part of appropriate order |
Arguments
|
|
pictogram - String
|
Return pictogram of recipe. If not specified, inheritance fallback to primaryCategory is enabled. |
Arguments
|
|
price - PriceConverted!
|
delivered price converted to prefered currency |
Arguments
|
|
prices - [RecipePrice!]!
|
possible prices of recipes |
Arguments
|
|
primaryWareCategory - WareCategory
|
all categories where recipe is used |
recipeColor - RecipeColor
|
|
recipeTagRelations - [RecipeTagRelation!]
|
|
recipeTags - [RecipeTag!]
|
|
rejectedPaymentMethods - [PaymentMethod!]!
|
which payment methods can be used to pay for recipe |
shared - Boolean!
|
|
sideDishCombinationMealPrices - [PriceComboSideDish!]
|
returns an array of the difference between the price of recipe and minimum price of all recipes for each recipe categories |
Arguments
|
|
sideDishesWareCategories - [WareCategory!]!
|
all categories that contains possible side dishes of recipe |
sideDishesWareCategoriesCount - Int!
|
number of side dishes categories that recipe can use |
soldOut - Boolean!
|
|
stockItems - [StockItem!]!
|
stock items of recipe |
translations - [RecipeTranslation!]!
|
|
video - String
|
|
ware - Ware
|
|
wareCategories - [WareCategory!]!
|
all categories where recipe is used |
wareCategoriesCount - Int!
|
number of categories where recipe is used |
wareCategoryType - WareCategoryType!
|
|
Example
{
"ageControl": true,
"allergens": [Allergen],
"associatedRecipes": [RecipeRelation],
"availabilities": [Availability],
"availableAmount": 123,
"bistroId": 4,
"code": "abc123",
"dependentRules": ["abc123"],
"descriptionLabel": "abc123",
"descriptionLabelTranslated": "xyz789",
"dotykackaId": 4,
"enabled": true,
"enabledByOwner": true,
"groups": [Group],
"hasMandatoryCategories": true,
"id": 4,
"image": "xyz789",
"ingredients": [Ingredient],
"internalCode": "abc123",
"internalNote": "abc123",
"isAvailable": false,
"isCombinationMeal": true,
"isCover": false,
"isDynamicPricingEnabled": false,
"isMain": true,
"isSideDish": true,
"mainCombinationMealPrice": PriceConverted,
"nameLabel": "xyz789",
"nameLabelTranslated": "abc123",
"orderRecipeCount": 987,
"pictogram": "abc123",
"price": PriceConverted,
"prices": [RecipePrice],
"primaryWareCategory": WareCategory,
"recipeColor": RecipeColor,
"recipeTagRelations": [RecipeTagRelation],
"recipeTags": [RecipeTag],
"rejectedPaymentMethods": [PaymentMethod],
"shared": true,
"sideDishCombinationMealPrices": [PriceComboSideDish],
"sideDishesWareCategories": [WareCategory],
"sideDishesWareCategoriesCount": 123,
"soldOut": true,
"stockItems": [StockItem],
"translations": [RecipeTranslation],
"video": "xyz789",
"ware": Ware,
"wareCategories": [WareCategory],
"wareCategoriesCount": 987,
"wareCategoryType": WareCategoryType
}
RecipeColor
Description
Recipe color with code and color definition
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Example
{
"code": "xyz789",
"color": "abc123",
"id": 4
}
RecipePrice
Description
Price of recipe
INDEX: [admin, branch_owner, brand_owner, driver, editor_menu, editor_recipe_price, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, driver, editor_menu, editor_recipe_price, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, editor_menu, editor_recipe_price, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_menu, editor_recipe_price, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_recipe_price, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
price - PriceConverted!
|
price converted to prefered currency |
Arguments
|
|
recipe - Recipe!
|
|
vat - Vat!
|
|
warePriceType - WarePriceType!
|
|
Example
{
"id": "4",
"price": PriceConverted,
"recipe": Recipe,
"vat": Vat,
"warePriceType": WarePriceType
}
RecipeRelation
Description
Relation between two recipes
INDEX: [admin, branch_owner, brand_owner, cashier, driver, editor_recipe_relation, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, driver, editor_recipe_relation, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_recipe_relation, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_recipe_relation, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_recipe_relation, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
associatedRecipe - Recipe!
|
|
id - ID!
|
|
recipe - Recipe!
|
|
warePriceType - WarePriceType!
|
Example
{
"associatedRecipe": Recipe,
"id": "4",
"recipe": Recipe,
"warePriceType": WarePriceType
}
RecipeTag
Description
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, branch_owner, brand_owner, editor_menu, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_menu, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_menu, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
color - String
|
|
company - Company
|
|
id - ID!
|
|
image - String
|
|
label - String
|
|
Arguments
|
|
pictogram - String
|
|
recipeTagCategoryType - RecipeTagCategoryType
|
|
systemRecipeTag - RecipeTag
|
|
translations - [RecipeTagTranslation!]!
|
|
Example
{
"color": "abc123",
"company": Company,
"id": "4",
"image": "xyz789",
"label": "abc123",
"pictogram": "abc123",
"recipeTagCategoryType": RecipeTagCategoryType,
"systemRecipeTag": RecipeTag,
"translations": [RecipeTagTranslation]
}
RecipeTagCategoryType
Description
Possible RecipeTagCategoryType types
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - RecipeTagCategoryTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "WARE_TYPE",
"id": "4",
"rawCode": "xyz789"
}
RecipeTagCategoryTypeEnum
Description
RecipeTagCategoryType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"WARE_TYPE"
RecipeTagRelation
Description
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
inherited - Boolean!
|
|
parentRelation - RecipeTagRelation
|
|
recipeTag - RecipeTag!
|
|
taggable - RecipeTagTaggable!
|
Example
{
"id": "4",
"inherited": false,
"parentRelation": RecipeTagRelation,
"recipeTag": RecipeTag,
"taggable": Recipe
}
RecipeTagTaggable
Description
Object which can be tagged by a RecipeTag
Types
| Union Types |
|---|
Example
Recipe
RecipeTagTranslation
RecipeTranslation
RequestEmailConfirmationCode
Fields
| Field Name | Description |
|---|---|
email - String!
|
Example
{"email": "abc123"}
RequestPhoneConfirmationCode
Fields
| Field Name | Description |
|---|---|
phone - String!
|
|
Arguments
|
|
Example
{"phone": "abc123"}
ResolvedCompanyBranch
Fields
| Field Name | Description |
|---|---|
companyBranch - CompanyBranch!
|
|
url - String!
|
url to doveze app |
zone - Zone!
|
zone that applies for customer delivery |
Example
{
"companyBranch": CompanyBranch,
"url": "xyz789",
"zone": Zone
}
RestrictedAttributes
Fields
| Field Name | Description |
|---|---|
address - JsonAddress!
|
can be address from google - no consistent data |
customer - JsonCustomer!
|
customer data - can be deleted after order is finished |
customerJson - JsonCustomer!
|
customer data - can be deleted after order is finished |
gps - GeoPoint
|
|
location - JsonLocation
|
highly depends on location origin - for example, in restaurant can contain number of table |
Possible Types
| RestrictedAttributes Types |
|---|
Example
{
"address": JsonAddress,
"customer": JsonCustomer,
"customerJson": JsonCustomer,
"gps": GeoPoint,
"location": JsonLocation
}
Role
Description
Possible user roles
INDEX: [admin, branch_owner, brand_owner, editor_role, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, editor_role, sales_representative, super_admin, supervisor, support]
CREATE: [admin, editor_role, super_admin]
UPDATE: [admin, editor_role, super_admin]
DESTROY: [admin, editor_role, super_admin]
Example
{
"code": "abc123",
"enum": "SUPER_ADMIN",
"id": "4",
"name": "xyz789",
"rawCode": "abc123"
}
RoleEnum
Description
Possible roles for user
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUPER_ADMIN"
Sector
Description
Sector information
INDEX: [admin, branch_owner, brand_owner, cashier, guest, operator, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, cashier, guest, operator, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
availabilities - [Availability!]!
|
when record is available |
code - String!
|
|
companyBranch - CompanyBranch!
|
|
deliveryType - DeliveryType
|
delivery type for sector |
eetEnabled - Boolean
|
|
enabled - Boolean!
|
|
gps - GeoPoint
|
|
id - ID!
|
|
inheritedAvailabilities - [Availability!]!
|
|
inheritedDeliveryType - DeliveryType
|
delivery type for sector when inheritance is used |
inheritedEetEnabled - Boolean!
|
|
inheritedEnabled - Boolean!
|
|
inheritedOccasionsEnabled - Boolean!
|
|
inheritedOrderDelaySeconds - Int!
|
|
inheritedWarePriceType - WarePriceType!
|
ware price type for sector when inheritance is used |
isAvailable - Boolean!
|
is available at specific time? |
Arguments
|
|
name - String!
|
|
occasions - [Occasion!]!
|
all available occasions |
occasionsEnabled - Boolean
|
|
orderDelaySeconds - Int
|
|
parent - Sector
|
sectors parent |
preordableOccasions - [Occasion!]!
|
occasions with active preorder |
sectorType - SectorType!
|
|
wareCategoryAvailabilities - [SectorWareCategory!]!
|
|
warePriceType - WarePriceType
|
ware price type for sector |
Example
{
"availabilities": [Availability],
"code": "abc123",
"companyBranch": CompanyBranch,
"deliveryType": DeliveryType,
"eetEnabled": false,
"enabled": true,
"gps": GeoPoint,
"id": 4,
"inheritedAvailabilities": [Availability],
"inheritedDeliveryType": DeliveryType,
"inheritedEetEnabled": false,
"inheritedEnabled": false,
"inheritedOccasionsEnabled": false,
"inheritedOrderDelaySeconds": 987,
"inheritedWarePriceType": WarePriceType,
"isAvailable": false,
"name": "xyz789",
"occasions": [Occasion],
"occasionsEnabled": false,
"orderDelaySeconds": 987,
"parent": Sector,
"preordableOccasions": [Occasion],
"sectorType": SectorType,
"wareCategoryAvailabilities": [SectorWareCategory],
"warePriceType": WarePriceType
}
SectorRecipe
Description
SectorRecipe information
INDEX: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, sales_representative, super_admin, supervisor, support]
CREATE: [admin, cashier, super_admin, support]
UPDATE: [admin, cashier, super_admin, support]
DESTROY: [admin, cashier, super_admin]
Fields
| Field Name | Description |
|---|---|
canceledAt - DateTime
|
|
canceledBy - User
|
|
covers - [SectorRecipe!]!
|
covers of item |
createdAt - DateTime!
|
|
createdBy - User
|
|
id - ID!
|
|
note - String
|
actual user note |
orderRecipeState - OrderRecipeState!
|
|
parent - SectorRecipe
|
|
recipe - Recipe!
|
|
sector - Sector!
|
|
sideDishes - [SectorRecipe!]!
|
side dishes of item |
updatedAt - DateTime!
|
Example
{
"canceledAt": "2007-12-03T10:15:30Z",
"canceledBy": User,
"covers": [SectorRecipe],
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": User,
"id": "4",
"note": "abc123",
"orderRecipeState": OrderRecipeState,
"parent": SectorRecipe,
"recipe": Recipe,
"sector": Sector,
"sideDishes": [SectorRecipe],
"updatedAt": "2007-12-03T10:15:30Z"
}
SectorRecipeUpdateSubscription
Description
Subscription of sector recipe
Fields
| Field Name | Description |
|---|---|
actionType - SubscriptionActionType!
|
|
id - ID!
|
|
sectorRecipe - SectorRecipe
|
Example
{
"actionType": "CREATE",
"id": "4",
"sectorRecipe": SectorRecipe
}
SectorType
Description
Possible SectorType types
INDEX: [admin, guest, super_admin, support, user]
READ: [admin, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - SectorTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "AREA",
"id": 4,
"rawCode": "abc123"
}
SectorTypeEnum
Description
SectorType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AREA"
SectorWareCategory
Description
Ware Category information about Sector
Fields
| Field Name | Description |
|---|---|
access - Boolean!
|
|
id - ID!
|
|
inherited - Boolean!
|
|
wareCategory - WareCategory!
|
Example
{
"access": false,
"id": 4,
"inherited": true,
"wareCategory": WareCategory
}
SettingCompany
Description
Settings of Company
Fields
| Field Name | Description |
|---|---|
kioskStyles - KioskStylesSetting
|
Example
{"kioskStyles": KioskStylesSetting}
SettingCompanyBranch
Description
Settings of CompanyBranch
Fields
| Field Name | Description |
|---|---|
deliveryVat - Vat!
|
|
dotykacka - DotykackaSetting
|
|
kioskStyles - KioskStylesSetting
|
|
Arguments
|
|
wolt - WoltSetting
|
|
Example
{
"deliveryVat": Vat,
"dotykacka": DotykackaSetting,
"kioskStyles": KioskStylesSetting,
"wolt": WoltSetting
}
SettingUser
Description
Settings of User
Fields
| Field Name | Description |
|---|---|
userAssignableRoles - [Role!]!
|
Example
{"userAssignableRoles": [Role]}
Shift
Description
Description of shift
INDEX: [admin, branch_owner, brand_owner, driver, editor_shift, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, driver, editor_shift, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_shift, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_shift, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_shift, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
beginAt - DateTime
|
|
capacity - Int!
|
|
companyBranch - CompanyBranch!
|
|
endAt - DateTime
|
|
id - ID!
|
|
placeCode - String
|
|
shiftUsers - [ShiftUser!]!
|
Example
{
"beginAt": "2007-12-03T10:15:30Z",
"capacity": 123,
"companyBranch": CompanyBranch,
"endAt": "2007-12-03T10:15:30Z",
"id": "4",
"placeCode": "xyz789",
"shiftUsers": [ShiftUser]
}
ShiftUser
Description
Keeps user information for appropriate shift
INDEX: [admin, branch_owner, brand_owner, driver, editor_shift_user, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, driver, editor_shift_user, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, driver, editor_shift_user, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, driver, editor_shift_user, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, driver, editor_shift_user, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shift - Shift!
|
|
shiftUserState - ShiftUserState!
|
|
user - User!
|
Example
{
"id": "4",
"shift": Shift,
"shiftUserState": ShiftUserState,
"user": User
}
ShiftUserState
Description
Possible ShiftUserState types
INDEX: [admin, super_admin, support]
READ: [admin, super_admin, support]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - ShiftUserStateEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "ACCEPTED",
"id": "4",
"rawCode": "abc123"
}
ShiftUserStateEnum
Description
ShiftUserState enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
StatisticsAccessInterface
Fields
| Field Name | Description |
|---|---|
accessibleCreditsGroups - [CreditsGroup!]!
|
Possible Types
| StatisticsAccessInterface Types |
|---|
Example
{"accessibleCreditsGroups": [CreditsGroup]}
StockInterface
Fields
| Field Name | Description |
|---|---|
incomingStockTransfer - [StockTransfer!]!
|
stock items that are incoming to branch |
outcomingStockTransfer - [StockTransfer!]!
|
stock items that are leaving branch |
stockItemsCanBeNegative - Boolean!
|
Possible Types
| StockInterface Types |
|---|
Example
{
"incomingStockTransfer": [StockTransfer],
"outcomingStockTransfer": [StockTransfer],
"stockItemsCanBeNegative": true
}
StockItem
Description
Keeps information about items at stock
INDEX: [admin, branch_owner, brand_owner, cashier, editor_menu, editor_stock_item, gastra_api, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, editor_menu, editor_stock_item, gastra_api, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_stock_item, gastra_api, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_stock_item, gastra_api, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_stock_item, gastra_api, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
allergens - [Allergen!]!
|
possible allergens |
allowNegative - FieldStateEnum!
|
|
allowNegativeValue - Boolean!
|
|
code - String!
|
|
companyBranch - CompanyBranch!
|
|
history - [StockItemHistory!]!
|
|
id - ID!
|
|
ingredients - [Ingredient!]!
|
ingredients that are using stock item |
label - String!
|
|
note - String!
|
|
originalStockItem - StockItem!
|
The StockItem that this StockItem is shared from. When the StockItem is not shared, it references itself. |
physicalStockItem - StockItem!
|
The StockItem that will be used to perform stock manipulations when this StockItem is used. |
plu - String
|
|
price - Float!
|
|
quantity - Float!
|
|
quantityChange - Float!
|
|
recipes - [Recipe!]!
|
recipes that are using stock item |
shared - Boolean!
|
True when the StockItem is shared, false when it is an original StockItem. |
wareUnit - WareUnit!
|
|
Example
{
"allergens": [Allergen],
"allowNegative": "DEFAULT",
"allowNegativeValue": true,
"code": "abc123",
"companyBranch": CompanyBranch,
"history": [StockItemHistory],
"id": 4,
"ingredients": [Ingredient],
"label": "abc123",
"note": "xyz789",
"originalStockItem": StockItem,
"physicalStockItem": StockItem,
"plu": "abc123",
"price": 987.65,
"quantity": 987.65,
"quantityChange": 987.65,
"recipes": [Recipe],
"shared": true,
"wareUnit": WareUnit
}
StockItemHistory
StockTransfer
Description
Transfer information about stock item
INDEX: [admin, branch_owner, brand_owner, editor_stock_transfer, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, editor_stock_transfer, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_stock_transfer, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_stock_transfer, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, editor_stock_transfer, operator, super_admin]
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
quantity - Float!
|
|
rejectAccepted - Boolean!
|
|
rejectedByTarget - Boolean!
|
|
sourceCompanyBranch - CompanyBranch!
|
|
stockItemCode - String!
|
code of stock item from source company branch |
targetCompanyBranch - CompanyBranch!
|
|
wareUnit - WareUnit!
|
Example
{
"id": 4,
"quantity": 123.45,
"rejectAccepted": false,
"rejectedByTarget": false,
"sourceCompanyBranch": CompanyBranch,
"stockItemCode": "abc123",
"targetCompanyBranch": CompanyBranch,
"wareUnit": WareUnit
}
String
Description
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SubscriptionActionType
Description
Possible action types of subscription
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATE"
Time
Description
Time without date (HH:MM:SS)
Example
"10:15:30Z"
TransportFeeInterface
Fields
| Field Name | Description |
|---|---|
levelsOfTransportFees - [TransportFees!]!
|
array of all possible transport fees for order |
Arguments
|
|
levelsOfTransportFeesCount - Int
|
the number of possible transport fees for order |
nextPossibleTransportFee - TransportFees
|
the nearest lower value of the transport fee for order |
Arguments
|
|
transportFee - PriceConverted!
|
|
Arguments
|
|
Possible Types
| TransportFeeInterface Types |
|---|
Example
{
"levelsOfTransportFees": [TransportFees],
"levelsOfTransportFeesCount": 987,
"nextPossibleTransportFee": TransportFees,
"transportFee": PriceConverted
}
TransportFees
Description
Transport fee according to zone rules
Fields
| Field Name | Description |
|---|---|
fromPrice - PriceConverted
|
minimum price for a new transport fee |
newTransportFee - PriceConverted
|
|
priceNeedToOrder - PriceConverted
|
the difference between order price and minimum price for a new transport fee |
Example
{
"fromPrice": PriceConverted,
"newTransportFee": PriceConverted,
"priceNeedToOrder": PriceConverted
}
TransportationDevice
Description
Type for transportation device
INDEX: [admin, branch_owner, brand_owner, cashier, driver, editor_transportation_device, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, driver, editor_transportation_device, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_transportation_device, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_transportation_device, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_transportation_device, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
companyBranch - CompanyBranch!
|
|
deviceState - DeviceState!
|
|
deviceType - DeviceType!
|
|
id - ID!
|
|
idNumber - String!
|
Example
{
"companyBranch": CompanyBranch,
"deviceState": DeviceState,
"deviceType": DeviceType,
"id": 4,
"idNumber": "xyz789"
}
TransportationDeviceUser
Description
Information about transportation device assigned to user
INDEX: [admin, branch_owner, brand_owner, cashier, driver, editor_transportation_device_user, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, driver, editor_transportation_device_user, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, driver, editor_transportation_device_user, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, driver, editor_transportation_device_user, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_transportation_device_user, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
activeUserDelivery - UserDelivery
|
Active UserDelivery of TransportationDeviceUser |
createdAt - DateTime!
|
time of when order was assigned to user |
geoRoad - [GeoPositionWithTimestamp!]!
|
points that transportation device visited |
id - ID!
|
|
isFinalized - Boolean!
|
driver returned transportation device and logged out |
lastPosition - GeoPositionWithTimestamp
|
last geo position that device visited |
returnZone - Zone
|
actual return zone in which is user located |
returnedAt - DateTime
|
time when transportation device was returned |
returning - Boolean!
|
crossed return zone |
transportationDevice - TransportationDevice!
|
|
updatedAt - DateTime!
|
|
user - User!
|
Example
{
"activeUserDelivery": UserDelivery,
"createdAt": "2007-12-03T10:15:30Z",
"geoRoad": [GeoPositionWithTimestamp],
"id": 4,
"isFinalized": false,
"lastPosition": GeoPositionWithTimestamp,
"returnZone": Zone,
"returnedAt": "2007-12-03T10:15:30Z",
"returning": true,
"transportationDevice": TransportationDevice,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User
}
TransportationDeviceUserUpdateSubscription
Description
Subscription of transportation device of user
Fields
| Field Name | Description |
|---|---|
actionType - SubscriptionActionType!
|
|
id - ID!
|
|
transportationDeviceUser - TransportationDeviceUser
|
Example
{
"actionType": "CREATE",
"id": "4",
"transportationDeviceUser": TransportationDeviceUser
}
User
Description
Holds information about every user
INDEX: [admin, branch_owner, brand_owner, cashier, driver, editor_user, operator, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, cashier, driver, editor_user, operator, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, editor_user, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_user, super_admin, supervisor, support, user]
DESTROY: [admin, branch_owner, brand_owner, editor_user, super_admin, supervisor, user]
Fields
| Field Name | Description |
|---|---|
accessibleBranches - [CompanyBranch!]!
|
|
Arguments
|
|
accessibleCreditsGroups - [CreditsGroup!]!
|
|
address - Address
|
|
Arguments
|
|
addresses - [Address!]
|
|
Arguments
|
|
companyBranchUsers - [CompanyBranchUser!]!
|
|
countUndeliveredOrders - Int!
|
|
createdAt - DateTime!
|
|
creditsExpiringSoon - CreditsWalletActivityConnection
|
|
Arguments
|
|
creditsPendingRewards - CreditsRewardConnection!
|
|
Arguments
|
|
creditsRewards - CreditsRewardConnection!
|
|
Arguments
|
|
creditsWalletActivities - CreditsWalletActivityConnection!
|
|
Arguments
|
|
creditsWallets - [CreditsWallet!]!
|
|
customers - [Customer!]!
|
|
Arguments
|
|
email - String!
|
|
emails - [String!]!
|
|
Arguments
|
|
employedBy - [CompanyBranch!]!
|
|
firstName - String
|
|
gps - GeoPoint
|
|
greeting - Greeting!
|
|
Arguments
|
|
id - ID!
|
|
inAppNotifications - InAppNotificationConnection!
|
|
Arguments
|
|
initials - String!
|
|
isGuest - Boolean!
|
is user guest type? -> customer specific data should be taken from different source |
language - Language!
|
|
lastName - String
|
|
login - String
|
|
maskedEmail - String
|
|
notification - Notification
|
what method use for user notification |
orders - [Order!]!
|
|
Arguments |
|
phone - String!
|
|
Arguments
|
|
roles - [Role!]!
|
|
settings - SettingUser!
|
|
shifts - [ShiftUser!]!
|
|
signInAt - DateTime
|
|
signInCount - Int
|
|
signInIp - String
|
|
transportationDeviceUsers - [TransportationDeviceUser!]!
|
|
unreadInAppNotificationsCount - Int!
|
|
updatedAt - DateTime!
|
|
usedTransportationDevice - TransportationDeviceUser
|
|
userDeliveringOrders - [UserDeliveringOrder!]!
|
|
Arguments
|
|
Example
{
"accessibleBranches": [CompanyBranch],
"accessibleCreditsGroups": [CreditsGroup],
"address": Address,
"addresses": [Address],
"companyBranchUsers": [CompanyBranchUser],
"countUndeliveredOrders": 123,
"createdAt": "2007-12-03T10:15:30Z",
"creditsExpiringSoon": CreditsWalletActivityConnection,
"creditsPendingRewards": CreditsRewardConnection,
"creditsRewards": CreditsRewardConnection,
"creditsWalletActivities": CreditsWalletActivityConnection,
"creditsWallets": [CreditsWallet],
"customers": [Customer],
"email": "xyz789",
"emails": ["xyz789"],
"employedBy": [CompanyBranch],
"firstName": "xyz789",
"gps": GeoPoint,
"greeting": Greeting,
"id": 4,
"inAppNotifications": InAppNotificationConnection,
"initials": "abc123",
"isGuest": false,
"language": Language,
"lastName": "abc123",
"login": "xyz789",
"maskedEmail": "xyz789",
"notification": Notification,
"orders": [Order],
"phone": "abc123",
"roles": [Role],
"settings": SettingUser,
"shifts": [ShiftUser],
"signInAt": "2007-12-03T10:15:30Z",
"signInCount": 987,
"signInIp": "xyz789",
"transportationDeviceUsers": [TransportationDeviceUser],
"unreadInAppNotificationsCount": 987,
"updatedAt": "2007-12-03T10:15:30Z",
"usedTransportationDevice": TransportationDeviceUser,
"userDeliveringOrders": [UserDeliveringOrder]
}
UserCallingCustomerSubscription
Description
Subscription for calling numbers for logged user
Example
{
"eventId": 4,
"isRinging": false,
"phone": "abc123",
"prefix": "abc123"
}
UserDeliveringOrder
Description
Information about user and order that is being delivered
INDEX: [admin, branch_owner, brand_owner, cashier, cashier_delivery, driver, editor_user_delivering_order, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, cashier_delivery, driver, editor_user_delivering_order, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, cashier_delivery, driver, editor_user_delivering_order, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, cashier_delivery, driver, editor_user_delivering_order, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, cashier_delivery, driver, editor_user_delivering_order, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
assignmentType - UserDeliveringOrdersAssignmentTypeEnum
|
|
createdAt - DateTime!
|
time of when order was assigned to user |
current - Boolean!
|
|
deliveredAt - DateTime
|
time of when order was deliver |
deliveryState - DeliveryStateEnum!
|
state of current association |
deliveryStates - [DeliveryStateHistorical!]!
|
|
id - ID!
|
|
order - Order!
|
|
updatedAt - DateTime!
|
|
user - User!
|
|
userDelivery - UserDelivery
|
|
willPickupAt - DateTime
|
Example
{
"assignmentType": "STAFF",
"createdAt": "2007-12-03T10:15:30Z",
"current": true,
"deliveredAt": "2007-12-03T10:15:30Z",
"deliveryState": "FRESH",
"deliveryStates": [DeliveryStateHistorical],
"id": 4,
"order": Order,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userDelivery": UserDelivery,
"willPickupAt": "2007-12-03T10:15:30Z"
}
UserDeliveringOrderUpdateSubscription
Description
Subscription of user delivering order changes
Fields
| Field Name | Description |
|---|---|
actionType - SubscriptionActionType!
|
|
id - ID!
|
|
userDeliveringOrder - UserDeliveringOrder
|
Example
{
"actionType": "CREATE",
"id": 4,
"userDeliveringOrder": UserDeliveringOrder
}
UserDeliveringOrdersAssignmentType
Description
Possible UserDeliveringOrdersAssignmentType types
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - UserDeliveringOrdersAssignmentTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "STAFF",
"id": "4",
"rawCode": "abc123"
}
UserDeliveringOrdersAssignmentTypeEnum
Description
UserDeliveringOrdersAssignmentType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"STAFF"
UserDelivery
Description
Information about users delivery
INDEX: [admin, cashier_delivery, driver, super_admin, support]
READ: [admin, cashier_delivery, driver, super_admin, support]
CREATE: [admin, cashier_delivery, driver, super_admin, support]
UPDATE: [admin, cashier_delivery, driver, super_admin, support]
DESTROY: [admin, cashier_delivery, driver, super_admin]
Fields
| Field Name | Description |
|---|---|
active - Boolean!
|
|
id - ID!
|
|
remainingUserDeliveringOrders - [UserDeliveringOrder!]!
|
|
user - TransportationDeviceUser!
|
|
userDeliveringOrders - [UserDeliveringOrder!]!
|
Example
{
"active": true,
"id": 4,
"remainingUserDeliveringOrders": [UserDeliveringOrder],
"user": TransportationDeviceUser,
"userDeliveringOrders": [UserDeliveringOrder]
}
UserPermission
VAMAgreement
Description
Information about specific agreement.
Example
{
"description": "abc123",
"id": 4,
"isConfirmed": false,
"isMandatory": false,
"name": "abc123"
}
Vat
VatPriceType
Description
Vat value for defined ware price type
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vat - Float!
|
|
warePriceType - WarePriceType!
|
Example
{"id": 4, "vat": 123.45, "warePriceType": WarePriceType}
Ware
Description
Type for Ware
INDEX: [admin, branch_owner, brand_owner, editor_menu, editor_ware, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, editor_menu, editor_ware, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_menu, editor_ware, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_menu, editor_ware, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_ware, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
availabilities - [Availability!]!
|
when ware is available |
code - String!
|
ware code |
companyBranch - CompanyBranch!
|
|
descriptionLabel - String!
|
|
enabled - Boolean!
|
|
id - ID!
|
|
isAvailable - Boolean!
|
|
nameLabel - String!
|
|
recipes - [Recipe!]!
|
all recipes of Ware |
Example
{
"availabilities": [Availability],
"code": "xyz789",
"companyBranch": CompanyBranch,
"descriptionLabel": "xyz789",
"enabled": true,
"id": 4,
"isAvailable": false,
"nameLabel": "xyz789",
"recipes": [Recipe]
}
WareCategory
Description
Information about category of wares
INDEX: [admin, branch_owner, brand_owner, cashier_menu, editor_menu, editor_ware_category, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
READ: [admin, branch_owner, brand_owner, cashier_menu, editor_menu, editor_ware_category, gastra_api, guest, menu_sync, merchant, operator, sales_representative, super_admin, supervisor, support, user]
CREATE: [admin, branch_owner, brand_owner, editor_menu, editor_ware_category, gastra_api, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_menu, editor_ware_category, gastra_api, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_ware_category, gastra_api, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
automaticFinish - Boolean!
|
|
availabilities - [Availability!]!
|
when record is available |
companyBranch - CompanyBranch!
|
owner of category |
countRecipes - Int!
|
number of items in category |
covers - [Recipe!]!
|
covers of ware category |
dependentRules - [String!]!
|
Description of rules where current ware category is used. |
descriptionLabel - String
|
|
descriptionLabelTranslated - String
|
|
dotykackaId - ID
|
|
enabled - Boolean!
|
is category active? |
enabledByOwner - Boolean!
|
|
id - ID!
|
|
image - String
|
|
internalNoteLabel - String
|
|
internalNoteLabelTranslated - String
|
|
isAvailable - Boolean!
|
is available at specific time? |
Arguments
|
|
mains - [Recipe!]!
|
main recipes of ware category |
maxCount - Int!
|
maximal number of wares that have to selected at this category |
maxRecipesCount - Int!
|
max number of recipes of one kind that can be selected |
minCount - Int!
|
minimal number of wares that have to selected at this category |
nameLabel - String!
|
|
nameLabelTranslated - String
|
|
orderOriginCategories - [OrderOriginCategoryEnum!]!
|
|
pictogram - String
|
|
promoTags - [PromoTag!]!
|
|
public - Boolean!
|
should be category shown to public? |
recipeTagRelations - [RecipeTagRelation!]
|
|
recipeTags - [RecipeTag!]
|
|
recipes - [Recipe!]!
|
all recipes of ware category |
Arguments
|
|
sharedCompanyBranches - [CompanyBranch!]!
|
|
sideDishes - [Recipe!]!
|
side dishes of ware category |
translations - [WareCategoryTranslation!]!
|
|
wareCategoryColor - WareCategoryColor
|
|
wareCategoryType - WareCategoryType!
|
|
Example
{
"automaticFinish": false,
"availabilities": [Availability],
"companyBranch": CompanyBranch,
"countRecipes": 987,
"covers": [Recipe],
"dependentRules": ["abc123"],
"descriptionLabel": "abc123",
"descriptionLabelTranslated": "xyz789",
"dotykackaId": 4,
"enabled": false,
"enabledByOwner": false,
"id": 4,
"image": "xyz789",
"internalNoteLabel": "abc123",
"internalNoteLabelTranslated": "abc123",
"isAvailable": true,
"mains": [Recipe],
"maxCount": 987,
"maxRecipesCount": 123,
"minCount": 987,
"nameLabel": "abc123",
"nameLabelTranslated": "abc123",
"orderOriginCategories": ["DOVEZE"],
"pictogram": "xyz789",
"promoTags": [PromoTag],
"public": false,
"recipeTagRelations": [RecipeTagRelation],
"recipeTags": [RecipeTag],
"recipes": [Recipe],
"sharedCompanyBranches": [CompanyBranch],
"sideDishes": [Recipe],
"translations": [WareCategoryTranslation],
"wareCategoryColor": WareCategoryColor,
"wareCategoryType": WareCategoryType
}
WareCategoryColor
Description
Ware category color with code and color definition
INDEX: [admin, super_admin, support, user]
READ: [admin, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Example
{
"code": "xyz789",
"color": "abc123",
"id": 4
}
WareCategoryIndexPos2
Description
Information about category of wares
Fields
| Field Name | Description |
|---|---|
hashDigest - String!
|
|
wareCategories - [WareCategory!]!
|
Example
{
"hashDigest": "abc123",
"wareCategories": [WareCategory]
}
WareCategoryPos2
Description
Information about category of wares
Fields
| Field Name | Description |
|---|---|
hashDigest - String!
|
|
wareCategory - WareCategory!
|
Example
{
"hashDigest": "xyz789",
"wareCategory": WareCategory
}
WareCategoryTranslation
WareCategoryType
Description
Possible WareCategoryType types
INDEX: [admin, editor_menu, guest, super_admin, support, user]
READ: [admin, editor_menu, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - WareCategoryTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "MAIN",
"id": "4",
"rawCode": "xyz789"
}
WareCategoryTypeEnum
Description
WareCategoryType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"MAIN"
WarePriceType
Description
Possible WarePriceType types
INDEX: [admin, editor_menu, guest, super_admin, support, user]
READ: [admin, editor_menu, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - WarePriceTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "DELIVERY",
"id": 4,
"rawCode": "abc123"
}
WarePriceTypeEnum
Description
WarePriceType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DELIVERY"
WareUnit
Description
Possible WareUnit types
INDEX: [admin, editor_menu, operator, super_admin, support, user]
READ: [admin, editor_menu, operator, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - WareUnitEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "abc123",
"enum": "KILOGRAM",
"id": 4,
"rawCode": "abc123"
}
WareUnitEnum
Description
WareUnit enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"KILOGRAM"
WeekDay
Description
Possible WeekDay types
INDEX: [admin, editor_business_hours, editor_orders, guest, super_admin, support, user]
READ: [admin, editor_business_hours, editor_orders, guest, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - WeekDayEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "MONDAY",
"id": "4",
"rawCode": "abc123"
}
WeekDayEnum
Description
WeekDay enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MONDAY"
WiFiAppInstruction
WoltProfile
WoltSetting
Description
Setting attributes for Wolt
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
profiles - [WoltProfile!]
|
Example
{"enabled": false, "profiles": [WoltProfile]}
Zone
Description
Zone information
INDEX: [admin, branch_owner, brand_owner, cashier, driver, editor_zone, editor_zones, merchant, operator, sales_representative, super_admin, supervisor, support]
READ: [admin, branch_owner, brand_owner, cashier, driver, editor_zone, editor_zones, merchant, operator, sales_representative, super_admin, supervisor, support]
CREATE: [admin, branch_owner, brand_owner, editor_zone, editor_zones, merchant, operator, sales_representative, super_admin, supervisor, support]
UPDATE: [admin, branch_owner, brand_owner, editor_zone, editor_zones, merchant, operator, sales_representative, super_admin, supervisor, support]
DESTROY: [admin, branch_owner, brand_owner, editor_zone, merchant, operator, sales_representative, super_admin, supervisor]
Fields
| Field Name | Description |
|---|---|
availabilities - [Availability!]!
|
when record is available |
companyBranch - CompanyBranch!
|
|
createdAt - DateTime!
|
|
defaultDeliveryTime - Int!
|
in minutes |
deliveryTimeDeviation - Int!
|
in minutes |
enabled - Boolean!
|
|
geoPolygon - [GeoPoint!]!
|
|
id - ID!
|
|
isAvailable - Boolean!
|
is available at specific time? |
Arguments
|
|
minimalOrderPrice - PriceConverted!
|
|
Arguments
|
|
minimalOrderPriceWithDiscounts - Boolean!
|
Indicates if discounts are included in minimalOrderPrice |
minimalOrderPriceWithTransportFee - Boolean!
|
Indicates if transportFee is included in minimalOrderPrice |
name - String!
|
|
priceRangeRules - [ZonePriceRangeRule!]!
|
price range rules converted to prefered currency |
Arguments
|
|
priority - Int!
|
|
rule - Json
|
description of rule |
updatedAt - DateTime!
|
|
zoneColor - ZoneColor!
|
|
zoneType - ZoneType!
|
|
Example
{
"availabilities": [Availability],
"companyBranch": CompanyBranch,
"createdAt": "2007-12-03T10:15:30Z",
"defaultDeliveryTime": 123,
"deliveryTimeDeviation": 123,
"enabled": false,
"geoPolygon": [GeoPoint],
"id": 4,
"isAvailable": true,
"minimalOrderPrice": PriceConverted,
"minimalOrderPriceWithDiscounts": false,
"minimalOrderPriceWithTransportFee": false,
"name": "abc123",
"priceRangeRules": [ZonePriceRangeRule],
"priority": 123,
"rule": Json,
"updatedAt": "2007-12-03T10:15:30Z",
"zoneColor": ZoneColor,
"zoneType": ZoneType
}
ZoneColor
Description
Zone color with code and color definition
INDEX: [admin, editor_zones, super_admin, support, user]
READ: [admin, editor_zones, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Example
{
"code": "xyz789",
"color": "xyz789",
"id": 4
}
ZonePriceRangeRule
Description
Price rules of the zone
Fields
| Field Name | Description |
|---|---|
price - PriceConverted!
|
price converted to prefered currency |
toPrice - PriceConverted!
|
maximal price of rule |
Example
{
"price": PriceConverted,
"toPrice": PriceConverted
}
ZoneType
Description
Possible ZoneType types
INDEX: [admin, editor_zones, super_admin, support, user]
READ: [admin, editor_zones, super_admin, support, user]
CREATE: [admin, super_admin, support]
UPDATE: [admin, super_admin, support]
DESTROY: [admin, super_admin]
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
enum - ZoneTypeEnum!
|
enum string used to identify object |
id - ID!
|
|
rawCode - String!
|
not localized code |
Example
{
"code": "xyz789",
"enum": "AREA",
"id": 4,
"rawCode": "abc123"
}
ZoneTypeEnum
Description
ZoneType enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AREA"