POST /open/api/v1/orders/:id/address

鉴权:接入方后台 HMAC

调用方:接入方后台

功能描述

发货前把履约订单的收货地址改成最新地址。路径里的 id 可以是小鹅订单号,也可以是接入方订单号。已发货、已完成、已取消或已退款的订单不能改。重复提交同一地址会覆盖为同一份快照。

参数

路径参数

属性类型默认值必填说明
idstring是小鹅订单号或接入方订单号。

Object object

属性类型默认值必填说明
receiver_namestring是收货人姓名,最长 64。
receiver_phonestring是收货人手机号,最长 20。
provincestring是省,最长 32。
citystring是市,最长 32。
districtstring否区,最长 32。
detail_addressstring是详细地址,最长 200。
postal_codestring否邮编,最长 16。

返回值

成功时 code 为 0,下面的字段在 data 里。

Object data

属性类型默认值必填说明
order_nostring是小鹅订单号。
partner_order_nostring否接入方订单号。
order_statusstring是订单状态。
pay_statusstring是支付状态。
addressObject是更新后的收货地址。
address.receiver_namestring是收货人姓名。
address.receiver_phonestring是收货人手机号。
address.provincestring是省。
address.citystring是市。
address.districtstring否区。
address.detail_addressstring是详细地址。
address.postal_codestring否邮编。

示例代码

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 号"
}'