场景模拟
本页面介绍如何模拟后付费卡物流追踪状态的更新,以测试配送更新流程。这些模拟对于正式验收测试和集成测试非常有用。
说明
这些请求模拟物流追踪状态更新,并返回带有更新后追踪数据的 HTTP 状态。
1 - 模拟物流追踪状态更新
模拟后付费卡物流追踪状态的更新,允许在配送流程的不同状态之间进行转换。更新操作会在物流历史中创建一个新事件。
ENDPOINT
/mock/wallet/WALLET_KEY/card/CARD_KEY/trackingMÉTODO
PATCH路径参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
wallet_key * | string | UUID v4 格式的钱包唯一密钥 | 36 |
card_key * | string | UUID v4 格式的卡片唯一密钥 | 36 |
Request Body
{
"status": "posted",
"place": "São Paulo - SP",
"description": "Postado - logística iniciada",
"reason": "Processamento concluído"
}
请求体字段说明
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
status * | string | 新的物流状态 | status 枚举值 |
place * | string | 事件发生地点 | 100 |
description * | string | 物流事件描述 | 255 |
reason | string | 事件的附加原因(可选) | 100 |
status 枚举值
| 枚举值 | 描述 |
|---|---|
pending | 待处理 - 等待初始处理 |
posted | 已寄出 - 物流已启动 |
prepared | 已备货 - 卡片已准备好转运 |
in_transfer | 转运中 - 卡片在途中 |
in_delivery_unit | 在配送网点 - 卡片已到达配送分发单位 |
on_route | 派送中 - 卡片已出发配送 |
attempt_failed | 尝试失败 - 配送尝试未成功 |
awaiting_withdrawal | 等待自提 - 卡片可供自取 |
returning | 退回中 - 卡片正在退回处理中 |
delivered | 已送达 - 卡片成功送达 |
returned | 已退回 - 卡片已被退回 |
canceled | 已取消 - 物流追踪已取消 |
failed | 失败 - 配送流程失败 |
resend | 重新发送 - 卡片将被重新发送 |
redispatch_error | 重新调度错误 - 重新调度卡片时出错 |
waiting_for_address_update | 等待地址更新 - 等待地址确认 |
Response
STATUS
204Response Body
{}
行为说明
- 模拟操作会更新物流追踪状态并在历史记录中创建新事件
- 状态转换遵循特定顺序并进行验证:
- 不能回退到之前的状态(特殊状态除外)
- 不能从最终状态(
delivered、returned、canceled、failed)更改状态 - 不能将
waiting_for_address_update转换为pending以外的状态 - 不能从最终状态转换为
waiting_for_address_update - 特殊状态(
attempt_failed、resend、redispatch_error)可在初始状态之后随时使用
reason字段为可选项,若提供则会被附加到事件描述中