VibeFox Aramex for OpenCart — ヘルプ

動作環境

OpenCart: 3.0.x（3.0.5.0 で検証済み）または 4.0.2 以降（4.1.0.3 で検証済み）。

PHP: 8.0 以降。

Aramex アカウント（リアルタイム料金のみ）: リアルタイム料金には Aramex Rate Calculator API を使用します。Aramex はアカウント保有者に API アクセスを提供しています。Aramex のアカウントマネージャーに問い合わせるか、Aramex のウェブサイトにある Aramex Developers Solution Center をご覧ください。必要な値は 6 つです：API ユーザー名（通常はメールアドレス）、パスワード、アカウント番号、アカウント PIN、アカウントのエンティティ（例：DXB）、アカウントの国コード（例：AE）。国ごとの固定料金のみを使用する場合、Aramex アカウントは不要です。

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

インストール

ダウンロードは、両方の OpenCart バージョン用のパッケージを含む 1 つの zip ファイルです。コンピューターで展開してください。README.txt、OpenCart 3 用のパッケージ vfd_aramex-oc3-(version).ocmod.zip、OpenCart 4 用のパッケージ vfd_aramex.ocmod.zip が含まれています。お使いの OpenCart のバージョンのパッケージのみをインストールしてください。ライセンスキーは両方のバージョンで同じです。

OpenCart 3

1. 管理画面で Extensions > Installer を開き、Upload をクリックして、ファイル vfd_aramex-oc3-(version).ocmod.zip を選択します。本拡張機能は OCMOD の変更を追加しないため、Extensions > Modifications を更新する必要はありません。インストーラーを使う代わりに、このパッケージの upload フォルダの内容をストアのルートフォルダにコピーすることもできます。

2. Extensions > Extensions に進み、拡張機能の種類で Shipping を選択します。VibeFox Aramex を見つけて、Install（緑色の + ボタン）をクリックします。

3. Edit（鉛筆のボタン）をクリックして設定ページを開きます。

4. Edit ページ上部のライセンスブロックの License key 欄に VibeFox ライセンスキーを貼り付け、Activate をクリックします（ライセンスキーを参照）。

5. 配送料の計算方法を選び、該当するセクションに入力し（設定を参照）、Enable Aramex をオンにして Save をクリックします。

OpenCart 4

1. 管理画面で Extensions > Installer を開き、Upload をクリックして、ファイル vfd_aramex.ocmod.zip を選択します。ファイル名は変更しないでください。OpenCart 4 は拡張機能のコードをファイル名から取得するため、名前を変更したパッケージは動作しません。

2. パッケージは、同じページのインストール済み拡張機能の一覧に表示されます。その横の Install（緑色の + ボタン）をクリックします。

3. Extensions > Extensions に進み、拡張機能の種類で Shipping を選択します。VibeFox Aramex を見つけて、Install（緑色の + ボタン）をクリックし、次に Edit（鉛筆ボタン）をクリックします。

4. OpenCart 3 の手順 4 と 5 と同じように、ライセンスキーと設定を入力します。設定ページとそのフィールドは両方のバージョンで同じです。

インストール直後は、Enable Aramex をオンにして保存するまで、この配送方法はオフのままです。アンインストール後に拡張機能を再インストールした場合、保持されていた Aramex の設定が再び使用されます。

設定

すべての設定は拡張機能のページにあります：Extensions > Extensions > Shipping > VibeFox Aramex > Edit。セクションは左側に一覧表示されます。ページ下部の 1 つの Save ボタンで、ページを再読み込みせずに全体を保存します。保存のたびに、キャッシュされた Aramex の料金もクリアされます。値が正しくない場合は何も保存されず、ページに理由が表示されます。例：Enter a method title (1 to 64 characters).、フィールドが数値である必要があることを示すメッセージ、または The account country code must have 2 letters, e.g. AE. 設定を保存できるのは、この拡張機能の変更権限を持つ管理者ユーザーのみです。

General

設定はすべてのジオゾーンに適用されます。Conditions で、このメソッドをジオゾーンと特定の国に限定できます。

Enable Aramex: チェックアウトで Aramex を表示または非表示にします。既定値：オフ。

Method title: カートとチェックアウトで購入者に表示される配送方法の名前。既定値：Aramex。必須。

Shipping cost: 料金の計算方法。

リアルタイム料金がない理由はデバッグログに記録されます。購入者に表示されることはありません。

Sort order: チェックアウトの配送方法の中での Aramex の並び順。整数で指定します。

Aramex API アカウント（リアルタイム料金にのみ必要。6 つのフィールドはすべて必須）

Username: Aramex API のユーザー名。通常はメールアドレスです。これを消去すると、保存されたパスワードも消去されます。

Password: Aramex API のパスワード。保存後、このフィールドは空になり Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。

Account number: Aramex 顧客アカウントの番号。これを消去すると、保存された PIN も消去されます。

Account PIN: Aramex アカウントの PIN。パスワードと同様に、保存後は再表示されません。

Account entity: アカウントの Aramex エンティティ（営業所）コード。例：DXB、AMM、RUH。

Account country code: Aramex アカウントの 2 文字の国コード。例：AE。

Aramex サービス（リアルタイム料金に使用）

配送先住所が発送元の国にある場合、出荷は Domestic として見積もられます。それ以外のすべての出荷は International express として見積もられます。

International service: 海外向けの Aramex 製品：PPX Priority Parcel Express（既定）、PDX Priority Document Express、PLX Priority Letter Express（0.5 kg 未満の書類）、DPX Value Express Parcels、EPX Economy Parcel Express、EDX Economy Document Express、GPX Ground Parcel Express、GDX Ground Document Express。

Domestic service: 発送元の国の中での出荷に使用される Aramex 製品：ONP Overnight (Parcel)（既定）、OND Overnight (Document)、SMP Same Day (Parcel)、SMD Same Day (Document)、SDD Same Day Delivery、EMD Early Morning Delivery、PEC Economy Delivery、PEX Road Express、HVY Heavy（20 kg 以上）。

Payment type: 出荷の Aramex への支払い者：Prepaid (shipper pays)（既定）、Collect (receiver pays)、または Third party。通常は Prepaid です。

API weight unit: Aramex に送信される単位：Kilograms (KG)（既定）または Pounds (LB)。商品の重量はその重量クラスから、寸法はその長さクラスから変換されます。請求重量は、実重量と容積重量（縦 × 横 × 高さ（cm）/ 5000）のいずれか大きい方です。最低は 0.5 kg で、重量のない商品にも適用されます。

Currency conversion rate: Aramex には、ストアの既定の通貨で見積もるよう依頼します。それでも別の通貨で回答された場合、料金にこの数値が乗算されます（Aramex 通貨 1 単位 = ストアの既定通貨 X 単位）。このような見積もりを拒否するには空欄のままにします。そうすれば、購入者が誤った通貨で請求されることはありません。

発送元（リアルタイム料金に使用）

Origin country: 発送元の国。最初の選択肢 Store country は、ストアの国を使用します。

Origin city: 発送元の都市。Aramex が必須としています。OpenCart のストア住所は自由記述のため、都市はそこから取得されません。ここに入力してください。

Origin state / emirate: 任意。

Origin postcode: 任意。

発送元の国がストアの国である場合、空欄の州は System > Settings > Store > Local にあるストアの地域から取得されます。

固定料金（Shipping cost が Fixed prices の場合、およびリアルタイム料金のフォールバックとして使用）

Price per country: ストアの既定の通貨（税抜）による、国と料金のリスト。Add country をクリックして行を追加し、× ボタンで行を削除します。独自の行がないすべての国に適用される料金には * All other countries を選択します。料金のない国（* の行がない場合）には固定料金が適用されないため、その国では配送方法が非表示になります。

Fixed price applies: Per order（既定）は料金を 1 回だけ請求します。Per item (price × quantity) は、カート内の商品数を掛けて請求します。Aramex のリアルタイム料金は常に出荷ごとです。

Conditions

Minimum weight (kg): カートの重量がこの値未満の場合、配送方法を非表示にします。0 は制限なし（既定）を意味します。

Maximum weight (kg): カートの重量がこの値を超える場合、配送方法を非表示にします。既定値：100。0 は制限なしを意味します。フィールドを空欄にすると 100 kg が使用されます。

Minimum order amount: 配送が必要な商品の小計（クーポン適用後、税抜）がこの金額に達した場合にのみ、配送方法を表示します。常に表示するには空欄のままにします。

Free shipping: 下記の金額以上の場合に Aramex の配送を無料にします。

Free shipping from: 配送が無料になる、配送が必要な商品の小計（クーポン適用後、税抜）。Free shipping がオンの場合にのみ使用されます。

Tax class: 配送料の税クラス、または No tax（既定）。Aramex のリアルタイム料金にはすでに付加価値税が含まれている場合があります。その場合は、配送料に税金が二重に課されないよう No tax を選択してください。

Geo zone: このジオゾーン内の住所にのみ Aramex を提供します。All zones（既定）は制限なしを意味します。ジオゾーンは System > Localisation > Geo Zones で管理します。

Countries: これらの配送先の国にのみ Aramex を提供します。すべての国を許可するには空欄のままにします。この制限は Geo zone と組み合わせて適用されます。

詳細設定

Debug log: 料金の計算と API のエラーを storage/logs/vfd_armx_debug.log.php に書き込みます。このファイルはウェブから読み取ることはできません。パスワード、PIN、購入者の住所がログに記録されることはありません。作業が終わったらログをオフにしてください。ファイルが 5 MB に達すると、vfd_armx_debug.old.log.php に移動され、新しいログが開始されます。

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

Remove data on uninstall: オンの場合、拡張機能をアンインストールすると、Aramex の設定、キャッシュされた料金、ログが削除されます。オフ（既定）の場合、再インストールのためにこれらは保持されます。

インポート / エクスポート

エクスポート: Download JSON をクリックすると、設定が JSON ファイルとして保存されます。パスワードと PIN はエクスポートされません。

インポート: 以前にエクスポートした JSON を貼り付けて Import をクリックすると、設定が復元されます。たとえば別のストアに復元する場合などに使用します。値は通常の保存時と同じように検証されます。保存済みのパスワードと PIN は保持されます。

チェックアウトでの動作

OpenCart が配送方法を表示するとき、拡張機能に Aramex の料金を問い合わせます。Geo zone が設定されていて住所がその外側にある場合、Aramex は提供されません。Requires Shipping が Yes に設定された商品のみが対象です。それ以外の商品は重量に加算されず、注文金額にも含まれません。次に拡張機能は条件を確認します：許可された国、カートの重量、最低注文金額。注文金額は、配送が必要な商品の価格で、クーポン割引後、税抜きの金額です。ギフト券、ポイント、ストアクレジットは考慮されません。送料無料が適用される場合、料金は 0 になり、Aramex へのリクエストは送信されません。

固定料金モードでは、料金は表から取得されます。リアルタイム料金モードでは、拡張機能は発送元と配送先の住所、請求重量、サービス、およびストアの既定の通貨を Aramex に送信し、返された合計を使用します。リアルタイム料金は、配送先住所に市区町村または郵便番号がある場合にのみ要求されます。料金はストアの既定の通貨で計算され、その通貨の小数桁に丸められ、選択した Tax class の税金を含めて、購入者の通貨で表示されます。

各応答は 1 時間キャッシュされるため、同じカートで新たなリクエストが発生することはありません。失敗したリクエストは 10 分間キャッシュされるため、チェックアウトが更新のたびに Aramex の応答を待つことはありません。API のタイムアウトは 10 秒です。

Aramex がエラー、ゼロの金額、または為替レートがないまま別の通貨の見積もりを返した場合、購入者にエラーは表示されません。配送方法は非表示になるか、フォールバックモードでは固定料金が使用されます。理由はデバッグログに記録されます。

この拡張機能は料金の計算のみを行います。Aramex の出荷の作成、ラベルの印刷、集荷の予約、荷物の追跡は行わず、購入者が Aramex の営業所を選択することもできません。注文には何も追加されません。注文には、他のすべての OpenCart の配送方法と同様に、配送方法の名前と配送料が表示されます。荷物は常に 1 個として Aramex に送られます。

OpenCart 4 では、購入者はチェックアウトページの配送方法ブロックで Choose をクリックし、Shipping method options のウィンドウで Aramex を選択します。この方法は OpenCart 3 と同じように動作します。

ライセンスキー

この拡張機能は、vibefox.net で購入した VibeFox ライセンスキーで動作します。License — VibeFox Aramex ライセンスブロックは、Extensions > Extensions > Shipping > VibeFox Aramex > Edit ページで設定の上にある最初のブロックです。キーを License key に貼り付けて Activate をクリックします。その後、ブロックにはキーがマスク表示され、ステータス（ライセンスの有効期限日やドメインなど）と、ボタンとして Check now（ステータスを再確認）、Change key（別のキーを入力）、Remove key（このストアからキーを削除）が表示されます。その下には Product: opencart-shipping-aramex の行と Manage licenses and domains in your account のリンクがあり、vibefox.net のアカウントが開きます。キーを変更できるのは、この拡張機能の変更権限を持つ管理者ユーザーのみです。ブロックのテキストは管理画面の言語に従います（英語とロシア語を含みます）。

キーが受け付けられない場合、ブロックに理由が表示されます。例：Key not found、This key belongs to another product、Domain limit reached、または日付付きの License expired on。ストアの住所を変更した後、またはアカウントでドメインの枠を解放した後は、Check now をクリックしてください。ライセンスサーバーに接続できない場合、拡張機能は最後に確認できたステータスで動作を続けます。

1 つのキーは 1 つのドメインで使用できます。OpenCart の設定にあるストアの住所が対象です。ストアからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

有効なキーがない場合、チェックアウトで購入者に Aramex の配送方法は表示されず、料金も計算されません。同じブラウザで管理画面にログインしている管理者ユーザーには、ストアで配送方法が (unlicensed — visible to admins only) の印付きで引き続き表示されるため、キーを購入する前に拡張機能を設定してテストできます。OpenCart 4 では、このプレビューは利用できません。ストアは管理画面のログインを認識しないため、有効なキーがない場合、配送方法は全員に対して非表示になります。Edit ページを一度開くと、管理画面の Dashboard にリマインダーが表示されます。× で閉じると 7 日間非表示になります。既存の注文には影響しません。

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

トラブルシューティング

チェックアウトに Aramex が表示されない: ライセンスが有効であること、Enable Aramex がオンであることを確認してください。Geo zone、Countries、重量制限、Minimum order amount を確認します。固定料金モードでは、その国または * All other countries に料金が設定されているか確認してください。商品の Requires Shipping が Yes に設定されていることも確認します。

リアルタイム料金が表示されない: Debug log をオンにして、チェックアウトを再読み込みし、拡張機能のページにある Log フィールドを確認してください。理由が表示されます：API の認証情報がない、Aramex のエラーコード、発送元の都市がない、配送先の都市または郵便番号がない、重量または金額の制限、別の通貨での見積もり。Aramex live rates, fixed prices if the API fails を設定しておけば、問題を修正する間も購入者は固定料金を受け取れます。

ログに ERR75 が表示される: Aramex がログインを拒否しました。Aramex のアカウントマネージャーに、ユーザー名、パスワード、アカウント番号、PIN、エンティティ、国コードを確認してください。

別の通貨での見積もりが拒否される: Aramex がストアの既定の通貨とは異なる通貨で回答しました。Currency conversion rate を入力するか、Aramex に自国の通貨で見積もるよう依頼してください。

配送料に税金が二重にかかる: Aramex の合計にはすでに付加価値税が含まれている場合があります。Tax class を No tax に設定してください。

変更後に料金が古いようだ: 拡張機能のページで Save をクリックしてください。これによりキャッシュされた Aramex の料金がクリアされます。

ページに "Warning: You do not have permission to modify VibeFox Aramex!" と表示される: 管理者ユーザーのグループには、設定の閲覧のみが許可されている可能性があります。System > Users > User Groups で、そのグループに extension/shipping/vfd_aramex（OpenCart 3）または extension/vfd_aramex/shipping/vfd_aramex（OpenCart 4）の変更権限を付与してください。

開発者向け: Aramex API のアドレスは、設定 vfd_armx_api_url（テスト用）で置き換えられます。設定ページにはこの項目の入力欄はありません。

アンインストール

Extensions > Extensions に進み、種類 Shipping を選択して、VibeFox Aramex の横にある Uninstall（赤い − ボタン）をクリックします。OpenCart は常に Enable Aramex、Sort order、Tax class、Geo zone をリセットします。キャッシュされた料金は常に削除されます。Remove data on uninstall がオンの場合、Aramex の設定とデバッグログも削除されます。オフの場合、ほかの設定は保持され、拡張機能を再インストールしたときに再び使用されます。既存の注文は、配送方法と送料をそのまま保持します。

OpenCart 4 で拡張機能のファイルも削除するには、アンインストール後に Extensions > Installer を開き、インストール済み拡張機能の一覧にある VibeFox Aramex の横の Uninstall（オレンジ色の − ボタン）をクリックして、次にアップロードしたパッケージを削除するため Delete（赤いごみ箱ボタン）をクリックします。

Aramex は、それぞれの所有者の商標です。本拡張機能は Aramex と提携しておらず、Aramex による推奨も受けていません。