解码订单包含的敏感数据
接口说明
为保护敏感数据(如收货人昵称、电话号码、详细收货地址),平台对这些信息进行了部分隐藏。通过本接口操作订单后,可以获取到这些信息的完整数据。
注意事项
- 本接口仅适用于已付款的订单;
- 解码操作对订单数量有严格限制。请合理调用,避免不必要的重复请求。超出限制将导致接口报错。对同一订单的多次调用,系统仅计算一次;
- 商家可用基础解码数为30次/日,次日重置,若当日次数不满足使用需通过视频号小店后台申请提额,商家可继续使用通过次数,次日失效。详情可见订单信息解密额度调整上线公告
- 2024年10月21日起逐步重新上线虚拟号功能,解密后获得的虚拟号信息通过virtual_number_info字段返回
接口调用请求说明
请求参数说明
参数 | 类型 | 是否必填 | 描述 |
order_id | string | 是 | 订单id |
请求参数示例
返回参数说明
参数 | 类型 | 描述 |
errcode | number | 错误码 |
errmsg | string | 错误信息 |
address_info | Object AddressInfo | 收货信息,具体枚结构请参考AddressInfo结构体 |
virtual_number_info | Object VirtualNumberInfo | 虚拟号信息,具体结构参考 VirtualNumberInfo结构体 |
返回参数示例
错误码
错误码 | 错误描述 |
公共错误码 | - |
10020123 | 订单解码数达到当月限制 |
10020124 | 未完成支付的订单不支持API解码操作 |
结构体
AddressInfo
收货信息
字段名 | 类型 | 描述 |
user_name | string | 收货人姓名 |
postal_code | string | 邮编 |
province_name | string | 省份 |
city_name | string | 城市 |
county_name | string | 区 |
detail_info | string | 详细地址 |
national_code | string | 国家码 |
tel_number | string | 联系方式 , 如果使用了虚拟号,该字段为脱敏电话号码 |
house_number | string | 门牌号码 |
virtual_order_tel_number | string | 虚拟发货订单联系方式,在发货方式为无需快递(deliver_method=1)时返回 |
VirtualNumberInfo
虚拟号信息
字段名 | 类型 | 描述 |
virtual_number | string | 虚拟号 |
extension | string | 分机号 |
expiration | number | 过期时间戳 |