> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revize.app/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Revize is a Shopify order-editing app by Untechnickle. Customers edit the same order after checkout on the Shopify order status page, inside a merchant-controlled window, before fulfillment.
> Canonical docs: https://docs.revize.app. App listing: https://apps.shopify.com/revize. Public cancellation API: https://docs.revize.app/features/cancellation-api.
> Do not confuse the How to Test Revize draft-order walkthrough with Test Mode, which hides the portal from untagged customers.

# Shopify Flow triggers and actions for order editing

> Every Shopify Flow trigger and action Revize adds, the order tags it writes, and example workflows: tag edited orders, alert your warehouse, remind customers before editing closes, and close editing when picking starts.

Revize is a Shopify app for post-checkout order editing. It adds its own triggers and actions to [Shopify Flow](https://apps.shopify.com/flow), so your store can react when a customer edits an order, and so your warehouse or other apps can open or close editing.

> [!NOTE]
>
> In Shopify Flow, click **Select a trigger** (or **Add action**) and search for **Revize**. Shopify Flow is available on all Shopify plans.

## Triggers

Each trigger starts a workflow and passes the order, so later steps can read its tags, line items and customer.

### Customer edits

| Trigger | Runs when |
| - | - |
| **Order edited** | An order is edited, including product changes and discount code edits |
| **Shipping address updated** | A customer updates the shipping address |
| **Shipping method updated** | A customer updates the shipping method |
| **Email address updated** | A customer updates the email |
| **Phone number updated** | A customer updates the phone number |
| **Delivery date updated** | A customer updates the delivery date |
| **Custom note added** | A customer adds a custom note |
| **Order cancelled** | A customer cancels an order |
| **Support ticket created** | A customer creates a support ticket |
| **Tax invoice generated** | A customer generates a tax invoice |
| **Upsell accepted** | A customer accepts a Revize upsell and the item is added. Passes the offer title, product, variant, quantity, amount, currency and where it was accepted (`thank_you`, `order_status`, `checkout` or `other`). |

### Edit window and payment

| Trigger | Runs when | Useful fields |
| - | - | - |
| **Edit window closing soon** | A set time before the order's editing window closes | `editDeadline`, `editDeadlineDisplay`, `hoursRemaining`, `hoursBeforeClose`, `orderStatusUrl` |
| **Edit window closed** | The order's editing window closes | `closedAt`, `editDeadline`, `paymentCaptureEnabled` |
| **Edit window changed** | Revize publishes a change to the window | `changeType` (`reopened`, `extended`, `shortened`, `until_fulfillment`), `editDeadline`, `previousDeadline`, `source` (`staff`, `merchant`, `flow`, `automatic`), `reason` |
| **Payment captured** | Revize captures payment and confirms the order is paid | `capturedAmount`, `currencyCode`, `capturedAt` |
| **Payment capture failed** | A capture attempt fails | `reason` (`capture_declined`, `authorization_expired`, `outcome_unknown`, `retries_exhausted`), `remainingAmount`, `attemptNumber`, `willRetry` |
| **Unpaid edits reversed** | Revize reverses unpaid edits, or the reversal fails | `outcome` (`reversed`, `failed`), `refundPending`, `remainingBalance` |

> [!NOTE]
>
> **Edit window closing soon** runs at the reminder times you choose in Revize under **Settings → General → Reminder before editing closes** (up to 3 times, Pro). Each time runs once per order, and again if the deadline moves.

## Actions

| Action | What it does |
| - | - |
| **Close editing now** | Closes editing on the order and runs the normal payment and fulfillment checks. Optional **Reason**, shown in the edit window history. |
| **Extend editing** | Adds **Hours** (a whole number from 1 to 4319) to an open window that has a set deadline. |
| **Reopen editing** | Opens editing for the requested **Hours** when the order is eligible. |
| **Keep editing open until fulfillment** | Keeps editing open until the order is fulfilled, when the order is eligible. |
| **Refund outstanding balance** | Refunds what the customer overpaid, for example after an edit lowered the total. |
| **Refund outstanding balance and report the result** | The same refund, but waits for it to finish and returns the result to your workflow. |

> [!NOTE]
>
> **Reopen editing skips orders it shouldn't touch:** orders that are already fulfilled or partially fulfilled, already released to fulfillment or carrying the release tag, cancelled, restricted by tags, or with a payment change still pending. Refunds follow your [refund setting](https://docs.revize.app/setup/payments-and-refunds.md#refund-options): **Original payment method** or **Store credit**. If nothing is owed, or refunds are set to **No refunds**, nothing is refunded.

## Tags Revize writes

Use these as conditions in Flow, in your 3PL, or in reports.

| Tag | Added when |
| - | - |
| `revize:order_released` (or your custom release tag) | Editing closes, if **Add release tag** is on |
| `revize:upsell` | An edit raised the order value |
| `revize:upsell_offer` | A customer accepted an upsell offer |
| `revize:order_downgraded` | An edit lowered the order value |
| `revize:reverse_unpaid` | Revize reversed unpaid edits |
| `revize:order_cancelled` | The order was cancelled through Revize |
| `revize:withdrawal_requested` | A customer submitted an [EU withdrawal](https://docs.revize.app/features/eu-withdrawal.md) request |

The [rules engine](https://docs.revize.app/setup/rules-engine.md) (Pro) can also add your own tags when an order's editing deadline closes, with its **Tag orders** action.

## Example workflows

> [accordion] Close editing when the warehouse starts picking
>
> **Trigger:** your WMS's own Flow trigger, or Shopify's **Order tags added** when the WMS writes a tag like `picked`.
>
> **Action:** Revize **Close editing now**, with reason `Picking started`.
>
> The customer can't change an order your team is already packing. The tag-only alternative is to add the same tag under **Settings → Order editing → Editing restrictions → Order tags** in Revize. See [3PL and warehouse holds](https://docs.revize.app/guides/3pl-warehouse-holds.md).

> [accordion] Remind customers before editing closes
>
> **Trigger:** **Edit window closing soon**.
>
> **Condition (optional):** `hoursBeforeClose` equals the reminder you want, if you set more than one.
>
> **Action:** send an email or SMS from your email app with `editDeadlineDisplay` and the `orderStatusUrl` link, so the customer can still fix a size or address. For Klaviyo, see the [Klaviyo guide](https://docs.revize.app/integrations/klaviyo.md).

> [accordion] Alert the team when an edited order has a new address
>
> **Trigger:** **Shipping address updated**.
>
> **Action:** add an order tag such as `address-changed`, or post to Slack, so the team double-checks orders that were already printed.

> [accordion] Follow up when a payment capture fails
>
> **Trigger:** **Payment capture failed**.
>
> **Condition:** `willRetry` is false.
>
> **Action:** tag the order `capture-failed` and notify your finance inbox. Revize also emails you when it stops retrying.

## Good to know

* **Triggers send each event once** after the change completes. Build workflows that are safe if an event is missed, for example by also checking tags.
* **Late tags still count.** Revize waits up to a minute after checkout for Flow to write tags or metafields before it picks an editing rule, so Flow tags set at checkout can drive [rules](https://docs.revize.app/setup/rules-engine.md).
* **Tag spelling matters.** Tag matching ignores letter case, not spelling: a tag written by Flow must be spelled exactly like the tag in Revize.

## Related

* [Tech stack](https://docs.revize.app/integrations/index.md): 3PLs, ERPs and integration platforms
* [Klaviyo](https://docs.revize.app/integrations/klaviyo.md): send emails from Revize triggers
* [Rules engine](https://docs.revize.app/setup/rules-engine.md): per-order deadlines, holds and tags
* [3PL and warehouse holds](https://docs.revize.app/guides/3pl-warehouse-holds.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.