VibeFox ShipStation for PrestaShop — ヘルプ

要件

PrestaShop：8.0 から 9.x。

PHP：8.0 以降。古いバージョンの PHP ではモジュールをインストールできません。

ShipStation アカウント：ShipStation で配送業者を接続し（Settings > Shipping > Carriers）、ShipStation > Settings > Account > API Settings から API Key と API Secret をコピーしてください。API へのアクセスは ShipStation のプランによって異なります。このページが表示されない場合、お使いのプランには API アクセスが含まれていません。本モジュールは ShipStation API V1（API Key と API Secret）を使用します。API キーが 1 つだけの ShipStation API V2 アカウントには対応していません。キーがない場合は、代替送料のみが使用されます。

VibeFox ライセンスキー：vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。

インストール

1. 管理画面で Modules > Module Manager に進み、Upload a module をクリックします。モジュールの ZIP ファイルを選択してください。

2. アップロードが完了したら Configure をクリックします。後で行う場合は、モジュール一覧から VibeFox ShipStation を見つけて Configure をクリックしてください。

3. VibeFox ライセンスキーを、Configure ページ上部のライセンスブロックにある License key に入力し、Activate をクリックします（ライセンスキーを参照）。

4. API Key と API Secret を貼り付け、発送元の郵便番号を入力して Save をクリックします。ページにアカウントの配送業者コードが表示されます。使用したいコードを Carrier codes に入力し、もう一度保存してください。

5. ショップのデフォルト通貨が ShipStation アカウントの通貨と異なる場合は、Exchange rate を設定してください。

6. 必要に応じて代替送料を入力します。

インストール時、モジュールは配送業者 ShipStation Shipping を作成します。配送日数のテキストは ShipStation carriers (USPS, UPS, FedEx, ...) です。配送業者はすべてのゾーンとすべての顧客グループに割り当てられます。ゾーン、顧客グループ、配送日数、ロゴ、サイズ制限は Shipping > Carriers で変更できます。ここでは価格を設定しないでください。価格は常にモジュールから取得されます。

設定

すべての設定はモジュールのページにあります：Modules > Module Manager > VibeFox ShipStation > Configure。各セクションにはそれぞれ Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた ShipStation の送料が消去され、API Key と API Secret が確認されます。その後、ページにはアカウントに接続された配送業者とそのコードが表示されます（例: "stamps_com (Stamps.com), ups_walleted (UPS by ShipStation)"）。

ページ上部の警告は、リアルタイムの送料が機能しない場合にお知らせします。キーがない、配送業者コードがない、発送元の郵便番号がない、為替レートがない、接続チェックに失敗した、またはアカウントに接続されていない配送業者コードがある、といった場合です。ショップの重量または寸法の単位がモジュールで換算できないものである場合も警告が表示されます。International > Localization（Local units）で、kg、g、lb、oz と、cm、mm、m、in を設定してください。負の値や数値ではないテキストが入った数値フィールド、または Maximum weight より大きい Minimum weight は、エラーとして通知され、何も保存されません。

一般

Enable ShipStation shipping：配送業者を有効または無効にします。Shipping > Carriers の配送業者のステータスと同じスイッチです。

Name：チェックアウトで購入者に表示される配送業者の名前です。既定値：ShipStation Shipping。必須、最大 64 文字。

Tax：配送業者の税ルール、または No tax。ShipStation の送料には販売税は含まれません。No tax は見積もりどおりに表示します。税ルールを選ぶと、お使いの税ルールに従って送料に税金が加算されます。

ShipStation アカウント

API Key：ShipStation > Settings > Account > API Settings にある API Key です。ShipStation にのみ送信され、ログには記録されません。保存後、このフィールドは空になり、Saved — leave empty to keep it. と表示されます。変更する場合のみ新しい値を入力してください。

API Secret：同じページにある API Secret です。キーと同様に扱われます。

Remove the saved API key and secret：キーが保存されると表示されます。チェックを入れて保存すると、両方が削除されます。

Carrier codes：ShipStation の配送業者コードを 1 つ以上、カンマ区切りで入力します（例: stamps_com, ups_walleted）。最大 5 件のコードが使用され、配送業者ごとに 1 回 API リクエストが行われます。5 件を超えて入力した場合は、最初の 5 件だけが保持され、ページに通知されます。これらの配送業者のうち最も安い送料が表示されます。コードは保存後に表示される一覧から入手してください。

Allowed services：任意。カンマ区切りの ShipStation サービスコードです（例: usps_priority_mail, ups_ground）。空欄のままにすると、上記の配送業者の中で最も安いサービスが表示されます。

Package code："package"（既定値）は、お使いの箱の料金を計算し、配送業者の封筒や定額料金の箱は対象から外します。空欄にすると、配送業者が提供するすべてのパッケージの種類が計算されます。

発送元

Ship-from postal code：リアルタイムの送料には必須です。ShipStation は郵便番号のみに基づいて送料を計算し、その郵便番号は ShipStation アカウントの国内になければなりません。空欄のままにすると、Shop Parameters > Contact > Stores にあるショップの郵便番号が使用されます。

送料

Parcels：カートを ShipStation にどのように送信するかを指定します。

ShipStation account currency：ShipStation が送料を返す通貨です。USD、CAD、GBP、AUD、NZD、EUR のいずれか。既定値：USD（米国のアカウント）。

Exchange rate：アカウント通貨 1 単位あたりのショップのデフォルト通貨での価格です（例: 0.92）。デフォルト通貨がアカウント通貨と異なる場合にのみ必要です。設定しない場合、リアルタイムの送料は使用されず、代替送料が適用されます。為替レートは自動では更新されません。

代替送料（リアルタイムの送料がない場合に使用されます：API キーがない、ShipStation に接続できない、住所に配送業者の送料がない場合。価格はショップのデフォルト通貨です。この場合に配送業者を非表示にするには、表と Other countries を空欄のままにしてください）

Prices by country：国ごとの基本料金と、荷物の重量に応じたサイズ列を持つ表です：XS ≤ 1 kg、S ≤ 2 kg、M ≤ 3 kg、L ≤ 5 kg、XL > 5 kg。Add country をクリックすると行が追加され、ごみ箱のアイコンをクリックすると行が削除されます。サイズが空欄の場合は基本料金が使用されます。基本料金が 0 の場合は送料無料になります。* Default (all other countries) の行は、独自の行がない国に適用されます。どの価格も入力されていない行は保存されません。

Other countries：表にその国の価格がない場合に使用される料金です。この場合に配送業者を非表示にするには、空欄のままにしてください。

条件

Free shipping from：送料が無料になるカートの小計（割引後、税抜き）です。その場合、ShipStation へのリクエストは行われません。空欄にすると無効になります。

Minimum subtotal：カートの小計（割引後、税抜き）がこの金額以上の場合にのみ配送業者を表示します。空欄にすると常に表示されます。

Minimum weight：配送業者を表示するためのカートの最小重量です（ショップの重量単位）。0 は制限なしを意味します。

Maximum weight：カートの重量がこの値を超えると、配送業者は非表示になります（ショップの重量単位）。0 は制限なしを意味します。

配送ゾーンを使わない場合の利用可否

通常、配送業者は Shipping > Carriers で設定されたゾーンで提供されます。代わりに、国ごとに提供することもできます。

Ignore shipping zones：下に指定した国について、ゾーンが割り当てられているかどうかに関係なく、その国に配送業者を提供します。有効にしている間は、後から作成されたゾーンを含むすべてのゾーンに配送業者が追加されます。無効にすると、追加されたゾーンは削除されます。

Countries：このモードの配送先の国です。空欄にすると、ショップの有効なすべての国が使用されます。このフィールドは Ignore shipping zones が有効な場合にのみ使用されます。

詳細設定

Debug log：ShipStation へのリクエストを、モジュールフォルダー内の logs/vfd_shst_debug.log.php に記録します。このファイルは Web から開くことはできません。API のエラーは、このオプションがオフでも常に記録されます。API Key、API Secret、顧客の住所は決して記録されません。郵便番号はマスクされます。

Log：ログのサイズと最新のエントリを表示します。Clear log をクリックすると空になります。

Remove data on uninstall：有効にすると、モジュールをアンインストールしたときに、設定、配送業者、ログ、および注文とともに保存された ShipStation のサービスが削除されます。無効にすると、再インストールできるようにすべてが保持されます。

チェックアウトでの動作

配送ステップで、PrestaShop はモジュールに価格を問い合わせます。対象になるのは実物の商品のみです。バーチャル商品は重量を加算せず、小計にも含まれません。モジュールはまず条件を確認します：許可された国（Ignore shipping zones を含む）、カートの重量、最小小計。送料無料の条件に該当する場合、配送業者は 0 の価格で表示され、ShipStation へのリクエストは送信されません。

その後、モジュールは発送元の郵便番号、配送先の国、都道府県、市区町村、郵便番号、荷物の重量、箱のサイズを ShipStation に送信します。お客様が郵便番号を入力するまで、リクエストは行われません。郵便番号のない国には代替送料が適用されます。商品は 1 つの箱にまとめられます。商品に寸法がない場合、荷物は重量のみで計算されます。

ShipStation へは配送業者コードごとに 1 回問い合わせが行われます。モジュールは、許可された中で最も安い送料を使用し、ショップのデフォルト通貨に換算します。その後、価格はお客様のカートの通貨で表示されます。

各応答は 1 時間キャッシュされます。ShipStation が使用可能な送料を返さずに応答した場合、その結果は 10 分間記憶されます。ShipStation がキーを拒否した場合、または接続できない場合、リクエストは 5 分間一時停止されます。レート制限の後は、ShipStation が示すリセット時刻まで一時停止されます。リクエストのタイムアウトは 12 秒です。モジュールを無効にすると、キャッシュされた送料は消去されます。

リアルタイムの送料がない場合、価格は代替送料の表から取得され、次に Other countries から取得されます。どちらも該当しない場合、配送業者は非表示になります。お客様に ShipStation のエラーメッセージが表示されることはありません。詳細はデバッグログに記録されます。

配送業者に注文が入った後で Shipping > Carriers で配送業者を編集すると、PrestaShop はそれを新しいバージョンの配送業者として保存します。モジュールは新しいバージョンに自動的に従います。

モジュールは送料の計算のみを行います。送り状ラベルの購入、ShipStation での注文や出荷の作成、荷物の追跡、返品の処理は行いません。受け取り場所はなく、チェックアウトで複数のサービスから選ぶこともできません。住所の検証、保険、サイン確認、複数の荷物への梱包、送料への上乗せもありません。

注文

ShipStation のリアルタイムの送料で注文が行われると、選択されたサービスが注文とともに保存されます。管理画面の注文ページでは、ShipStation ブロックに Service として表示されます（例: "USPS Ground Advantage - Package"）。これにより、ShipStation で対応する送り状ラベルを作成できます。その後のカートの再計算では変更されません。代替送料や送料無料で注文された場合、サービスのブロックは表示されません。

ライセンスキー

本モジュールは vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox ShipStation は、Modules > Module Manager > VibeFox ShipStation > Configure ページの、設定より上にある最初のブロックです。キーを License key に入力し、Activate をクリックしてください。その後、ブロックにはマスクされたキー、ステータス（ライセンスの有効期限日やお使いのドメインなど）、そして次のボタンが表示されます：ステータスを再確認する Check now、別のキーを入力する Change key、このショップからキーを削除する Remove key。その下には Product: presta-shipping-shipstation の行と、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 のアカウントで解放してください。

有効なキーがない場合、チェックアウトで ShipStation の配送業者は購入者に表示されず、送料も計算されません。PrestaShop のストアフロントは、管理画面にログインしていることを認識しないため、配送業者はあなたにも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブに通知が表示されます。既存の注文には影響しません。

ライセンスの期限が切れても、モジュールは動作を続けますが、アップデートとサポートには更新が必要です。管理画面で作業している間、ステータスは自動的に再確認されます。キーを入力してから最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスのステータスは常に削除されます。

トラブルシューティング

チェックアウトに ShipStation が表示されない：ライセンスが有効であること、Enable ShipStation shipping がオンであることを確認してください。Shipping > Carriers で、配送業者が購入者の国のゾーンと顧客グループを対象にしているかを確認するか、Ignore shipping zones をオンにして Countries を確認してください。重量制限と Minimum subtotal も確認してください。リアルタイムの送料がない場合は、その国、* Default、または Other countries に価格が設定されているかを確認してください。また、商品ページで商品が特定の配送業者に制限されている場合もあります。

ShipStation の送料ではなく代替送料が表示される：モジュールのページ上部の警告（キー、配送業者コード、発送元の郵便番号、為替レート）を確認してください。Debug log をオンにし、チェックアウトを再読み込みして、Log フィールドを確認してください。購入者の郵便番号が必要です。入力されるまでリクエストは行われません。

入力すべき配送業者コード：キーと secret を入力して設定を保存してください。ページにアカウントの配送業者コードが一覧表示されます。そのうち 1 つ以上を使用してください。

ShipStation の接続チェックに失敗した：メッセージに理由が表示されます。API Key と API Secret を確認し、再度保存してチェックを繰り返してください。

送料が ShipStation と異なる：荷物は商品の重量と寸法から作成され、商品は 1 つの箱にまとめられます。寸法のない商品は、重量のみで計算されます。送料は 1 時間キャッシュされます。キャッシュを消去するには、モジュールのページで Save をクリックしてください。

ShipStation の配送業者が見つからないと表示される：配送業者は Shipping > Carriers で削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。

アンインストール

Modules > Module Manager に進み、VibeFox ShipStation の横にあるメニューを開いて、Uninstall を選択してください。ライセンスキーとライセンスのステータスは常に削除されます。キャッシュされた送料と接続チェックの結果は、常に削除されます。Remove data on uninstall がオンの場合、配送業者は削除され（注文は履歴を保持します）、設定、ログ、注文とともに保存されたサービスも削除されます。オフの場合、配送業者は無効になるだけで、設定と注文済みのサービスは保持されます。モジュールを再インストールするか、リセットを行うと、配送業者は以前のステータスに戻ります。

ShipStation は、その所有者の商標です。本モジュールは ShipStation と提携しておらず、ShipStation による推奨も受けていません。