API开放平台

TIP

# 收货地址信息接口

# 新增收货地址信息

请求方式： 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_mss_province": "320000",
            "cm_delivery_mss_city": "320100",
            "cm_delivery_mss_area": "320104",
            "cm_delivery_mss_street": "320105007",
            "cm_delivery_province": "江苏省",
            "cm_delivery_city": "南京市",
            "cm_delivery_area": "建邺区",
            "cm_delivery_street": "黄河大道",
            "cm_delivery_ex1":"",
            "cm_delivery_ex2":"",
            "cm_delivery_ex3":""
        }
    ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 是 来源于第三方的客户唯一标识，和勤策的客户唯一标识不能同时为空
cm_waiqin365_id VARCHAR(100) 是 勤策的客户唯一标识，和第三方的客户唯一标识不能同时为空。cm_id、cm_waiqin365_id如果同时存在优先取cm_waiqin365_id
cm_code VARCHAR(32) 是 客户编码，状态为正常的客户编码唯一，有效字符详见附录：有效字符说明 (opens new window)
deliverys List 否 收货信息列表
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_mss_province VARCHAR(32) 否 收货地址所属行政区域-省编码，取标准行政区划代码，如是直辖市，省和市请传一样的值。如果编码与名称同时存在，优先解析编码；行政区划父级必须存在
deliverys.cm_delivery_mss_city VARCHAR(32) 否 收货地址所属行政区域-市编码，取标准行政区划代码，如是直辖市，省和市请传一样的值
deliverys.cm_delivery_mss_area VARCHAR(32) 否 收货地址所属行政区域-区县编码，取标准行政区划代码，如是直筒子市，市和县请传一样的值
deliverys.cm_delivery_mss_street VARCHAR(32) 否 收货地址所属行政区域-乡镇街道编码，取标准行政区划代码
deliverys.cm_delivery_province VARCHAR(32) 否 收货地址所属行政区域-省名称，如是直辖市，省和市请传一样的值
deliverys.cm_delivery_city VARCHAR(32) 否 收货地址所属行政区域-市名称，如是直辖市，省和市请传一样的值
deliverys.cm_delivery_area VARCHAR(32) 否 收货地址所属行政区域-区县名称，如是直筒子市，市和县请传一样的值
deliverys.cm_delivery_street 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：失败。其他详见附录错误码说明 (opens new window)
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_mss_province": "320000",
        "cm_delivery_mss_city": "320100",
        "cm_delivery_mss_area": "320104",
        "cm_delivery_mss_street": "320105007",
        "cm_delivery_province": "江苏省",
        "cm_delivery_city": "南京市",
        "cm_delivery_area": "建邺区",
        "cm_delivery_street": "黄河大道",
        "cm_delivery_ex1":"",
        "cm_delivery_ex2":"",
        "cm_delivery_ex3":""
    }]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方的客户唯一标识，和勤策的客户唯一标识不能同时为空，有效字符详见附录：有效字符说明 (opens new window)
cm_waiqin365_id VARCHAR(32) 否 勤策的客户唯一标识，和第三方的客户唯一标识不能同时为空。cm_id、cm_waiqin365_id 如果同时存在优先取cm_waiqin365_id
cm_code VARCHAR(32) 否 客户编码，有效字符详见附录：有效字符说明 (opens new window)
deliverys List 否 收货信息列表
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_mss_province VARCHAR(32) 否 收货地址所属行政区域-省编码，取标准行政区划代码，如是直辖市，省和市请传一样的值。如果编码与名称同时存在，优先解析编码；行政区划父级必须存在
deliverys.cm_delivery_mss_city VARCHAR(32) 否 收货地址所属行政区域-市编码，取标准行政区划代码，如是直辖市，省和市请传一样的值
deliverys.cm_delivery_mss_area VARCHAR(32) 否 收货地址所属行政区域-区县编码，取标准行政区划代码，如是直筒子市，市和县请传一样的值
deliverys.cm_delivery_mss_street VARCHAR(32) 否 收货地址所属行政区域-乡镇街道编码，取标准行政区划代码
deliverys.cm_delivery_province VARCHAR(32) 否 收货地址所属行政区域-省名称，如是直辖市，省和市请传一样的值
deliverys.cm_delivery_city VARCHAR(32) 否 收货地址所属行政区域-市名称，如是直辖市，省和市请传一样的值
deliverys.cm_delivery_area VARCHAR(32) 否 收货地址所属行政区域-区县名称，如是直筒子市，市和县请传一样的值
deliverys.cm_delivery_street 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：失败。其他详见附录错误码说明 (opens new window)
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) 否 来源于第三方的客户唯一标识，和勤策的客户唯一标识不能同时为空。有效字符详见附录：有效字符说明 (opens new window)
cm_waiqin365_id VARCHAR(32) 否 勤策的客户唯一标识，和第三方的客户唯一标识不能同时为空。cm_id、cm_waiqin365_id如果同时存在优先取cm_waiqin365_id
cm_code VARCHAR(32) 否 客户编码，有效字符详见附录：有效字符说明 (opens new window)
deliverys List 否 收货信息列表
deliverys.address_id VARCHAR(32) 否 收货地址唯一标识，来源于第三方系统的唯一收货地址标识
deliverys.address_waiqin365_id VARCHAR(32) 否 勤策收货地址唯一标识

响应示例：

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

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 推送收货地址信息

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

dataType=cm_receive_address

{
    "cm_id": "082901",
    "cm_source_id": "A190",
    "cm_code": "CUS138767",
    "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) 是 客户唯一标识，有效字符详见附录：有效字符说明 (opens new window)
cm_source_id VARCHAR(32) 是 来源于第三方的客户唯一标识，和勤策的客户唯一标识不能同时为空
cm_code VARCHAR(32) 是 客户编码
deliverys List 否 收货信息列表
deliverys.address_id VARCHAR(32) 否 收货地址唯一标识，来源于第三方系统的唯一收货地址标识
deliverys.address_waiqin365_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：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 查询收货地址信息

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/address/v1/queryReceiveAddress/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "cm_id": "CM0001",
    "cm_waiqin365_id": "12356788",
    "cm_code": "suguo_fzmd"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 来源于第三方的客户唯一标识，和勤策（原外勤365）的客户唯一标识、客户编码不能同时为空
cm_waiqin365_id VARCHAR(32) 否 勤策（原外勤365）的客户唯一标识，和第三方的客户唯一标识、客户编码不能同时为空
cm_code VARCHAR(32) 否 客户编码，和勤策（原外勤365）的客户唯一标识、第三方的客户唯一标识不能同时为空，勤策客户唯一标识、第三方客户唯一标识、客户编码同时出现时，取值优先级依次降低

响应示例：

{
 "cm_id":6967251007830766432,
 "cm_wainqin365_id":"4725889539710871801",
 "code":"CUS000074",
 "deliverys":[
  {
   "area":"西城区",
   "mss_province":110000,
   "city":"北京",
   "cm_deliverys_main":"0",
   "address_id":null,
   "cm_delivery_addr":"北京市西城区广安门外街道勤策小区",
   "cm_delivery_phone":"13777777777",
   "mss_area":110102,
   "mss_city":110000,
   "cm_delivery_name":"11",
   "province":"北京",
   "cm_delivery_tel":"13777777777",
   "street":"广安门外街道",
   "address_waiqin365_id":8905258093452499835,
   "cm_delivery_ex3":null,
   "mss_street":110102020,
   "cm_delivery_ex2":null,
   "cm_delivery_ex1":null
  }
 ]
}

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 来源于第三方的客户唯一标识
cm_waiqin365_id VARCHAR(100) 勤策（原外勤365）的客户唯一标识
cm_code VARCHAR(32) 客户编码，状态为正常的客户编码唯一，有效字符详见附录：有效字符说明 (opens new window)
deliverys List 收货信息列表
deliverys.address_id VARCHAR(32) 勤策（原外勤365）收货地址唯一标识
deliverys.cm_delivery_main VARCHAR(1) 是否为默认地址。0：否，1：是
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_mss_province VARCHAR(32) 收货地址所属行政区域-省编码
deliverys.cm_delivery_mss_city VARCHAR(32) 收货地址所属行政区域-市编码
deliverys.cm_delivery_mss_area VARCHAR(32) 收货地址所属行政区域-区县编码/span>
deliverys.cm_delivery_mss_street VARCHAR(32) 收货地址所属行政区域-乡镇街道编码
deliverys.cm_delivery_province VARCHAR(32) 收货地址所属行政区域-省名称
deliverys.cm_delivery_city VARCHAR(32) 收货地址所属行政区域-市名称
deliverys.cm_delivery_area VARCHAR(32) 收货地址所属行政区域-区县名称
deliverys.cm_delivery_street 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 String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

← 客户收货方关系维护接口 →