接口说明

该接口提供给第三方平台或是卖家自有系统校验国家、州、城市、邮编信息。

接口名称

winit.tools.zipcode.validate

使用场景

卖家使用下出库单前可以通过该接口验证城市和邮编校验是否正确，减少因错误的城市和邮编产生订单校验不通过的情况。

请求说明

请求内容	说明
URL	https://openapi.winit.com.cn/openapi/service
接口测试	https://sandboxopenapi.winit.com.cn/openapi/service
验证方法	Token,md5
格式	json
字符编码	UTF-8
http请求方式	http
请求数限制	默认每分钟1000，1000有需要可申请加大。

请求入参

名称	类型	必填	说明
country	String(64)	Y	国家支持 ISO国家码/国家名称，忽略大小写仅支持美国（US、United States）、英国（GB、United Kingdom）、加拿大(CA、Canada)和澳大利亚(AU、Auustralia)的邮编库校验。
state	String(128)	N	州支持州编码/州名称，忽略大小写暂不支持英国的州校验，国家为GB时，即使填写也会被忽略，仅校验邮编。
city	String(64)	Y	城市支持城市名称，忽略大小写暂不支持英国的城市校验，国家为GB时非必填，即使填写也会被忽略，仅校验邮编。
zipcode	String(32)	Y	邮编忽略大小写

请求示例

{
    "action": "winit.tools.zipcode.validate",
    "app_key": "rebecca",
    "client_id": "ODJKMDU1YZCTYJQ5YY00ZWZLLTK5N2QTOWY4MZI5OGMWNDG2",
    "client_sign": "15972C5334CCC7AB588DA3AAD284DD8D",
    "data": {
        "country": "us",
        "state": "fl",
        "city": "mayo",
        "zipcode": "32066"
    },
    "format": "json",
    "language": "zh_CN",
    "platform": "OWNERERP",
    "sign": "FD66831E7AF15BC13DA4B0C7AD38FC06",
    "sign_method": "md5",
    "timestamp": "2015-06-16 00:19:26",
    "version": "1.0"
}

返回出参

返回参数说明：正确的返回编码code：0及结果data，错误的返回错误码及错误信息msg。

名称	类型	必填	说明	示例
result	String	Y	校验结果 Success：校验成功 Failed：校验失败 NotSupport：不支持校验	Success
resultMsg	String	N	不通过原因 1.[国家不存在]输入的国家[XX]在邮编库中不存在，请核实后再提交。 2.[不支持校验]输入的国家[XX]暂不支持邮编库校验，但不影响您通过该地址下订单。 3.[邮编不存在]输入的邮编[XX]在邮编库中不存在。 4.[邮编格式错误]美国邮编由5位数字或者5位数字-4位数字组成，请您修改后重试。 5.[地址信息错误]未匹配到准确的城市信息，请参考基于邮编查询的[recommendList]
recommendList	Array	Y	推荐信息,以下为子节点校验成功：返回入参的国家、州、城市+修正格式后的邮编校验失败：基于国家+邮编，返回万邑通邮编库推荐的城市List
–\|country	String	Y	国家
–\|state	String	N	州暂不支持英国的州校验，国家为GB时，返回空
–\|city	String	Y	城市暂不支持英国的城市校验，国家为GB时，返回空
–\|zipcode	String	Y	邮编针对美国、英国、加拿大，系统会基于该国的官方邮编规则修正格式。例如：美国补足5位，英国在倒数第4位增加空格，加拿大在正数第4位增加空格

返回示例

{
    "code": "0",
    "msg": "操作成功",
    "data": {
        "result": "Success",
        "resultMsg": null,
        "recommendList": [
            {
                "country": "us",
                "state": "fl",
                "city": "mayo",
                "zipcode": "32066"
            }
        ]
    }
}

关键词