查询客户 - C300-OpenAPI

请求参数

Path 参数

viewKey

string

必需

Body 参数application/json

conditions

object (CUSTOMER_filter)

可选

code

object

可选

唯一编码（不可编辑）(支持精确、集合查询)

name

object

可选

名称(支持精确、集合查询)

sorts

object (CUSTOMER_sort)

可选

fieldKeys

array[string]

可选

查询字段：为空则返回所有字段

paging

object

必需

start

integer

分页开始

必需

>= 0

length

integer

分页大小

必需

>= 1<= 500

示例

{
  "conditions": {
    "code": {
      "conditionType": "KEYWORD",
      "value": "string"
    },
    "name": {
      "conditionType": "KEYWORD",
      "value": "string"
    }
  },
  "sorts": {},
  "fieldKeys": [
    "string"
  ],
  "paging": {
    "start": 0,
    "length": 1
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://c2.xinheyun.com/api/open/v3/CUSTOMER/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "conditions": {
        "code": {
            "conditionType": "KEYWORD",
            "value": "string"
        },
        "name": {
            "conditionType": "KEYWORD",
            "value": "string"
        }
    },
    "sorts": {},
    "fieldKeys": [
        "string"
    ],
    "paging": {
        "start": 0,
        "length": 1
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

可选

message

string

可选

data

object

可选

list

array[object (CUSTOMER) {31}]

可选

start

integer

可选

length

integer

可选

recordsTotal

integer

可选

示例

{
  "code": 0,
  "message": "string",
  "data": {
    "list": [
      {
        "callingCode": "string",
        "code": "string",
        "enterpriseCategoryNumber": "string",
        "invoiceAddress": "string",
        "bankName": "string",
        "number": "string",
        "attachment": {},
        "countryCode": "string",
        "currency": "string",
        "taxNum": "string",
        "fax": "string",
        "email": "string",
        "defaultPayConditionName": "string",
        "bankAccount": "string",
        "bankAccountName": "string",
        "area": "string",
        "enterpriseCategoryName": "string",
        "comments": "string",
        "address": "string",
        "mobile": "string",
        "zipcode": 0,
        "createBy": 0,
        "trade": "string",
        "createTime": 0,
        "phone": "string",
        "name": "string",
        "auditStatus": "string",
        "invoice": "string",
        "invoicePhone": "string",
        "contacts": "string",
        "status": "string"
      }
    ],
    "start": 0,
    "length": 0,
    "recordsTotal": 0
  }
}

🟢201成功

🟠401没有权限

🟠403禁止访问

🟠404记录不存在