客户列表 - 铱云开放API 2.0

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

codes

array[string]

机构编码

可选

currentPage

integer <int32>

页码默认值: 1

可选

customerCategoryIds

array[integer <int64>]

可选

根据客户分类id批量查询客户信息

fillDefaultWarehouseInfo

boolean

可选

是否填充默认仓库信息：ERP同步客户信息使用，默认false

modifyTimeBegin

string <date-time>

更新开始时间

可选

modifyTimeEnd

string <date-time>

更新结束时间

可选

pageSize

integer <int32>

可选

每页数量默认值: 20，最大值: 200

settlementOrgFlag

integer <int32>

可选

结算客户查询标识 0：默认查询所有 1：只查询结算客户

status

integer <int32>

可选

状态:0=禁用，1=启用

userNames

array[string]

用户名

可选

示例

{
  "codes": [
    "string"
  ],
  "currentPage": 0,
  "customerCategoryIds": [
    0
  ],
  "fillDefaultWarehouseInfo": true,
  "modifyTimeBegin": "2019-08-24T14:15:22Z",
  "modifyTimeEnd": "2019-08-24T14:15:22Z",
  "pageSize": 0,
  "settlementOrgFlag": 0,
  "status": 0,
  "userNames": [
    "string"
  ]
}

返回响应

🟢200OK

application/json

Body

address

string

详细地址

可选

areaAddress

string

省市区的结合组成

可选

billDay

string

结算周期

可选

code

string

编码

可选

contactName

string

联系人

可选

createTime

string <date-time>

组织创建时间

可选

customerCategoryId

integer <int64>

客户分类id

可选

customerCategoryName

string

客户分类名称

可选

defaultWarehouseID

integer <int64>

默认发货仓库ID

可选

defaultWarehouseName

string

默认发货仓库名称

可选

defaultWarehouseNumber

string

默认发货仓库编号

可选

deliveryAddress

string

收货联系地址

可选

deliveryAddressDetail

string

收货联系详细地址

可选

deliveryName

string

收货联系人

可选

deliveryPhone

string

收货联系人电话

可选

details

string

详细地址

可选

franchiseTime

string <date-time>

加盟时间

可选

integer <int64>

可选

limitQuota

number

信用额度

可选

logisticsCode

string

物流编码

可选

memo

string

备注

可选

modifyTime

string <date-time>

组织修改时间

可选

name

string

名称

可选

payPeriodTypeName

string

可选

结算模式名称（账期类型名称）

phoneNum

string

联系电话

可选

productAuthorizationName

string

商品授权方案名称

可选

productAuthorizationId

integer <int64>

商品授权方案ID

可选

referrerId

integer <int64>

可选

推荐人id，员工id或客户id

referrerName

string

推荐人名称

可选

referrerType

integer <int32>

可选

推荐人类型：0.无推荐人 1.员工 2.客户

regionId

integer <int64>

区域id

可选

regionName

string

所属区域名

可选

repaymentDay

string

付款日/付款期限

可选

routeId

integer <int64>

路线id

可选

routeName

string

路线名称

可选

salesName

string

业务员姓名

可选

sourceType

integer <int32>

可选

客户来源类型：1.手工创建 2.ERP同步 3.员工拉新(员工葵花码) 4.客户推荐(小程序链接) 5.微信搜索 6.扫码注册(组织葵花码) 7.批量导入

status

integer <int32>

可选

状态 1开启 0禁用

userName

string

机构账号

可选

irObjects

object

可选

自定义字段Key-Value键值对, key见自定义字段apiName

示例

{
  "address": "string",
  "areaAddress": "string",
  "billDay": "string",
  "code": "string",
  "contactName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "customerCategoryId": 0,
  "customerCategoryName": "string",
  "defaultWarehouseID": 0,
  "defaultWarehouseName": "string",
  "defaultWarehouseNumber": "string",
  "deliveryAddress": "string",
  "deliveryAddressDetail": "string",
  "deliveryName": "string",
  "deliveryPhone": "string",
  "details": "string",
  "franchiseTime": "2019-08-24T14:15:22Z",
  "id": 0,
  "limitQuota": 0,
  "logisticsCode": "string",
  "memo": "string",
  "modifyTime": "2019-08-24T14:15:22Z",
  "name": "string",
  "payPeriodTypeName": "string",
  "phoneNum": "string",
  "productAuthorizationName": "string",
  "productAuthorizationId": 0,
  "referrerId": 0,
  "referrerName": "string",
  "referrerType": 0,
  "regionId": 0,
  "regionName": "string",
  "repaymentDay": "string",
  "routeId": 0,
  "routeName": "string",
  "salesName": "string",
  "sourceType": 0,
  "status": 0,
  "userName": "string",
  "irObjects ": {}
}