跳到主要内容

场景模拟

本页面介绍如何模拟后付费卡物流追踪状态的更新,以测试配送更新流程。这些模拟对于正式验收测试和集成测试非常有用。

说明

这些请求模拟物流追踪状态更新,并返回带有更新后追踪数据的 HTTP 状态。

1 - 模拟物流追踪状态更新

模拟后付费卡物流追踪状态的更新,允许在配送流程的不同状态之间进行转换。更新操作会在物流历史中创建一个新事件。

ENDPOINT
/mock/wallet/WALLET_KEY/card/CARD_KEY/tracking
MÉTODO
PATCH

路径参数

字段类型描述字符数
wallet_key *stringUUID v4 格式的钱包唯一密钥36
card_key *stringUUID 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
reasonstring事件的附加原因(可选)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
204
Response Body
{}
行为说明
  • 模拟操作会更新物流追踪状态并在历史记录中创建新事件
  • 状态转换遵循特定顺序并进行验证:
    • 不能回退到之前的状态(特殊状态除外)
    • 不能从最终状态(deliveredreturnedcanceledfailed)更改状态
    • 不能将 waiting_for_address_update 转换为 pending 以外的状态
    • 不能从最终状态转换为 waiting_for_address_update
    • 特殊状态(attempt_failedresendredispatch_error)可在初始状态之后随时使用
  • reason 字段为可选项,若提供则会被附加到事件描述中