戻る

VibeFox Aramex for PrestaShop — ヘルプ

要件

PrestaShop: 8.0 ~ 9.x。

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

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

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

インストール

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

2. アップロードが完了したら Configure をクリックするか、後でモジュール一覧から VibeFox Aramex を探して Configure をクリックします。

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

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

インストール時に、モジュールは配達時間のテキストが Courier delivery の Aramex 配送業者を作成します。配送業者はすべてのゾーンとすべての顧客グループに割り当てられます。ゾーン、顧客グループ、配達時間、ロゴ、サイズ制限は Shipping > Carriers で変更できます。そこでは料金を設定しないでください。料金は常にモジュールから取得されます。

設定

すべての設定はモジュールのページにあります: Modules > Module Manager > VibeFox Aramex > Configure。各セクションには独自の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた Aramex 料金も消去されます。

一般

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

Method title: カートとチェックアウトに表示される配送業者名。デフォルト: Aramex。必須。

Shipping cost: 料金の計算方法。

Fixed prices per country (table below): 料金は Price per country の表から取得されます。Aramex アカウントは不要です。
Aramex live rates (API): カートごとに Aramex へ料金を照会します。Aramex が料金を返さない場合、そのカートでは配送業者が非表示になります。
Aramex live rates, fixed prices if the API fails: Aramex へ料金を照会します。Aramex が応答しない場合(認証情報の誤り、タイムアウト、サービスエラー)は、その国の固定料金が使用されます。

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

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

Username: Aramex API のユーザー名。通常はメールアドレスです。

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

Account number: Aramex の顧客アカウント番号。

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

Account entity: Aramex アカウントの entity(営業所)コード。例: 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、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(発送者が支払う)、Collect(受取人が支払う)、Third party(第三者が支払う)。通常は Prepaid です。

API weight unit: Aramex に送信する単位(KG または LB)。商品の重量とサイズはショップの単位から換算されます。課金重量は実重量と容積重量(縦 × 横 × 高さ(cm)/ 5000)の大きい方です。最小値は 0.5 kg で、重量のない商品にも適用されます。

Currency conversion rate: Aramex にはショップのデフォルト通貨で見積もるよう依頼します。それでも Aramex が別の通貨で回答した場合、料金にこの数値を掛けます(Aramex の通貨 1 単位 = ショップのデフォルト通貨 X 単位)。このような見積もりを拒否するには空欄のままにします。そうすれば、購入者が誤った通貨で請求されることはありません。

発送元住所(出荷元)(リアルタイム料金に使用)

Origin country: 発送元の国。デフォルトはショップの国です。

Origin city: 発送元の都市。Aramex で必須です。

Origin state / emirate: 任意。

Origin postcode: 任意。

発送元の国がショップの国の場合、空欄のフィールドは Shop Parameters > Contact > Stores にあるショップの住所から補われます。

固定料金(固定モードで使用し、リアルタイム料金のフォールバックとしても使用)

Price per country: 2 文字の国コードと料金の表。料金はショップのデフォルト通貨、税抜きで入力します。Add row をクリックすると国を追加でき、ゴミ箱アイコンで削除できます。その他すべての国には国コードとして * を使用します。料金のない国(* の行がない場合)には固定料金が適用されないため、その国では配送業者が非表示になります。

Fixed price applies: Per order は料金を 1 回だけ請求します。Per item は料金にカート内の商品数を掛けます。Aramex のリアルタイム料金は常に発送ごとです。

条件

Minimum weight: カートの重量がこの値より軽い場合、配送業者を非表示にします(kg)。0 は制限なしを意味します。

Maximum weight: カートの重量がこの値より重い場合、配送業者を非表示にします(kg)。デフォルト: 100。0 は制限なしを意味します。

Minimum order amount: カートの小計(割引後、税抜き)がこの金額に達した場合にのみ配送業者を表示します。空欄にすると常に表示されます。

Free shipping: 下記の金額以上で Aramex の送料無料を有効にします。

Free shipping from: 送料が無料になるカートの小計(割引後、税抜き)。Free shipping が有効な場合にのみ使用されます。

Tax: 配送業者の税ルール、または No tax。Aramex のリアルタイム料金にはすでに消費税が含まれている場合があります。その場合は No tax を選び、税金の二重請求を防ぎます。

Countries: これらの配送先国に対してのみ Aramex を提供します。空欄にすると、配送業者のゾーンに含まれるすべての国を許可します。

詳細設定

Debug log: 料金の計算と API エラーを、モジュールフォルダ内の logs/vfd_armx_debug.log.php に書き込みます。このファイルはウェブから開けません。パスワード、PIN、アカウント番号、顧客の住所はマスクされます。作業が終わったらログを無効にしてください。

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

Remove data on uninstall: 有効にすると、モジュールのアンインストール時に Aramex の設定、配送業者、キャッシュされた料金、ログが削除されます。無効にすると、再インストールに備えてすべてが保持されます。

チェックアウト時の動作

配送ステップで、PrestaShop はモジュールに Aramex の料金を問い合わせます。対象は実物の商品のみです。バーチャル商品は重量に加算されず、注文金額にも含まれません。モジュールはまず条件を確認します: 許可された国、カートの重量、最低注文金額。送料無料が適用される場合、料金は 0 になり、Aramex へのリクエストは送信されません。

固定モードでは、料金は表から取得されます。リアルタイムモードでは、モジュールは発送元と配送先の住所、課金重量、サービス、デフォルト通貨を Aramex に送信し、返された合計を使用します。リアルタイム料金が照会されるのは、配送先住所に市区町村または郵便番号がある場合のみです。料金はデフォルト通貨で計算された後、購入者のカートの通貨で表示されます。

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

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

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

モジュールが行うのは料金の計算のみです。Aramex の発送データ作成、ラベル印刷、集荷予約、荷物追跡、購入者による Aramex 営業所の選択はできません。小包は常に 1 個として Aramex に送信されます。

ライセンスキー

モジュールは vibefox.net で取得した VibeFox ライセンスキーで動作します。License — VibeFox Aramex のライセンスブロックは、Modules > Module Manager > VibeFox Aramex > Configure の一番上、設定より上にあるブロックです。キーを License key に入力し、Activate をクリックします。その後、ブロックにはマスクされたキー、ステータス(ライセンスの有効期限日やドメインなど)、そして Check now(ステータスを再確認)、Change key(別のキーを入力)、Remove key(このショップからキーを削除)のボタンが表示されます。その下には Product: presta-shipping-aramex の行と、Manage licenses and domains in your account のリンク(vibefox.net のアカウントが開きます)があります。キーを変更できるのは、モジュールの Configure 権限を持つスタッフだけです。ブロックの文言はバックオフィスの言語に従います(英語とロシア語が含まれます)。

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

1 つのキーは 1 つのドメインで使用できます。マルチストア構成の場合も、メインショップのドメインが対象です。ショップからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

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

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

トラブルシューティング

Aramex がチェックアウトに表示されない: ライセンスが有効であること、Enable Aramex がオンであることを確認してください。Shipping > Carriers で、配送業者が購入者の国のゾーンと購入者のグループをカバーしているか確認します。Countries、重量の制限、Minimum order amount を確認してください。固定モードでは、その国または * に料金が設定されているか確認します。商品ページで、商品が特定の配送業者に制限されている場合もあります。

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

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

別通貨での見積もりが拒否される: Aramex がショップのデフォルト通貨以外の通貨で回答しました。Currency conversion rate を入力するか、Aramex にご利用の通貨で見積もるよう依頼してください。

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

変更後も料金が古いまま: モジュールのページで Save をクリックしてください。キャッシュされた Aramex 料金が消去されます。

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

アンインストール

Modules > Module Manager に移動し、VibeFox Aramex の横にあるメニューを開いて Uninstall を選びます。ライセンスキー、ライセンスステータス、キャッシュされた料金は常に削除されます。Remove data on uninstall が有効な場合、配送業者は削除され(注文は履歴を保持します)、設定とログも削除されます。無効な場合、配送業者は無効化されるだけで、すべての設定は保持されます。モジュールを再インストールすると、保存されていた配送業者が再び有効になります。

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