订单收件人信息
POST
/ark/open_api/v3/common_controller错误码 | 错误码描述 | |
---|---|---|
-2000400 | 请求参数错误 | |
-2000500 | 系统调用异常 |
请求参数
Body 参数application/json
receiverQueries
array [object {3}]
必需
收件人详情查询列表,上限20,请务必在发货前调用一次避免用户修改导致不一致
packageId
string
订单号
openAddressId
string
必需
详情接口返回,标识此单收件人信息
orderId
string
可选
isReturn
string
是否是换货单
示例
{
"receiverQueries": [
{
"orderId": "P132***4125",
"openAddressId": "1948201"
}
],
"isReturn": ""
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
receiverInfos
array [object {9}]
必需
收件人信息列表,仅待发货有内容,加密数据通过解密接口获取
packageId
string
包裹号 用来对应
matched
boolean
可选
当前openAddressId是否与传入的相符,不相符时不返回相关信息,且需要重新 拉取订单详情
receiverProvinceName
string
收件人省份
receiverCityName
string
收件人城市
receiverDistrictName
string
收件人区县
receiverTownName
string
收件人镇/街道
receiverName
string
收件人姓名
receiverPhone
string
收件人电话
receiverAddress
string
收件人详细地址
示例
{
"receiverInfos": [
{
"orderId": "P132***4125",
"matched": true,
"receiverProvinceName": "浙江",
"receiverCityName": "杭州市",
"receiverDistrictName": "西湖区",
"receiverTownName": "xx街道",
"receiverName": "张三",
"receiverPhone": "123456789",
"receiverAddress": "XX路XX号"
}
]
}
最后修改时间: 1 年前