Skip to main content

releaseOrder

Release Order

Releases an order from hold status, allowing it to continue processing through the fulfillment workflow.

Requirements

  • Order must be in on_hold status
  • User must have appropriate permissions to release orders

Behavior

  • Restores the order to its previous status before being placed on hold
  • Resolves payment-related alerts by downgrading their severity
  • Triggers order status change notifications
  • May initiate automatic fulfillment based on sales channel configuration
  • Logs the release action with the provided reason

Possible Errors

  • **Not Found**: Order with the provided ID does not exist
  • **Validation Error**: Order is not in on_hold status
  • **Permission Error**: User lacks the required release_order permission
releaseOrder(
input: ReleaseOrderInput!
): ReleaseOrderPayload

Arguments

releaseOrder.input ● ReleaseOrderInput! non-null input

Parameters for ReleaseOrder

Type

ReleaseOrderPayload object

Autogenerated return type of ReleaseOrder.