收货地址信息接口

新增收货地址信息

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/address/v1/addReceiveAddress/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求包体:

{
    "cm_id": "CM0001",
    "cm_waiqin365_id": "苏果夫子庙店",
    "cm_code": "suguo_fzmd",
    "deliverys": [
        {
            "address_id": "1",
            "cm_delivery_main": "0",
            "cm_delivery_name": "张三1111",
            "cm_delivery_tel": "523658222295",
            "cm_delivery_phone": "13052125555",
            "cm_delivery_addr": "江苏省南京市南京路XXXX号",
            "cm_delivery_ex1":"",
            "cm_delivery_ex2":"",
            "cm_delivery_ex3":""
        }
    ]
}

参数说明:

参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:有效字符说明
cm_waiqin365_id VARCHAR(100) 外勤365客户唯一标识
cm_code VARCHAR(32) 客户编码,状态为正常的客户编码唯一,有效字符详见附录:有效字符说明
deliverys[].address_id VARCHAR(32) 收货地址唯一标识,来源于第三方系统的唯一收货地址标识
deliverys[].cm_delivery_main VARCHAR(1) 是否为默认收获地址,0-否 1-是,默认值:0
deliverys[].cm_delivery_name VARCHAR(32) 收货人名称
deliverys[].cm_delivery_tel VARCHAR(32) 收货电话
deliverys[].cm_delivery_phone VARCHAR(32) 收货手机号
deliverys[].cm_delivery_addr VARCHAR(32) 收货地址
deliverys[].cm_delivery_ex1 VARCHAR(200) 收货地址扩展字段1
deliverys[].cm_delivery_ex2 VARCHAR(200) 收货地址扩展字段2
deliverys[].cm_delivery_ex3 VARCHAR(200) 收货地址扩展字段3

返回结果:

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

修改收货地址信息

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/address/v1/modifyReceiveAddress/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求包体:

{
    "cm_id": "CM0001",
    "cm_name": "苏果夫子庙店",
    "cm_code": "suguo_fzmd",
    "deliverys":[{
        "address_id":"NJTDXC",
        "cm_delivery_main":"1",
        "cm_delivery_name":"张三",
        "cm_delivery_tel":"52365895",
        "cm_delivery_phone":"13052125555",
        "cm_delivery_addr":"南京路XXXX号",
        "cm_delivery_ex1":"",
        "cm_delivery_ex2":"",
        "cm_delivery_ex3":""
    }]
}

参数说明:

参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:有效字符说明
cm_waiqin365_id VARCHAR(32) cm_id和cm_waiqin365_id 按照cm_waiqin365_id、cm_id的顺序有效, 并且至少提供一个
cm_code VARCHAR(32) 客户编码,有效字符详见附录:有效字符说明
deliverys[].address_id VARCHAR(32) 收货地址唯一标识,来源于第三方系统的唯一收货地址标识
deliverys[].cm_delivery_main VARCHAR(1) 是否为默认收获地址,0-否 1-是,默认值:0
deliverys[].cm_delivery_name VARCHAR(32) 收货人名称
deliverys[].cm_delivery_tel VARCHAR(32) 收货电话
deliverys[].cm_delivery_phone VARCHAR(32) 收货手机号
deliverys[].cm_delivery_addr VARCHAR(32) 收货地址
deliverys[].cm_delivery_ ex1 VARCHAR(200) 收货地址扩展字段1
deliverys[].cm_delivery_ ex2 VARCHAR(200) 收货地址扩展字段2
deliverys[].cm_delivery_ ex3 VARCHAR(200) 收货地址扩展字段3

返回结果:

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

删除收货地址信息

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/address/v1/removeReceiveAddress/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求包体:

{
    "cm_id": "082901",
    "cm_waiqin365_id": "8913445946038614084",
    "cm_code": "CUS000000003609",
    "deliverys":[
          {
            "address_id":"test001",
            "address_waiqin365_id": "8297111851472788530"
          }
    ]
}

参数说明:

参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:有效字符说明
cm_waiqin365_id VARCHAR(32) cm_id和cm_waiqin365_id 按照cm_waiqin365_id、cm_id的顺序有效, 并且至少提供一个
cm_code VARCHAR(32) 客户编码,有效字符详见附录:有效字符说明
deliverys[].address_id VARCHAR(32) 收货地址唯一标识,来源于第三方系统的唯一收货地址标识
deliverys[].address_id VARCHAR(32) 外勤365收货地址唯一标识

返回结果:

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

推送收货地址信息

客户/门店/经销商的收货地址信息发生变化时向第三方系统推送数据 请求方式: POST(HTTPS
请求地址: 第三方服务接口URL

dataType=cm_receive_address
{
    "cm_id": "082901",
    "deliverys":[
          {
            "address_id":"test001",
            "cm_delivery_main": "0",
            "address_waiqin365_id": "8297111851472788530",
            "mss_province": "350000",
            "mss_city": "350900",
            "mss_area": "350922",
            "mss_street": "350922104",
            "province": "福建",
            "city": "宁德市",
            "area": "古田县",
            "street": "鹤塘镇",
            "cm_delivery_addr": "13131",
            "cm_delivery_name": "kk",
            "cm_delivery_phone": "122222222222",
            "cm_delivery_tel": "122222222222",
            "status": "1"
          }
    ]
}

参数说明:

参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:有效字符说明
deliverys[].address_id VARCHAR(32) 收货地址唯一标识,来源于第三方系统的唯一收货地址标识
deliverys[].cm_delivery_main VARCHAR(32) 是否为默认地址,可选值:0否 1是 当存在门店收货人信息时,此字段默认为0
deliverys[].mss_province VARCHAR(32) 收货地址所属行政区域-省编码
deliverys[].mss_city VARCHAR(32) 收货地址所属行政区域-市编码
deliverys[].mss_area VARCHAR(32) 收货地址所属行政区域-区编码
deliverys[].mss_street VARCHAR(32) 收货地址所属行政区域-街道编码
deliverys[].province VARCHAR(32) 收货地址所属行政区域-省名称
deliverys[].city VARCHAR(32) 收货地址所属行政区域-市名称
deliverys[].area VARCHAR(32) 收货地址所属行政区域-区名称
deliverys[].street VARCHAR(32) 收货地址所属行政区域-街道名称
deliverys[].cm_delivery_addr VARCHAR(32) 收货地址
deliverys[].cm_delivery_name VARCHAR(32) 收货人姓名
deliverys[].cm_delivery_phone VARCHAR(32) 收货人手机
deliverys[].cm_delivery_tel VARCHAR(32) 收货人电话
deliverys[].status VARCHAR(32) 状态,0逻辑删除,1未删除

返回结果:

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明