Automation Run Query Adds New Store Credit Fields

Returns one production or test run of an automation, with its run-level fields. Returns null when no run with the ID exists or its automation isn't readable.

Cancels an order, with options for refunding, restocking inventory, and customer notification.

Caution:
Order cancellation is irreversible. An order that has been cancelled can't be restored to its original state.

Use the orderCancel mutation to programmatically cancel orders in scenarios such as:

• Customer-requested cancellations due to size, color, or other preference changes
• Payment processing failures or declined transactions
• Fraud detection and prevention
• Insufficient inventory availability
• Staff errors in order processing
• Wholesale or B2B order management workflows

The orderCancel mutation provides flexible refund options including refunding to original payment methods
or issuing store credit. If a payment was only authorized (temporarily held) but not yet charged,
that hold will be automatically released when the order is cancelled, even if you choose not to refund other payments.

If the order has an existing
write-off,
calling this mutation can reduce the written-off amount automatically when the cancellation includes a
refund that reduces the order total before write-offs below the remaining written-off amount.

The mutation supports different cancellation reasons: customer requests, payment declines, fraud,
inventory issues, staff errors, or other unspecified reasons. Each cancellation can include optional
staff notes for internal documentation (notes aren't visible to customers).

An order can only be cancelled if it meets the following criteria:

• The order hasn't already been cancelled.
• The order has no pending payment authorizations.
• The order has no active returns in progress.
• The order has no outstanding fulfillments that can't be cancelled.

Orders might be assigned to locations that become
deactivated
after the order was created. When cancelling such orders, inventory behavior depends on payment status:

• Paid orders: Cancellation will fail with an error if restocking is enabled, since inventory
  can't be returned to deactivated locations.
• Unpaid orders: Cancellation succeeds but inventory is not restocked anywhere, even when the
  restock option is enabled. The committed inventory effectively becomes unavailable rather than being
  returned to stock at the deactivated location.

After you cancel an order, you can still make limited updates to certain fields (like
notes and tags) using the
orderUpdate.

For partial refunds or more complex refund scenarios on active orders,
such as refunding only specific line items while keeping the rest of the order fulfilled,
consider using the refundCreate
mutation instead of full order cancellation.

Learn how to build apps that integrate with
order management and fulfillment processes.

Updates the attributes of an order, such as the customer's email, the shipping address for the order,
tags, and metafields associated with the order.

In API version 2026-10 and later, if the order has an existing
write-off,
calling this mutation can reduce the written-off amount automatically when a shipping address change
recalculates taxes and this reduces the order total before write-offs below the remaining written-off
amount.

If you need to make significant updates to an order, such as adding or removing line items, changing
quantities, or modifying discounts, then use
the orderEditBegin
mutation instead. The orderEditBegin mutation initiates an order editing session,
allowing you to make multiple changes before finalizing them. Learn more about using the orderEditBegin
mutation to edit existing orders.

If you need to remove a customer from an order, then use the orderCustomerRemove
mutation instead.

Learn how to build apps that integrate with
order management and fulfillment processes.

Removes return and/or exchange lines from a return.

If the order has an existing
write-off,
calling this mutation can reduce the written-off amount automatically when it reduces the order total
before write-offs below the remaining written-off amount.

Removes return lines from a return.

If the order has an existing
write-off,
calling this mutation can reduce the written-off amount automatically when removing return lines also
removes restocking or return shipping fees and this reduces the order total before write-offs below
the remaining written-off amount.