商品新增 | API文档

# 商品新增

# 接口说明

项	值
URL	`/openapi/v1/trade/goods/add.json`
描述	商品新增
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
name	string	商品名称	是
seq	Integer	商品序号	否
outSkuId	string	商品外部编码	否
isExternal	Integer	是否外部商品 0-否 1-是。默认值: 0	是
jumpUrl	string	外部商品链接，用于跳转到第三方的商品详情页	是
imgUrls	List	商品图片	是
videoUrl	string	视频地址	否
brief	string	商品简介。介绍商品的卖点信息，建议 80 字内	否
detail	string	商品详情。html5富文本	否
price	Long	商品价格	是
deletelinedPrice	Long	划线价格	否
isVirtual	Integer	是否虚拟商品 1是 0否	是
shippingPrice	Long	物流运费价格，单位毫	否
stockNum	Long	库存	否
shelfMode	Integer	上架设置 1立即上架 2定时上架 3暂不上架	是
shelfTime	Date	上架时间	是
showStatus	Integer	显示状态 0隐藏 1显示	是
stopSaleStatus	Integer	停售状态 0-否 1-是	否
goodsType	Integer	商品类型: 1-通用商品	是
virtualSaleCount	Long	虚拟销量，用于修饰App端展示的销量数据	否
isMobileRequired	Integer	手机号是否必须 0:否 1:是	否
isUserNameRequired	Integer	姓名是否必须 0:否 1:是	否
deliveryType	Integer	发货方式 0-快递 1-自提，默认为0	否
isIframeOpen	Integer	外链商品是否Iframe嵌套展示，当是外链商品的时候，才需要这个字段	否

# 请求数据

{
    "name": "测试商品",
    "outSkuId": "93939399393",
    "imgUrls": [
      "https://duanxunbao-test.oss-cn-beijing.aliyuncs.com/1/2025-01-22/d36be770-d867-11ef-9599-17f85e582fcb.jpg"
    ],
    "videoUrl": "",
    "price": 12229000,
    "deletelinedPrice": 12229000,
    "stockNum": 100,
    "virtualSaleCount": 1,
    "shelfMode": 2,
    "shelfTime": 1737685404879,
    "showStatus": 1,
    "stopSaleStatus": 0,
    "brief": "21221",
    "detail": "<p>22</p>",
    "seq": 100,
    "jumpUrl": "http://baidu.com",
    "isExternal": 1,
    "isIframeOpen": 1,
    "isVirtual": 0,
    "deliveryType": 0,
    "shippingPrice": 100,
    "isMobileRequired": 1,
    "isUserNameRequired": 1
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": {
    "id": "Y7AVyQfqsc",
    "skuId": "202501221119132286"
  },
  "pageDto": null
}

# 商品编辑

# 接口说明

项	值
URL	`/openapi/v1/trade/goods/mod.json`
描述	商品编辑
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	string	商品编号	是
name	string	商品名称	是
seq	Integer	商品序号	否
outSkuId	string	商品外部编码	否
jumpUrl	string	外部商品链接，用于跳转到第三方的商品详情页	是
imgUrls	List	商品图片	是
videoUrl	string	视频地址	否
brief	string	商品简介。介绍商品的卖点信息，建议 80 字内	否
detail	string	商品详情。html5富文本	否
price	Long	商品价格	是
deletelinedPrice	Long	划线价格	否
shippingPrice	Long	物流运费价格，单位毫	否
stockNum	Long	库存	否
shelfMode	Integer	上架设置 1立即上架 2定时上架 3暂不上架	是
shelfTime	Date	上架时间	是
showStatus	Integer	显示状态 0隐藏 1显示	是
stopSaleStatus	Integer	停售状态 0-否 1-是	否
goodsType	Integer	商品类型: 1-通用商品	是
virtualSaleCount	Long	虚拟销量，用于修饰App端展示的销量数据	否
isMobileRequired	Integer	手机号是否必须 0:否 1:是	否
isUserNameRequired	Integer	姓名是否必须 0:否 1:是	否
deliveryType	Integer	发货方式 0-快递 1-自提，默认为0	否

# 请求数据

{
    "id": "YvisoDUaln",
    "name": "测试商品",
    "outSkuId": "93939399393",
    "imgUrls": [
      "https://duanxunbao-test.oss-cn-beijing.aliyuncs.com/1/2025-01-22/d36be770-d867-11ef-9599-17f85e582fcb.jpg"
    ],
    "videoUrl": "",
    "price": 12229000,
    "deletelinedPrice": 12229000,
    "stockNum": 100,
    "virtualSaleCount": 1,
    "shelfMode": 2,
    "shelfTime": 1737685404879,
    "showStatus": 1,
    "stopSaleStatus": 0,
    "brief": "21221",
    "detail": "<p>22</p>",
    "seq": 100,
    "jumpUrl": "http://baidu.com",
    "deliveryType": 0,
    "shippingPrice": 100,
    "isMobileRequired": 1,
    "isUserNameRequired": 1
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": {
    "id": "Y7AVyQfqsc",
    "skuId": "202501221119132286"
  },
  "pageDto": null
}

# 商品详情

# 接口说明

项	值
URL	`/openapi/v1/trade/goods/detail.json`
描述	商品详情
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	string	商品编号	是

# 请求数据

{
    "id": "YvisoDUaln"
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": {
    "goodsId": "YvisoDUaln",
    "name": "嵌套外链-否",
    "goodsType": 1,
    "seq": 9999999,
    "goodsNormalDetail": {
      "id": "YvisoDUaln",
      "fkId": null,
      "name": "嵌套外链-否",
      "goodsType": 1,
      "isVirtual": 1,
      "shippingPrice": 0,
      "goodsTypeDesc": "通用商品",
      "periodId": null,
      "seq": 9999999,
      "skuId": "202501211034259325",
      "outSkuId": "",
      "isExternal": 1,
      "jumpUrl": "https://www.baidu.com",
      "imageUrl": "[\"https://duanxunbao-test.oss-cn-beijing.aliyuncs.com/undefined/2025-01-21/2c130d40-d7a0-11ef-a2b0-4b257b97781f.png\"]",
      "videoUrl": "",
      "brief": "",
      "detail": "<p><br></p>",
      "price": 1000,
      "deletelinedPrice": null,
      "stockNum": null,
      "shelfMode": 1,
      "shelfTime": null,
      "shelfStatus": 1,
      "shelfStatusDesc": "已上架",
      "showStatus": 1,
      "showStatusDesc": "显示",
      "createTime": 1737426865000,
      "createTimeDate": "2025-01-21 10:34:25",
      "saleCount": 0,
      "hasCoupon": null,
      "virtualSaleCount": 0,
      "isMobileRequired": 0,
      "isUserNameRequired": 0,
      "isJoinGroup": null,
      "activityId": null,
      "deliveryType": 0,
      "isIframeOpen": 0
    }
  },
  "pageDto": null
}

# 商品列表

# 接口说明

项	值
URL	`/openapi/v1/trade/goods/list.json`
描述	商品列表
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
createTimeStart	Long	商品创建时间-开始时间	否
createTimeEnd	Long	商品创建时间-结束时间	否
name	string	商品名称	否
skuId	string	商品外部编码	否
isVirtual	Integer	是否虚拟商品 1是 0否	否
saleCountStart	Long	商品销量	否
saleCountEnd	Long	商品销量	否
priceStart	Long	商品价格	否
priceEnd	Long	商品价格	否
shelfStatus	Integer	上架状态 1已上架 2已下架 3等待上架	否
showStatus	Integer	显示状态	否
isStopSale	Integer	停售状态 0 否 1 是	否
stockNum	Long	库存	否
shelfMode	Integer	上架设置 1立即上架 2定时上架 3暂不上架	是
shelfTime	Date	上架时间	是
showStatus	Integer	显示状态 0隐藏 1显示	是
stopSaleStatus	Integer	停售状态 0-否 1-是	否
goodsType	Integer	商品类型: 1-通用商品	是
virtualSaleCount	Long	虚拟销量，用于修饰App端展示的销量数据	否
isMobileRequired	Integer	手机号是否必须 0:否 1:是	否
isUserNameRequired	Integer	姓名是否必须 0:否 1:是	否
deliveryType	Integer	发货方式 0-快递 1-自提，默认为0	否
pageDto	object	分页对象	是

# 分页对象

字段名	字段类型	说明	是否必传
pageSize	number	页大小	是。区间 (0,100]
pageNum	number	页码	是。从1开始

# 请求数据

{
  "name": "",
  "skuId": "",
  "shelfStatus": null,
  "showStatus": null,
  "goodsType": null,
  "saleCountStart": "",
  "saleCountEnd": "",
  "timeRange": [],
  "isVirtual": null,
  "createTimeStart": null,
  "createTimeEnd": null,
  "sortField": null,
  "sortOrder": null,
  "pageDto": {
    "pageNum": 1,
    "pageSize": 20
  }
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": [
    {
      "id": "YvisoDUaln",
      "fkId": null,
      "name": "嵌套外链-否",
      "goodsType": 1,
      "isVirtual": 1,
      "shippingPrice": 0,
      "goodsTypeDesc": "通用商品",
      "periodId": null,
      "seq": 9999999,
      "skuId": "202501211034259325",
      "outSkuId": "",
      "isExternal": 1,
      "jumpUrl": "https://www.baidu.com",
      "imageUrl": "[\"https://duanxunbao-test.oss-cn-beijing.aliyuncs.com/undefined/2025-01-21/2c130d40-d7a0-11ef-a2b0-4b257b97781f.png\"]",
      "videoUrl": "",
      "brief": "",
      "detail": "<p><br></p>",
      "price": 1000,
      "deletelinedPrice": null,
      "stockNum": null,
      "shelfMode": 1,
      "shelfTime": null,
      "shelfStatus": 1,
      "shelfStatusDesc": "已上架",
      "showStatus": 1,
      "showStatusDesc": "显示",
      "createTime": 1737426865000,
      "createTimeDate": "2025-01-21 10:34:25",
      "saleCount": 0,
      "hasCoupon": 1,
      "virtualSaleCount": 0,
      "isMobileRequired": 0,
      "isUserNameRequired": 0,
      "isJoinGroup": null,
      "activityId": null,
      "deliveryType": 0,
      "isIframeOpen": 0
    }
  ],
  "pageDto": {
    "count": 551,
    "curPageCount": 0,
    "pageNum": 1,
    "pageSize": 20,
    "needCount": true,
    "offset": 0,
    "totalPageNum": 28
  }
}

← 优惠券客户 →