# 收货地址信息接口

# 新增收货地址信息

请求方式: POST(HTTPS
请求地址: https://openapi.qince.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 响应说明

# 新增收货地址 V2.0

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/receiverAddress/v2/add/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "cm_id": "CM0001",
  "cm_waiqin365_id": "8456966831710658547",
  "cm_code": "suguo_fzmd",
  "receiverAddrs": [
    {
      "is_main": "1",
      "receive_name": "name20",
      "receive_tel": "12345623",
      "receive_phone": "12345678917",
      "receive_addr": "江苏省南京市建邺区勤策",
      "mss_province": "320000",
      "mss_city": "320100",
      "mss_area": "320104",
      "mss_street": "110101001",
      "province": "江苏省",
      "city": "南京市",
      "area": "建邺区",
      "street": "雨润大街",
      "exts" : [
        {
          "key" : "field_5IDu0__c",
          "value" : "12341234"
        }
      ]
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
cm_id VARCHAR(32) 来源于第三方的客户唯一标识。和勤策的客户唯一标识、客户编码不能同时为空
cm_waiqin365_id VARCHAR(32) 勤策的客户唯一标识,和第三方的客户唯一标识、客户编码不能同时为空。三者同时存在,优先取勤策客户id>三方唯一标识id>客户编码
cm_code VARCHAR(32) 客户编码,和第三方的客户唯一标识、勤策客户id不能同时为空。三者同时存在,优先取勤策客户id>三方唯一标识id>客户编码
receiverAddrs List 收货地址列表支持同时新增多个收货地址
receiverAddrs.is_main VARCHAR(32) 是否默认地址
receiverAddrs.receive_name VARCHAR(32) 收货人姓名,收货人姓名不能包含特殊字符,必须为中文、数字、大小写英文字母、下划线的组合
receiverAddrs.receive_phone VARCHAR(32) 收货人手机号
receiverAddrs.receive_tel VARCHAR(32) 固定电话
receiverAddrs.receive_addr VARCHAR(32) 详细地址
receiverAddrs.mss_province VARCHAR(32) 收货地址所属行政区域-省编码,取标准行政区划代码,如是直辖市,省和市请传一样的值。如果编码与名称同时存在,优先解析编码;行政区划父级必须存在
receiverAddrs.mss_city VARCHAR(32) 收货地址所属行政区域-市编码,取标准行政区划代码,如是直辖市,省和市请传一样的值。如果编码与名称同时存在,优先解析编码;行政区划父级必须存在
receiverAddrs.mss_area VARCHAR(32) 收货地址所属行政区域-区县编码,取标准行政区划代码,如是直筒子市,市和县请传一样的值
receiverAddrs.mss_street VARCHAR(32) 收货地址所属行政区域-乡镇街道编码,取标准行政区划代码
receiverAddrs.province VARCHAR(32) 收货地址所属行政区域-省名称,如是直辖市,省和市请传一样的值
receiverAddrs.city VARCHAR(32) 收货地址所属行政区域-市名称,如是直辖市,省和市请传一样的值
receiverAddrs.area VARCHAR(32) 收货地址所属行政区域-区县名称,如是直筒子市,市和县请传一样的值
receiverAddrs.street VARCHAR(32) 收货地址行政区域-乡镇街道名称
receiverAddrs.exts List 自定义字段列表
receiverAddrs.exts.key VARCHAR(32) 自定义字段key
receiverAddrs.exts.value VARCHAR(4000) 自定义字段值,企业根据apaas的入参格式传入【企微文档】aPaaS字段格式梳理修订版(最终版)https://doc.weixin.qq.com/sheet/e3_AEgAyQYKAOgu0zqoE6dSoukncdDQj?scode=ABAAEQcdAA0Ms61Lt3AY4A6AabABI&tab=e9r8s0

响应示例:

{
  "msg_id": "X000001",
  "return_code": 0,
  "return_msg": "",
  "response_data": "[6387865969297701131]"
}

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 新增成功的收货地址id列表

# 修改收货地址信息

请求方式: POST(HTTPS
请求地址: https://openapi.qince.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 响应说明

# 修改收货地址 V2.0

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/receiverAddress/v2/modify/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "id" : "9170558002644740959",
  "cm_waiqin365_id": "8456966831710658547",
  "cm_code": "suguo_fzmd",
  "cm_id": "CM0001",
  "is_main": "1",
  "receive_name": "name19_1",
  "receive_tel": "1234567",
  "receive_phone": "12345678900",
  "receive_addr": "江苏省南京市建邺区勤策",
  "mss_province": "320000",
  "mss_city": "320100",
  "mss_area": "320104",
  "mss_street": "",
  "province": "江苏省",
  "city": "南京市",
  "area": "建邺区",
  "street": "雨润大街",
  "exts": [
    {
      "key": "field_5IDu0__c",
      "value": "11111111"
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 收货地址id
cm_id VARCHAR(32) 来源于第三方的客户唯一标识。和勤策的客户唯一标识、客户编码不能同时为空
cm_waiqin365_id VARCHAR(32) 勤策的客户唯一标识,和第三方的客户唯一标识、客户编码不能同时为空。三者同时存在,优先取勤策客户id>三方唯一标识id>客户编码
cm_code VARCHAR(32) 客户编码,和第三方的客户唯一标识、勤策客户id不能同时为空。三者同时存在,优先取勤策客户id>三方唯一标识id>客户编码
is_main VARCHAR(32) 是否默认地址
receive_name VARCHAR(32) 收货人姓名,收货人姓名不能包含特殊字符,必须为中文、数字、大小写英文字母、下划线的组合
receive_phone VARCHAR(32) 收货人手机号
receive_tel VARCHAR(32) 固定电话
receive_addr VARCHAR(32) 详细地址
mss_province VARCHAR(32) 收货地址所属行政区域-省编码,取标准行政区划代码,如是直辖市,省和市请传一样的值。如果编码与名称同时存在,优先解析编码;行政区划父级必须存在
mss_city VARCHAR(32) 收货地址所属行政区域-市编码,取标准行政区划代码,如是直辖市,省和市请传一样的值。如果编码与名称同时存在,优先解析编码;行政区划父级必须存在
mss_area VARCHAR(32) 收货地址所属行政区域-区县编码,取标准行政区划代码,如是直筒子市,市和县请传一样的值
mss_street VARCHAR(32) 收货地址所属行政区域-乡镇街道编码,取标准行政区划代码
province VARCHAR(32) 收货地址所属行政区域-省名称,如是直辖市,省和市请传一样的值
city VARCHAR(32) 收货地址所属行政区域-市名称,如是直辖市,省和市请传一样的值
area VARCHAR(32) 收货地址所属行政区域-区县名称,如是直筒子市,市和县请传一样的值
street VARCHAR(32) 收货地址行政区域-乡镇街道名称
exts List 自定义字段列表
exts.key VARCHAR(32) 自定义字段key
exts.value VARCHAR(4000) 自定义字段值,企业根据apaas的入参格式传入【企微文档】aPaaS字段格式梳理修订版(最终版)https://doc.weixin.qq.com/sheet/e3_AEgAyQYKAOgu0zqoE6dSoukncdDQj?scode=ABAAEQcdAA0Ms61Lt3AY4A6AabABI&tab=e9r8s0

响应示例:

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

参数说明:

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

# 删除收货地址信息

请求方式: POST(HTTPS
请求地址: https://openapi.qince.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.qince.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 响应说明

# 查询收货地址 V2.0

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/receiverAddress/v2/query/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "cm_id": "CM0001",
  "cm_waiqin365_id": "8456966831710658547",
  "cm_code": "suguo_fzmd",
  "sorts" : [
    {
      "field_key" : "create_time",
      "type" : "desc"
    }
  ],
  "page" : 1,
  "rows" : 100,
  "query_group" : [
    {
      "connector" : "and",
      "filters" : [{
        "field_key" : "is_main",
        "operator" : "EQ",
        "field_values" : ["1"]
      }
      ]
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
cm_id VARCHAR(32) 来源于第三方的客户唯一标识。和勤策的客户唯一标识、客户编码不能同时为空
cm_waiqin365_id VARCHAR(32) 勤策的客户唯一标识,和第三方的客户唯一标识、客户编码不能同时为空。三者同时存在,优先取勤策客户id>三方唯一标识id>客户编码
cm_code VARCHAR(32) 客户编码,和第三方的客户唯一标识、勤策客户id不能同时为空。三者同时存在,优先取勤策客户id>三方唯一标识id>客户编码
sorts List 排序
field_key VARCHAR(32) 排序字段
type VARCHAR(32) 排序类型:asc 正序,desc 倒序
page VARCHAR(32) 页数,默认值为1
rows VARCHAR(32) 条数,默认值为100
query_group List 查询条件列表
query_group.connector VARCHAR(32) 组内查询条件,条件AND或OR
query_group.filters List 组内查询条件
query_group.filters.field_key VARCHAR(32) 字段key
query_group.filters.operator VARCHAR(32) 操作符,详见附录操作符说明(opens new window)
query_group.filters.field_values VARCHAR(4000) 字段值集合

响应示例:

[
  {
    "mss_province": "320000",
    "city": "南京市",
    "modify_time": "2024-12-20 14:42:01",
    "mss_area": "320104",
    "receive_phone": "{\"code\":\"86\",\"phone\":\"12345678900\"}",
    "province": "江苏省",
    "modifyier_id": "998",
    "receive_name": "name19_1",
    "receive_tel": "1234567",
    "id": "9170558002644740959",
    "area": "秦淮区",
    "mss_street": "110101001",
    "street": "雨润大街",
    "create_time": "2024-12-20 14:39:45",
    "mss_city": "320100",
    "receive_addr": "江苏省南京市建邺区勤策",
    "cm_id": "8456966831710658547",
    "cm_name": "DT00000041",
    "cm_code": "DT00000041",
    "is_main": "1",
    "creator_id": "998",
    "creator_name": "系统服务器",
    "status": "1",
    "exts" : [
      {
        "key" : "field_5IDu0__c",
        "value" : "11111111"
      }
    ]
  }
]

参数说明:

参数 类型 说明
id String 勤策的收货地址唯一标识
cm_id String 勤策客户id
cm_name String 客户名
cm_code String 客户编码
receive_name String 收货人姓名
receive_phone String 收货人手机号
receive_tel String 固定电话
status String 状态
is_main String 是否默认收货地址 0-否;1-是
mss_province String 收货地址所属行政区域-省编码
mss_city String 收货地址所属行政区域-市编码
mss_area String 收货地址所属行政区域-区编码
mss_street String 收货地址所属行政区域-街道编码
province String 收货地址所属行政区域-省名称
city String 收货地址所属行政区域-市名称
area String 收货地址所属行政区域-区名称
street String 收货地址所属行政区域-街道名称
receive_addr String 详细地址
exts List 自定义字段列表
exts.key String 自定义字段key
exts.value String 自定义字段value

参数说明:

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