返品の更新
「返品の更新」トリガーは、ストア内の返品、その項目、またはリバースフルフィルメントされた注文の 1 つ以上のフィールドの値が変わると、ワークフローを開始します。返品の重要なフィールドを選択すると、返品のステータスの変更や返品手数料の追加など、選択したフィールドのいずれかに変更があった場合にのみ、ワークフローが実行されます。
返品が特定の段階に達したときにワークフローを開始するには、「返品のリクエスト」、「返品の承認」、「返品のクローズ」など、その段階に対応するトリガーを使用することもできます。
監視できるフィールド
「返品の更新」トリガーでは、監視するフィールドを少なくとも 1 つ選択する必要があります。フィールドは最大 5 つ選択できます。選択したフィールドのいずれかの値が変わると、ワークフローが実行されます。選択していないフィールドの値が変わっても、ワークフローは開始しません。
監視できるフィールドの詳細については、以下の表を確認してください。
| フィールドのタイプ | フィールド |
|---|---|
| 返品 | closedAt、decline、requestApprovedAt、status |
| 返品項目 | returnLineItems.quantity、returnLineItems.refundableQuantity、returnLineItems.refundedQuantity、returnLineItems.restockingFee、returnLineItems.restockingFee.amountSet、returnLineItems.restockingFee.amountSet.presentmentMoney、returnLineItems.restockingFee.amountSet.shopMoney、returnLineItems.restockingFee.percentage、returnLineItems.unprocessedQuantity |
| 交換項目 | exchangeLineItems |
| 返品配送手数料 | returnShippingFees、returnShippingFees.amountSet、returnShippingFees.amountSet.presentmentMoney、returnShippingFees.amountSet.shopMoney |
| リバースフルフィルメントされた注文 | reverseFulfillmentOrders、reverseFulfillmentOrders.lineItems、reverseFulfillmentOrders.status |
名前が amountSet で終わるフィールドは、2 種類の通貨での金額を保持しています。このフィールドを監視している場合、どちらかの金額が変わるとワークフローが開始します。一方の金額だけを監視するには、そのフィールド内の shopMoney フィールドでストアの通貨での金額を選択するか、presentmentMoney フィールドでお客様の通貨での金額を選択します。
一部のフィールドでは、返品にアイテムを追加した場合や、返品からアイテムを削除した場合にも、ワークフローが開始します。
- 「返品項目」グループ内のフィールドを監視している場合は、返品に項目を追加したり、返品から項目を削除したりすると、ワークフローが開始します。
returnLineItems.restockingFee.percentageなどの返品手数料フィールドを監視している場合は、項目に返品手数料を追加するか、項目から削除すると、ワークフローが起動します。exchangeLineItemsフィールドを監視している場合、返品に交換アイテムを追加するか、返品から交換アイテムを削除すると、ワークフローが開始します。- 「返品配送手数料」グループのフィールドを監視している場合、返品配送手数料を追加または削除すると、ワークフローが開始します。
- 「リバースフルフィルメントされた注文」グループのフィールドを監視している場合、返品にリバースフルフィルメントされた注文を追加すると、ワークフローが開始します。
reverseFulfillmentOrdersフィールドまたはreverseFulfillmentOrders.lineItemsフィールドを監視している場合は、リバースフルフィルメントされた注文から項目を削除したときにもワークフローが開始します。
ワークフローを開始するフィールドを選択
変更時にワークフローを開始するフィールドを選択します。
手順:
- ワークフローエディタで、「返品の更新時」トリガーをクリックします。
- 「返品フィールドを選択」セクションで、「フィールドを選択」をクリックします。
- 「監視するフィールドを追加」ダイアログで、監視するフィールドを検索するか、一覧から探して選択します。
- 任意:手順 2 と 3 を繰り返して、最大 5 つのフィールドを監視できます。
フィールド
「返品の更新」トリガーには、以下のフィールドが含まれています。これらのフィールドは、条件やアクションで使用でき、ワークフローでデータを取得する際にも利用できます。「返品」フィールドと「ストア」フィールドは常に利用できます。その他のフィールドは、関連するフィールドを監視している場合にのみ利用できます。たとえば、「リバースフルフィルメントされた注文」フィールドは、reverseFulfillmentOrders.status など、リバースフルフィルメントされた注文のフィールドを監視している場合に利用できます。
| フィールド | 説明 |
|---|---|
| 返品 | 更新後の返品です。 |
| ストア | 返品を更新したストアです。 |
| 返品項目 | 変更があった返品項目です。返品から項目を削除した場合は空になります。returnLineItems.quantity または返品手数料のフィールドを監視している場合に使用できます。 |
| 交換項目 | 追加した交換項目です。交換項目を削除した場合は空になります。exchangeLineItems フィールドを監視している場合に使用できます。 |
| リバースフルフィルメントされた注文 | 変更があったリバースフルフィルメントされた注文です。リバースフルフィルメントされた注文のフィールドを監視している場合に利用できます。 |
異なる種類のフィールドを監視する場合、ワークフローの実行時に「返品項目」、「交換項目」、「リバースフルフィルメントされた注文」の各フィールドが空になることがあります。たとえば、status と returnLineItems.quantity の両方を監視していて、ステータスだけが変わった場合、「返品項目」フィールドは空になります。「返品項目」フィールドと「交換項目」フィールドは、それぞれの種類のフィールドのみを監視している場合でも、空になることがあります。これらのフィールドをアクションで使用する前に、フィールドに値があることを確認する条件を追加してください。
「返品の更新」トリガーが提供するのは、返品とその項目の現在の値のみです。変更があったフィールドの変更前の値は、ワークフローでは利用できません。たとえば、status フィールドを監視している場合、返品の現在のステータスは条件やアクションで使用できますが、変更前のステータスは使用できません。
アクション
このトリガーは返品オブジェクトを提供するため、返品を必要とするすべてのアクションを使用できます。また、返品オブジェクトには注文が含まれているため、以下を含む、注文に関するすべてのアクションでこのトリガーを使用できます。
注文からお客様などの他のデータにアクセスできるため、お客様に関するアクションも利用できます。以下のアクションが含まれます。
注文には、項目などのデータのリストも含まれます。「各項目に対して実行」アクションを使用すると、これらのリストを順に処理し、各要素に対してアクションを実行できます。たとえば、項目を順に処理して、各商品にタグを追加できます。
「返品の更新」トリガーのテスト
このトリガーで開始するワークフローをテストするには、ワークフローを有効にしてから、管理画面で返品を開き、ワークフローが監視しているフィールドのいずれかを変更します。たとえば、返品を作成してから、返品を処理するか、返品をクローズします。
API の詳細
「返品の更新」トリガーでは、Return GraphQL API オブジェクトを使用してアクションを実行できます。このトリガーは、Shopify Events リファレンスのReturn トピックにある update アクションに対応しており、監視対象として選択したフィールドに絞り込んで動作します。