VibeFox Canada Post for WooCommerce — ヘルプ
要件
WordPress: 5.8 以降。
WooCommerce: 5.0 以降、インストールされ有効化されていること。WooCommerce がないとプラグインは有効化できません。
PHP: 8.0 以降。
Canada Post Developer Program(リアルタイム運賃のみ): リアルタイム運賃は Canada Post Rating API を使用します。Canada Post のウェブサイトで Canada Post Developer Program に参加し、API キーと顧客番号をコピーしてください。API キーは username:password の形式で、Canada Post は開発(サンドボックス)環境と本番環境で別々のキーを発行します。発送元のカナダの郵便番号も必要です。固定料金のみを使用する場合、API キーは不要です。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. WordPress で Plugins > Add New > Upload Plugin に移動し、プラグインの ZIP ファイルを選んで Install Now をクリックします。FTP で vfd_canada_post フォルダを /wp-content/plugins/ にアップロードすることもできます。
2. Activate をクリックします。
3. 設定を開きます: WooCommerce > Settings > Shipping > VibeFox Canada Post。または、プラグインの一覧ページでプラグイン名の下にある Settings をクリックします。
4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。
5. リアルタイム運賃を使う場合は、API のユーザー名とパスワード、顧客番号、発送元の郵便番号を入力します。ストアの通貨が CAD でない場合は、CAD のレートを入力します。固定料金やフォールバック料金が必要な場合は Country prices に入力します(設定を参照)。
6. WooCommerce > Settings > Shipping > Shipping zones で、配送ゾーンに VibeFox Canada Post を追加します。または Ignore shipping zones を有効にして国を選択します。
設定
すべての設定は 1 つのページにあります: WooCommerce > Settings > Shipping > VibeFox Canada Post。設定はすべての配送ゾーンに適用されます。配送ゾーンにこの方法を追加すると、ゾーンのウィンドウには次の項目だけが表示されます:
Title (zone): このゾーンで購入者に表示される名前。空欄にすると、全体の Method title が使われます。
設定を保存するたびに、キャッシュされた Canada Post の運賃は消去されます。設定が正しく機能しない場合、ページにはエラーも表示されます。API のユーザー名とパスワードのどちらか一方だけが入力されている、発送元の郵便番号がカナダの郵便番号ではない、ストアの通貨が CAD ではないのに CAD のレートがない、API キーも固定料金もない、などの場合です。
一般
Enable/Disable: すべてのゾーンでこの方法を一度に有効または無効にします。
Method title: カートとチェックアウトで表示される配送方法の名前。デフォルト: Canada Post。ゾーンごとに独自のタイトルを設定できます。
Tax status: Taxable は配送料に WooCommerce の税金を加算します。None は加算しません。
Canada Post API(リアルタイム運賃)
API のユーザー名とパスワードを入力すると、料金は Canada Post Rating API から取得されます。API が運賃を返さない場合(API が利用できない、郵便番号が誤っている、サービスが利用できないなど)は、Country prices の固定料金が使われます。固定料金がない場合は、この方法は非表示になります。
API username: API キーのコロンより前の部分。Sandbox がオンの場合は開発用のキーを、本番のストアでは本番用のキーを使用します。
API password: API キーのコロンより後ろの部分。ログには記録されません。
Customer number: 顧客番号を入力すると、Canada Post はお客様のアカウントの法人(割引)運賃を返します。通常(窓口)運賃を使う場合は空欄のままにします。
Contract number: 任意です。契約のあるお客様向けです。顧客番号と併せてのみ使用されます。
Sandbox: Canada Post の開発環境を使い、開発用の API キーでテストします。料金はテストデータです。本番のストアでは無効にしてください。
Ship-from postal code: 荷物を発送するカナダの郵便番号(例: K1A 0B1)。リアルタイム運賃に必要です。
Service in Canada: カナダの住所向けのサービス: Cheapest available、Regular Parcel(デフォルト)、Expedited Parcel、Xpresspost、Priority。
Service to the USA: Cheapest available(デフォルト)、Expedited Parcel USA、Tracked Packet USA、Small Packet USA Air、Xpresspost USA、Priority Worldwide parcel USA。
International service: Cheapest available(デフォルト)、International Parcel Surface、International Parcel Air、Tracked Packet International、Small Packet International Surface、Small Packet International Air、Xpresspost International、Priority Worldwide parcel International。
選択したサービスが住所または荷物に提供されていない場合は、利用可能な最も安いサービスが使われます。
Canadian sales taxes: GST/HST/PST を含まない Canada Post の料金を使用します。カナダの住所では、Canada Post の料金にこれらの税金が含まれます。WooCommerce が配送料に税金を加算する場合(Tax status = Taxable)にオンにすると、税金の二重課税を防げます。
CAD → store currency rate: フィールド名にはストアの通貨が表示されます。Canada Post の料金は CAD です。ストアの通貨が CAD でない場合は、CAD 1 単位がストアの通貨でいくらに相当するかを入力します(例: 0.68)。入力しないとリアルタイム運賃は使われません。ストアの通貨が CAD の場合は空欄にします。小数点とカンマのどちらも小数点区切りとして使えます。
Default product weight (kg): 重量が設定されていない商品ごとに Canada Post へ送られる重量。デフォルト: 0.5。商品の重量と寸法はストアの単位から換算され、カートは 1 個の荷物として計算されます。
固定料金(API の認証情報がない場合に使われ、API が運賃を返さない場合のフォールバックにもなります)
Country prices: 国の一覧で、Base の料金と、ストアの通貨によるカート重量ごとの料金を設定する表です。XS は 1 kg まで、S は 1~2 kg、M は 2~3 kg、L は 3~5 kg、XL は 5 kg 超。サイズの料金が空欄またはゼロの場合は Base の料金が使われます。Add country をクリックすると行が追加され、× をクリックすると行が削除されます。* Default (all other countries) の行は、独自の行を持たないすべての国の料金を設定します。行がない国(* にも該当しない国)には固定料金は設定されません。基本料金が 0 の場合、その国は送料無料になります。
Fixed price per: Order は料金を 1 回だけ請求します。Item (price × quantity) は、カート内の商品数を掛けた料金になります。これは固定料金にのみ適用されます。リアルタイム運賃は常に荷物全体について計算されます。
条件
Min cart weight (kg): カートの重量がこの値より低い場合、この方法を非表示にします。0 は制限なしを意味します。
Max cart weight (kg): カートの重量がこの値より高い場合、この方法を非表示にします。デフォルト: 25。0 は制限なしを意味します。Canada Post の荷物は最大 30 kg まで可能です。
Minimum order amount: カートの小計がこの金額に達した場合にのみ、この方法を表示します。空欄にすると常に表示されます。
Excluded shipping classes: カート内の商品のいずれかに、これらの WooCommerce 配送クラスが設定されている場合、この方法を非表示にします。
Free shipping: 下記の金額以上で送料無料を有効にします。
Free shipping from: 送料が無料になるカートの小計。この場合、API へのリクエストは行われません。
配送ゾーンを使わない場合の提供
Ignore shipping zones: 一致するゾーンに関係なく、下記の国に対してこの方法を提供します。
Countries: このモードでの仕向け先の国。空欄にすると、ストアが配送するすべての国が対象になります。このフィールドは Ignore shipping zones が有効な場合にのみ使われます。
詳細設定
Debug log: 運賃の計算を WooCommerce > Status > Logs に記録します。ソースは vfd-canada-post です。API エラーは、このオプションがオフでも常に記録されます。API キー、顧客番号、購入者の郵便番号は記録されません。
Remove data on uninstall: オンにすると、プラグインを削除したときに、その設定、ゾーンの方法、キャッシュされた運賃が削除されます。プラグインを無効化しても、何も削除されません。
チェックアウトでの動作
購入者が配送先住所を入力すると、WooCommerce はプラグインに運賃を要求します。プラグインはまず条件を確認します。カート重量、最低注文金額、除外される配送クラスです。送料無料が適用される場合、購入者は無料の運賃を受け取り、Canada Post へのリクエストは送信されません。
API キーを使用している場合、プラグインは発送元の郵便番号、仕向け先、荷物の重量、そしてすべての商品に寸法がある場合は推定される荷物のサイズを Canada Post に送信します。カナダ向けの仕向け先は郵便番号、米国向けは ZIP コード、その他の国向けは国のみです。リアルタイム運賃は、カナダまたは米国の住所に有効な郵便番号または ZIP コードがある場合にのみ要求されます。Canada Post は荷物に対して利用可能なすべてのサービスを返します。プラグインは、仕向け先グループで選択されたサービス、または最も安いサービスを選び、Canadian sales taxes が有効な場合はカナダの販売税を取り除き、CAD の料金をお客様のレートで換算します。サービス名は注文と一緒に保存され、管理画面の注文画面に Canada Post service として表示されます。
各応答は 1 時間キャッシュされるため、同じカートと住所で新しいリクエストが発生することはありません。失敗したリクエストは 10 分間キャッシュされるため、Canada Post の障害によってチェックアウトの更新が毎回遅くなることはありません。API のタイムアウトは 10 秒です。30 kg を超える荷物は API に送信されません。
API が運賃を返さない場合は固定料金が使われ、固定料金がない場合はこの方法が非表示になります。購入者に API のエラー詳細が表示されることはありません。これらは WooCommerce のログに記録されます。
この方法は、クラシックチェックアウト、およびカートとチェックアウトのブロックで動作します。WooCommerce の高パフォーマンス注文保存(HPOS)に対応しています。
プラグインが行うのは運賃の計算だけです。発送データの作成、ラベルの印刷、マニフェストや返品の作成、荷物の追跡は行いません。購入者は郵便局や受け取り場所を選べません。配達日、保険、署名のオプションを含まない、1 つの Canada Post 運賃を表示します。カートは常に 1 個の荷物として計算され、通貨レートは自動では更新されません。
ライセンスキー
本プラグインは、vibefox.net の VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Shipping > VibeFox Canada Post の上部にあります。キーを License key に貼り付けて、Activate をクリックしてください。ブロックには、ライセンスの有効期限日や、お客様のドメインなど、ステータスが表示されます。ステータスを再確認するには Check now、別のキーを入力するには Change key、このサイトからキーを削除するには Remove key を使用します。リンク Manage licenses and domains in your account を開くと、vibefox.net のアカウントが開きます。
1 つのキーは 1 つのドメインで使用できます。サイトからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、Canada Post はチェックアウトで購入者に表示されません。ログインしたストアの管理者には、(unlicensed — visible to admins only) と表示された状態で引き続き表示されるため、キーを購入する前にプラグインを設定してテストできます。プラグインのページと WooCommerce のページには通知が表示されます。既存の注文には影響しません。
ライセンスの有効期限が切れてもプラグインは動作し続けますが、アップデートとサポートには更新が必要です。ステータスはバックグラウンドで自動的に再確認されます。
トラブルシューティング
チェックアウトに Canada Post が表示されない: ライセンスが有効であること、Enable/Disable がオンであること、この方法が購入者の国のゾーンに追加されていること(または Ignore shipping zones がオンで、その国が許可されていること)を確認してください。重量の制限、Minimum order amount、Excluded shipping classes も確認してください。運賃が存在する必要があります。API キーを使う場合、住所には有効な郵便番号(カナダ)または ZIP コード(米国)が必要です。そうでなければ、その国または * に固定料金が設定されている必要があります。
リアルタイム運賃が表示されない: Debug log をオンにして、チェックアウトを再読み込みし、WooCommerce > Status > Logs を開いて、ソース vfd-canada-post を確認してください。理由が表示されます。API のユーザー名またはパスワードの不足、発送元または仕向け先の郵便番号が無効、CAD のレートがない、30 kg を超える荷物、または Canada Post のエラーメッセージのいずれかです。その間、固定料金がある場合は、購入者にはその料金が表示されます。
運賃が Canada Post のウェブサイトの料金と異なる: 顧客番号を入力すると、お客様のアカウントの法人(割引)運賃になります。入力しない場合は、通常(窓口)運賃になります。カナダの住所では、Canada Post の料金に GST/HST/PST が含まれます。料金はお客様の CAD レートで換算されます。
配送料に税金が二重にかかる: Canadian sales taxes をオンにするか、Tax status を None に設定してください。
本番のストアで料金をテストする: Sandbox をオフにして、本番用の API キーを使用してください。
変更後に運賃が古く見える: 設定ページを保存してください。これにより、キャッシュされた Canada Post の運賃が消去されます。
ライセンスブロックにエラーが表示される: ブロックのメッセージに従ってください。たとえば、そのキーが別のドメインで使用されている場合は、vibefox.net のアカウントで枠を解放し、Check now をクリックします。サイトのアドレスが変わった場合は、Check now をクリックして、新しいドメインでキーを有効化します。ライセンスサーバーに接続できない場合、プラグインは最後に確認できたステータスで動作を続けます。
アンインストール
プラグインを無効化しても、すべてのデータは保持されます。削除するには、無効化してから Plugins ページで削除してください。このプラグインのライセンスキーとライセンスステータスは、常に削除されます。設定、ゾーンの方法、キャッシュされた運賃は、Remove data on uninstall がオンになっている場合にのみ削除されます。そうでない場合は、後で再インストールするために残ります。注文が削除されることはありません。
Canada Post は、それぞれの所有者の商標です。本プラグインは Canada Post と提携しておらず、Canada Post による推奨もされていません。
