B2B-GRAPHQL-UAT-API
Query
Commerce Modern GraphQL – Query Operations
This document describes all root Query operations exposed by the Commerce Modern API, along with the key input and result types, and the common interfaces, scalars, and enums they rely on.
Queries| Mutations| Subscriptions
1. Query Operations
Each operation below is defined on the GraphQL Query type in common.graphqls.
1.1 getListOfValues
Signature
getListOfValues(input: ListOfValuesInput!): ListOfValues
Description
Returns lists of allowed values for attributes used in search and filter criteria (for example, UI dropdowns, validation lists, and filter options).
1.2 userInfo
Signature
userInfo(input: ActorInput): ActorDescription
Retrieves user profile information for a single user, based on the provided actor criteria.
1.3 searchUser
Signature
searchUser(input: ActorInput): [Actor]Description
Searches for users that match the given criteria and returns a list of Actor records.
1.4 getItems
Signature
getItems(input: ItemSearch!): CatalogResultDescription
Searches the product catalog and returns items that match the given search criteria (for example, SKU/part number, classification, portfolio, or keywords).
1.5 getEstimate
Signature
getEstimate(input: EstimateInput): EstimateDescription
Retrieves a single estimate that matches the provided identifier or search parameters.
1.6 searchEstimate
Signature
searchEstimate(input: EstimateSearchInput): EstimateResultDescription
Searches for estimates based on flexible criteria (such as account, status, creation date, etc.) and returns a paginated EstimateResult.
1.7 validateEstimate
Signature
validateEstimate(input: EstimateInput): EstimateDescription
Validates an estimate against business rules and pricing logic, returning the evaluated Estimate (including validation messages and status).
1.8 searchQuote
Signature
searchQuote(input: QuoteSearchInput): QuoteResultDescription
Searches for quotes based on quote identifiers and filters (such as status, customer, date ranges), returning a paginated QuoteResult.
1.9 getQuote
Signature
getQuote(input: QuoteSearchInput): QuoteDescription
Retrieves the details of a single quote that matches the given criteria.
1.10 searchOrder
Signature
searchOrder(input: OrderSearchInput): OrderResultDescription
Searches for orders based on order number, customer PO, account, status, or other attributes, returning a paginated OrderResult.
1.11 getOrderDetails
Signature
getOrderDetails(input: OrderSearchInput): OrderResultDescription
Retrieves detailed information for one or more orders that match the given search criteria (for example, line-level details and status history).
1.12 getSubscriptionDetails
Signature
getSubscriptionDetails(input: MySubscriptionSearchInput): MySubscriptionResultDescription
Retrieves detailed subscription information for one or more subscriptions that match the provided search criteria.
1.13 searchSubscription
Signature
searchSubscription(input: MySubscriptionSearchInput): MySubscriptionResultDescription
Searches for subscriptions using flexible filters (such as subscription ID, account, status, and term) and returns a paginated MySubscriptionResult.
1.14 getInvoiceDocument
Signature
getInvoiceDocument(input: InvoiceInput): InvoiceDocumentDescription
Retrieves an invoice document (for example, a PDF reference or structured document metadata) based on the invoice input.
1.15 searchInvoice
Signature
searchInvoice(input: InvoiceInput): InvoiceResultDescription
Searches for invoices based on identification and filter criteria (such as invoice number, account, and date ranges), returning a paginated InvoiceResult.
1.16 getInvoiceDetails
Signature
getInvoiceDetails(input: InvoiceInput): InvoiceResultDescription
Retrieves detailed invoice information for one or more invoices that match the given input.
1.17 getPricingCard
Signature
getPricingCard(input: PricingCardInput): PricingCardResultDescription
Retrieves a pricing card for the given context (for example, buying program, offer, product set), including pricing, terms, and related commercial attributes.
1.18 searchSmartAccounts
Signature
searchSmartAccounts(input: SmartAccountSearchInput): SmartAccountResultDescription
Searches for Smart Accounts based on the provided criteria (such as name, ID, or ownership attributes). Smart Accounts are used for software licensing, entitlement management, and compliance tracking.
1.19 searchVirtualAccount
Signature
searchVirtualAccount(input: VirtualAccountInput): SmartAccountResultDescription
Searches for Virtual Accounts within a Smart Account. Virtual Accounts provide organizational structure (for example, departments or business units) within a Smart Account for better license and asset management.