Skip to main content

ordersRevertToDraft

Reverts a sales order to Draft so its demand no longer reduces inventory availability.

Business Rules​

  • The order must be a pending, ordered, or in progress V2 sales order.
  • Every fulfillment order must already be canceled, or none may exist.
  • Payment information and order details are preserved. Paid orders are eligible.
  • Confirming the draft restores its inventory demand.

Error Scenarios​

  • The order does not exist or is in an ineligible state.
  • A fulfillment order has not been canceled, including fulfilled orders.
  • The user lacks permission to change this sales order.

Permissions Required​

  • orders:update_sales_order
ordersRevertToDraft(
  input: OrdersRevertToDraftInput!
): V2Order!

Arguments​

ordersRevertToDraft.input ● OrdersRevertToDraftInput! non-null input common​

Parameters for OrdersRevertToDraft

Type​

V2Order object orders​

The V2 order type. This type represents a V2 order in the system with only the fields necessary for draft creation and details.