✅ チェックリスト

• [ ] 注文作成時のWebhookが登録されている
• [ ] 注文キャンセル時のWebhookが登録されている

概要

AnyGiftに注文情報を連携するために、注文作成時と注文キャンセル時にAnyGiftのシステムに webhookを登録いただきます。

手順

1. 設定を変更する > Webhook管理 > 受注Webhookテンプレートの管理 をクリック

   

2. 新規作成 をクリック

   

3. 下記の情報を入力し、保存する。（受注完了時のWebhookテンプレートを作成する。）

   • 名前

     • [AnyGift] 受注完了時のテンプレート

   • テンプレート

     <aside> ⚠️ storeId の部分は AnyReach へ連携に必要な情報を共有する で共有いただいた ストアIDと同じものを入力ください。ドメインなどと間違えないようご注意ください。正しく連携が行われません。

     </aside>

     {
        "type":"OrderCreated",
        "payload":{
           "id":"{{ order.id }}",
           "number":"{{ order.number }}",
           "storeId":"**編集ください**",
           "orderItems": [
             {% for item in order.order_items %}
             {
               "id": {{ item.product.id }},
               "sku": "{{ item.variant.sku }}",
               "name": "{{ item.variant.name }}",
               "price": {{ item.price }},
               "quantity": {{ item.quantity }}
             }{% if forloop.last == false %},{% endif %}
             {% endfor %}
           ],
           "email":"{{ order.customer.email }}",
           "remark":"{{ order.remark }}",
           "completedAt":"{{ order.completed_at }}",
           "total":{{ order.total }},
           "shippingFee": {{ order.deliv_fee }},
           "paymentMethod": "{{ order.payment.payment_method.name }}",
        	  "lastName": "{{ order.billing_address.name01 }}",
           "firstName": "{{ order.billing_address.name02 }}",
           "zipCode1": "{{ order.billing_address.zip01 }}",
           "zipCode2": "{{ order.billing_address.zip02 }}",
           "prefecture": "{{ order.billing_address.prefecture_name }}",
           "address1": "{{ order.billing_address.addr01 }}",
           "address2": "{{ order.billing_address.addr02 }}",
           "address3": "{{ order.billing_address.addr03 }}",
           "tel1": "{{ order.billing_address.tel01 }}",
           "tel2": "{{ order.billing_address.tel02 }}",
           "tel3": "{{ order.billing_address.tel03 }}",
           "isEGift": {% if order.remark contains "message" and order.remark contains "senderName" %}true{% else %}false{% endif %}
        }
     }
     

4. 2. の画面に戻り、再度新規作成をクリック

5. 下記の情報を入力し、保存する。（受注キャンセル時のWebhookテンプレートを作成する。）

   • 名前

     • [AnyGift] 受注キャンセル時のテンプレート

   • テンプレート

     <aside> ⚠️ storeId の部分は AnyReach へ連携に必要な情報を共有する で共有いただいた ストアIDと同じものを入力ください。ドメインなどと間違えないようご注意ください。正しく連携が行われません。

     </aside>

     {
        "type":"OrderCanceled",
        "payload":{
           "id":"{{ order.id }}",
           "storeId":"**編集ください**",
           "isEGift": {% if order.remark contains "message" and order.remark contains "senderName" %}true{% else %}false{% endif %}
        }
     }
     

6. 1. のページ（設定を変更する > Webhook管理 ）に戻る

7. 受注 Webhook の管理 の横にある 設定する をクリック

8. 右上 新規作成 をクリック

9. 下記の情報を入力し、保存する。（受注完了時のWebhookを設定する。）

   URL	https://hooks.anygift.jp/ecforce/afterOrderCreated
   イベント名	order_complete
   ※ order_completed ではないので注意。
   テンプレート	[AnyGift] 受注完了時のテンプレート

10. 8. の画面に戻る

11. 下記の情報を入力し、保存する。（受注キャンセル時のWebhookを設定する。）

    URL	https://hooks.anygift.jp/ecforce/afterOrderCanceled
    イベント名	order_canceled
    テンプレート	[AnyGift] 受注キャンセル時のテンプレート