接口说明

该接口提供给第三方平台或是卖家自有系统。

使用场景

卖家使用Ontrac区域派送供应商，可以通过该接口验证收货人地址是否正确，并获取建议地址用于修正。减少因地址错误产生地址修正附加费或包裹投递失败。

接口名称

winit.tools.address.addressValid

请求说明

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

请求入参

名称	类型	必填	说明
type	string	Y	校验类型，目前只支持ONTRAC
country	String	Y	ISO国家码
city	String	Y	城市
zipcode	String	Y	邮编
street	String	Y	街道
street2	String	N	街道2
state	String	Y	州

请求示例

{
    "action": "winit.tools.address.addressValid",
    "app_key": "rebecca",
    "data": {
        "type":"ONTRAC",
        "state":"California",
        "city": "Hawthorne",
        "country": "United States of America",
        "street": "13825 CRENSHAW",
        "street2": " BLV",
        "zipcode": "90250-7814"
    },
    "format": "json",
    "language": "zh_CN",
    "platform": "OWNERERP",
    "sign": "00000000000000000000000000000000",
    "sign_method": "md5",
    "timestamp": "2015-06-16 00:19:26",
    "version": "1.0"
}

返回出参

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

名称	类型	必传	说明	示例
valid	Boolean	Y	校验结果	true-通过 false-不通过
errorMessage	String	Y	错误信息
suggestionList	Object	N	建议地址列表
–\|streetNumberLow	String	Y	最小街道号
–\|streetNumberHigh	String	Y	最大街道号
–\|streetSide	String	Y	streetSide
–\|streetNumber	String	Y	街道号
–\|streetName	String	Y	街道
–\|country	String	Y	国家
–\|city	String	Y	城市
–\|postalCode	String	Y	邮编
–\|percentage	String	Y	相似度
–\|state	String	Y	州
scrubbedAddress	Object		结构化地址，无需使用
–\|streetAddress	String	Y	结构化地址，无需使用
–\|roomSuiteFloor	String	Y	结构化地址，无需使用
–\|isBusiness	String	Y	结构化地址，无需使用
–\|addressQuality	String	Y	结构化地址，无需使用
–\|scrubbedLogic	String	Y	结构化地址，无需使用
–\|country	String	Y	结构化地址，无需使用
–\|city	String	Y	结构化地址，无需使用
–\|postalCode	String	Y	结构化地址，无需使用
–\|state	String	Y	结构化地址，无需使用
–\|timeZone	String	Y	结构化地址，无需使用

返回示例

{
    "code": "0",
    "msg": "操作成功",
    "data": {
        "valid": false,
        "errorMessage": null,
        "suggestions": [
            {
                "streetNumberLow": "13801",
                "streetNumberHigh": "13899",
                "streetSide": "Odd",
                "streetNumber": "13825",
                "streetName": "CRENSHAW BLVD",
                "country": "US",
                "city": "HAWTHORNE",
                "postalCode": "90250",
                "percentage": 95,
                "state": "CA"
            }
        ],
        "scrubbedAddress": {
            "streetAddress": "13825 CRENSHAW BLV",
            "roomSuiteFloor": "",
            "isBusiness": true,
            "addressQuality": 0,
            "scrubbedLogic": "     ",
            "country": "US",
            "city": "HAWTHORNE",
            "postalCode": "90250-7814",
            "state": "CA",
            "timeZone": "America/Los_Angeles"
        },
        "error": false
    }
}

关键词