POST /open/api/v1/orders/:id/address
鉴权:接入方后台 HMAC
调用方:接入方后台
功能描述
发货前把履约订单的收货地址改成最新地址。路径里的 id 可以是小鹅订单号,也可以是接入方订单号。已发货、已完成、已取消或已退款的订单不能改。重复提交同一地址会覆盖为同一份快照。
参数
路径参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
id | string | 是 | 小鹅订单号或接入方订单号。 |
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
receiver_name | string | 是 | 收货人姓名,最长 64。 | |
receiver_phone | string | 是 | 收货人手机号,最长 20。 | |
province | string | 是 | 省,最长 32。 | |
city | string | 是 | 市,最长 32。 | |
district | string | 否 | 区,最长 32。 | |
detail_address | string | 是 | 详细地址,最长 200。 | |
postal_code | string | 否 | 邮编,最长 16。 |
返回值
成功时 code 为 0,下面的字段在 data 里。
Object data
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
order_no | string | 是 | 小鹅订单号。 | |
partner_order_no | string | 否 | 接入方订单号。 | |
order_status | string | 是 | 订单状态。 | |
pay_status | string | 是 | 支付状态。 | |
address | Object | 是 | 更新后的收货地址。 | |
address.receiver_name | string | 是 | 收货人姓名。 | |
address.receiver_phone | string | 是 | 收货人手机号。 | |
address.province | string | 是 | 省。 | |
address.city | string | 是 | 市。 | |
address.district | string | 否 | 区。 | |
address.detail_address | string | 是 | 详细地址。 | |
address.postal_code | string | 否 | 邮编。 |
示例代码
curlbash
# 先设置 CHANNEL_ACCESS_KEY、CHANNEL_SECRET_KEY,并按接口说明计算 signature
curl --request POST 'https://api.channel.suiinn.com/open/api/v1/orders/YD202601010001/address' \
--header 'X-Channel-Key: $CHANNEL_ACCESS_KEY' \
--header 'X-Channel-Timestamp: $timestamp' \
--header 'X-Channel-Nonce: $nonce' \
--header 'X-Channel-Signature: $signature' \
--header 'Content-Type: application/json' \
--data-raw '{
"receiver_name": "小鹅",
"receiver_phone": "13800000000",
"province": "广东省",
"city": "广州市",
"district": "天河区",
"detail_address": "体育东路 1 号"
}'