客户运营能力客户运营能力

更新时间:2021/06/29 GMT+08:00
分享

查询邮寄地址

功能介绍

客户可以查询自己的邮寄地址信息。

客户登录费用中心“发票管理”的“收件地址”区域,单击“管理收件地址”,即可查看邮寄地址。

接口约束

该接口可以使用客户AK/SK或者Token调用。

调试

您可以在API Explorer中直接运行调试该接口。

URI

GET /v2/customers/postal-addresses

表1 查询参数

参数

是否必选

参数类型

取值范围

描述

offset

Integer

-

偏移量。默认值为0。

limit

Integer

[1-1000]

每次查询的个数。默认值为10。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/customers/postal-addresses?offset=0&limit=10 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。

具体请参考状态码。只有失败才返回该字段。

error_msg

String

最大长度:1000

错误描述信息。只有失败才返回该字段。

postal_address

List<CustomerPostalAddressV2>

-

邮寄地址,具体参见表2

total_count

Integer

-

邮寄地址的个数,只有成功的时候才返回。

表2 CustomerPostalAddressV2

参数

参数类型

取值范围

描述

address_id

String

最大长度:64

邮寄地址ID。

recipient

String

最大长度:256

收件人姓名。

nationality

String

最大长度:64

国家。例如:中国

province

String

最大长度:64

省/自治区/直辖市。例如:江苏省。

city

String

最大长度:64

市/区。例如:南京市。

district

String

最大长度:64

区。例如:雨花区。

address

String

最大长度:256

邮寄详细地址。

zipcode

String

最大长度:32

邮编。

areacode

String

最大长度:10

国家码。例如:

中国:0086

mobile_phone

String

最大长度:32

手机号码,不带国家码。

is_default

Integer

-

是否默认地址,默认为0。

  • 1:默认地址
  • 0:非默认地址

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 
{
    "total_count": 1,
    "postal_address": [
        {
            "address_id": "769377db380c4038a16b4667bbb12265",
            "recipient": "name",
            "nationality": "中国",
            "province": "北京市",
            "city": "北京市",
            "district": "东城区",
            "address": "地址",
            "zipcode": "100000",
            "areacode": "0086",
            "mobile_phone": "13215151515",
            "is_default": 1
        }
    ]
}

状态码

HTTP状态码

错误码

错误描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品