简要描述:

  • 货品档案-查询接口

接口说明

  • 1.1接口描述:获取ERP的货品档案资料,“货品档案”其他系统称为“物料档案”“商品档案”等
  • 1.2注意事项:goods_no必传,spec_no 可以传或者不传

概念介绍

1. ERP货品档案的货品编号与商家编码定义如下
  1. 货品编号(goods_no)代表SPU所有属性信息的唯一编号,ERP内货品编号之间不重复。
  2. 商家编码(spec_no)代表SKU所有属性信息的唯一编号,ERP商家编码之间不重复。
2. SPU、SKU的通用定义如下:
  1. 概念 : SPU = Standard Product Unit (标准产品单位),SPU 是商品信息聚合的最小单位,是一组可复用、易检索的标准化信息的集合,该集合描述了一个产品的特性。通俗点讲,属性值、特性相同的货品就可以称为一个 SPU,与商家、颜色、款式、套餐都无关。例如:华为P20和华为Mate20是两款不同的货品,定义华为P20的编号为HUAWEI-P20,定义华为Mate20的编号为HUAWEI-Mate20,HUAWEI-Mate20和HUAWEI-P20就是ERP系统的货品编号(goods_no)。
  2. 概念:SKU=stock keeping unit( 库存量单位),SKU 即库存进出计量的单位, 可以是以件、盒、托盘等为单位,SKU 是物理上不可分割的最小存货单元。通俗点将,属性值、特性相同的一个SPU再细化粒度到商家、颜色、款式、套餐等就是一个SKU,华为P20的颜色属性其中有两个颜色宝蓝色(Royal blue)与亮黑色(Bright black),定义华为P20宝蓝色的编码为HUAWEI-P20-Royal blue,定义华为P20宝蓝色的编码为HUAWEIP20-Bright black,HUAWEI-P20-Royal blue和HUAWEI-P20-Royal blue都是下属货品编号HUAWEI-P20的两个商家编码(spec_no)。

接口版本:

版本号 制定人 制定日期 修订日期
1.0.0 石明科 2020-07-20 2020-07-20

请求URL:

环境 HTTP地址
测试环境 http://apitest.yptcgroup.com/thirdpart/oms/basic/goods/query
预发布环境 http://apiuat.yptcgroup.com/thirdpart/oms/basic/goods/query
正式环境 http://api.yptcgroup.com/thirdpart/xxxx/oms/basic/goods/query

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
X-AUTH-TOKEN string 令牌
Content-Type string 请求类型,统一是 application/json

请求参数:

参数名 字段 是否必须 类型 长度 说明
货品编号 goods_no varchar 40 代表货品(SPU)所有属性的唯一编号,用于指定获取系统货品的数据
商家编码 spec_no varchar 40 代表单品(SKU)所有属性的唯一编码,用于获取指定的系统单品的数据

请求参数示例

{
    goods_no :"9WY017",
    spec_no :"9WY017001"
}

响应参数

返回参数说明:

参数名 字段 是否必须 类型 长度 说明
错误码 code int 11 状态码:1表示成功,其他表示失败
错误原因 message varchar 255 错误原因
请求id requestId varchar 255 请求后,返回唯一id(成功与否都会返回)
具体返回详情 data data[] 具体返回详情

goods_list

参数名 字段 是否必须 类型 长度 说明
货品ID goods_id int 11 货品表主键
货品编码 goods_no varchar 40 代表货品(spu)所有属性的唯一编号,用于系统货品区分
货品类别 goods_type int 1 货品类别 1销售商品 2原材料 3包装 4周转材料5虚拟商品6固定资产 0其它
货品名称 goods_name varchar 255 货品名称
货品简称 short_name varchar 255 货品简称
货品别名 alias varchar 255 货品别名
拼音名称 pinyin varchar 40 拼音名称
规格数 spec_count int 11 规格数
年份 year varchar 64 年份 (如:2020)
季节 season varchar 64 季节(春季,夏季,秋季,冬季)
性别 sex varchar 64 性别
流水号 serial_number varchar 255 流水号
分类ID class_id int 64 分类ID
分类 class_name varchar 64 分类
品牌ID brand_id varchar 32 品牌ID
品牌编码 brand_no varchar 32 品牌编码
品牌 brand_name varchar 64 品牌
基本单位 unit varchar 20 基本单位
基本单位名称 unit_name varchar 20 基本单位名称
辅助单位 aux_unit varchar 255 辅助单位
辅助单位名称 aux_unit_name varchar 255 辅助单位名称
标记 flag_id varchar 11 标记
标记名称 flag_name varchar 32 标记名称
属性 properties varchar 1024
版本号 version_id varchar 11 版本号,用来检查同时修改的
最后修改时间 goods_modified datetime 11 最后修改时间 格式:yyyy-MM-dd HH:mm:ss
创建时间 goods_created datetime 11 创建时间 格式:yyyy-MM-dd HH:mm:ss
备注 remark 是否 varchar 512 备注
是否已经删除 deleted int 11 是否已删除: 0:未删除 >0代表已删除
自定义属性1 prop1 varchar 255 自定义属性1
自定义属性2 prop2 varchar 255 自定义属性2
自定义属性3 prop3 varchar 255 自定义属性3
自定义属性4 prop4 varchar 255 自定义属性4
自定义属性5 prop5 varchar 255 自定义属性5
自定义属性6 prop6 varchar 255 自定义属性6
单品节点 spec_list data[]

spec_list

参数名 字段 是否必须 类型 长度 说明
商家编码 spec_no varchar 40 代表单品(sku)所有属性的唯一编码,用于系统单品区分,SKU概念介绍
规格ID spec_id varchar 40 规格ID
规格码 spec_code varchar 40 规格编码
主条码 barcode varchar 50 主条码
规格名称 spec_name varchar 100 规格名称
货品ID goods_id varchar 100 货品ID
最低价 lowest_price decimal 19,4 最低价
零售价 retail_price decimal 19,4 零售价
批发价 wholesale_price decimal 19,4 批发价
会员价 member_price decimal 19,4 会员价
市场价 market_price decimal 19,4 市场价
自定义价格1 custom_price1 decimal 19,4 自定义价格1
自定义价格2 custom_price2 decimal 19,4 自定义价格2
销售积分 sale_score decimal 19,4 销售积分
打包积分 pack_score decimal 19,4 打包积分
拣货积分 pick_score decimal 19,4 拣货积分
有效期天数 validity_days int 11 保质期,天数
最佳销售天数 sales_days int 11 最佳销售天数
最佳收获天数 receive_days int 11 最佳收获天数
重量 weight decimal 19,4 ERP默认重量单位:kg
length decimal 19,4 长(CM)
width decimal 19,4 宽(CM)
height decimal 19,4 高(CM)
启用序列号 is_sn_enable 1 是否启用序列号,默认不启用,0不启用序列号 1强序列号 2弱序列
允许负库存 is_allow_neg_stock int 1 是否允许负库存1允许,0不允许(默认为1)
是否出库不用验货 is_not_need_examine int 1 是否出库不用验货,默认不开启该配置,0出库不验货未开启 1出库不验货开启
是否允许0成本 is_zero_cost int 1 是否允许0成本,默认允许,0不允许1允许
是否允许低于成本价 is_lower_cost int 1 是否允许低于成本价,默认不允许,0不允许1允许
是否航空禁运 is_not_use_air int 1 是否航空禁运,默认不开启,0不开启1开启
税率 tax_rate varchar 255 税率
大件类别 large_type int 1 0非大件1普通大件2独立大件
备注 remark varchar 512 备注
最后修改时间 spec_modified datetime 11 最后修改时间 格式:yyyy-MM-dd HH:mm:ss
创建时间 spec_created datetime 11 创建时间 格式:yyyy-MM-dd HH:mm:ss
自定义1 prop1 varchar 255 自定义属性1
自定义2 prop2 varchar 255 自定义属性2
自定义3 prop3 varchar 255 自定义属性3
自定义4 prop4 varchar 255 自定义属性4
自定义5 prop5 varchar 255 自定义属性5
自定义6 prop6 varchar 255 自定义属性6
图片url地址 img_url varchar 40 图片url地址
税务编码 tax_code_id varchar 11 税务编码
是否启用同一批次出库 is_single_batch int 1 是否启用同一批次出库,默认不启用,0不启用1启用
水洗标 washing_label varchar 40 水洗标
基本单位 unit varchar 11 基本单位
辅助单位 aux_unit varchar 11 辅助单位
标记ID flag_id varchar 11 标记ID
图片在外部空间的key img_key varchar 100 看图片在外部空间的key 比如说 云盘的一个 外链
条码个数 barcode_count int 6 条码个数
平台货品数量 plat_spec_count int 6 平台货品数量(不包含删除的)
sn自增数 postfix_val varchar 11 sn自增数
最后日期 last_date datetime 最后日期 格式:yyyy-MM-dd HH:mm:ss
补货 replenish_type int 1 补货,默认低于警戒库存补货,0持续补货1不补货2低于警戒库存补货
是否畅销品 is_popular int 1 是否畅销品,默认非畅销,0非畅销 1畅销
备注换货匹配码 replace_no varchar 40 备注换货匹配码
单品标记二进制位 spec_mask varchar 11 单品标记二进制位 1同款备注换货虚拟规格 2是否在备注换货界面展示
同款备注换货 replace_proportion varchar 11 同款备注换货–虚拟货品换货比例
扩展字段 extra_3 varchar 40 扩展字段
税务编码 tax_code varchar 32 税务编码
基本单位 spec_unit_name varchar 20 基本单位名称
辅助单位 spec_aux_unit_name varchar 20 辅助单位名称
是否已删除 deleted int 11 是否已删除:0:未删除 >0代表已删除

|单品辅助单位名称|spec_aux_unit_name |否 |varchar |255| 单品辅助单位名称|

返回示例:

正确时返回:

{
    "code": "1",
    "data": {
        "goods_list": [
            {
                "alias": "",
                "aux_unit": 0,
                "aux_unit_name": "",
                "brand_id": 0,
                "brand_name": "无",
                "brand_no": "BD201911060035",
                "class_id": 0,
                "class_name": "无",
                "currentPage": 1,
                "deleted": 0,
                "flag_id": 0,
                "flag_name": "",
                "goods_created": "2020-07-17 10:10:03",
                "goods_id": 276264,
                "goods_modified": "2020-07-20 14:26:36",
                "goods_name": "石头人",
                "goods_no": "9WY017",
                "goods_type": 1,
                "origin": "",
                "pageSize": 30,
                "pinyin": "",
                "prop1": "2020",
                "prop2": "",
                "prop3": "",
                "prop4": "",
                "prop5": "",
                "prop6": "",
                "properties": "0,0,0,0,0,0",
                "remark": "",
                "season": "",
                "serial_number": "",
                "sex": "",
                "short_name": "",
                "spec_count": 1,
                "spec_list": [
                    {
                        "aux_unit": 0,
                        "barcode": "",
                        "currentPage": 1,
                        "custom_price1": 0,
                        "custom_price2": 0,
                        "deleted": 0,
                        "extra_3": "",
                        "flag_id": 0,
                        "goods_id": 276264,
                        "height": 0,
                        "img_key": "",
                        "img_url": "",
                        "is_allow_neg_stock": 0,
                        "is_lower_cost": 0,
                        "is_not_need_examine": 0,
                        "is_not_use_air": 0,
                        "is_popular": 0,
                        "is_single_batch": 0,
                        "is_sn_enable": 0,
                        "is_zero_cost": 1,
                        "large_type": 0,
                        "length": 0,
                        "lowest_price": 0,
                        "market_price": 0,
                        "member_price": 0,
                        "pack_score": 0,
                        "pageSize": 30,
                        "pick_score": 0,
                        "plat_spec_count": 0,
                        "postfix_val": 0,
                        "prop1": "",
                        "prop2": "",
                        "prop3": "",
                        "prop4": "",
                        "prop5": "",
                        "prop6": "",
                        "receive_days": 0,
                        "remark": "",
                        "replace_no": "",
                        "replace_proportion": 1,
                        "replenish_type": 2,
                        "retail_price": 0,
                        "sale_score": 0,
                        "sales_days": 0,
                        "spec_aux_unit_name": "",
                        "spec_code": "9WY01-黑",
                        "spec_created": "2020-07-17 10:10:03",
                        "spec_id": 517701,
                        "spec_mask": 0,
                        "spec_modified": "2020-07-17 10:10:03",
                        "spec_name": "石头人-黑",
                        "spec_no": "9WY017001",
                        "spec_unit_name": "",
                        "summary": false,
                        "tax_code_id": 0,
                        "tax_rate": 0,
                        "unit": 0,
                        "validity_days": 0,
                        "washing_label": "",
                        "weight": 0,
                        "wholesale_price": 0,
                        "width": 0
                    }
                ],
                "summary": false,
                "unit": 0,
                "unit_name": "",
                "version_id": 0,
                "year": "2020"
            }
        ]
    },
    "msg": "SUCCESS",
    "requestId": "4825188b21d045d8846b33fdce356658"
}

错误时返回:

{
    "code": "100001",
    "msg": "[goods_no]参数校验失败,不能为空",
    "requestId": "bb3ed906b9fd4289b71a5240178623e1"
}

备注:

  • 更多返回错误代码请看首页的错误代码描述
文档更新时间: 2020-08-07 17:01   作者:石明科