Sales & CRM
Commerce
Explore the data types and operations available in Commerce.
159 operations
Lists every available Magic Query noun with a short description and its options — the discovery entry point.
listOrderLinesQueryList order lines with pagination. Requires order:list permission.
listOrdersQueryList orders with pagination. Requires order:list permission.
listPaymentsQueryList payments with pagination. Requires payment:list permission.
listPriceBracketsQueryList price brackets with pagination. Requires priceBracket:list permission.
listProductsQueryList products with pagination, filtering, and sorting. Requires product:list permission.
listPurchaseOrderLinesQueryList purchase order lines with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
listPurchaseOrdersQueryList purchase orders with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
listSuppliersQueryList suppliers with pagination, filtering, and sorting. Requires supplier:list permission.
listTaxCodesQueryList tax codes with pagination. Requires taxCode:list permission.
magicQueryQueryExecutes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
orderFulfillmentCompletionQueryAssess current policy across every order line using explicitly attributed quantities
orderLifecycleQueryFetch a complete order lifecycle: order, lines, estimate, invoices, shipments, and jobs. Requires order:read.
pingQueryHealth check endpoint
recordPaymentMutationRecord a payment against an invoice: writes a payment ledger row and rolls the payment up onto the invoice (`paidAmount`, `paid`/`partiallyPaid`, `paidAt`) and its order (`paymentStatus`), atomically. Requires payment:write permission.
reindexEntityNotesMutationQueue bounded recoverable indexing work using the current model
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
reviseEstimateMutationCreate a new revision of an estimate, copying all lines. Requires estimate:write.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchEntityNotesQueryRead operational notes with current target permissions
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
topicExamplesQueryFetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.
updateAddressMutationUpdate an address. Only provided fields are changed. Requires address:write permission.
updateBusinessUnitMutationUpdate a business unit. Only provided fields are changed. Requires businessunit:write permission.
updateContactMutationUpdate a contact. Only provided fields are changed. Requires contact:write permission.
updateCostCenterMutationUpdate a cost center. Only provided fields are changed. Requires costcenter:write permission.
updateCustomerMutationUpdate a customer. Only provided fields are changed. Requires customer:write permission.
updateCustomerPriceOverrideMutationUpdate a customer price override. Only provided fields are changed. Requires customerPriceOverride:write permission.
updateEntityNoteMutationSave note changes independently of embedding success
updateEstimateMutationUpdate an estimate. Only provided fields are changed. Requires estimate:write permission.
updateEstimateLineMutationUpdate an estimate line. Only provided fields are changed. Requires estimate:write permission.
updateInvoiceMutationUpdate an existing invoice. Requires invoice:write permission.
updateInvoiceLineMutationUpdate an invoice line. Only provided fields are changed. Requires invoice:write permission.
updateOrderMutationUpdate an order. Only provided fields are changed. Requires order:write permission.
updateOrderLineMutationUpdate an order line. Only provided fields are changed. Requires order:write permission.
updatePriceBracketMutationUpdate a price bracket. Only provided fields are changed. Requires priceBracket:write permission.
updateProductMutationUpdate a product. Only provided fields are changed. Requires product:write permission.
updatePurchaseOrderMutationUpdate a purchase order. Only provided fields are changed. Requires purchaseOrder:write permission.
updatePurchaseOrderLineMutationUpdate a purchase order line. Only provided fields are changed. Requires purchaseOrder:write permission.
updateSupplierMutationUpdate a supplier. Only provided fields are changed. Requires supplier:write permission.
updateTaxCodeMutationUpdate a tax code. Only provided fields are changed. Requires taxCode:write permission.
upsertAddressMutationCreate or update an address. Requires address:write permission.
upsertBusinessUnitMutationCreate or update a business unit. Requires businessunit:write permission.
upsertContactMutationCreate or update a contact. Requires contact:write permission.
upsertCostCenterMutationCreate or update a cost center. Requires costcenter:write permission.
upsertCustomerMutationCreate or update a customer. Requires customer:write permission.
upsertCustomerPriceOverrideMutationCreate or update a customer price override. Requires customerPriceOverride:write permission.
upsertEstimateMutationCreate or update an estimate. Requires estimate:write permission.
upsertEstimateLineMutationCreate or update an estimate line. Requires estimate:write permission.
upsertInvoiceMutationCreate or update an invoice. Requires invoice:write permission.