Sales & CRM
Commerce
Explore the data types and operations available in Commerce.
159 operations
Generate an automated estimate by inferring operations, calculating costs, and creating estimate lines. Requires estimate:write permission.
getAddressQueryFetch a single address by ID. Requires address:read permission.
getAddressByQueryFetch an address by external ID. Requires address:read permission.
getBusinessUnitQueryFetch a single business unit by ID. Requires businessunit:read permission.
getBusinessUnitByQueryFetch a business unit by external ID or code. Requires businessunit:read permission.
getContactQueryFetch a contact by its stable ID. Requires contact:read permission.
getContactByQueryFetch a contact by external ID or email. Requires contact:read permission.
getCostCenterQueryFetch a single cost center by ID. Requires costcenter:read permission.
getCostCenterByQueryFetch a cost center by external ID or code. Requires costcenter:read permission.
getCustomerQueryFetch a single customer by ID. Requires customer:read permission.
getCustomerByQueryFetch a customer by external ID. Requires customer:read permission.
getEntityNoteQueryRead operational notes with current target permissions
getEntityNoteBySourceQueryRead operational notes with current target permissions
getEstimateQueryFetch an estimate by ID. Requires estimate:read permission.
getEstimateByQueryFetch an estimate by external ID. Requires estimate:read permission.
getEstimateLineQueryFetch an estimate line by ID. Requires estimate:read permission.
getInvoiceQueryFetch a single invoice by ID. Requires invoice:read permission.
getInvoiceLineQueryFetch a single invoice line by ID. Requires invoice:read permission.
getMagicQueryGraphQLQueryResolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getOrderQueryFetch an order by ID. Requires order:read permission.
getOrderByQueryFetch an order by external ID. Requires order:read permission.
getOrderLineQueryFetch an order line by ID. Requires order:read permission.
getPaymentQueryFetch a single payment by ID. Requires payment:read permission.
getPriceBracketQueryFetch a single price bracket by ID. Requires priceBracket:read permission.
getProductQueryFetch a single product by ID. Requires product:read permission.
getPurchaseOrderQueryFetch a single purchase order by ID. Requires purchaseOrder:read permission.
getPurchaseOrderLineQueryFetch a single purchase order line by ID. Requires purchaseOrder:read permission.
getSupplierQueryFetch a single supplier by ID. Requires supplier:read permission.
getTaxCodeQueryFetch a single tax code by ID. Requires taxCode:read permission.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
invoiceOrderMutationGenerate an invoice from an order and its lines. Rejects orders that already have an invoice, including concurrent retries. Requires invoice:write.
issueCreditNoteMutationIssue a credit note against an invoice. Requires invoice:write.
listAddressesQueryList addresses with pagination. Requires address:list permission.
listBusinessUnitsQueryList business units with pagination. Requires businessunit:list permission.
listContactsQueryList contacts with pagination. Requires contact:list permission.
listCostCentersQueryList cost centers with pagination. Requires costcenter:list permission.
listCustomerPriceOverridesQueryList customer price overrides. Requires customerPriceOverride:list permission.
listCustomersQueryList customers with pagination, filtering, and sorting. Requires customer:list permission.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listEstimateCostBreakdownsQueryList cost breakdowns for an estimate line. Requires estimate:read permission.
listEstimateLinesQueryList estimate lines with pagination, filtering, and sorting. Requires estimate:list permission.
listEstimatesQueryList estimates with pagination, filtering, and sorting. Requires estimate:list permission.
listInvoiceLinesQueryList invoice lines with pagination, filtering, and sorting. Requires invoice:list permission.
listInvoicesQueryList invoices with pagination, filtering, and sorting. Requires invoice:list permission.