Appearance

供应商管理 API ​

1. 接口概述 ​

供应商管理 API 提供了供应商的查询功能。通过这些接口，您可以获取系统中的供应商列表信息，支持按供应商编码、名称等条件进行筛选。

2. 接口列表 ​

接口名方法功能描述
supplier.getListPOST获取供应商列表
supplier.getDetailPOST获取供应商详情

3. 系统级参数 ​

系统级参数是调用所有接口都必须提供的参数：

参数名类型必填名称描述
flagstring是应用标识用于标识调用方身份
methodstring是接口方法名例如：supplier.getList
vernumber是版本号固定为1
charsetstring是字符集固定为utf-8
typestring是返回格式固定为json
timestampstring是时间戳格式：yyyyMMddHHmmss
signstring是签名用于验证请求的合法性

4. 接口详细说明 ​

4.1 获取供应商列表 ​

请求参数 ​

参数名类型必填描述
supplier_namestring否供应商名称
supplier_bnstring否供应商编码
start_timestring否创建时间开始，格式：2022-01-01
end_timestring否创建时间结束，格式：2022-01-31
page_noint是页码，默认1
page_sizeint是每页条数，默认50，最大1000

响应参数 ​

参数名类型描述
countint总记录数
listsarray供应商列表

lists 数组中的每个对象包含以下字段：

参数名类型描述
supplier_idstring供应商ID
supplier_bnstring供应商编码
supplier_namestring供应商名称
short_namestring简称
create_timestring创建时间
supplier_levelstring供应商等级
statusstring状态（1:启用 2:禁用）
status_textstring状态描述

请求示例 ​

请参考openapi.md文档中【6. 接口调用示例】。

响应示例 ​

json
{
  "count": 100,
  "lists": [
    {
      "supplier_id": "10001",
      "supplier_bn": "SUP001",
      "supplier_name": "测试供应商",
      "short_name": "测试供应",
      "create_time": "2022-01-01 10:00:00",
      "supplier_level": "A级",
      "status": "1",
      "status_text": "启用"
    }
  ]
}

4.2 获取供应商详情 ​

请求参数 ​

参数名类型必填描述
supplier_idstring否供应商ID
supplier_bnstring否供应商编码

响应参数 ​

参数名类型描述
supplier_idstring供应商ID
supplier_bnstring供应商编码
supplier_namestring供应商名称
short_namestring简称
supplier_levelstring供应商等级
statusstring状态
status_textstring状态描述
create_timestring创建时间
update_timestring更新时间
contactsarray联系人信息
address_infoarray地址信息
bank_infoarray银行信息

contacts 数组中的每个对象包含以下字段：

参数名类型描述
namestring联系人姓名
positionstring职位
phonestring电话
mobilestring手机
emailstring邮箱
is_defaultstring是否默认联系人（1:是 0:否）

address_info 数组中的每个对象包含以下字段：

参数名类型描述
address_idstring地址ID
consigneestring收货人
mobilestring手机
telstring电话
countrystring国家
provincestring省
citystring市
districtstring区
addressstring详细地址
zipstring邮政编码
is_defaultstring是否默认地址（1:是 0:否）

bank_info 数组中的每个对象包含以下字段：

参数名类型描述
account_idstring账号ID
account_namestring账户名称
account_numberstring账号
bank_namestring开户银行
bank_branchstring开户支行
is_defaultstring是否默认账户（1:是 0:否）

请求示例 ​

请参考openapi.md文档中【6. 接口调用示例】。

响应示例 ​

json
{
  "supplier_id": "10001",
  "supplier_bn": "SUP001",
  "supplier_name": "测试供应商",
  "short_name": "测试供应",
  "supplier_level": "A级",
  "status": "1",
  "status_text": "启用",
  "create_time": "2022-01-01 10:00:00",
  "update_time": "2022-01-02 10:00:00",
  "contacts": [
    {
      "name": "张三",
      "position": "经理",
      "phone": "021-12345678",
      "mobile": "13800138000",
      "email": "zhangsan@example.com",
      "is_default": "1"
    }
  ],
  "address_info": [
    {
      "address_id": "20001",
      "consignee": "张三",
      "mobile": "13800138000",
      "tel": "021-12345678",
      "country": "中国",
      "province": "上海市",
      "city": "上海市",
      "district": "浦东新区",
      "address": "张杨路500号",
      "zip": "200120",
      "is_default": "1"
    }
  ],
  "bank_info": [
    {
      "account_id": "30001",
      "account_name": "测试供应商有限公司",
      "account_number": "6222021234567890123",
      "bank_name": "中国工商银行",
      "bank_branch": "上海浦东支行",
      "is_default": "1"
    }
  ]
}

5. 错误码说明 ​

错误码错误信息解决方案
0成功-
1参数错误检查参数格式是否正确，所有必填参数是否都已提供
400参数错误检查参数格式是否正确，所有必填参数是否都已提供
401未授权访问检查flag和sign是否正确
403禁止访问联系管理员获取权限
500服务器内部错误检查请求参数或联系技术支持
1001非法的flag请检查flag是否正确
1002请求已过期请检查timestamp是否正确，请求有效期为5分钟
1003签名错误请检查签名算法和参数是否正确
1004不支持的type格式请使用json格式
2001缺少必要的参数请检查请求参数是否完整
2002非法的请求参数请检查参数格式和范围是否正确
2003接口不存在请检查接口方法名是否正确

6. 注意事项 ​

  1. 时间格式必须为 yyyy-MM-dd HH:mm:ss，否则可能导致查询失败。
  2. page_size 参数最大支持 1000，默认50，超过100将被限制为 100。
  3. 对于大数据量的查询，建议使用供应商名称、供应商编码等条件进行精确筛选，以提高查询效率。
  4. 时间戳必须与服务器时间保持同步，误差不超过3600秒。
  5. 每个请求必须生成唯一的签名，避免重复提交。
  6. 请妥善保管接口密钥，避免泄露。
  7. 所有请求参数中的特殊字符必须进行 URL 编码，特别是在使用 GET 方法时。
  8. 请确保在请求头中设置正确的 Content-Type，对于 POST 请求建议使用 application/json。
  9. 为了系统性能和稳定性，请避免短时间内发送大量请求，建议控制调用频率。
  10. 敏感数据（如签名、密钥等）请勿在日志中记录，确保数据安全。