Advanced Integrated Visibility Webhook 的类型
通过 Advanced Integrated Visibility Webhook,FedEx 可以将近乎实时的安全查询事件数据推送到与特定 FedEx 账号关联的货件目的地 URL。
您可以在 FedEx Developer Portal 上创建 Advanced Integrated Visibility Webhook 项目,然后根据所选的订阅类型,将其与一个或多个 FedEx 账号或 FedEx 追踪号码进行关联。
导航到:
ADVANCED INTEGRATED VISIBILITY 账号订阅 或 ADVANCED INTEGRATED VISIBILITY 追踪号码订阅 ,以查看创建相应 Advanced Integrated Visibility Webhook 的步骤。
FedEx Advanced Integrated Visibility 概览
FedEx 客户可以订阅账号或查询号码,以便接收近乎实时的在途货件事件,从标签创建到包裹递送证明,包括递送图片证明。
订阅类型
FedEx 客户可以通过下列方式订阅 Advanced Integrated Visibility:
- 按账号 - 订阅 FedEx 账号,可接收与该账号匹配的货件更新。
- 按查询号码 - 订阅 FedEx 查询号码,可通过 API 端点接收与指定查询号码匹配的货件更新。
注意:目前订阅需要使用美国 FedEx 9 位数账号进行账单付款,客户根据查询号码计数支付月度费用。如需详细了解 Advanced Integrated Visibility 定价,请参阅 Advanced Integrated Visibility 概览定价指南。
如果通过账号订阅,目前订阅需要 FedEx 9 位数的美国货运账号。
下表列出了账号订阅与 Advanced Integrated Visibility 追踪号码订阅的功能对比信息
| 功能 | 账号订阅 | 追踪号码订阅 |
|---|---|---|
| 响应 | 受保护数据 = 个人身份信息 (PII) 数据寄件人和收件人数据 SPOD CDO(方便递送选项)/响应 | 匿名数据(包括货件、在途更新,不包括 PII - 个人身份信息/响应 |
| 关联 | 通过账号关联 = 一次关联所有已链接的查询号码 | 关联查询号码 |
| 所有权 | 账号需要由用户本人所有 | 查询号码不需要由用户本人所有 |
| 筛选 | 能够按进口、出口和第三方货件筛选事件 |
无法筛选事件 |
| 集成 | 通过 UI 关联账号 | 通过 API 端点关联查询号码 |
| 限制 | 最多可以添加 100 个账号 | 每个请求最多可以添加 1000 个查询号码 |
| 合适用例 | 第一方客户 - 如果客户拥有账号 | 第三方客户 - 如果客户拥有属于第一方客户的查询号码 |
FedEx Integrated Visibility – 按订阅类型对比的功能比较
| 功能/数据元素 | 追踪号码订阅 | 账号订阅 | 备注 |
|---|---|---|---|
| SPOD(递送签收证明) | 不适用 | 可用(所需配置) | TIFF 格式的签名图像,在有效负载中传送 |
| PPOD(递送图片证明) | 可用(所需配置) | 可用(所需配置) | 递送地点的 JPEG 图像,采用 base64 编码 |
| PPODA(尝试递送图片证明) | 可用(所需配置) | 可用(所需配置) | 尝试递送时提供的 JPEG 图像 |
| GPS 坐标 (gpsPodCoordinates) | 不适用 | 可用 | 在查询号码型订阅中以掩码形式显示 |
| 联系信息(姓名、电话、公司) | 掩码形式 | 可用 | 跨寄件人、收件人、始发地、目的地、代理人等 |
| 街道地址和邮政编码 | 掩码形式 | 可用 | streetLines 和 postalCode 在查询号码型有效负载中以掩码形式显示 |
| 帐号 | 掩码形式 | 可用 | 包括付款人、寄件人和收件人账号值 |
| 包裹财务信息(例如 declaredValue、codAmount) | 掩码形式 | 可用 | 海关、COD 和申报值以掩码形式显示 |
| 查询和退货详情(查询代码、退货原因) | 掩码形式 | 可用 | 仅向账号型订阅用户显示完整详情 |
| 货品与内容数据 | 掩码形式 | 可用 | 包括零件代码、描述、数量 |
| 员工 ID(例如活动人员) | 掩码形式 | 不适用 | 出于隐私原因,两种情况下均采用掩码处理 |
| 活动通知及 EDD/EDTW | 可用 | 可用 | 两者均支持预计送达日期/时间功能 |
| 一票多件货件 (MPS) | 可用 | 可用 | 提供其他查询信息 |
| 预计送达时间信心与风险分数 | 可用 | 可用 | 仅限 Premium 层级 |
Advanced Integrated Visibility 查询号码订阅的已掩码数据字段
摘要
当客户使用 Advanced Integrated Visibility 查询号码订阅而不是 Advanced Integrated Visibility账号订阅来订阅货件查询更新时,特定数据字段将采用掩码处理,以维护客户隐私并遵守数据安全政策。
此掩码处理确保敏感信息(包括个人联系方式、地址及财务数据)仅对授权方可见。使用 Advanced Integrated Visibility 查询号码订阅的客户,在下方列出的掩码处理字段中将看到“XXXXX”,即使该数据可能通过 Advanced Integrated Visibility 查询号码订阅获取。
这种掩码处理的影响包括:
- 对始发地/目的地详情及相关方的可见性受限。
- 不含个人标识信息(如姓名、电话号码)及财务或海关相关数据。
- 通过设计保护专有或敏感货件信息,以满足安全及法规合规要求。
需访问这些掩码字段以满足运营或业务需求的客户,建议使用账号进行订阅。
Advanced Integrated Visibility 查询号码订阅中采用掩码处理的数据项包括:
扫描事件
- scanEvent/location/locationContactAndAddress/address/streetLines
- scanEvent/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/location/locationContactAndAddress/contact/companyName
- scanEvent/location/locationContactAndAddress/contact/personName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/address/streetLines
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/companyName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/personName
寄件人信息
- trackResult/shipperInfo/contactAndAddress/address/postalCode
- trackResult/shipperInfo/contactAndAddress/address/streetLines
- trackResult/shipperInfo/contactAndAddress/contact/phoneNumber
- trackResult/shipperInfo/contactAndAddress/contact/companyName
- trackResult/shipperInfo/contactAndAddress/contact/personName
- trackResult/shipperInfo/account/value
收件人信息
- trackResult/recipientInfo/contactAndAddress/address/postalCode
- trackResult/recipientInfo/contactAndAddress/address/streetLines
- trackResult/recipientInfo/account/value
- trackResult/recipientInfo/contactAndAddress/contact/phoneNumber
- trackResult/recipientInfo/contactAndAddress/contact/companyName
- trackResultecipientInfo/contactAndAddress/contact/personName
始发地和目的地位置
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/postalCode
递送和地址更改详情
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/gpsPodCoordinates
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/personName
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/personName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/companyName
代理人信息
- trackResult/broker/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/broker/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/broker/locationDetail/locationContactAndAddress/contact/personName
- trackResult/broker/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/broker/locationDetail/locationContactAndAddress/address/postalCode
包裹和财务详情
- trackResult/packageDetail/customsValue/value
- trackResult/packageDetail/declaredValue/value
- trackResult/packageDetail/originalTransportationCharge/value
- trackResult/codDetail/codAmount/value
查询和货品信息
- trackResult/inquiries/[Array]/categoryCode
- trackResult/inquiries/[Array]/code
- trackResult/inquiries/[Array]/createTime
- trackResult/inquiries/[Array]/statusCode
- trackResult/commodityInfo/[Array]/description
- trackResult/commodityInfo/[Array]/code
包裹内容和退货原因
- trackResult/contents/[Array]/partNumber
- trackResult/contents/[Array]/partCode
- trackResult/contents/[Array]/description
- trackResult/contents/[Array]/quantity
- trackResult/returnReason/[Array]/code
- trackResult/returnReason/[Array]/description
账单信息
- trackResult/billToParties/[Array]/billToParty/accountNumber
客户受益:
- 通过主动通知预计送达日期和递送时间窗口的在途变更,提高收件人的信心。
- 通过提供 FedEx 递送图片证明,降低 WISMO(我的订单在哪里)呼叫以及递送争议的客户服务成本。
- 通过提供近乎实时的货件状态通知,提升客户体验。
- 通过接收实时推送的货件更新信息,而不是不断轮询检查每批货件的查询更新信息,从而提高运营效率。
功能和查询事件
查询事件
此功能可以查询货件状态以及主动通知客户货件生命周期中的不同更新。它为客户提供了各种选项,客户可选择货件流程/事件的确切阶段,进而接收相应通知/提醒。可用的托运事件如下:
- 寄件: 此选项可在所选货件事件发生时提供通知。例如:标签已创建、取件等
- 运送途中:此选项可提供货件运送事件的通知。例如:运送途中、货件寄存在投递局等
- 递送:此选项可提供货件递送事件的通知。例如:外出递送、已送达等
- 异常:此选项可提供递送异常的通知。例如:清关延误等
- 方便递送选项: 选择此选项,可接收某些个性化查询事件的通知。例如:暂寄存在服务站的请求已接受。
有关可用货件事件选项的更多信息,请参阅 Advanced Integrated Visibility 查询事件的状态代码和状态表格。
递送证明
此功能可用于确认订单已成功到达预定目的地,包括:
- 递送图片证明 (PPOD):通过 PPOD,当包裹送达客户家门时,客户即可收到一张包裹确切位置的照片。
Advanced Integrated Visibility 会在 JSON 有效负载中提供 base64 格式的 PPOD 图像,然后图像可转换为 JPEG 格式。
注意:
- PPOD 适用于美国、加拿大、波多黎各、中国香港、新西兰、英国和爱尔兰。
- PPOD 仅适用于 FedEx Ground、FedEx Express 和住宅区包裹/地址。
- PPOD 适用于无需 SPOD 且符合条件的递送服务。无法同时使用 PPOD 和 SPOD。
- PPOD 适用于无需签收 (NSR) 的递送服务,此类递送并未直接将货件交付给客户(例如:递送过程中直接交给客户)。
- PPOD 可支持的图像大小为 14000 至 33000 字节(适用于分辨率为 320×240 的图像)。
- 尝试递送图片证明 (PPODA):在无法完成递送的情况下,PPODA 使客户能够收到包裹递送确切位置的照片。Advanced Integrated Visibility 会在 JSON 有效负载中提供 base64 格式的 PPODA 图像,然后图像可转换为 JPEG 格式。
- PPODA 可在美国和波多黎各使用。
- PPOD 仅适用于 FedEx Ground、FedEx Express 和住宅区和商业区包裹/地址。
- PPODA 图像可以是:
- 门上通知单的 PPODA 图像照片。
- 递送点受阻的照片(即,门锁定)。
- 在站点投递包裹的 PPOD 图像。
- PPODA 支持的图像大小为 14000 至 33000 字节(适用于 320 x 240 分辨率)
- 递送签收证明 (SPOD):通过 SPOD,客户可以收到收件人签收图像以及收件人姓名、递送日期、时间和地点。SPOD 信息将显示为字节数组而不是图像。字节数组是一个 base64 编码的字符串,需要解码才能得到最终的 PNG 格式的签名图片
- SPOD 不可用于 Advanced Integrated Visibility 查询号码订阅。
- SPOD 图像大小为 4000 至 6000 字节(适用于分辨率为 400x95 的图像)。
- SPOD 图像大小为 5000 至 8000 字节(适用于分辨率为 230x150 的图像)。
- GPS 递送证明 (GPSPOD):
- 通过 GPS POD,客户可以接收递送地点的地理坐标。
注意: 默认情况下,GPSPOD 可用于 Advanced Integrated Visibility 账号订阅。
- 通过 GPS POD,客户可以接收递送地点的地理坐标。
预计送达日期和递送时间窗口事件
此功能会提供货件递送的日期和/或时间范围,可帮助货件收件人规划递送安排,包括:
- 预计送达日期 (EDD):此选项可向收件人提供递送货件的预计日期。例如:20XX 年 11 月 20 日。
- 预计送达时间窗口 (EDTW): 此选项可向收件人提供在实际递送当天货件递送的预计时间窗口。例如:下午 2 点至下午 6 点。
事件筛选条件
利用此功能,客户可以根据货件的账单邮寄方式,安排自己的 webhook 项目。选项如下:
- 进口:如果货件递送给您并向作为收件人的您收取费用,请选择此选项。
- 出口:如果货件由您寄件并向作为发件人的您收取费用,请选择此选项。
- 第三方:如果进口和出口货件将向作为第三方付款人的您收费,请选择此选项。
注意: 您的 FedEx 账号将用于支付账单或支付货件。如果您是第三方付款人,则不可作为寄件人或收件人,但系统会向您的 FedEx 账号收取费用。
重试政策
此功能可防止 FedEx 在客户端出现问题时发送查询事件数据。FedEx 将保留数据并尝试在 3 次重试(每隔 5 分钟一次)时段内重新发送数据。
如果 FedEx 在指定时间范围内没有收到成功的响应,FedEx 将停止该特定事件的重新投递。但是,客户可以通过 Advanced Integrated Visibility Webhook 项目详情页面上的手动“重试”按钮,请求获取过去 7 天内的错过事件。
有关重试政策的更多信息,请参阅 重试机制 部分。
Response