Input objects
HoldSalesOrderCommandRequestInput
Holds the sales order with a reason; holding again replaces the reason. Fails with a GraphQL error whose extensions.code is SalesOrderCannotBeHeld. - Request
input
HoldSalesOrderCommandRequestInputFields
salesOrderId
ID!
required
The ID of the sales order. An unknown ID fails with SalesOrderNotFound.
onHoldReasonId
ID!
required
The reason. An unknown ID fails with OnHoldReasonNotFound.
disableAutomaticWorkflows
Boolean
Suppresses the automatic workflow triggers of this call. Defaults to false when omitted.
idempotencyKey
String
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?