TriggerSalesOrderActionEventCommandRequestInput
Raises the automatic event of a sales order that belongs to an action (for example created, changed or deleted), so that the workflows that listen to it run. Use it after a write call that was sent with disableAutomaticWorkflows=true. The workflows run asynchronously; their result is not reported back, read the workflow queue and log (QueryWorkflowQueueEntries, QueryWorkflowLogEntries) for it. The action keys a kind of object supports are a catalog in the workflow API design document, not an enum, so new actions are added without a contract change. Errors: SalesOrderNotFound (the sales order does not exist); WORKFLOW_ACTION_UNKNOWN (422, the key is not in the catalog of the sales order); WORKFLOW_ACTION_NOT_AVAILABLE (422, the key is known, but the workflow engine has no such event for sales orders); WorkflowsNotLicensed (the license does not include workflows). - Request
TriggerSalesOrderActionEventCommandRequestInputFields
The ID of the sales order.
The key of the action whose automatic event is raised, for example created, changed or deleted. The keys a sales order supports are listed in the workflow API design document.
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?