Sales & CRM

Commerce

Explore the data types and operations available in Commerce.

159 operations

generateEstimateMutation

Generate an automated estimate by inferring operations, calculating costs, and creating estimate lines. Requires estimate:write permission.

getAddressQuery

Fetch a single address by ID. Requires address:read permission.

getAddressByQuery

Fetch an address by external ID. Requires address:read permission.

getBusinessUnitQuery

Fetch a single business unit by ID. Requires businessunit:read permission.

getBusinessUnitByQuery

Fetch a business unit by external ID or code. Requires businessunit:read permission.

getContactQuery

Fetch a contact by its stable ID. Requires contact:read permission.

getContactByQuery

Fetch a contact by external ID or email. Requires contact:read permission.

getCostCenterQuery

Fetch a single cost center by ID. Requires costcenter:read permission.

getCostCenterByQuery

Fetch a cost center by external ID or code. Requires costcenter:read permission.

getCustomerQuery

Fetch a single customer by ID. Requires customer:read permission.

getCustomerByQuery

Fetch a customer by external ID. Requires customer:read permission.

getEntityNoteQuery

Read operational notes with current target permissions

getEntityNoteBySourceQuery

Read operational notes with current target permissions

getEstimateQuery

Fetch an estimate by ID. Requires estimate:read permission.

getEstimateByQuery

Fetch an estimate by external ID. Requires estimate:read permission.

getEstimateLineQuery

Fetch an estimate line by ID. Requires estimate:read permission.

getInvoiceQuery

Fetch a single invoice by ID. Requires invoice:read permission.

getInvoiceLineQuery

Fetch a single invoice line by ID. Requires invoice:read permission.

getMagicQueryGraphQLQuery

Resolves 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.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getOrderQuery

Fetch an order by ID. Requires order:read permission.

getOrderByQuery

Fetch an order by external ID. Requires order:read permission.

getOrderLineQuery

Fetch an order line by ID. Requires order:read permission.

getPaymentQuery

Fetch a single payment by ID. Requires payment:read permission.

getPriceBracketQuery

Fetch a single price bracket by ID. Requires priceBracket:read permission.

getProductQuery

Fetch a single product by ID. Requires product:read permission.

getPurchaseOrderQuery

Fetch a single purchase order by ID. Requires purchaseOrder:read permission.

getPurchaseOrderLineQuery

Fetch a single purchase order line by ID. Requires purchaseOrder:read permission.

getSupplierQuery

Fetch a single supplier by ID. Requires supplier:read permission.

getTaxCodeQuery

Fetch a single tax code by ID. Requires taxCode:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every 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.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

invoiceOrderMutation

Generate an invoice from an order and its lines. Rejects orders that already have an invoice, including concurrent retries. Requires invoice:write.

issueCreditNoteMutation

Issue a credit note against an invoice. Requires invoice:write.

listAddressesQuery

List addresses with pagination. Requires address:list permission.

listBusinessUnitsQuery

List business units with pagination. Requires businessunit:list permission.

listContactsQuery

List contacts with pagination. Requires contact:list permission.

listCostCentersQuery

List cost centers with pagination. Requires costcenter:list permission.

listCustomerPriceOverridesQuery

List customer price overrides. Requires customerPriceOverride:list permission.

listCustomersQuery

List customers with pagination, filtering, and sorting. Requires customer:list permission.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listEstimateCostBreakdownsQuery

List cost breakdowns for an estimate line. Requires estimate:read permission.

listEstimateLinesQuery

List estimate lines with pagination, filtering, and sorting. Requires estimate:list permission.

listEstimatesQuery

List estimates with pagination, filtering, and sorting. Requires estimate:list permission.

listInvoiceLinesQuery

List invoice lines with pagination, filtering, and sorting. Requires invoice:list permission.

listInvoicesQuery

List invoices with pagination, filtering, and sorting. Requires invoice:list permission.