GraphQL OBJECT
query
link Definition
- type query {
- #   Returns the requested Bookmark.
- # 
- # Arguments
- #   bookmarkId: Unique ID of the bookmark.
- #   isDefaultBookmark: Set to true to only return default 
- #   bookmarks.
- (: Int!, : 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.
- (
- : [BookmarkType],
- : Int,
- : Boolean
- ): [BiBookmark] 
- #   Returns a preview of a shopping cart.
- # 
- # Arguments
- #   cartInput: Cart content information.
- (: CartInput!): Cart 
- #   Returns the structure of the specified catalog.
- # 
- # Arguments
- #   id: Unique id of the catalog.
- (: 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.
- (: Int!, : LanguageEnum): CatalogStructure 
- #   Returns the catalog items that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the catalog item search.
- (: CatalogItemSearchParameters!): CatalogItemSearchResult 
- #   Returns the catalogs that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the catalog search.
- (: CatalogSearchParameters!): CatalogSearchResult 
- #   Returns the shopping cart from a cart session.
- # 
- # Arguments
- #   input: Cart content information.
- (: 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.
- (: 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.
- (: [SubscriptionCartInput]!): [Cart] 
- #   Returns information about the user who is logged in to the cleverbridge 
- #   platform.
- : CurrentUser 
- #   Returns customer profile and transaction data.
- # 
- # Arguments
- #   id: cleverbridge's unique ID for the customer.
- #   clientReferenceId: Your unique ID for the customer.
- (: Int, : String): Customer 
- #   Returns the departments that the logged-in user has access to.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (: 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.
- (: Int): [ClientFile] 
- #   Returns the error log entries that match the search parameters.
- # 
- # Arguments
- #   errorLogSearchParameters: Parameters of the error log search.
- (
- : ErrorLogSearchParameters
- ): ErrorLogEntrySearchResult 
- #   Returns a list of flows.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (: Int): [Flow] 
- #   Returns the follow-up that matches the search parameters.
- # 
- # Arguments
- #   id: Unique ID of the follow-up.
- (: 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.
- #   validForPurchase: Set to true to get follow-up reasons for 
- #   purchases.
- #   validForClient: Set to true to get follow-up reasons for 
- #   clients.
- (
- : Boolean,
- : Boolean,
- : 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 reasons for purchases.
- #   validForPurchase: Set to true to get follow-up reasons for 
- #   purchases.
- #   validForClient: Set to true to get follow-up reasons for 
- #   clients.
- (
- : Boolean,
- : Boolean,
- : Boolean
- ): [FollowUpReasonCategory] 
- #   Returns the follow-ups that match the search parameters.
- # 
- # Arguments
- #   followUpSearchParameters: Parameters of the follow-up search.
- (
- : 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.
- (: 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.
- (: Int): [KeyList] 
- #   Returns the key generators for a client account.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (
- : 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.
- (: Int): [Office] 
- #   Returns a office that matches the given ID.
- # 
- # Arguments
- #   id: ID of the office.
- (: Int!): Office 
- #   Returns a list of offices that matches the given parameters.
- # 
- # Arguments
- #   parameters: Parameters of the office search.
- (: 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.
- (
- : Int,
- : [ProductTypeEnum],
- : 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.
- (
- : Int,
- : String,
- : Int,
- : Boolean
- ): Product 
- #   Returns the products that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the product search.
- (: ProductSearchParameters): ProductSearchResult 
- #   Returns transaction data.
- # 
- # Arguments
- #   id: Unique ID of the purchase.
- (: Int!): Purchase 
- #   Returns the product file for a specified product file id.
- # 
- # Arguments
- #   id: Unique ID of the product file.
- (: Int!): ProductFile 
- #   Returns the product files that match the search parameters.
- # 
- # Arguments
- #   parameters: Filter parameters for the product files search.
- (: ProductFileSearchParameters): ProductFileSearchResult 
- #   Returns the purchase documents for a purchase.
- # 
- # Arguments
- #   purchaseId: Unique ID of the purchase.
- (: Int!): [PurchaseDocument] 
- #   Returns the purchase documents which fit to the search parameters
- # 
- # Arguments
- #   purchaseDocumentSearchParameters: Parameters of the purchase 
- #   document search.
- (
- : PurchaseDocumentSearchParameters!
- ): PurchaseDocumentSearchResult 
- #   Returns the purchases which fit to the search parameters
- # 
- # Arguments
- #   purchaseSearchParameters: Parameters of the purchase search.
- (
- : PurchaseSearchParameters!
- ): PurchaseSearchResult 
- #   Returns the refund reasons that are valid for a specific refund type.
- # 
- # Arguments
- #   refundType: Type of refund.
- (: 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.
- (: ID!, : Int): PowerBiReports 
- #   Returns subscription data.
- # 
- # Arguments
- #   id: Unique ID of the subscription.
- #   languageId: Two-character language iso code for localized 
- #   output.
- (: Int!, : CheckoutLanguageEnum): Subscription 
- #   Returns a preview of how the given subscription would look like after an 
- #   upgrade.
- # 
- # Arguments
- #   input: Subscription content information.
- (
- : UpgradeSubscriptionInput!
- ): UpgradeSubscriptionResult @deprecated( reason: "Use subscriptionUpgradePreviews instead."  )
- #   Returns a preview of how the given subscription would look like after an 
- #   upgrade.
- # 
- # Arguments
- #   input: List of subscription upgrade previews to process.
- (
- : [SubscriptionUpgradePreviewInput]!
- ): [SubscriptionUpgradePreviewResult] 
- #   Returns idp identifier associated with user SSO email.
- # 
- # Arguments
- #   email: User's unique SSO email.
- (: String!): String 
- #   Returns user account information by requested user email.
- # 
- # Arguments
- #   email: User's unique SSO email
- #   id: Unique ID of the useraccount
- (: String, : 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.
- (: Int, : Int): [UserAccount] 
- #   Returns test credit number.
- : TestCreditCard 
- #   Returns the userAccounts that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the user account search.
- (: UserAccountSearchParameters): UserAccountSearchResult 
- #   Returns lists of values.
- : Lookups 
- #   Returns a product list.
- # 
- # Arguments
- #   id: Unique ID of the product list.
- (: 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.
- (: Int): [ProductList] 
- #   Returns a product selection.
- # 
- # Arguments
- #   id: Unique ID of the product selection.
- (: 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.
- (
- : Int,
- : [ControlTypeEnum!]
- ): [ProductSelection] 
- #   Returns account information for a specific client account.
- # 
- # Arguments
- #   id: Unique ID of the client account.
- (: Int!): Client 
- #   Returns account information for all client accounts.
- # 
- # Arguments
- #   activeClientsOnly: Filter for only active (true) or all (false) 
- #   clients.
- (: Boolean): [Client] 
- #   Returns the clients that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the client search.
- (: ClientSearchParameters): ClientSearchResult 
- #   Returns an input amount converted into one or more other currencies.
- # 
- # Arguments
- #   input: Input for currency conversion.
- (: CurrencyConversionInput!): [CurrencyAmount] 
- #   Returns a specific recommendation.
- # 
- # Arguments
- #   id: Unique ID of the recommendation.
- (: 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.
- (: 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.
- (
- : Int,
- : TemplateTypeEnum,
- : Boolean
- ): [Template] 
- #   Returns price configurations for recommendations and promotions.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (: Int): [PriceConfiguration] 
- #   Returns a unique Price configuration.
- # 
- # Arguments
- #   id: Unique ID of the price configuration.
- (: Int!): PriceConfiguration 
- #   Returns a specific promotion.
- # 
- # Arguments
- #   id: Unique ID of the promotion.
- (: 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.
- (: Int, : String, : PromotionTypeEnum): [Promotion] 
- #   Returns the requested number of coupon codes.
- # 
- # Arguments
- #   input: Input for coupon code generation.
- (: GenerateCouponCodesInput!): [String] 
- #   Returns a specific text element.
- # 
- # Arguments
- #   id: Unique ID of the text element.
- (: 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.
- (: Int): [TextElement] 
- #   Returns a specific text resource.
- # 
- # Arguments
- #   id: Unique ID of the text resource.
- (: Int!): TextResource 
- #   Returns the text resources matching given filter criteria.
- # 
- # Arguments
- #   filter: Mandatory filter for text resources.
- (: TextResourceFilter!): TextResourceFilterResult 
- #   Returns a specific text resource context.
- # 
- # Arguments
- #   id: Unique ID of the text resource context.
- (: Int!): TextResourceContext 
- #   Returns the text resource contexts matching given filter criteria.
- # 
- # Arguments
- #   filter: Mandatory filter for text resources contexts.
- (: TextResourceContextFilter!): TextResourceContextFilterResult 
- #   Returns a specific product characteristic.
- # 
- # Arguments
- #   id: Unique ID of the product characteristic.
- (: 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.
- (
- : Int,
- : [ControlTypeEnum!]
- ): [ProductCharacteristic] 
- #   Returns a list of configurations. For internal use only.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (: Int): [Configuration] 
- #   Returns customers that fit to the filters parameters.
- # 
- # Arguments
- #   parameters: Parameters of the customer search.
- (: CustomerSearchParametersInput): CustomerSearchResult 
- #   Returns the protected URLs which fit to the search parameters.
- # 
- # Arguments
- #   parameters: Filters for the search.
- (
- : 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.
- (: Int): [TrackingParameter] 
- #   Returns the checksum for a dynamic product url string.
- # 
- # Arguments
- #   dynamicProductString: dynamic product string.
- #   clientId: Unique ID of the client account.
- (
- : String!,
- : Int
- ): String 
- #   Returns the client's avatax configuration.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (: 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.
- (
- : Int,
- : String,
- : String,
- : Boolean
- ): [String] 
- #   Returns a specific partner/affiliate group.
- # 
- # Arguments
- #   id: Unique ID of the partner/affiliate group.
- (: Int!): PartnerGroup 
- #   Returns a list of partner/affiliate groups.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (: Int): [PartnerGroup] 
- #   Returns a region configuration.
- # 
- # Arguments
- #   id: Unique ID of the region configuration.
- (: 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?
- (
- : Int,
- : Boolean
- ): [RegionConfiguration] 
- #   Returns a list of applicable price configurations.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (: Int): [ApplicablePriceConfiguration] 
- #   Returns a unique multivariate testing campaign.
- # 
- # Arguments
- #   id: Unique ID of the price configuration.
- (: Int!): MvtCampaign 
- #   Returns multivariate testing campaigns that fit to the filters parameters.
- # 
- # Arguments
- #   parameters: Parameters of the mvt campaign search.
- (
- : MvtCampaignSearchParametersInput
- ): MvtCampaignSearchResult 
- #   Returns Key Generators which match the search parameters
- # 
- # Arguments
- #   parameters: Search parameters
- (
- : KeyGeneratorSearchParameters!
- ): KeyGeneratorSearchResultGraphType 
- #   Returns a Key Generator by ID
- # 
- # Arguments
- #   id: ID of the Key Generator
- (: Int!): KeyGenerator 
- #   Returns a unique client notification.
- # 
- # Arguments
- #   id: Unique ID of the notification.
- (: Int!): Notification 
- #   Returns a queryable list of client notifications.
- # 
- # Arguments
- #   parameters: Parameters of the notification search.
- (
- : NotificationSearchParameters!
- ): NotificationSearchResult 
- #   Returns a list of notification contacts.
- # 
- # Arguments
- #   clientId: Unique ID of the client account.
- (: Int): [Contact] 
- #   Returns a specific web file.
- # 
- # Arguments
- #   id: Unique ID of the text resource.
- (: Int!): WebFile 
- #   Returns the web files matching given filter criteria.
- # 
- # Arguments
- #   filter: Mandatory filter for web files.
- (
- : WebFileFilter!
- ): WebFileFilterResult @deprecated( reason: "Replaced by webFileSearch"  )
- #   Returns the web files that match the search parameters.
- # 
- # Arguments
- #   parameters: Filter parameters for the web files search.
- (: WebFileSearchParameters): WebFileSearchResult 
- #   Returns the web folders for a client.
- # 
- # Arguments
- #   clientId: The client ID.
- (: Int!): [WebFileFolder] 
- #   Returns the history entries that match the search parameters.
- # 
- # Arguments
- #   parameters: Filter parameters for the history entry search.
- (: 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.
- (
- : CountryEnum!,
- : StateEnum,
- : DateTime,
- : Int
- ): [TaxTypeConfiguration] 
- #   Returns the web files matching given filter criteria.
- # 
- # Arguments
- #   parameters: Parameters of the journal item search.
- (: JournalItemSearchParameters!): JournalItemSearchResult 
- #   Returns a tax exemption document.
- # 
- # Arguments
- #   id: ID of the requested tax exemption document.
- (: String!): TaxExemptionDocument 
- #   Returns a filtered list of tax exemption documents.
- # 
- # Arguments
- #   parameters: Parameters.
- (
- : TaxExemptionDocumentSearchParameters!
- ): TaxExemptionDocumentSearchResult 
- #   Returns a journal item that matches the given ID.
- # 
- # Arguments
- #   id: ID of the journal item.
- (: Int!): JournalItem 
- #   Returns a package discount that matches the given ID.
- # 
- # Arguments
- #   id: ID of the package discount.
- (: Int!): PackageDiscount 
- #   Returns a list of package discounts that matches the given parameters.
- # 
- # Arguments
- #   parameters: Parameters of the package discount search.
- (
- : PackageDiscountSearchParameters!
- ): PackageDiscountSearchResult 
- #   Returns a list of subscriptions items.
- # 
- # Arguments
- #   parameters: Parameters of the subscription item search.
- (
- : SubscriptionItemSearchParameters!
- ): SubscriptionItemSearchResult 
- #   Updates a subscription.
- # 
- # Arguments
- #   subscriptionId: ID of the subscription.
- #   input: Update input for the subscription.
- (
- : Int!,
- : UpdateSubscriptionInput!
- ): UpdateSubscriptionResult @deprecated( reason: "Use subscriptionUpdatePreviews instead."  )
- #   Returns a preview of how the given subscription would look like after an update.
- # 
- # Arguments
- #   input: List of subscription update previews.
- (
- : [SubscriptionUpdatePreviewInput]!
- ): [SubscriptionUpdatePreviewResult] 
- #   Returns a metadata with price formatting information.
- # 
- # Arguments
- #   input: Input for price format.
- (: PriceFormatInput!): PriceFormat 
- #   Returns data from a session.
- : Session 
- #   Returns a renewal quote that matches the given ID.
- # 
- # Arguments
- #   id: ID of the renewal quote.
- (
- : Int!
- ): RenewalQuote @deprecated( reason: "Use subscriptionQuote instead."  )
- #   Returns the renewal quotes that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the renewal quote search.
- (
- : RenewalQuoteParameters!
- ): RenewalQuoteSearchResult @deprecated( reason: "Use subscriptionQuoteSearch instead."  )
- #   Returns a subscription quote that matches the given ID.
- # 
- # Arguments
- #   id: ID of the subscription quote.
- (: Int!): SubscriptionQuote 
- #   Returns the subscription quotes that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the subscription quote search.
- (
- : SubscriptionQuoteSearchParameters!
- ): SubscriptionQuoteSearchResult 
- #   Returns a security policy that matches the given ID.
- # 
- # Arguments
- #   id: ID of the security policy.
- (: Int!): SecurityPolicy 
- #   Returns a list of security policies that matches the given parameters.
- # 
- # Arguments
- #   parameters: Parameters of the security policy search.
- (
- : SecurityPolicySearchParameters!
- ): SecurityPolicySearchResult 
- #   Returns a privilege set that matches the given ID.
- # 
- # Arguments
- #   id: ID of the privilege set.
- (: Int!): PrivilegeSet 
- #   Returns a list of privilege sets that matches the given parameters.
- # 
- # Arguments
- #   parameters: Parameters of the privilege set search.
- (
- : PrivilegeSetSearchParameters!
- ): PrivilegeSetSearchResult 
- #   Returns a department that matches the given ID.
- # 
- # Arguments
- #   id: ID of the department.
- (: Int!): Department 
- #   Returns the departments that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the department search.
- (: DepartmentSearchParameters!): DepartmentSearchResult 
- #   Returns a specific shipping configuration.
- # 
- # Arguments
- #   id: Unique ID of the shipping configuration.
- (: Int!): ShippingConfiguration 
- #   Returns the shipping configuration that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the shipping configuration search.
- (
- : ShippingConfigurationSearchParameters!
- ): ShippingConfigurationSearchResult 
- #   List of payment delinquency configurations.
- : [PaymentDelinquencyConfiguration] 
- #   Returns a specific support contact.
- # 
- # Arguments
- #   id: Unique ID of the support contact.
- (: Int!): SupportContact 
- #   Returns the support contacts that match the search parameters.
- # 
- # Arguments
- #   parameters: Parameters of the support contact search.
- (
- : SupportContactSearchParametersInput
- ): SupportContactSearchResult 
- }
link Required by
This element is not required by anyone