VibeFox FedEx for WooCommerce — 帮助
系统要求
WordPress:5.8 或更高版本。
WooCommerce:7.0 或更高版本,已安装并启用。未安装 WooCommerce 时,插件无法启用。
PHP:8.0 或更高版本。
FedEx 账户和 API 密钥(仅用于实时运费):请在 FedEx Developer Portal(developer.fedex.com)中创建一个开通了 Rate API 的项目,关联您的 FedEx 配送账户,并复制 API Key 和 Secret Key。您还需要 9 位数的 FedEx 账号。测试密钥仅在 Sandbox 开启时有效,正式密钥仅在其关闭时有效。插件使用 OAuth 2.0 的 FedEx REST API,不需要 meter number 或 Web Services 密码。如果您只使用固定价格,则无需 FedEx 密钥。
VibeFox 许可证密钥:在 vibefox.net 购买。一个密钥只能用于一个域名。
安装
1. 在 WordPress 中进入 Plugins > Add New > Upload Plugin,选择插件的 ZIP 文件,然后点击 Install Now。您也可以通过 FTP 将 vfd_fedex 文件夹上传到 /wp-content/plugins/。
2. 点击 Activate。
3. 打开设置:WooCommerce > Settings > Shipping > VibeFox FedEx,或在插件列表页点击插件名称下方的 Settings。
4. 在页面顶部的许可证区块中输入您的 VibeFox 许可证密钥,然后点击 Activate。
5. 输入 API Key、Secret Key、9 位 FedEx 账号以及 Ship from 发货地址(邮编;美国和加拿大还需填写 2 位字母的州/省代码)。使用正式密钥时,请关闭 Sandbox。
6. 在 WooCommerce > Settings > Shipping > Shipping zones 中将 VibeFox FedEx 添加到配送区域,或开启 Ignore shipping zones 并选择国家。
7. 可选:输入固定价格作为备用。
配置
所有设置都在同一个页面:WooCommerce > Settings > Shipping > VibeFox FedEx。它们适用于所有配送区域。将该方式添加到某个区域时,区域窗口只有一个字段:
Title (zone):该选项在结账时显示的名称。留空则使用全局的 Name。
页面顶部会显示插件的警告:三项 API 凭据只填写了部分、没有 API 密钥也没有固定价格(此时该方式永远不会显示)、缺少发货邮编、美国或加拿大缺少发货州/省代码,或者店铺货币与 FedEx 账户货币不同且未设置汇率。每次保存设置时,缓存的 FedEx 令牌和运费都会被清除。数字字段接受小数点或逗号。无效数字不会被保存,并会给出提示。
General
Enable/Disable:一次性在所有区域开启或关闭 FedEx 配送。默认:开启。
Name:结账时显示给顾客的配送方式名称。默认:FedEx。
Tax status:Taxable 允许 WooCommerce 对运费加收税款,因此使用不含税的 FedEx 运费。None 则按 FedEx 的净运费原样使用。默认:Taxable。
FedEx API(实时运费)
未输入密钥时使用固定价格。该部分包含链接 Clear cached FedEx token and rates。
Sandbox:使用带测试密钥的 FedEx 沙盒。若要使用正式密钥获取真实运费,请关闭此项。默认:开启。
API Key:您在 FedEx Developer Portal 项目中的 API Key(client_id)。
Secret Key:同一项目的 Secret Key(client_secret)。
FedEx account number:与该项目关联的 9 位 FedEx 配送账号。
Rates:Account rates (your negotiated FedEx prices)(默认)或 List rates (FedEx published prices)。
Residential delivery:将顾客地址按住宅地址报价(FedEx Home Delivery,住宅附加费)。如果您主要寄送给企业,请关闭。默认:开启。
Box size:可选的包装箱尺寸,使用店铺的尺寸单位,例如 30x20x15。设置后,FedEx 将应用体积重量。留空则仅按重量报价。
FedEx account currency:您的 FedEx 账户货币,例如美国账户用 USD,加拿大用 CAD。默认:USD。FedEx 也始终会被要求以店铺货币报价。
Exchange rate:仅当 FedEx 只返回账户货币的运费,且店铺货币不同时才需要:1 单位账户货币折合为店铺货币的价格,例如 0.92。未设置时,此类运费不会被使用。
发货地址
FedEx 取件或您寄送包裹时所在的地址。用于实时运费。
Country:您发货所在的国家。默认:United States。
State / province code:2 位字母的州/省代码,美国和加拿大必填,例如 TN、CA 或 ON。
City:发货城市。
ZIP / postal code:发货邮政编码。FedEx 需要它才能报价。
固定价格
在未输入 API 密钥时使用,并在 FedEx 未返回任何运费时作为备用(API 不可用、密钥错误、没有可用服务)。若希望在此情况下隐藏该方式,请将两个字段都留空。
Country prices:按目的国设置的店铺货币价格,每行一个国家,格式为 CC=PRICE,例如 US=12.99 或 CA=19,99。使用 * 表示其他所有国家,例如 *=29.99。格式不符的行会被忽略,并在保存时提示。
Fallback cost:没有匹配的国家价格时使用的固定价格。留空则隐藏该方式。
Fixed price is:Per order 只收取一次价格。Per item (price x number of items) 按商品数量相乘。这仅适用于固定价格。FedEx 实时运费始终按购物车的总重量报价。
条件
Free shipping from:购物车小计达到该金额时此方式免运费。留空则从不提供免运费。
Minimum subtotal:仅当购物车小计不低于该金额时才显示此方式。留空则始终显示。
Min weight (kg):此方式显示所需的最低购物车重量。0 表示无限制。
Max weight (kg):购物车的最大重量。超过时此方式会被隐藏。0 表示无限制。
Default product weight (kg):用于没有重量的商品,适用于 FedEx 运费计算和上述重量限制。默认:0.5。
Excluded shipping classes:如果购物车中包含任一 WooCommerce 配送类别的商品,则隐藏此方式。
未使用配送区域时的可用性
Ignore shipping zones:即使未将此方式添加到配送区域,也会为下方指定的国家提供该方式。如果某个区域中的区域方式已在该区域中关闭,则它保持关闭。
Countries:该模式的目的国。留空则适用于店铺的所有配送国家。仅在开启 Ignore shipping zones 时使用。
高级
Debug log:将 API 请求和运费计算记录到 WooCommerce > Status > Logs,来源为 vfd-fedex。API 错误始终会被记录。密钥、令牌和顾客地址绝不会被记录。
Remove data on uninstall:开启后,删除插件会移除所有插件设置和区域方式。停用插件绝不会删除设置。
结账时的工作流程
当顾客输入收货地址时,WooCommerce 会向插件请求运费。插件首先检查购物车重量、最低小计和排除的配送类别。如果适用免运费,顾客会看到该方式显示为 FedEx (Free),且不会向 FedEx 发送任何请求。
否则,插件会获取 OAuth 令牌,并向 FedEx Rate API 发送发货地址、收货地址、购物车重量(以 kg 计;使用 lb 或 oz 的店铺则以 lb 计)、已设置的包装箱尺寸,以及作为首选货币的店铺货币。对于使用邮政编码的国家,只有在顾客输入邮编后才会发起请求。对于国际运输,会发送购物车的海关申报价值。州/省代码仅针对美国和加拿大发送。
FedEx 返回可用的服务。对于每项服务,插件会取您所选的账户或列表运费,优先使用店铺货币的运费,用您设置的汇率换算 FedEx 账户货币的运费,并丢弃无法换算的运费。最便宜的服务显示在您的配送方式名称下,其名称会保存到订单的配送行中。
令牌按环境和密钥缓存,当 FedEx 拒绝时会自动重新请求。报价缓存 1 小时。运费请求失败会记录 10 分钟,令牌请求失败会记录 5 分钟,因此服务中断不会拖慢每次结账更新。API 超时时间为 15 秒。如果 FedEx 无响应,顾客不会看到任何错误:会使用固定价格,或隐藏该方式。
该方式适用于经典结账和区块结账。它兼容 WooCommerce 高性能订单存储(HPOS)。
插件只计算运费。它不会创建 FedEx 运单、打印面单、预约取件、跟踪包裹,也不允许顾客选择 FedEx 网点。它只显示一个选项(最便宜的服务),而不是多个;并且没有装箱功能:购物车按一个包裹报价。
许可证密钥
本插件需要一个来自 vibefox.net 的 VibeFox 许可证密钥。许可证区块位于 WooCommerce > Settings > Shipping > VibeFox FedEx 的顶部。将密钥粘贴到 License key 中,然后点击 Activate。该区块会显示状态,例如许可证有效期至何时以及您的域名。使用 Check now 可重新检查状态,Change key 可输入其他密钥,Remove key 可将其从本站点移除。链接 Manage licenses and domains in your account 会打开您的 vibefox.net 账户。
一个密钥只能用于一个域名。从某个站点移除密钥并不会释放其域名名额。请在您的 vibefox.net 账户中释放该名额。
没有有效密钥时,结账时不会向顾客显示 FedEx。已登录的店铺管理员仍能看到该方式,并标有 (unlicensed — visible to admins only),以便您在购买密钥前进行设置和测试。插件列表页和 WooCommerce 页面会显示提醒。现有订单不受影响。
许可证到期后,插件仍可继续工作,但更新和支持需要续费。状态会在后台自动重新检查。
故障排除
结账时不显示 FedEx:请检查许可证是否有效、Enable/Disable 是否开启,以及该方式是否已添加到顾客所在国家的配送区域(或已开启 Ignore shipping zones 且允许该国家)。请查看设置页顶部的警告、重量限制、Minimum subtotal 和 Excluded shipping classes。没有实时运费时,该方式需要一个国家价格、一行 * 或一个 Fallback cost。
实时运费不显示:请开启 Debug log,刷新结账页面,然后打开 WooCommerce > Status > Logs,来源选择 vfd-fedex。错误的密钥、错误的环境(Sandbox 关闭时使用测试密钥,或开启时使用正式密钥)以及 FedEx 错误代码都会记录在那里。
我的店铺不是 USD:系统会向 FedEx 请求以店铺货币计算的运费。如果您的账户只返回其自身的货币,请设置 FedEx account currency 和 Exchange rate。没有汇率时,这些运费会被忽略,并使用固定价格,因此美元金额绝不会显示为欧元。
"per item" 会乘以 FedEx 运费吗?不会。Per item 只适用于固定价格。
修改后运费似乎过时:更改密钥后,缓存会自动清除。您也可以点击 Clear cached FedEx token and rates。
只应提供部分服务:开发者可以使用 vfd_fdx_allowed_services 过滤器限制服务。
许可证区块显示错误:请按照区块中的提示操作。例如,如果该密钥已在另一个域名上使用,请在您的 vibefox.net 账户中释放一个名额,然后点击 Check now。如果站点地址已更改,请点击 Check now,为新域名激活密钥。如果无法连接许可证服务器,插件会继续使用最后已知的状态运行。
卸载
停用插件会保留所有设置,只清除缓存的令牌和运费。要删除插件,请先停用,然后在 Plugins 页面将其删除。本插件的许可证密钥和许可证状态、缓存的令牌和运费以及旧日志文件始终会被删除。只有开启了 Remove data on uninstall 时,设置和区域方式才会被删除。否则它们会保留,以便之后重新安装时使用。现有订单会保留其配送行。
FedEx 是其各自所有者的商标。本插件与 FedEx 无关联,也未获得 FedEx 的认可。
