Sales & CRM

Commerce

Explore the data types and operations available in Commerce.

159 operations

acceptEstimateAndCreateJobsMutation

Accept an estimate and create order + jobs with components/operations from production blueprints. Requires order:write.

bulkUpdateOrderStatusesMutation

Update the status of multiple orders at once. Requires order:write.

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

completeOrderFulfillmentMutation

Explicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work

convertEstimateToOrderMutation

Convert an accepted estimate into an order with order lines. Requires order:write.

createAddressMutation

Create a new address. Requires address:write permission.

createBusinessUnitMutation

Create a new business unit. Requires businessunit:write permission.

createContactMutation

Create a new contact. Requires contact:write permission.

createCostCenterMutation

Create a new cost center. Requires costcenter:write permission.

createCustomerMutation

Create a new customer. Requires customer:write permission.

createCustomerPriceOverrideMutation

Create a new customer price override. Requires customerPriceOverride:write permission.

createEntityNoteMutation

Save note changes independently of embedding success

createEstimateMutation

Create a new estimate. Requires estimate:write permission.

createEstimateLineMutation

Create a new estimate line. Requires estimate:write permission.

createInvoiceMutation

Create a new invoice. Requires invoice:write permission.

createInvoiceLineMutation

Create a new invoice line. Requires invoice:write permission.

createJobsFromOrderMutation

Create jobs from order lines. Requires job:write.

createOrderMutation

Create a new order. Requires order:write permission.

createOrderGraphMutation

Create a complete order — header, customer, billing/shipping addresses, and lines — in a single transaction. Each nested input reuses the same type as the corresponding individual upsert mutation; nested ids are rejected because this mutation is create-only. The resolver also enforces customer:write / address:write / orderline:write when those nested inputs are provided.

createOrderLineMutation

Create a new order line. Requires order:write permission.

createPriceBracketMutation

Create a new price bracket. Requires priceBracket:write permission.

createProductMutation

Create a new product. Requires product:write permission.

createPurchaseOrderLineMutation

Create a new purchase order line. Requires purchaseOrder:write permission.

createSupplierMutation

Create a new supplier. Requires supplier:write permission.

createTaxCodeMutation

Create a new tax code. Requires taxCode:write permission.

customerAccountSummaryQuery

Fetch a customer account summary with orders, estimates, invoices and financial totals. Requires customer:read.

dataChangeEventsSubscription

Subscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).

deleteAddressMutation

Delete an address. Requires address:delete permission.

deleteBusinessUnitMutation

Delete a business unit. Requires businessunit:delete permission.

deleteContactMutation

Delete a contact. Requires contact:delete permission.

deleteCostCenterMutation

Delete a cost center. Requires costcenter:delete permission.

deleteCustomerMutation

Delete a customer. Requires customer:delete permission.

deleteCustomerPriceOverrideMutation

Delete a customer price override. Requires customerPriceOverride:delete permission.

deleteEntityNoteMutation

Save note changes independently of embedding success

deleteEstimateMutation

Delete an estimate. Requires estimate:delete permission.

deleteEstimateLineMutation

Delete an estimate line. Requires estimate:delete permission.

deleteInvoiceMutation

Delete an invoice. Requires invoice:delete permission.

deleteInvoiceLineMutation

Delete an invoice line. Requires invoice:delete permission.

deleteOrderMutation

Delete an order. Requires order:delete permission.

deleteOrderLineMutation

Delete an order line. Requires order:delete permission.

deletePaymentMutation

Delete a payment record. Requires payment:delete permission.

deletePriceBracketMutation

Delete a price bracket. Requires priceBracket:delete permission.

deleteProductMutation

Delete a product. Requires product:delete permission.

deletePurchaseOrderMutation

Delete a purchase order. Requires purchaseOrder:delete permission.

deletePurchaseOrderLineMutation

Delete a purchase order line. Requires purchaseOrder:delete permission.

deleteSupplierMutation

Delete a supplier. Requires supplier:delete permission.

deleteTaxCodeMutation

Delete a tax code. Requires taxCode:delete permission.

duplicateEstimateForCustomerMutation

Duplicate an estimate for a different customer, optionally adjusting prices. Requires estimate:write.

entityNotesQuery

Read operational notes with current target permissions

generateDefaultDataQueryQuery

Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.