SMRT GraphQL API Documentation
This documentation offers a comprehensive documentation for the SMRT GraphQL API, providing full access to the SMRT point of sale software. Usage examples include, creating client signup forms, native apps, querying report data, pulling order information for sales tax reporting purposes, and much more!
To access the SMRT API, an 'Authorization' header with an API key is required. This key is available to businesses with an active subscription to SMRT Systems. For more information on our services and subscription details, please visit https://smrtsystems.com/.
Businesses interested in API integration can reach out to our support team at support@smrtsystems.com for an API key, applicable for both development and production use. This key is crucial for authenticating your API requests.
During the development phase, the API endpoint is https://apitesting.smrtapp.com/graphql, allowing certain public GraphQL queries without an API key for convenient testing. For production deployment, integrations shift to a unique business-specific subdomain, paired with a dedicated API key.
API Endpoints
https://apitesting.smrtapp.com/graphql/Queries
business
Description
Information about the business that this graphql endpoint is referencing. The subdomain of *.smrtapp.com, will always match the subdomain of the business returned.
Response
Returns a Business
Example
Query
query Business {
business {
id
localId
shortId
subdomain
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
employeeSettings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
stores {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
storesForCurrentBrand {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
communicationTemplatesList {
id
localId
name
categories {
...CommunicationTemplateCategoryFragment
}
}
contactCommunicationTemplates {
id
localId
name
categories {
...CommunicationTemplateCategoryFragment
}
}
employees {
id
localId
name
firstName
}
routes {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
type
isSubRoute
masterRouteId
pickupCutoffHours
deliveryCutoffHours
autoOptimize
}
routesOnDate {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
type
isSubRoute
masterRouteId
pickupCutoffHours
deliveryCutoffHours
autoOptimize
}
groups {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
notes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
brands {
id
localId
name
brandId
settings {
...SettingsFragment
}
agents {
...AgentFragment
}
isWalled
}
agents {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
holidays {
id
localId
date
noProduction
noDelivery
dayOfWeek
}
itemCategories {
id
localId
name
sort
description
disabled
isRetail
}
itemTypes {
id
localId
name
category {
...ItemCategoryFragment
}
active
isDisabledInCustomerApp
price
priceDisplay
showInDetailing
description
departmentId
defaultImageUrl
}
subscriptions {
id
localId
name
category {
...ItemCategoryFragment
}
active
isDisabledInCustomerApp
price
priceDisplay
showInDetailing
description
departmentId
defaultImageUrl
}
taxRates {
id
localId
objectId
rate
}
paymentMethods {
id
localId
name
disabled
}
taxConfigurationRules {
id
localId
sort
parentRule
isDisabled
isDefault
name
rate
useAutoTaxJar
addressSpecific
zipCondition
departmentCondition
agentCondition
}
itemValidationRules {
id
localId
name
requiredFields
requiredSpecialCares
itemTypeCondition
departmentCondition
sort
isDisabled
}
itemFields {
id
localId
name
}
financialDepartments {
id
localId
name
showInCustomerScheduler
}
specialCares {
id
localId
name
}
alertTypes {
id
localId
name
active
}
alertSubTypes {
id
localId
masterTypeId
name
prefTicket
prefCustomer
prefDelivery
prefPressing
prefInspection
prefSpotting
prefAlteration
prefWashing
mpOffloadArm
active
}
chatRooms {
id
localId
name
specialRoomType
isPrivate
userIds
agents
usersAllowedToPost
isNotificationsRoom
isRequired
chatMessages {
...ChatMessageFragment
}
}
customerFields {
id
localId
fieldType
label
possibleValues
shownProfile
shownPosSignUp
shownCustomerWebsite
shownCustomerWebsiteSignUp
elasticKey
disabled
isRequired
}
usesPaymentSystem
getCustomer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
getCustomers {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
getOrder {
id
localId
displayId
date
dueDate
deliveredDate
customer {
...CustomerFragment
}
pickupStore {
...StoreFragment
}
dropStore {
...StoreFragment
}
isPickup
isDelivery
hasChangedReturnLocation
isPaid
isPaidForDelivery
buyPrice
pieceCount
status
items {
...OrderItemFragment
}
bags {
...OrderBagFragment
}
customerProvidedDetails {
...DetailedCustomerOrderFragment
}
customerOrderStatusText
receiptLink
lastPaymentWasDeclined
}
getAppointment {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
queryReports {
id
localId
columns {
...QueryReportsResultColumnFragment
}
values
totalCount
kpi {
...QueryReportsResultKPIValueFragment
}
}
productionStationStatistics {
id
localId
hours
pieces
ppoh
value
}
merchants {
id
localId
name
gateway
agentIds
}
surcharges {
id
localId
name
disabled
}
customPriceLists {
id
localId
name
}
marketingEmailTemplates {
id
localId
name
subject
jsonTemplate
htmlTemplate
hasPromotion
}
marketingBroadcasts {
id
localId
name
subject
broadcastType
message
customerInclusionKpiIdList
customerExclusionKpiIdList
emailTemplateId
status
dateCreated
dateSent
emailHtmlTemplate
sentBy
scheduledBy
scheduledDate
promotion
autoApplyPromo
optimizeEmailDelivery
}
marketingFilters {
id
localId
report
title
total
}
stripePublishableKey
promotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
lockers {
id
localId
address {
...CustomerAddressFragment
}
}
geoFences {
id
localId
name
brand {
...BrandFragment
}
route {
...RouteFragment
}
polygon
color
isDisabled
createdAt
}
uniqueTwilioErrors {
id
localId
name
}
}
}
Response
{
"data": {
"business": {
"id": "4",
"localId": "4",
"shortId": 987,
"subdomain": "xyz789",
"settings": Settings,
"employeeSettings": Settings,
"stores": [Store],
"storesForCurrentBrand": [Store],
"communicationTemplatesList": [
CommunicationTemplates
],
"contactCommunicationTemplates": CommunicationTemplates,
"employees": [User],
"routes": [Route],
"routesOnDate": [Route],
"groups": [Group],
"notes": [Note],
"brands": [Brand],
"agents": [Agent],
"holidays": [Holiday],
"itemCategories": [ItemCategory],
"itemTypes": [ItemType],
"subscriptions": [ItemType],
"taxRates": [TaxRate],
"paymentMethods": [PaymentMethod],
"taxConfigurationRules": [TaxConfigurationRule],
"itemValidationRules": [ItemValidationRule],
"itemFields": [ItemField],
"financialDepartments": [FinancialDepartment],
"specialCares": [SpecialCare],
"alertTypes": [AlertType],
"alertSubTypes": [AlertSubType],
"chatRooms": [ChatRoom],
"customerFields": [CustomerField],
"usesPaymentSystem": true,
"getCustomer": Customer,
"getCustomers": [Customer],
"getOrder": Order,
"getAppointment": Appointment,
"queryReports": QueryReportsResult,
"productionStationStatistics": ProductionStationStatistics,
"merchants": [Merchant],
"surcharges": [Surcharge],
"customPriceLists": [PriceList],
"marketingEmailTemplates": [MarketingEmailTemplate],
"marketingBroadcasts": [MarketingBroadcast],
"marketingFilters": [MarketingFilterResponse],
"stripePublishableKey": "xyz789",
"promotions": [Promotion],
"lockers": [Locker],
"geoFences": [GeoFence],
"uniqueTwilioErrors": [UniqueTwilioError]
}
}
}
businessReviews
Description
Returns all business reviews for multiple locations
Response
Returns a LocationReviews!
Example
Query
query BusinessReviews(
$pageSize: Int,
$pageToken: String,
$orderBy: String
) {
businessReviews(
pageSize: $pageSize,
pageToken: $pageToken,
orderBy: $orderBy
) {
id
localId
locationReviews {
id
localId
name
review {
...ReviewFragment
}
}
nextPageToken
}
}
Variables
{
"pageSize": 987,
"pageToken": "abc123",
"orderBy": "abc123"
}
Response
{
"data": {
"businessReviews": {
"id": 4,
"localId": "4",
"locationReviews": [LocationReview],
"nextPageToken": "abc123"
}
}
}
currentCustomer
Description
The currently authenticated customer. If one of the customer authentication mutations was previously used, this query will return that customer, as present in the session cookie.
Response
Returns a Customer
Example
Query
query CurrentCustomer {
currentCustomer {
id
localId
name
futureAppointments {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
group {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
agent {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
routeHolds {
id
localId
startDate
endDate
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultDeliveryAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
id
localId
type
last4
expm
expy
status {
...CreditCardStatusFragment
}
}
datesForSchedulingAppointment {
id
localId
date
timeSlots {
...TimeSlotFragment
}
}
unpaidOrders {
id
localId
orders {
...OrderFragment
}
duePayment {
...DuePaymentFragment
}
}
finishedPayments {
id
localId
total
date
receiptLink
}
customerBookings {
id
localId
pickupAppointment {
...AppointmentFragment
}
deliveryAppointment {
...AppointmentFragment
}
detailedCustomerOrder {
...DetailedCustomerOrderFragment
}
orders {
...OrderFragment
}
pickupDateDisplay
deliveryDateDisplay
pickupDateTitle
deliveryDateTitle
statusText
status
progress
bookingDate
lockerId
lockerLabel
}
stagingDetailedCustomerOrder {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
readyBags {
id
localId
barcode
display
order {
...OrderFragment
}
location {
...RackLogFragment
}
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
subscription {
id
localId
pending {
...CustomerSubscriptionEntryFragment
}
active {
...CustomerSubscriptionEntryFragment
}
log {
...CustomerSubscriptionLogFragment
}
renewalDate
}
subscriptionUsage {
id
localId
type
limit
usage
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
customFields {
id
localId
label
value
}
isInSignupProcess
paymentStatus {
id
localId
paymentReference
paymentStatus
}
wardrobeCategories {
id
localId
name
sort
description
disabled
isRetail
}
wardrobeItems {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
paymentPreference
rewardPoints
rewards {
id
localId
date
amount
status
expiryDate
redeemDate
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
communication {
id
localId
direction
type
date
subject
staff {
...UserFragment
}
contactFlag
body
}
}
}
Response
{
"data": {
"currentCustomer": {
"id": 4,
"localId": 4,
"name": "abc123",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "xyz789",
"preferences": [4],
"goodOnlineAccountStanding": false,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": false,
"creditCardIFrameURL": "abc123",
"authenticatedCustomerSiteLink": "abc123",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": true,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 123,
"demographic": 987,
"apiTokenForCustomer": "xyz789",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "abc123",
"cellPhone": "xyz789",
"cellPhoneDisplay": "abc123",
"homePhone": "xyz789",
"activePhone": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"companyName": "xyz789",
"fullName": "xyz789",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": false,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 123.45,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": false,
"deliveryNotes": [Note],
"communication": [Communication]
}
}
}
currentStation
Description
The station the user is signed into
Response
Returns a Station
Example
Query
query CurrentStation {
currentStation {
id
localId
name
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
type {
id
localId
name
category
}
lastUsed
deliveryVehicle {
id
localId
name
typeName
}
}
}
Response
{
"data": {
"currentStation": {
"id": "4",
"localId": "4",
"name": "xyz789",
"store": Store,
"type": StationType,
"lastUsed": "2007-12-03T10:15:30Z",
"deliveryVehicle": Rack
}
}
}
currentStore
Description
The store the user is signed into, or the default store if not set.
Response
Returns a Store
Example
Query
query CurrentStore {
currentStore {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
id
localId
name
gateway
agentIds
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
id
localId
name
store {
...StoreFragment
}
type {
...StationTypeFragment
}
lastUsed
deliveryVehicle {
...RackFragment
}
}
hasCounterStation
}
}
Response
{
"data": {
"currentStore": {
"id": 4,
"localId": "4",
"agentId": "4",
"agentType": "abc123",
"name": "abc123",
"isStripeEnabled": false,
"merchant": Merchant,
"phone": "abc123",
"address": "xyz789",
"city": "xyz789",
"state": "abc123",
"zip": "abc123",
"latitude": 987.65,
"longitude": 123.45,
"externalStoreIdentifier": "abc123",
"googlePlaceId": "abc123",
"stations": [Station],
"hasCounterStation": false
}
}
}
currentUser
Description
The currently authenticated user. This is normally an employee of the business, but if an API key is used, this will return the API user instead. Lastly, if a customer is authenticated rather than a user, this endpoint will return null.
Response
Returns a User
Example
Query
query CurrentUser {
currentUser {
id
localId
name
firstName
}
}
Response
{
"data": {
"currentUser": {
"id": "4",
"localId": 4,
"name": "xyz789",
"firstName": "xyz789"
}
}
}
customerCountFromMarketingFilter
Description
Gets number of customers that will receive a marketing broadcast/campaign
Response
Returns an Int!
Example
Query
query CustomerCountFromMarketingFilter(
$customerInclusionKpiIdList: [String]!,
$customerExclusionKpiIdList: [String]!
) {
customerCountFromMarketingFilter(
customerInclusionKpiIdList: $customerInclusionKpiIdList,
customerExclusionKpiIdList: $customerExclusionKpiIdList
)
}
Variables
{
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"]
}
Response
{"data": {"customerCountFromMarketingFilter": 987}}
customerPreferences
Description
A list of customer preference sections
Response
Returns [CustomerPreferenceSection!]!
Example
Query
query CustomerPreferences {
customerPreferences {
id
localId
type
name
options {
id
localId
name
}
hideCustomerPreference
}
}
Response
{
"data": {
"customerPreferences": [
{
"id": "4",
"localId": 4,
"type": "abc123",
"name": "xyz789",
"options": [CustomerPreference],
"hideCustomerPreference": false
}
]
}
}
customerStop
Description
Returns stop data for a delivery appointment
Response
Returns a CustomerStop
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the stop. Same as an appointment ID |
Example
Query
query CustomerStop($id: ID!) {
customerStop(id: $id) {
id
localId
appointment {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
customer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
orders {
id
localId
displayId
date
dueDate
deliveredDate
customer {
...CustomerFragment
}
pickupStore {
...StoreFragment
}
dropStore {
...StoreFragment
}
isPickup
isDelivery
hasChangedReturnLocation
isPaid
isPaidForDelivery
buyPrice
pieceCount
status
items {
...OrderItemFragment
}
bags {
...OrderBagFragment
}
customerProvidedDetails {
...DetailedCustomerOrderFragment
}
customerOrderStatusText
receiptLink
lastPaymentWasDeclined
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"customerStop": {
"id": 4,
"localId": 4,
"appointment": Appointment,
"customer": Customer,
"orders": [Order]
}
}
}
customerStops
Description
Returns delivery stops for a given route and day
Response
Returns [CustomerStop!]!
Example
Query
query CustomerStops(
$routeId: ID!,
$date: DateTime!
) {
customerStops(
routeId: $routeId,
date: $date
) {
id
localId
appointment {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
customer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
orders {
id
localId
displayId
date
dueDate
deliveredDate
customer {
...CustomerFragment
}
pickupStore {
...StoreFragment
}
dropStore {
...StoreFragment
}
isPickup
isDelivery
hasChangedReturnLocation
isPaid
isPaidForDelivery
buyPrice
pieceCount
status
items {
...OrderItemFragment
}
bags {
...OrderBagFragment
}
customerProvidedDetails {
...DetailedCustomerOrderFragment
}
customerOrderStatusText
receiptLink
lastPaymentWasDeclined
}
}
}
Variables
{
"routeId": 4,
"date": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"customerStops": [
{
"id": 4,
"localId": "4",
"appointment": Appointment,
"customer": Customer,
"orders": [Order]
}
]
}
}
googleAccounts
Description
List of Google accounts
Response
Returns [GoogleAccount]!
Example
Query
query GoogleAccounts {
googleAccounts {
id
localId
name
locations {
id
localId
name
address
storeCode
placeId
}
}
}
Response
{
"data": {
"googleAccounts": [
{
"id": "4",
"localId": "4",
"name": "abc123",
"locations": [GoogleLocation]
}
]
}
}
node
Description
Retrieve any object given an id in the graph. Required by React Relay.
nodes
Description
Retrieve multiple objects given ids in the graph. Required by React Relay.
preAllocatedOrderIds
Description
Returns a list of allocated order ids to use
publicBusiness
Description
Returns data about the current business / brand that should be available for non authenticated users. The business / brand is determined by the current subdomain of *.smrtapp.com
Response
Returns a PublicBusiness!
Example
Query
query PublicBusiness {
publicBusiness {
id
businessName
logoUrl
phoneNumber
streetAddress
cityAddress
zipAddress
stateAddress
signupAddressRequired
signupEmailRequired
customerFields {
id
localId
fieldType
label
possibleValues
shownProfile
shownPosSignUp
shownCustomerWebsite
shownCustomerWebsiteSignUp
elasticKey
disabled
isRequired
}
defaultLanguage
fullstoryEnabled
settings {
localId
id
customSignupUrl
}
localId
}
}
Response
{
"data": {
"publicBusiness": {
"id": "4",
"businessName": "xyz789",
"logoUrl": "abc123",
"phoneNumber": "xyz789",
"streetAddress": "xyz789",
"cityAddress": "xyz789",
"zipAddress": "xyz789",
"stateAddress": "xyz789",
"signupAddressRequired": true,
"signupEmailRequired": false,
"customerFields": [CustomerField],
"defaultLanguage": "abc123",
"fullstoryEnabled": true,
"settings": PublicBusinessSetting,
"localId": "4"
}
}
}
rackByLockerCode
Description
Returns an address given a locker code. Also updates customer default address if locker address is found.
Response
Returns a RackByLockerCodeResponse!
Example
Query
query RackByLockerCode(
$customerId: ID!,
$lockerCode: String!
) {
rackByLockerCode(
customerId: $customerId,
lockerCode: $lockerCode
) {
id
localId
rack {
id
localId
address {
...CustomerAddressFragment
}
lockerOnRoute
}
address {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
locationLabel
}
}
Variables
{
"customerId": "4",
"lockerCode": "abc123"
}
Response
{
"data": {
"rackByLockerCode": {
"id": 4,
"localId": "4",
"rack": RackCfg,
"address": CustomerAddress,
"locationLabel": "abc123"
}
}
}
stationTypes
Description
Get a list of possible station types
Response
Returns [StationType]!
Example
Query
query StationTypes {
stationTypes {
id
localId
name
category
}
}
Response
{
"data": {
"stationTypes": [
{
"id": 4,
"localId": 4,
"name": "xyz789",
"category": "abc123"
}
]
}
}
Mutations
addCustomerToRoute
Description
Adds a customer to a route
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
|
routeId - ID!
|
|
preference - CustomerDeliveryPreferenceEnum!
|
Example
Query
mutation AddCustomerToRoute(
$customerId: ID!,
$routeId: ID!,
$preference: CustomerDeliveryPreferenceEnum!
) {
addCustomerToRoute(
customerId: $customerId,
routeId: $routeId,
preference: $preference
) {
id
localId
name
futureAppointments {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
group {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
agent {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
routeHolds {
id
localId
startDate
endDate
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultDeliveryAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
id
localId
type
last4
expm
expy
status {
...CreditCardStatusFragment
}
}
datesForSchedulingAppointment {
id
localId
date
timeSlots {
...TimeSlotFragment
}
}
unpaidOrders {
id
localId
orders {
...OrderFragment
}
duePayment {
...DuePaymentFragment
}
}
finishedPayments {
id
localId
total
date
receiptLink
}
customerBookings {
id
localId
pickupAppointment {
...AppointmentFragment
}
deliveryAppointment {
...AppointmentFragment
}
detailedCustomerOrder {
...DetailedCustomerOrderFragment
}
orders {
...OrderFragment
}
pickupDateDisplay
deliveryDateDisplay
pickupDateTitle
deliveryDateTitle
statusText
status
progress
bookingDate
lockerId
lockerLabel
}
stagingDetailedCustomerOrder {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
readyBags {
id
localId
barcode
display
order {
...OrderFragment
}
location {
...RackLogFragment
}
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
subscription {
id
localId
pending {
...CustomerSubscriptionEntryFragment
}
active {
...CustomerSubscriptionEntryFragment
}
log {
...CustomerSubscriptionLogFragment
}
renewalDate
}
subscriptionUsage {
id
localId
type
limit
usage
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
customFields {
id
localId
label
value
}
isInSignupProcess
paymentStatus {
id
localId
paymentReference
paymentStatus
}
wardrobeCategories {
id
localId
name
sort
description
disabled
isRetail
}
wardrobeItems {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
paymentPreference
rewardPoints
rewards {
id
localId
date
amount
status
expiryDate
redeemDate
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
communication {
id
localId
direction
type
date
subject
staff {
...UserFragment
}
contactFlag
body
}
}
}
Variables
{
"customerId": "4",
"routeId": 4,
"preference": "NO_PREFERENCE"
}
Response
{
"data": {
"addCustomerToRoute": {
"id": "4",
"localId": "4",
"name": "xyz789",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "xyz789",
"preferences": ["4"],
"goodOnlineAccountStanding": true,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": true,
"creditCardIFrameURL": "abc123",
"authenticatedCustomerSiteLink": "xyz789",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": false,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 123,
"demographic": 123,
"apiTokenForCustomer": "xyz789",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "xyz789",
"cellPhone": "abc123",
"cellPhoneDisplay": "abc123",
"homePhone": "xyz789",
"activePhone": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"companyName": "abc123",
"fullName": "xyz789",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": true,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 987.65,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": true,
"deliveryNotes": [Note],
"communication": [Communication]
}
}
}
addUserToChatRoom
Description
Add a chat user to a room
Response
Returns a Boolean!
Example
Query
mutation AddUserToChatRoom(
$roomId: ID!,
$userId: ID!
) {
addUserToChatRoom(
roomId: $roomId,
userId: $userId
)
}
Variables
{"roomId": 4, "userId": 4}
Response
{"data": {"addUserToChatRoom": true}}
appendSpecialChatMessageContent
Description
If a chat message contains any special info like item or customer barcodes this endpoint will transform the message replacing the barcodes with links
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
message - String!
|
The original message to process |
Example
Query
mutation AppendSpecialChatMessageContent($message: String!) {
appendSpecialChatMessageContent(message: $message)
}
Variables
{"message": "xyz789"}
Response
{
"data": {
"appendSpecialChatMessageContent": "xyz789"
}
}
applyPromotion
Description
Applies promotion code to customer. Requires access level: Customer or Admin
Response
Returns a Boolean!
Example
Query
mutation ApplyPromotion(
$customerId: ID,
$promotionToApply: String
) {
applyPromotion(
customerId: $customerId,
promotionToApply: $promotionToApply
)
}
Variables
{
"customerId": "4",
"promotionToApply": "xyz789"
}
Response
{"data": {"applyPromotion": false}}
buildRouteAction
Description
Creates a customer stop given bag barcode, route and day
Response
Returns a BuildRoute!
Arguments
| Name | Description |
|---|---|
input - BuildRouteActionInput!
|
Example
Query
mutation BuildRouteAction($input: BuildRouteActionInput!) {
buildRouteAction(input: $input) {
id
localId
barcode
extraMessage
customerName
}
}
Variables
{"input": BuildRouteActionInput}
Response
{
"data": {
"buildRouteAction": {
"id": 4,
"localId": 4,
"barcode": "abc123",
"extraMessage": "abc123",
"customerName": "abc123"
}
}
}
cancelAppointment
Description
Cancel an appointment. Requires access level: Customer or Admin
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
appointmentId - ID!
|
The ID of the appointment to cancel |
Example
Query
mutation CancelAppointment($appointmentId: ID!) {
cancelAppointment(appointmentId: $appointmentId)
}
Variables
{"appointmentId": "4"}
Response
{"data": {"cancelAppointment": false}}
cancelCustomerSubscription
Description
Cancels a subscription by setting the status to 'cancelled', but also sets the end date to the end of the month during which time it will remain active. Requires access level: Customer or Admin
Response
Returns a CustomerSubscription
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
A customer id |
status - SubscriptionStatusEnum!
|
The status of the subscription to cancel |
Example
Query
mutation CancelCustomerSubscription(
$customerId: ID!,
$status: SubscriptionStatusEnum!
) {
cancelCustomerSubscription(
customerId: $customerId,
status: $status
) {
id
localId
pending {
id
localId
saleId
price
start
end
}
active {
id
localId
saleId
price
start
end
}
log {
id
localId
date
event
description
user {
...UserFragment
}
}
renewalDate
}
}
Variables
{"customerId": 4, "status": "pending"}
Response
{
"data": {
"cancelCustomerSubscription": {
"id": 4,
"localId": "4",
"pending": CustomerSubscriptionEntry,
"active": CustomerSubscriptionEntry,
"log": [CustomerSubscriptionLog],
"renewalDate": "2007-12-03T10:15:30Z"
}
}
}
changeStopOrderDeliveryAction
Description
Changes the order of a delivery stop
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ChangeStopOrderDeliveryActionInput!
|
Example
Query
mutation ChangeStopOrderDeliveryAction($input: ChangeStopOrderDeliveryActionInput!) {
changeStopOrderDeliveryAction(input: $input)
}
Variables
{"input": ChangeStopOrderDeliveryActionInput}
Response
{"data": {"changeStopOrderDeliveryAction": false}}
clearCurrentCustomer
Response
Returns a Boolean
Example
Query
mutation ClearCurrentCustomer {
clearCurrentCustomer
}
Response
{"data": {"clearCurrentCustomer": false}}
completeStopDeliveryAction
Description
Marks a delivery stop completed. Requires a valid Delivery station cookie
Response
Returns a CustomerStop!
Arguments
| Name | Description |
|---|---|
input - CompleteStopDeliveryActionInput!
|
Example
Query
mutation CompleteStopDeliveryAction($input: CompleteStopDeliveryActionInput!) {
completeStopDeliveryAction(input: $input) {
id
localId
appointment {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
customer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
orders {
id
localId
displayId
date
dueDate
deliveredDate
customer {
...CustomerFragment
}
pickupStore {
...StoreFragment
}
dropStore {
...StoreFragment
}
isPickup
isDelivery
hasChangedReturnLocation
isPaid
isPaidForDelivery
buyPrice
pieceCount
status
items {
...OrderItemFragment
}
bags {
...OrderBagFragment
}
customerProvidedDetails {
...DetailedCustomerOrderFragment
}
customerOrderStatusText
receiptLink
lastPaymentWasDeclined
}
}
}
Variables
{"input": CompleteStopDeliveryActionInput}
Response
{
"data": {
"completeStopDeliveryAction": {
"id": 4,
"localId": "4",
"appointment": Appointment,
"customer": Customer,
"orders": [Order]
}
}
}
createAndSetStation
Description
Create a new station given a store and station type. On success, the secret key is returned that the client should store in the cookie 'smrt_stkey' for authentication. If your IP is not whitelisted, you must provide a user entered auth code as argument. Simply try the endpoint and on error, ask the user to input an auth code. The endpoint will also give an error if the auth key is invalid.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
stationTypeId - String!
|
The station type (StationType_x_y) of the station that you want to create |
storeId - String!
|
The store id (Store_x_y) of the store that you want to assign this station to |
authCode - String
|
For a non whitelisted IP, you must provide an auth code to create a station. This can be fetched manually in the admin panel. |
name - String
|
Optional name of the station. If not provided, a name will be auto generated |
Example
Query
mutation CreateAndSetStation(
$stationTypeId: String!,
$storeId: String!,
$authCode: String,
$name: String
) {
createAndSetStation(
stationTypeId: $stationTypeId,
storeId: $storeId,
authCode: $authCode,
name: $name
)
}
Variables
{
"stationTypeId": "abc123",
"storeId": "abc123",
"authCode": "abc123",
"name": "xyz789"
}
Response
{"data": {"createAndSetStation": "xyz789"}}
createAuthCodesForSettingStation
Description
Generate 5 one-time authentication codes for setting up stations. Requires access level: Sr Manager
Response
Returns [String]!
Example
Query
mutation CreateAuthCodesForSettingStation {
createAuthCodesForSettingStation
}
Response
{
"data": {
"createAuthCodesForSettingStation": [
"xyz789"
]
}
}
createCardSetupIntent
Description
Creates a Stripe Setup Intent, returns the Stripe client secret. Requires access level: Customer or Admin
createCustomer
Description
Creates a customer. Requires access level: Admin
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
input - CustomerInput!
|
Customer to create |
agentId - String
|
The associated agent ID |
Example
Query
mutation CreateCustomer(
$input: CustomerInput!,
$agentId: String
) {
createCustomer(
input: $input,
agentId: $agentId
) {
id
localId
name
futureAppointments {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
group {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
agent {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
routeHolds {
id
localId
startDate
endDate
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultDeliveryAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
id
localId
type
last4
expm
expy
status {
...CreditCardStatusFragment
}
}
datesForSchedulingAppointment {
id
localId
date
timeSlots {
...TimeSlotFragment
}
}
unpaidOrders {
id
localId
orders {
...OrderFragment
}
duePayment {
...DuePaymentFragment
}
}
finishedPayments {
id
localId
total
date
receiptLink
}
customerBookings {
id
localId
pickupAppointment {
...AppointmentFragment
}
deliveryAppointment {
...AppointmentFragment
}
detailedCustomerOrder {
...DetailedCustomerOrderFragment
}
orders {
...OrderFragment
}
pickupDateDisplay
deliveryDateDisplay
pickupDateTitle
deliveryDateTitle
statusText
status
progress
bookingDate
lockerId
lockerLabel
}
stagingDetailedCustomerOrder {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
readyBags {
id
localId
barcode
display
order {
...OrderFragment
}
location {
...RackLogFragment
}
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
subscription {
id
localId
pending {
...CustomerSubscriptionEntryFragment
}
active {
...CustomerSubscriptionEntryFragment
}
log {
...CustomerSubscriptionLogFragment
}
renewalDate
}
subscriptionUsage {
id
localId
type
limit
usage
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
customFields {
id
localId
label
value
}
isInSignupProcess
paymentStatus {
id
localId
paymentReference
paymentStatus
}
wardrobeCategories {
id
localId
name
sort
description
disabled
isRetail
}
wardrobeItems {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
paymentPreference
rewardPoints
rewards {
id
localId
date
amount
status
expiryDate
redeemDate
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
communication {
id
localId
direction
type
date
subject
staff {
...UserFragment
}
contactFlag
body
}
}
}
Variables
{
"input": CustomerInput,
"agentId": "abc123"
}
Response
{
"data": {
"createCustomer": {
"id": 4,
"localId": "4",
"name": "xyz789",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "xyz789",
"preferences": [4],
"goodOnlineAccountStanding": false,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": true,
"creditCardIFrameURL": "abc123",
"authenticatedCustomerSiteLink": "xyz789",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": false,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 987,
"demographic": 987,
"apiTokenForCustomer": "abc123",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "xyz789",
"cellPhone": "abc123",
"cellPhoneDisplay": "abc123",
"homePhone": "xyz789",
"activePhone": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"companyName": "abc123",
"fullName": "abc123",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": true,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 123.45,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": true,
"deliveryNotes": [Note],
"communication": [Communication]
}
}
}
createDefaultMarketingReport
Description
Creates a default marketing report
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
marketingReport - MarketingReportInput!
|
The marketing report to create |
Example
Query
mutation CreateDefaultMarketingReport($marketingReport: MarketingReportInput!) {
createDefaultMarketingReport(marketingReport: $marketingReport)
}
Variables
{"marketingReport": MarketingReportInput}
Response
{"data": {"createDefaultMarketingReport": false}}
createNotificationForEmployees
Description
Send a notification to specified employees. Requires access level: Production
Response
Returns a Boolean!
Example
Query
mutation CreateNotificationForEmployees(
$text: String!,
$employees: [ID]!
) {
createNotificationForEmployees(
text: $text,
employees: $employees
)
}
Variables
{
"text": "abc123",
"employees": ["4"]
}
Response
{"data": {"createNotificationForEmployees": false}}
createPayment
Description
Creates a payment
Response
Returns a PaymentStatus!
Arguments
| Name | Description |
|---|---|
input - CreatePaymentInput!
|
Example
Query
mutation CreatePayment($input: CreatePaymentInput!) {
createPayment(input: $input) {
id
localId
paymentReference
paymentStatus
}
}
Variables
{"input": CreatePaymentInput}
Response
{
"data": {
"createPayment": {
"id": "4",
"localId": 4,
"paymentReference": "abc123",
"paymentStatus": "AUTHORIZED"
}
}
}
createPhoto
Description
Creates a photo from a base64 string
Response
Returns a Photo
Arguments
| Name | Description |
|---|---|
input - PhotoInput!
|
Example
Query
mutation CreatePhoto($input: PhotoInput!) {
createPhoto(input: $input) {
id
localId
status
thumbnailUrl
smallUrl
largeUrl
description
}
}
Variables
{"input": PhotoInput}
Response
{
"data": {
"createPhoto": {
"id": "4",
"localId": "4",
"status": "xyz789",
"thumbnailUrl": "abc123",
"smallUrl": "xyz789",
"largeUrl": "abc123",
"description": "abc123"
}
}
}
deactivateAccount
Description
Deactivates customer account. Requires access level: Sales Clerk
Response
Returns an ID!
Example
Query
mutation DeactivateAccount(
$customerId: ID!,
$subCategoryId: ID!,
$description: String
) {
deactivateAccount(
customerId: $customerId,
subCategoryId: $subCategoryId,
description: $description
)
}
Variables
{
"customerId": "4",
"subCategoryId": 4,
"description": "abc123"
}
Response
{"data": {"deactivateAccount": 4}}
deleteMarketingBroadcast
Description
Delete a marketing broadcast.
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
broadcastId - ID!
|
Id of the marketing broadcast to delete |
Example
Query
mutation DeleteMarketingBroadcast($broadcastId: ID!) {
deleteMarketingBroadcast(broadcastId: $broadcastId)
}
Variables
{"broadcastId": 4}
Response
{"data": {"deleteMarketingBroadcast": 4}}
deleteMarketingEmailTemplate
Description
Delete an marketing email template.
Example
Query
mutation DeleteMarketingEmailTemplate($templateId: ID!) {
deleteMarketingEmailTemplate(templateId: $templateId)
}
Variables
{"templateId": "4"}
Response
{
"data": {
"deleteMarketingEmailTemplate": "4"
}
}
deleteReviewReply
Description
Deletes a reply to a review
deleteRouteHold
Description
Delete a customer route hold. Requires access level: Sr Manager
Response
Returns an ID
Example
Query
mutation DeleteRouteHold(
$customerId: ID!,
$input: ID!
) {
deleteRouteHold(
customerId: $customerId,
input: $input
)
}
Variables
{"customerId": "4", "input": 4}
Response
{"data": {"deleteRouteHold": 4}}
deleteTaxConfigurationRule
Description
Delete a tax configuration rule. Requires access level: Sr Manager
deliverBagDeliveryAction
Description
Delivers a bag to its customer. Requires a valid Delivery station cookie
Response
Returns a CustomerStop!
Arguments
| Name | Description |
|---|---|
input - DeliverBagDeliveryActionInput!
|
Example
Query
mutation DeliverBagDeliveryAction($input: DeliverBagDeliveryActionInput!) {
deliverBagDeliveryAction(input: $input) {
id
localId
appointment {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
customer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
orders {
id
localId
displayId
date
dueDate
deliveredDate
customer {
...CustomerFragment
}
pickupStore {
...StoreFragment
}
dropStore {
...StoreFragment
}
isPickup
isDelivery
hasChangedReturnLocation
isPaid
isPaidForDelivery
buyPrice
pieceCount
status
items {
...OrderItemFragment
}
bags {
...OrderBagFragment
}
customerProvidedDetails {
...DetailedCustomerOrderFragment
}
customerOrderStatusText
receiptLink
lastPaymentWasDeclined
}
}
}
Variables
{"input": DeliverBagDeliveryActionInput}
Response
{
"data": {
"deliverBagDeliveryAction": {
"id": "4",
"localId": 4,
"appointment": Appointment,
"customer": Customer,
"orders": [Order]
}
}
}
disconnectGoogleAccount
Description
Disconnects the Google account from the Business
Response
Returns a Boolean!
Example
Query
mutation DisconnectGoogleAccount {
disconnectGoogleAccount
}
Response
{"data": {"disconnectGoogleAccount": true}}
getAdminApiToken
Description
Create or get an existing JWT admin API Token. This token does not expire unless revoked. Requires access level: Admin
Response
Returns a String!
Example
Query
mutation GetAdminApiToken {
getAdminApiToken
}
Response
{"data": {"getAdminApiToken": "abc123"}}
getBeefreeApiToken
Description
Create or get an existing Beefree API Token. Requires access level: Admin
Response
Returns a String!
Example
Query
mutation GetBeefreeApiToken {
getBeefreeApiToken
}
Response
{"data": {"getBeefreeApiToken": "abc123"}}
loadBagDeliveryAction
Description
Loads a bag into a delivery van. Requires a valid Delivery station cookie
Response
Returns a CustomerStop!
Arguments
| Name | Description |
|---|---|
input - LoadBagDeliveryActionInput!
|
Example
Query
mutation LoadBagDeliveryAction($input: LoadBagDeliveryActionInput!) {
loadBagDeliveryAction(input: $input) {
id
localId
appointment {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
customer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
orders {
id
localId
displayId
date
dueDate
deliveredDate
customer {
...CustomerFragment
}
pickupStore {
...StoreFragment
}
dropStore {
...StoreFragment
}
isPickup
isDelivery
hasChangedReturnLocation
isPaid
isPaidForDelivery
buyPrice
pieceCount
status
items {
...OrderItemFragment
}
bags {
...OrderBagFragment
}
customerProvidedDetails {
...DetailedCustomerOrderFragment
}
customerOrderStatusText
receiptLink
lastPaymentWasDeclined
}
}
}
Variables
{"input": LoadBagDeliveryActionInput}
Response
{
"data": {
"loadBagDeliveryAction": {
"id": "4",
"localId": "4",
"appointment": Appointment,
"customer": Customer,
"orders": [Order]
}
}
}
mailgunValidateEmail
Description
Validates an email address using the Mailgun API
mpKioskSendPaymentLink
Description
Sends payment link to customer for ready & unpaid orders
pickupOrdersHeimacKiosk
Description
Pickup orders through Heimac Kiosk
Example
Query
mutation PickupOrdersHeimacKiosk($barcodes: [String]!) {
pickupOrdersHeimacKiosk(barcodes: $barcodes)
}
Variables
{"barcodes": ["abc123"]}
Response
{"data": {"pickupOrdersHeimacKiosk": false}}
prepareChatUser
Description
To be called before connecting to chat socket to ensure appropriate data exists
Response
Returns a Boolean!
Example
Query
mutation PrepareChatUser {
prepareChatUser
}
Response
{"data": {"prepareChatUser": false}}
prepareKioskTicketsForPayment
Description
Extracts finished tickets to new orders to allow for partial payment and pickup from a 24/7 kiosk. Returns the number of splits performed.
putAlertSubType
Description
Creates or updates an Alert Sub Type
Response
Returns an AlertSubType
Arguments
| Name | Description |
|---|---|
input - AlertSubTypeInput!
|
Example
Query
mutation PutAlertSubType($input: AlertSubTypeInput!) {
putAlertSubType(input: $input) {
id
localId
masterTypeId
name
prefTicket
prefCustomer
prefDelivery
prefPressing
prefInspection
prefSpotting
prefAlteration
prefWashing
mpOffloadArm
active
}
}
Variables
{"input": AlertSubTypeInput}
Response
{
"data": {
"putAlertSubType": {
"id": "4",
"localId": "4",
"masterTypeId": 4,
"name": "abc123",
"prefTicket": true,
"prefCustomer": true,
"prefDelivery": true,
"prefPressing": true,
"prefInspection": false,
"prefSpotting": false,
"prefAlteration": false,
"prefWashing": true,
"mpOffloadArm": "xyz789",
"active": false
}
}
}
putAppointment
Description
Create or update an Appointment. Requires access level: Customer or Admin
Response
Returns an Appointment!
Arguments
| Name | Description |
|---|---|
input - AppointmentInput!
|
An Appointment to create or update |
isPickup - Boolean
|
Must be set if scheduling both pickup and delivery |
Example
Query
mutation PutAppointment(
$input: AppointmentInput!,
$isPickup: Boolean
) {
putAppointment(
input: $input,
isPickup: $isPickup
) {
id
localId
startTime
endTime
timeSlot {
id
localId
start
end
routeId
}
scheduledBy {
id
localId
name
}
scheduledAt
route {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
type
isSubRoute
masterRouteId
pickupCutoffHours
deliveryCutoffHours
autoOptimize
}
driverInstructions
cleaningInstructions
departments {
id
localId
name
showInCustomerScheduler
}
customer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
address {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
driver {
id
localId
name
firstName
}
regular
anytime
status
appointmentLinkId
photos {
id
localId
status
thumbnailUrl
smallUrl
largeUrl
description
}
lockerCode
locationLabel
vehicleStatus {
id
localId
driverName
driverPhone
lastPositionAt
currentLatitude
currentLongitude
stopsLeft
}
stopNumber
deliveryPhoto {
id
localId
status
thumbnailUrl
smallUrl
largeUrl
description
}
}
}
Variables
{"input": AppointmentInput, "isPickup": true}
Response
{
"data": {
"putAppointment": {
"id": 4,
"localId": "4",
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"timeSlot": TimeSlot,
"scheduledBy": Actor,
"scheduledAt": "2007-12-03T10:15:30Z",
"route": Route,
"driverInstructions": "abc123",
"cleaningInstructions": "xyz789",
"departments": [FinancialDepartment],
"customer": Customer,
"address": CustomerAddress,
"driver": User,
"regular": true,
"anytime": true,
"status": "incomplete",
"appointmentLinkId": 4,
"photos": [Photo],
"lockerCode": 4,
"locationLabel": "4",
"vehicleStatus": DeliveryVehicleStatus,
"stopNumber": 987,
"deliveryPhoto": Photo
}
}
}
putBrand
Description
Update or Create brand. Requires access level: Sr Manager
Response
Returns a Brand!
Arguments
| Name | Description |
|---|---|
input - BrandInput!
|
A brand to create/update |
Example
Query
mutation PutBrand($input: BrandInput!) {
putBrand(input: $input) {
id
localId
name
brandId
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
agents {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
isWalled
}
}
Variables
{"input": BrandInput}
Response
{
"data": {
"putBrand": {
"id": 4,
"localId": "4",
"name": "xyz789",
"brandId": "xyz789",
"settings": Settings,
"agents": [Agent],
"isWalled": false
}
}
}
putChatRoom
Description
Create or update a chat room. Requires access level: Sr Manager
Response
Returns a ChatRoom!
Arguments
| Name | Description |
|---|---|
input - ChatRoomInput!
|
A chat room to create/update |
Example
Query
mutation PutChatRoom($input: ChatRoomInput!) {
putChatRoom(input: $input) {
id
localId
name
specialRoomType
isPrivate
userIds
agents
usersAllowedToPost
isNotificationsRoom
isRequired
chatMessages {
id
localId
roomId
userId
text
createDate
}
}
}
Variables
{"input": ChatRoomInput}
Response
{
"data": {
"putChatRoom": {
"id": 4,
"localId": "4",
"name": "abc123",
"specialRoomType": "xyz789",
"isPrivate": false,
"userIds": ["4"],
"agents": ["4"],
"usersAllowedToPost": ["4"],
"isNotificationsRoom": false,
"isRequired": true,
"chatMessages": [ChatMessage]
}
}
}
putContactLogEmail
Description
Sends a message to the customer using the contact log. Requires access level: Customer or Admin
Response
Returns a Boolean
Example
Query
mutation PutContactLogEmail(
$customerId: ID!,
$subject: String,
$message: String
) {
putContactLogEmail(
customerId: $customerId,
subject: $subject,
message: $message
)
}
Variables
{
"customerId": "4",
"subject": "abc123",
"message": "xyz789"
}
Response
{"data": {"putContactLogEmail": false}}
putCreditCard
Description
Updates a customer's credit card. Responds with 'added' or 'updated'. For Stripe only id and customerId is mandatory. Requires access level: Customer or Admin
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
A customer id |
id - String!
|
A credit card ID |
type - CreditCardTypeEnum
|
A credit card type |
last4 - Int
|
Last 4 digits of the credit card number |
expiryMonth - Int
|
Month of expiry (1-12) |
expiryYear - Int
|
Year of expiry in 4 digits |
addedBy - CreditCardAddedByEnum
|
By whom the card was added, defaults to customer |
Example
Query
mutation PutCreditCard(
$customerId: ID!,
$id: String!,
$type: CreditCardTypeEnum,
$last4: Int,
$expiryMonth: Int,
$expiryYear: Int,
$addedBy: CreditCardAddedByEnum
) {
putCreditCard(
customerId: $customerId,
id: $id,
type: $type,
last4: $last4,
expiryMonth: $expiryMonth,
expiryYear: $expiryYear,
addedBy: $addedBy
)
}
Variables
{
"customerId": "4",
"id": "abc123",
"type": "visa",
"last4": 987,
"expiryMonth": 123,
"expiryYear": 123,
"addedBy": "customer"
}
Response
{"data": {"putCreditCard": "abc123"}}
putCustomer
Description
Updates a customer. Requires access level: Customer or Admin
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
customerId - ID
|
A customer id (optional, defaults to logged in user) |
input - CustomerInput!
|
Customer fields to update |
promotionToApply - String
|
A coupon code to apply to the customer |
Example
Query
mutation PutCustomer(
$customerId: ID,
$input: CustomerInput!,
$promotionToApply: String
) {
putCustomer(
customerId: $customerId,
input: $input,
promotionToApply: $promotionToApply
) {
id
localId
name
futureAppointments {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
group {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
agent {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
routeHolds {
id
localId
startDate
endDate
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultDeliveryAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
id
localId
type
last4
expm
expy
status {
...CreditCardStatusFragment
}
}
datesForSchedulingAppointment {
id
localId
date
timeSlots {
...TimeSlotFragment
}
}
unpaidOrders {
id
localId
orders {
...OrderFragment
}
duePayment {
...DuePaymentFragment
}
}
finishedPayments {
id
localId
total
date
receiptLink
}
customerBookings {
id
localId
pickupAppointment {
...AppointmentFragment
}
deliveryAppointment {
...AppointmentFragment
}
detailedCustomerOrder {
...DetailedCustomerOrderFragment
}
orders {
...OrderFragment
}
pickupDateDisplay
deliveryDateDisplay
pickupDateTitle
deliveryDateTitle
statusText
status
progress
bookingDate
lockerId
lockerLabel
}
stagingDetailedCustomerOrder {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
readyBags {
id
localId
barcode
display
order {
...OrderFragment
}
location {
...RackLogFragment
}
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
subscription {
id
localId
pending {
...CustomerSubscriptionEntryFragment
}
active {
...CustomerSubscriptionEntryFragment
}
log {
...CustomerSubscriptionLogFragment
}
renewalDate
}
subscriptionUsage {
id
localId
type
limit
usage
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
customFields {
id
localId
label
value
}
isInSignupProcess
paymentStatus {
id
localId
paymentReference
paymentStatus
}
wardrobeCategories {
id
localId
name
sort
description
disabled
isRetail
}
wardrobeItems {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
paymentPreference
rewardPoints
rewards {
id
localId
date
amount
status
expiryDate
redeemDate
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
communication {
id
localId
direction
type
date
subject
staff {
...UserFragment
}
contactFlag
body
}
}
}
Variables
{
"customerId": "4",
"input": CustomerInput,
"promotionToApply": "xyz789"
}
Response
{
"data": {
"putCustomer": {
"id": "4",
"localId": "4",
"name": "abc123",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "abc123",
"preferences": [4],
"goodOnlineAccountStanding": true,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": true,
"creditCardIFrameURL": "xyz789",
"authenticatedCustomerSiteLink": "abc123",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": true,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 123,
"demographic": 123,
"apiTokenForCustomer": "xyz789",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "abc123",
"cellPhone": "abc123",
"cellPhoneDisplay": "xyz789",
"homePhone": "xyz789",
"activePhone": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"companyName": "xyz789",
"fullName": "abc123",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": true,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 987.65,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": false,
"deliveryNotes": [Note],
"communication": [Communication]
}
}
}
putCustomerAddresses
Description
Updates a customer's addresses. Requires access level: Customer or Admin
Response
Returns a PutCustomerAddressesResponse
Arguments
| Name | Description |
|---|---|
customerId - ID
|
A customer id (optional, defaults to logged in user) |
defaultName - String
|
The default address name. Must be one of Billing | Home | Business | Other |
addresses - [CustomerAddressInput]!
|
A list of addresses |
updateDeliveries - Boolean
|
If true, also update addresses for currently scheduled deliveries |
Example
Query
mutation PutCustomerAddresses(
$customerId: ID,
$defaultName: String,
$addresses: [CustomerAddressInput]!,
$updateDeliveries: Boolean
) {
putCustomerAddresses(
customerId: $customerId,
defaultName: $defaultName,
addresses: $addresses,
updateDeliveries: $updateDeliveries
) {
id
localId
info
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
}
}
Variables
{
"customerId": "4",
"defaultName": "xyz789",
"addresses": [CustomerAddressInput],
"updateDeliveries": true
}
Response
{
"data": {
"putCustomerAddresses": {
"id": "4",
"localId": "4",
"info": "xyz789",
"addresses": [CustomerAddress]
}
}
}
putCustomerField
Description
Creates or updates a customer field
Response
Returns a CustomerField
Arguments
| Name | Description |
|---|---|
input - CustomerFieldInput!
|
Example
Query
mutation PutCustomerField($input: CustomerFieldInput!) {
putCustomerField(input: $input) {
id
localId
fieldType
label
possibleValues
shownProfile
shownPosSignUp
shownCustomerWebsite
shownCustomerWebsiteSignUp
elasticKey
disabled
isRequired
}
}
Variables
{"input": CustomerFieldInput}
Response
{
"data": {
"putCustomerField": {
"id": 4,
"localId": 4,
"fieldType": "text",
"label": "xyz789",
"possibleValues": ["xyz789"],
"shownProfile": true,
"shownPosSignUp": true,
"shownCustomerWebsite": false,
"shownCustomerWebsiteSignUp": false,
"elasticKey": "xyz789",
"disabled": true,
"isRequired": false
}
}
}
putCustomerPreferences
Description
Updates a customer's preferences. Requires access level: Customer or Admin
Response
Returns [ID]!
Example
Query
mutation PutCustomerPreferences(
$customerId: ID!,
$preferenceIds: [ID]!
) {
putCustomerPreferences(
customerId: $customerId,
preferenceIds: $preferenceIds
)
}
Variables
{"customerId": 4, "preferenceIds": ["4"]}
Response
{"data": {"putCustomerPreferences": [4]}}
putDetailedOrder
Description
Create a detailed customer order. Requires access level: Customer or Admin
Response
Returns a DetailedCustomerOrder!
Arguments
| Name | Description |
|---|---|
customerId - String!
|
A customer id |
order - DetailedCustomerOrderInput
|
Details for the order, provided directly by customer |
Example
Query
mutation PutDetailedOrder(
$customerId: String!,
$order: DetailedCustomerOrderInput
) {
putDetailedOrder(
customerId: $customerId,
order: $order
) {
id
localId
customer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
isStaging
detailedItemData {
id
localId
description
photo {
...PhotoFragment
}
annotations {
...AnnotationFragment
}
}
}
}
Variables
{
"customerId": "xyz789",
"order": DetailedCustomerOrderInput
}
Response
{
"data": {
"putDetailedOrder": {
"id": 4,
"localId": "4",
"customer": Customer,
"isStaging": false,
"detailedItemData": [DetailedItemData]
}
}
}
putGeoFence
Description
Creates or updates a geo-fence
Response
Returns a GeoFence!
Arguments
| Name | Description |
|---|---|
input - GeoFenceInput!
|
Example
Query
mutation PutGeoFence($input: GeoFenceInput!) {
putGeoFence(input: $input) {
id
localId
name
brand {
id
localId
name
brandId
settings {
...SettingsFragment
}
agents {
...AgentFragment
}
isWalled
}
route {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
type
isSubRoute
masterRouteId
pickupCutoffHours
deliveryCutoffHours
autoOptimize
}
polygon
color
isDisabled
createdAt
}
}
Variables
{"input": GeoFenceInput}
Response
{
"data": {
"putGeoFence": {
"id": 4,
"localId": 4,
"name": "abc123",
"brand": Brand,
"route": Route,
"polygon": [123.45],
"color": "abc123",
"isDisabled": false,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
putImportOrder
Description
Creates an import order. Requires access level: Customer or Admin
Response
Returns an Order
Example
Query
mutation PutImportOrder(
$customerId: ID!,
$agentId: String,
$amount: String,
$status: String,
$comment: String
) {
putImportOrder(
customerId: $customerId,
agentId: $agentId,
amount: $amount,
status: $status,
comment: $comment
) {
id
localId
displayId
date
dueDate
deliveredDate
customer {
id
localId
name
futureAppointments {
...AppointmentFragment
}
settings {
...SettingsFragment
}
group {
...GroupFragment
}
agent {
...AgentFragment
}
routeHolds {
...CustomerRouteHoldFragment
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
...CustomerAddressFragment
}
defaultAddress {
...CustomerAddressFragment
}
defaultDeliveryAddress {
...CustomerAddressFragment
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
...CreditCardFragment
}
datesForSchedulingAppointment {
...ScheduleDateFragment
}
unpaidOrders {
...UnpaidOrdersFragment
}
finishedPayments {
...PaymentReceiptFragment
}
customerBookings {
...CustomerBookingFragment
}
stagingDetailedCustomerOrder {
...DetailedCustomerOrderFragment
}
readyBags {
...CustomerBagFragment
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
...PromotionFragment
}
subscription {
...CustomerSubscriptionFragment
}
subscriptionUsage {
...SubscriptionUsageFragment
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
...StoreFragment
}
customFields {
...CustomerFieldValueFragment
}
isInSignupProcess
paymentStatus {
...PaymentStatusFragment
}
wardrobeCategories {
...ItemCategoryFragment
}
wardrobeItems {
...OrderItemFragment
}
paymentPreference
rewardPoints
rewards {
...RewardFragment
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
...NoteFragment
}
communication {
...CommunicationFragment
}
}
pickupStore {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
dropStore {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
isPickup
isDelivery
hasChangedReturnLocation
isPaid
isPaidForDelivery
buyPrice
pieceCount
status
items {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
bags {
id
localId
barcode
label
items {
...OrderItemFragment
}
rack {
...RackFragment
}
isReturnedToCustomer
rackLocation {
...RackLogFragment
}
bagPackagingType
}
customerProvidedDetails {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
customerOrderStatusText
receiptLink
lastPaymentWasDeclined
}
}
Variables
{
"customerId": "4",
"agentId": "xyz789",
"amount": "xyz789",
"status": "abc123",
"comment": "xyz789"
}
Response
{
"data": {
"putImportOrder": {
"id": "4",
"localId": "4",
"displayId": "4",
"date": "2007-12-03T10:15:30Z",
"dueDate": "2007-12-03T10:15:30Z",
"deliveredDate": "2007-12-03T10:15:30Z",
"customer": Customer,
"pickupStore": Store,
"dropStore": Store,
"isPickup": true,
"isDelivery": true,
"hasChangedReturnLocation": false,
"isPaid": true,
"isPaidForDelivery": false,
"buyPrice": 987.65,
"pieceCount": 987,
"status": "disabled",
"items": [OrderItem],
"bags": [OrderBag],
"customerProvidedDetails": DetailedCustomerOrder,
"customerOrderStatusText": "xyz789",
"receiptLink": "xyz789",
"lastPaymentWasDeclined": true
}
}
}
putItemCategories
Description
Update or Create item categories. Requires access level: Sr Manager
Response
Returns [ItemCategory]!
Arguments
| Name | Description |
|---|---|
input - [ItemCategoryInput]!
|
A list of item categories to create/update |
Example
Query
mutation PutItemCategories($input: [ItemCategoryInput]!) {
putItemCategories(input: $input) {
id
localId
name
sort
description
disabled
isRetail
}
}
Variables
{"input": [ItemCategoryInput]}
Response
{
"data": {
"putItemCategories": [
{
"id": "4",
"localId": 4,
"name": "abc123",
"sort": 987,
"description": "xyz789",
"disabled": false,
"isRetail": true
}
]
}
}
putItemValidationRule
Description
Create or update an item validation rule. Requires access level: Sr Manager
Response
Returns an ItemValidationRule!
Arguments
| Name | Description |
|---|---|
input - ItemValidationRuleInput!
|
A rule to create/update |
Example
Query
mutation PutItemValidationRule($input: ItemValidationRuleInput!) {
putItemValidationRule(input: $input) {
id
localId
name
requiredFields
requiredSpecialCares
itemTypeCondition
departmentCondition
sort
isDisabled
}
}
Variables
{"input": ItemValidationRuleInput}
Response
{
"data": {
"putItemValidationRule": {
"id": "4",
"localId": 4,
"name": "xyz789",
"requiredFields": ["abc123"],
"requiredSpecialCares": ["abc123"],
"itemTypeCondition": ["xyz789"],
"departmentCondition": ["abc123"],
"sort": 123,
"isDisabled": true
}
}
}
putMarketingBroadcast
Description
Creates or updates a marketing broadcast
Response
Returns a MarketingBroadcast
Arguments
| Name | Description |
|---|---|
input - MarketingBroadcastInput!
|
Example
Query
mutation PutMarketingBroadcast($input: MarketingBroadcastInput!) {
putMarketingBroadcast(input: $input) {
id
localId
name
subject
broadcastType
message
customerInclusionKpiIdList
customerExclusionKpiIdList
emailTemplateId
status
dateCreated
dateSent
emailHtmlTemplate
sentBy
scheduledBy
scheduledDate
promotion
autoApplyPromo
optimizeEmailDelivery
}
}
Variables
{"input": MarketingBroadcastInput}
Response
{
"data": {
"putMarketingBroadcast": {
"id": 4,
"localId": "4",
"name": "xyz789",
"subject": "abc123",
"broadcastType": "xyz789",
"message": "xyz789",
"customerInclusionKpiIdList": [
"abc123"
],
"customerExclusionKpiIdList": [
"abc123"
],
"emailTemplateId": "abc123",
"status": "abc123",
"dateCreated": 123.45,
"dateSent": "xyz789",
"emailHtmlTemplate": "abc123",
"sentBy": "abc123",
"scheduledBy": "xyz789",
"scheduledDate": "abc123",
"promotion": "abc123",
"autoApplyPromo": false,
"optimizeEmailDelivery": true
}
}
}
putMarketingEmailTemplate
Description
Creates or updates a marketing email template
Response
Returns a MarketingEmailTemplate
Arguments
| Name | Description |
|---|---|
input - MarketingEmailTemplateInput!
|
Example
Query
mutation PutMarketingEmailTemplate($input: MarketingEmailTemplateInput!) {
putMarketingEmailTemplate(input: $input) {
id
localId
name
subject
jsonTemplate
htmlTemplate
hasPromotion
}
}
Variables
{"input": MarketingEmailTemplateInput}
Response
{
"data": {
"putMarketingEmailTemplate": {
"id": 4,
"localId": 4,
"name": "xyz789",
"subject": "abc123",
"jsonTemplate": "abc123",
"htmlTemplate": "xyz789",
"hasPromotion": true
}
}
}
putRouteHold
Description
Update or Create a customer route hold. Requires access level: Sales Clerk
Response
Returns a CustomerRouteHold!
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
Id of the customer to create/update a route hold for |
input - CustomerRouteHoldInput!
|
A route hold to create/update |
Example
Query
mutation PutRouteHold(
$customerId: ID!,
$input: CustomerRouteHoldInput!
) {
putRouteHold(
customerId: $customerId,
input: $input
) {
id
localId
startDate
endDate
}
}
Variables
{"customerId": 4, "input": CustomerRouteHoldInput}
Response
{
"data": {
"putRouteHold": {
"id": 4,
"localId": 4,
"startDate": "abc123",
"endDate": "abc123"
}
}
}
putStorePlaceId
Description
Creates or updates a store place id
Response
Returns a Boolean!
Example
Query
mutation PutStorePlaceId(
$placeId: ID!,
$storesToAdd: [ID]!,
$storesToRemove: [ID]!
) {
putStorePlaceId(
placeId: $placeId,
storesToAdd: $storesToAdd,
storesToRemove: $storesToRemove
)
}
Variables
{
"placeId": "4",
"storesToAdd": [4],
"storesToRemove": ["4"]
}
Response
{"data": {"putStorePlaceId": false}}
putTaxConfigurationRule
Description
Update or Create a tax configuration rule. Requires access level: Sr Manager
Response
Returns a TaxConfigurationRule!
Arguments
| Name | Description |
|---|---|
input - TaxConfigurationRuleInput!
|
A rule to create/update |
Example
Query
mutation PutTaxConfigurationRule($input: TaxConfigurationRuleInput!) {
putTaxConfigurationRule(input: $input) {
id
localId
sort
parentRule
isDisabled
isDefault
name
rate
useAutoTaxJar
addressSpecific
zipCondition
departmentCondition
agentCondition
}
}
Variables
{"input": TaxConfigurationRuleInput}
Response
{
"data": {
"putTaxConfigurationRule": {
"id": "4",
"localId": 4,
"sort": 123,
"parentRule": "4",
"isDisabled": false,
"isDefault": false,
"name": "abc123",
"rate": 987.65,
"useAutoTaxJar": true,
"addressSpecific": false,
"zipCondition": "abc123",
"departmentCondition": ["abc123"],
"agentCondition": ["xyz789"]
}
}
}
redeemReward
Description
Redeems a reward for a customer
removeCustomerFromRoute
Description
Removes a customer from their current route
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
|
preference - CustomerDeliveryPreferenceEnum
|
New delivery preference (optional, defaults to NO_PREFERENCE) |
Example
Query
mutation RemoveCustomerFromRoute(
$customerId: ID!,
$preference: CustomerDeliveryPreferenceEnum
) {
removeCustomerFromRoute(
customerId: $customerId,
preference: $preference
)
}
Variables
{"customerId": 4, "preference": "NO_PREFERENCE"}
Response
{"data": {"removeCustomerFromRoute": true}}
removeUserFromChatRoom
Description
Remove a chat user from a room
Response
Returns a Boolean!
Example
Query
mutation RemoveUserFromChatRoom(
$roomId: ID!,
$userId: ID!
) {
removeUserFromChatRoom(
roomId: $roomId,
userId: $userId
)
}
Variables
{"roomId": 4, "userId": 4}
Response
{"data": {"removeUserFromChatRoom": false}}
requestMagicLink
Description
Takes an email and sends a magic link to the email address
requestRouteRegular
Description
A customer requests to be assigned to a regular route. Requires access level: Customer
Response
Returns a Boolean
Example
Query
mutation RequestRouteRegular {
requestRouteRegular
}
Response
{"data": {"requestRouteRegular": true}}
scheduleMarketingBroadcast
Description
Schedules a marketing broadcast
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
marketingBroadcast - MarketingBroadcastInput!
|
The broadcast to schedule |
Example
Query
mutation ScheduleMarketingBroadcast($marketingBroadcast: MarketingBroadcastInput!) {
scheduleMarketingBroadcast(marketingBroadcast: $marketingBroadcast)
}
Variables
{"marketingBroadcast": MarketingBroadcastInput}
Response
{"data": {"scheduleMarketingBroadcast": true}}
selectCustomerSubscription
Description
Creates a subscription invoice & sets the subscription status to 'pending'. Requires access level: Customer or Admin
Response
Returns a CustomerSubscription
Example
Query
mutation SelectCustomerSubscription(
$customerId: ID!,
$subscriptionId: ID!
) {
selectCustomerSubscription(
customerId: $customerId,
subscriptionId: $subscriptionId
) {
id
localId
pending {
id
localId
saleId
price
start
end
}
active {
id
localId
saleId
price
start
end
}
log {
id
localId
date
event
description
user {
...UserFragment
}
}
renewalDate
}
}
Variables
{"customerId": "4", "subscriptionId": 4}
Response
{
"data": {
"selectCustomerSubscription": {
"id": 4,
"localId": 4,
"pending": CustomerSubscriptionEntry,
"active": CustomerSubscriptionEntry,
"log": [CustomerSubscriptionLog],
"renewalDate": "2007-12-03T10:15:30Z"
}
}
}
sendCustomerMessage
Description
Sends a message from a customer to the cleaner and adds it to the contact log
Example
Query
mutation SendCustomerMessage(
$customerId: ID!,
$message: String!
) {
sendCustomerMessage(
customerId: $customerId,
message: $message
)
}
Variables
{
"customerId": "4",
"message": "xyz789"
}
Response
{"data": {"sendCustomerMessage": false}}
sendCustomerNegativeFeedback
Description
Sends a negative feedback on an order from a customer to the cleaner and adds it to the contact log
Example
Query
mutation SendCustomerNegativeFeedback(
$customerId: ID!,
$message: String!
) {
sendCustomerNegativeFeedback(
customerId: $customerId,
message: $message
)
}
Variables
{"customerId": 4, "message": "xyz789"}
Response
{"data": {"sendCustomerNegativeFeedback": true}}
sendCustomerPasswordResetLink
Description
Sends a password reset email to the provided customer
Example
Query
mutation SendCustomerPasswordResetLink($customerId: ID!) {
sendCustomerPasswordResetLink(customerId: $customerId)
}
Variables
{"customerId": "4"}
Response
{"data": {"sendCustomerPasswordResetLink": true}}
sendCustomerSignupText
Description
Sends a text with a signup link to a provided customer phone number.
Response
Returns a Boolean
Example
Query
mutation SendCustomerSignupText(
$phone: String!,
$fromKiosk: Boolean
) {
sendCustomerSignupText(
phone: $phone,
fromKiosk: $fromKiosk
)
}
Variables
{"phone": "xyz789", "fromKiosk": false}
Response
{"data": {"sendCustomerSignupText": false}}
sendFeedbackClickTracking
Description
Send feedback click tracking for Feedback Email/Sms
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
feedbackClickTracking - FeedbackClickTrackingInput!
|
Example
Query
mutation SendFeedbackClickTracking($feedbackClickTracking: FeedbackClickTrackingInput!) {
sendFeedbackClickTracking(feedbackClickTracking: $feedbackClickTracking)
}
Variables
{"feedbackClickTracking": FeedbackClickTrackingInput}
Response
{"data": {"sendFeedbackClickTracking": true}}
sendKioskAlreadyInUseText
Description
Sends a text that the kiosk is already in use to a provided customer phone number.
sendMarketingBroadcast
Description
Sends a marketing broadcast
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
marketingBroadcast - MarketingBroadcastInput!
|
The broadcast to send |
Example
Query
mutation SendMarketingBroadcast($marketingBroadcast: MarketingBroadcastInput!) {
sendMarketingBroadcast(marketingBroadcast: $marketingBroadcast)
}
Variables
{"marketingBroadcast": MarketingBroadcastInput}
Response
{"data": {"sendMarketingBroadcast": false}}
sendReviewReply
Description
Sends a reply to a review
Response
Returns a ReviewReply
Example
Query
mutation SendReviewReply(
$reviewId: String!,
$reviewName: String!,
$reply: String!
) {
sendReviewReply(
reviewId: $reviewId,
reviewName: $reviewName,
reply: $reply
) {
id
localId
comment
updateTime
replierName
}
}
Variables
{
"reviewId": "xyz789",
"reviewName": "abc123",
"reply": "abc123"
}
Response
{
"data": {
"sendReviewReply": {
"id": "4",
"localId": "4",
"comment": "abc123",
"updateTime": "abc123",
"replierName": "xyz789"
}
}
}
sendTestMarketingBroadcast
Description
Sends a test marketing broadcast
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - MarketingBroadcastInput!
|
The test broadcast to send |
Example
Query
mutation SendTestMarketingBroadcast($input: MarketingBroadcastInput!) {
sendTestMarketingBroadcast(input: $input)
}
Variables
{"input": MarketingBroadcastInput}
Response
{"data": {"sendTestMarketingBroadcast": true}}
setCurrentCustomer
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
A customer ID to be logged in |
Example
Query
mutation SetCurrentCustomer($customerId: ID!) {
setCurrentCustomer(customerId: $customerId) {
id
localId
name
futureAppointments {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
group {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
agent {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
routeHolds {
id
localId
startDate
endDate
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultDeliveryAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
id
localId
type
last4
expm
expy
status {
...CreditCardStatusFragment
}
}
datesForSchedulingAppointment {
id
localId
date
timeSlots {
...TimeSlotFragment
}
}
unpaidOrders {
id
localId
orders {
...OrderFragment
}
duePayment {
...DuePaymentFragment
}
}
finishedPayments {
id
localId
total
date
receiptLink
}
customerBookings {
id
localId
pickupAppointment {
...AppointmentFragment
}
deliveryAppointment {
...AppointmentFragment
}
detailedCustomerOrder {
...DetailedCustomerOrderFragment
}
orders {
...OrderFragment
}
pickupDateDisplay
deliveryDateDisplay
pickupDateTitle
deliveryDateTitle
statusText
status
progress
bookingDate
lockerId
lockerLabel
}
stagingDetailedCustomerOrder {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
readyBags {
id
localId
barcode
display
order {
...OrderFragment
}
location {
...RackLogFragment
}
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
subscription {
id
localId
pending {
...CustomerSubscriptionEntryFragment
}
active {
...CustomerSubscriptionEntryFragment
}
log {
...CustomerSubscriptionLogFragment
}
renewalDate
}
subscriptionUsage {
id
localId
type
limit
usage
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
customFields {
id
localId
label
value
}
isInSignupProcess
paymentStatus {
id
localId
paymentReference
paymentStatus
}
wardrobeCategories {
id
localId
name
sort
description
disabled
isRetail
}
wardrobeItems {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
paymentPreference
rewardPoints
rewards {
id
localId
date
amount
status
expiryDate
redeemDate
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
communication {
id
localId
direction
type
date
subject
staff {
...UserFragment
}
contactFlag
body
}
}
}
Variables
{"customerId": "4"}
Response
{
"data": {
"setCurrentCustomer": {
"id": 4,
"localId": "4",
"name": "xyz789",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "abc123",
"preferences": [4],
"goodOnlineAccountStanding": true,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": false,
"creditCardIFrameURL": "xyz789",
"authenticatedCustomerSiteLink": "abc123",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": false,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 123,
"demographic": 123,
"apiTokenForCustomer": "abc123",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "xyz789",
"cellPhone": "xyz789",
"cellPhoneDisplay": "xyz789",
"homePhone": "abc123",
"activePhone": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"companyName": "abc123",
"fullName": "xyz789",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": true,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 123.45,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": false,
"deliveryNotes": [Note],
"communication": [Communication]
}
}
}
setStation
Description
Try to assign this computer to a station. On success, the secret key is returned that the client should store in the cookie 'smrt_stkey' for authentication. If your IP is not whitelisted, you must provide a user entered auth code as argument. Simply try the endpoint and on error, ask the user to input an auth code. The endpoint will also give an error if the auth key is invalid.
Response
Returns a String!
Example
Query
mutation SetStation(
$stationId: String!,
$authCode: String
) {
setStation(
stationId: $stationId,
authCode: $authCode
)
}
Variables
{
"stationId": "xyz789",
"authCode": "abc123"
}
Response
{"data": {"setStation": "xyz789"}}
sortDeliveryStops
Description
Sort delivery stops
Response
Returns [Customer]!
Example
Query
mutation SortDeliveryStops(
$routeId: ID!,
$sortedStopIds: [ID]!
) {
sortDeliveryStops(
routeId: $routeId,
sortedStopIds: $sortedStopIds
) {
id
localId
name
futureAppointments {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
group {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
agent {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
routeHolds {
id
localId
startDate
endDate
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultDeliveryAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
id
localId
type
last4
expm
expy
status {
...CreditCardStatusFragment
}
}
datesForSchedulingAppointment {
id
localId
date
timeSlots {
...TimeSlotFragment
}
}
unpaidOrders {
id
localId
orders {
...OrderFragment
}
duePayment {
...DuePaymentFragment
}
}
finishedPayments {
id
localId
total
date
receiptLink
}
customerBookings {
id
localId
pickupAppointment {
...AppointmentFragment
}
deliveryAppointment {
...AppointmentFragment
}
detailedCustomerOrder {
...DetailedCustomerOrderFragment
}
orders {
...OrderFragment
}
pickupDateDisplay
deliveryDateDisplay
pickupDateTitle
deliveryDateTitle
statusText
status
progress
bookingDate
lockerId
lockerLabel
}
stagingDetailedCustomerOrder {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
readyBags {
id
localId
barcode
display
order {
...OrderFragment
}
location {
...RackLogFragment
}
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
subscription {
id
localId
pending {
...CustomerSubscriptionEntryFragment
}
active {
...CustomerSubscriptionEntryFragment
}
log {
...CustomerSubscriptionLogFragment
}
renewalDate
}
subscriptionUsage {
id
localId
type
limit
usage
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
customFields {
id
localId
label
value
}
isInSignupProcess
paymentStatus {
id
localId
paymentReference
paymentStatus
}
wardrobeCategories {
id
localId
name
sort
description
disabled
isRetail
}
wardrobeItems {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
paymentPreference
rewardPoints
rewards {
id
localId
date
amount
status
expiryDate
redeemDate
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
communication {
id
localId
direction
type
date
subject
staff {
...UserFragment
}
contactFlag
body
}
}
}
Variables
{"routeId": 4, "sortedStopIds": ["4"]}
Response
{
"data": {
"sortDeliveryStops": [
{
"id": "4",
"localId": 4,
"name": "xyz789",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "abc123",
"preferences": ["4"],
"goodOnlineAccountStanding": false,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": false,
"creditCardIFrameURL": "abc123",
"authenticatedCustomerSiteLink": "xyz789",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": false,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 987,
"demographic": 123,
"apiTokenForCustomer": "xyz789",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "abc123",
"cellPhone": "abc123",
"cellPhoneDisplay": "xyz789",
"homePhone": "abc123",
"activePhone": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"companyName": "abc123",
"fullName": "abc123",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": false,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 123.45,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": false,
"deliveryNotes": [Note],
"communication": [Communication]
}
]
}
}
sortItemValidationRules
Description
Sort item validation rules. Requires access level: Sr Manager
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
sortedRuleIds - [ID]!
|
A list of sorted rule ids |
Example
Query
mutation SortItemValidationRules($sortedRuleIds: [ID]!) {
sortItemValidationRules(sortedRuleIds: $sortedRuleIds)
}
Variables
{"sortedRuleIds": ["4"]}
Response
{"data": {"sortItemValidationRules": false}}
sortTaxConfigurationRules
Description
Sort tax configuration rules. Requires access level: Sr Manager
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
sortedRuleIds - [ID]!
|
A list of sorted rule ids |
Example
Query
mutation SortTaxConfigurationRules($sortedRuleIds: [ID]!) {
sortTaxConfigurationRules(sortedRuleIds: $sortedRuleIds)
}
Variables
{"sortedRuleIds": ["4"]}
Response
{"data": {"sortTaxConfigurationRules": false}}
startRouteOptimization
Description
Schedules a background job for automatic optimizing of a route.
Response
Returns a Boolean
Example
Query
mutation StartRouteOptimization(
$routeId: ID!,
$date: Int
) {
startRouteOptimization(
routeId: $routeId,
date: $date
)
}
Variables
{"routeId": "4", "date": 123}
Response
{"data": {"startRouteOptimization": false}}
startTextSignIn
Description
Takes either a phone number or an email and sends a sign in code to the user
Response
Returns a StartTextSignInResponse
Example
Query
mutation StartTextSignIn(
$phoneNumber: String,
$email: String
) {
startTextSignIn(
phoneNumber: $phoneNumber,
email: $email
) {
id
localId
phoneNumber
email
authProcess
}
}
Variables
{
"phoneNumber": "abc123",
"email": "xyz789"
}
Response
{
"data": {
"startTextSignIn": {
"id": "4",
"localId": 4,
"phoneNumber": "abc123",
"email": "xyz789",
"authProcess": "LOGIN_ONGOING"
}
}
}
stationSignIn
Description
Staff station sign-in. Requires a valid station cookie.
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
signInMethod - StationSignInMethodEnum!
|
|
secret - String!
|
The user's password, pin code or badge barcode depending on the sign-in method |
username - String
|
Required if signing in with password |
Example
Query
mutation StationSignIn(
$signInMethod: StationSignInMethodEnum!,
$secret: String!,
$username: String
) {
stationSignIn(
signInMethod: $signInMethod,
secret: $secret,
username: $username
) {
id
localId
name
firstName
}
}
Variables
{
"signInMethod": "password",
"secret": "xyz789",
"username": "abc123"
}
Response
{
"data": {
"stationSignIn": {
"id": 4,
"localId": 4,
"name": "xyz789",
"firstName": "abc123"
}
}
}
terminatePayment
Description
Terminates an ongoing payment
Response
Returns a PaymentStatus!
Example
Query
mutation TerminatePayment(
$customerId: String!,
$paymentReference: String!
) {
terminatePayment(
customerId: $customerId,
paymentReference: $paymentReference
) {
id
localId
paymentReference
paymentStatus
}
}
Variables
{
"customerId": "abc123",
"paymentReference": "xyz789"
}
Response
{
"data": {
"terminatePayment": {
"id": 4,
"localId": 4,
"paymentReference": "xyz789",
"paymentStatus": "AUTHORIZED"
}
}
}
unloadTicketsOnMPArm
Description
Unload tickets for a specific arm
Response
Returns a Boolean
Example
Query
mutation UnloadTicketsOnMPArm(
$tickets: [String]!,
$unloadArm: String!
) {
unloadTicketsOnMPArm(
tickets: $tickets,
unloadArm: $unloadArm
)
}
Variables
{
"tickets": ["xyz789"],
"unloadArm": "abc123"
}
Response
{"data": {"unloadTicketsOnMPArm": true}}
updateHoliday
Description
Update or Create a holiday (set it open, closed or no delivery) Requires access level: Sr Manager
Response
Returns a Holiday!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of the holiday to update |
input - HolidayInput!
|
The holiday data to update |
Example
Query
mutation UpdateHoliday(
$id: ID!,
$input: HolidayInput!
) {
updateHoliday(
id: $id,
input: $input
) {
id
localId
date
noProduction
noDelivery
dayOfWeek
}
}
Variables
{"id": 4, "input": HolidayInput}
Response
{
"data": {
"updateHoliday": {
"id": "4",
"localId": 4,
"date": "xyz789",
"noProduction": false,
"noDelivery": true,
"dayOfWeek": "abc123"
}
}
}
updatePhoto
Description
Updates an existing photo's description
Response
Returns a Photo
Arguments
| Name | Description |
|---|---|
input - UpdatePhotoInput!
|
Example
Query
mutation UpdatePhoto($input: UpdatePhotoInput!) {
updatePhoto(input: $input) {
id
localId
status
thumbnailUrl
smallUrl
largeUrl
description
}
}
Variables
{"input": UpdatePhotoInput}
Response
{
"data": {
"updatePhoto": {
"id": 4,
"localId": 4,
"status": "xyz789",
"thumbnailUrl": "abc123",
"smallUrl": "abc123",
"largeUrl": "xyz789",
"description": "abc123"
}
}
}
updateSettings
Description
Update settings, global to the business or a scope such as brand, group or customer. Returns a list of messages for user display.
Response
Returns [String]
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
Id of the node to update a setting for (a customer, business etc) |
input - SettingsInput!
|
the settings to update |
Example
Query
mutation UpdateSettings(
$nodeId: ID!,
$input: SettingsInput!
) {
updateSettings(
nodeId: $nodeId,
input: $input
)
}
Variables
{"nodeId": 4, "input": SettingsInput}
Response
{"data": {"updateSettings": ["abc123"]}}
validateAddress
Description
Validates an address.
Response
Returns a CustomerAddress
Arguments
| Name | Description |
|---|---|
input - AddressValidationInput!
|
An address to validate |
Example
Query
mutation ValidateAddress($input: AddressValidationInput!) {
validateAddress(input: $input) {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
id
localId
status
thumbnailUrl
smallUrl
largeUrl
description
}
}
}
Variables
{"input": AddressValidationInput}
Response
{
"data": {
"validateAddress": {
"id": 4,
"localId": "4",
"name": "abc123",
"streetAddress": "abc123",
"streetAddress2": "abc123",
"city": "xyz789",
"state": "xyz789",
"zip": "xyz789",
"country": "abc123",
"latitude": "abc123",
"longitude": "abc123",
"skipVerification": false,
"manualLocation": false,
"note": "xyz789",
"photo": Photo
}
}
}
validateCustomerCredentials
Description
validate customer email and password.
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
input - ValidateCustomerCredentialsInput!
|
Customer Credentials (email & password) to validate |
Example
Query
mutation ValidateCustomerCredentials($input: ValidateCustomerCredentialsInput!) {
validateCustomerCredentials(input: $input) {
id
localId
name
futureAppointments {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
group {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
agent {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
routeHolds {
id
localId
startDate
endDate
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultDeliveryAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
id
localId
type
last4
expm
expy
status {
...CreditCardStatusFragment
}
}
datesForSchedulingAppointment {
id
localId
date
timeSlots {
...TimeSlotFragment
}
}
unpaidOrders {
id
localId
orders {
...OrderFragment
}
duePayment {
...DuePaymentFragment
}
}
finishedPayments {
id
localId
total
date
receiptLink
}
customerBookings {
id
localId
pickupAppointment {
...AppointmentFragment
}
deliveryAppointment {
...AppointmentFragment
}
detailedCustomerOrder {
...DetailedCustomerOrderFragment
}
orders {
...OrderFragment
}
pickupDateDisplay
deliveryDateDisplay
pickupDateTitle
deliveryDateTitle
statusText
status
progress
bookingDate
lockerId
lockerLabel
}
stagingDetailedCustomerOrder {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
readyBags {
id
localId
barcode
display
order {
...OrderFragment
}
location {
...RackLogFragment
}
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
subscription {
id
localId
pending {
...CustomerSubscriptionEntryFragment
}
active {
...CustomerSubscriptionEntryFragment
}
log {
...CustomerSubscriptionLogFragment
}
renewalDate
}
subscriptionUsage {
id
localId
type
limit
usage
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
customFields {
id
localId
label
value
}
isInSignupProcess
paymentStatus {
id
localId
paymentReference
paymentStatus
}
wardrobeCategories {
id
localId
name
sort
description
disabled
isRetail
}
wardrobeItems {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
paymentPreference
rewardPoints
rewards {
id
localId
date
amount
status
expiryDate
redeemDate
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
communication {
id
localId
direction
type
date
subject
staff {
...UserFragment
}
contactFlag
body
}
}
}
Variables
{"input": ValidateCustomerCredentialsInput}
Response
{
"data": {
"validateCustomerCredentials": {
"id": "4",
"localId": "4",
"name": "xyz789",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "xyz789",
"preferences": ["4"],
"goodOnlineAccountStanding": true,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": false,
"creditCardIFrameURL": "xyz789",
"authenticatedCustomerSiteLink": "xyz789",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": true,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 123,
"demographic": 123,
"apiTokenForCustomer": "abc123",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "xyz789",
"cellPhone": "xyz789",
"cellPhoneDisplay": "abc123",
"homePhone": "abc123",
"activePhone": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"companyName": "abc123",
"fullName": "xyz789",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": false,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 123.45,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": true,
"deliveryNotes": [Note],
"communication": [Communication]
}
}
}
validateCustomerKioskCredentials
Description
Validate customer phone and kiosk access code.
Response
Returns a Customer
Example
Query
mutation ValidateCustomerKioskCredentials(
$phone: String!,
$accessCode: String!
) {
validateCustomerKioskCredentials(
phone: $phone,
accessCode: $accessCode
) {
id
localId
name
futureAppointments {
id
localId
startTime
endTime
timeSlot {
...TimeSlotFragment
}
scheduledBy {
...ActorFragment
}
scheduledAt
route {
...RouteFragment
}
driverInstructions
cleaningInstructions
departments {
...FinancialDepartmentFragment
}
customer {
...CustomerFragment
}
address {
...CustomerAddressFragment
}
driver {
...UserFragment
}
regular
anytime
status
appointmentLinkId
photos {
...PhotoFragment
}
lockerCode
locationLabel
vehicleStatus {
...DeliveryVehicleStatusFragment
}
stopNumber
deliveryPhoto {
...PhotoFragment
}
}
settings {
id
localId
mainDeliveryStore {
...StoreFragment
}
mainStore {
...StoreFragment
}
quickDetailingItemTypes {
...ItemTypeFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
acceptedPaymentMethods {
...PaymentMethodFragment
}
logo
receiptLogo
POSNewOrderTabs
deliveryNewOrderTabs
statementGenerationDays
invoiceGenerationDays
acceptedCards
automaticSurcharges {
...AutomaticSurchargeFragment
}
detailingAttributes
marketingCampaigns {
...CampaignSettingFragment
}
welcomeNewCustomerCampaign {
...WelcomeNewCustomerCampaignFragment
}
thankYouCampaign {
...ThankYouCampaignFragment
}
arPastDueCampaign {
...ArPastDueCampaignFragment
}
counterToRouteCampaign {
...CounterToRouteCampaignFragment
}
monthlyNewsletterCampaign {
...MonthlyNewsletterCampaignFragment
}
happyAnniversaryCampaign {
...HappyAnniversaryCampaignFragment
}
inventoryReminderCampaign {
...InventoryReminderCampaignFragment
}
oneAndDoneCampaign {
...OneAndDoneCampaignFragment
}
marketingByDepartmentCampaign {
...MarketingByDepartmentCampaignFragment
}
thankYouTopSpendersCampaign {
...ThankYouTopSpendersCampaignFragment
}
newCustomerRetentionCampaign {
...NewCustomerRetentionCampaignFragment
}
customerSignupNoOrdersCampaign {
...CustomerSignupNoOrdersCampaignFragment
}
noOrdersSinceLastCampaign {
...NoOrdersSinceLastCampaignFragment
}
updateYourInformationCampaign {
...UpdateYourInformationCampaignFragment
}
quarterlyComforterCampaign {
...QuarterlyComforterCampaignFragment
}
thankYouNewReviewCampaign {
...ThankYouNewReviewCampaignFragment
}
lostBigCustomerCampaign {
...LostBigCustomerCampaignFragment
}
reviewGenerationCampaign {
...ReviewGenerationCampaignFragment
}
customCampaign {
...CustomCampaignFragment
}
snapshotEmailList {
...SnapshotEmailListFragment
}
businessName
dateFormat
countryCode
timeZone
locale
contactAddressLine
contactAddressState
contactAddressCity
contactAddressZip
contactPhone
logoUrl
noProductionDays
noDeliveryDays
specialHolidays
openDetailingWithCategory
customerFacingDomain
customSignupUrl
contactEmail
twilioAccountSid
twilioAuthToken
twilioPhone
twilioPhoneLookup
whatsAppEnabled
sendSmsOptOutInformation
userNameOnEmailSubject
payableEntity
emailFooter
lockerBuildingCode
communicationTemplatesId
vcardTemplate
newPickupScheduledInstructions
sendAutomatedMessages
sendStatementEmails
signupEmailRequired
signupGroupRequired
signupAutofillCity
signupAddressRequired
signupPhoneRequired
allowOrderSplitting
groupOnDetailingSplit
offerStoreDelivery
offerDeliverySchedulingInText
useStoreZipCodeForTax
summarizeByBillingCode
showSalesTaxBreakdownForStatementOrders
sumOrderTotalOnStatements
simplifiedPaymentReceipt
cashTotalRounding
hasLogo
isHotel
isHotelProcessor
isRoomGroupHotel
isLockers
isValet
isWholesaler
pickupUnpaidOrders
pressOnlyDiscount
scheduleWillCallAtAssembly
scheduleWillCallOnDueDate
dontIncludeOrdersInDeliveryListBeforeDueDate
geoFencingEnabled
allowSubDeliveryAccountScheduling
allowSubAccountToTriggerMasterDelivery
sendAutopayReceipts
sendDeliveryAppointmentConfirmation
showDeliveryNotPaid
deliveryAppLoadListSortDescending
requireSignatureOnDelivery
requirePhotoOnDelivery
showSubRouteForDeliveryStop
genericLaundryBagMode
rushNotificationsHour
websiteDisplayText
shouldShowWebsiteOnReceipts
showAgentOnBagTag
assemblyEvenOnly
voiceAssemblyEnabled
inspectPriceAtAssembly
assemblyPrintFinancialReceiptForDeliveryCustomer
assemblyAlwaysPrintFinancialReceipt
printFinancialTicketOutsideAssembly
keepRackAssignmentOnOrderSplit
complexLotControl
overrideDueDateWithNextDelivery
autoSelectDeliveryReturnLocation
defaultDetailingTab
autoOpenAnnotationType
requireInvoiceInDetailing
displayTooManyDetailedItemsWarning
assemblyIcon
alignAssemblyIcon
newCustomerTicketIcon
newCustomerBottomTicketIcon
customerNameOnTicketBottom
pieceCountOnTicketBottom
customerPhoneOnTicket
showRoomInfoBelowAddress
laundryLicense
summarizedItemTable
showLogoOnReceipts
logoOnReceiptHeight
receiptLogoName
showPriceOnAssembly
paymentReceiptShowSignatureLine
receiptsNameShort
newLocationOnTicket
showRouteOfSameDayDelivery
itemDetailsOnTicket
itemDetailsOnOrderReceipt
newOrderPrintCount
printRetailReceipts
printDropTicketOnOrderSplit
printTicketOnOrderCloseCount
noStoreContactInfoOnReceipts
noPricingOnOrderReceipts
receiptsFooter
thermalReceiptFooter
ticketReceiptFooter
showEmailOnReceipts
showWebsiteOnReceipts
invoicePayableLine
invoiceTerms
isRestorationAccount
offerDemandDelivery
autoAddNewCustomerToWillCallRoute
groupItemDetailsByRoomNumber
merchantBatchCloseTime
saveCardsOnFile
amexSeparately
maxAutopayAmount
maxPaymentAmountWarning
autopayTerms
autopayStatements
autopayBatchStrategy
invoiceDueDays
consolidateInvoiceItemDetails
invoiceShowOrderDetails
invoiceHideOrderInfo
showDateOnStatement
callStatementInvoice
activitySummaryEnabled
attachPDFInStatementEmails
rewardsProgramEnabled
rewardsPointModifier
rewardsCurrencyModifier
rewardsConversionRequirement
rewardsRedeemAutomatically
rewardsEmailRequired
rewardsPhoneRequired
rewardsAddressRequired
rewardsCreditCardRequired
welcomeNotificationDisabled
autoTicketOnCustomerRegistration
autoTicketOnScheduledDelivery
sendCustomerUpdatedCCNotification
allowScheduleBothPickupAndDelivery
limitScheduleDeliveryToClosestRoute
allowRouteRegularCustomersToScheduleOnDemand
allowSameDaySchedulingEvenIfRouteStarted
experimentalPhotoUserExperienceOnWebsiteScheduler
priceListUpdateOrdersCondition
routeAgentPriority
commonOrdersAgent
isMailOrderPickups
lockerDropBinPickupMode
showYesRepliesInComm
autoReplyToYesRepliesInComm
customerWebsiteClothesTrackerTabEnabled
customerWebsiteWardrobeTabEnabled
customerWebsitePaymentTabEnabled
metalprogettiAssemblyLabelTemplate
metalprogettiSendRackSpaceToStorage
rushOrderSurcharge
rushOrderSurchargeTier2
sendNewOrderNotificationOnEveryVisit
includeReceiptInNewOrderNotification
printTempTagsForBarcodedItems
alwaysGenerateTemporaryBarcodes
zebraPrinterTemplate
epsonPrinterTemplate
forceOnlyBagFieldInput
detailingWithoutBarcodes
printLabelsWhenDuplicating
metalprogettiStripCharacters
autoDetailingEnabled
minItemBarcodeLength
maxItemBarcodeLength
quotesDeletionTimeFrame
minWashNFoldPrice
minWashNFoldWeight
washAndFoldWeightStations
departmentSpecificOrdersEnabled
manualPickupRestricted
displayDueDateInProductionModules
filterDetailingByItemTypes
automaticallyFilterReportsToEmployeesStore
payrollPeriod
payrollLastCloseDate
payrollFirstHalfCloseDate
payrollLastHalfCloseDate
payrollCloseDate
workweekStart
hoursUntilWeeklyOvertime
hoursUntilDailyOvertime
hoursUntilDailyDoubleTime
hoursUntilWeeklyNotification
hoursUntilDailyNotification
preventClockInBeforeTime
californiaOvertimeRules
promptForClockInOnLogin
overrideTimeClockWithUserDepartment
allowMobileAppClockIn
disableOverTimeNotifications
overnightClockOut
inventorySystemEnabled
inventorySystemEnabledProduction
permissionManageSystemSettings
permissionManageMarketing
permissionManageStationSettings
permissionAccessCustomerCredits
permissionAddCustomerDiscount
permissionAccessCustomerModule
permissionAccessDeliveryModule
permissionAccessAssemblyModule
permissionAccessSpottingModule
permissionAccessAlterAndRepairModule
permissionAccessAccountsReceivableModule
permissionAccessPressingModule
permissionAccessPriceListModule
permissionAccessCashBoxModule
permissionAccessTimeclockModule
permissionAccessPerformanceModule
permissionAccessWashAndFoldModule
permissionAccessInspectionModule
permissionAccessItemBaggingModule
permissionAccessFoldingAndBaggingModule
permissionAccessMessagesModule
permissionAccessRackingModule
permissionAccessRouteManagerModule
permissionAccessReportsModule
permissionAccessAdminReportsModule
permissionAccessIssueTrackerModule
permissionAccessSupportModule
permissionAccessEmployeeSettingsModule
permissionAccessBulkMarkinModule
permissionManualPriceEdits
permissionSpecialCareAfterOrderClose
permissionResetOrder
permissionRemoveItems
showStrikeThroughWhenReturned
usePieceCountTotalsOnTicket
taxHeaderString
includeTaxInPrice
dropDateOnAssemblyTicket
displayDepartmentOnTicket
displayCategoryOnTicket
displayPriceOnPickupSlip
useStoreSpecificOrderSequenceNumbers
showStoreSpecificOrderNumberOnTop
saleItemLedgerTrackingEnabled
inOnboarding
noCcCustomerText
pickupReminderOfferCancellations
pickupReminderEnabledForInactiveCustomers
offersRetailDelivery
regRouteQuestionChecked
pickupReminderHour24
pickupReminderIncludeDeliveries
deliveryCompleteConfirmation
defaultCustomerPaymentType
promptOnCardAvsFailure
minCardChargeAmount
defaultCustomerPriceList
cardSurcharging
cardSurchargeFixedPercentage
organizationNumber
fullstoryEnabled
initializedInferred
cashBoxMode
cashBoxModeProduction
displayExtendedStationReceiptInfo
displayExtendedZReportInfo
twilioMarketingNumber
campaignsEnabled
broadcastsEnabled
reviewModuleEnabled
defaultLanguage
weightUnit
segmentWriteKey
socialId
twilioReviewNumber
}
group {
id
localId
agentId
agentType
name
merchant {
...MerchantFragment
}
isStripeEnabled
hasOwnAgent
isGroupStop
isMasterBilling
customers {
...CustomerFragment
}
}
agent {
id
localId
name
agentId
agentType
isStripeEnabled
merchant {
...MerchantFragment
}
}
routeHolds {
id
localId
startDate
endDate
}
driverInstructions
preferences
goodOnlineAccountStanding
addresses {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
defaultDeliveryAddress {
id
localId
name
streetAddress
streetAddress2
city
state
zip
country
latitude
longitude
skipVerification
manualLocation
note
photo {
...PhotoFragment
}
}
isMasterDeliveryAccount
creditCardIFrameURL
authenticatedCustomerSiteLink
creditCard {
id
localId
type
last4
expm
expy
status {
...CreditCardStatusFragment
}
}
datesForSchedulingAppointment {
id
localId
date
timeSlots {
...TimeSlotFragment
}
}
unpaidOrders {
id
localId
orders {
...OrderFragment
}
duePayment {
...DuePaymentFragment
}
}
finishedPayments {
id
localId
total
date
receiptLink
}
customerBookings {
id
localId
pickupAppointment {
...AppointmentFragment
}
deliveryAppointment {
...AppointmentFragment
}
detailedCustomerOrder {
...DetailedCustomerOrderFragment
}
orders {
...OrderFragment
}
pickupDateDisplay
deliveryDateDisplay
pickupDateTitle
deliveryDateTitle
statusText
status
progress
bookingDate
lockerId
lockerLabel
}
stagingDetailedCustomerOrder {
id
localId
customer {
...CustomerFragment
}
isStaging
detailedItemData {
...DetailedItemDataFragment
}
}
readyBags {
id
localId
barcode
display
order {
...OrderFragment
}
location {
...RackLogFragment
}
}
isRouteCustomer
customerRelationship
deliveryStop
demographic
apiTokenForCustomer
activePromotions {
id
localId
name
couponCode
customerCouponCode
disabled
validForMarketing
}
subscription {
id
localId
pending {
...CustomerSubscriptionEntryFragment
}
active {
...CustomerSubscriptionEntryFragment
}
log {
...CustomerSubscriptionLogFragment
}
renewalDate
}
subscriptionUsage {
id
localId
type
limit
usage
}
kioskAccessCode
email
cellPhone
cellPhoneDisplay
homePhone
activePhone
firstName
lastName
companyName
fullName
store {
id
localId
agentId
agentType
name
isStripeEnabled
merchant {
...MerchantFragment
}
phone
address
city
state
zip
latitude
longitude
externalStoreIdentifier
googlePlaceId
stations {
...StationFragment
}
hasCounterStation
}
customFields {
id
localId
label
value
}
isInSignupProcess
paymentStatus {
id
localId
paymentReference
paymentStatus
}
wardrobeCategories {
id
localId
name
sort
description
disabled
isRetail
}
wardrobeItems {
id
localId
type {
...ItemTypeFragment
}
barcode
brandDisplay
itemStatus {
...ItemStatusFragment
}
colors {
...ColorFragment
}
photo {
...PhotoFragment
}
}
paymentPreference
rewardPoints
rewards {
id
localId
date
amount
status
expiryDate
redeemDate
}
missingRewardSettingCriteria
isSubBilling
deliveryNotes {
id
localId
date
customer {
...CustomerFragment
}
message
mainCategory
subCategory
status
saleId
itemId
lastUpdated
dueDate
assignee {
...UserFragment
}
photos {
...PhotoFragment
}
}
communication {
id
localId
direction
type
date
subject
staff {
...UserFragment
}
contactFlag
body
}
}
}
Variables
{
"phone": "abc123",
"accessCode": "abc123"
}
Response
{
"data": {
"validateCustomerKioskCredentials": {
"id": 4,
"localId": "4",
"name": "xyz789",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "xyz789",
"preferences": ["4"],
"goodOnlineAccountStanding": true,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": true,
"creditCardIFrameURL": "abc123",
"authenticatedCustomerSiteLink": "abc123",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": false,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 987,
"demographic": 987,
"apiTokenForCustomer": "xyz789",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "xyz789",
"cellPhone": "xyz789",
"cellPhoneDisplay": "xyz789",
"homePhone": "abc123",
"activePhone": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"companyName": "xyz789",
"fullName": "abc123",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": true,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 987.65,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": false,
"deliveryNotes": [Note],
"communication": [Communication]
}
}
}
validatePhoneAndSendKioskSMSCode
Description
Checks if customer exists and sends SMS with login code.
Example
Query
mutation ValidatePhoneAndSendKioskSMSCode($phone: String!) {
validatePhoneAndSendKioskSMSCode(phone: $phone)
}
Variables
{"phone": "abc123"}
Response
{"data": {"validatePhoneAndSendKioskSMSCode": false}}
validateUniqueEmail
Description
Verifies that the email is unique in the system
verifyTextSignIn
Description
Verifies the code sent to user from startTextSignIn mutation and signs in or signs up a customer by phonenumber or email
Response
Returns a SignInTextStatusEnum
Arguments
| Name | Description |
|---|---|
phoneNumber - String
|
The active phone number of the customer to sign in or register |
email - String
|
The active email of the customer to sign in or register |
code - String!
|
The verification code received by SMS |
customerFields - SignUpCustomerFields
|
Values set to the customer upon registration |
Example
Query
mutation VerifyTextSignIn(
$phoneNumber: String,
$email: String,
$code: String!,
$customerFields: SignUpCustomerFields
) {
verifyTextSignIn(
phoneNumber: $phoneNumber,
email: $email,
code: $code,
customerFields: $customerFields
)
}
Variables
{
"phoneNumber": "abc123",
"email": "abc123",
"code": "abc123",
"customerFields": SignUpCustomerFields
}
Response
{"data": {"verifyTextSignIn": "LOGIN_ONGOING"}}
Types
Actor
AddressValidationInput
Description
An address to validate
Example
{
"streetAddress": "abc123",
"streetAddress2": "abc123",
"city": "abc123",
"state": "xyz789",
"zip": "xyz789"
}
Agent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Name of the Agent |
agentId - ID
|
Unique identifier for the Agent. Can be null for a Group, if the group is not an agent. |
agentType - String
|
The type of Agent. One of "Store", "Route" or "Group". Can be null for a Group, if the group is not an agent. |
isStripeEnabled - Boolean
|
If an agent is Stripe enabled |
merchant - Merchant
|
The merchant for the agent |
Example
{
"id": 4,
"localId": 4,
"name": "xyz789",
"agentId": "4",
"agentType": "abc123",
"isStripeEnabled": true,
"merchant": Merchant
}
AlertSubType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
masterTypeId - ID!
|
ID of the master Alert Type |
name - String!
|
Name of the Sub Type |
prefTicket - Boolean!
|
|
prefCustomer - Boolean!
|
|
prefDelivery - Boolean!
|
|
prefPressing - Boolean!
|
|
prefInspection - Boolean!
|
|
prefSpotting - Boolean!
|
|
prefAlteration - Boolean!
|
|
prefWashing - Boolean!
|
|
mpOffloadArm - String
|
|
active - Boolean!
|
Example
{
"id": 4,
"localId": "4",
"masterTypeId": "4",
"name": "xyz789",
"prefTicket": false,
"prefCustomer": true,
"prefDelivery": false,
"prefPressing": false,
"prefInspection": false,
"prefSpotting": true,
"prefAlteration": true,
"prefWashing": false,
"mpOffloadArm": "abc123",
"active": false
}
AlertSubTypeInput
Description
Defines an Alert Sub Type
Fields
| Input Field | Description |
|---|---|
id - ID
|
Only required for existing entries |
masterTypeId - ID!
|
ID of the master Alert Type |
name - String!
|
Name of the Sub Type. |
prefTicket - Boolean
|
|
prefCustomer - Boolean
|
|
prefDelivery - Boolean
|
|
prefPressing - Boolean
|
|
prefInspection - Boolean
|
|
prefSpotting - Boolean
|
|
prefAlteration - Boolean
|
|
prefWashing - Boolean
|
|
mpOffloadArm - String
|
|
active - Boolean!
|
Example
{
"id": 4,
"masterTypeId": "4",
"name": "xyz789",
"prefTicket": false,
"prefCustomer": false,
"prefDelivery": false,
"prefPressing": false,
"prefInspection": true,
"prefSpotting": true,
"prefAlteration": false,
"prefWashing": false,
"mpOffloadArm": "abc123",
"active": false
}
AlertType
Example
{
"id": 4,
"localId": "4",
"name": "xyz789",
"active": true
}
Annotation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
description - String!
|
Optional user provided description |
positionX - Int!
|
Annotation x coordinate on image or outline |
positionY - Int!
|
Annotation y coordinate on image or outline |
type - AnnotationTypeEnum!
|
Type of annotation |
Example
{
"id": 4,
"localId": "4",
"description": "xyz789",
"positionX": 987,
"positionY": 987,
"type": "spot"
}
AnnotationInput
Description
Item Annotation provided by customer, such as a spot, damage or note.
Fields
| Input Field | Description |
|---|---|
description - String
|
Optional user provided description |
x - Int!
|
Annotation x coordinate on image or outline |
y - Int!
|
Annotation y coordinate on image or outline |
type - AnnotationTypeEnum!
|
Type of annotation |
Example
{
"description": "xyz789",
"x": 987,
"y": 123,
"type": "spot"
}
AnnotationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"spot"
Appointment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
startTime - DateTime!
|
Start time of the appointment. For a business with only static routes, only the date is relevant. |
endTime - DateTime!
|
End time of the appointment. |
timeSlot - TimeSlot!
|
Time slot of the appointment. |
scheduledBy - Actor!
|
Who the appointment was scheduled by; the Customer, a Bot or a User (employee). |
scheduledAt - DateTime!
|
When the appointment was scheduled. For appointments scheduled by a bot, this may be in the middle of the night. This date is updated on edits of the appointment. |
route - Route!
|
The Delivery Route the appointment will/has run on. |
driverInstructions - String
|
Instructions for the driver |
cleaningInstructions - String
|
Instructions for cleaning |
departments - [FinancialDepartment]!
|
Financial departments if specified |
customer - Customer!
|
The customer the appointment belongs to. |
address - CustomerAddress
|
The address for the appointment. |
driver - User!
|
The driver the appointment is assigned to (or who eventually completed the appointment. |
regular - Boolean!
|
Whether this appointment is a recurring event that was scheduled automatically. |
anytime - Boolean!
|
If an appointment is marked anytime, it can happen at any time during the day, and the startTime/endTime is not relevant. |
status - AppointmentStatusEnum!
|
The status of the appointment |
appointmentLinkId - ID
|
A random string linking multiple appointments together |
photos - [Photo]
|
Photos attached to this appointment |
lockerCode - ID
|
A locker code if available |
locationLabel - ID
|
The human readable label of the locker code |
vehicleStatus - DeliveryVehicleStatus
|
Current status of the vehicle running this appointment. Will return null if outside the route time window, if the route hasn't started or if the pickup/delivery was completed |
stopNumber - Int!
|
The stop number |
deliveryPhoto - Photo
|
The photo taken by the driver after successful delivery |
Example
{
"id": "4",
"localId": "4",
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"timeSlot": TimeSlot,
"scheduledBy": Actor,
"scheduledAt": "2007-12-03T10:15:30Z",
"route": Route,
"driverInstructions": "xyz789",
"cleaningInstructions": "abc123",
"departments": [FinancialDepartment],
"customer": Customer,
"address": CustomerAddress,
"driver": User,
"regular": true,
"anytime": false,
"status": "incomplete",
"appointmentLinkId": "4",
"photos": [Photo],
"lockerCode": "4",
"locationLabel": 4,
"vehicleStatus": DeliveryVehicleStatus,
"stopNumber": 987,
"deliveryPhoto": Photo
}
AppointmentInput
Description
Create or update an appointment
Fields
| Input Field | Description |
|---|---|
id - ID
|
Only required for existing entries |
addressId - String!
|
ID of the address to pickup from or deliver to |
customerId - String!
|
ID of the customer |
selectedDate - Int!
|
Selected date (day in month) |
selectedMonth - Int!
|
Selected month (1-12) |
selectedYear - Int!
|
Selected year |
timeSlotId - String!
|
ID of the selected time slot. Set -1 if no time slot is selected (anytime will be set to true) |
routeId - String!
|
ID of the route associated with the selected time slot. |
driverInstructions - String
|
Instructions for the driver. 2500 character limit. |
cleaningInstructions - String
|
Instructions for cleaning. 2500 character limit. |
departmentIds - [String]
|
A list of financial department IDs |
appointmentLinkId - ID
|
A random string linking multiple appointments together |
photoIds - [ID]
|
A list of photo IDs to attach to the appointment |
putPhotos - [PhotoInput]
|
A list of photos to upload |
updatePhotos - [UpdatePhotoInput]
|
A list of photos to update |
regular - Boolean
|
If the appointment is regular |
lockerCode - ID
|
A locker code if available |
locationLabel - ID
|
The human readable label of the locker code |
Example
{
"id": "4",
"addressId": "abc123",
"customerId": "xyz789",
"selectedDate": 987,
"selectedMonth": 123,
"selectedYear": 987,
"timeSlotId": "abc123",
"routeId": "abc123",
"driverInstructions": "abc123",
"cleaningInstructions": "xyz789",
"departmentIds": ["xyz789"],
"appointmentLinkId": 4,
"photoIds": [4],
"putPhotos": [PhotoInput],
"updatePhotos": [UpdatePhotoInput],
"regular": true,
"lockerCode": 4,
"locationLabel": "4"
}
AppointmentStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"incomplete"
ArPastDueCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
dayToSend - Int!
|
The day of the month to send the message |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
Example
{
"id": 4,
"localId": "4",
"name": "xyz789",
"enabled": true,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"dayToSend": 987,
"email": "abc123",
"sms": "xyz789"
}
ArPastDueCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
dayToSend - Int!
|
The day of the month to send the message |
Example
{
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"email": "xyz789",
"sms": "xyz789",
"promotion": "xyz789",
"autoApplyPromo": false,
"updateInfo": UpdateInfoInput,
"dayToSend": 987
}
AutomaticSurcharge
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
surchargeId - ID
|
ID of the surcharge |
conditions - [AutomaticSurchargeCondition]
|
The conditions of the automatic surcharge |
Example
{
"id": "4",
"localId": "4",
"surchargeId": "4",
"conditions": [AutomaticSurchargeCondition]
}
AutomaticSurchargeCondition
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
type - String!
|
Condition type |
count - String
|
The count of the condition |
dateFilter - String
|
Definition of the date filter |
value - Boolean
|
The value of the condition |
Example
{
"id": 4,
"localId": "4",
"type": "xyz789",
"count": "abc123",
"dateFilter": "abc123",
"value": false
}
AutomaticSurchargeConditionInput
Description
Create or update an automatic surcharge condition
Example
{
"type": "abc123",
"count": "abc123",
"dateFilter": "xyz789",
"value": true
}
AutomaticSurchargeInput
Description
Create or update an automatic surcharge
Fields
| Input Field | Description |
|---|---|
surchargeId - ID
|
ID of the surcharge |
conditions - [AutomaticSurchargeConditionInput]
|
The conditions of the automatic surcharge |
Example
{
"surchargeId": 4,
"conditions": [AutomaticSurchargeConditionInput]
}
BagPackagingTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HANGER"
Boolean
Description
The Boolean scalar type represents true or false.
Bot
Brand
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Identifying name of the brand, not necessarily for display to Customers. Use settings.name to get what branding name should be displayed to the user instead. |
brandId - String!
|
Locally identifying id of the brand |
settings - Settings!
|
Settings for this brand. |
agents - [Agent]!
|
Agents for this brand. |
isWalled - Boolean!
|
Whether this brand is isolated from customers belonging to other brands. |
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"brandId": "xyz789",
"settings": Settings,
"agents": [Agent],
"isWalled": false
}
BrandInput
Description
Create / Update a brand
Example
{
"id": "4",
"name": "xyz789",
"agents": ["abc123"]
}
BuildRoute
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
barcode - String!
|
Bag barcode |
extraMessage - String!
|
Descriptive message status |
customerName - String!
|
Customer name |
Example
{
"id": 4,
"localId": "4",
"barcode": "abc123",
"extraMessage": "xyz789",
"customerName": "abc123"
}
BuildRouteActionInput
Description
The input for adding a bag to a route on a given day
Example
{
"barcode": 4,
"masterRouteId": "xyz789",
"day": "xyz789",
"vanRackId": "abc123"
}
Business
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of Business_subdomain |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
shortId - Int!
|
Short integer identifier, for example, SF Green Clean has '1'. This identifier is a part of all other Node identifiers pertaining to this business. For example, a Customer may have id 'Customer_1_1234' at SF Green Clean. |
subdomain - String!
|
Business subdomain of smrtapp.com, e.g sfgc. Also part of the primary business. |
settings - Settings!
|
Global Business Settings |
employeeSettings - Settings!
|
Global Employee Settings |
stores - [Store]!
|
Physical Stores |
storesForCurrentBrand - [Store]!
|
Physical Stores associated with the currently signed in customer based on their agent/brand |
communicationTemplatesList - [CommunicationTemplates]!
|
All CommunicationTemplates |
contactCommunicationTemplates - CommunicationTemplates!
|
The primary list of contact communication templates. |
employees - [User]!
|
All Employees |
routes - [Route]!
|
Delivery Routes |
routesOnDate - [Route!]!
|
Delivery routes that run on a specific date |
Arguments
|
|
groups - [Group]!
|
Customer Groups |
notes - [Note]!
|
Query for notes |
Arguments
|
|
brands - [Brand]!
|
If a business has multiple brands (usually operating stores with different brand names), those are included here. |
agents - [Agent]!
|
All agents associated with the business |
holidays - [Holiday]!
|
Chronological list of all current holidays |
itemCategories - [ItemCategory]!
|
All Item categories |
itemTypes - [ItemType]!
|
All Item types |
subscriptions - [ItemType]!
|
All Subscription types |
taxRates - [TaxRate]!
|
Tax rates by department, optionally for a specific customer |
Arguments
|
|
paymentMethods - [PaymentMethod]!
|
All POS Payment Methods |
taxConfigurationRules - [TaxConfigurationRule]!
|
Tax configuration rules |
itemValidationRules - [ItemValidationRule]!
|
A list of item validation rules |
itemFields - [ItemField]!
|
A list of item fields |
financialDepartments - [FinancialDepartment]!
|
A list of financial departments |
specialCares - [SpecialCare]!
|
A list of special cares (a.k.a. descriptors or upcharges) |
alertTypes - [AlertType]!
|
All Alert Types |
alertSubTypes - [AlertSubType]!
|
All Alert Sub Types |
chatRooms - [ChatRoom]!
|
A list of all public chat rooms |
customerFields - [CustomerField]!
|
A list of configured customer fields |
Arguments
|
|
usesPaymentSystem - Boolean
|
|
getCustomer - Customer
|
|
Arguments
|
|
getCustomers - [Customer]!
|
|
Arguments
|
|
getOrder - Order
|
|
Arguments
|
|
getAppointment - Appointment
|
A pickup or delivery appointment by ID |
Arguments
|
|
queryReports - QueryReportsResult!
|
|
productionStationStatistics - ProductionStationStatistics!
|
|
Arguments
|
|
merchants - [Merchant]!
|
A list of merchants |
surcharges - [Surcharge]!
|
A list surcharges |
customPriceLists - [PriceList]!
|
List of price lists |
marketingEmailTemplates - [MarketingEmailTemplate]!
|
A list of email templates |
marketingBroadcasts - [MarketingBroadcast]!
|
A list of broadcasts |
marketingFilters - [MarketingFilterResponse]!
|
A list of customer filters |
stripePublishableKey - String!
|
Stripe Publishable Key |
promotions - [Promotion]!
|
A list promotions |
lockers - [Locker]!
|
A list of lockers |
geoFences - [GeoFence]!
|
A list of geo-fences |
Arguments
|
|
uniqueTwilioErrors - [UniqueTwilioError]!
|
A list of unique twilio errors |
Example
{
"id": "4",
"localId": "4",
"shortId": 123,
"subdomain": "xyz789",
"settings": Settings,
"employeeSettings": Settings,
"stores": [Store],
"storesForCurrentBrand": [Store],
"communicationTemplatesList": [CommunicationTemplates],
"contactCommunicationTemplates": CommunicationTemplates,
"employees": [User],
"routes": [Route],
"routesOnDate": [Route],
"groups": [Group],
"notes": [Note],
"brands": [Brand],
"agents": [Agent],
"holidays": [Holiday],
"itemCategories": [ItemCategory],
"itemTypes": [ItemType],
"subscriptions": [ItemType],
"taxRates": [TaxRate],
"paymentMethods": [PaymentMethod],
"taxConfigurationRules": [TaxConfigurationRule],
"itemValidationRules": [ItemValidationRule],
"itemFields": [ItemField],
"financialDepartments": [FinancialDepartment],
"specialCares": [SpecialCare],
"alertTypes": [AlertType],
"alertSubTypes": [AlertSubType],
"chatRooms": [ChatRoom],
"customerFields": [CustomerField],
"usesPaymentSystem": true,
"getCustomer": Customer,
"getCustomers": [Customer],
"getOrder": Order,
"getAppointment": Appointment,
"queryReports": QueryReportsResult,
"productionStationStatistics": ProductionStationStatistics,
"merchants": [Merchant],
"surcharges": [Surcharge],
"customPriceLists": [PriceList],
"marketingEmailTemplates": [MarketingEmailTemplate],
"marketingBroadcasts": [MarketingBroadcast],
"marketingFilters": [MarketingFilterResponse],
"stripePublishableKey": "xyz789",
"promotions": [Promotion],
"lockers": [Locker],
"geoFences": [GeoFence],
"uniqueTwilioErrors": [UniqueTwilioError]
}
CampaignSetting
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
Example
{
"id": 4,
"localId": "4",
"name": "xyz789",
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "xyz789",
"autoApplyPromo": false,
"updateInfo": UpdateInfo
}
CardSurcharge
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
buyPrice - Float!
|
The total price of the surcharge |
taxAmount - Float!
|
The tax of the surcharge |
taxableAmount - Float!
|
The total price of the surcharge before tax |
Example
{
"id": 4,
"localId": "4",
"buyPrice": 987.65,
"taxAmount": 123.45,
"taxableAmount": 987.65
}
ChangeStopOrderDeliveryActionInput
Description
The input for performing a Sort Route Day delivery action
Example
{
"routeId": "4",
"newStopOrder": [4],
"timestamp": "2007-12-03T10:15:30Z"
}
ChatMessage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
roomId - String!
|
|
userId - String!
|
|
text - String!
|
The message content |
createDate - String!
|
Message timestamp in iso8106 with milliseconds |
Example
{
"id": "4",
"localId": "4",
"roomId": "abc123",
"userId": "abc123",
"text": "abc123",
"createDate": "abc123"
}
ChatRoom
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String
|
|
specialRoomType - String
|
|
isPrivate - Boolean!
|
|
userIds - [ID]!
|
|
agents - [ID]!
|
|
usersAllowedToPost - [ID]
|
|
isNotificationsRoom - Boolean!
|
|
isRequired - Boolean!
|
|
chatMessages - [ChatMessage]!
|
|
Example
{
"id": 4,
"localId": 4,
"name": "abc123",
"specialRoomType": "abc123",
"isPrivate": false,
"userIds": [4],
"agents": [4],
"usersAllowedToPost": ["4"],
"isNotificationsRoom": true,
"isRequired": true,
"chatMessages": [ChatMessage]
}
ChatRoomInput
Description
Create or update a chat channel
Fields
| Input Field | Description |
|---|---|
id - ID
|
Only required for existing entries |
name - String!
|
Name of the room. Optional for private rooms |
agents - [ID]
|
A list of agent ids to use when routing messages |
userIds - [ID]!
|
A list of global user ids that have access to the room. |
isPrivate - Boolean
|
True if the room is private. Only admins can manage public rooms. |
isNotificationsRoom - Boolean
|
True if the room is a hardcoded room for notifications. |
isRequired - Boolean
|
If true the room cannot be deleted or modified by an admin |
usersAllowedToPost - [String]
|
A list of global user ids that may post to this room. Everyone can post if null |
isArchived - Boolean
|
Set to true to soft delete the room |
Example
{
"id": "4",
"name": "abc123",
"agents": ["4"],
"userIds": ["4"],
"isPrivate": true,
"isNotificationsRoom": true,
"isRequired": true,
"usersAllowedToPost": ["xyz789"],
"isArchived": false
}
Color
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Color name (e.g Blue) |
hex - String!
|
Color name (e.g Blue) |
isDark - Boolean!
|
whether color is considered "dark" |
Example
{
"id": 4,
"localId": "4",
"name": "xyz789",
"hex": "abc123",
"isDark": true
}
Communication
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
direction - CommunicationDirectionEnum!
|
The direction of the contact (e.g., contactIn, contactOut). |
type - CommunicationTypeEnum!
|
The type of communication (e.g., email, text, call). |
date - String!
|
The date and time when the communication occurred. |
subject - String
|
The subject or title of the communication. |
staff - User
|
The staff member who initiated the communication. |
contactFlag - ContactFlagEnum!
|
An integer flag representing the contact type. |
body - String!
|
The body of the communication. |
Example
{
"id": 4,
"localId": 4,
"direction": "CONTACT_IN",
"type": "CONTACT_EMAIL_OUT",
"date": "abc123",
"subject": "abc123",
"staff": User,
"contactFlag": "NOTIFICATION_DEFAULT",
"body": "xyz789"
}
CommunicationDirectionEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CONTACT_IN"
CommunicationTemplate
Example
{
"id": "4",
"localId": 4,
"subject": "abc123",
"body": "xyz789"
}
CommunicationTemplateCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Name of the communication template category |
templates - [CommunicationTemplate!]!
|
List of templates for the corresponding communication category |
Example
{
"id": 4,
"localId": "4",
"name": "xyz789",
"templates": [CommunicationTemplate]
}
CommunicationTemplates
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String
|
Name of the communication template list |
categories - [CommunicationTemplateCategory!]!
|
List of communication template categories |
Example
{
"id": 4,
"localId": "4",
"name": "abc123",
"categories": [CommunicationTemplateCategory]
}
CommunicationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTACT_EMAIL_OUT"
CompleteStopDeliveryActionInput
Description
The input for performing a Complete Stop delivery action
Fields
| Input Field | Description |
|---|---|
appointmentId - ID!
|
ID of the delivery appointment |
timestamp - DateTime!
|
When the action was initiated |
longitude - Float!
|
GPS longitude coordinate |
latitude - Float!
|
GPS latitude coordinate |
stopNote - String
|
Optional note when completing stop |
signatureImage - DeliveryImageInput
|
Optional signature image in base64 |
deliveryPhoto - DeliveryImageInput
|
Optional delivery stop photo in base64 |
Example
{
"appointmentId": "4",
"timestamp": "2007-12-03T10:15:30Z",
"longitude": 123.45,
"latitude": 123.45,
"stopNote": "abc123",
"signatureImage": DeliveryImageInput,
"deliveryPhoto": DeliveryImageInput
}
ContactFlagEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOTIFICATION_DEFAULT"
CounterToRouteCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
frequency - Int
|
how often the campaign triggers |
maxWaitDays - Int
|
Max amount of days of waiting to schedule before exiting campaign |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
Example
{
"id": 4,
"localId": 4,
"name": "xyz789",
"enabled": false,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfo,
"frequency": 123,
"maxWaitDays": 987,
"email": "abc123",
"sms": "abc123"
}
CounterToRouteCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
frequency - Int
|
how often the campaign triggers |
maxWaitDays - Int
|
Max amount of days of waiting to schedule before exiting campaign |
Example
{
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "abc123",
"sms": "xyz789",
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfoInput,
"frequency": 123,
"maxWaitDays": 987
}
CreatePaymentInput
Description
Input type for creating a payment
Fields
| Input Field | Description |
|---|---|
orderIds - [String]!
|
Orders to pay for |
Example
{"orderIds": ["abc123"]}
CreditCard
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
type - CreditCardTypeEnum!
|
The brand/type of the credit card. |
last4 - String!
|
The last 4 digits. |
expm - String!
|
Month of expiration |
expy - String!
|
Year of expiration |
status - CreditCardStatus!
|
The status of the card |
Example
{
"id": 4,
"localId": "4",
"type": "visa",
"last4": "abc123",
"expm": "xyz789",
"expy": "abc123",
"status": CreditCardStatus
}
CreditCardAddedByEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"customer"
CreditCardStatus
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
type - CreditCardStatusTypeEnum!
|
Credit card status type |
message - String
|
Credit card status message |
Example
{
"id": "4",
"localId": 4,
"type": "ACTIVE",
"message": "xyz789"
}
CreditCardStatusTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
CreditCardTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"visa"
CustomCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
customCampaigns - [CustomCampaignEntry]
|
A list of all custom campaigns |
Example
{
"id": 4,
"localId": 4,
"customCampaigns": [CustomCampaignEntry]
}
CustomCampaignEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the custom campaign |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
frequencyType - String
|
The type of interval used for sending the campaign message to the customer. |
frequencyValue - Int
|
The numeric value for measuring the chosen frequency type. |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
maxMessagesToSend - Int
|
The maximum messages to send per customer |
archived - Boolean!
|
If the setting is archived |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
Example
{
"id": 4,
"localId": 4,
"name": "xyz789",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"promotion": "xyz789",
"autoApplyPromo": true,
"frequencyType": "abc123",
"frequencyValue": 123,
"email": "abc123",
"sms": "abc123",
"maxMessagesToSend": 123,
"archived": false,
"updateInfo": UpdateInfo
}
CustomCampaignEntryInput
Description
A custom campaign
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the custom campaign |
name - String!
|
The name of the custom campaign |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
frequencyType - String
|
The type of interval used for sending the campaign message to the customer. |
frequencyValue - Int
|
The numeric value for measuring the chosen frequency type. |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
maxMessagesToSend - Int
|
The maximum messages to send per customer |
archived - Boolean!
|
If the setting is archived |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
Example
{
"id": 4,
"name": "xyz789",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"promotion": "xyz789",
"autoApplyPromo": false,
"frequencyType": "xyz789",
"frequencyValue": 987,
"email": "abc123",
"sms": "abc123",
"maxMessagesToSend": 123,
"archived": false,
"updateInfo": UpdateInfoInput
}
CustomCampaignInput
Description
Update a custom campaign
Fields
| Input Field | Description |
|---|---|
customCampaigns - [CustomCampaignEntryInput]!
|
A list of all custom campaigns |
Example
{"customCampaigns": [CustomCampaignEntryInput]}
Customer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Name of the actor |
futureAppointments - [Appointment]!
|
Chronological list of all future appointments with the customer. This includes both pickup and delivery requests. |
settings - Settings!
|
Settings specific to the customer. Also includes all global business settings. Please see Settings documentation for more information. |
group - Group
|
A customer may be part of a customer group. See Group for more information |
agent - Agent!
|
The Sales agent the customer belongs to |
routeHolds - [CustomerRouteHold]!
|
Customer route holds |
driverInstructions - String
|
Standing driver instructions |
preferences - [ID]!
|
Customer preferences |
goodOnlineAccountStanding - Boolean!
|
Good online account standing |
addresses - [CustomerAddress]!
|
Customer addresses |
defaultAddress - CustomerAddress
|
Customer default address |
defaultDeliveryAddress - CustomerAddress
|
Customer default delivery address |
isMasterDeliveryAccount - Boolean!
|
|
creditCardIFrameURL - String!
|
Customer credit card iframe URL. Parameter 'style' can be either 'payments' or 'profile'. Defaults to 'profile |
Arguments
|
|
authenticatedCustomerSiteLink - String!
|
Returns a link that takes the user straight into their customer portal, optionally define a specific target tab, which the user will land on. |
Arguments
|
|
creditCard - CreditCard
|
Customer credit card. |
datesForSchedulingAppointment - [ScheduleDate]!
|
Available dates for scheduling an appointment |
unpaidOrders - UnpaidOrders
|
Customer's unpaid orders |
finishedPayments - [PaymentReceipt]!
|
Customer's finished payments |
customerBookings - [CustomerBooking!]!
|
Customer bookings (appointments and orders) |
stagingDetailedCustomerOrder - DetailedCustomerOrder
|
The currently staged customer order not yet tied to an order or pickup |
readyBags - [CustomerBag]!
|
List of ready bags for the customer, yet to be picked up |
isRouteCustomer - Boolean!
|
True if the customer is assigned to a route |
customerRelationship - CustomerRelationshipEnum!
|
Describes the company-customer relationship |
deliveryStop - Int
|
Customer delivery stop |
demographic - Int
|
Customer demographic |
apiTokenForCustomer - String!
|
|
activePromotions - [Promotion]
|
Active Promotions |
subscription - CustomerSubscription
|
Subscription |
subscriptionUsage - [SubscriptionUsage]!
|
Get subscription usage |
kioskAccessCode - String
|
A personal kiosk access code (auto-generated) |
email - String
|
Customer's primary email |
cellPhone - String
|
Customer's primary phone number |
cellPhoneDisplay - String
|
Customer's active phone number |
homePhone - String
|
Customer's secondary phone number |
activePhone - String
|
Customer's active phone number |
firstName - String
|
Customer's first name |
lastName - String
|
Customer's last name |
companyName - String
|
Company name |
fullName - String
|
Customer's full name |
store - Store!
|
The store this customer belongs to |
customFields - [CustomerFieldValue]
|
|
isInSignupProcess - Boolean!
|
True if the customer recently signed up using a phone number and still has a temporary account name |
paymentStatus - PaymentStatus!
|
Payment status |
Arguments
|
|
wardrobeCategories - [ItemCategory!]!
|
Item categories for the customer wardrobe |
wardrobeItems - [OrderItem!]!
|
Items in the customers wardrobe |
paymentPreference - PaymentPreferenceEnum!
|
Payment preference |
rewardPoints - Float!
|
The customers reward points, from the reward system |
rewards - [Reward]!
|
Earned rewards |
missingRewardSettingCriteria - [RewardSettingCriteriaEnum!]!
|
Array of active reward criteria that customer does not meet. Returns an empty array if all criteria are met |
isSubBilling - Boolean!
|
Customer is a sub billing customer. I.e. it belongs to a master billing group where the master account handles the payments |
deliveryNotes - [Note!]!
|
Any notes for the customer relevant for pickup and delivery |
communication - [Communication!]!
|
Array of communication data between the business and the customer in batches of 25 controlled by the page argument, excluding automatic communications if set to true |
Example
{
"id": 4,
"localId": 4,
"name": "abc123",
"futureAppointments": [Appointment],
"settings": Settings,
"group": Group,
"agent": Agent,
"routeHolds": [CustomerRouteHold],
"driverInstructions": "abc123",
"preferences": [4],
"goodOnlineAccountStanding": true,
"addresses": [CustomerAddress],
"defaultAddress": CustomerAddress,
"defaultDeliveryAddress": CustomerAddress,
"isMasterDeliveryAccount": false,
"creditCardIFrameURL": "xyz789",
"authenticatedCustomerSiteLink": "xyz789",
"creditCard": CreditCard,
"datesForSchedulingAppointment": [ScheduleDate],
"unpaidOrders": UnpaidOrders,
"finishedPayments": [PaymentReceipt],
"customerBookings": [CustomerBooking],
"stagingDetailedCustomerOrder": DetailedCustomerOrder,
"readyBags": [CustomerBag],
"isRouteCustomer": true,
"customerRelationship": "STORE_ONLY",
"deliveryStop": 987,
"demographic": 123,
"apiTokenForCustomer": "xyz789",
"activePromotions": [Promotion],
"subscription": CustomerSubscription,
"subscriptionUsage": [SubscriptionUsage],
"kioskAccessCode": "abc123",
"email": "xyz789",
"cellPhone": "abc123",
"cellPhoneDisplay": "abc123",
"homePhone": "abc123",
"activePhone": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"companyName": "abc123",
"fullName": "xyz789",
"store": Store,
"customFields": [CustomerFieldValue],
"isInSignupProcess": true,
"paymentStatus": PaymentStatus,
"wardrobeCategories": [ItemCategory],
"wardrobeItems": [OrderItem],
"paymentPreference": "AUTOPAY",
"rewardPoints": 987.65,
"rewards": [Reward],
"missingRewardSettingCriteria": ["ADD_EMAIL_CRITERIA"],
"isSubBilling": false,
"deliveryNotes": [Note],
"communication": [Communication]
}
CustomerAddress
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Address name |
streetAddress - String!
|
Street address |
streetAddress2 - String
|
Street address line 2 |
city - String!
|
City |
state - String!
|
State |
zip - String!
|
Zip |
country - String!
|
Country |
latitude - String
|
Latitude |
longitude - String
|
Longitude |
skipVerification - Boolean
|
True if address verification was bypassed on last save. |
manualLocation - Boolean
|
True if latitude and longitude were edited manually. |
note - String
|
Customer provided description / directions for address. |
photo - Photo
|
Photo of address location |
Example
{
"id": "4",
"localId": 4,
"name": "xyz789",
"streetAddress": "abc123",
"streetAddress2": "xyz789",
"city": "abc123",
"state": "abc123",
"zip": "xyz789",
"country": "xyz789",
"latitude": "abc123",
"longitude": "xyz789",
"skipVerification": true,
"manualLocation": true,
"note": "xyz789",
"photo": Photo
}
CustomerAddressInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Address name |
streetAddress - String!
|
Street address |
streetAddress2 - String
|
Street address line 2 |
city - String!
|
City |
state - String!
|
State |
zip - String!
|
Zip |
latitude - String
|
Latitude |
longitude - String
|
Longitude |
skipVerification - Boolean
|
Set to true if you want to skip address verification. Defaults to false. |
manualLocation - Boolean
|
Set to true if manually editing coordinates. |
note - String
|
Customer provided description / directions for address. |
photoId - ID
|
Reference to a new photo |
Example
{
"name": "xyz789",
"streetAddress": "xyz789",
"streetAddress2": "abc123",
"city": "xyz789",
"state": "xyz789",
"zip": "xyz789",
"latitude": "xyz789",
"longitude": "abc123",
"skipVerification": true,
"manualLocation": true,
"note": "abc123",
"photoId": 4
}
CustomerBag
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
barcode - String!
|
Barcode (id) of the bag |
display - String!
|
ID of the bag, as it should be displayed to a user |
order - Order!
|
The order associated with this bag |
location - RackLog
|
Current location and scan event info of the ready bag (could be null) |
Example
{
"id": 4,
"localId": 4,
"barcode": "abc123",
"display": "xyz789",
"order": Order,
"location": RackLog
}
CustomerBooking
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
pickupAppointment - Appointment
|
A pickup appointment if scheduled |
deliveryAppointment - Appointment
|
A delivery appointment if scheduled |
detailedCustomerOrder - DetailedCustomerOrder
|
Customer provided order details for this booking |
orders - [Order!]!
|
A list of orders created at POS for this booking |
pickupDateDisplay - String
|
A displayable pickup date/time if scheduled |
deliveryDateDisplay - String
|
A displayable delivery date/time if scheduled |
pickupDateTitle - String
|
A text describing the pickup date |
deliveryDateTitle - String
|
A text describing the delivery date |
statusText - String!
|
A displayable info text |
status - CustomerBookingStatusEnum!
|
The status of the booking |
progress - Float!
|
The progress of the booking (0.0-1.0) |
bookingDate - DateTime!
|
The booking date, derived from the first available date out of pickup date, order creation date, delivery date, or a detailed customer order. |
lockerId - String
|
The locker storage ID if the order(s) were delivered to a locker |
lockerLabel - String
|
The label of a specific locker the order(s) were delivered to |
Example
{
"id": "4",
"localId": "4",
"pickupAppointment": Appointment,
"deliveryAppointment": Appointment,
"detailedCustomerOrder": DetailedCustomerOrder,
"orders": [Order],
"pickupDateDisplay": "abc123",
"deliveryDateDisplay": "xyz789",
"pickupDateTitle": "abc123",
"deliveryDateTitle": "abc123",
"statusText": "abc123",
"status": "ORDER_CONFIRMED",
"progress": 123.45,
"bookingDate": "2007-12-03T10:15:30Z",
"lockerId": "xyz789",
"lockerLabel": "abc123"
}
CustomerBookingStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ORDER_CONFIRMED"
CustomerDeliveryPreferenceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NO_PREFERENCE"
CustomerField
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
fieldType - CustomerFieldTypeEnum!
|
The type of the field |
label - String!
|
|
possibleValues - [String]
|
|
shownProfile - Boolean!
|
|
shownPosSignUp - Boolean!
|
|
shownCustomerWebsite - Boolean!
|
|
shownCustomerWebsiteSignUp - Boolean!
|
|
elasticKey - String
|
|
disabled - Boolean
|
|
isRequired - Boolean
|
Set to true to make it a required field when shown in the UI |
Example
{
"id": "4",
"localId": 4,
"fieldType": "text",
"label": "abc123",
"possibleValues": ["xyz789"],
"shownProfile": true,
"shownPosSignUp": false,
"shownCustomerWebsite": false,
"shownCustomerWebsiteSignUp": false,
"elasticKey": "abc123",
"disabled": true,
"isRequired": true
}
CustomerFieldConfigurationVisibilityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"shown_profile"
CustomerFieldInput
Description
Defines a Customer Field Input Type
Fields
| Input Field | Description |
|---|---|
id - String!
|
A unique ID for this custom field |
fieldType - CustomerFieldTypeEnum!
|
The type of the field |
label - String!
|
The name of the field |
possibleValues - [String]
|
Values for select type field |
shownProfile - Boolean!
|
Display on customer profile in POS |
shownPosSignUp - Boolean!
|
Display at customer signup in POS |
shownCustomerWebsite - Boolean!
|
Display on customer website |
shownCustomerWebsiteSignUp - Boolean!
|
Display on customer website at signup |
disabled - Boolean
|
Set to true to disable the field |
isRequired - Boolean
|
Set to true to make it a required field when shown in the UI |
Example
{
"id": "abc123",
"fieldType": "text",
"label": "abc123",
"possibleValues": ["xyz789"],
"shownProfile": false,
"shownPosSignUp": true,
"shownCustomerWebsite": true,
"shownCustomerWebsiteSignUp": true,
"disabled": false,
"isRequired": false
}
CustomerFieldTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"text"
CustomerFieldValue
Example
{
"id": "4",
"localId": 4,
"label": "abc123",
"value": "xyz789"
}
CustomerFieldValueInput
CustomerInput
Description
A customer to update
Example
{
"email": "abc123",
"phone": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"password": "xyz789",
"customFields": [CustomerFieldValueInput]
}
CustomerPreference
CustomerPreferenceSection
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
type - String!
|
Type of the preference section |
name - String!
|
Name of the preference section |
options - [CustomerPreference]!
|
Available preferences in a section |
hideCustomerPreference - Boolean!
|
Flag to tell if a customer preference section should be hidden or not |
Example
{
"id": "4",
"localId": "4",
"type": "xyz789",
"name": "xyz789",
"options": [CustomerPreference],
"hideCustomerPreference": false
}
CustomerRelationshipEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"STORE_ONLY"
CustomerRouteHold
Example
{
"id": 4,
"localId": 4,
"startDate": "abc123",
"endDate": "xyz789"
}
CustomerRouteHoldInput
CustomerSignupNoOrdersCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
frequencyType - String
|
Only send one message per customer per this many days |
frequencyValue - Int
|
The days passed since the oldest ready order to send the campaign |
maxMessages - Int
|
The maximum number of messages to send |
enableStore - Boolean!
|
Whether the campaign is enabled for store customers |
enableRoute - Boolean!
|
Whether the campaign is enabled for route customers |
storeEmail - String
|
The email template to send to store customers |
storeSms - String
|
The sms template to send to store customers |
routeEmail - String
|
The email template to send to route customers |
routeSms - String
|
The sms template to send to route customers |
Example
{
"id": "4",
"localId": 4,
"name": "abc123",
"enabled": true,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfo,
"frequencyType": "xyz789",
"frequencyValue": 987,
"maxMessages": 987,
"enableStore": true,
"enableRoute": true,
"storeEmail": "xyz789",
"storeSms": "abc123",
"routeEmail": "abc123",
"routeSms": "xyz789"
}
CustomerSignupNoOrdersCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
frequencyType - String
|
Only send one message per customer per this many days |
frequencyValue - Int
|
The days passed since the oldest ready order to send the campaign |
maxMessages - Int
|
The maximum number of messages to send |
enableStore - Boolean!
|
Whether the campaign is enabled for store customers |
enableRoute - Boolean!
|
Whether the campaign is enabled for route customers |
storeEmail - String
|
The email template to send to store customers |
storeSms - String
|
The sms template to send to store customers |
routeEmail - String
|
The email template to send to route customers |
routeSms - String
|
The sms template to send to route customers |
Example
{
"enabled": false,
"priority": "abc123",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "xyz789",
"promotion": "xyz789",
"autoApplyPromo": false,
"updateInfo": UpdateInfoInput,
"frequencyType": "abc123",
"frequencyValue": 123,
"maxMessages": 123,
"enableStore": false,
"enableRoute": false,
"storeEmail": "xyz789",
"storeSms": "xyz789",
"routeEmail": "abc123",
"routeSms": "xyz789"
}
CustomerStop
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
appointment - Appointment!
|
The pickup or delivery appointment associated with the stop |
customer - Customer!
|
The delivery account of the stop |
orders - [Order!]!
|
Orders that are eligible for delivery as well as delivered orders on the date of the stop |
Example
{
"id": "4",
"localId": "4",
"appointment": Appointment,
"customer": Customer,
"orders": [Order]
}
CustomerSubscription
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
pending - CustomerSubscriptionEntry
|
Pending subscription object |
active - CustomerSubscriptionEntry
|
Active subscription object |
log - [CustomerSubscriptionLog]
|
Start & end-times of subscriptions |
renewalDate - DateTime
|
Date when subscription renews |
Example
{
"id": "4",
"localId": "4",
"pending": CustomerSubscriptionEntry,
"active": CustomerSubscriptionEntry,
"log": [CustomerSubscriptionLog],
"renewalDate": "2007-12-03T10:15:30Z"
}
CustomerSubscriptionEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
saleId - ID
|
The connected order Id |
price - Float!
|
The price per month for this subscription |
start - DateTime
|
The start date |
end - DateTime
|
The end date |
Example
{
"id": 4,
"localId": "4",
"saleId": "4",
"price": 123.45,
"start": "2007-12-03T10:15:30Z",
"end": "2007-12-03T10:15:30Z"
}
CustomerSubscriptionLog
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
date - String!
|
The date |
event - String!
|
The event name |
description - String!
|
The event description |
user - User
|
The user who triggered the event |
Example
{
"id": 4,
"localId": "4",
"date": "xyz789",
"event": "xyz789",
"description": "abc123",
"user": User
}
DateRange
DateTime
Description
An ISO-8601 encoded UTC date string.
Example
"2007-12-03T10:15:30Z"
DeliverBagDeliveryActionInput
Description
The input for performing a Deliver Bag delivery action
Example
{
"appointmentId": "4",
"ticketBarcode": 4,
"timestamp": "2007-12-03T10:15:30Z"
}
DeliveryImageInput
DeliveryVehicleStatus
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
driverName - String!
|
|
driverPhone - String
|
|
lastPositionAt - DateTime!
|
|
currentLatitude - String!
|
|
currentLongitude - String!
|
|
stopsLeft - Int!
|
Example
{
"id": 4,
"localId": "4",
"driverName": "xyz789",
"driverPhone": "xyz789",
"lastPositionAt": "2007-12-03T10:15:30Z",
"currentLatitude": "abc123",
"currentLongitude": "xyz789",
"stopsLeft": 123
}
DepartmentMessageEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
department - String
|
The name of the department to send the message for |
email - String
|
The email Template ID to send on this day |
sms - String
|
The sms Template to send on this day |
promotion - String
|
The promotion to send in this message |
Example
{
"id": 4,
"localId": 4,
"department": "xyz789",
"email": "abc123",
"sms": "xyz789",
"promotion": "abc123"
}
DepartmentMessageEntryInput
Description
A message to send to a department
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the message Entry |
department - String
|
The name of the department to send the message for |
email - String
|
The email Template ID to send on this day |
sms - String
|
The sms Template to send on this day |
promotion - String
|
The promotion to send in this message |
Example
{
"id": "4",
"department": "abc123",
"email": "abc123",
"sms": "xyz789",
"promotion": "abc123"
}
DetailedCustomerOrder
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
customer - Customer
|
The customer this order belongs to |
isStaging - Boolean
|
Whether this order is the currently staged order by customer. If an order is staged, it means that this order describes the order the customer plans to give the cleaner next. |
detailedItemData - [DetailedItemData]!
|
Customer Item Details |
Example
{
"id": 4,
"localId": "4",
"customer": Customer,
"isStaging": true,
"detailedItemData": [DetailedItemData]
}
DetailedCustomerOrderInput
Description
An order detailed by customer
Fields
| Input Field | Description |
|---|---|
items - [DetailedItemDataInput]!
|
Example
{"items": [DetailedItemDataInput]}
DetailedItemData
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
description - String!
|
Customer Provided Item Description |
photo - Photo
|
photo of garment |
annotations - [Annotation]!
|
annotations (such as spots and damages) of item |
Example
{
"id": "4",
"localId": 4,
"description": "abc123",
"photo": Photo,
"annotations": [Annotation]
}
DetailedItemDataInput
Description
Customer detailed item with optional description, photo and annotations
Fields
| Input Field | Description |
|---|---|
description - String
|
Customer Provided Item Description |
photo - ID
|
Photo of the garment (id of Photo) |
annotations - [AnnotationInput]!
|
annotations (such as spots and damages) of item |
Example
{
"description": "xyz789",
"photo": 4,
"annotations": [AnnotationInput]
}
DuePayment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
subTotal - Float!
|
The total price for the orders, including tax |
creditedAmount - Float!
|
The sum of credits for the payment |
cardSurcharge - CardSurcharge
|
The card surcharge for the payment |
total - Float!
|
The total sum of the payment |
Example
{
"id": "4",
"localId": 4,
"subTotal": 987.65,
"creditedAmount": 987.65,
"cardSurcharge": CardSurcharge,
"total": 123.45
}
ElapsedDaysEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
daysPassed - Int
|
The day of the week to send the campaign |
promotion - String
|
The promotion to send on this day |
email - String
|
The email Template ID to send on this day |
sms - String
|
The sms Template to send on this day |
Example
{
"id": "4",
"localId": "4",
"daysPassed": 987,
"promotion": "abc123",
"email": "xyz789",
"sms": "xyz789"
}
ElapsedDaysEntryInput
Description
A campaign setting
Example
{
"id": 4,
"daysPassed": 123,
"promotion": "xyz789",
"email": "abc123",
"sms": "xyz789"
}
EmailListEntry
Example
{
"id": "4",
"localId": "4",
"fullName": "xyz789",
"email": "xyz789"
}
EmailListEntryInput
FeedbackClickTrackingInput
Description
The input for sending click tracking data for a review
Example
{
"customerId": "4",
"feedbackType": true,
"feedbackTimestamp": 987,
"googlePlaceId": "abc123"
}
FinancialDepartment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Name of the department. |
showInCustomerScheduler - Boolean!
|
True if supposed to be displayed in the customer delivery scheduler. |
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"showInCustomerScheduler": false
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GeoFence
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the geo-fence |
brand - Brand
|
The specific brand for which the geo-fence is configured. If null, the geo-fence applies globally across all non-walled brands |
route - Route
|
A route associated with the geo-fence |
polygon - [Float!]!
|
A list of coordinates defining the geo-fence area. Defined in tuples like [longitude, latitude] |
color - String
|
A color for the geo-fence as a hex value |
isDisabled - Boolean!
|
Whether the geo-fence is disabled or not |
createdAt - DateTime!
|
When this geo-fence was created |
Example
{
"id": 4,
"localId": "4",
"name": "xyz789",
"brand": Brand,
"route": Route,
"polygon": [987.65],
"color": "xyz789",
"isDisabled": true,
"createdAt": "2007-12-03T10:15:30Z"
}
GeoFenceInput
Description
Input for creating or updating a geo-fence
Fields
| Input Field | Description |
|---|---|
id - ID
|
An ID if updating an existing geo-fence |
name - String
|
The name of the geo-fence |
brandId - ID
|
The ID of a specific brand for which the geo-fence is configured. If null, the geo-fence applies globally across all non-walled brands |
routeId - ID
|
An ID of a route associated with the geo-fence |
polygon - [Float!]
|
A list of coordinates defining the geo-fence area. Defined in tuples like [longitude, latitude] |
color - String
|
A color for the geo-fence as a hex value, with or without the hash sign |
isDisabled - Boolean
|
Set to true to disable the geo-fence |
Example
{
"id": 4,
"name": "xyz789",
"brandId": "4",
"routeId": 4,
"polygon": [987.65],
"color": "abc123",
"isDisabled": false
}
GetCustomerFieldEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"id"
GetCustomersFieldEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"masterRouteId"
GoogleAccount
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the Google account |
locations - [GoogleLocation]!
|
Locations associated with the Google account |
Example
{
"id": 4,
"localId": "4",
"name": "abc123",
"locations": [GoogleLocation]
}
GoogleLocation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the Google location |
address - String
|
The address of the Google location |
storeCode - String
|
The store code of the Google location |
placeId - String
|
The place id of the Google location |
Example
{
"id": 4,
"localId": "4",
"name": "abc123",
"address": "xyz789",
"storeCode": "abc123",
"placeId": "xyz789"
}
Group
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
agentId - ID
|
Unique identifier for the Agent. Can be null for a Group, if the group is not an agent. |
agentType - String
|
The type of Agent. One of "Store", "Route" or "Group". Can be null for a Group, if the group is not an agent. |
name - String!
|
Name of the Agent |
merchant - Merchant
|
The merchant for the agent |
isStripeEnabled - Boolean
|
If an agent is Stripe enabled |
hasOwnAgent - Boolean!
|
Whether this group has its own Sales agent or not. Must groups do not have their own sales agent, but sometimes this is used for granular sales reporting for the group. |
isGroupStop - Boolean!
|
Whether this group is a group delivery stop. For example a building with many customers in it. |
isMasterBilling - Boolean!
|
Whether this group is billed as one. The Customers in the group do not pay for the services billed for in SMRT, only the group does. |
customers - [Customer]!
|
Members of this group |
Example
{
"id": 4,
"localId": 4,
"agentId": "4",
"agentType": "xyz789",
"name": "xyz789",
"merchant": Merchant,
"isStripeEnabled": false,
"hasOwnAgent": false,
"isGroupStop": true,
"isMasterBilling": true,
"customers": [Customer]
}
HappyAnniversaryCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
Example
{
"id": 4,
"localId": 4,
"name": "xyz789",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"email": "xyz789",
"sms": "abc123"
}
HappyAnniversaryCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
Example
{
"enabled": true,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "abc123",
"promotion": "abc123",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput
}
HasCustomSettings
Holiday
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
date - String!
|
The date of the holiday, YYYY-MM-DD |
noProduction - Boolean!
|
True if no production on day |
noDelivery - Boolean!
|
True if no delivery on day |
dayOfWeek - String!
|
The day of the week for the date (Mon, Tue etc) |
Example
{
"id": "4",
"localId": 4,
"date": "xyz789",
"noProduction": false,
"noDelivery": false,
"dayOfWeek": "xyz789"
}
HolidayInput
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
InventoryReminderCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
frequency - Int
|
Only send one message per customer per this many days |
elapsedDays - [ElapsedDaysEntry]
|
The days passed since the oldest ready order to send the campaign |
Example
{
"id": "4",
"localId": 4,
"name": "xyz789",
"enabled": false,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfo,
"frequency": 987,
"elapsedDays": [ElapsedDaysEntry]
}
InventoryReminderCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
frequency - Int
|
Only send one message per customer per this many days |
elapsedDays - [ElapsedDaysEntryInput]!
|
The days passed since the oldest ready order to send the campaign |
Example
{
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "abc123",
"promotion": "xyz789",
"autoApplyPromo": false,
"updateInfo": UpdateInfoInput,
"frequency": 987,
"elapsedDays": [ElapsedDaysEntryInput]
}
ItemCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Name of the category, e.g Shirts/Tops |
sort - Int!
|
Sort of the category in item detailing, lowest number first |
description - String!
|
Longer description of what items are in the category |
disabled - Boolean!
|
Whether the category is disabled (meaning deleted) or not |
isRetail - Boolean!
|
If the category is the retail sales category. This category includes non cleaning items such as gift cards and lint rollers. |
Example
{
"id": 4,
"localId": 4,
"name": "xyz789",
"sort": 987,
"description": "xyz789",
"disabled": false,
"isRetail": true
}
ItemCategoryInput
Description
Create / Update an item category
Fields
| Input Field | Description |
|---|---|
id - ID
|
only required for existing entries |
name - String!
|
Name of the category, e.g Shirts/Tops |
sort - Int!
|
Sort of the category in item detailing, lowest number first |
description - String!
|
Longer description of what items are in the category |
disabled - Boolean!
|
Whether the category is disabled (meaning deleted) or not |
isRetail - Boolean!
|
If the category is the retail sales category. This category includes non cleaning items such as gift cards and lint rollers. |
Example
{
"id": 4,
"name": "abc123",
"sort": 987,
"description": "xyz789",
"disabled": true,
"isRetail": false
}
ItemField
ItemStatus
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"isReady": false
}
ItemType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Name of the item type |
category - ItemCategory!
|
Item Category. |
active - Boolean
|
Whether the item type has been deleted or not. |
isDisabledInCustomerApp - Boolean
|
Whether the item type should be displayed in the customer app (for subscriptions). |
price - String
|
The current price of the item type |
priceDisplay - String
|
The current price of the item type including tax |
showInDetailing - Boolean
|
Whether the item type should be shown in detailing |
description - String
|
The description of the item type |
departmentId - String!
|
|
defaultImageUrl - String!
|
The default item image url |
Example
{
"id": "4",
"localId": 4,
"name": "abc123",
"category": ItemCategory,
"active": true,
"isDisabledInCustomerApp": false,
"price": "xyz789",
"priceDisplay": "xyz789",
"showInDetailing": false,
"description": "xyz789",
"departmentId": "abc123",
"defaultImageUrl": "xyz789"
}
ItemValidationRule
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Name of the rule. |
requiredFields - [String]
|
A list of required item fields. |
requiredSpecialCares - [String]
|
A list of required special cares (one-of condition). |
itemTypeCondition - [String]
|
A list of item types. |
departmentCondition - [String]
|
A list of financial departments. |
sort - Int
|
Sort order. |
isDisabled - Boolean
|
True if rule is disabled. |
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"requiredFields": ["xyz789"],
"requiredSpecialCares": ["xyz789"],
"itemTypeCondition": ["abc123"],
"departmentCondition": ["xyz789"],
"sort": 123,
"isDisabled": true
}
ItemValidationRuleInput
Description
Create or update an item validation rule
Fields
| Input Field | Description |
|---|---|
id - ID
|
Only required for existing entries |
name - String!
|
Name of the rule. |
requiredFields - [String]
|
A list of required item fields. |
requiredSpecialCares - [String]
|
A list of required special cares (one-of condition). |
itemTypeCondition - [String]
|
A list of item types. |
departmentCondition - [String]
|
A list of financial departments. |
sort - Int
|
Sort order. |
isDisabled - Boolean
|
True if rule is disabled. |
Example
{
"id": "4",
"name": "abc123",
"requiredFields": ["abc123"],
"requiredSpecialCares": ["xyz789"],
"itemTypeCondition": ["xyz789"],
"departmentCondition": ["abc123"],
"sort": 123,
"isDisabled": false
}
LoadBagDeliveryActionInput
Description
The input for performing a Load Bag delivery action
Example
{
"appointmentId": 4,
"ticketBarcode": "4",
"timestamp": "2007-12-03T10:15:30Z"
}
LocationReview
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"review": Review
}
LocationReviews
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
locationReviews - [LocationReview]
|
A review for the location. |
nextPageToken - String
|
The token to retrieve the next page of reviews. |
Example
{
"id": 4,
"localId": "4",
"locationReviews": [LocationReview],
"nextPageToken": "abc123"
}
Locker
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
address - CustomerAddress
|
Locker Address |
Example
{
"id": 4,
"localId": "4",
"address": CustomerAddress
}
LostBigCustomerCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
frequencyType - String
|
The frequency type |
frequencyValue - Int
|
The frequency value |
spendingDemographics - [Int]
|
The spending demographics |
Example
{
"id": "4",
"localId": 4,
"name": "xyz789",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"email": "xyz789",
"sms": "abc123",
"frequencyType": "xyz789",
"frequencyValue": 123,
"spendingDemographics": [123]
}
LostBigCustomerCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
frequencyType - String
|
The frequency type |
frequencyValue - Int
|
The frequency value |
spendingDemographics - [Int]
|
The spending demographics |
Example
{
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "abc123",
"promotion": "abc123",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput,
"frequencyType": "abc123",
"frequencyValue": 123,
"spendingDemographics": [123]
}
MarketingBroadcast
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the broadcast |
subject - String
|
The subject of the broadcast email |
broadcastType - String
|
The type of the broadcast |
message - String
|
The message of the broadcast in plain text or html |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
emailTemplateId - String
|
The id of the broadcast email template |
status - String
|
The status of the broadcast |
dateCreated - Float!
|
The date the broadcast was created |
dateSent - String
|
The date the broadcast was sent |
emailHtmlTemplate - String
|
The html template of the broadcast email |
sentBy - String!
|
User that created/sent the broadcast |
scheduledBy - String!
|
User that scheduled the broadcast |
scheduledDate - String
|
Date for the scheduled the broadcast |
promotion - String
|
The promotion used in the broadcast |
autoApplyPromo - Boolean
|
Whether the promotion should be auto applied |
optimizeEmailDelivery - Boolean!
|
Whether to optimize email delivery |
Example
{
"id": "4",
"localId": 4,
"name": "abc123",
"subject": "xyz789",
"broadcastType": "abc123",
"message": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"emailTemplateId": "xyz789",
"status": "abc123",
"dateCreated": 987.65,
"dateSent": "abc123",
"emailHtmlTemplate": "abc123",
"sentBy": "abc123",
"scheduledBy": "abc123",
"scheduledDate": "abc123",
"promotion": "abc123",
"autoApplyPromo": true,
"optimizeEmailDelivery": true
}
MarketingBroadcastInput
Description
MarketingBroadcast input object
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the broadcast |
name - String!
|
The name of the email template |
subject - String
|
The subject of the email |
broadcastType - String
|
The type of the broadcast |
message - String!
|
The message of the broadcast in plain text or html |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
emailTemplateId - String
|
The id of the email template |
emailHtmlTemplate - String
|
The html template of the email |
dateCreated - Float!
|
The date the broadcast was created |
scheduledDate - Float
|
The date to send the broadcast |
promotion - String
|
The promotion used in the broadcast |
autoApplyPromo - Boolean
|
Whether to auto apply the promotion |
testEmail - String
|
The email used for the test broadcast |
testPhone - String
|
The phone number used for the broadcast |
optimizeEmailDelivery - Boolean
|
Whether to optimize email delivery |
Example
{
"id": "4",
"name": "xyz789",
"subject": "xyz789",
"broadcastType": "xyz789",
"message": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"emailTemplateId": "abc123",
"emailHtmlTemplate": "xyz789",
"dateCreated": 123.45,
"scheduledDate": 123.45,
"promotion": "xyz789",
"autoApplyPromo": true,
"testEmail": "abc123",
"testPhone": "xyz789",
"optimizeEmailDelivery": false
}
MarketingByDepartmentCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
frequency - Int
|
Send a message every X days |
departmentMessages - [DepartmentMessageEntry]
|
List of messages to send to customers for each department |
Example
{
"id": "4",
"localId": 4,
"name": "xyz789",
"enabled": false,
"priority": "abc123",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfo,
"frequency": 123,
"departmentMessages": [DepartmentMessageEntry]
}
MarketingByDepartmentCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
frequency - Int
|
The day of the month to send the message |
departmentMessages - [DepartmentMessageEntryInput]
|
List of messages to send to customers for each department |
Example
{
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["abc123"],
"email": "xyz789",
"sms": "abc123",
"promotion": "xyz789",
"autoApplyPromo": false,
"updateInfo": UpdateInfoInput,
"frequency": 987,
"departmentMessages": [DepartmentMessageEntryInput]
}
MarketingEmailTemplate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the email template |
subject - String
|
The subject of the email |
jsonTemplate - String!
|
The json template of the email |
htmlTemplate - String!
|
The html template of the email |
hasPromotion - Boolean!
|
Whether the email template includes a promotion link |
Example
{
"id": 4,
"localId": 4,
"name": "xyz789",
"subject": "xyz789",
"jsonTemplate": "abc123",
"htmlTemplate": "abc123",
"hasPromotion": true
}
MarketingEmailTemplateInput
Description
An email template input.
Example
{
"id": "abc123",
"name": "abc123",
"subject": "xyz789",
"jsonTemplate": "abc123",
"htmlTemplate": "abc123"
}
MarketingFilterResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
report - ID!
|
The id of the report |
title - String!
|
The title of the report |
total - Int!
|
The number of customers in the report |
Example
{
"id": 4,
"localId": "4",
"report": 4,
"title": "xyz789",
"total": 123
}
MarketingReportInput
Merchant
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Merchant name |
gateway - String!
|
Merchant gateway |
agentIds - [String]!
|
Ids of agents using the merchant |
Example
{
"id": 4,
"localId": 4,
"name": "abc123",
"gateway": "xyz789",
"agentIds": ["abc123"]
}
MonthlyNewsletterCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
dayToSend - Int!
|
The day of the month to send the message |
januaryEmail - String
|
The email template to send in January |
januaryEnabled - Boolean!
|
If the email should be sent in January |
februaryEmail - String
|
The email template to send in February |
februaryEnabled - Boolean!
|
If the email should be sent in February |
marchEmail - String
|
The email template to send in March |
marchEnabled - Boolean!
|
If the email should be sent in March |
aprilEmail - String
|
The email template to send in April |
aprilEnabled - Boolean!
|
If the email should be sent in April |
mayEmail - String
|
The email template to send in May |
mayEnabled - Boolean!
|
If the email should be sent in May |
juneEmail - String
|
The email template to send in June |
juneEnabled - Boolean!
|
If the email should be sent in June |
julyEmail - String
|
The email template to send in July |
julyEnabled - Boolean!
|
If the email should be sent in July |
augustEmail - String
|
The email template to send in August |
augustEnabled - Boolean!
|
If the email should be sent in August |
septemberEmail - String
|
The email template to send in September |
septemberEnabled - Boolean!
|
If the email should be sent in September |
octoberEmail - String
|
The email template to send in October |
octoberEnabled - Boolean!
|
If the email should be sent in October |
novemberEmail - String
|
The email template to send in November |
novemberEnabled - Boolean!
|
If the email should be sent in November |
decemberEmail - String
|
The email template to send in December |
decemberEnabled - Boolean!
|
If the email should be sent in December |
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfo,
"dayToSend": 123,
"januaryEmail": "abc123",
"januaryEnabled": true,
"februaryEmail": "abc123",
"februaryEnabled": true,
"marchEmail": "abc123",
"marchEnabled": false,
"aprilEmail": "xyz789",
"aprilEnabled": false,
"mayEmail": "xyz789",
"mayEnabled": true,
"juneEmail": "abc123",
"juneEnabled": false,
"julyEmail": "xyz789",
"julyEnabled": true,
"augustEmail": "abc123",
"augustEnabled": true,
"septemberEmail": "abc123",
"septemberEnabled": true,
"octoberEmail": "xyz789",
"octoberEnabled": false,
"novemberEmail": "abc123",
"novemberEnabled": false,
"decemberEmail": "xyz789",
"decemberEnabled": false
}
MonthlyNewsletterCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
dayToSend - Int!
|
The day of the month to send the message |
januaryEmail - String
|
The email template to send in January |
januaryEnabled - Boolean!
|
If the email should be sent in January |
februaryEmail - String
|
The email template to send in February |
februaryEnabled - Boolean!
|
If the email should be sent in February |
marchEmail - String
|
The email template to send in March |
marchEnabled - Boolean!
|
If the email should be sent in March |
aprilEmail - String
|
The email template to send in April |
aprilEnabled - Boolean!
|
If the email should be sent in April |
mayEmail - String
|
The email template to send in May |
mayEnabled - Boolean!
|
If the email should be sent in May |
juneEmail - String
|
The email template to send in June |
juneEnabled - Boolean!
|
If the email should be sent in June |
julyEmail - String
|
The email template to send in July |
julyEnabled - Boolean!
|
If the email should be sent in July |
augustEmail - String
|
The email template to send in August |
augustEnabled - Boolean!
|
If the email should be sent in August |
septemberEmail - String
|
The email template to send in September |
septemberEnabled - Boolean!
|
If the email should be sent in September |
octoberEmail - String
|
The email template to send in October |
octoberEnabled - Boolean!
|
If the email should be sent in October |
novemberEmail - String
|
The email template to send in November |
novemberEnabled - Boolean!
|
If the email should be sent in November |
decemberEmail - String
|
The email template to send in December |
decemberEnabled - Boolean!
|
If the email should be sent in December |
Example
{
"enabled": true,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "xyz789",
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput,
"dayToSend": 987,
"januaryEmail": "xyz789",
"januaryEnabled": false,
"februaryEmail": "abc123",
"februaryEnabled": true,
"marchEmail": "xyz789",
"marchEnabled": true,
"aprilEmail": "xyz789",
"aprilEnabled": true,
"mayEmail": "xyz789",
"mayEnabled": false,
"juneEmail": "xyz789",
"juneEnabled": false,
"julyEmail": "abc123",
"julyEnabled": false,
"augustEmail": "xyz789",
"augustEnabled": true,
"septemberEmail": "abc123",
"septemberEnabled": true,
"octoberEmail": "xyz789",
"octoberEnabled": false,
"novemberEmail": "xyz789",
"novemberEnabled": true,
"decemberEmail": "abc123",
"decemberEnabled": true
}
NewCustomerRetentionCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
maxMessages - Int
|
The maximum number of messages to send |
storeEmail - String
|
The email template to send |
storeSms - String
|
The sms template to send |
routeEmail - String
|
The email template to send |
routeSms - String
|
The sms template to send |
enableStore - Boolean!
|
Whether to send messages to store customers |
enableRoute - Boolean!
|
Whether to send messages to route customers |
Example
{
"id": "4",
"localId": "4",
"name": "xyz789",
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"promotion": "abc123",
"autoApplyPromo": true,
"updateInfo": UpdateInfo,
"maxMessages": 123,
"storeEmail": "abc123",
"storeSms": "xyz789",
"routeEmail": "xyz789",
"routeSms": "abc123",
"enableStore": false,
"enableRoute": false
}
NewCustomerRetentionCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
maxMessages - Int
|
The maximum number of messages to send |
storeEmail - String
|
The email template to send |
storeSms - String
|
The sms template to send |
routeEmail - String
|
The email template to send |
routeSms - String
|
The sms template to send |
enableStore - Boolean!
|
Whether to send messages to store customers |
enableRoute - Boolean!
|
Whether to send messages to route customers |
Example
{
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "abc123",
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfoInput,
"maxMessages": 987,
"storeEmail": "abc123",
"storeSms": "xyz789",
"routeEmail": "abc123",
"routeSms": "abc123",
"enableStore": false,
"enableRoute": true
}
NoOrdersSinceLastCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
spendingDemographics - [Int!]
|
Only send to customers with these spending demographics |
elapsedDays - [ElapsedDaysEntry]
|
The days passed since the last order. |
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "xyz789",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"spendingDemographics": [987],
"elapsedDays": [ElapsedDaysEntry]
}
NoOrdersSinceLastCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
spendingDemographics - [Int!]
|
Only send to customers with these spending demographics |
elapsedDays - [ElapsedDaysEntryInput]
|
The days passed since the last order. |
Example
{
"enabled": true,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "abc123",
"promotion": "abc123",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput,
"spendingDemographics": [123],
"elapsedDays": [ElapsedDaysEntryInput]
}
Node
Note
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
date - DateTime!
|
The creation date of the note |
customer - Customer!
|
The customer of the note |
message - String!
|
The note text |
mainCategory - String!
|
The note category |
subCategory - String!
|
The note sub category |
status - String!
|
The note status |
saleId - String
|
The attached sale id |
itemId - String
|
The attached item id |
lastUpdated - DateTime
|
Latest update of the note |
dueDate - DateTime
|
Due date of issue |
assignee - User
|
The assigned user |
photos - [Photo]!
|
List of photos attached to this note |
Example
{
"id": 4,
"localId": "4",
"date": "2007-12-03T10:15:30Z",
"customer": Customer,
"message": "abc123",
"mainCategory": "abc123",
"subCategory": "xyz789",
"status": "abc123",
"saleId": "abc123",
"itemId": "xyz789",
"lastUpdated": "2007-12-03T10:15:30Z",
"dueDate": "2007-12-03T10:15:30Z",
"assignee": User,
"photos": [Photo]
}
OneAndDoneCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
maxWaitDays - Int
|
The maximum number of days to wait before sending the campaign |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
Example
{
"id": "4",
"localId": "4",
"name": "xyz789",
"enabled": true,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"maxWaitDays": 123,
"email": "xyz789",
"sms": "abc123"
}
OneAndDoneCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
maxWaitDays - Int
|
The maximum number of days to wait before sending the campaign |
Example
{
"enabled": false,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"email": "abc123",
"sms": "xyz789",
"promotion": "abc123",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput,
"maxWaitDays": 987
}
Order
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
displayId - ID!
|
A displayable order ID |
date - DateTime!
|
The order's creation date |
dueDate - DateTime
|
The order's due date |
deliveredDate - DateTime
|
The order's delivered date if delivered |
customer - Customer!
|
The customer |
pickupStore - Store
|
The store where the customer will pick up the completed order |
dropStore - Store
|
The store where the customer dropped of the order |
isPickup - Boolean!
|
Whether or not the order was made at a pickup |
isDelivery - Boolean!
|
Whether or not the return location of the order is set to delivery |
hasChangedReturnLocation - Boolean!
|
hasChangedReturnLocation |
isPaid - Boolean!
|
Whether or not the order is fully paid |
isPaidForDelivery - Boolean!
|
Whether or not the delivery order is fully paid |
buyPrice - Float!
|
Total buy price of the order |
pieceCount - Int!
|
Piece count of the order |
status - OrderStatusEnum!
|
The current status of the order |
items - [OrderItem!]!
|
Items detailed on the order |
bags - [OrderBag!]!
|
Bags/tickets on the order if assembled |
customerProvidedDetails - DetailedCustomerOrder
|
Details provided by customer |
customerOrderStatusText - String!
|
Customer facing order status |
receiptLink - String!
|
The URL to the order receipt PDF |
lastPaymentWasDeclined - Boolean!
|
Whether the last payment was declined |
Example
{
"id": 4,
"localId": "4",
"displayId": 4,
"date": "2007-12-03T10:15:30Z",
"dueDate": "2007-12-03T10:15:30Z",
"deliveredDate": "2007-12-03T10:15:30Z",
"customer": Customer,
"pickupStore": Store,
"dropStore": Store,
"isPickup": false,
"isDelivery": false,
"hasChangedReturnLocation": false,
"isPaid": false,
"isPaidForDelivery": false,
"buyPrice": 123.45,
"pieceCount": 123,
"status": "disabled",
"items": [OrderItem],
"bags": [OrderBag],
"customerProvidedDetails": DetailedCustomerOrder,
"customerOrderStatusText": "xyz789",
"receiptLink": "abc123",
"lastPaymentWasDeclined": false
}
OrderBag
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
barcode - String!
|
The bag/ticket barcode |
label - String!
|
The bag/ticket label (A, B, C...) |
items - [OrderItem!]!
|
Items in the bag |
rack - Rack
|
Where this bag was last racked, if available |
isReturnedToCustomer - Boolean!
|
True if the bag is returned to the customer |
rackLocation - RackLog
|
Location the bag was last racked to |
bagPackagingType - BagPackagingTypeEnum!
|
The package type: Hangar, Folded or Wash n Fold |
Example
{
"id": 4,
"localId": 4,
"barcode": "abc123",
"label": "abc123",
"items": [OrderItem],
"rack": Rack,
"isReturnedToCustomer": true,
"rackLocation": RackLog,
"bagPackagingType": "HANGER"
}
OrderItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
type - ItemType
|
Item Type |
barcode - String!
|
Item Barcode |
brandDisplay - String!
|
Item Brand (e.g Banana Republic) |
itemStatus - ItemStatus!
|
Current item status (e.g Detailed, Pressing, Customer) |
colors - [Color!]!
|
Item Colors |
photo - Photo
|
Item Photo |
Example
{
"id": "4",
"localId": 4,
"type": ItemType,
"barcode": "xyz789",
"brandDisplay": "xyz789",
"itemStatus": ItemStatus,
"colors": [Color],
"photo": Photo
}
OrderStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"disabled"
PaymentMethod
PaymentPreferenceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AUTOPAY"
PaymentReceipt
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
total - Float!
|
The total sum of the payment |
date - DateTime!
|
The date the payment was made |
receiptLink - String!
|
The URL to the payment receipt PDF |
Example
{
"id": "4",
"localId": 4,
"total": 987.65,
"date": "2007-12-03T10:15:30Z",
"receiptLink": "abc123"
}
PaymentStatus
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
paymentReference - String!
|
Payment reference |
paymentStatus - PaymentStatusEnum!
|
Payment status |
Example
{
"id": 4,
"localId": "4",
"paymentReference": "xyz789",
"paymentStatus": "AUTHORIZED"
}
PaymentStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTHORIZED"
Photo
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
status - String!
|
Current processing status of the photo. |
thumbnailUrl - String
|
URL to the thumbnail sized version, if any |
smallUrl - String
|
URL to the small sized version, if any |
largeUrl - String
|
URL to the large sized version, if any |
description - String
|
A description or comment |
Example
{
"id": "4",
"localId": "4",
"status": "xyz789",
"thumbnailUrl": "xyz789",
"smallUrl": "abc123",
"largeUrl": "abc123",
"description": "xyz789"
}
PhotoInput
Description
Creates a photo from a base64 string
Example
{
"base64": "abc123",
"description": "abc123",
"customerId": 4
}
PriceList
ProductionStationStatistics
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
localId - ID!
|
|
hours - Float!
|
Number of hours the employee has worked today if using time clock. Returns 0 otherwise. |
pieces - Int!
|
The number of pieces the employee has processed today. |
ppoh - Float
|
Pieces per hour if the employee has clocked in at any point today. Returns null otherwise. |
value - Float!
|
The total value of the pieces processed today. |
Example
{
"id": "4",
"localId": 4,
"hours": 123.45,
"pieces": 123,
"ppoh": 123.45,
"value": 123.45
}
ProductionStationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"assemble"
Promotion
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
|
couponCode - String
|
|
customerCouponCode - String
|
|
disabled - Boolean
|
|
validForMarketing - Boolean
|
Example
{
"id": "4",
"localId": "4",
"name": "xyz789",
"couponCode": "xyz789",
"customerCouponCode": "xyz789",
"disabled": false,
"validForMarketing": true
}
PublicBusiness
Fields
| Field Name | Description |
|---|---|
id - ID!
|
id |
businessName - String!
|
Name of the business |
logoUrl - String!
|
Name of the business |
phoneNumber - String!
|
Phone number |
streetAddress - String!
|
Street address |
cityAddress - String!
|
City |
zipAddress - String!
|
Zip |
stateAddress - String!
|
State |
signupAddressRequired - Boolean!
|
Whether address is required for signup |
signupEmailRequired - Boolean!
|
Whether email is required for signup |
customerFields - [CustomerField]!
|
A list of configured customer fields |
defaultLanguage - String!
|
Default address |
fullstoryEnabled - Boolean!
|
Whether Fullstory is enabled |
settings - PublicBusinessSetting!
|
Settings |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
Example
{
"id": "4",
"businessName": "xyz789",
"logoUrl": "xyz789",
"phoneNumber": "abc123",
"streetAddress": "abc123",
"cityAddress": "xyz789",
"zipAddress": "xyz789",
"stateAddress": "abc123",
"signupAddressRequired": true,
"signupEmailRequired": false,
"customerFields": [CustomerField],
"defaultLanguage": "abc123",
"fullstoryEnabled": true,
"settings": PublicBusinessSetting,
"localId": "4"
}
PublicBusinessSetting
PutCustomerAddressesResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
info - String
|
An optional info message |
addresses - [CustomerAddress]!
|
The updated list of addresses |
Example
{
"id": "4",
"localId": 4,
"info": "abc123",
"addresses": [CustomerAddress]
}
QuarterlyComforterCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
dayToSend - Int
|
The day of the month to send the campaign |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
sendReminder - Boolean!
|
Whether to send a reminder message |
reminderDelay - Int
|
How long to wait |
reminderEmail - String
|
The reminder email template to send |
reminderSms - String
|
The reminder sms template to send |
Example
{
"id": 4,
"localId": 4,
"name": "abc123",
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"dayToSend": 123,
"email": "abc123",
"sms": "xyz789",
"sendReminder": false,
"reminderDelay": 123,
"reminderEmail": "xyz789",
"reminderSms": "xyz789"
}
QuarterlyComforterCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
dayToSend - Int
|
The day of the month to send the campaign |
sendReminder - Boolean!
|
Whether to send a reminder message |
reminderDelay - Int
|
How long to wait |
reminderEmail - String
|
The reminder email template to send |
reminderSms - String
|
The reminder sms template to send |
Example
{
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"email": "abc123",
"sms": "xyz789",
"promotion": "abc123",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput,
"dayToSend": 987,
"sendReminder": true,
"reminderDelay": 987,
"reminderEmail": "xyz789",
"reminderSms": "xyz789"
}
QueryReportsResult
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
columns - [QueryReportsResultColumn]!
|
|
values - [String]!
|
|
totalCount - Int!
|
|
kpi - QueryReportsResultKPIValue
|
Example
{
"id": 4,
"localId": 4,
"columns": [QueryReportsResultColumn],
"values": ["xyz789"],
"totalCount": 123,
"kpi": QueryReportsResultKPIValue
}
QueryReportsResultColumn
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
field - String
|
|
index - String
|
|
type - String
|
|
name - String
|
|
sortBy - String
|
|
isSortable - Boolean
|
|
nested - String
|
Example
{
"id": 4,
"localId": 4,
"field": "xyz789",
"index": "xyz789",
"type": "abc123",
"name": "xyz789",
"sortBy": "xyz789",
"isSortable": false,
"nested": "xyz789"
}
QueryReportsResultKPIValue
Rack
Example
{
"id": 4,
"localId": 4,
"name": "xyz789",
"typeName": "xyz789"
}
RackByLockerCodeResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
rack - RackCfg!
|
|
address - CustomerAddress!
|
|
locationLabel - String!
|
Example
{
"id": "4",
"localId": 4,
"rack": RackCfg,
"address": CustomerAddress,
"locationLabel": "abc123"
}
RackCfg
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
address - CustomerAddress!
|
Rack street address if available |
lockerOnRoute - ID
|
Locker route Id if set |
Example
{
"id": "4",
"localId": "4",
"address": CustomerAddress,
"lockerOnRoute": 4
}
RackLog
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
dateScanned - DateTime!
|
The date the bag got scanned to the location |
rack - Rack
|
The rack the bag was scanned to |
locationBarcode - String
|
The unique location barcode |
locationName - String
|
Human readable location name (e.g 10), only guaranteed to be unique within a rack. Could be null, but is normally set |
Example
{
"id": "4",
"localId": "4",
"dateScanned": "2007-12-03T10:15:30Z",
"rack": Rack,
"locationBarcode": "abc123",
"locationName": "xyz789"
}
Review
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
reviewId - String
|
The ID of the review. |
reviewName - String
|
The name of the review resource. |
starRating - Int
|
The star rating of the review. |
comment - String
|
The body of the review as plain text with markups. |
reviewer - Reviewer
|
The reviewer of the review. |
createTime - String
|
The timestamp for when the review was last modified. |
updateTime - String
|
The timestamp for when the review was last updated. |
reviewReply - ReviewReply
|
The reply to the review comment. |
Example
{
"id": "4",
"localId": 4,
"reviewId": "abc123",
"reviewName": "xyz789",
"starRating": 987,
"comment": "abc123",
"reviewer": Reviewer,
"createTime": "abc123",
"updateTime": "xyz789",
"reviewReply": ReviewReply
}
ReviewGenerationCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
frequencyType - String
|
Only send one message per customer per this many days |
frequencyValue - Int
|
The days passed since the oldest ready order to send the campaign |
Example
{
"id": 4,
"localId": 4,
"name": "abc123",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "abc123",
"frequencyType": "abc123",
"frequencyValue": 987
}
ReviewGenerationCampaignInput
Description
The input type for a review generation campaign
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
frequencyType - String
|
Only send one message per customer per this many days |
frequencyValue - Int
|
The days passed since the oldest ready order to send the campaign |
Example
{
"enabled": false,
"priority": "abc123",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "abc123",
"sms": "xyz789",
"frequencyType": "abc123",
"frequencyValue": 987
}
ReviewReply
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
comment - String
|
The body of the review reply as plain text with markups. The maximum length is 4096 bytes. |
updateTime - String
|
The timestamp for when the review reply was last updated. |
replierName - String
|
The name of the review replier. |
Example
{
"id": 4,
"localId": "4",
"comment": "abc123",
"updateTime": "xyz789",
"replierName": "xyz789"
}
Reviewer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
profilePhotoUrl - String
|
The URL of the reviewer's profile photo. |
displayName - String
|
The display name of the reviewer. |
isAnonymous - Boolean
|
Whether the reviewer is anonymous. |
Example
{
"id": "4",
"localId": "4",
"profilePhotoUrl": "abc123",
"displayName": "abc123",
"isAnonymous": false
}
Reward
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
date - String!
|
Date when the reward was earned |
amount - String!
|
The amount which the reward is worth |
status - RewardStatus!
|
Redeem status |
expiryDate - String!
|
The date when the reward expires |
redeemDate - String!
|
The date when the reward was redeemed |
Example
{
"id": 4,
"localId": 4,
"date": "xyz789",
"amount": "xyz789",
"status": "EXPIRED",
"expiryDate": "abc123",
"redeemDate": "xyz789"
}
RewardSettingCriteriaEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADD_EMAIL_CRITERIA"
RewardStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EXPIRED"
Route
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
agentId - ID
|
Unique identifier for the Agent. Can be null for a Group, if the group is not an agent. |
agentType - String
|
The type of Agent. One of "Store", "Route" or "Group". Can be null for a Group, if the group is not an agent. |
name - String!
|
Name of the Agent |
merchant - Merchant
|
The merchant for the agent |
isStripeEnabled - Boolean
|
If an agent is Stripe enabled |
type - String!
|
Type of the route (static or ondemand) |
isSubRoute - Boolean!
|
A master route may have several sub routes. |
masterRouteId - ID
|
The master route this route is a sub of. |
pickupCutoffHours - ID
|
Pickup cutoff time in hours. |
deliveryCutoffHours - ID
|
Delivery cutoff time in hours. |
autoOptimize - Boolean!
|
Delivery cutoff time in hours. |
Example
{
"id": "4",
"localId": 4,
"agentId": 4,
"agentType": "xyz789",
"name": "abc123",
"merchant": Merchant,
"isStripeEnabled": false,
"type": "abc123",
"isSubRoute": true,
"masterRouteId": 4,
"pickupCutoffHours": 4,
"deliveryCutoffHours": 4,
"autoOptimize": false
}
ScheduleDate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
date - DateTime
|
A date |
timeSlots - [TimeSlot]
|
Available time slots for this date |
Example
{
"id": "4",
"localId": "4",
"date": "2007-12-03T10:15:30Z",
"timeSlots": [TimeSlot]
}
Settings
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
mainDeliveryStore - Store
|
|
mainStore - Store
|
|
quickDetailingItemTypes - [ItemType]
|
|
defaultPaymentMethod - PaymentMethod
|
|
acceptedPaymentMethods - [PaymentMethod]
|
|
logo - String
|
|
receiptLogo - String
|
|
POSNewOrderTabs - [ID]
|
|
deliveryNewOrderTabs - [ID]
|
|
statementGenerationDays - [String]
|
|
invoiceGenerationDays - [String]
|
|
acceptedCards - [ID]
|
|
automaticSurcharges - [AutomaticSurcharge]
|
|
detailingAttributes - [String]
|
|
marketingCampaigns - [CampaignSetting]
|
|
welcomeNewCustomerCampaign - WelcomeNewCustomerCampaign
|
|
thankYouCampaign - ThankYouCampaign
|
|
arPastDueCampaign - ArPastDueCampaign
|
|
counterToRouteCampaign - CounterToRouteCampaign
|
|
monthlyNewsletterCampaign - MonthlyNewsletterCampaign
|
|
happyAnniversaryCampaign - HappyAnniversaryCampaign
|
|
inventoryReminderCampaign - InventoryReminderCampaign
|
|
oneAndDoneCampaign - OneAndDoneCampaign
|
|
marketingByDepartmentCampaign - MarketingByDepartmentCampaign
|
|
thankYouTopSpendersCampaign - ThankYouTopSpendersCampaign
|
|
newCustomerRetentionCampaign - NewCustomerRetentionCampaign
|
|
customerSignupNoOrdersCampaign - CustomerSignupNoOrdersCampaign
|
|
noOrdersSinceLastCampaign - NoOrdersSinceLastCampaign
|
|
updateYourInformationCampaign - UpdateYourInformationCampaign
|
|
quarterlyComforterCampaign - QuarterlyComforterCampaign
|
|
thankYouNewReviewCampaign - ThankYouNewReviewCampaign
|
|
lostBigCustomerCampaign - LostBigCustomerCampaign
|
|
reviewGenerationCampaign - ReviewGenerationCampaign
|
|
customCampaign - CustomCampaign
|
|
snapshotEmailList - SnapshotEmailList
|
|
businessName - String
|
Name of the company as should be presented to the customer |
dateFormat - String
|
|
countryCode - String
|
|
timeZone - String
|
|
locale - String
|
|
contactAddressLine - String
|
|
contactAddressState - String
|
|
contactAddressCity - String
|
|
contactAddressZip - String
|
|
contactPhone - String
|
|
logoUrl - String
|
The full URL to a .png file containing the company logo as should be presented to the customer |
noProductionDays - String
|
Comma separated list of 3 letter days the business has no production on (e.g "mon,sun"). |
noDeliveryDays - String
|
Comma separated list of 3 letter days the business has no pickup/delivery service on (e.g "mon,sun"). |
specialHolidays - String
|
Comma separated list of holidays the business is closed on. Possible values: us_christmas,us_newyears,us_independence,us_laborday,us_thanksgiving,us_memorial |
openDetailingWithCategory - ID
|
Open an Item Category automatically in detailing, currently business level only. Provide null to disable, or a ItemCategory_ id to enable for a specific category. |
customerFacingDomain - String
|
|
customSignupUrl - String
|
|
contactEmail - String
|
|
twilioAccountSid - String
|
|
twilioAuthToken - String
|
|
twilioPhone - String
|
|
twilioPhoneLookup - Boolean
|
|
whatsAppEnabled - Boolean
|
|
sendSmsOptOutInformation - Boolean
|
|
userNameOnEmailSubject - Boolean
|
|
payableEntity - String
|
|
emailFooter - String
|
|
lockerBuildingCode - String
|
|
communicationTemplatesId - String
|
|
vcardTemplate - String
|
|
newPickupScheduledInstructions - String
|
|
sendAutomatedMessages - Boolean
|
|
sendStatementEmails - Boolean
|
|
signupEmailRequired - Boolean
|
Is an email address required on signup? |
signupGroupRequired - Boolean
|
|
signupAutofillCity - Boolean
|
|
signupAddressRequired - Boolean
|
|
signupPhoneRequired - Boolean
|
|
allowOrderSplitting - Boolean
|
|
groupOnDetailingSplit - Boolean
|
|
offerStoreDelivery - Boolean
|
|
offerDeliverySchedulingInText - Boolean
|
|
useStoreZipCodeForTax - Boolean
|
|
summarizeByBillingCode - Boolean
|
|
showSalesTaxBreakdownForStatementOrders - Boolean
|
|
sumOrderTotalOnStatements - Boolean
|
|
simplifiedPaymentReceipt - Boolean
|
|
cashTotalRounding - String
|
|
hasLogo - String
|
|
isHotel - Boolean
|
|
isHotelProcessor - Boolean
|
|
isRoomGroupHotel - Boolean
|
|
isLockers - Boolean
|
|
isValet - Boolean
|
|
isWholesaler - Boolean
|
|
pickupUnpaidOrders - Boolean
|
|
pressOnlyDiscount - String
|
|
scheduleWillCallAtAssembly - Boolean
|
|
scheduleWillCallOnDueDate - Boolean
|
|
dontIncludeOrdersInDeliveryListBeforeDueDate - Boolean
|
|
geoFencingEnabled - Boolean
|
|
allowSubDeliveryAccountScheduling - Boolean
|
|
allowSubAccountToTriggerMasterDelivery - Boolean
|
|
sendAutopayReceipts - Boolean
|
|
sendDeliveryAppointmentConfirmation - Boolean
|
|
showDeliveryNotPaid - Boolean
|
|
deliveryAppLoadListSortDescending - Boolean
|
|
requireSignatureOnDelivery - Boolean
|
|
requirePhotoOnDelivery - Boolean
|
|
showSubRouteForDeliveryStop - Boolean
|
|
genericLaundryBagMode - Boolean
|
|
rushNotificationsHour - String
|
|
websiteDisplayText - String
|
|
shouldShowWebsiteOnReceipts - Boolean
|
|
showAgentOnBagTag - Boolean
|
|
assemblyEvenOnly - Boolean
|
|
voiceAssemblyEnabled - Boolean
|
|
inspectPriceAtAssembly - Boolean
|
|
assemblyPrintFinancialReceiptForDeliveryCustomer - Boolean
|
|
assemblyAlwaysPrintFinancialReceipt - Boolean
|
|
printFinancialTicketOutsideAssembly - Boolean
|
|
keepRackAssignmentOnOrderSplit - Boolean
|
|
complexLotControl - Boolean
|
|
overrideDueDateWithNextDelivery - Boolean
|
|
autoSelectDeliveryReturnLocation - Boolean
|
|
defaultDetailingTab - String
|
|
autoOpenAnnotationType - Boolean
|
|
requireInvoiceInDetailing - Boolean
|
|
displayTooManyDetailedItemsWarning - Boolean
|
|
assemblyIcon - String
|
|
alignAssemblyIcon - String
|
|
newCustomerTicketIcon - String
|
|
newCustomerBottomTicketIcon - String
|
|
customerNameOnTicketBottom - Boolean
|
|
pieceCountOnTicketBottom - Boolean
|
|
customerPhoneOnTicket - Boolean
|
|
showRoomInfoBelowAddress - Boolean
|
|
laundryLicense - String
|
|
summarizedItemTable - Boolean
|
|
showLogoOnReceipts - Boolean
|
|
logoOnReceiptHeight - String
|
|
receiptLogoName - String
|
|
showPriceOnAssembly - Boolean
|
|
paymentReceiptShowSignatureLine - Boolean
|
|
receiptsNameShort - String
|
|
newLocationOnTicket - Boolean
|
|
showRouteOfSameDayDelivery - Boolean
|
|
itemDetailsOnTicket - Boolean
|
|
itemDetailsOnOrderReceipt - Boolean
|
|
newOrderPrintCount - String
|
|
printRetailReceipts - Boolean
|
|
printDropTicketOnOrderSplit - Boolean
|
|
printTicketOnOrderCloseCount - String
|
|
noStoreContactInfoOnReceipts - Boolean
|
|
noPricingOnOrderReceipts - Boolean
|
|
receiptsFooter - String
|
|
thermalReceiptFooter - String
|
|
ticketReceiptFooter - String
|
|
showEmailOnReceipts - Boolean
|
|
showWebsiteOnReceipts - Boolean
|
|
invoicePayableLine - String
|
|
invoiceTerms - String
|
|
isRestorationAccount - Boolean
|
|
offerDemandDelivery - Boolean
|
|
autoAddNewCustomerToWillCallRoute - ID
|
|
groupItemDetailsByRoomNumber - Boolean
|
|
merchantBatchCloseTime - String
|
|
saveCardsOnFile - Boolean
|
|
amexSeparately - Boolean
|
|
maxAutopayAmount - String
|
|
maxPaymentAmountWarning - String
|
|
autopayTerms - ID
|
|
autopayStatements - Boolean
|
|
autopayBatchStrategy - ID
|
|
invoiceDueDays - String
|
|
consolidateInvoiceItemDetails - Boolean
|
|
invoiceShowOrderDetails - Boolean
|
|
invoiceHideOrderInfo - Boolean
|
|
showDateOnStatement - Boolean
|
|
callStatementInvoice - Boolean
|
|
activitySummaryEnabled - Boolean
|
|
attachPDFInStatementEmails - Boolean
|
|
rewardsProgramEnabled - Boolean
|
|
rewardsPointModifier - String
|
|
rewardsCurrencyModifier - String
|
|
rewardsConversionRequirement - String
|
|
rewardsRedeemAutomatically - Boolean
|
|
rewardsEmailRequired - Boolean
|
|
rewardsPhoneRequired - Boolean
|
|
rewardsAddressRequired - Boolean
|
|
rewardsCreditCardRequired - Boolean
|
|
welcomeNotificationDisabled - Boolean
|
|
autoTicketOnCustomerRegistration - Boolean
|
|
autoTicketOnScheduledDelivery - Boolean
|
|
sendCustomerUpdatedCCNotification - Boolean
|
|
allowScheduleBothPickupAndDelivery - Boolean
|
|
limitScheduleDeliveryToClosestRoute - Boolean
|
|
allowRouteRegularCustomersToScheduleOnDemand - Boolean
|
|
allowSameDaySchedulingEvenIfRouteStarted - Boolean
|
|
experimentalPhotoUserExperienceOnWebsiteScheduler - Boolean
|
|
priceListUpdateOrdersCondition - String
|
|
routeAgentPriority - Boolean
|
|
commonOrdersAgent - Boolean
|
|
isMailOrderPickups - Boolean
|
|
lockerDropBinPickupMode - Boolean
|
|
showYesRepliesInComm - Boolean
|
|
autoReplyToYesRepliesInComm - Boolean
|
|
customerWebsiteClothesTrackerTabEnabled - Boolean
|
|
customerWebsiteWardrobeTabEnabled - Boolean
|
|
customerWebsitePaymentTabEnabled - Boolean
|
|
metalprogettiAssemblyLabelTemplate - String
|
|
metalprogettiSendRackSpaceToStorage - Boolean
|
|
rushOrderSurcharge - String
|
|
rushOrderSurchargeTier2 - String
|
|
sendNewOrderNotificationOnEveryVisit - Boolean
|
|
includeReceiptInNewOrderNotification - Boolean
|
|
printTempTagsForBarcodedItems - Boolean
|
|
alwaysGenerateTemporaryBarcodes - Boolean
|
|
zebraPrinterTemplate - String
|
|
epsonPrinterTemplate - String
|
|
forceOnlyBagFieldInput - Boolean
|
|
detailingWithoutBarcodes - Boolean
|
|
printLabelsWhenDuplicating - Boolean
|
|
metalprogettiStripCharacters - String
|
|
autoDetailingEnabled - Boolean
|
|
minItemBarcodeLength - String
|
|
maxItemBarcodeLength - String
|
|
quotesDeletionTimeFrame - String
|
|
minWashNFoldPrice - String
|
|
minWashNFoldWeight - String
|
|
washAndFoldWeightStations - Boolean
|
|
departmentSpecificOrdersEnabled - Boolean
|
|
manualPickupRestricted - Boolean
|
|
displayDueDateInProductionModules - Boolean
|
|
filterDetailingByItemTypes - Boolean
|
|
automaticallyFilterReportsToEmployeesStore - Boolean
|
|
payrollPeriod - String
|
This setting defines the payroll period for a business. |
payrollLastCloseDate - String
|
|
payrollFirstHalfCloseDate - String
|
|
payrollLastHalfCloseDate - String
|
|
payrollCloseDate - String
|
|
workweekStart - String
|
|
hoursUntilWeeklyOvertime - String
|
|
hoursUntilDailyOvertime - String
|
|
hoursUntilDailyDoubleTime - String
|
|
hoursUntilWeeklyNotification - String
|
|
hoursUntilDailyNotification - String
|
|
preventClockInBeforeTime - String
|
|
californiaOvertimeRules - Boolean
|
|
promptForClockInOnLogin - Boolean
|
|
overrideTimeClockWithUserDepartment - Boolean
|
|
allowMobileAppClockIn - Boolean
|
|
disableOverTimeNotifications - Boolean
|
|
overnightClockOut - Boolean
|
|
inventorySystemEnabled - Boolean
|
|
inventorySystemEnabledProduction - Boolean
|
|
permissionManageSystemSettings - String
|
|
permissionManageMarketing - String
|
|
permissionManageStationSettings - String
|
|
permissionAccessCustomerCredits - String
|
|
permissionAddCustomerDiscount - String
|
|
permissionAccessCustomerModule - String
|
|
permissionAccessDeliveryModule - String
|
|
permissionAccessAssemblyModule - String
|
|
permissionAccessSpottingModule - String
|
|
permissionAccessAlterAndRepairModule - String
|
|
permissionAccessAccountsReceivableModule - String
|
|
permissionAccessPressingModule - String
|
|
permissionAccessPriceListModule - String
|
|
permissionAccessCashBoxModule - String
|
|
permissionAccessTimeclockModule - String
|
|
permissionAccessPerformanceModule - String
|
|
permissionAccessWashAndFoldModule - String
|
|
permissionAccessInspectionModule - String
|
|
permissionAccessItemBaggingModule - String
|
|
permissionAccessFoldingAndBaggingModule - String
|
|
permissionAccessMessagesModule - String
|
|
permissionAccessRackingModule - String
|
|
permissionAccessRouteManagerModule - String
|
|
permissionAccessReportsModule - String
|
|
permissionAccessAdminReportsModule - String
|
|
permissionAccessIssueTrackerModule - String
|
|
permissionAccessSupportModule - String
|
|
permissionAccessEmployeeSettingsModule - String
|
|
permissionAccessBulkMarkinModule - String
|
|
permissionManualPriceEdits - String
|
|
permissionSpecialCareAfterOrderClose - String
|
|
permissionResetOrder - String
|
|
permissionRemoveItems - String
|
|
showStrikeThroughWhenReturned - Boolean
|
|
usePieceCountTotalsOnTicket - Boolean
|
|
taxHeaderString - String
|
|
includeTaxInPrice - Boolean
|
|
dropDateOnAssemblyTicket - Boolean
|
|
displayDepartmentOnTicket - Boolean
|
|
displayCategoryOnTicket - Boolean
|
|
displayPriceOnPickupSlip - Boolean
|
|
useStoreSpecificOrderSequenceNumbers - Boolean
|
|
showStoreSpecificOrderNumberOnTop - Boolean
|
|
saleItemLedgerTrackingEnabled - Boolean
|
|
inOnboarding - Boolean
|
|
noCcCustomerText - Boolean
|
|
pickupReminderOfferCancellations - Boolean
|
|
pickupReminderEnabledForInactiveCustomers - Boolean
|
|
offersRetailDelivery - Boolean
|
|
regRouteQuestionChecked - Boolean
|
|
pickupReminderHour24 - String
|
|
pickupReminderIncludeDeliveries - Boolean
|
|
deliveryCompleteConfirmation - Boolean
|
|
defaultCustomerPaymentType - String
|
|
promptOnCardAvsFailure - Boolean
|
|
minCardChargeAmount - String
|
|
defaultCustomerPriceList - String
|
|
cardSurcharging - String
|
|
cardSurchargeFixedPercentage - String
|
|
organizationNumber - String
|
|
fullstoryEnabled - Boolean
|
|
initializedInferred - Boolean
|
|
cashBoxMode - String
|
|
cashBoxModeProduction - String
|
|
displayExtendedStationReceiptInfo - Boolean
|
|
displayExtendedZReportInfo - Boolean
|
|
twilioMarketingNumber - String
|
|
campaignsEnabled - Boolean
|
|
broadcastsEnabled - Boolean
|
|
reviewModuleEnabled - Boolean
|
|
defaultLanguage - String
|
|
weightUnit - String
|
|
segmentWriteKey - String
|
|
socialId - String
|
|
twilioReviewNumber - String
|
Example
{
"id": 4,
"localId": 4,
"mainDeliveryStore": Store,
"mainStore": Store,
"quickDetailingItemTypes": [ItemType],
"defaultPaymentMethod": PaymentMethod,
"acceptedPaymentMethods": [PaymentMethod],
"logo": "abc123",
"receiptLogo": "xyz789",
"POSNewOrderTabs": [4],
"deliveryNewOrderTabs": [4],
"statementGenerationDays": ["xyz789"],
"invoiceGenerationDays": ["abc123"],
"acceptedCards": ["4"],
"automaticSurcharges": [AutomaticSurcharge],
"detailingAttributes": ["abc123"],
"marketingCampaigns": [CampaignSetting],
"welcomeNewCustomerCampaign": WelcomeNewCustomerCampaign,
"thankYouCampaign": ThankYouCampaign,
"arPastDueCampaign": ArPastDueCampaign,
"counterToRouteCampaign": CounterToRouteCampaign,
"monthlyNewsletterCampaign": MonthlyNewsletterCampaign,
"happyAnniversaryCampaign": HappyAnniversaryCampaign,
"inventoryReminderCampaign": InventoryReminderCampaign,
"oneAndDoneCampaign": OneAndDoneCampaign,
"marketingByDepartmentCampaign": MarketingByDepartmentCampaign,
"thankYouTopSpendersCampaign": ThankYouTopSpendersCampaign,
"newCustomerRetentionCampaign": NewCustomerRetentionCampaign,
"customerSignupNoOrdersCampaign": CustomerSignupNoOrdersCampaign,
"noOrdersSinceLastCampaign": NoOrdersSinceLastCampaign,
"updateYourInformationCampaign": UpdateYourInformationCampaign,
"quarterlyComforterCampaign": QuarterlyComforterCampaign,
"thankYouNewReviewCampaign": ThankYouNewReviewCampaign,
"lostBigCustomerCampaign": LostBigCustomerCampaign,
"reviewGenerationCampaign": ReviewGenerationCampaign,
"customCampaign": CustomCampaign,
"snapshotEmailList": SnapshotEmailList,
"businessName": "abc123",
"dateFormat": "xyz789",
"countryCode": "xyz789",
"timeZone": "xyz789",
"locale": "xyz789",
"contactAddressLine": "xyz789",
"contactAddressState": "abc123",
"contactAddressCity": "abc123",
"contactAddressZip": "abc123",
"contactPhone": "abc123",
"logoUrl": "xyz789",
"noProductionDays": "xyz789",
"noDeliveryDays": "abc123",
"specialHolidays": "abc123",
"openDetailingWithCategory": 4,
"customerFacingDomain": "abc123",
"customSignupUrl": "abc123",
"contactEmail": "xyz789",
"twilioAccountSid": "xyz789",
"twilioAuthToken": "abc123",
"twilioPhone": "abc123",
"twilioPhoneLookup": true,
"whatsAppEnabled": true,
"sendSmsOptOutInformation": false,
"userNameOnEmailSubject": true,
"payableEntity": "abc123",
"emailFooter": "abc123",
"lockerBuildingCode": "xyz789",
"communicationTemplatesId": "xyz789",
"vcardTemplate": "xyz789",
"newPickupScheduledInstructions": "xyz789",
"sendAutomatedMessages": false,
"sendStatementEmails": true,
"signupEmailRequired": true,
"signupGroupRequired": true,
"signupAutofillCity": false,
"signupAddressRequired": false,
"signupPhoneRequired": false,
"allowOrderSplitting": false,
"groupOnDetailingSplit": false,
"offerStoreDelivery": false,
"offerDeliverySchedulingInText": true,
"useStoreZipCodeForTax": true,
"summarizeByBillingCode": true,
"showSalesTaxBreakdownForStatementOrders": false,
"sumOrderTotalOnStatements": true,
"simplifiedPaymentReceipt": false,
"cashTotalRounding": "abc123",
"hasLogo": "xyz789",
"isHotel": false,
"isHotelProcessor": false,
"isRoomGroupHotel": true,
"isLockers": true,
"isValet": true,
"isWholesaler": true,
"pickupUnpaidOrders": false,
"pressOnlyDiscount": "xyz789",
"scheduleWillCallAtAssembly": true,
"scheduleWillCallOnDueDate": false,
"dontIncludeOrdersInDeliveryListBeforeDueDate": false,
"geoFencingEnabled": false,
"allowSubDeliveryAccountScheduling": false,
"allowSubAccountToTriggerMasterDelivery": false,
"sendAutopayReceipts": true,
"sendDeliveryAppointmentConfirmation": false,
"showDeliveryNotPaid": true,
"deliveryAppLoadListSortDescending": true,
"requireSignatureOnDelivery": false,
"requirePhotoOnDelivery": false,
"showSubRouteForDeliveryStop": false,
"genericLaundryBagMode": false,
"rushNotificationsHour": "xyz789",
"websiteDisplayText": "abc123",
"shouldShowWebsiteOnReceipts": true,
"showAgentOnBagTag": true,
"assemblyEvenOnly": false,
"voiceAssemblyEnabled": false,
"inspectPriceAtAssembly": false,
"assemblyPrintFinancialReceiptForDeliveryCustomer": true,
"assemblyAlwaysPrintFinancialReceipt": true,
"printFinancialTicketOutsideAssembly": true,
"keepRackAssignmentOnOrderSplit": false,
"complexLotControl": false,
"overrideDueDateWithNextDelivery": true,
"autoSelectDeliveryReturnLocation": true,
"defaultDetailingTab": "xyz789",
"autoOpenAnnotationType": false,
"requireInvoiceInDetailing": true,
"displayTooManyDetailedItemsWarning": true,
"assemblyIcon": "xyz789",
"alignAssemblyIcon": "abc123",
"newCustomerTicketIcon": "xyz789",
"newCustomerBottomTicketIcon": "xyz789",
"customerNameOnTicketBottom": false,
"pieceCountOnTicketBottom": false,
"customerPhoneOnTicket": true,
"showRoomInfoBelowAddress": true,
"laundryLicense": "abc123",
"summarizedItemTable": false,
"showLogoOnReceipts": true,
"logoOnReceiptHeight": "abc123",
"receiptLogoName": "abc123",
"showPriceOnAssembly": true,
"paymentReceiptShowSignatureLine": false,
"receiptsNameShort": "abc123",
"newLocationOnTicket": false,
"showRouteOfSameDayDelivery": true,
"itemDetailsOnTicket": true,
"itemDetailsOnOrderReceipt": true,
"newOrderPrintCount": "abc123",
"printRetailReceipts": true,
"printDropTicketOnOrderSplit": true,
"printTicketOnOrderCloseCount": "xyz789",
"noStoreContactInfoOnReceipts": false,
"noPricingOnOrderReceipts": false,
"receiptsFooter": "xyz789",
"thermalReceiptFooter": "xyz789",
"ticketReceiptFooter": "xyz789",
"showEmailOnReceipts": true,
"showWebsiteOnReceipts": false,
"invoicePayableLine": "xyz789",
"invoiceTerms": "xyz789",
"isRestorationAccount": false,
"offerDemandDelivery": true,
"autoAddNewCustomerToWillCallRoute": "4",
"groupItemDetailsByRoomNumber": false,
"merchantBatchCloseTime": "abc123",
"saveCardsOnFile": true,
"amexSeparately": false,
"maxAutopayAmount": "abc123",
"maxPaymentAmountWarning": "abc123",
"autopayTerms": "4",
"autopayStatements": true,
"autopayBatchStrategy": "4",
"invoiceDueDays": "xyz789",
"consolidateInvoiceItemDetails": false,
"invoiceShowOrderDetails": true,
"invoiceHideOrderInfo": true,
"showDateOnStatement": false,
"callStatementInvoice": true,
"activitySummaryEnabled": false,
"attachPDFInStatementEmails": true,
"rewardsProgramEnabled": false,
"rewardsPointModifier": "xyz789",
"rewardsCurrencyModifier": "abc123",
"rewardsConversionRequirement": "xyz789",
"rewardsRedeemAutomatically": true,
"rewardsEmailRequired": false,
"rewardsPhoneRequired": true,
"rewardsAddressRequired": false,
"rewardsCreditCardRequired": false,
"welcomeNotificationDisabled": false,
"autoTicketOnCustomerRegistration": true,
"autoTicketOnScheduledDelivery": true,
"sendCustomerUpdatedCCNotification": true,
"allowScheduleBothPickupAndDelivery": false,
"limitScheduleDeliveryToClosestRoute": true,
"allowRouteRegularCustomersToScheduleOnDemand": true,
"allowSameDaySchedulingEvenIfRouteStarted": true,
"experimentalPhotoUserExperienceOnWebsiteScheduler": true,
"priceListUpdateOrdersCondition": "abc123",
"routeAgentPriority": true,
"commonOrdersAgent": true,
"isMailOrderPickups": true,
"lockerDropBinPickupMode": false,
"showYesRepliesInComm": true,
"autoReplyToYesRepliesInComm": false,
"customerWebsiteClothesTrackerTabEnabled": false,
"customerWebsiteWardrobeTabEnabled": false,
"customerWebsitePaymentTabEnabled": true,
"metalprogettiAssemblyLabelTemplate": "abc123",
"metalprogettiSendRackSpaceToStorage": false,
"rushOrderSurcharge": "xyz789",
"rushOrderSurchargeTier2": "xyz789",
"sendNewOrderNotificationOnEveryVisit": true,
"includeReceiptInNewOrderNotification": true,
"printTempTagsForBarcodedItems": false,
"alwaysGenerateTemporaryBarcodes": false,
"zebraPrinterTemplate": "xyz789",
"epsonPrinterTemplate": "xyz789",
"forceOnlyBagFieldInput": true,
"detailingWithoutBarcodes": true,
"printLabelsWhenDuplicating": true,
"metalprogettiStripCharacters": "xyz789",
"autoDetailingEnabled": false,
"minItemBarcodeLength": "xyz789",
"maxItemBarcodeLength": "xyz789",
"quotesDeletionTimeFrame": "xyz789",
"minWashNFoldPrice": "xyz789",
"minWashNFoldWeight": "xyz789",
"washAndFoldWeightStations": false,
"departmentSpecificOrdersEnabled": false,
"manualPickupRestricted": false,
"displayDueDateInProductionModules": false,
"filterDetailingByItemTypes": true,
"automaticallyFilterReportsToEmployeesStore": false,
"payrollPeriod": "abc123",
"payrollLastCloseDate": "xyz789",
"payrollFirstHalfCloseDate": "xyz789",
"payrollLastHalfCloseDate": "abc123",
"payrollCloseDate": "xyz789",
"workweekStart": "xyz789",
"hoursUntilWeeklyOvertime": "abc123",
"hoursUntilDailyOvertime": "abc123",
"hoursUntilDailyDoubleTime": "xyz789",
"hoursUntilWeeklyNotification": "abc123",
"hoursUntilDailyNotification": "xyz789",
"preventClockInBeforeTime": "abc123",
"californiaOvertimeRules": true,
"promptForClockInOnLogin": false,
"overrideTimeClockWithUserDepartment": false,
"allowMobileAppClockIn": true,
"disableOverTimeNotifications": false,
"overnightClockOut": false,
"inventorySystemEnabled": false,
"inventorySystemEnabledProduction": false,
"permissionManageSystemSettings": "xyz789",
"permissionManageMarketing": "xyz789",
"permissionManageStationSettings": "abc123",
"permissionAccessCustomerCredits": "abc123",
"permissionAddCustomerDiscount": "abc123",
"permissionAccessCustomerModule": "abc123",
"permissionAccessDeliveryModule": "abc123",
"permissionAccessAssemblyModule": "abc123",
"permissionAccessSpottingModule": "xyz789",
"permissionAccessAlterAndRepairModule": "abc123",
"permissionAccessAccountsReceivableModule": "xyz789",
"permissionAccessPressingModule": "abc123",
"permissionAccessPriceListModule": "abc123",
"permissionAccessCashBoxModule": "abc123",
"permissionAccessTimeclockModule": "abc123",
"permissionAccessPerformanceModule": "abc123",
"permissionAccessWashAndFoldModule": "xyz789",
"permissionAccessInspectionModule": "abc123",
"permissionAccessItemBaggingModule": "abc123",
"permissionAccessFoldingAndBaggingModule": "xyz789",
"permissionAccessMessagesModule": "abc123",
"permissionAccessRackingModule": "xyz789",
"permissionAccessRouteManagerModule": "xyz789",
"permissionAccessReportsModule": "abc123",
"permissionAccessAdminReportsModule": "abc123",
"permissionAccessIssueTrackerModule": "xyz789",
"permissionAccessSupportModule": "abc123",
"permissionAccessEmployeeSettingsModule": "abc123",
"permissionAccessBulkMarkinModule": "abc123",
"permissionManualPriceEdits": "abc123",
"permissionSpecialCareAfterOrderClose": "xyz789",
"permissionResetOrder": "xyz789",
"permissionRemoveItems": "abc123",
"showStrikeThroughWhenReturned": false,
"usePieceCountTotalsOnTicket": false,
"taxHeaderString": "xyz789",
"includeTaxInPrice": true,
"dropDateOnAssemblyTicket": true,
"displayDepartmentOnTicket": true,
"displayCategoryOnTicket": false,
"displayPriceOnPickupSlip": false,
"useStoreSpecificOrderSequenceNumbers": true,
"showStoreSpecificOrderNumberOnTop": true,
"saleItemLedgerTrackingEnabled": true,
"inOnboarding": true,
"noCcCustomerText": true,
"pickupReminderOfferCancellations": false,
"pickupReminderEnabledForInactiveCustomers": false,
"offersRetailDelivery": false,
"regRouteQuestionChecked": true,
"pickupReminderHour24": "abc123",
"pickupReminderIncludeDeliveries": true,
"deliveryCompleteConfirmation": true,
"defaultCustomerPaymentType": "abc123",
"promptOnCardAvsFailure": false,
"minCardChargeAmount": "abc123",
"defaultCustomerPriceList": "xyz789",
"cardSurcharging": "abc123",
"cardSurchargeFixedPercentage": "abc123",
"organizationNumber": "abc123",
"fullstoryEnabled": true,
"initializedInferred": true,
"cashBoxMode": "abc123",
"cashBoxModeProduction": "abc123",
"displayExtendedStationReceiptInfo": false,
"displayExtendedZReportInfo": true,
"twilioMarketingNumber": "xyz789",
"campaignsEnabled": true,
"broadcastsEnabled": false,
"reviewModuleEnabled": true,
"defaultLanguage": "abc123",
"weightUnit": "xyz789",
"segmentWriteKey": "abc123",
"socialId": "abc123",
"twilioReviewNumber": "abc123"
}
SettingsInput
Description
Update various settings connected to a Business, Brand, Customer Group or Customer. These settings are configured by employees of the business.
Fields
| Input Field | Description |
|---|---|
businessName - String
|
Name of the company as should be presented to the customer |
dateFormat - String
|
|
countryCode - String
|
|
timeZone - String
|
|
locale - String
|
|
contactAddressLine - String
|
|
contactAddressState - String
|
|
contactAddressCity - String
|
|
contactAddressZip - String
|
|
contactPhone - String
|
|
logoUrl - String
|
The full URL to a .png file containing the company logo as should be presented to the customer |
noProductionDays - String
|
Comma separated list of 3 letter days the business has no production on (e.g "mon,sun"). |
noDeliveryDays - String
|
Comma separated list of 3 letter days the business has no pickup/delivery service on (e.g "mon,sun"). |
specialHolidays - String
|
Comma separated list of holidays the business is closed on. Possible values: us_christmas,us_newyears,us_independence,us_laborday,us_thanksgiving,us_memorial |
openDetailingWithCategory - ID
|
Open an Item Category automatically in detailing, currently business level only. Provide null to disable, or a ItemCategory_ id to enable for a specific category. |
customerFacingDomain - String
|
|
customSignupUrl - String
|
|
contactEmail - String
|
|
twilioAccountSid - String
|
|
twilioAuthToken - String
|
|
twilioPhone - String
|
|
twilioPhoneLookup - Boolean
|
|
whatsAppEnabled - Boolean
|
|
sendSmsOptOutInformation - Boolean
|
|
userNameOnEmailSubject - Boolean
|
|
payableEntity - String
|
|
emailFooter - String
|
|
lockerBuildingCode - String
|
|
communicationTemplatesId - String
|
|
vcardTemplate - String
|
|
newPickupScheduledInstructions - String
|
|
sendAutomatedMessages - Boolean
|
|
sendStatementEmails - Boolean
|
|
signupEmailRequired - Boolean
|
Is an email address required on signup? |
signupGroupRequired - Boolean
|
|
signupAutofillCity - Boolean
|
|
signupAddressRequired - Boolean
|
|
signupPhoneRequired - Boolean
|
|
allowOrderSplitting - Boolean
|
|
groupOnDetailingSplit - Boolean
|
|
offerStoreDelivery - Boolean
|
|
offerDeliverySchedulingInText - Boolean
|
|
useStoreZipCodeForTax - Boolean
|
|
summarizeByBillingCode - Boolean
|
|
showSalesTaxBreakdownForStatementOrders - Boolean
|
|
sumOrderTotalOnStatements - Boolean
|
|
simplifiedPaymentReceipt - Boolean
|
|
cashTotalRounding - String
|
|
hasLogo - String
|
|
isHotel - Boolean
|
|
isHotelProcessor - Boolean
|
|
isRoomGroupHotel - Boolean
|
|
isLockers - Boolean
|
|
isValet - Boolean
|
|
isWholesaler - Boolean
|
|
pickupUnpaidOrders - Boolean
|
|
pressOnlyDiscount - String
|
|
scheduleWillCallAtAssembly - Boolean
|
|
scheduleWillCallOnDueDate - Boolean
|
|
dontIncludeOrdersInDeliveryListBeforeDueDate - Boolean
|
|
geoFencingEnabled - Boolean
|
|
allowSubDeliveryAccountScheduling - Boolean
|
|
allowSubAccountToTriggerMasterDelivery - Boolean
|
|
sendAutopayReceipts - Boolean
|
|
sendDeliveryAppointmentConfirmation - Boolean
|
|
showDeliveryNotPaid - Boolean
|
|
deliveryAppLoadListSortDescending - Boolean
|
|
requireSignatureOnDelivery - Boolean
|
|
requirePhotoOnDelivery - Boolean
|
|
showSubRouteForDeliveryStop - Boolean
|
|
genericLaundryBagMode - Boolean
|
|
rushNotificationsHour - String
|
|
websiteDisplayText - String
|
|
shouldShowWebsiteOnReceipts - Boolean
|
|
showAgentOnBagTag - Boolean
|
|
assemblyEvenOnly - Boolean
|
|
voiceAssemblyEnabled - Boolean
|
|
inspectPriceAtAssembly - Boolean
|
|
assemblyPrintFinancialReceiptForDeliveryCustomer - Boolean
|
|
assemblyAlwaysPrintFinancialReceipt - Boolean
|
|
printFinancialTicketOutsideAssembly - Boolean
|
|
keepRackAssignmentOnOrderSplit - Boolean
|
|
complexLotControl - Boolean
|
|
overrideDueDateWithNextDelivery - Boolean
|
|
autoSelectDeliveryReturnLocation - Boolean
|
|
defaultDetailingTab - String
|
|
autoOpenAnnotationType - Boolean
|
|
requireInvoiceInDetailing - Boolean
|
|
displayTooManyDetailedItemsWarning - Boolean
|
|
assemblyIcon - String
|
|
alignAssemblyIcon - String
|
|
newCustomerTicketIcon - String
|
|
newCustomerBottomTicketIcon - String
|
|
customerNameOnTicketBottom - Boolean
|
|
pieceCountOnTicketBottom - Boolean
|
|
customerPhoneOnTicket - Boolean
|
|
showRoomInfoBelowAddress - Boolean
|
|
laundryLicense - String
|
|
summarizedItemTable - Boolean
|
|
showLogoOnReceipts - Boolean
|
|
logoOnReceiptHeight - String
|
|
receiptLogoName - String
|
|
showPriceOnAssembly - Boolean
|
|
paymentReceiptShowSignatureLine - Boolean
|
|
receiptsNameShort - String
|
|
newLocationOnTicket - Boolean
|
|
showRouteOfSameDayDelivery - Boolean
|
|
itemDetailsOnTicket - Boolean
|
|
itemDetailsOnOrderReceipt - Boolean
|
|
newOrderPrintCount - String
|
|
printRetailReceipts - Boolean
|
|
printDropTicketOnOrderSplit - Boolean
|
|
printTicketOnOrderCloseCount - String
|
|
noStoreContactInfoOnReceipts - Boolean
|
|
noPricingOnOrderReceipts - Boolean
|
|
receiptsFooter - String
|
|
thermalReceiptFooter - String
|
|
ticketReceiptFooter - String
|
|
showEmailOnReceipts - Boolean
|
|
showWebsiteOnReceipts - Boolean
|
|
invoicePayableLine - String
|
|
invoiceTerms - String
|
|
isRestorationAccount - Boolean
|
|
offerDemandDelivery - Boolean
|
|
autoAddNewCustomerToWillCallRoute - ID
|
|
groupItemDetailsByRoomNumber - Boolean
|
|
merchantBatchCloseTime - String
|
|
saveCardsOnFile - Boolean
|
|
amexSeparately - Boolean
|
|
maxAutopayAmount - String
|
|
maxPaymentAmountWarning - String
|
|
autopayTerms - ID
|
|
autopayStatements - Boolean
|
|
autopayBatchStrategy - ID
|
|
invoiceDueDays - String
|
|
consolidateInvoiceItemDetails - Boolean
|
|
invoiceShowOrderDetails - Boolean
|
|
invoiceHideOrderInfo - Boolean
|
|
showDateOnStatement - Boolean
|
|
callStatementInvoice - Boolean
|
|
activitySummaryEnabled - Boolean
|
|
attachPDFInStatementEmails - Boolean
|
|
rewardsProgramEnabled - Boolean
|
|
rewardsPointModifier - String
|
|
rewardsCurrencyModifier - String
|
|
rewardsConversionRequirement - String
|
|
rewardsRedeemAutomatically - Boolean
|
|
rewardsEmailRequired - Boolean
|
|
rewardsPhoneRequired - Boolean
|
|
rewardsAddressRequired - Boolean
|
|
rewardsCreditCardRequired - Boolean
|
|
welcomeNotificationDisabled - Boolean
|
|
autoTicketOnCustomerRegistration - Boolean
|
|
autoTicketOnScheduledDelivery - Boolean
|
|
sendCustomerUpdatedCCNotification - Boolean
|
|
allowScheduleBothPickupAndDelivery - Boolean
|
|
limitScheduleDeliveryToClosestRoute - Boolean
|
|
allowRouteRegularCustomersToScheduleOnDemand - Boolean
|
|
allowSameDaySchedulingEvenIfRouteStarted - Boolean
|
|
experimentalPhotoUserExperienceOnWebsiteScheduler - Boolean
|
|
priceListUpdateOrdersCondition - String
|
|
routeAgentPriority - Boolean
|
|
commonOrdersAgent - Boolean
|
|
isMailOrderPickups - Boolean
|
|
lockerDropBinPickupMode - Boolean
|
|
showYesRepliesInComm - Boolean
|
|
autoReplyToYesRepliesInComm - Boolean
|
|
customerWebsiteClothesTrackerTabEnabled - Boolean
|
|
customerWebsiteWardrobeTabEnabled - Boolean
|
|
customerWebsitePaymentTabEnabled - Boolean
|
|
metalprogettiAssemblyLabelTemplate - String
|
|
metalprogettiSendRackSpaceToStorage - Boolean
|
|
rushOrderSurcharge - String
|
|
rushOrderSurchargeTier2 - String
|
|
sendNewOrderNotificationOnEveryVisit - Boolean
|
|
includeReceiptInNewOrderNotification - Boolean
|
|
printTempTagsForBarcodedItems - Boolean
|
|
alwaysGenerateTemporaryBarcodes - Boolean
|
|
zebraPrinterTemplate - String
|
|
epsonPrinterTemplate - String
|
|
forceOnlyBagFieldInput - Boolean
|
|
detailingWithoutBarcodes - Boolean
|
|
printLabelsWhenDuplicating - Boolean
|
|
metalprogettiStripCharacters - String
|
|
autoDetailingEnabled - Boolean
|
|
minItemBarcodeLength - String
|
|
maxItemBarcodeLength - String
|
|
quotesDeletionTimeFrame - String
|
|
minWashNFoldPrice - String
|
|
minWashNFoldWeight - String
|
|
washAndFoldWeightStations - Boolean
|
|
departmentSpecificOrdersEnabled - Boolean
|
|
manualPickupRestricted - Boolean
|
|
displayDueDateInProductionModules - Boolean
|
|
filterDetailingByItemTypes - Boolean
|
|
automaticallyFilterReportsToEmployeesStore - Boolean
|
|
payrollPeriod - String
|
This setting defines the payroll period for a business. |
payrollLastCloseDate - String
|
|
payrollFirstHalfCloseDate - String
|
|
payrollLastHalfCloseDate - String
|
|
payrollCloseDate - String
|
|
workweekStart - String
|
|
hoursUntilWeeklyOvertime - String
|
|
hoursUntilDailyOvertime - String
|
|
hoursUntilDailyDoubleTime - String
|
|
hoursUntilWeeklyNotification - String
|
|
hoursUntilDailyNotification - String
|
|
preventClockInBeforeTime - String
|
|
californiaOvertimeRules - Boolean
|
|
promptForClockInOnLogin - Boolean
|
|
overrideTimeClockWithUserDepartment - Boolean
|
|
allowMobileAppClockIn - Boolean
|
|
disableOverTimeNotifications - Boolean
|
|
overnightClockOut - Boolean
|
|
inventorySystemEnabled - Boolean
|
|
inventorySystemEnabledProduction - Boolean
|
|
permissionManageSystemSettings - String
|
|
permissionManageMarketing - String
|
|
permissionManageStationSettings - String
|
|
permissionAccessCustomerCredits - String
|
|
permissionAddCustomerDiscount - String
|
|
permissionAccessCustomerModule - String
|
|
permissionAccessDeliveryModule - String
|
|
permissionAccessAssemblyModule - String
|
|
permissionAccessSpottingModule - String
|
|
permissionAccessAlterAndRepairModule - String
|
|
permissionAccessAccountsReceivableModule - String
|
|
permissionAccessPressingModule - String
|
|
permissionAccessPriceListModule - String
|
|
permissionAccessCashBoxModule - String
|
|
permissionAccessTimeclockModule - String
|
|
permissionAccessPerformanceModule - String
|
|
permissionAccessWashAndFoldModule - String
|
|
permissionAccessInspectionModule - String
|
|
permissionAccessItemBaggingModule - String
|
|
permissionAccessFoldingAndBaggingModule - String
|
|
permissionAccessMessagesModule - String
|
|
permissionAccessRackingModule - String
|
|
permissionAccessRouteManagerModule - String
|
|
permissionAccessReportsModule - String
|
|
permissionAccessAdminReportsModule - String
|
|
permissionAccessIssueTrackerModule - String
|
|
permissionAccessSupportModule - String
|
|
permissionAccessEmployeeSettingsModule - String
|
|
permissionAccessBulkMarkinModule - String
|
|
permissionManualPriceEdits - String
|
|
permissionSpecialCareAfterOrderClose - String
|
|
permissionResetOrder - String
|
|
permissionRemoveItems - String
|
|
showStrikeThroughWhenReturned - Boolean
|
|
usePieceCountTotalsOnTicket - Boolean
|
|
taxHeaderString - String
|
|
includeTaxInPrice - Boolean
|
|
dropDateOnAssemblyTicket - Boolean
|
|
displayDepartmentOnTicket - Boolean
|
|
displayCategoryOnTicket - Boolean
|
|
displayPriceOnPickupSlip - Boolean
|
|
useStoreSpecificOrderSequenceNumbers - Boolean
|
|
showStoreSpecificOrderNumberOnTop - Boolean
|
|
saleItemLedgerTrackingEnabled - Boolean
|
|
inOnboarding - Boolean
|
|
noCcCustomerText - Boolean
|
|
pickupReminderOfferCancellations - Boolean
|
|
pickupReminderEnabledForInactiveCustomers - Boolean
|
|
offersRetailDelivery - Boolean
|
|
regRouteQuestionChecked - Boolean
|
|
pickupReminderHour24 - String
|
|
pickupReminderIncludeDeliveries - Boolean
|
|
deliveryCompleteConfirmation - Boolean
|
|
defaultCustomerPaymentType - String
|
|
promptOnCardAvsFailure - Boolean
|
|
minCardChargeAmount - String
|
|
defaultCustomerPriceList - String
|
|
cardSurcharging - String
|
|
cardSurchargeFixedPercentage - String
|
|
organizationNumber - String
|
|
fullstoryEnabled - Boolean
|
|
initializedInferred - Boolean
|
|
cashBoxMode - String
|
|
cashBoxModeProduction - String
|
|
displayExtendedStationReceiptInfo - Boolean
|
|
displayExtendedZReportInfo - Boolean
|
|
twilioMarketingNumber - String
|
|
campaignsEnabled - Boolean
|
|
broadcastsEnabled - Boolean
|
|
reviewModuleEnabled - Boolean
|
|
defaultLanguage - String
|
|
weightUnit - String
|
|
segmentWriteKey - String
|
|
socialId - String
|
|
twilioReviewNumber - String
|
|
acceptedPaymentMethods - [ID]
|
Id list |
quickDetailingItemTypes - [ID]
|
Id list |
mainDeliveryStore - ID
|
store id |
mainStore - ID
|
store id |
communicationTemplates - [ID]
|
Communication template id |
defaultPaymentMethod - ID
|
default payment method id |
logo - Upload
|
a logo image |
receiptLogo - Upload
|
logo image |
POSNewOrderTabs - [ID]
|
|
deliveryNewOrderTabs - [ID]
|
|
statementGenerationDays - [String]
|
|
invoiceGenerationDays - [String]
|
|
acceptedCards - [ID]
|
|
automaticSurcharges - [AutomaticSurchargeInput]
|
|
detailingAttributes - [String]
|
|
welcomeNewCustomerCampaign - WelcomeNewCustomerCampaignInput
|
|
thankYouCampaign - ThankYouCampaignInput
|
|
arPastDueCampaign - ArPastDueCampaignInput
|
|
counterToRouteCampaign - CounterToRouteCampaignInput
|
|
monthlyNewsletterCampaign - MonthlyNewsletterCampaignInput
|
|
happyAnniversaryCampaign - HappyAnniversaryCampaignInput
|
|
inventoryReminderCampaign - InventoryReminderCampaignInput
|
|
oneAndDoneCampaign - OneAndDoneCampaignInput
|
|
marketingByDepartmentCampaign - MarketingByDepartmentCampaignInput
|
|
thankYouTopSpendersCampaign - ThankYouTopSpendersCampaignInput
|
|
newCustomerRetentionCampaign - NewCustomerRetentionCampaignInput
|
|
customerSignupNoOrdersCampaign - CustomerSignupNoOrdersCampaignInput
|
|
noOrdersSinceLastCampaign - NoOrdersSinceLastCampaignInput
|
|
updateYourInformationCampaign - UpdateYourInformationCampaignInput
|
|
quarterlyComforterCampaign - QuarterlyComforterCampaignInput
|
|
thankYouNewReviewCampaign - ThankYouNewReviewCampaignInput
|
|
lostBigCustomerCampaign - LostBigCustomerCampaignInput
|
|
reviewGenerationCampaign - ReviewGenerationCampaignInput
|
|
customCampaign - CustomCampaignInput
|
|
snapshotEmailList - SnapshotEmailListInput
|
Example
{
"businessName": "xyz789",
"dateFormat": "abc123",
"countryCode": "xyz789",
"timeZone": "abc123",
"locale": "abc123",
"contactAddressLine": "abc123",
"contactAddressState": "xyz789",
"contactAddressCity": "xyz789",
"contactAddressZip": "xyz789",
"contactPhone": "xyz789",
"logoUrl": "xyz789",
"noProductionDays": "abc123",
"noDeliveryDays": "xyz789",
"specialHolidays": "xyz789",
"openDetailingWithCategory": 4,
"customerFacingDomain": "xyz789",
"customSignupUrl": "xyz789",
"contactEmail": "abc123",
"twilioAccountSid": "abc123",
"twilioAuthToken": "abc123",
"twilioPhone": "xyz789",
"twilioPhoneLookup": true,
"whatsAppEnabled": false,
"sendSmsOptOutInformation": false,
"userNameOnEmailSubject": true,
"payableEntity": "abc123",
"emailFooter": "xyz789",
"lockerBuildingCode": "abc123",
"communicationTemplatesId": "abc123",
"vcardTemplate": "abc123",
"newPickupScheduledInstructions": "xyz789",
"sendAutomatedMessages": true,
"sendStatementEmails": true,
"signupEmailRequired": true,
"signupGroupRequired": false,
"signupAutofillCity": false,
"signupAddressRequired": false,
"signupPhoneRequired": false,
"allowOrderSplitting": true,
"groupOnDetailingSplit": true,
"offerStoreDelivery": false,
"offerDeliverySchedulingInText": true,
"useStoreZipCodeForTax": false,
"summarizeByBillingCode": true,
"showSalesTaxBreakdownForStatementOrders": false,
"sumOrderTotalOnStatements": true,
"simplifiedPaymentReceipt": true,
"cashTotalRounding": "abc123",
"hasLogo": "abc123",
"isHotel": false,
"isHotelProcessor": false,
"isRoomGroupHotel": false,
"isLockers": true,
"isValet": false,
"isWholesaler": false,
"pickupUnpaidOrders": true,
"pressOnlyDiscount": "xyz789",
"scheduleWillCallAtAssembly": true,
"scheduleWillCallOnDueDate": false,
"dontIncludeOrdersInDeliveryListBeforeDueDate": true,
"geoFencingEnabled": false,
"allowSubDeliveryAccountScheduling": false,
"allowSubAccountToTriggerMasterDelivery": false,
"sendAutopayReceipts": true,
"sendDeliveryAppointmentConfirmation": false,
"showDeliveryNotPaid": true,
"deliveryAppLoadListSortDescending": true,
"requireSignatureOnDelivery": true,
"requirePhotoOnDelivery": false,
"showSubRouteForDeliveryStop": true,
"genericLaundryBagMode": true,
"rushNotificationsHour": "xyz789",
"websiteDisplayText": "xyz789",
"shouldShowWebsiteOnReceipts": true,
"showAgentOnBagTag": false,
"assemblyEvenOnly": false,
"voiceAssemblyEnabled": true,
"inspectPriceAtAssembly": false,
"assemblyPrintFinancialReceiptForDeliveryCustomer": false,
"assemblyAlwaysPrintFinancialReceipt": false,
"printFinancialTicketOutsideAssembly": true,
"keepRackAssignmentOnOrderSplit": false,
"complexLotControl": true,
"overrideDueDateWithNextDelivery": true,
"autoSelectDeliveryReturnLocation": true,
"defaultDetailingTab": "abc123",
"autoOpenAnnotationType": false,
"requireInvoiceInDetailing": true,
"displayTooManyDetailedItemsWarning": true,
"assemblyIcon": "abc123",
"alignAssemblyIcon": "xyz789",
"newCustomerTicketIcon": "abc123",
"newCustomerBottomTicketIcon": "abc123",
"customerNameOnTicketBottom": true,
"pieceCountOnTicketBottom": true,
"customerPhoneOnTicket": false,
"showRoomInfoBelowAddress": true,
"laundryLicense": "xyz789",
"summarizedItemTable": true,
"showLogoOnReceipts": true,
"logoOnReceiptHeight": "xyz789",
"receiptLogoName": "abc123",
"showPriceOnAssembly": false,
"paymentReceiptShowSignatureLine": false,
"receiptsNameShort": "xyz789",
"newLocationOnTicket": true,
"showRouteOfSameDayDelivery": false,
"itemDetailsOnTicket": true,
"itemDetailsOnOrderReceipt": true,
"newOrderPrintCount": "xyz789",
"printRetailReceipts": false,
"printDropTicketOnOrderSplit": true,
"printTicketOnOrderCloseCount": "abc123",
"noStoreContactInfoOnReceipts": true,
"noPricingOnOrderReceipts": true,
"receiptsFooter": "xyz789",
"thermalReceiptFooter": "abc123",
"ticketReceiptFooter": "abc123",
"showEmailOnReceipts": false,
"showWebsiteOnReceipts": true,
"invoicePayableLine": "xyz789",
"invoiceTerms": "abc123",
"isRestorationAccount": false,
"offerDemandDelivery": false,
"autoAddNewCustomerToWillCallRoute": "4",
"groupItemDetailsByRoomNumber": true,
"merchantBatchCloseTime": "xyz789",
"saveCardsOnFile": true,
"amexSeparately": false,
"maxAutopayAmount": "abc123",
"maxPaymentAmountWarning": "xyz789",
"autopayTerms": 4,
"autopayStatements": true,
"autopayBatchStrategy": "4",
"invoiceDueDays": "abc123",
"consolidateInvoiceItemDetails": false,
"invoiceShowOrderDetails": false,
"invoiceHideOrderInfo": false,
"showDateOnStatement": false,
"callStatementInvoice": true,
"activitySummaryEnabled": false,
"attachPDFInStatementEmails": false,
"rewardsProgramEnabled": true,
"rewardsPointModifier": "xyz789",
"rewardsCurrencyModifier": "abc123",
"rewardsConversionRequirement": "abc123",
"rewardsRedeemAutomatically": false,
"rewardsEmailRequired": true,
"rewardsPhoneRequired": true,
"rewardsAddressRequired": false,
"rewardsCreditCardRequired": true,
"welcomeNotificationDisabled": false,
"autoTicketOnCustomerRegistration": true,
"autoTicketOnScheduledDelivery": false,
"sendCustomerUpdatedCCNotification": false,
"allowScheduleBothPickupAndDelivery": true,
"limitScheduleDeliveryToClosestRoute": false,
"allowRouteRegularCustomersToScheduleOnDemand": false,
"allowSameDaySchedulingEvenIfRouteStarted": false,
"experimentalPhotoUserExperienceOnWebsiteScheduler": true,
"priceListUpdateOrdersCondition": "abc123",
"routeAgentPriority": false,
"commonOrdersAgent": false,
"isMailOrderPickups": true,
"lockerDropBinPickupMode": true,
"showYesRepliesInComm": true,
"autoReplyToYesRepliesInComm": true,
"customerWebsiteClothesTrackerTabEnabled": false,
"customerWebsiteWardrobeTabEnabled": false,
"customerWebsitePaymentTabEnabled": true,
"metalprogettiAssemblyLabelTemplate": "abc123",
"metalprogettiSendRackSpaceToStorage": false,
"rushOrderSurcharge": "abc123",
"rushOrderSurchargeTier2": "xyz789",
"sendNewOrderNotificationOnEveryVisit": true,
"includeReceiptInNewOrderNotification": true,
"printTempTagsForBarcodedItems": true,
"alwaysGenerateTemporaryBarcodes": true,
"zebraPrinterTemplate": "xyz789",
"epsonPrinterTemplate": "abc123",
"forceOnlyBagFieldInput": true,
"detailingWithoutBarcodes": true,
"printLabelsWhenDuplicating": false,
"metalprogettiStripCharacters": "abc123",
"autoDetailingEnabled": false,
"minItemBarcodeLength": "abc123",
"maxItemBarcodeLength": "xyz789",
"quotesDeletionTimeFrame": "xyz789",
"minWashNFoldPrice": "xyz789",
"minWashNFoldWeight": "abc123",
"washAndFoldWeightStations": false,
"departmentSpecificOrdersEnabled": false,
"manualPickupRestricted": false,
"displayDueDateInProductionModules": true,
"filterDetailingByItemTypes": false,
"automaticallyFilterReportsToEmployeesStore": false,
"payrollPeriod": "abc123",
"payrollLastCloseDate": "abc123",
"payrollFirstHalfCloseDate": "abc123",
"payrollLastHalfCloseDate": "abc123",
"payrollCloseDate": "abc123",
"workweekStart": "abc123",
"hoursUntilWeeklyOvertime": "abc123",
"hoursUntilDailyOvertime": "xyz789",
"hoursUntilDailyDoubleTime": "abc123",
"hoursUntilWeeklyNotification": "abc123",
"hoursUntilDailyNotification": "abc123",
"preventClockInBeforeTime": "abc123",
"californiaOvertimeRules": true,
"promptForClockInOnLogin": true,
"overrideTimeClockWithUserDepartment": false,
"allowMobileAppClockIn": false,
"disableOverTimeNotifications": false,
"overnightClockOut": false,
"inventorySystemEnabled": false,
"inventorySystemEnabledProduction": true,
"permissionManageSystemSettings": "abc123",
"permissionManageMarketing": "xyz789",
"permissionManageStationSettings": "abc123",
"permissionAccessCustomerCredits": "xyz789",
"permissionAddCustomerDiscount": "abc123",
"permissionAccessCustomerModule": "xyz789",
"permissionAccessDeliveryModule": "xyz789",
"permissionAccessAssemblyModule": "abc123",
"permissionAccessSpottingModule": "xyz789",
"permissionAccessAlterAndRepairModule": "xyz789",
"permissionAccessAccountsReceivableModule": "abc123",
"permissionAccessPressingModule": "xyz789",
"permissionAccessPriceListModule": "abc123",
"permissionAccessCashBoxModule": "abc123",
"permissionAccessTimeclockModule": "xyz789",
"permissionAccessPerformanceModule": "xyz789",
"permissionAccessWashAndFoldModule": "abc123",
"permissionAccessInspectionModule": "abc123",
"permissionAccessItemBaggingModule": "xyz789",
"permissionAccessFoldingAndBaggingModule": "xyz789",
"permissionAccessMessagesModule": "abc123",
"permissionAccessRackingModule": "abc123",
"permissionAccessRouteManagerModule": "abc123",
"permissionAccessReportsModule": "xyz789",
"permissionAccessAdminReportsModule": "abc123",
"permissionAccessIssueTrackerModule": "xyz789",
"permissionAccessSupportModule": "abc123",
"permissionAccessEmployeeSettingsModule": "xyz789",
"permissionAccessBulkMarkinModule": "xyz789",
"permissionManualPriceEdits": "xyz789",
"permissionSpecialCareAfterOrderClose": "abc123",
"permissionResetOrder": "xyz789",
"permissionRemoveItems": "xyz789",
"showStrikeThroughWhenReturned": false,
"usePieceCountTotalsOnTicket": false,
"taxHeaderString": "abc123",
"includeTaxInPrice": false,
"dropDateOnAssemblyTicket": false,
"displayDepartmentOnTicket": false,
"displayCategoryOnTicket": true,
"displayPriceOnPickupSlip": false,
"useStoreSpecificOrderSequenceNumbers": false,
"showStoreSpecificOrderNumberOnTop": true,
"saleItemLedgerTrackingEnabled": true,
"inOnboarding": true,
"noCcCustomerText": true,
"pickupReminderOfferCancellations": true,
"pickupReminderEnabledForInactiveCustomers": false,
"offersRetailDelivery": false,
"regRouteQuestionChecked": true,
"pickupReminderHour24": "xyz789",
"pickupReminderIncludeDeliveries": false,
"deliveryCompleteConfirmation": false,
"defaultCustomerPaymentType": "abc123",
"promptOnCardAvsFailure": true,
"minCardChargeAmount": "abc123",
"defaultCustomerPriceList": "xyz789",
"cardSurcharging": "xyz789",
"cardSurchargeFixedPercentage": "xyz789",
"organizationNumber": "xyz789",
"fullstoryEnabled": true,
"initializedInferred": true,
"cashBoxMode": "abc123",
"cashBoxModeProduction": "abc123",
"displayExtendedStationReceiptInfo": false,
"displayExtendedZReportInfo": false,
"twilioMarketingNumber": "xyz789",
"campaignsEnabled": false,
"broadcastsEnabled": true,
"reviewModuleEnabled": true,
"defaultLanguage": "abc123",
"weightUnit": "abc123",
"segmentWriteKey": "abc123",
"socialId": "xyz789",
"twilioReviewNumber": "xyz789",
"acceptedPaymentMethods": [4],
"quickDetailingItemTypes": [4],
"mainDeliveryStore": "4",
"mainStore": 4,
"communicationTemplates": [4],
"defaultPaymentMethod": 4,
"logo": Upload,
"receiptLogo": Upload,
"POSNewOrderTabs": [4],
"deliveryNewOrderTabs": [4],
"statementGenerationDays": ["abc123"],
"invoiceGenerationDays": ["xyz789"],
"acceptedCards": ["4"],
"automaticSurcharges": [AutomaticSurchargeInput],
"detailingAttributes": ["xyz789"],
"welcomeNewCustomerCampaign": WelcomeNewCustomerCampaignInput,
"thankYouCampaign": ThankYouCampaignInput,
"arPastDueCampaign": ArPastDueCampaignInput,
"counterToRouteCampaign": CounterToRouteCampaignInput,
"monthlyNewsletterCampaign": MonthlyNewsletterCampaignInput,
"happyAnniversaryCampaign": HappyAnniversaryCampaignInput,
"inventoryReminderCampaign": InventoryReminderCampaignInput,
"oneAndDoneCampaign": OneAndDoneCampaignInput,
"marketingByDepartmentCampaign": MarketingByDepartmentCampaignInput,
"thankYouTopSpendersCampaign": ThankYouTopSpendersCampaignInput,
"newCustomerRetentionCampaign": NewCustomerRetentionCampaignInput,
"customerSignupNoOrdersCampaign": CustomerSignupNoOrdersCampaignInput,
"noOrdersSinceLastCampaign": NoOrdersSinceLastCampaignInput,
"updateYourInformationCampaign": UpdateYourInformationCampaignInput,
"quarterlyComforterCampaign": QuarterlyComforterCampaignInput,
"thankYouNewReviewCampaign": ThankYouNewReviewCampaignInput,
"lostBigCustomerCampaign": LostBigCustomerCampaignInput,
"reviewGenerationCampaign": ReviewGenerationCampaignInput,
"customCampaign": CustomCampaignInput,
"snapshotEmailList": SnapshotEmailListInput
}
SignInTextStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LOGIN_ONGOING"
SignUpCustomerFields
Description
Fields to set to a customer upon registration
Fields
| Input Field | Description |
|---|---|
firstName - String
|
Customer first name |
lastName - String
|
Customer last name |
email - String
|
Customer email |
streetAddress - String
|
Customer street address |
streetAddress2 - String
|
Customer street address 2 |
cityAddress - String
|
Customer city address |
stateAddress - String
|
Customer state address |
zipAddress - String
|
Customer zip address |
promotionCode - String
|
Promotion code |
group - String
|
Customer group |
agent - String
|
Agent |
customFields - [CustomerFieldValueInput]
|
A list of custom field values |
Example
{
"firstName": "xyz789",
"lastName": "abc123",
"email": "xyz789",
"streetAddress": "xyz789",
"streetAddress2": "abc123",
"cityAddress": "xyz789",
"stateAddress": "abc123",
"zipAddress": "abc123",
"promotionCode": "xyz789",
"group": "xyz789",
"agent": "xyz789",
"customFields": [CustomerFieldValueInput]
}
SnapshotEmailList
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
emailList - [EmailListEntry]
|
The email list for SnapShot recipients. |
Example
{
"id": 4,
"localId": "4",
"emailList": [EmailListEntry]
}
SnapshotEmailListInput
Description
Create or update snapshot email list.
Fields
| Input Field | Description |
|---|---|
emailList - [EmailListEntryInput]
|
The email list for SnapShot recipients. |
Example
{"emailList": [EmailListEntryInput]}
SpecialCare
StartTextSignInResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
phoneNumber - String
|
Set if signing in via phone number |
email - String
|
Set if signing in via email |
authProcess - SignInTextStatusEnum
|
Current step in the sign in / registration process |
Example
{
"id": "4",
"localId": "4",
"phoneNumber": "xyz789",
"email": "abc123",
"authProcess": "LOGIN_ONGOING"
}
Station
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Name of the station (e.g Counter 1) |
store - Store!
|
The store which this station belongs to |
type - StationType!
|
The type of station |
lastUsed - DateTime
|
Last time this station was used. |
deliveryVehicle - Rack
|
A vehicle (rack) associated with the station. For delivery stations specifically. |
Example
{
"id": "4",
"localId": 4,
"name": "abc123",
"store": Store,
"type": StationType,
"lastUsed": "2007-12-03T10:15:30Z",
"deliveryVehicle": Rack
}
StationSignInMethodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"password"
StationType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
Descriptive name of the station type, useful for user display. |
category - String!
|
Name of the station category this type is part of. |
Example
{
"id": 4,
"localId": 4,
"name": "abc123",
"category": "xyz789"
}
Store
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
agentId - ID
|
Unique identifier for the Agent. Can be null for a Group, if the group is not an agent. |
agentType - String
|
The type of Agent. One of "Store", "Route" or "Group". Can be null for a Group, if the group is not an agent. |
name - String!
|
Name of the Agent |
isStripeEnabled - Boolean
|
If an agent is Stripe enabled |
merchant - Merchant
|
The merchant for the agent |
phone - String
|
Phone number to the store |
address - String
|
Address |
city - String
|
City |
state - String
|
State |
zip - String
|
Zip code |
latitude - Float
|
Latitude |
longitude - Float
|
Longitude |
externalStoreIdentifier - String
|
External Store Identifier |
googlePlaceId - String
|
Google Place Id |
stations - [Station]!
|
Stations (computers) that are at a physical store |
hasCounterStation - Boolean!
|
Whether or not the store has one or more counter stations |
Example
{
"id": "4",
"localId": 4,
"agentId": "4",
"agentType": "abc123",
"name": "xyz789",
"isStripeEnabled": false,
"merchant": Merchant,
"phone": "xyz789",
"address": "xyz789",
"city": "xyz789",
"state": "abc123",
"zip": "xyz789",
"latitude": 987.65,
"longitude": 987.65,
"externalStoreIdentifier": "abc123",
"googlePlaceId": "abc123",
"stations": [Station],
"hasCounterStation": true
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SubscriptionStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"pending"
SubscriptionUsage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
type - String!
|
Type of benefit |
limit - Float!
|
Total amount of uses for benefit |
usage - Float!
|
Number of used benefits |
Example
{
"id": 4,
"localId": 4,
"type": "abc123",
"limit": 123.45,
"usage": 123.45
}
Surcharge
Example
{
"id": "4",
"localId": 4,
"name": "abc123",
"disabled": true
}
TaxConfigurationRule
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
sort - Int
|
Sort priority of the rule |
parentRule - ID
|
Id of an older revision of the rule |
isDisabled - Boolean
|
True if overridden by a newer revision |
isDefault - Boolean
|
True if this is the default rule |
name - String!
|
Name of the rule |
rate - Float
|
Tax rate of the rule |
useAutoTaxJar - Boolean!
|
True if tax rate from TaxJar should be used |
addressSpecific - Boolean!
|
True if check from TaxJar should be address specific |
zipCondition - String
|
Zip condition to apply this rule to. May be null, single '90210' or range '90210-91210' |
departmentCondition - [String]
|
Department(s) to apply this rule to. May be null or array of department IDs |
agentCondition - [String]
|
Agent(s) to apply this rule to. May be null or array of department IDs |
Example
{
"id": 4,
"localId": 4,
"sort": 123,
"parentRule": 4,
"isDisabled": true,
"isDefault": true,
"name": "abc123",
"rate": 987.65,
"useAutoTaxJar": true,
"addressSpecific": true,
"zipCondition": "xyz789",
"departmentCondition": ["abc123"],
"agentCondition": ["xyz789"]
}
TaxConfigurationRuleInput
Description
Create / Update a tax configuration rule
Fields
| Input Field | Description |
|---|---|
id - ID
|
Tax configuration rule id |
name - String!
|
Name of the rule |
rate - Float
|
Tax rate of the rule |
useAutoTaxJar - Boolean!
|
True if tax rate from TaxJar should be used |
addressSpecific - Boolean!
|
True if check from TaxJar should be address specific |
zipCondition - String
|
Zip condition to apply this rule to. May be null, single '90210' or range '90210-91210' |
departmentCondition - [String]
|
Department(s) to apply this rule to. May be null or array of department IDs |
agentCondition - [String]
|
Agent(s) to apply this rule to. May be null or array of department IDs |
Example
{
"id": "4",
"name": "xyz789",
"rate": 987.65,
"useAutoTaxJar": true,
"addressSpecific": true,
"zipCondition": "abc123",
"departmentCondition": ["abc123"],
"agentCondition": ["abc123"]
}
TaxRate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
objectId - String!
|
The ID of the object, should be either an item type id or a department id |
rate - String!
|
Example
{
"id": "4",
"localId": 4,
"objectId": "abc123",
"rate": "xyz789"
}
ThankYouCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
frequency - Int!
|
Only send messages if the customer has not been sent a message in this many days |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
Example
{
"id": "4",
"localId": 4,
"name": "abc123",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "xyz789",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"frequency": 123,
"email": "abc123",
"sms": "abc123"
}
ThankYouCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
frequency - Int!
|
Only send messages if the customer has not been sent a message in this many days |
Example
{
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "abc123",
"sms": "xyz789",
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput,
"frequency": 987
}
ThankYouNewReviewCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
starRatings - [String]
|
The list of star ratings for which the message should be sent. |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"starRatings": ["abc123"],
"email": "abc123",
"sms": "abc123"
}
ThankYouNewReviewCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
starRatings - [String]
|
The list of star ratings for which the message should be sent. |
Example
{
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "abc123",
"sms": "xyz789",
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfoInput,
"starRatings": ["abc123"]
}
ThankYouTopSpendersCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
interval - Int
|
Send the message every X days |
spendingDemographics - [Int!]
|
Only send to customers with these spending demographics |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
Example
{
"id": "4",
"localId": 4,
"name": "xyz789",
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "abc123",
"autoApplyPromo": true,
"updateInfo": UpdateInfo,
"interval": 123,
"spendingDemographics": [123],
"email": "xyz789",
"sms": "xyz789"
}
ThankYouTopSpendersCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
interval - Int
|
Send the message every X days |
spendingDemographics - [Int!]
|
Only send to customers with these spending demographics |
Example
{
"enabled": false,
"priority": "abc123",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "xyz789",
"sms": "xyz789",
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput,
"interval": 987,
"spendingDemographics": [123]
}
TimeSlot
Example
{
"id": 4,
"localId": "4",
"start": "xyz789",
"end": "xyz789",
"routeId": 4
}
UniqueTwilioError
Example
{
"id": "4",
"localId": 4,
"name": "abc123"
}
UnpaidOrders
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
orders - [Order]!
|
A list of unpaid orders |
duePayment - DuePayment!
|
The payment object including subtotal, total, surcharges, discounts and such |
Example
{
"id": "4",
"localId": "4",
"orders": [Order],
"duePayment": DuePayment
}
UpdateInfo
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
lastUpdateDate - String
|
The date the setting was last updated |
lastUpdateUser - String
|
The user who last updated the setting |
lastEnabledDate - String
|
The date the setting was last enabled |
lastEnabledUser - String
|
The user who last enabled the setting |
lastDisabledDate - String
|
The date the setting was last disabled |
lastDisabledUser - String
|
The user who last disabled the setting |
createDate - String
|
The date the campaign was created |
createUser - String
|
The user who created the campaign |
Example
{
"id": "4",
"localId": 4,
"lastUpdateDate": "xyz789",
"lastUpdateUser": "abc123",
"lastEnabledDate": "xyz789",
"lastEnabledUser": "xyz789",
"lastDisabledDate": "abc123",
"lastDisabledUser": "abc123",
"createDate": "abc123",
"createUser": "abc123"
}
UpdateInfoInput
Description
Information on when a campaign was last updated
Fields
| Input Field | Description |
|---|---|
lastUpdateDate - String
|
The date the setting was last updated |
lastUpdateUser - String
|
The user who last updated the setting |
lastEnabledDate - String
|
The date the setting was last enabled |
lastEnabledUser - String
|
The user who last enabled the setting |
lastDisabledDate - String
|
The date the setting was last disabled |
lastDisabledUser - String
|
The user who last disabled the setting |
createDate - String
|
The date the campaign was created |
createUser - String
|
The user who created the campaign |
Example
{
"lastUpdateDate": "abc123",
"lastUpdateUser": "abc123",
"lastEnabledDate": "abc123",
"lastEnabledUser": "abc123",
"lastDisabledDate": "abc123",
"lastDisabledUser": "abc123",
"createDate": "abc123",
"createUser": "xyz789"
}
UpdatePhotoInput
UpdateYourInformationCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
messageType - [String]
|
The type of information updates to request from customers |
frequencyType - String
|
The type of interval used for sending the information update requests to the customer. |
frequencyValue - Int
|
The numeric value for measuring the chosen frequency type. |
Example
{
"id": 4,
"localId": "4",
"name": "xyz789",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["xyz789"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfo,
"email": "abc123",
"sms": "xyz789",
"messageType": ["xyz789"],
"frequencyType": "xyz789",
"frequencyValue": 987
}
UpdateYourInformationCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
messageType - [String]
|
The type of information updates to request from customers |
frequencyType - String
|
The type of interval used for sending the information update requests to the customer. |
frequencyValue - Int
|
The numeric value for measuring the chosen frequency type. |
Example
{
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["xyz789"],
"email": "abc123",
"sms": "abc123",
"promotion": "abc123",
"autoApplyPromo": false,
"updateInfo": UpdateInfoInput,
"messageType": ["xyz789"],
"frequencyType": "xyz789",
"frequencyValue": 987
}
Upload
Example
Upload
User
Example
{
"id": "4",
"localId": 4,
"name": "abc123",
"firstName": "abc123"
}
ValidateCustomerCredentialsInput
WelcomeNewCustomerCampaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Globally Unique Identifier. In the format of ObjectType_BusinessIdShort_ObjectId |
localId - ID!
|
Local identifier without ObjectType_BusinessIdShort prefix. |
name - String!
|
The name of the campaign setting |
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfo!
|
The information on when the campaign was updated |
maxWaitDays - Int!
|
The maximum number of days to wait before sending the campaign |
enableRoute - Boolean!
|
If the campaign should be sent to customers who are on a route |
enableStore - Boolean!
|
If the campaign should be sent to customers who are not on a route |
routeEmail - String
|
The email template to send to customers who are on a route |
routeSms - String
|
The sms template to send to customers who are on a route |
storeEmail - String
|
The email template to send to customers who are not on a route |
storeSms - String
|
The sms template to send to customers who are not on a route |
Example
{
"id": "4",
"localId": "4",
"name": "abc123",
"enabled": false,
"priority": "xyz789",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"promotion": "xyz789",
"autoApplyPromo": true,
"updateInfo": UpdateInfo,
"maxWaitDays": 987,
"enableRoute": false,
"enableStore": true,
"routeEmail": "xyz789",
"routeSms": "abc123",
"storeEmail": "xyz789",
"storeSms": "xyz789"
}
WelcomeNewCustomerCampaignInput
Description
Update a campaign setting
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
If the setting is enabled |
priority - String!
|
The sending priority of the campaign |
customerInclusionKpiIdList - [String]!
|
The customer inclusion kpi list |
customerExclusionKpiIdList - [String]!
|
The customer exclusion kpi list |
email - String
|
The email template to send |
sms - String
|
The sms template to send |
promotion - String
|
The ID for the promotion to apply to the campaign |
autoApplyPromo - Boolean!
|
Whether to automatically add the selected promotion to the customer's account when the campaign message is sent. |
updateInfo - UpdateInfoInput!
|
The information on when the campaign was updated |
maxWaitDays - Int!
|
The maximum number of days to wait before sending the campaign |
enableRoute - Boolean!
|
If the campaign should be sent to customers who are on a route |
enableStore - Boolean!
|
If the campaign should be sent to customers who are not on a route |
routeEmail - String
|
The email template to send to customers who are on a route |
routeSms - String
|
The sms template to send to customers who are on a route |
storeEmail - String
|
The email template to send to customers who are not on a route |
storeSms - String
|
The sms template to send to customers who are not on a route |
Example
{
"enabled": true,
"priority": "abc123",
"customerInclusionKpiIdList": ["abc123"],
"customerExclusionKpiIdList": ["abc123"],
"email": "xyz789",
"sms": "abc123",
"promotion": "abc123",
"autoApplyPromo": true,
"updateInfo": UpdateInfoInput,
"maxWaitDays": 123,
"enableRoute": true,
"enableStore": false,
"routeEmail": "xyz789",
"routeSms": "abc123",
"storeEmail": "abc123",
"storeSms": "xyz789"
}