Sales & CRM

Commerce

Explore the data types and operations available in Commerce.

159 operations

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listOrderLinesQuery

List order lines with pagination. Requires order:list permission.

listOrdersQuery

List orders with pagination. Requires order:list permission.

listPaymentsQuery

List payments with pagination. Requires payment:list permission.

listPriceBracketsQuery

List price brackets with pagination. Requires priceBracket:list permission.

listProductsQuery

List products with pagination, filtering, and sorting. Requires product:list permission.

listPurchaseOrderLinesQuery

List purchase order lines with pagination, filtering, and sorting. Requires purchaseOrder:list permission.

listPurchaseOrdersQuery

List purchase orders with pagination, filtering, and sorting. Requires purchaseOrder:list permission.

listSuppliersQuery

List suppliers with pagination, filtering, and sorting. Requires supplier:list permission.

listTaxCodesQuery

List tax codes with pagination. Requires taxCode:list permission.

magicQueryQuery

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

orderFulfillmentCompletionQuery

Assess current policy across every order line using explicitly attributed quantities

orderLifecycleQuery

Fetch a complete order lifecycle: order, lines, estimate, invoices, shipments, and jobs. Requires order:read.

pingQuery

Health check endpoint

recordPaymentMutation

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

reindexEntityNotesMutation

Queue bounded recoverable indexing work using the current model

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

reviseEstimateMutation

Create a new revision of an estimate, copying all lines. Requires estimate:write.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchEntityNotesQuery

Read operational notes with current target permissions

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

topicExamplesQuery

Fetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.

updateAddressMutation

Update an address. Only provided fields are changed. Requires address:write permission.

updateBusinessUnitMutation

Update a business unit. Only provided fields are changed. Requires businessunit:write permission.

updateContactMutation

Update a contact. Only provided fields are changed. Requires contact:write permission.

updateCostCenterMutation

Update a cost center. Only provided fields are changed. Requires costcenter:write permission.

updateCustomerMutation

Update a customer. Only provided fields are changed. Requires customer:write permission.

updateCustomerPriceOverrideMutation

Update a customer price override. Only provided fields are changed. Requires customerPriceOverride:write permission.

updateEntityNoteMutation

Save note changes independently of embedding success

updateEstimateMutation

Update an estimate. Only provided fields are changed. Requires estimate:write permission.

updateEstimateLineMutation

Update an estimate line. Only provided fields are changed. Requires estimate:write permission.

updateInvoiceMutation

Update an existing invoice. Requires invoice:write permission.

updateInvoiceLineMutation

Update an invoice line. Only provided fields are changed. Requires invoice:write permission.

updateOrderMutation

Update an order. Only provided fields are changed. Requires order:write permission.

updateOrderLineMutation

Update an order line. Only provided fields are changed. Requires order:write permission.

updatePriceBracketMutation

Update a price bracket. Only provided fields are changed. Requires priceBracket:write permission.

updateProductMutation

Update a product. Only provided fields are changed. Requires product:write permission.

updatePurchaseOrderMutation

Update a purchase order. Only provided fields are changed. Requires purchaseOrder:write permission.

updatePurchaseOrderLineMutation

Update a purchase order line. Only provided fields are changed. Requires purchaseOrder:write permission.

updateSupplierMutation

Update a supplier. Only provided fields are changed. Requires supplier:write permission.

updateTaxCodeMutation

Update a tax code. Only provided fields are changed. Requires taxCode:write permission.

upsertAddressMutation

Create or update an address. Requires address:write permission.

upsertBusinessUnitMutation

Create or update a business unit. Requires businessunit:write permission.

upsertContactMutation

Create or update a contact. Requires contact:write permission.

upsertCostCenterMutation

Create or update a cost center. Requires costcenter:write permission.

upsertCustomerMutation

Create or update a customer. Requires customer:write permission.

upsertCustomerPriceOverrideMutation

Create or update a customer price override. Requires customerPriceOverride:write permission.

upsertEstimateMutation

Create or update an estimate. Requires estimate:write permission.

upsertEstimateLineMutation

Create or update an estimate line. Requires estimate:write permission.

upsertInvoiceMutation

Create or update an invoice. Requires invoice:write permission.