Shopifyのカスタマイズ – 送料のカスタマイズ方法その1 Webhookによる送料計算

2024.09.07.土

井上飛鳥

Engineer

今回、送料計算のカスタマイズについて2回に分けて紹介します。

クライアント要望
- 対応したこと
送料計算の基本仕様
送料計算を別精算とする
- 流れ
事前準備
- 1. Webhook用のプログラムを作成します。
- 2. Webhookで「注文作成」イベントを作成する
購入

クライアント要望

送料計算を独自の計算にしたい

対応したこと

Webhook用のプログラムを作成
Webhookで「注文作成」イベントを作成する

送料計算の基本仕様

shopifyで可能な送料計算の仕様は以下の通りです。

1. 重量に基づく送料

商品の重量を基に送料を設定する方法です。これは最も一般的な方法で、商品が重くなるにつれて送料も増加します。

2.価格に基づく送料

注文金額に応じて送料を設定することができます。例えば、注文金額が一定額を超えた場合に無料で配送する設定も可能です。

3.距離に基づく送料（配送先の場所）

特定の配送エリアごとに異なる送料を設定することも可能です。

4.商品数に基づく送料

商品の数量に基づいて送料を設定することも可能です。

これ以外に送料計算をカスタマイズする場合、Shopifyの「Commerce Components by Shopify」（CCS）を有効にする必要があります。
基本、CCSはアドバンスドプラン以上に申し込めば利用が可能になります。

送料計算が基本仕様に合わず、CCSも有効にできない場合はやむなく別の方法をとる必要があります。
※CCSを有効にした、送料計算のカスタマイズは後日別記事で紹介します

送料計算を別精算とする

この方法はスマートではありませんが、一案として初回精算後に送料を計算し、手動で送料を精算する方法として紹介します。

流れ

お客様が注文
決済が完了
Webhookが注文内容を受け取り、送料を計算。
計算した送料を注文のメモに書き込み
店舗オーナーが注文メモを見て送料を管理画面から請求

事前準備

1. Webhook用のプログラムを作成します。

自前のサーバーを用意しPHPのLaravelでWebhook用のプログラムを用意します。


<?php
namespace App\Http\Controllers;

use Illuminate\Support\Facades\Config;
use Illuminate\Http\Request;
use GuzzleHttp\Client;
use Illuminate\Support\Facades\Log;

class ShopifyWebhookOrderShippingController extends Controller
{
    protected $client;
    protected $shopName;
    protected $accessToken;

    public function __construct(Request $request)
    {
        $this->client = new Client();

        // 本番環境の設定を使用
        $this->shopName = config('shopify.shop_name');
        $this->accessToken = config('shopify.access_token');
    }

    public function handleWebhook(Request $request)
    {
        $data = $request->all();
        Log::info('Webhook received data:', $data);

        // 配送先住所から都道府県を取得
        $province_code = $data['shipping_address']['province_code'];

        // カートのアイテム情報を取得
        $items = $data['line_items'];

        foreach ($items as &$item) {
            $product_id = $item['product_id'];
            $item['properties'] = $this->getProductProperties($product_id);
            Log::info("Product ID: {$product_id} Properties:", $item['properties']);
        }

        // 送料計算
        $shipping_data = $this->calculateShippingCost($province_code, $items, array_column($items, 'properties'));

        // 計算された送料を注文に反映（注文の更新）
        $this->updateOrderShippingCost($data['id'], $shipping_data);
    }

    protected function getProductProperties($product_id)
    {
        $url = "https://{$this->shopName}/admin/api/2023-07/products/{$product_id}/metafields.json";

        try {
            $response = $this->client->get($url, [
                'headers' => [
                    'X-Shopify-Access-Token' => $this->accessToken,
                    'Content-Type' => 'application/json',
                ]
            ]);

            if ($response->getStatusCode() == 200) {
                $metafields = json_decode($response->getBody()->getContents(), true);
                foreach ($metafields['metafields'] as $metafield) {
                    if ($metafield['key'] == 'properties') {
                        return json_decode($metafield['value'], true);
                    }
                }
            } else {
                Log::error("Failed to retrieve product properties for product ID: {$product_id}. Response: " . $response->getBody()->getContents());
            }
        } catch (\Exception $e) {
            Log::error("Exception occurred while retrieving product properties: " . $e->getMessage());
        }

        return [];
    }

    protected function calculateShippingCost($province_code, $items, $properties)
    {
        // 省略（送料計算のロジック）
    }

    protected function updateOrderShippingCost($order_id, $shipping_data)
    {
        $url = "https://{$this->shopName}/admin/api/2023-07/orders/{$order_id}.json";
        
        $note_message = "";

        if (is_string($shipping_data)) {
            $note_message = $shipping_data;
        } else {
            $total_cost = $shipping_data['total_cost'];
            $note_message .= "送料：¥".number_format($total_cost)."\n※後から請求してください";
        }

        $data = [
            'order' => [
                'note' => $note_message
            ]
        ];

        try {
            $response = $this->client->put($url, [
                'headers' => [
                    'X-Shopify-Access-Token' => $this->accessToken,
                    'Content-Type' => 'application/json',
                ],
                'json' => $data
            ]);

            if ($response->getStatusCode() == 200) {
                Log::info("Shipping cost updated successfully for order ID: {$order_id}");
            } else {
                Log::error("Failed to update shipping cost for order ID: {$order_id}. Response: " . $response->getBody()->getContents());
            }
        } catch (\Exception $e) {
            Log::error("Exception occurred while updating shipping cost: " . $e->getMessage());
        }
    }
}