Skip to main content

releaseOrder

DEPRECATED

Legacy Orders V1 mutation. It applies to V1 orders only and will be removed once Orders V1 support ends. For V2 orders, use releaseOrderHold.

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 @deprecated

Arguments​

releaseOrder.input ● ReleaseOrderInput! non-null input common​

Parameters for ReleaseOrder

Type​

ReleaseOrderPayload object common​

Autogenerated return type of ReleaseOrder.