Return requested
The Return requested trigger starts a workflow when a return is requested by a customer using self-serve returns.
On this page
Data provided
The following data is provided to workflows that start with the Return requested trigger.
| Data | Description |
|---|---|
Return | The return resource related to the trigger. Allows accessing data on the GraphQL Admin API Return object |
Testing the trigger
Before you test the trigger, ensure that you've set up self-serve returns.
Steps:
- Create a test customer account for the store that you want to test.
- Place an order as the test customer.
- In the test customer's account, request a return.
Actions
This trigger provides a return object, so it lets you use any action that requires a return. In addition, because the return object includes an order, the trigger can be used with any order actions, including:
- Add order line item
- Add order tags
- Archive order
- Cancel order
- Capture payment
- Hold fulfillment order
- Mark order as paid
Orders allow you to access other data such as the customer, so it can be used with customer actions. These include:
Orders also contain lists of data such as line items. Using a For each action, you can loop through these lists and perform actions on each item. For example, you can loop through the line items and add a tag to each product.