商品信息接口

参数名称 参数值
应用编码 product
应用版本 v1
接口名称 新增商品
接口编码 addProduct
接口URL https://openapi.waiqin365.com/api/product/v1/addProduct/{openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
prd_id VARCHAR(32) 商品唯一标识,来源第三方系统的唯一ID
prd_code VARCHAR(100) 商品编码,不允许重复
prd_short_code VARCHAR(32) 助记码
prd_barcode VARCHAR(32) 基本单位条形码
prd_name VARCHAR(100) 商品名称,不允许重复
class_name VARCHAR(100) 商品类型,多层级时使用“,”分割,
如:”商品大类,商品中类,商品小类”
prd_spec VARCHAR (4000) 商品规格
prd_brand VARCHAR (100) 品牌
prd_unit VARCHAR(100) 单位
prd_pkg_unit VARCHAR(100) 大包装单位
prd_pkg_num INT 大包装数量
prd_bigbarcode VARCHAR(32) 大单位条形码
prd_valid_period INT 保质期天数
prd_weight VARCHAR(32) 重量
prd_sequ INT 排序号,默认值1000
prd_remarks VARCHAR(4000) 备注
with_tag_new VARCHAR(32) 是否新品
with_tag_hot VARCHAR(32) 是否重点
with_tag_gift VARCHAR(32) 是否赠品
with_tag_sale VARCHAR(32) 是否促销
prd_suggest_price NUMERIC(20,2) 建议零售价,单位:元
prd_cost_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) 标箱系数
same_price_code VARCHAR(255) 同价码
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "prd_id": "PRE009",
    "prd_name": "优酸乳",
    "prd_code": "0YYSR09",
    "prd_short_code": "YSR",
    "prd_barcode": "201603101119",
    "class_name": "乳品,常温奶",
    "prd_spec": "100ml",
    "prd_brand": "卫岗",
    "prd_unit": "瓶",
    "prd_pkg_unit": "箱",
    "prd_pkg_num": "12",
    "prd_valid_period": "60",
    "prd_weight": "5kg",
    "prd_remarks": "特供商品",
    "prd_sequ": 1200,
    "with_tag_new": "true",
    "with_tag_hot": "false",
    "with_tag_gift": "false",
    "with_tag_sale": "true",
    "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": ""
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 product
应用版本 v1
接口名称 修改商品
接口编码 modifyProduct
接口URL https://openapi.waiqin365.com/api/product/v1/modifyProduct/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
prd_id VARCHAR(32) 商品唯一标识
prd_code VARCHAR(100) 商品编码
prd_short_code VARCHAR(32) 助记码
prd_barcode VARCHAR(32) 基本单位条形码
prd_name VARCHAR(100) 商品名称
class_name VARCHAR(100) 商品类型,多层级时使用“,”分割,
如:”商品大类,商品中类,商品小类”
prd_spec VARCHAR(4000) 商品规格
prd_brand VARCHAR (100) 品牌
prd_unit VARCHAR (100) 单位
prd_pkg_unit VARCHAR(100) 大包装单位
prd_pkg_num INT 大包装数量
prd_bigbarcode VARCHAR(32) 大单位条形码
prd_valid_period INT 保质期天数
prd_weight VARCHAR(32) 重量
prd_sequ INT 排序号
prd_remarks VARCHAR(4000) 备注
with_tag_new VARCHAR(32) 是否新品,默认 false
with_tag_hot VARCHAR(32) 是否重点,默认 false
with_tag_gift CHAR(1) 是否赠品,默认 false
with_tag_sale VARCHAR(32) 是否促销,默认 false
prd_suggest_price NUMERIC(20,2) 建议零售价,单位:元
prd_cost_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) 标箱系数
same_price_code VARCHAR(255) 同价码
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "prd_id": "PRD001",
    "prd_name": "优酸乳01",
    "prd_code": "0YYSR001",
    "prd_short_code": "YSR011",
    "prd_barcode": "201603101116",
    "class_name": "乳品,常温奶",
    "prd_spec": "120ml",
    "prd_brand": "光明",
    "prd_unit": "盒",
    "prd_pkg_unit": "板",
    "prd_pkg_num": "12",
    "prd_valid_period": "60",
    "prd_weight": "2kg",
    "prd_remarks": "特供品",
    "prd_sequ": 1201,
    "with_tag_new": "false",
    "with_tag_hot": "true",
    "with_tag_gift": "true",
    "with_tag_sale": "false",
    "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": ""
}

// 正常响应信息示例:
{
    "msg_id": "PRD00001",
    "return_code": 0
}

// 异常响应信息示例:
{
    "msg_id": "PRD00001",
    "return_code": 100605,
    "return_msg": "商品ID不存在!值为:空"
}
{
    "msg_id": "PRD00001",
    "return_code": 100602,
    "return_msg": "商品编码已经存在!值为:0YYSR001"
}
                  
参数名称 参数值
应用编码 product
应用版本 v1
接口名称 删除商品
接口编码 removeProduct
接口URL https://openapi.waiqin365.com/api/product/v1/removeProduct/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
prd_id VARCHAR(32) 商品唯一标识
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "prd_id": "PRD001"
}

// 正常响应信息示例:
{
    "msg_id": "PRD00001",
    "return_code": 0
}

// 异常响应信息示例:
{
    "msg_id": "PRD00001",
    "return_code": 100605,
    "return_msg": "商品ID不存在!值为:空"
}
                  
参数名称 参数值
应用编码 product
应用版本 v1
接口名称 查询商品
接口编码 queryProduct
接口URL https://openapi.waiqin365.com/api/product/v1/queryProduct/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
page_number INT 页码默认1,每页最大1000条
prd_id VARCHAR(32) 商品唯一标识,来源第三方系统的唯一ID
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”
响应信息 参照表响应信息格式
prd_id VARCHAR(100) 商品唯一标识,来源第三方系统的唯一ID
prd_waiqin365_id VARCHAR(32) 外勤商品id
prd_code VARCHAR(100) 商品编码
prd_short_code VARCHAR(200) 助记码
prd_barcode VARCHAR(32) 基本单位条形码
prd_name VARCHAR (100) 商品名称
class_name VARCHAR (100) 商品类型
prd_spec VARCHAR(4000) 商品规格
prd_brand VARCHAR(100) 品牌
prd_unit VARCHAR(100) 单位
prd_valid_period numeric(15) 保质期天数
prd_weight VARCHAR(32) 重量
prd_sequ numeric(20,2) 排序号
prd_remarks VARCHAR(4000) 备注
create_time TIMESTAMP 创建时间
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) 单价,单位:元
prd_sale_status CHAR(1) 销售状态:0:停售 1、在售
prd_short_name varchar(4000) 商品简称
prd_teu_coefficient numeric(28,8) 商品标箱系数
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 TIMESTAMP 修改时间
prd_exts
prd_exts[].prd_ext_key VARCHAR(4000) 自定义字段key
prd_exts[].prd_ext_value VARCHAR(4000) 自定义字段value
prd_units
prd_units[].prd_is_base VARCHAR(1) 是否基本单位 1-基本单位,0-辅助单位
prd_units[].prd_ratio NUMERIC(28,8) 换算倍数
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) 商品单位中的重量
prd_units[].prd_weight_unit VARCHAR(32) 商品单位中的重量单位名称

// 请求消息体示例:
{
    "prd_id": "0001A1100000000CUJWR"
}

// 正常响应信息示例:
{
"msg_id":"ORG00001",
"return_code":0,
"response_data":"[{
	"prd_spec":"1*5[水蜜桃,高糖,500ML]",
	"prd_weight":"800KG",
	"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_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": "查询日期格式不合法!"
}