Input objects
CancelSalesOrderCommandRequestInput
Cancels the whole sales order with a reason. Fails with a GraphQL error whose extensions.code is SalesOrderCannotBeCancelled. - Request
input
CancelSalesOrderCommandRequestInputFields
salesOrderId
ID!
required
The ID of the sales order. An unknown ID fails with SalesOrderNotFound.
cancellationReasonId
ID!
required
The reason. Fails with CancellationReasonNotFound, or CancellationReasonNotValidForAmazon for an Amazon order.
disableAutomaticWorkflows
Boolean
Suppresses the automatic workflow triggers of this call. Defaults to false when omitted.
cancellationComment
String
A comment, up to 100 characters (CancellationCommentTooLong). Needed when the reason asks for one (CancellationCommentRequired).
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?