close
GraphQL Schema
query
mutation
GraphQL Scalars
Boolean
Date
DateTime
Decimal
Float
ID
Int
Long
String
GraphQL Enums
ActiveNotificationTransportTypeEnum
ActivePaymentTypeEnum
BackupMediumJobStatusEnum
BiDimensionFilterType
BillingTypeEnum
BiMeasureFormat
BiTimePeriodLevel
BiTimePeriodModifier
BoletoPaymentType
BookmarkType
BoolSearchRelationOperatorEnum
BusinessModelEnum
CandidateAffiliateSettingEnum
CharacterEncodingEnum
CheckoutCurrencyEnum
CheckoutLanguageEnum
ClientBusinessModelEnum
ClientPolicyLanguagesEnum
ClientPolicyTypeEnum
ClientSegmentEnum
ControlTypeEnum
CountryEnum
CouponCodeCharacterSetEnum
CreditCardBrandEnum
CurrencyEnum
CustomerTypeEnum
DateRelationOperator
DebitCardBrandEnum
DeliveryStatusEnum
DeliveryTypeEnum
DiscountPriceTypeEnum
DocumentFormat
EmailActionEnum
EnumSearchRelationOperatorEnum
ErrorLogEntryTypeEnum
ErrorLogOrderByField
ExtraParametersRelationOperator
FeatureEnum
FollowUpReasonCategoryEnum
FollowUpReasonEnum
GalleryTypeId
GenericPaymentTypeEnum
HistoryCategoryEnum
HistoryContactactMethodEnum
HistoryContactMethodEnum
HistoryNatureOfContactEnum
HistoryReasonEnum
HistorytypeEnum
IdealBankEnum
IntervalEnum
IntervalPeriodTypeEnum
JournalItemOrderByField
KeyGeneratorDocumentTypeEnum
KeyGeneratorInterfaceEnum
KeyGeneratorTypeEnum
KeyResultTypeEnum
LanguageEnum
LanguagesFilter
LicenseTypeEnum
ListTypeEnum
LogicalOperator
MailStatusEnum
MailTypeEnum
ManualAuthorizationStatusEnum
ManualPaymentAssignmentCurrencyEnum
MvtCampaignOrderByField
NotificationDocumentTypeEnum
NotificationEventEnum
NotificationTransportTypeEnum
NumberRelationOperator
NumericIdSearchRelationOperatorEnum
OperatingSystemEnum
OperatingSystemTreeElementEnum
PackageDiscountSearchOrderByField
PartnerTypeEnum
PaymentAssignmentStatusEnum
PaymentTypeCategoryEnum
PaymentTypeEnum
PeriodLevelId
Permission
PermissionContext
PriceTypeEnum
PricingMethodEnum
ProductSearchOrderByField
ProductSelectionPositionEnum
ProductStatusEnum
ProductTypeEnum
PromotionTypeEnum
PurchaseActionTypeEnum
PurchaseDocumentSearchOrderByField
PurchaseDocumentTypeEnum
PurchaseItemActionTypeEnum
PurchaseItemPriceTypeEnum
PurchaseSearchOrderByField
PurchaseSearchPaymentTypeCategoryEnum
PurchaseSearchPaymentTypeEnum
PurchaseStatusEnum
RecommendationDisplayOptionEnum
RecommendationOptionTypeEnum
RecommendationPositionTypeEnum
RecommendationQuantityLimitTypeEnum
RecommendationTypeEnum
RefundPolicyTypeEnum
RefundReasonEnum
RefundTypeEnum
RenewalQuoteSearchOrderByField
SalesTaxCodeEnum
SalutationEnum
SearchOrderOperator
SepaPaymentTypeEnum
StateEnum
StatesFilter
StatisticValueTypeEnum
StringExtendedRelationOperator
StringLimitedRelationOperator
StringRelationOperator
SubscriptionDeliveryOptionEnum
SubscriptionItemSearchOrderByField
SubscriptionItemStatusEnum
SubscriptionLicenseType
SubscriptionManagementModelEnum
SubscriptionRenewalTypeEnum
SubscriptionStatusEnum
SubscriptionUpgradeModeEnum
TaxExemptionDocumentAttachmentStatusEnum
TaxExemptionDocumentDateOperator
TaxExemptionDocumentEnumOperator
TaxExemptionDocumentFieldNameEnum
TaxExemptionDocumentLanguageEnum
TaxExemptionDocumentNumericOperator
TaxExemptionDocumentStateEnum
TaxExemptionDocumentStatusEnum
TaxExemptionDocumentStringOperator
TaxExemptionReasonEnumGraphType
TaxExemptionTaxIdTypeEnum
TaxExemptionTypeOfBusinessEnum
TaxTypeEnum
TemplateTypeEnum
WebFileCategoryEnum
XmlSchemaEnum
__DirectiveLocation
__TypeKind
GraphQL Interfaces
LogEntryInterface
OrderItemInterface
PaymentProfileInterface
PriceSettingsInterface
GraphQL Objects
AbsoluteBiTimePeriodFilter
AcceptPurchaseResult
AcceptRenewalQuoteResult
ActivePaymentType
AddBackupCdResult
Affiliate
AlignIpCountryWithCustomerCountryPayload
AlignmentCustomerPrice
ApplicablePriceConfiguration
ApplyCouponToSubscriptionPayload
AvataxConfiguration
BackupMediumJob
BackupMediumJobStatus
BiBookmark
BiChartSettings
BiDimension
BiGroupResult
BiMeasure
BiMeasureResult
BiReport
BiReportResult
BoletoProfile
BrazilianBankAccountProfile
Browser
BusinessModel
Cart
CartItem
Catalog
CharacterEncoding
CleverbridgeContacts
Client
ClientBusinessModel
ClientFile
ClientInformation
ClientPolicy
ClientPolicyType
ClientSalesRevenueStatistics
ClientSegment
ClientShippingset
ClientWebbinary
Configuration
Contact
ContactInformation
ContactMethod
ContactTaxType
ControlType
ConversionRateStatistics
ConvertOrderToPurchaseOrderResult
Country
CreateAvataxConfigurationPayload
CreateCustomerPayload
CreateHistoryEntryPayload
CreateJournalItemIPayload
CreateKeyGeneratorPayload
CreateMvtCampaignPayload
CreateNotificationPayload
CreatePackageDiscountPayload
CreatePriceConfigurationPayload
CreateProductCharacteristicPayload
CreateProductListPayload
CreateProductPayload
CreateProductSelectionPayload
CreatePromotionPayload
CreateRecommendationPayload
CreateRegionConfigurationPayload
CreateRenewalQuotePayload
CreateSubscriptionPayload
CreateTaxExemptionDocumentPayload
CreateTextElementPayload
CreditCardProfile
Currency
CurrencyAmount
CurrentUser
Customer
CustomerInformation
CustomerSearchResult
CustomerSearchResultItem
CustomerType
DebitCardProfile
DeleteAvataxConfigurationPayload
DeleteKeyGeneratorPayload
DeleteMvtCampaignPayload
DeleteNotificationPayload
DeletePackageDiscountPayload
DeletePersonalDataPayload
DeletePriceConfigurationPayload
DeleteProductCharacteristicPayload
DeleteProductListPayload
DeleteProductSelectionPayload
DeletePromotionPayload
DeleteProtectedUrlPayload
DeleteRecommendationPayload
DeleteRegionConfigurationPayload
DeleteTaxExemptionDocumentPayload
DeleteTextElementPayload
DeliveryStatus
DeliveryType
Department
Discount
Email
EmailAction
EmailPayload
EmailsPayload
ErrorLogEntry
ErrorLogEntryPayload
ErrorLogEntrySearchResult
ErrorLogEntrySearchResultItem
ErrorLogEntryType
ExecuteDeliveryProcessResult
ExtendedClientSettings
ExtraParameter
ExtraParametersPayload
Feature
FinancialAccount
FollowUp
FollowUpPayload
FollowUpReason
FollowUpReasonCategory
FollowUpSearchResult
GenerateProtectedUrlPayload
GenericBiDimensionFilter
GenericPaymentProfile
HistoryCategory
HistoryContactMethod
HistoryEntry
HistoryEntrySearchResult
HistoryEntrySearchResultItem
HistoryNatureOfContact
HistoryReason
Historytype
IdealBank
IdealProfile
JournalItem
JournalItemPurchaseAssignment
JournalItemSearchResult
JournalItemSearchResultItem
KeyGenerator
KeyGeneratorInterface
KeyGeneratorSearchResultGraphType
KeyGeneratorType
KeyList
KeyResultType
KonbiniProfile
Language
LanguageRegion
LicenseStatistics
LicenseType
ListType
LocalizedClientWebbinary
LocalizedString
Lookups
MailStatus
MailType
ManualAuthorizationStatus
MvtCampaign
MvtCampaignCandidate
MvtCampaignSearchResult
Notification
NotificationDocumentType
NotificationEvent
NotificationInterval
NotificationSearchResult
NotificationSettings
NotificationTransportType
NotificationTransportTypeConfiguration
Office
OperatingSystem
OperatingSystemTreeElement
OrderStatistics
PackageDiscount
PackageDiscountDefinition
PackageDiscountDefinitionSearchResultItem
PackageDiscountSearchResult
PackageDiscountSearchResultItem
PartnerGroup
PartnerType
PaymentAssignmentStatus
PaymentProfilePayload
PaymentProvider
PaymentTransaction
PaymentTransactionType
PaymentType
PaymentTypeCategory
Percentage
PowerBiReport
PowerBiReports
Price
PriceAbsolute
PriceAbsoluteValue
PriceConfiguration
PriceConfigurationItem
PriceConfigurationList
PriceConfigurationProductItem
PriceConfigurationProductListItem
PriceFormat
PricePercentage
PricePercentageValue
PriceType
Pricing
PricingMethod
Product
ProductBundle
ProductCategory
ProductCharacteristic
ProductCharacteristicOption
ProductContentSettings
ProductDeletePayload
ProductDelivery
ProductDeliveryDownloadOptions
ProductDeliveryKeyDeliveryOptions
ProductDeliverySettings
ProductGroup
ProductInformation
ProductList
ProductSearchResult
ProductSelection
ProductSelectionItem
ProductSelectionPosition
ProductStatus
ProductSubscriptionSettings
ProductType
Promotion
PromotionCoupon
PromotionCouponList
PromotionCouponSettings
PromotionProductList
promotionReferringsResult
PromotionType
ProtectedUrl
ProtectedUrlItem
ProtectedUrlSearchResult
Purchase
PurchaseActionType
PurchaseAssignment
PurchaseDocument
PurchaseDocumentSearchResult
PurchaseDocumentSearchResultItem
PurchaseDocumentType
PurchaseItem
PurchaseItemActionType
PurchaseItemDelivery
PurchaseItemPriceType
PurchaseMetaData
PurchasePayload
PurchaseSearchContact
PurchaseSearchPaymentType
PurchaseSearchPaymentTypeCategory
PurchaseSearchPromotion
PurchaseSearchResult
PurchaseSearchResultItem
PurchaseSearchResultProduct
PurchaseStatus
PurchaseTransaction
PurchasItemeMetaData
Recommendation
RecommendationDisplayOption
RecommendationOptionType
RecommendationParameter
RecommendationPositionType
RecommendationQuantityLimit
RecommendationQuantityLimitType
RecommendationType
RecommendedProduct
RedeliverBackupMediumResult
RefundPayload
RefundPolicySettings
RefundPolicyType
RefundReason
RefundType
Region
RegionConfiguration
RejectPurchaseForErrorResult
RelativeBiTimePeriodFilter
ReleasePurchaseOrderResult
RenewalQuote
RenewalQuoteItem
RenewalQuoteItemSearchResult
RenewalQuoteSearchResult
RenewalQuoteSearchResultItem
RenewPayload
RenewSubscriptionResult
Salutation
SampleUrls
SellingEntityContextPlaceholderItem
SellingEntityContextResourceItem
SepaBankAccountProfile
Session
SessionCart
SessionsStatistics
ShippingConfiguration
State
StatisticValue
StatisticValueType
Subscription
SubscriptionBilling
SubscriptionDeliveryOption
SubscriptionInterval
SubscriptionIntervalData
SubscriptionIntervalDataItem
SubscriptionItem
SubscriptionItemBilling
SubscriptionItemPayload
SubscriptionItemSearchProductInformation
SubscriptionItemSearchResult
SubscriptionItemSearchResultItem
SubscriptionItemStatus
SubscriptionParameter
SubscriptionRenewalType
SubscriptionStatus
SupportContact
TaxationHistory
TaxExemptionContact
TaxExemptionDocument
TaxExemptionDocumentAttachment
TaxExemptionDocumentAttachmentStatus
TaxExemptionDocumentSearchResult
TaxExemptionDocumentStatus
TaxExemptionReason
TaxExemptionTaxIdType
TaxExemptionTypeOfBusiness
TaxType
TaxTypeConfiguration
TaxTypePrice
Template
TemplateType
TextElement
TextResource
TextResourceContext
TextResourceContextFilterResult
TextResourceFilterResult
TotalPriceTaxGroup
TrackingParameter
TrackingParameterItem
TypedPrice
UpdateApplicablePriceConfigurationsPayload
UpdateAvataxConfigurationPayload
UpdateBiBookmarkPayload
UpdateClientPayload
UpdateContactPayload
UpdateCustomerPayload
UpdateHistoryEntryPayload
UpdateJournalItemIPayload
UpdateKeyGeneratorPayload
UpdateMvtCampaignPayload
UpdateNextBillingDatePayload
UpdateNotificationPayload
UpdatePackageDiscountPayload
UpdatePriceConfigurationPayload
UpdateProductCharacteristicPayload
UpdateProductListPayload
UpdateProductPayload
UpdateProductSelectionPayload
UpdatePromotionPayload
UpdateProtectedUrlPayload
UpdatePurchasePayload
UpdateRecommendationPayload
UpdateRegionConfigurationPayload
UpdateRenewalQuotePayload
UpdateRenewalTypePayload
UpdateSessionPayload
UpdateSubscriptionResult
UpdateTaxExemptionDocumentPayload
UpdateTextElementPayload
UpgradeSubscriptionResult
UrlParameter
UserAccount
UserAccountInformation
UserAccountPrivilege
UserAccountSettings
WebFile
WebFileFilterResult
XmlSchema
__Directive
__EnumValue
__Field
__InputValue
__Schema
__Type
GraphQL Input Objects
AbsoluteDateTimeFilter
BasicRefundOptions
BoolSearchRelationInput
BusinessModelSearchRelationInput
CartInput
CartItemInput
CheckoutLanguageSearchRelationInput
ClientPolicyInput
ContactInput
CountrySearchRelationInput
CreateAvataxConfigurationInput
CreateBrazilianBankAccountInput
CreateContactInput
CreateCustomerContactsInput
CreateCustomerInput
CreateFollowUpInput
CreateHistoryEntryInput
CreateJournalItemInput
CreateKeyGeneratorInput
CreateMvtCampaignCandidateInput
CreateMvtCampaignInput
CreateNotifcationSettingsInput
CreateNotificationInput
CreateNotificationTransportTypeConfigurationInput
CreatePackageDiscountDefinitionInput
CreatePackageDiscountInput
CreatePaymentOptionInputGraphType
CreatePriceAbsoluteInput
CreatePriceAbsoluteValueInput
CreatePriceConfigurationInput
CreateProductCharacteristicInput
CreateProductCharacteristicOptionInput
CreateProductContentSettingsInput
CreateProductDeliveryInput
CreateProductInput
CreateProductListInput
CreateProductSelectionInput
CreatePromotionInput
CreatePromotionPriceSettingsInput
CreateRecommendationInput
CreateRegionConfigurationInput
CreateRenewalQuoteInput
CreateSepaBankAccountInput
CreateSubscriptionInput
CreateSubscriptionItemInput
CreateTaxExemptionContactInput
CreateTaxExemptionDocumentInput
CreateTextElementInput
CurrencyConversionInput
CurrencySearchRelationInput
CustomerSearchParametersInput
DateSearchRelationInput
DateTimeSearchRelationInput
DynamicPriceInput
ErrorLogEntryTypeInput
ErrorLogOrderByInput
ErrorLogSearchParameters
ExtraParameterInput
ExtraParametersSearchRelationInput
File
FloatSearchRelationInput
FollowUpSearchParameters
GenerateCouponCodesInput
GenerateProtectedUrlInput
HistoryCategorySearchRelationInput
HistoryContactMethodSearchRelationInput
HistoryEntrySearchInput
HistoryNatureOfContactSearchRelationInput
HistoryReasonSearchInput
HistoryTypeSearchRelationInput
IntSearchRelationInput
JournalItemOrderByInput
JournalItemPurchaseAssignmentInput
JournalItemSearchParameters
KeyGeneratorSearchParameters
KeyGeneratorTypeSearchRelationInput
localizedIdReferenceInput
LocalizedStringInput
ManualAuthorizationStatusSearchRelationInput
MvtCampaignSearchParametersInput
NotificationSearchParameters
NotificationTransportTypeSearchRelationInput
NumericIdSearchRelationInput
OrderByInput
PackageDiscountSearchOrderByInput
PackageDiscountSearchParameters
PaginationInput
PartnerTypeSearchRelationInput
PaymentAssignmentStatusSearchRelationInput
PaymentTypeCategorySearchRelationInput
PriceAbsoluteInput
PriceAbsoluteValueInput
PriceConfigurationListInput
PriceConfigurationProductItemInput
PriceConfigurationProductListItemInput
PriceFormatInput
PricePercentageInput
PricePercentageValueInput
PriceSettingsInput
ProductBundleInput
ProductDeliveryDownloadOptionsInput
ProductDeliveryKeyDeliveryOptionsInput
ProductDeliverySettingsInput
ProductSearchOrderByInput
ProductSearchParameters
ProductSelectionItemInput
ProductStatusSearchRelationInput
ProductSubscriptionSettingsInput
ProductTypeSearchRelationInput
PromotionCouponInput
PromotionCouponSettingsInput
PromotionProductListInput
ProtectedUrlSearchParameters
PurchaseDocumentSearchOrderByInput
PurchaseDocumentSearchParameters
PurchaseDocumentTypeSearchRelationInput
PurchaseItemDeliveryKey
PurchaseSearchOrderByInput
PurchaseSearchParameters
PurchaseSearchPaymentTypeCategorySearchRelationInput
PurchaseSearchPaymentTypeSearchRelationInput
PurchaseStatusInput
PurchaseStatusSearchRelationInput
RecommendationParameterInput
RecommendationQuantityLimitInput
RecommendedProductInput
ReferringsPaginatedInput
RefundCouponParameters
RefundPolicySettingsInput
RenewalQuoteItemInputGraphType
RenewalQuoteParameters
RenewalQuoteSearchOrderByInput
ResourceEntityContextInput
SessionCartInput
StateSearchRelationInput
StringExtendedSearchRelationInput
StringLimitedSearchRelationInput
StringSearchRelationInput
SubscriptionCartInput
SubscriptionCartItemInput
SubscriptionItemSearchOrderByInput
SubscriptionItemSearchParameters
SubscriptionItemStatusInputSearchRelation
SubscriptionRenewalTypeSearchRelation
SubscriptionStatusInputSearchRelation
TaxExemptionDocumentDateSearchRelationInput
TaxExemptionDocumentDateTimeSearchRelationInput
TaxExemptionDocumentExemptReasonSearchRelationInput
TaxExemptionDocumentIntSearchRelationInput
TaxExemptionDocumentSearchParameters
TaxExemptionDocumentSorterInput
TaxExemptionDocumentStateSearchRelationInput
TaxExemptionDocumentStatusSearchRelationInput
TaxExemptionDocumentStringSearchRelationInput
TaxExemptionDocumentTaxIdTypeSearchRelationInput
TaxExemptionDocumentTypeOfBusinessSearchRelationInput
TaxTypeInput
TextResourceContextFilter
TextResourceFilter
UpdateApplicablePriceConfigurationInput
UpdateApplicablePriceConfigurationsInput
UpdateAvataxConfigurationInput
UpdateBiBookmarkInput
UpdateBoletoPaymentInput
UpdateBrazilianBankAccountInput
UpdateClientInput
UpdateContactInput
UpdateCreditCardInput
UpdateCustomerContactsInput
UpdateDebitCardInput
UpdateErrorLogEntry
UpdateFollowUpInput
UpdateHistoryEntryInput
UpdateIdealPaymentInput
UpdateJournalItemInput
UpdateKeyGeneratorInput
UpdateKonbiniPaymentInput
UpdateMvtCampaignCandidateInput
UpdateMvtCampaignInput
UpdateNotificationInput
UpdateNotificationSettingsInput
UpdateNotificationTransportTypeConfigurationInput
UpdatePackageDiscountDefinitionInput
UpdatePackageDiscountInput
UpdatePaymentProfileInput
UpdatePriceAbsoluteInput
UpdatePriceConfigurationInput
UpdateProductCharacteristicInput
UpdateProductInput
UpdateProductListInput
UpdateProductSelectionInput
UpdatePromotionInput
UpdateProtectedUrlInput
UpdatePurchaseContactsInput
UpdateRecommendationInput
UpdateRegionConfigurationInput
UpdateRenewalQuoteInput
UpdateSepaBankAccountInput
UpdateSessionContactInput
UpdateSessionCustomerContactsInput
UpdateSubscriptionInput
UpdateSubscriptionIntervalInput
UpdateSubscriptionItemInput
UpdateTaxExemptionContactInput
UpdateTaxExemptionDocumentInput
UpdateTextElementInput
UpgradeSubscriptionExtraParameterInput
UpgradeSubscriptionInput
WebFileFilter
GraphQL Directives
deprecated
include
skip
menu
Types
GraphiQL
open_in_new
GraphQL ENUM
ClientSegmentEnum
link
Definition
enum
ClientSegmentEnum
{
# Enterprise
ENTERPRISE
# Growth
GROWTH
# Mid Market
MID_MARKET
}
link
Required by
ClientSegment
null