GraphQL GraphQL OBJECT
query

Definition

type query {
#   Returns the requested Bookmark.
# 
# Arguments
#   bookmarkId: Unique ID of the bookmark.
#   isDefaultBookmark: Set to true to only return default 
#   bookmarks.
biBookmark(bookmarkId: Int!, isDefaultBookmark: Boolean!): BiBookmark 
#   Returns the personal, account, and default bookmarks of the given user.
# 
# Arguments
#   bookmarkTypeIds: Type of bookmark.
#   parentId: ID of the folder where the bookmark is located. Use 
#   zero to query bookmarks at root level.
#   allowAccountSubsets: Set to true to return bookmarks also when 
#   the set of the client account IDs assigned to the bookmarks is only a subset of 
#   the client account IDs assigned to the user.
biBookmarks(
bookmarkTypeIds: [BookmarkType],
parentId: Int,
allowAccountSubsets: Boolean
): [BiBookmark] 
#   Returns a preview of a shopping cart.
# 
# Arguments
#   cartInput: Cart content information.
cart(cartInput: CartInput!): Cart 
#   Returns the structure of the specified catalog.
# 
# Arguments
#   id: Unique id of the catalog.
catalog(id: Int!): Catalog 
#   Returns the structure of the specified catalog.
# 
# Arguments
#   id: Unique id of the catalog.
#   languageId: Two-character language iso code for localized 
#   output.
catalogStructure(id: Int!, languageId: LanguageEnum): CatalogStructure 
#   Returns the catalog items that match the search parameters.
# 
# Arguments
#   parameters: Parameters of the catalog item search.
catalogItemSearch(parameters: CatalogItemSearchParameters!): CatalogItemSearchResult 
#   Returns the catalogs that match the search parameters.
# 
# Arguments
#   parameters: Parameters of the catalog search.
catalogSearch(parameters: CatalogSearchParameters!): CatalogSearchResult 
#   Returns the shopping cart from a cart session.
# 
# Arguments
#   input: Cart content information.
sessionCart(input: SessionCartInput): SessionCart 
#   Returns a preview of a shopping cart. Omit the items array to use the current 
#   data from the subscription.
# 
# Arguments
#   input: Cart content information.
subscriptionCart(input: SubscriptionCartInput!): Cart 
#   Returns a preview of a shopping cart. Omit the items array to use the current 
#   data from the subscription.
# 
# Arguments
#   input: Cart content information.
subscriptionCarts(input: [SubscriptionCartInput]!): [Cart] 
#   Returns information about the user who is logged in to the cleverbridge 
#   platform.
currentUser: CurrentUser 
#   Returns customer profile and transaction data.
# 
# Arguments
#   id: cleverbridge's unique ID for the customer.
#   clientReferenceId: Your unique ID for the customer.
customer(id: Int, clientReferenceId: String): Customer 
#   Returns the departments that the logged-in user has access to.
# 
# Arguments
#   clientId: Unique ID of the client account.
departments(clientId: Int): [Department] 
#   Returns the download files for a client account or for all client accounts the 
#   user is assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
downloadFiles(clientId: Int): [ClientFile] 
#   Returns the error log entries that match the search parameters.
# 
# Arguments
#   errorLogSearchParameters: Parameters of the error log search.
errorLogSearch(
errorLogSearchParameters: ErrorLogSearchParameters
): ErrorLogEntrySearchResult 
#   Returns a list of flows.
# 
# Arguments
#   clientId: Unique ID of the client account.
flows(clientId: Int): [Flow] 
#   Returns the follow-up that matches the search parameters.
# 
# Arguments
#   id: Unique ID of the follow-up.
followUp(id: Int!): FollowUp 
#   Returns the follow-up reasons that are valid for a specific context.
# 
# Arguments
#   purchaseFollowUpReasonsOnly: Set to true to only get follow-up 
#   reasons for purchases.
followUpReasons(purchaseFollowUpReasonsOnly: Boolean): [FollowUpReason] 
#   Returns the follow-up reason categories that are valid for a specific context.
# 
# Arguments
#   purchaseFollowUpReasonCategoriesOnly: Set to true to only get 
#   follow-up reason categories for purchases.
followUpReasonCategories(
purchaseFollowUpReasonCategoriesOnly: Boolean
): [FollowUpReasonCategory] 
#   Returns the follow-ups that match the search parameters.
# 
# Arguments
#   followUpSearchParameters: Parameters of the follow-up search.
followUpSearch(
followUpSearchParameters: FollowUpSearchParameters
): FollowUpSearchResult 
#   Returns the images for a client account or for all client accounts the user is 
#   assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
images(clientId: Int): [ClientWebbinary] 
#   Returns the key lists for a client account or for all client accounts the user 
#   is assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
keyLists(clientId: Int): [KeyList] 
#   Returns the key generators for a client account.
# 
# Arguments
#   clientId: Unique ID of the client account.
keyGenerators(
clientId: Int
): [KeyGenerator] @deprecated( reason: "Replaced by keyGeneratorSearch"  )
#   Returns the offices that the logged-in user has access to.
# 
# Arguments
#   clientId: Unique ID of the client account.
offices(clientId: Int): [Office] 
#   Returns a office that matches the given ID.
# 
# Arguments
#   id: ID of the office.
office(id: Int!): Office 
#   Returns a list of offices that matches the given parameters.
# 
# Arguments
#   parameters: Parameters of the office search.
officeSearch(parameters: OfficeSearchParameters!): OfficeSearchResult 
#   Returns all products configured for a client account.
# 
# Arguments
#   clientId: Unique ID of the client account.
#   productTypeIds: Type of product.
#   billingType: Type of billing. Allows you to query products with 
#   a subscription pricing model or a one-time-charge pricing model.
products(
clientId: Int,
productTypeIds: [ProductTypeEnum],
billingType: BillingTypeEnum
): [Product] @deprecated( reason: "Replaced by productSearch"  )
#   Returns a specific product.
# 
# Arguments
#   id: Unique ID of the product.
#   internalId: Internal ID of the product. Cross-references the 
#   purchases for this product with your own internal number.
#   clientId: Unique ID of the client account. Mandatory when 
#   querying with "internalId".
#   excludeDerivedFields: Set to true to hide information inherited 
#   from a base product.
product(
id: Int,
internalId: String,
clientId: Int,
excludeDerivedFields: Boolean
): Product 
#   Returns the products that match the search parameters.
# 
# Arguments
#   parameters: Parameters of the product search.
productSearch(parameters: ProductSearchParameters): ProductSearchResult 
#   Returns transaction data.
# 
# Arguments
#   id: Unique ID of the purchase.
purchase(id: Int!): Purchase 
#   Returns the purchase documents for a purchase.
# 
# Arguments
#   purchaseId: Unique ID of the purchase.
purchaseDocuments(purchaseId: Int!): [PurchaseDocument] 
#   Returns the purchase documents which fit to the search parameters
# 
# Arguments
#   purchaseDocumentSearchParameters: Parameters of the purchase 
#   document search.
purchaseDocumentSearch(
purchaseDocumentSearchParameters: PurchaseDocumentSearchParameters!
): PurchaseDocumentSearchResult 
#   Returns the purchases which fit to the search parameters
# 
# Arguments
#   purchaseSearchParameters: Parameters of the purchase search.
purchaseSearch(
purchaseSearchParameters: PurchaseSearchParameters!
): PurchaseSearchResult 
#   Returns the refund reasons that are valid for a specific refund type.
# 
# Arguments
#   refundType: Type of refund.
refundReasons(refundType: RefundTypeEnum!): [RefundReason] 
#   Returns a list of PowerBiReports together with a matching embed token.Requires 
#   privilege "ExecutePowerBI" on "Reporting".
# 
# Arguments
#   workspaceId: Identifies the PowerBi workspace/group the reports 
#   are queried for.
#   clientId: ClientId used as role inside the PowerBi of 
#   Cleverbridge.
powerBiReports(workspaceId: ID!, clientId: Int): PowerBiReports 
#   Returns subscription data.
# 
# Arguments
#   id: Unique ID of the subscription.
#   languageId: Two-character language iso code for localized 
#   output.
subscription(id: Int!, languageId: CheckoutLanguageEnum): Subscription 
#   Returns a preview of how the given subscription would look like after an 
#   upgrade.
# 
# Arguments
#   input: Subscription content information.
upgradeSubscriptionPreview(
input: UpgradeSubscriptionInput!
): UpgradeSubscriptionResult 
#   Returns idp identifier associated with user SSO email.
# 
# Arguments
#   email: User's unique SSO email.
idpIdentifier(email: String!): String 
#   Returns user account information by requested user email.
# 
# Arguments
#   email: User's unique SSO email
#   id: Unique ID of the useraccount
userAccount(email: String, id: Int): UserAccount 
#   Returns user account information for the user who is logged in to the 
#   cleverbridge platform.
# 
# Arguments
#   clientId: Unique ID of the client account.
#   departmentId: Unique ID of the department the user belongs to.
userAccounts(clientId: Int, departmentId: Int): [UserAccount] 
#   Returns test credit number.
generateTestCreditCardNumber: TestCreditCard 
#   Returns the userAccounts that match the search parameters.
# 
# Arguments
#   parameters: Parameters of the user account search.
userAccountSearch(parameters: UserAccountSearchParameters): UserAccountSearchResult 
#   Returns lists of values.
lookups: Lookups 
#   Returns a product list.
# 
# Arguments
#   id: Unique ID of the product list.
productList(id: Int!): ProductList 
#   Returns the product lists for a client account or for all client accounts the 
#   user is assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
productLists(clientId: Int): [ProductList] 
#   Returns a product selection.
# 
# Arguments
#   id: Unique ID of the product selection.
productSelection(id: Int!): ProductSelection 
#   Returns the product selections for a client account or for all client accounts 
#   the user is assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
#   characteristicControlTypeIds: Control type IDs of the product 
#   characteristic.
productSelections(
clientId: Int,
characteristicControlTypeIds: [ControlTypeEnum!]
): [ProductSelection] 
#   Returns account information for a specific client account.
# 
# Arguments
#   id: Unique ID of the client account.
client(id: Int!): Client 
#   Returns account information for all client accounts.
# 
# Arguments
#   activeClientsOnly: Filter for only active (true) or all (false) 
#   clients.
clients(activeClientsOnly: Boolean): [Client] 
#   Returns an input amount converted into one or more other currencies.
# 
# Arguments
#   input: Input for currency conversion.
currencyConversion(input: CurrencyConversionInput!): [CurrencyAmount] 
#   Returns a specific recommendation.
# 
# Arguments
#   id: Unique ID of the recommendation.
recommendation(id: Int!): Recommendation 
#   Returns the recommendations for a client account or for all client accounts the 
#   user is assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
recommendations(clientId: Int): [Recommendation] 
#   Returns templates.
# 
# Arguments
#   clientId: Unique ID of the client account.
#   typeId: Type of template.
#   excludeCleverbridgeTemplates: Indicates whether response should 
#   contain cleverbridge (not client specific) templates. true - exclude 
#   cleverbridge templates from response, false - include.
templates(
clientId: Int,
typeId: TemplateTypeEnum,
excludeCleverbridgeTemplates: Boolean
): [Template] 
#   Returns price configurations for recommendations and promotions.
# 
# Arguments
#   clientId: Unique ID of the client account.
priceConfigurations(clientId: Int): [PriceConfiguration] 
#   Returns a unique Price configuration.
# 
# Arguments
#   id: Unique ID of the price configuration.
priceConfiguration(id: Int!): PriceConfiguration 
#   Returns a specific promotion.
# 
# Arguments
#   id: Unique ID of the promotion.
promotion(id: Int!): Promotion 
#   Returns promotions.
# 
# Arguments
#   clientId: Unique ID of the client account.
#   couponCode: Coupon code for a promotion applied to item(s) in 
#   the cart.
#   type: The type of promotion.
promotions(clientId: Int, couponCode: String, type: PromotionTypeEnum): [Promotion] 
#   Returns the requested number of coupon codes.
# 
# Arguments
#   input: Input for coupon code generation.
generateCouponCodes(input: GenerateCouponCodesInput!): [String] 
#   Returns a specific text element.
# 
# Arguments
#   id: Unique ID of the text element.
textElement(id: Int!): TextElement 
#   Returns the text elements for a client account or for all client accounts the 
#   user is assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
textElements(clientId: Int): [TextElement] 
#   Returns a specific text resource.
# 
# Arguments
#   id: Unique ID of the text resource.
textResource(id: Int!): TextResource 
#   Returns the text resources matching given filter criteria.
# 
# Arguments
#   filter: Mandatory filter for text resources.
textResources(filter: TextResourceFilter!): TextResourceFilterResult 
#   Returns a specific text resource context.
# 
# Arguments
#   id: Unique ID of the text resource context.
textResourceContext(id: Int!): TextResourceContext 
#   Returns the text resource contexts matching given filter criteria.
# 
# Arguments
#   filter: Mandatory filter for text resources contexts.
textResourceContexts(filter: TextResourceContextFilter!): TextResourceContextFilterResult 
#   Returns a specific product characteristic.
# 
# Arguments
#   id: Unique ID of the product characteristic.
productCharacteristic(id: Int!): ProductCharacteristic 
#   Returns the product characteristics for a client account or for all client 
#   accounts the user is assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
#   controlTypeIds: Control type IDs.
productCharacteristics(
clientId: Int,
controlTypeIds: [ControlTypeEnum!]
): [ProductCharacteristic] 
#   Returns a list of configurations. For internal use only.
# 
# Arguments
#   clientId: Unique ID of the client account.
configurations(clientId: Int): [Configuration] 
#   Returns customers that fit to the filters parameters.
# 
# Arguments
#   parameters: Parameters of the customer search.
customerSearch(parameters: CustomerSearchParametersInput): CustomerSearchResult 
#   Returns the protected URLs which fit to the search parameters.
# 
# Arguments
#   parameters: Filters for the search.
protectedUrlSearch(
parameters: ProtectedUrlSearchParameters!
): ProtectedUrlSearchResult 
#   Returns the tracking parameters for a client account or for all client accounts 
#   the user is assigned to.
# 
# Arguments
#   clientId: Unique ID of the client account.
trackingParameters(clientId: Int): [TrackingParameter] 
#   Returns the checksum for a dynamic product url string.
# 
# Arguments
#   dynamicProductString: dynamic product string.
#   clientId: Unique ID of the client account.
dynamicProductChecksum(
dynamicProductString: String!,
clientId: Int
): String 
#   Returns the client's avatax configuration.
# 
# Arguments
#   clientId: Unique ID of the client account.
avataxConfiguration(clientId: Int!): AvataxConfiguration 
#   Returns avatax company codes. Provide a clientId for querying company codes with 
#   the existing avatax configuration for this client, or provide a combination of 
#   accountUsername/licensekeyPassword to query company codes with these 
#   credentials.
# 
# Arguments
#   clientId: Unique ID of the client account.
#   accountUsername: Account or Username for avatax.
#   licensekeyPassword: License key or Password for avatax.
#   useSandbox: Indicates if the sandbox environment should be 
#   used.
avataxCompanyCodes(
clientId: Int,
accountUsername: String,
licensekeyPassword: String,
useSandbox: Boolean
): [String] 
#   Returns a specific partner/affiliate group.
# 
# Arguments
#   id: Unique ID of the partner/affiliate group.
partnerGroup(id: Int!): PartnerGroup 
#   Returns a list of partner/affiliate groups.
# 
# Arguments
#   clientId: Unique ID of the client account.
partnerGroups(clientId: Int): [PartnerGroup] 
#   Returns a region configuration.
# 
# Arguments
#   id: Unique ID of the region configuration.
regionConfiguration(id: Int!): RegionConfiguration 
#   Returns a list of region configurations.
# 
# Arguments
#   clientId: Unique ID of the client account.
#   includeCleverbridgeRegionConfigurations: Should not client 
#   specific region configurations be added to the result?
regionConfigurations(
clientId: Int,
includeCleverbridgeRegionConfigurations: Boolean
): [RegionConfiguration] 
#   Returns a list of applicable price configurations.
# 
# Arguments
#   clientId: Unique ID of the client account.
applicablePriceConfigurations(clientId: Int): [ApplicablePriceConfiguration] 
#   Returns a unique multivariate testing campaign.
# 
# Arguments
#   id: Unique ID of the price configuration.
mvtCampaign(id: Int!): MvtCampaign 
#   Returns multivariate testing campaigns that fit to the filters parameters.
# 
# Arguments
#   parameters: Parameters of the mvt campaign search.
mvtCampaignSearch(
parameters: MvtCampaignSearchParametersInput
): MvtCampaignSearchResult 
#   Returns Key Generators which match the search parameters
# 
# Arguments
#   parameters: Search parameters
keyGeneratorSearch(
parameters: KeyGeneratorSearchParameters!
): KeyGeneratorSearchResultGraphType 
#   Returns a Key Generator by ID
# 
# Arguments
#   id: ID of the Key Generator
keyGenerator(id: Int!): KeyGenerator 
#   Returns a unique client notification.
# 
# Arguments
#   id: Unique ID of the notification.
notification(id: Int!): Notification 
#   Returns a queryable list of client notifications.
# 
# Arguments
#   parameters: Parameters of the notification search.
notificationSearch(
parameters: NotificationSearchParameters!
): NotificationSearchResult 
#   Returns a list of notification contacts.
# 
# Arguments
#   clientId: Unique ID of the client account.
notificationContacts(clientId: Int): [Contact] 
#   Returns a specific web file.
# 
# Arguments
#   id: Unique ID of the text resource.
webFile(id: Int!): WebFile 
#   Returns the web files matching given filter criteria.
# 
# Arguments
#   filter: Mandatory filter for web files.
webFiles(filter: WebFileFilter!): WebFileFilterResult 
#   Returns the history entries that match the search parameters.
# 
# Arguments
#   parameters: Filter parameters for the history entry search.
historyEntrySearch(parameters: HistoryEntrySearchInput): HistoryEntrySearchResult 
#   Returns the current tax types.
# 
# Arguments
#   countryId: The country to search for.
#   stateId: The state to search for. Five- or six-character ID of 
#   the customer's country and state based on ISO 3166-2. It is required for 
#   Australia, Brazil, Canada, India, Ireland, Japan, the UAE, and the USA.
#   taxationTime: The time the taxation takes place. If no 
#   parameter given, this defaults to the current timestamp.
#   clientId: The client ID.
taxTypeConfigurations(
countryId: CountryEnum!,
stateId: StateEnum,
taxationTime: DateTime,
clientId: Int
): [TaxTypeConfiguration] 
#   Returns the web files matching given filter criteria.
# 
# Arguments
#   parameters: Parameters of the journal item search.
journalItemSearch(parameters: JournalItemSearchParameters!): JournalItemSearchResult 
#   Returns a tax exemption document.
# 
# Arguments
#   id: ID of the requested tax exemption document.
taxExemptionDocument(id: String!): TaxExemptionDocument 
#   Returns a filtered list of tax exemption documents.
# 
# Arguments
#   parameters: Parameters.
taxExemptionDocumentSearch(
parameters: TaxExemptionDocumentSearchParameters!
): TaxExemptionDocumentSearchResult 
#   Returns a journal item that matches the given ID.
# 
# Arguments
#   id: ID of the journal item.
journalItem(id: Int!): JournalItem 
#   Returns a package discount that matches the given ID.
# 
# Arguments
#   id: ID of the package discount.
packageDiscount(id: Int!): PackageDiscount 
#   Returns a list of package discounts that matches the given parameters.
# 
# Arguments
#   parameters: Parameters of the package discount search.
packageDiscountSearch(
parameters: PackageDiscountSearchParameters!
): PackageDiscountSearchResult 
#   Returns a list of subscriptions items.
# 
# Arguments
#   parameters: Parameters of the subscription item search.
subscriptionItemSearch(
parameters: SubscriptionItemSearchParameters!
): SubscriptionItemSearchResult 
#   Updates a subscription.
# 
# Arguments
#   subscriptionId: ID of the subscription.
#   input: Update input for the subscription.
updateSubscriptionPreview(
subscriptionId: Int!,
input: UpdateSubscriptionInput!
): UpdateSubscriptionResult 
#   Returns a metadata with price formatting information.
# 
# Arguments
#   input: Input for price format.
priceFormat(input: PriceFormatInput!): PriceFormat 
#   Returns data from a session.
session: Session 
#   Returns a renewal quote that matches the given ID.
# 
# Arguments
#   id: ID of the renewal quote.
renewalQuote(id: Int!): RenewalQuote 
#   Returns the renewal quotes that match the search parameters.
# 
# Arguments
#   parameters: Parameters of the renewal quote search.
renewalQuoteSearch(parameters: RenewalQuoteParameters!): RenewalQuoteSearchResult 
#   Returns a security policy that matches the given ID.
# 
# Arguments
#   id: ID of the security policy.
securityPolicy(id: Int!): SecurityPolicy 
#   Returns a list of security policies that matches the given parameters.
# 
# Arguments
#   parameters: Parameters of the security policy search.
securityPolicySearch(
parameters: SecurityPolicySearchParameters!
): SecurityPolicySearchResult 
#   Returns a privilege set that matches the given ID.
# 
# Arguments
#   id: ID of the privilege set.
privilegeSet(id: Int!): PrivilegeSet 
#   Returns a list of privilege sets that matches the given parameters.
# 
# Arguments
#   parameters: Parameters of the privilege set search.
privilegeSetSearch(
parameters: PrivilegeSetSearchParameters!
): PrivilegeSetSearchResult 
#   Returns a department that matches the given ID.
# 
# Arguments
#   id: ID of the department.
department(id: Int!): Department 
#   Returns the departments that match the search parameters.
# 
# Arguments
#   parameters: Parameters of the department search.
departmentSearch(parameters: DepartmentSearchParameters!): DepartmentSearchResult 
}
Required by

This element is not required by anyone
query

link Definition

link Required by

Definition

Required by
