API开放平台

TIP

新增商品
修改商品
删除商品
查询商品
查询合并商品包含子商品

# 新增商品

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/product/v1/addProduct/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "prd_id": "PRE009",
    "prd_name": "优酸乳",
    "prd_code": "0YYSR09",
    "prd_short_code": "YSR",
    "prd_barcode": "201603101119",
    "class_name": "乳品,常温奶",
    "prd_spec": "100ml",
    "prd_brand": "卫岗",
    "prd_valid_period": "60",
    "prd_remarks": "特供商品",
    "prd_sequ": 1200,
    "prd_suggest_price": 32.5,
    "prd_cost_price": 15,
    "prd_price": 32.6,
    "prd_sale_status": "1",
    "prd_status": "1",
    "short_name": "",
    "teu_coefficient": "",
    "same_price_code": "",
    "sale_unit_name":"袋",
    "tag_values":"热卖,必铺",
    "is_combo_rule_main_pd":"1",
    "is_change_price":"0",
    "tax_rate":"11",
    "units":
    [
        {
            "name":"瓶",
            "is_base":"1",
            "ratio":1.00000000,
            "bar_code":"20170000000",
            "prd_weight":"500",
            "weight_unit":"g"
            
        },
        {
            "name":"袋",
            "is_base":"0",
            "ratio":12.00000000,
            "bar_code":"20141212121",
            "prd_weight":"200",
            "weight_unit":"g"
        }
    ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
prd_id	VARCHAR(32)	是	商品唯一标识，来源第三方系统的唯一ID
prd_code	VARCHAR(100)	是	商品编码，不允许重复
prd_short_code	VARCHAR(32)	否	助记码
prd_name	VARCHAR(100)	是	商品名称，不允许重复
class_name	VARCHAR(100)	否	商品类型，多层级时使用“,”分割，如：”商品大类,商品中类,商品小类”
prd_spec	VARCHAR (4000)	否	商品规格
prd_brand	VARCHAR (100)	否	品牌
prd_valid_period	INT	否	保质期
prd_valid_period_unit	VARCHAR(32)	否	保质期单位（天，月），默认天
prd_sequ	INT	否	排序号，默认值1000
prd_remarks	VARCHAR(4000)	否	备注
pictures	VARCHAR(4000)	否	商品图片，多个值用“,”分割
store_sale_status	VARCHAR(32)	否	是否商城上架，true/false。
prd_suggest_price	NUMERIC(20,2)	否	建议零售价，单位：元
prd_price	NUMERIC(20,2)	是	基本单位批发价，单位：元
prd_sale_status	CHAR(1)	是	销售状态。0：停售，1：在售
prd_status	CHAR(1)	是	商品状态。1：正常，0：失效
short_name	VARCHAR(255)	否	商品简称
teu_coefficient	NUMERIC(20,8)	否	标箱系数
tray_coefficient	NUMERIC(9,4)	否	托盘系数
same_price_code	VARCHAR(255)	否	同价码
use_stock	VARCHAR(32)	否	启用库存管理。1：启用，0：不启用。不传默认启用
use_batch	VARCHAR(32)	否	启用批次管理。1：启用，0：不启用。不传默认不启用
use_valid_period	VARCHAR(32)	否	启用保质期管理。1：启用，0：不启用。不传默认不启用
use_serial_number	VARCHAR(32)	否	启用序列号管理。1：启用，0：不启用。不传默认不启用
sale_unit_name	VARCHAR(100)	否	销售常用单位。不传默认为基本单位（units列表中is_base=1的单位）。该值须与units列表中name值对应。例如：需要将商品的销售常用单位设"瓶"，如果“瓶”不是基本单位，则入参须设置：sale_unit_name="瓶"，units[{name="瓶",is_base="0"}]
purchase_unit_name	VARCHAR(100)	否	采购常用单位
tag_values	VARCHAR(32)	是	商品标签，多个标签使用“,”分割，如：“新品,热卖”
is_combo_rule_main_pd	VARCHAR(32)	否	组合规则主商品,1:是，0：否，不传默认为否
is_change_price	VARCHAR(32)	否	是否允许改价，0：不允许，1：允许，不传默认为允许
tax_rate	VARCHAR(32)	否	销项税率（%），如果为17%，则传入17即可
units	List	是	注：2021年后接入OPENAPI接口的企业在新增商品时，units列表必传。当is_base=1时，该json对象的值是商品基本单位的相关信息。每个商品新增并选用自己的单位，各商品的单位不共用
units.name	VARCHAR(32)	是	单位名称
units.is_base	VARCHAR(32)	是	是否基本单位。0：否，1：是
units.ratio	VARCHAR(32)	是	换算比，基本单位的换算比固定为1
units.bar_code	VARCHAR(32)	否	条形码
units.length	VARCHAR(32)	否	长必须为数字，最多可以精确到小数点后三位
units.width	VARCHAR(32)	否	宽必须为数字，最多可以精确到小数点后三位
units.height	VARCHAR(32)	否	高必须为数字，最多可以精确到小数点后三位
units.weight	VARCHAR(32)	否	重量小数位不能大于4位
units.weight_unit	VARCHAR(32)	否	重量单位：克/千克/吨
prd_exts	List	否	自定义字段列表
prd_exts.prd_ext_key	VARCHAR(4000)	否	自定义字段key
prd_exts.prd_ext_value	VARCHAR(4000)	否	自定义字段value，多个值用“,”分隔

响应示例：

{
    "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.waiqin365.com/api/product/v1/modifyProduct/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "prd_id": "PRD001",
    "prd_name": "优酸乳01",
    "prd_code": "0YYSR001",
    "prd_short_code": "YSR011",
    "prd_barcode": "201603101116",
    "class_name": "乳品,常温奶",
    "prd_spec": "120ml",
    "prd_brand": "光明",
    "prd_valid_period": "60",
    "prd_remarks": "特供品",
    "prd_sequ": 1201,
    "prd_suggest_price": 12.5,
    "prd_cost_price": 11,
    "prd_price": 12.6,
    "prd_sale_status": "0",
    "prd_status": "1",
    "short_name": "",
    "teu_coefficient": "",
    "same_price_code": "",
    "sale_unit_name":"袋",
    "tag_values":"热卖,必铺",
    "is_change_price":"0",
    "tax_rate":"11",
    "units":
    [
        {
            "name":"瓶",
            "is_base":"1",
            "ratio":1.00000000,
            "bar_code":"20170000000",
            "prd_weight":"500",
            "weight_unit":"g"
            
        },
        {
            "name":"袋",
            "is_base":"0",
            "ratio":12.00000000,
            "bar_code":"20141212121",
            "prd_weight":"200",
            "weight_unit":"g"
        }
    ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
prd_id	VARCHAR(32)	否	来源第三方系统的商品唯一标识，`prd_id`,`id`如果同时存在优先取`id`
id	VARCHAR(32)	否	勤策商品唯一id
prd_code	VARCHAR(100)	否	商品编码
prd_short_code	VARCHAR(32)	否	助记码
prd_name	VARCHAR(100)	否	商品名称
class_name	VARCHAR(100)	否	商品类型,多层级时使用“,”分割，如：”商品大类,商品中类,商品小类”
prd_spec	VARCHAR(4000)	否	商品规格
prd_brand	VARCHAR (100)	否	品牌
prd_valid_period	INT	否	保质期
prd_valid_period_unit	VARCHAR(32)	否	保质期单位（天，月），默认天
prd_sequ	INT	否	排序号
prd_remarks	VARCHAR(4000)	否	备注
pictures	VARCHAR(4000)	否	商品图片，多个值用“,”分割
store_sale_status	VARCHAR(32)	否	是否商城上架，true/false。
prd_suggest_price	NUMERIC(20,2)	否	建议零售价，单位：元
prd_price	NUMERIC(20,2)	否	基本单位批发价，单位：元
prd_sale_status	CHAR(1)	否	销售状态。0：停售，1：在售
prd_status	CHAR(1)	是	商品状态。1：正常，0：删除
short_name	VARCHAR(255)	否	商品简称
teu_coefficient	NUMERIC(20,8)	否	标箱系数，只能是数字
tray_coefficient	NUMERIC(9,4)	否	托盘系数，只能是数字
same_price_code	VARCHAR(255)	否	同价码
sale_unit_name	VARCHAR(100)	否	销售常用单位。该值须与units列表中的name值对应。例如：需要将商品的销售常用单位修改为“瓶”，如果“瓶”不是基本单位，则入参须设置：sale_unit_name="瓶"，units[{name="瓶",is_base="0"}]
purchase_unit_name	VARCHAR(100)	否	采购常用单位
tag_values	VARCHAR(32)	是	商品标签,多个标签使用“,”分割，如：“新品,热卖”,传-1则清除所有标签
is_change_price	VARCHAR(32)	否	是否允许改价，0：不允许，1：允许
tax_rate	VARCHAR(32)	否	销项税率（%），如果为17%，则传入17即可
prd_pkg_unit	VARCHAR(100)	否	大包装单位(该字段已废弃)
prd_pkg_num	INT	否	大包装数量(该字段已废弃)
units	List		列表
units.name	VARCHAR(32)	是	单位名称
units.is_base	VARCHAR(32)	否	是否基本单位。0：否，1：是。基本单位名称不能修改，不传默认是0
units.ratio	VARCHAR(32)	是	换算比，基本单位的换算比固定为1
units.bar_code	VARCHAR(32)	否	条形码
units.length	VARCHAR(32)	否	长必须为数字，最多可以精确到小数点后三位
units.width	VARCHAR(32)	否	宽必须为数字，最多可以精确到小数点后三位
units.height	VARCHAR(32)	否	高必须为数字，最多可以精确到小数点后三位
units.weight	VARCHAR(32)	否	重量小数位不能大于4位
units.weight_unit	VARCHAR(32)	否	重量单位。克/千克/吨
prd_exts.prd_ext_key	VARCHAR(4000)	否	自定义字段key
prd_exts.prd_ext_value	VARCHAR(4000)	否	自定义字段value，多个值用","分隔

响应示例：

{
    "msg_id": "PRD00001",
    "return_code": 0
}

{
    "msg_id": "PRD00001",
    "return_code": 100605,
    "return_msg": "商品ID不存在！值为：空"
}
{
    "msg_id": "PRD00001",
    "return_code": 100602,
    "return_msg": "商品编码已经存在！值为：0YYSR001"
}

参数说明：

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

# 删除商品

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/product/v1/removeProduct/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
prd_id	VARCHAR(32)	是	商品唯一标识

响应示例：

{
    "msg_id": "PRD00001",
    "return_code": 100605,
    "return_msg": "商品ID不存在！值为：空"
}

参数说明：

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

# 查询商品

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/product/v1/queryProduct/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
page_number	INT	否	页码默认1，每页最大1000条
prd_id	VARCHAR(32)	否	商品唯一标识，来源第三方系统的唯一ID
prd_code	VARCHAR(100)	否	商品编码
after_create_time	CHAR(15)	否	创建时间之后。格式：yyyy-MM-dd HH:mm:ss
before_create_time	CHAR(15)	否	创建时间之前。格式：yyyy-MM-dd HH:mm:ss
after_modify_time	CHAR(15)	否	修改时间之后。格式：yyyy-MM-dd HH:mm:ss
before_modify_time	CHAR(15)	否	修改时间之前。格式：yyyy-MM-dd HH:mm:ss
brand_id	VARCHAR(32)	否	品牌唯一标识，来源第三方系统的唯一ID，品牌ID和名称同时存在时，ID优先级大于名称
brand_name	VARCHAR(32)	否	品牌名称，品牌ID和名称同时存在时，ID优先级大于名称
classification	VARCHAR(32)	否	商品分类，0：普通商品，1：助销物料，2：包装物，3：兑换物料。不传即查询所有，多个时用逗号隔开。

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "prd_spec":"1*5[水蜜桃,高糖,500ML]",
        "class_name":"饮料",
        "prd_waiqin365_id":5746956808669247685,
        "prd_name":"20170728003name",
        "with_tag_gift":"赠品",
        "with_tag_sale":"促销",
        "with_tag_hot":"重点",
        "with_tag_ex1":"热卖",
        "with_tag_new":"新品",
        "prd_short_code":"thinkabout",
        "prd_unit":"袋",
        "prd_barcode":"20170000000",
        "prd_code":"20170728003",
        "prd_sale_status":"在售",
        "source_code":"5746956808669247685",
        "prd_price":22.00000000,
        "prd_name_py":"20170728003name 20170728003name",
        "prd_suggest_price":999.00000000,
        "create_time":"2017-07-28 08:57:35",
        "prd_brand":"javascriptyyy",
        "prd_valid_period":800,
        "prd_short_name":"",
        "prd_teu_coefficient":"",
        "prd_same_price_code":"",
        "creator_id":"5280123597799111087",
        "create_name":"hf老板aaa",
        "modifier_time":"2018-03-15 19:06:06",
        "modifyier_name":"jinhao1",
        "modifyier_id":"5918189314149391033",
        "prd_tax_rate": "13.12",
        "prd_is_merge": "1",
        "store_shelf_status": "1",
    "prd_units":[
    {
        "prd_is_base":"1",
        "prd_ratio":1.00000000,
        "prd_barcode":"20170000000",
        "prd_unit_name":"瓶",
        "prd_unit_waiqin365_id":4889802966711221998,
        "prd_waiqin365_id ":5746956808669247685,
        "prd_weight":"500",
        "prd_weight_unit":"g"
    },
    {
        "prd_is_base":"0",
        "prd_ratio":12.00000000,
        "prd_barcode":"20141212121",
        "prd_unit_name":"袋",
        "prd_unit_waiqin365_id":5538415640268400439,
        "prd_waiqin365_id ":5746956808669247685,
        "prd_weight":"200",
        "prd_weight_unit":"g"
    }],
    "prd_exts":[
        {"prd_ext_value":"怎么啥都没有啊","prd_ext_key":"商品质量输入"},
        {"prd_ext_value":"1000","prd_ext_key":"期望价格"},
        {"prd_ext_value":"好吃","prd_ext_key":"单选"},
        {"prd_ext_value":"AAA,SSS,DDD,FFF","prd_ext_key":"多选"},
        {"prd_ext_value":"7688628547624343020","prd_ext_key":"商品单选框"}
        ]
    }
]

异常示例：

{
    "msg_id": "PRD00001",
    "return_code": 1,
    "return_msg": "查询日期格式不合法！"
}

参数说明：

参数	类型	必填	说明
prd_id	VARCHAR(100)	否	商品唯一标识，来源第三方系统的唯一ID
status	VARCHAR(32)	是	删除标志。1：正常，0：删除
prd_waiqin365_id	VARCHAR(32)	是	勤策商品id
prd_code	VARCHAR(100)	否	商品编码
prd_short_code	VARCHAR(200)	否	助记码
prd_barcode	VARCHAR(32)	否	基本单位条形码
prd_name	VARCHAR (100)	否	商品名称
class_id	VARCHAR (100)	是	商品类型唯一ID
class_name	VARCHAR (100)	是	商品类型
class_source_code	VARCHAR (100)	是	第三方系统商品类型唯一标识
class_full_path	VARCHAR (100)	是	商品类型全路径
prd_spec	VARCHAR(4000)	否	商品规格
prd_brand	VARCHAR(100)	否	品牌
prd_unit	VARCHAR(100)	否	单位
prd_valid_period	numeric(15)	否	保质期天数
prd_sequ	numeric(20,2)	否	排序号
prd_remarks	VARCHAR(4000)	否	备注
pictures	VARCHAR(4000)	否	商品图片，多个值用“,”分割
create_time	VARCHAR(32)	是	创建时间。格式：yyyy-MM-dd HH:mm:ss
with_tag_new	VARCHAR(32)	否	"新品"
with_tag_hot	VARCHAR(32)	否	"重点"
with_tag_gift	VARCHAR(32)	否	"赠品"
with_tag_sale	VARCHAR(32)	否	"促销"
with_tag_ex1	VARCHAR(32)	否	"热卖"
prd_suggest_price	numeric(28,8)	否	建议零售价，单位：元
prd_cost_price	numeric(28,8)	否	成本价，单位：元
prd_price	numeric(28,8)	否	基本单位批发价，单位：元
sale_status	CHAR(32)	否	销售状态。0：停售，1：在售
prd_short_name	varchar(4000)	是	商品简称
prd_teu_coefficient	numeric(28,8)	是	商品标箱系数，只能是数字
prd_tray_coefficient	NUMERIC(9,4)	是	商品托盘系数，只能是数字
prd_same_price_code	VARCHAR(100)	是	商品同价码
creator_id	VARCHAR(32)	否	创建人ID
create_name	VARCHAR(32)	否	创建人姓名
modifyier_id	VARCHAR(32)	否	修改人ID
modifyier_name	VARCHAR(32)	否	修改人姓名
modifier_time	VARCHAR(32)	否	修改时间。格式：yyyy-MM-dd HH:mm:ss
prd_tax_rate	numeric(20,2)	否	销项税率
prd_is_merge	VARCHAR(1)	否	是否是铺货合并商品，0：否，1：是
classification	VARCHAR(1)	否	商品分类，0：普通商品，1：助销物料，2：包装物，3：兑换物料
store_shelf_status	VARCHAR(1)	否	是否商城上架，0：否，1：是
base_unit_net_weight	numeric(28,8)	否	基本单位净重
base_unit_net_weight_code	VARCHAR(32)	否	基本单位净重单位，g：克；kg：千克；t：吨
prd_exts	List	否	自定义字段列表
prd_exts.prd_ext_key	VARCHAR(4000)	否	自定义字段key
prd_exts.prd_ext_value	VARCHAR(4000)	否	自定义字段value
prd_units	List		单位列表
prd_units.prd_is_base	VARCHAR(1)	是	是否基本单位。1：基本单位，0：辅助单位
prd_units.prd_ratio	NUMERIC(28,8)	是	换算比，基本单位的换算比固定为1
prd_units.prd_barcode	VARCHAR(100)	否	单位条码
prd_units.prd_unit_name	VARCHAR(32)	是	单位名称
prd_units.prd_unit_waiqin365_id	VARCHAR(32)	是	勤策单位id
prd_units.prd_weight	VARCHAR(32)	否	商品单位中的重量，小数位不能大于4位
prd_units.prd_weight_unit	VARCHAR(32)	否	商品单位中的重量单位名称
prd_report_unit_id	VARCHAR(32)	否	销售常用单位ID
prd_purchase_unit_id	VARCHAR(32)	否	采购常用单位ID
prd_report_unit_name	VARCHAR(32)	否	销售常用单位名称
prd_purchase_unit_name	VARCHAR(32)	否	采购常用单位名称

# 查询合并商品包含子商品

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/product/v1/queryMergeProduct/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
page_number	INT	否	页码默认1，每页最大1000条
prd_id	VARCHAR(32)	否	合并商品唯一标识，来源第三方系统的唯一ID
prd_code	VARCHAR(100)	否	合并商品编码
after_create_time	CHAR(15)	否	创建时间之后。格式：yyyy-MM-dd HH:mm:ss
before_create_time	CHAR(15)	否	创建时间之前。格式：yyyy-MM-dd HH:mm:ss
after_modify_time	CHAR(15)	否	修改时间之后。格式：yyyy-MM-dd HH:mm:ss
before_modify_time	CHAR(15)	否	修改时间之前。格式：yyyy-MM-dd HH:mm:ss

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "prd_waiqin365_id":"5746956808669247685",
        "status":"1",
        "class_name":"饮料",
        "prd_name":"productname",
        "prd_code":"productcode",
        "prd_brand":"brand",
        "sub_products":[
            {
                "prd_waiqin365_id":"6948023915562250808",
                "status":"1",
                "class_name":"饮料",
                "prd_name":"subproductname",
                "prd_code":"subproductcode",
                "prd_brand":"brand"
            }
        ]
    }
]

异常示例：

{
    "msg_id": "PRD00001",
    "return_code": 1,
    "return_msg": "查询日期格式不合法！"
}

参数说明：

参数	类型	必填	说明
prd_id	VARCHAR(100)	否	商品唯一标识，来源第三方系统的唯一ID
status	VARCHAR(32)	是	删除标志。1：正常，0：删除
prd_waiqin365_id	VARCHAR(32)	是	勤策商品id
prd_code	VARCHAR(100)	否	商品编码
prd_name	VARCHAR (100)	否	商品名称
class_id	VARCHAR (100)	是	商品类型唯一ID
class_name	VARCHAR (100)	是	商品类型
class_source_code	VARCHAR (100)	是	第三方系统商品类型唯一标识
class_full_path	VARCHAR (100)	是	商品类型全路径
prd_brand	VARCHAR(100)	否	品牌
sub_products	List		子商品列表
sub_products.prd_id	VARCHAR(100)	否	商品唯一标识，来源第三方系统的唯一ID
sub_products.status	VARCHAR(32)	是	删除标志。1：正常，0：删除
sub_products.prd_waiqin365_id	VARCHAR(32)	是	勤策商品id
sub_products.prd_code	VARCHAR(100)	否	商品编码
sub_products.prd_name	VARCHAR (100)	否	商品名称
sub_products.class_id	VARCHAR (100)	是	商品类型唯一ID
sub_products.class_name	VARCHAR (100)	是	商品类型
sub_products.class_source_code	VARCHAR (100)	是	第三方系统商品类型唯一标识
sub_products.class_full_path	VARCHAR (100)	是	商品类型全路径
sub_products.prd_brand	VARCHAR(100)	否	品牌

← 商品类型接口商品可售范围接口 →