API接口说明

API接口说明

VERSION: 1.0.2844.Api.Ali.20240221.Beta

商品相关接口

商品接口

一、获取商品分类
1.1、接口名称 : CategoryByPid( http method:get)

示例:http://supply.2844go.com:2844/scm/api/CategoryByPid?pid=0

根据上级分类ID获取下一级分类。

请求参数
参数名称必须示例备注
pid0第一级传数字“2”或比2小的数,上一级的返回的id作为下一级的parent id。

返回数据
key类型必须备注
codenumber1:表示成功;其它均为失败。
sizenumber本次返回商品分类的数量。
msgstring返回异常消息。
rowsArrayList<Map<String,Object>>返回分类数据
├─ idnumber分类id
├─ pidnumber上级分类id(一级返回2)
├─ titlestring分类标题
├─ levelnumber分类级别

响应示例
1.2、接口名称 : CategoryAll( http method:get)

示例:http://supply.2844go.com:2844/scm/api/CategoryAll

根据上级分类ID获取下一级分类。

请求参数
参数名称必须示例备注
page第几页。默认值 1
rows每次返回多少行数据?最多一次一次200行,默认50。

返回数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
sizenumber本次返回商品分类的数量。
msgstring返回异常消息。
rowsArrayList<Map<String,Object>>返回分类数据
├─ idnumber分类id
├─ pidnumber上级分类id(一级返回2)
├─ titlestring分类标题
├─ levelnumber分类级别

响应示例
二、商品列表
2.1、接口名称 : GoodsIdsByCategoryId( http method:get)

示例:http://supply.2844go.com:2844/scm/api/GoodsIdsByCategoryId?cid=51590

根据商品分类id获取该分类下的商品id,该id可以用于索引获取商品详情(用于拉取数据)。

请求参数
参数名称必须示例备注
cid分类id请参考商品分类接口返回的数据。
page第几页。默认值 1
rows每次返回多少个商品ID?最多一次200个,默认50。

返回数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
sizenumber本次返回商品分类的总数量。
msgstring返回简要消息。
rowsArrayList<number>返回分类下的商品ID数组,例如:[1,2,3,4]

响应示例
三、商品详情
3.1、接口名称 : GoodsDetailBySpuId( http method:get)

示例:http://supply.2844go.com:2844/scm/api/GoodsDetailBySpuId?id=10541,10639

根据商品id返回商品详情信息。多个id用半角逗号分割,一次最多50个spu_id。

请求参数
参数名称必须示例备注
id商品ID,请参考商品列表接口返回的数据。

返回数据
key类型必须备注
codenumber1:表示成功;其它均为失败。
sizenumber本次请求返回记录数。
msgstring异常消息
rowsArrayList<Map<String,Object>>返回商品数据
├─ idnumber商品id
├─ iconstring图标(默认为图片路径,如果以#vid结尾则是视频路径,例如:https://taotiejiuzhou.com/images/logo.svg#img,默认为图片)
├─ namestring商品名称
├─ brand_namestring品牌名称
├─ remarkstring备注
├─ introstring由图片数组组成的商品详情字符串
├─ picsArrayList<Map<String,Object>>轮播图
├─├─ idnumber图片ID
├─├─ spu_idnumber该图片属于的商品,商品id(spu)
├─├─ primarynumber是否主图,1:主图,其它非主图
├─├─ sortnumber图片排序
├─├─ pathnumber网络路径(默认为图片路径,如果以#vid结尾则是视频路径,例如:https://taotiejiuzhou.com/images/logo.svg#img,默认为图片)
├─ specListArrayList<Map<String,Object>>规格列表
├─├─ idnumber商品的规格id
├─├─ spu_idnumber该规格属于的商品,商品id(spu)
├─├─ iconstring规格小图标(默认为图片路径,如果以#vid结尾则是视频路径,例如:https://taotiejiuzhou.com/images/logo.svg#img,默认为图片)
├─├─ namestring商品名称(规格)
├─├─ spec_jsonnumber多纬度商品规格的json串
├─├─ bnnumber商品编码
├─├─ approve_statusnumber是否上架:1,上架;其它不上架
├─├─ is_defaultnumber是否是默认的规格
├─├─ unitnumber单位
├─├─ pricenumber金额(单位:分)
├─├─ agreement_pricenumber协议价(单位:分)
├─├─ pricesnumber价格信息
├─├─├─ pricenumber金额(单位:分)
├─├─├─ typenumber价格的种类:0:售价;1:协议价;
├─ categoryListArrayList<Map<String,Object>>所属分类信息
├─├─ idnumber分类id
├─├─ pidnumber该分类的所属上级分类id
├─├─ titlestring分类标题
├─├─ levelnumber分类级别

响应示例
3.2、接口名称 : GoodsSpuBySkuId( http method:get)

示例:http://supply.2844go.com:2844/scm/api/GoodsSpuBySkuId?id=1,2,3,4

根据商品的规格sku返回和商品spu的对应关系。

请求参数
参数名称必须示例备注
id商品规格ID,请参考商品列表接口返回的数据(specList.id)。

返回数据
key类型必须备注
codenumber1:表示成功;其它均为失败。
sizenumber本次返回记录数。
msgstring返回消息。
rowslist返回分类数据
├─ sku_idnumber商品sku_id
├─ spu_idstring商品spu_id

响应示例

立即接入