VibeFox EasyPost for PrestaShop — ヘルプ
要件
PrestaShop:8.0 から 9.x。
PHP:cURL 拡張機能を備えた 8.0 以降。これらがない場合、モジュールはインストールされません。
EasyPost アカウント(リアルタイム送料を使う場合のみ必要):EasyPost の Web サイトでアカウントを作成し、EasyPost のダッシュボードで配送業者アカウント(USPS、UPS、FedEx など)を接続して、EasyPost Dashboard > Account Settings > API Keys から API キーをコピーします。EasyPost の料金は購入したラベルに対して発生し、送料の照会に対しては発生しません。予備価格のみを使用する場合、EasyPost アカウントは不要です。
商品:商品には重量が必要で、できれば寸法も設定してください。
VibeFox ライセンスキー:vibefox.net で購入します。1 つのキーは 1 つのドメインでのみ使用できます。
インストール
1. 管理画面で Modules > Module Manager に進み、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。
2. アップロードが完了したら Configure をクリックします。後で行う場合は、モジュール一覧で VibeFox EasyPost を探して Configure をクリックします。
3. Configure ページ上部のライセンスブロックにある License key 欄に VibeFox ライセンスキーを入力し、Activate をクリックします(ライセンスキーを参照)。
4. EasyPost の API キーを貼り付け、Ship from の住所を入力します。リアルタイム送料には郵便番号が必要です。
5. デフォルト通貨が USD でない場合は、USD exchange rate を入力します。必要に応じて予備価格も入力します(設定を参照)。Save をクリックします。
インストール時、モジュールは配送日数のテキストが Live carrier rate (EasyPost) の配送業者 EasyPost Shipping を作成します。この配送業者は、すべてのゾーンとすべての顧客グループに割り当てられます。ゾーン、顧客グループ、配送日数、ロゴ、サイズ制限は Shipping > Carriers で変更できます。価格はここでは設定しないでください。価格は常にモジュールから取得されます。
設定
すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox EasyPost > Configure。各セクションには独自の Save ボタンがあり、ページ全体を保存します。保存のたびに、キャッシュされた EasyPost の送料も消去されます。
ページ上部には、リアルタイム送料を使用できない場合に警告が表示されます。API キーがない(予備価格の有無を問わず)、出荷元の郵便番号または国がない、またはデフォルト通貨が USD 以外で為替レートがない場合です。テスト用 API キーが設定されている場合は注意が、モジュールの配送業者が削除された場合はエラーが、ショップの重量または寸法の単位(International > Localization)がモジュールで対応していない単位の場合(kg、g、lb、oz、cm、mm、m、in 以外)は警告が表示されます。
保存時、数値でない値(または負の値)は保存されません。警告でフィールド名が示され、以前の値が保持されます。USD exchange rate が 0 の場合、または Minimum weight が Maximum weight より大きい場合も同様です。
全般
Enable EasyPost shipping: 配送業者を有効または無効にします。Shipping > Carriers の配送業者のステータスと同じスイッチです。デフォルト:on。
Name: チェックアウト時に購入者に表示される配送業者名です。最大 64 文字です(これより長い名前は拒否され、何も保存されません)。デフォルト:EasyPost Shipping。名前が空の場合、または PrestaShop が配送業者名で許可していない文字を含む場合は、デフォルト名が使用されます。
EasyPost アカウント
API key: EasyPost Dashboard > Account Settings > API Keys から取得した EasyPost の API キーです。本番用キー(EZAK で始まる)は実際の送料を返します。テスト用キー(EZTK で始まる)は EasyPost のテスト送料を返すため、テスト目的でのみ使用してください。保存後、このフィールドは空になり、保存済みのキーがマスクされて表示されます(例:EZAK******abcd)。キーを保持する場合は空のままにします。変更する場合にのみ新しい値を入力してください。
Remove the saved API key: このチェックボックスをオンにして Save をクリックすると、保存済みの API キーが削除されます。
Allowed carriers / services: 任意です。カンマで区切って入力します。EasyPost の名称どおりに、配送業者(USPS)または配送業者とサービス(USPS:Priority、UPS:Ground)を入力します。許可された中で最も安い送料が表示されます。空欄にすると、どの配送業者の中でも最も安い送料が表示されます。
出荷元
荷物の発送元の住所です。Country がショップの所在国の場合、空欄のフィールドは Shop Parameters > Contact > Stores のショップ住所から補完されます(差出人名はショップ名から取得されます)。
Sender name / company: 差出人の名前または会社名です。
Street address: 出荷元住所の番地です。
City: 出荷元住所の市区町村です。
State: 2 文字の州コードです(例:CA、NY)。
ZIP code: 出荷元の郵便番号です。リアルタイム送料には必須です。
Country: 出荷元の国です。デフォルト:United States。
送料
Parcels: カートを EasyPost にどのように送信するかを指定します。
重量はショップの単位からオンス(最小 1 oz)に、寸法はインチに変換されます。寸法が未設定の商品がある場合、その荷物は重量のみで計算されます。
USD exchange rate: EasyPost の送料は USD で提供されます。デフォルト通貨で 1 USD の価格を入力します(例:0.92)。これを設定しないと、リアルタイム送料は使用されず、予備価格のみが使用されます。デフォルト通貨が USD の場合は不要です。USD と CAD のショップでは、EasyPost に自国通貨での見積もりを依頼します。小数点区切りとして、ピリオドとカンマのどちらも使用できます。
Tax: 配送業者の税ルール、または No tax です。EasyPost の送料には消費税は含まれません。配送に適用する税ルールを選択してください。
予備価格
リアルタイム送料がない場合に使用されます。API キーがない、EasyPost に接続できない、キーが拒否された、またはどの配送業者もその住所の送料を提供していない場合です。価格はデフォルト通貨で、税抜きです。この場合に配送業者を非表示にするには、両方のフィールドを空欄にします。
Country prices: 国ごとに 1 行です。2 文字の国コード、コロン、価格の順に入力します(例:US:9.99)。別の形式の行は無視され、保存時に警告で一覧表示されます。
Other countries: 上のリストにない国の価格です。空欄にすると、それらの国では配送業者が非表示になります。
条件
Free shipping from: 送料が無料になるカート小計です(配送対象商品、割引適用後、税抜き、デフォルト通貨)。この条件を満たす場合、EasyPost へのリクエストは行われません。空欄にすると無効になります。
Minimum subtotal: カート小計(配送対象商品、割引適用後、税抜き)がこの金額以上の場合にのみ配送業者を表示します。空欄にすると常に表示されます。
Minimum weight: カートの重量がこの値未満の場合、配送業者を非表示にします。単位はショップの重量単位です(フィールドのラベルに表示されます)。0 は制限なしを意味します。
Maximum weight: カートの重量がこの値を超える場合、配送業者を非表示にします。単位はショップの重量単位です。0 は制限なしを意味します。
配送ゾーンを使わない場合の利用可否
通常、配送業者は Shipping > Carriers で割り当てられたゾーンに対して提供されます。または、ゾーンに関係なく国単位で提供することもできます。
Ignore shipping zones: 下に指定した国に対して、その国のゾーンが配送業者に割り当てられているかどうかに関係なく、配送業者を提供します。このオプションをオンにして保存すると、配送業者は後から作成されたゾーンを含むすべてのゾーンに割り当てられます。オフにすると、配送業者は以前のゾーンを取り戻します。
Countries: このモードの配送先の国です。Ctrl+クリックで複数選択できます。空欄にすると、ショップで有効なすべての国が使用されます。このフィールドは Ignore shipping zones がオンの場合にのみ使用されます。
詳細設定
Debug log: EasyPost へのリクエストを modules/vfd_easypost/logs/vfd_ep.log.php に書き込みます。このファイルは Web から開くことができず、5 MB に達するとローテーションされます。このオプションがオフでも、API エラーは常に記録されます。API キーと購入者の住所は記録されません。
Remove data on uninstall: オンにすると、モジュールをアンインストールしたときに、その設定、テーブル、ログが削除されます。モジュールを無効にしても設定は削除されません。
Log: 設定の下にあるパネルに、ログの最新 100 行が表示されます。Clear log をクリックすると空になります。
チェックアウト時の動作
配送の段階で、PrestaShop はモジュールに EasyPost の価格を問い合わせます。対象となるのは実物の商品のみです。仮想商品は重量に加算されず、小計にも含まれません。モジュールはまず条件を確認します:配送先の国(Ignore shipping zones を使用する場合)、カートの重量、最低小計です。送料無料が適用される場合、価格は 0 となり、EasyPost へのリクエストは送信されません。
それ以外の場合、モジュールは出荷元住所、配送先住所、荷物を EasyPost に送信し、お使いのすべての配送業者アカウントの送料を受け取ります。許可された中で最も安い送料を選び、デフォルト通貨に換算して、購入者のカートの通貨で表示します。郵便番号が必要な国では、配送先住所に郵便番号がある場合にのみリクエストが送信されます。購入者が住所を入力する前は、訪問者の国しかわからないため、郵便番号が必要な国では住所が入力されるまで予備価格が適用されます。
同じ住所と荷物の場合、各応答は 1 時間キャッシュされます。使用可能な送料がなかった住所は 10 分間記憶されます。タイムアウト、キーの拒否、レート制限、EasyPost のサーバーエラーの後は、5 分間リクエストが行われません。API のタイムアウトは 10 秒です。これらすべての場合、購入者にエラーは表示されません。予備価格が使用されるか、予備価格がない場合は配送業者が非表示になります。理由はログに記録されます。
配送業者に注文が入った後に Shipping > Carriers で配送業者を編集すると、PrestaShop はそれを新しい配送業者のバージョンとして保存します。モジュールは新しいバージョンに自動的に従います。
モジュールは送料の計算のみを行います。ラベルの購入、荷物の追跡、住所の検証、集荷・受け取り拠点の提供、保険や受取サインのオプションの追加は行いません。表示するのは 1 つの選択肢(許可された中で最も安い送料)のみで、サービスの一覧は表示しません。商品を 1 つの荷物にまとめる以外の箱詰めは行わず、送料の上乗せや手数料も設定しません。
注文
EasyPost の配送業者で注文が行われると、チェックアウト時に表示された送料が注文とともに保存されます。管理画面の注文ページには EasyPost shipping ブロックが表示されます:
Carrier / service: 送料の EasyPost 配送業者とサービスです(例:USPS Priority)。商品ごとに 1 つの荷物のモードでは、使用されたすべてのサービスが一覧表示されます。
Estimated delivery days: EasyPost が返す配送日数です(注文ごとに 1 つの荷物のモードで、EasyPost が返す場合にのみ表示されます)。
Price source: Live EasyPost rate、Fallback price (no live rate)、または Free shipping threshold です。
Calculated price (excl. tax): デフォルト通貨での価格です。
管理画面でカートを後から変更しても、これらの値は変わりません。これらの情報を使って、EasyPost アカウントでラベルを購入してください。放棄されたカートの送料は 30 日後に削除されます。
ライセンスキー
このモジュールは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox EasyPost は、Modules > Module Manager > VibeFox EasyPost > Configure の最初のブロックで、設定の上にあります。キーを License key に入力し、Activate をクリックしてください。その後、ブロックにはキーがマスク表示され、ステータス(ライセンスの有効期限日やドメインなど)が表示されます。また、ステータスを再確認する Check now、別のキーを入力する Change key、このショップからキーを削除する Remove key のボタンが表示されます。その下には、行 Product: presta-shipping-easypost と、vibefox.net のアカウントを開くリンク Manage licenses and domains in your account があります。キーを変更できるのは、モジュールの Configure 権限を持つ従業員のみです。ブロックのテキストは管理画面の言語に従います(英語とロシア語が含まれます)。
キーが受け付けられない場合、ブロックにその理由が表示されます(例: Key not found、This key belongs to another product、Domain limit reached、License expired on と日付)。ショップの住所を変更した後、またはアカウントでドメイン枠を解放した後は、Check now をクリックしてください。ライセンスサーバーに接続できない場合、モジュールは最後に確認できたステータスで動作を続けます。
1 つのキーは 1 つのドメインで機能します。メインショップのドメインで、マルチストア構成でも同様です。ショップからキーを削除しても、ドメイン枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、EasyPost 配送業者はチェックアウトで顧客に表示されず、料金も計算されません。PrestaShop のストアフロントは、バックオフィスにログインしていることを認識しないため、配送業者はあなたに対しても非表示になります。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。
ライセンスの有効期限が切れてもモジュールは動作を続けますが、アップデートとサポートには更新が必要です。バックオフィスで作業している間、ステータスは自動的に再確認されます。キー入力後の最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは必ず削除されます。
トラブルシューティング
チェックアウトに EasyPost が表示されない:ライセンスが有効であること、Enable EasyPost shipping がオンであることを確認してください。Shipping > Carriers で、配送業者が有効であり、購入者の国のゾーンと購入者のグループをカバーしていることを確認してください(または、Ignore shipping zones がオンで、その国が選択されていることを確認してください)。重量の制限と Minimum subtotal も確認してください。リアルタイム送料がない場合、配送業者にはその国または Other countries 向けの予備価格が必要です。また、商品ページで商品を特定の配送業者に限定している場合もあります。
リアルタイム送料が表示されない:モジュールのページ上部の警告を確認し、Debug log をオンにして、チェックアウトを再読み込みし、Log パネルを確認してください。よくある原因:API キーまたは出荷元の郵便番号がない、USD 以外のショップで USD exchange rate が設定されていない、配送先住所にまだ郵便番号がない、EasyPost アカウントのどの配送業者もその住所に対応していない、または Allowed carriers / services によってすべての送料が除外されている。
送料がテスト価格のように見える:テスト用キー(EZTK...)が設定されています。実際のショップでは本番用キー(EZAK...)を使用してください。
送料の取得が数分間停止した:タイムアウト、キーの拒否、EasyPost のサーバーエラーの後、モジュールは 5 分間リクエストを停止し、予備価格を使用します。API キーとログを確認してください。
税は含まれていますか?EasyPost の送料には消費税は含まれません。Tax で税ルールを選択すると、送料に税が加算されます。
変更後に送料が古いように見える:モジュールのページで Save をクリックしてください。キャッシュされた EasyPost の送料が消去されます。
ページに「モジュールの配送業者が見つかりません」と表示される:配送業者は Shipping > Carriers で削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。
開発者向けフック:フック actionVfdEpShipmentRequest(リクエスト本文)、actionVfdEpSelectedRate(選択された送料)、actionVfdEpApiUrl(API のベース URL)で、モジュールを調整できます。
アンインストール
Modules > Module Manager に進み、VibeFox EasyPost の横にあるメニューを開いて、Uninstall を選択します。ライセンスキーとライセンスステータスは常に削除されます。配送業者はチェックアウトから削除されます(注文の履歴は保持されます)。キャッシュされた送料は常に削除されます。Remove data on uninstall がオンの場合、設定、保存された注文の送料、ログも削除されます。オフの場合、設定と配置済み注文の EasyPost データは、再インストールのために保持されます。モジュールをインストールまたはリセットすると、新しい配送業者が作成されます。設定が保持されていた場合、新しい配送業者は前の配送業者のステータス(有効または無効)を引き継ぎます。
EasyPost は、その所有者の商標です。本モジュールは EasyPost と提携しておらず、EasyPost の承認も受けていません。
