Sales & CRM
Commerce
Explore the data types and operations available in Commerce.
222 types · Used in operation arguments and return values.
Input for `acceptEstimateAndCreateJobs`: accepts an estimate and materializes the order, its jobs, and each job's production structure in one step.
AcceptEstimatePayloadObjectResult of `acceptEstimateAndCreateJobs`: the order, its lines, and the jobs, components and operations produced from the estimate.
AddressConnectionObjectPaginated list of addresses
AddressFilterInputInputFilter input for address queries
AddressIDScalarUnique identifier for an address
AddressSortInputInputSort input for address queries
AddressStateObjectA physical address from the master address book
BulkUpdateOrderStatusesInputInputApplies one status — and optionally one internal note — to a batch of up to 100 orders.
BulkUpdateOrderStatusesPayloadObjectResult of a bulk order status update. Partial success is expected: unknown ids are reported in failedOrderIds and errors while the orders that were found are still committed together.
BusinessUnitConnectionObjectPaginated list of business units
BusinessUnitFilterInputInputFilter input for business unit queries
BusinessUnitIDScalarUnique identifier for a business unit
BusinessUnitSortInputInputSort input for business unit queries
BusinessUnitStateObjectAn organizational unit that can contain cost centers. Supports hierarchical structure via parentId.
ContactConnectionObjectPaginated list of contacts
ContactFilterInputInputFilter input for contact queries
ContactIDScalarUnique identifier for a contact person
ContactSortInputInputSort input for contact queries
ContactStateObjectA contact person associated with a customer
ConvertEstimateToOrderInputInputInput for `convertEstimateToOrder`: turns an estimate into a confirmed order, copying its lines.
ConvertEstimateToOrderPayloadObjectResult of `convertEstimateToOrder`: the new order, its lines, and the accepted estimate.
CostCenterConnectionObjectPaginated list of cost centers
CostCenterFilterInputInputFilter input for cost center queries
CostCenterIDScalarUnique identifier for a cost center
CostCenterSortInputInputSort input for cost center queries
CostCenterStateObjectA cost center within a business unit for tracking costs and profitability
CreateAddressInputInputInput for creating an address
CreateBusinessUnitInputInputInput for creating a business unit
CreateContactInputInputInput for creating a contact. At least one nonblank firstName, lastName, email, phone, or externalId is required.
CreateCostCenterInputInputInput for creating a cost center
CreateCustomerInputInputInput for creating a customer
CreateCustomerPriceOverrideInputInputInput for creating a customer price override
CreateEntityNoteInputInputEntity note input; no knowledge extraction or lifecycle instruction
CreateEstimateInputInputInput for creating an estimate
CreateEstimateLineInputInputInput for creating an estimate line
CreateInvoiceInputInputInput for creating a new invoice
CreateInvoiceLineInputInputInput for creating an invoice line
CreateJobsFromOrderInputInputInput for `createJobsFromOrder`: materializes production jobs from selected lines of an existing order.
CreateJobsFromOrderPayloadObjectResult of `createJobsFromOrder`: the updated order and the jobs it produced.
CreateOrderGraphInputInputConverged input for createOrderGraph — composes the same Upsert*Input types as the per-resource mutations
CreateOrderGraphPayloadObjectRich payload for createOrderGraph — the full order graph in one response
CreateOrderInputInputInput for creating an order
CreateOrderLineInputInputInput for creating a new order line
CreatePriceBracketInputInputInput for creating a price bracket
CreateProductInputInputInput for creating a product
CreatePurchaseOrderLineInputInputInput for creating a purchase order line
CreateSupplierInputInputInput for creating a supplier
CreateTaxCodeInputInputInput for creating a tax code
CustomerAccountSummaryPayloadObjectA customer's trading position over a date window: their orders, estimates and invoices, plus invoiced/paid/outstanding money totals derived from those invoices.
CustomerConnectionObjectA paginated connection of customers