返回

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。您需要六个值:API 用户名(通常是电子邮件地址)、密码、账户号码、账户 PIN、账户 entity(机构代码,例如 DXB)和账户国家代码(例如 AE)。如果您只使用按国家设置的固定价格,则无需 Aramex 账户。

VibeFox 许可证密钥:在 vibefox.net 购买。一个密钥只能用于一个域名。

安装

1. 在后台进入 Modules > Module Manager,点击 Upload a module。选择模块的 ZIP 文件。

2. 上传完成后,点击 Configure;或之后在模块列表中找到 VibeFox Aramex,然后点击 Configure。

3. 在 Configure 页面顶部的许可证区块中,将您的 VibeFox 许可证密钥输入 License key 字段,然后点击 Activate(参见“许可证密钥”)。

4. 选择运费的计算方式,填写相应的部分(参见“配置”),然后点击 Save。

安装时,模块会创建 Aramex 承运商,配送时间文本为 Courier delivery。该承运商会分配给所有区域和所有客户群组。您可以在 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 账户(仅实时运费需要;所有六个字段均为必填)

Username:您的 Aramex API 用户名,通常是电子邮件地址。

Password:您的 Aramex API 密码。保存后该字段保持为空,并显示 Saved — leave empty to keep it。仅在需要更改时输入新值。

Account number:您的 Aramex 客户账户号码。

Account PIN:您的 Aramex 账户的 PIN。与密码一样,保存后不会再次显示。

Account entity:您的 Aramex 账户的机构(办事处)代码,例如 DXB、AMM 或 RUH。

Account country code:您的 Aramex 账户的两位国家代码,例如 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 仍以其他货币回复,则将运费乘以此数字(1 个 Aramex 货币单位 = X 个店铺默认货币单位)。留空则拒绝此类报价,从而确保顾客绝不会以错误的货币付款。

发货地址(起始地址)(用于实时运费)

Origin country:您的发货国家。默认为您店铺所在的国家。

Origin city:您的发货城市。Aramex 要求填写。

Origin state / emirate:可选。

Origin postcode:可选。

如果发货国家与店铺所在国家相同,空白字段将从 Shop Parameters > Contact > Stores 中的店铺地址获取。

固定价格(用于固定模式,并作为实时运费的备用方案)

Price per country:一个表格,包含两位国家代码和价格,价格以您店铺的默认货币计,不含税。点击 Add row 添加国家,点击垃圾桶图标删除。使用 * 作为所有其他国家的国家代码。没有价格的国家(如果没有 * 行)不会获得固定运费,因此该承运商对它们隐藏。

Fixed price applies:Per order 只收取一次价格。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 网点。包裹始终作为一件货物发送给 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。如果无法连接许可证服务器,模块将继续按最后已知状态运行。

一个密钥只能用于一个域名:主店铺的域名,多店铺设置中也是如此。从店铺中移除密钥不会释放其域名名额。请在 vibefox.net 账户中释放名额。

没有有效密钥时,Aramex 承运商不会在结账时显示给顾客,也不会计算任何运费。PrestaShop 前台无法得知您已登录后台,因此该承运商对您也是隐藏的:您可以在购买密钥之前设置模块,但无法在结账时测试。Modules > Module Manager 的 Alerts 选项卡中会出现提醒。现有订单不受影响。

许可证到期后,模块仍会继续运行,但更新和支持需要续费。您在后台工作时会自动再次检查状态:输入密钥后的前 14 天内每天一次,之后每周一次。无需 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 拒绝了登录。请与您的 Aramex 客户经理核对用户名、密码、账户号码、PIN、entity 和国家代码。

其他货币的报价被拒绝:Aramex 以不同于您默认货币的货币回复。请输入 Currency conversion rate,或要求 Aramex 以您的货币报价。

运费被重复征税:Aramex 的总额可能已包含增值税。请将 Tax 设置为 No tax。

修改后运费看起来过时:点击模块页面上的 Save。这会清除缓存的 Aramex 运费。

页面提示未找到 Aramex 承运商:该承运商已在 Shipping > Carriers 中被删除。请在 Modules > Module Manager 中重置模块以重新创建。

卸载

进入 Modules > Module Manager,打开 VibeFox Aramex 旁边的菜单,然后选择 Uninstall。许可证密钥、许可证状态和缓存的运费总会被删除。如果 Remove data on uninstall 已开启,承运商会被删除(订单保留其历史记录),设置和日志也会被删除。如果已关闭,承运商仅会被停用,所有设置都会保留。重新安装模块会重新启用保存的承运商。

Aramex 是其各自所有者的商标。本模块与 Aramex 无关联,也未获得 Aramex 的认可。