1. 属性模块API

API URL

post {HTTP(S)地址}/api/{version}/property

1.1. 自定义栏位列表查询接口

1.1.1. SERVICE_TYPE

CUSTOMER_FIELD_QUERY

1.1.2. 请求参数

参数	是否必须	类型	示例	备注
tableName	Y	String	SYS_ITEM	SYS_ITEM：系统商品自定义栏位； SYS_ORDER：订单自定义栏位； SYS_ODO：出库单自定义栏位； SYS_ASN：入库单自定义栏位。
columType	N	String	NUMBER	筛选不同填入类型的自定义栏位 NUMBER：数字； DATE：日期； STRING：字符串； SELECT：下拉框。
columName	N	String	生产日期	用户自己定义的栏位名称
required	N	Number	1	是否只查询必填栏位 1:true;0:false
isQuery	N	Number	1	是否只查询支持查询的栏位 1:true;0:false
isShow	N	Number	1	是否只查询支持列配置的栏位 1:true;0:false

1.1.3. 返回参数

参数	是否必须	类型	示例	备注
errorCode	Y	String	“DATA_INPUT_ERROR”	错误码
errorMsg	Y	String	“输入参数不对”	业务错误信息
state	Y	String	success	请求结果
total	Y	Number	100	总条数
result	Y	List		店铺信息,详情查看下表

CustomeField(自定义栏位)

参数	是否必须	类型	示例	备注
id	N	Long	3	自定义栏位的ID,用于创建订单等使用
tableName	Y	String	SYS_ITEM	SYS_ITEM：系统商品自定义栏位； SYS_ORDER：订单自定义栏位； SYS_ODO：出库单自定义栏位； SYS_ASN：入库单自定义栏位。
columType	Y	String	NUMBER	筛选不同填入类型的自定义栏位 NUMBER：数字； DATE：日期； STRING：字符串； SELECT：下拉框。
columName	Y	String	生产日期	用户自己定义的栏位名称
defaultValue	N	String	"1970/01/01"(无双引号)	自定义栏位默认值
candidateValue	N	String	["1970/01/01","1970/01/02"]	下拉框的候选值
remark	N	String	上架日期区分于出厂日期	备注
required	N	Integer	1	是否只查询必填栏位 1:true;0:false
isQuery	N	Integer	1	是否只查询支持查询的栏位 1:true;0:false
isShow	N	Integer	1	是否只查询支持列配置的栏位 1:true;0:false

2. 供应商模块API

API URL

post {HTTP(S)地址}/api/{version}/supplier

2.1. 供应商查询接口（预计2025-08-15上线）

2.1.1. SERVICE_TYPE

QUERY_SUPPLIER_LIST

2.1.2. 请求参数

参数	是否必须	类型	示例	备注
name	N	String	浪马	供应商名称，精确查询
purchaserUserName	N	String	张三	采购员用户名（精确查询）
category	N	String	COMMON	供应商类型，见枚举
enable	N	Boolean	true	供应商是否启用，true为启用，false为停用
createTimeFrom	N	String	格式：yyyy-MM-dd HH:mm:ss，例如：2021-08-01 00:00:00	创建时间（范围开始）
createTimeTo	N	String	格式：yyyy-MM-dd HH:mm:ss，例如：2021-08-01 23:00:00	创建时间（范围结束）
page	Y	Number	1	页码，默认1
pageSize	Y	Number	100	每页条数，不超过200条

2.1.3. 返回参数

参数	是否必须	类型	示例	备注
name	Y	String	供应商A	供应商名称
level	N	String	A	供应商等级，见枚举
categoryOneName	N	String	一级品类名称	一级品类名称
categoryTwoName	N	String	二级品类名称	二级品类名称
categoryThreeName	N	String	三级品类名称	三级品类名称
purchaserName	N	String	张三	采购员姓名
purchaserUserName	N	String	zhangsan	采购员用户名
settlementWay	N	String	DELIVERY_ON_CASH	结算方式类型，见枚举
accountPeriodList	N	String	[{"days":"1","percent":70}]	账期列表
accountPeriodOpt	N	String	MONTHLY	账期选项，当选择的结算方式是固定账期FIXED_ACCOUNT_PERIOD时，参数有值。该字段目前只有MONTHLY一个枚举值，意为月结
billingDate	N	String	30	出账日.当选择的结算方式是固定账期FIXED_ACCOUNT_PERIOD时，参数有值。范围1<=param<=31
effectiveNode	N	String	RECEIVE	生效节点,见枚举. 当选择的结算方式是动态账期DYNAMIC_ACCOUNT_PERIOD或固定账期FIXED_ACCOUNT_PERIOD时，参数必传。
paymentWay	N	String	CASH	付款方式，见枚举
prepayRate	N	Number	30	预付款比例
transportParty	N	String	SUPPLIER	运费承担方，见枚举
defectiveProductResolution	N	String	PURCHASER_UNDERTAKING	不良品处理方式，见枚举
contacts	N	String	张三	联系人
contactsInfo	N	String	133333333333	联系方式
contactsAddress	N	String	某村3号	详细地址
province	N	String	浙江	省份
city	N	String	杭州	城市
supplySource	N	String	中国杭州	货源地
legalRepresentative	N	String		法定代表人
entrustedAgent	N	String		委托代理人
depositBank	N	String		开户银行
account	N	String		银行账号
enable	Y	Boolean	true	供应商是否启用
remark	N	String		备注
category	N	String	COMMON	供应商类别，见枚举
createTime	Y	String	格式：yyyy-MM-dd HH:mm:ss，例如：2021-08-01 00:00:00	创建时间
updateTime	Y	String	格式：yyyy-MM-dd HH:mm:ss，例如：2021-08-01 00:00:00	更新时间
country	N	String	CN	国家，见枚举

2.2. 供应商创建接口（预计2025-08-15上线）

2.2.1. SERVICE_TYPE

CREATE_SUPPLIER

2.2.2. 请求参数

参数	是否必须	类型	示例	备注
category	Y	String	COMMON	供应商类别，见枚举
categoryOneName	N	String	一级品类名称	一级品类名称
categoryTwoName	N	String	二级品类名称	二级品类名称
categoryThreeName	N	String	三级品类名称	三级品类名称
name	Y	String	供应商A	供应商名称
level	N	String	A	供应商等级，见枚举
purchaserUserName	Y	String	zhangsan	采购员用户名（非姓名）
contacts	N	String	张三	联系人，不超过50个字符
contactsInfo	N	String	133333333333	联系方式，不超过255个字符
province	N	String	浙江	省份，不超过50个字符
country	N	String	CN	国家，见枚举
city	N	String	杭州	城市，不超过50个字符
contactsAddress	N	String	某村3号	详细地址，不超过255个字符
supplySource	N	String	中国杭州	货源地，不超过50个字符
authorization	N	Boolean	true	是否授权所有用户该供应商
authUserNameList	N	List	['zhangsan','lisi']	如不选择授权所有用户，也就是authorization为false时，该字段指定待授权的用户名列表（非姓名）
settlementWay	Y	String	DELIVERY_ON_CASH	结算方式，见枚举该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
effectiveNode	N	String	RECEIVE	生效节点，当选择的结算方式是动态账期DYNAMIC_ACCOUNT_PERIOD或固定账期FIXED_ACCOUNT_PERIOD时，参数必传。见枚举。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
accountPeriodList	N	String	系统支持多账期模式。例如，供应商合同约定预付30%，收货付款60%，收货后30天付款10%，则应设置：● 账期1：0天，60%● 账期2：30天，10% 此时当前参数应传：[{"days":"0","percent":"60"},{"days":"30","percent":"10"}]，并将 prepayRate 设为 30	当选择的结算方式是动态账期DYNAMIC_ACCOUNT_PERIOD时，参数必传。Percent+预付比例需要是100 。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
accountPeriodOpt	N	String	MONTHLY	账期选项，当选择的结算方式是固定账期FIXED_ACCOUNT_PERIOD时，参数有值。该字段目前只有MONTHLY一个枚举值，意为月结。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
billingDate	N	String	30	出账日.当选择的结算方式是固定账期FIXED_ACCOUNT_PERIOD时，参数有值。范围1<=param<=31。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
paymentWay	Y	String	CASH	付款方式，见枚举。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
prepayRate	N	Number	30	预付款比例，最多保留小数点后四位该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
transportParty	Y	String	SUPPLIER	运费承担方，见枚举。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
defectiveProductResolution	Y	String	PURCHASER_UNDERTAKING	不良品处理方式，见枚举。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
legalRepresentative	N	String		法定代表人，不超过255个字符。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
entrustedAgent	N	String		委托代理人，不超过255个字符。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
depositBank	N	String		开户银行，不超过255个字符。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
account	N	String		开户账号，不超过255个字符。该参数当供应商类型为1688供应商时无需填写,为普通供应商按照要求填写
remark	N	String		备注，不超过2000个字符。

2.2.3. 返回参数

参数	是否必须	类型	示例	备注
errorCode	Y	String	“DATA_INPUT_ERROR”	错误码
errorMsg	Y	String	“输入参数不对”	业务错误信息
state	Y	String	success	请求结果

2.3. 供应商商品查询接口（预计2025-08-15上线）

2.3.1. SERVICE_TYPE

QUERY_SUPPLIER_SKU_LIST

2.3.2. 请求参数

参数	是否必须	类型	示例	备注
sku	N	String	SKU001	sku，精确查询
title	N	String	ONESKU	sku名称，精确查询
category	N	String	COMMON	供应商类型，见枚举，默认查询普通供应商
supplierName	N	String	供应商A	供应商名称，精确查询
defaultPurchaserUserName	N	String	zhangsan	默认采购员用户名（精确查询）
relationStatus	N	String	UNMAPPING	供应商选择1688供应商时该参数有效，1688 供应商商品是否已关联平台下拉的商品规格。供应商对应类型，取值见枚举（如：UNMAPPING 表示未关联）。
createTimeFrom	N	String	格式：yyyy-MM-dd HH:mm:ss，例如：2021-08-01 00:00:00	创建时间（范围开始）
createTimeTo	N	String	格式：yyyy-MM-dd HH:mm:ss，例如：2021-08-01 23:00:00	创建时间（范围结束）
page	Y	Number	1	页码，默认1
pageSize	Y	Number	每页条数，不超过200条	每页条数，不超过200条

2.3.3. 返回参数

参数	是否必须	类型	示例	备注
sku	Y	String	SKU001	商品SKU编码，暂不支持组合品类型的sku
title	Y	String	ONESKU	SKU名称
description	N	String	示例商品描述	商品描述
skuSupplierList	N	List		供应商商品列表

skuSupplierList字段内参数说明（OpenApiSkuSupplierResponse）

参数	是否必须	类型	示例	备注
defaultPurchaserName	N	String	张三	默认采购员姓名
defaultPurchaserUserName	N	String	zhangsan	默认采购员用户名
category	Y	String	COMMON	供应商类型，见枚举
deliveryCycle	Y	Long	1	预计交期（天）
purchaseMethod	N	String	BULK	采购方式，见枚举
defaultValue	N	String	Y	是否默认供应商,枚举值为Y、N。Y为是，N为否
purchasePriceUnit	N	String	CNY	采购价格单位。货币单位，见枚举
drawbackRate	N	BigDecimal	3.0	退税税率（%）
purchaseTaxRate	N	BigDecimal	3.0	采购税率（%）
purchasePrice	N	String	100.50	采购价格（字符串格式避免精度丢失）
minimumPurchaseQuantity	N	Long	1	最小采购量
supplierName	N	String	供应商A	供应商名称
associatedName	N	String	1688商品名称	关联的1688平台的商品名称

2.4. 供应商商品创建接口（预计2025-08-15上线）

2.4.1. SERVICE_TYPE

CREATE_SUPPLIER_SKU

2.4.2. 请求参数

参数	是否必须	类型	示例	备注
sku	Y	String	SKU001	商品SKU编码，暂不支持组合品类型的sku
supplierName	Y	String	供应商A	供应商名称，该接口会根据供应商的类型决定创建普通供应商还是1688供应商
defaultPurchaserUserName	Y	String	张三	默认采购员用户名
deliveryCycle	Y	Number	1	预计交期（天）
purchaseMethod	Y	String	BULK	采购方式，见枚举
minimumPurchaseQuantity	N	Number	1	最小采购量，默认值为1，最小为1
purchasePrice	N	Number	100.50	采购单价，默认为0，采购价为空时币种为CNY，最多保留小数点后四位
purchasePriceUnit	N	String	CNY	采购价格单位。货币单位，见枚举
purchaseTaxRate	N	Number	3.0	采购税率（%），该参数已自动附带“%”，调用方无需传入“%”符号，仅传数值即可，默认值为0，最多保留小数点后两位
drawbackRate	N	Number	3.0	退税率（%），该参数已自动附带“%”，调用方无需传入“%”符号，仅传数值即可，默认值为0，最多保留小数点后两位
purchaseUrl	N	String	https://detail.1688.com/offer/782726.html?spm=q.84423.0.0.3aae4	采购链接地址，不超过1024个字符
isDefault	N	Number	1	是否为默认供应关系（1是，0否），默认为0

2.4.3. 返回参数

参数	是否必须	类型	示例	备注
errorCode	Y	String	“DATA_INPUT_ERROR”	错误码
errorMsg	Y	String	“输入参数不对”	业务错误信息
state	Y	String	success	请求结果

自定义栏位