Shoplus-API文档:
请到店铺管理后台-设置-应用管理获取应用账号密钥。
openApi调用方式参考本页【开发对接附录】，webhook调用方式参考本页【webhook对接】。

配置项

HTTP请求地址
app_key
secret

商品模块

添加商品1.0

接口名(name)：products.add

版本号(version)：1.0

请求参数/ 数据模型

名称

类型

是否必须

示例值

描述

spuCode

string

否

商家spu编号

title

string

是

商品名称

vendor

string

否

供应商

brandId

integer

否

品牌ID（预留，暂时没用）

productType

string

否

商品类别（字符串，由商家自定义）

tags

string

否

标签（字符串，由商家自定义）

freightTemplateId

long

否

运费模板ID（预留，暂时没用）

productSizeDesc

string

否

商品尺码表（html table格式）

productShortDesc

string

否

商品短描述（JSON格式）

productLongDesc

string

否

商品长描述（html格式）

specialReturnDesc

string

否

特殊退货政策（html格式）

currencyCode

string

否

货币编码（三位编码）

taxStatus

boolean

否

是否收税

seoTitle

string

否

seo标题

seoDesc

string

否

set描述(访问链接，不传系统自动生成[spucode-title])

seoKeyword

string

否

seo关键字

seoUrl

string

否

seo链接

spuRemark

string

否

商品备注（供商家标记，不会显示到C端）

publishStatus

integer

否

发布状态,1:发布;0:未发布(默认发布状态)

productImages

array

否

名称	类型	是否必须	描述
attachment	string	否	Base64格式图片（attachment/imgUrl二者选传一个）
fileName	string	否	Base64格式图片名称
imgUrl	string	否	图片url链接（attachment/imgUrl二者选传一个）
videoUrl	string	否	商品视频url链接
alt	string	否	图片描述
title	string	否	图片标题
position	integer	否	图片展示顺序

商品图片数组

productOptions

array

否

名称

类型

是否必须

示例值

描述

name

string

是

商品属性名称

position

integer

否

属性展示位置

productOptionValues

array

否

名称	类型	是否必须	描述
value	string	是	商品属性描述
position	integer	否	商品属性描述展示位置
imageUrl	string	否	属性图片url

商品属性描述数组

商品属性数组

productCustomizedOptions

array

否

名称	类型	是否必须	示例值	描述
name	string	是		商品自定义属性名称
position	integer	否		商品自定义属性展示位置

商品自定义属性数组

productVariants

array

是

名称	类型	是否必须	描述
skuCode	string	否	商家sku编号
salePrice	bigdecimal	否	销售价格
compareAtPrice	bigdecimal	否	参考价
purchasePrice	bigdecimal	否	成本价格
skuBarcode	string	否	sku条码
imgUrl	string	否	sku图片
isTrackInventory	integer	否	是否追踪库存,0:不追踪;1:追踪
optionValueNames	array	否	sku属性描述数组（需要保证该值在spu属性中存在）
customizedOptionNames	array	否	sku自定义属性描述数组（需要保证该值在spu自定义属性中存在）
grams	integer	否	商品重量(克)
weight	bigdecimal	否	商品重量
weightUnit	string	否	商品重量单位(g,kg,oz,lb)
availableStockQuantity	integer	否	库存数量
inventoryPolicy	string	否	库存政策,deny:不允许超卖, continue:允许超卖
skuRemark	string	否	sku备注（供商家标记，不会显示到C端）

sku数组

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

long

商品id

shopId

long

店铺ID

spuCode

string

商家spu编号

title

string

标题

vendor

string

供应商

brandId

integer

品牌ID

productType

string

商品类别

tags

string

标签

freightTemplateId

long

运费模板ID

productSizeDesc

object

商品尺码表

productShortDesc

object

商品短描述

productLongDesc

object

商品长描述

specialReturnDesc

string

特殊退货政策（html格式）

currencyCode

string

货币编码（三位编码）

taxStatus

boolean

是否收税

seoTitle

string

seo标题

seoDesc

string

set描述

seoKeyword

string

seo关键字

seoUrl

string

seo链接

spuRemark

string

商品备注（供商家标记，不会显示到C端）

publishStatus

integer

发布状态,1:发布;0:未发布

isDeleted

integer

是否删除,1:否;2:是

publishTime

date

发布时间

createTime

date

创建时间

updateTime

date

更新时间

productImgDTOs

array

名称	类型	描述
id	long	商品图片主键ID
productId	long	商品ID
shopId	long	店铺ID
alt	string	图片描述
title	string	图片标题
position	integer	位置
imgUrl	string	图片内容
createTime	date	创建时间
updateTime	date	更新时间

商品图片数组

productOptionDTOs

array

名称

类型

示例值

描述

long

属性主键id

productId

long

商品ID

shopId

long

店铺ID

name

string

名称

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

产品ID

optionId

long

属性id

value

string

描述

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueImgRelationshipDTOs

array

名称	类型	描述
id	long	自增主键
productId	long	产品ID
shopId	long	店铺ID
valueId	long	属性描述ID
imgId	object	图片ID
createTime	date	创建时间
updateTime	date	更新时间

属性描述关联图片数组

属性描述数组

商品属性数组

productCustomizedOptionDTOs

array

名称	类型	描述
id	long	属性主键id
productId	long	商品ID
shopId	long	站点ID
name	string	名称
position	object	位置

商品自定义属性数组

productVariantDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

商品ID

shopId

long

店铺ID

imgId

long

图片ID

skuCode

string

商家sku编号

salePrice

bigdecimal

销售价格

compareAtPrice

bigdecimal

参考价

purchasePrice

bigdecimal

成本价格

skuBarcode

string

sku条码

isTrackInventory

integer

是否追踪库存,0:不追踪;1:追踪

optionValueIds

string

sku销售属性id,多个逗号拼接

optionValueNames

string

sku销售属性名称,多个逗号隔开

customizedOptionNames

string

sku自定义属性名称,多个逗号隔开

grams

integer

商品重量(克)

weight

bigdecimal

商品重量

weightUnit

string

商品重量单位 g,kg,oz,lb

createTime

date

创建时间

updateTime

date

更新时间

productVariantInventoryDTO

object

名称	类型	描述
variantId	long	主键id
availableStockQuantity	integer	可用库存数量
lockedStockQuantity	integer	锁定库存数量
isTrackInventory	integer	是否追踪库存,0:追踪;1:不追踪
inventoryPolicy	string	库存政策,deny:不允许超卖;continue:允许超卖

库存对象

sku数组

{
	"code":"0",
	"data":{
		"seoKeyword":"",
		"specialReturnDesc":"",
		"title":"",
		"seoTitle":"",
		"seoDesc":"",
		"taxStatus":"",
		"productVariantDTOs":[
			{
				"isTrackInventory":"",
				"productId":"",
				"imgId":"",
				"salePrice":"",
				"optionValueNames":"",
				"optionValueIds":"",
				"weight":"",
				"updateTime":"",
				"purchasePrice":"",
				"customizedOptionNames":"",
				"createTime":"",
				"productVariantInventoryDTO":{
					"availableStockQuantity":"",
					"lockedStockQuantity":"",
					"isTrackInventory":"",
					"inventoryPolicy":"",
					"variantId":""
				},
				"id":"",
				"shopId":"",
				"skuBarcode":"",
				"grams":"",
				"skuCode":"",
				"compareAtPrice":"",
				"weightUnit":""
			}
		],
		"seoUrl":"",
		"isDeleted":"",
		"vendor":"",
		"productCustomizedOptionDTOs":[
			{
				"productId":"",
				"name":"",
				"id":"",
				"shopId":"",
				"position":""
			}
		],
		"spuCode":"",
		"id":"",
		"shopId":"",
		"productType":"",
		"publishStatus":"",
		"publishTime":"",
		"freightTemplateId":"",
		"productImgDTOs":[
			{
				"imgUrl":"",
				"productId":"",
				"createTime":"",
				"alt":"",
				"updateTime":"",
				"id":"",
				"shopId":"",
				"position":"",
				"title":""
			}
		],
		"updateTime":"",
		"tags":"",
		"productShortDesc":"",
		"productLongDesc":"",
		"spuRemark":"",
		"productOptionDTOs":[
			{
				"productId":"",
				"createTime":"",
				"productOptionValueDTOs":[
					{
						"productOptionValueImgRelationshipDTOs":[
							{
								"valueId":"",
								"productId":"",
								"imgId":"",
								"createTime":"",
								"updateTime":"",
								"id":"",
								"shopId":""
							}
						],
						"productId":"",
						"createTime":"",
						"optionId":"",
						"updateTime":"",
						"id":"",
						"position":"",
						"value":""
					}
				],
				"name":"",
				"updateTime":"",
				"id":"",
				"shopId":"",
				"position":""
			}
		],
		"productSizeDesc":"",
		"createTime":"",
		"brandId":"",
		"currencyCode":""
	},
	"msg":""
}

请求数据
返回结果

全量更新商品1.0

接口名(name)：products.updateAll

版本号(version)：1.0

请求参数/ 数据模型

名称

类型

是否必须

示例值

描述

long

是

商品id

spuCode

string

否

商家spu编号

title

string

否

商品名称

vendor

string

否

供应商

brandId

integer

否

品牌ID（预留，暂时没用）

productType

string

否

商品类别（字符串，由商家自定义）

tags

string

否

标签（字符串，由商家自定义）

freightTemplateId

long

否

运费模板ID（预留，暂时没用）

productSizeDesc

string

否

商品尺码表（html table格式）

productShortDesc

string

否

商品短描述（JSON）

productLongDesc

string

否

商品长描述（html格式）

specialReturnDesc

string

否

特殊退货政策（html格式）

currencyCode

string

否

货币编码（三位编码）

taxStatus

boolean

否

是否收税

seoTitle

string

否

seo标题

seoDesc

string

否

set描述

seoKeyword

string

否

seo关键字

seoUrl

string

否

seo链接(访问链接，不传系统自动生成[spucode-title])

spuRemark

string

否

商品备注（供商家标记，不会显示到C端）

publishStatus

integer

否

发布状态,1:发布;0:未发布

productImages

array

否

名称	类型	是否必须	描述
attachment	string	否	Base64格式图片（attachment/imgUrl二者选传一个）
fileName	string	否	Base64格式图片名称
imgUrl	string	否	图片url链接（attachment/imgUrl二者选传一个）
videoUrl	string	否	商品视频url链接
alt	string	否	图片描述
title	string	否	图片标题
position	integer	否	图片展示顺序

商品图片数组

productOptions

array

否

名称

类型

是否必须

示例值

描述

name

string

是

商品属性名称

position

integer

否

属性展示位置

productOptionValues

array

否

名称	类型	是否必须	描述
value	string	是	商品属性描述
position	integer	否	商品属性描述展示位置
imageUrl	string	否	属性图片url

商品属性描述数组

商品属性数组

productCustomizedOptions

array

否

名称	类型	是否必须	示例值	描述
name	string	是		商品自定义属性名称
position	integer	否		商品自定义属性展示位置

商品自定义属性数组

productVariants

array

是

名称	类型	是否必须	描述
id	long	否	商家skuId(更新必传)
skuCode	string	否	商家sku编号
salePrice	bigdecimal	否	销售价格
compareAtPrice	bigdecimal	否	参考价
purchasePrice	bigdecimal	否	成本价格
skuBarcode	string	否	sku条码
imgUrl	string	否	sku图片
isTrackInventory	integer	否	是否追踪库存,0:不追踪;1:追踪
optionValueNames	array	否	sku属性描述数组（需要保证该值在spu属性中存在）
customizedOptionNames	array	否	sku自定义属性描述数组（需要保证该值在spu自定义属性中存在）
grams	integer	否	商品重量(克)
weight	bigdecimal	否	商品重量
weightUnit	string	否	商品重量单位(g,kg,oz,lb)
availableStockQuantity	integer	否	库存数量
inventoryPolicy	string	否	库存政策,deny:不允许超卖, continue:允许超卖
skuRemark	string	否	sku备注（供商家标记，不会显示到C端）

sku数组

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

long

商品id

shopId

long

店铺ID

spuCode

string

商家spu编号

title

string

标题

vendor

string

供应商

brandId

integer

品牌ID

productType

string

商品类别

tags

string

标签

freightTemplateId

long

运费模板ID

productSizeDesc

object

商品尺码表

productShortDesc

object

商品短描述

productLongDesc

object

商品长描述

specialReturnDesc

string

特殊退货政策（html格式）

currencyCode

string

货币编码（三位编码）

taxStatus

boolean

是否收税

seoTitle

string

seo标题

seoDesc

string

set描述

seoKeyword

string

seo关键字

seoUrl

string

seo链接

spuRemark

string

商品备注（供商家标记，不会显示到C端）

publishStatus

integer

发布状态,1:发布;0:未发布

isDeleted

integer

是否删除,1:否;2:是

publishTime

date

发布时间

createTime

date

创建时间

updateTime

date

更新时间

productImgDTOs

array

名称	类型	描述
id	long	商品图片主键ID
productId	long	商品ID
shopId	long	店铺ID
alt	string	图片描述
title	string	图片标题
position	integer	位置
imgUrl	string	图片内容
createTime	date	创建时间
updateTime	date	更新时间

商品图片数组

productOptionDTOs

array

名称

类型

示例值

描述

long

属性主键id

productId

long

商品ID

shopId

long

店铺ID

name

string

名称

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

产品ID

optionId

long

属性id

value

string

描述

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueImgRelationshipDTOs

array

名称	类型	描述
id	long	自增主键
productId	long	产品ID
shopId	long	店铺ID
valueId	long	属性描述ID
imgId	object	图片ID
createTime	date	创建时间
updateTime	date	更新时间

属性描述关联图片数组

属性描述数组

商品属性数组

productCustomizedOptionDTOs

array

名称	类型	描述
id	long	属性主键id
productId	long	商品ID
shopId	long	站点ID
name	string	名称
position	object	位置

商品自定义属性数组

productVariantDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

商品ID

shopId

long

店铺ID

imgId

long

图片ID

skuCode

string

商家sku编号

salePrice

bigdecimal

销售价格

compareAtPrice

bigdecimal

参考价

purchasePrice

bigdecimal

成本价格

skuBarcode

string

sku条码

isTrackInventory

integer

是否追踪库存,0:不追踪;1:追踪

optionValueIds

string

sku销售属性id,多个逗号拼接

optionValueNames

string

sku销售属性名称,多个逗号隔开

customizedOptionNames

string

sku自定义属性名称,多个逗号隔开

grams

integer

商品重量(克)

weight

bigdecimal

商品重量

weightUnit

string

商品重量单位 g,kg,oz,lb

createTime

date

创建时间

updateTime

date

更新时间

productVariantInventoryDTO

object

名称	类型	描述
variantId	long	主键id
availableStockQuantity	integer	可用库存数量
lockedStockQuantity	integer	锁定库存数量
isTrackInventory	integer	是否追踪库存,0:追踪;1:不追踪
inventoryPolicy	string	库存政策,deny:不允许超卖;continue:允许超卖

库存对象

sku数组

请求数据
返回结果

更新SPU基础信息1.0

接口名(name)：products.updateSpuSelective

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
id	long	是	商品id
spuCode	string	否	商家spu编号
title	string	否	商品名称
vendor	string	否	供应商
brandId	integer	否	品牌ID（预留，暂时没用）
productType	string	否	商品类别（字符串，由商家自定义）
tags	string	否	标签（字符串，由商家自定义）
freightTemplateId	long	否	运费模板ID（预留，暂时没用）
productSizeDesc	string	否	商品尺码表（html table格式）
productShortDesc	string	否	商品短描述（JSON）
productLongDesc	string	否	商品长描述（html格式）
specialReturnDesc	string	否	特殊退货政策（html格式）
currencyCode	string	否	货币编码（三位编码）
taxStatus	boolean	否	是否收税
seoTitle	string	否	seo标题
seoDesc	string	否	set描述
seoKeyword	string	否	seo关键字
spuRemark	string	否	商品备注（供商家标记，不会显示到C端）
publishStatus	integer	否	发布状态,1:发布;0:未发布

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
result	boolean		更新结果

请求数据
返回结果

批量更新SPU基础信息1.0

接口名(name)：products.updateSpuSelectiveBatch

版本号(version)：1.0

请求参数/ 数据模型

名称

类型

是否必须

示例值

描述

products

array

是

名称	类型	是否必须	描述
id	long	是	商品id
spuCode	string	否	商家spu编号
title	string	否	商品名称
vendor	string	否	供应商
brandId	integer	否	品牌ID（预留，暂时没用）
productType	string	否	商品类别（字符串，由商家自定义）
tags	string	否	标签（字符串，由商家自定义）
freightTemplateId	long	否	运费模板ID（预留，暂时没用）
productSizeDesc	string	否	商品尺码表（html table格式）
productShortDesc	string	否	商品短描述（JSON）
productLongDesc	string	否	商品长描述（html格式）
specialReturnDesc	string	否	特殊退货政策（html格式）
currencyCode	string	否	货币编码（三位编码）
taxStatus	boolean	否	是否收税
seoTitle	string	否	seo标题
seoDesc	string	否	set描述
seoKeyword	string	否	seo关键字
spuRemark	string	否	商品备注（供商家标记，不会显示到C端）
publishStatus	integer	否	发布状态,1:发布;0:未发布

商品数组

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
result	boolean		更新结果

请求数据
返回结果

查询商品列表1.0

接口名(name)：products

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
ids	array	否	商品ids
fields	array	否	返回字段属性,1:商品图片;2:商品属性;3:sku（默认返回所有信息）
updatedAtMin	date	否	起始更新时间
updatedAtMax	date	否	结束更新时间
pageNum	integer	是	第几页
pageSize	integer	是	每页几条数据(最大可设置200)

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

totalCount

integer

数据总量

productVOs

array

名称

类型

示例值

描述

long

商品id

shopId

long

店铺ID

spuCode

string

商家spu编号

title

string

标题

vendor

string

供应商

brandId

integer

品牌ID

productType

string

商品类别

tags

string

标签

freightTemplateId

long

运费模板ID

productSizeDesc

object

商品尺码表

productShortDesc

object

商品短描述

productLongDesc

object

商品长描述

specialReturnDesc

string

特殊退货政策（html格式）

currencyCode

string

货币编码（三位编码）

taxStatus

boolean

是否收税

seoTitle

string

seo标题

seoDesc

string

set描述

seoKeyword

string

seo关键字

seoUrl

string

seo链接

spuRemark

string

商品备注（供商家标记，不会显示到C端）

publishStatus

integer

发布状态,1:发布;0:未发布

isDeleted

integer

是否删除,1:否;2:是

publishTime

date

发布时间

createTime

date

创建时间

updateTime

date

更新时间

productImgDTOs

array

名称	类型	描述
id	long	商品图片主键ID
productId	long	商品ID
shopId	long	店铺ID
alt	string	图片描述
title	string	图片标题
position	integer	位置
imgUrl	string	图片内容
createTime	date	创建时间
updateTime	date	更新时间

商品图片数组

productOptionDTOs

array

名称

类型

示例值

描述

long

属性主键id

productId

long

商品ID

shopId

long

店铺ID

name

string

名称

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

产品ID

optionId

long

属性id

value

string

描述

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueImgRelationshipDTOs

array

名称	类型	描述
id	long	自增主键
productId	long	产品ID
shopId	long	店铺ID
valueId	long	属性描述ID
imgId	object	图片ID
createTime	date	创建时间
updateTime	date	更新时间

属性描述关联图片数组

属性描述数组

商品属性数组

productCustomizedOptionDTOs

array

名称	类型	描述
id	long	属性主键id
productId	long	商品ID
shopId	long	站点ID
name	string	名称
position	object	位置

商品自定义属性数组

productVariantDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

商品ID

shopId

long

店铺ID

imgId

long

图片ID

skuCode

string

商家sku编号

salePrice

bigdecimal

销售价格

compareAtPrice

bigdecimal

参考价

purchasePrice

bigdecimal

成本价格

skuBarcode

string

sku条码

isTrackInventory

integer

是否追踪库存,0:不追踪;1:追踪

optionValueIds

string

sku销售属性id,多个逗号拼接

optionValueNames

string

sku销售属性名称,多个逗号隔开

customizedOptionNames

string

sku自定义属性名称,多个逗号隔开

grams

integer

商品重量(克)

weight

bigdecimal

商品重量

weightUnit

string

商品重量单位 g,kg,oz,lb

createTime

date

创建时间

updateTime

date

更新时间

productVariantInventoryDTO

object

名称	类型	描述
variantId	long	主键id
availableStockQuantity	integer	可用库存数量
lockedStockQuantity	integer	锁定库存数量
isTrackInventory	integer	是否追踪库存,0:追踪;1:不追踪
inventoryPolicy	string	库存政策,deny:不允许超卖;continue:允许超卖

库存对象

sku数组

商品列表

pageNum

integer

第几页

pageSize

integer

每页几条数据(最大可设置200)

{
	"code":"0",
	"data":{
		"productVOs":[
			{
				"seoKeyword":"",
				"specialReturnDesc":"",
				"title":"",
				"seoTitle":"",
				"seoDesc":"",
				"taxStatus":"",
				"productVariantDTOs":[
					{
						"isTrackInventory":"",
						"productId":"",
						"imgId":"",
						"salePrice":"",
						"optionValueNames":"",
						"optionValueIds":"",
						"weight":"",
						"updateTime":"",
						"purchasePrice":"",
						"customizedOptionNames":"",
						"createTime":"",
						"productVariantInventoryDTO":{
							"availableStockQuantity":"",
							"lockedStockQuantity":"",
							"isTrackInventory":"",
							"inventoryPolicy":"",
							"variantId":""
						},
						"id":"",
						"shopId":"",
						"skuBarcode":"",
						"grams":"",
						"skuCode":"",
						"compareAtPrice":"",
						"weightUnit":""
					}
				],
				"seoUrl":"",
				"isDeleted":"",
				"vendor":"",
				"productCustomizedOptionDTOs":[
					{
						"productId":"",
						"name":"",
						"id":"",
						"shopId":"",
						"position":""
					}
				],
				"spuCode":"",
				"id":"",
				"shopId":"",
				"productType":"",
				"publishStatus":"",
				"publishTime":"",
				"freightTemplateId":"",
				"productImgDTOs":[
					{
						"imgUrl":"",
						"productId":"",
						"createTime":"",
						"alt":"",
						"updateTime":"",
						"id":"",
						"shopId":"",
						"position":"",
						"title":""
					}
				],
				"updateTime":"",
				"tags":"",
				"productShortDesc":"",
				"productLongDesc":"",
				"spuRemark":"",
				"productOptionDTOs":[
					{
						"productId":"",
						"createTime":"",
						"productOptionValueDTOs":[
							{
								"productOptionValueImgRelationshipDTOs":[
									{
										"valueId":"",
										"productId":"",
										"imgId":"",
										"createTime":"",
										"updateTime":"",
										"id":"",
										"shopId":""
									}
								],
								"productId":"",
								"createTime":"",
								"optionId":"",
								"updateTime":"",
								"id":"",
								"position":"",
								"value":""
							}
						],
						"name":"",
						"updateTime":"",
						"id":"",
						"shopId":"",
						"position":""
					}
				],
				"productSizeDesc":"",
				"createTime":"",
				"brandId":"",
				"currencyCode":""
			}
		],
		"pageSize":"10",
		"totalCount":"",
		"pageNum":"1"
	},
	"msg":""
}

查询商品详情1.0

接口名(name)：products.detail

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
id	long	是		商品id

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

long

商品id

shopId

long

店铺ID

spuCode

string

商家spu编号

title

string

标题

vendor

string

供应商

brandId

integer

品牌ID

productType

string

商品类别

tags

string

标签

freightTemplateId

long

运费模板ID

productSizeDesc

object

商品尺码表

productShortDesc

object

商品短描述

productLongDesc

object

商品长描述

specialReturnDesc

string

特殊退货政策（html格式）

currencyCode

string

货币编码（三位编码）

taxStatus

boolean

是否收税

seoTitle

string

seo标题

seoDesc

string

set描述

seoKeyword

string

seo关键字

seoUrl

string

seo链接

spuRemark

string

商品备注（供商家标记，不会显示到C端）

publishStatus

integer

发布状态,1:发布;0:未发布

isDeleted

integer

是否删除,1:否;2:是

publishTime

date

发布时间

createTime

date

创建时间

updateTime

date

更新时间

productImgDTOs

array

名称	类型	描述
id	long	商品图片主键ID
productId	long	商品ID
shopId	long	店铺ID
alt	string	图片描述
title	string	图片标题
position	integer	位置
imgUrl	string	图片内容
createTime	date	创建时间
updateTime	date	更新时间

商品图片数组

productOptionDTOs

array

名称

类型

示例值

描述

long

属性主键id

productId

long

商品ID

shopId

long

店铺ID

name

string

名称

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

产品ID

optionId

long

属性id

value

string

描述

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueImgRelationshipDTOs

array

名称	类型	描述
id	long	自增主键
productId	long	产品ID
shopId	long	店铺ID
valueId	long	属性描述ID
imgId	object	图片ID
createTime	date	创建时间
updateTime	date	更新时间

属性描述关联图片数组

属性描述数组

商品属性数组

productCustomizedOptionDTOs

array

名称	类型	描述
id	long	属性主键id
productId	long	商品ID
shopId	long	站点ID
name	string	名称
position	object	位置

商品自定义属性数组

productVariantDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

商品ID

shopId

long

店铺ID

imgId

long

图片ID

skuCode

string

商家sku编号

salePrice

bigdecimal

销售价格

compareAtPrice

bigdecimal

参考价

purchasePrice

bigdecimal

成本价格

skuBarcode

string

sku条码

isTrackInventory

integer

是否追踪库存,0:不追踪;1:追踪

optionValueIds

string

sku销售属性id,多个逗号拼接

optionValueNames

string

sku销售属性名称,多个逗号隔开

customizedOptionNames

string

sku自定义属性名称,多个逗号隔开

grams

integer

商品重量(克)

weight

bigdecimal

商品重量

weightUnit

string

商品重量单位 g,kg,oz,lb

createTime

date

创建时间

updateTime

date

更新时间

productVariantInventoryDTO

object

名称	类型	描述
variantId	long	主键id
availableStockQuantity	integer	可用库存数量
lockedStockQuantity	integer	锁定库存数量
isTrackInventory	integer	是否追踪库存,0:追踪;1:不追踪
inventoryPolicy	string	库存政策,deny:不允许超卖;continue:允许超卖

库存对象

sku数组

删除商品1.0

接口名(name)：products.delete

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
ids	array	是		商品id数组

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
result	boolean		删除结果

新增或更新sku1.0

接口名(name)：products.skus.addOrUpdate

版本号(version)：1.0

请求参数/ 数据模型

名称

类型

是否必须

示例值

描述

productId

long

是

商品id

updateProductVariants

array

否

名称	类型	是否必须	描述
id	long	否	skuId（更新必传）
imgId	long	否	sku关联的图片id
skuCode	string	否	sku编号
salePrice	bigdecimal	否	销售价格
compareAtPrice	bigdecimal	否	参考价
purchasePrice	bigdecimal	否	成本价格
skuBarcode	string	否	sku条码
isTrackInventory	integer	否	是否追踪库存,0:不追踪;1:追踪
optionValueNames	array	否	sku属性描述数组（需要保证该值在spu属性中存在）
customizedOptionNames	array	否	sku自定义属性描述数组（需要保证该值在spu自定义属性中存在）
grams	integer	否	商品重量(克)
weight	bigdecimal	否	商品重量
weightUnit	string	否	商品重量单位(g,kg,oz,lb)
availableStockQuantity	integer	否	库存数量
inventoryPolicy	string	否	库存政策,deny:不允许超卖, continue:允许超卖

商品sku数组

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

long

商品id

shopId

long

店铺ID

spuCode

string

商家spu编号

title

string

标题

vendor

string

供应商

brandId

integer

品牌ID

productType

string

商品类别

tags

string

标签

freightTemplateId

long

运费模板ID

productSizeDesc

object

商品尺码表

productShortDesc

object

商品短描述

productLongDesc

object

商品长描述

specialReturnDesc

string

特殊退货政策（html格式）

currencyCode

string

货币编码（三位编码）

taxStatus

boolean

是否收税

seoTitle

string

seo标题

seoDesc

string

set描述

seoKeyword

string

seo关键字

seoUrl

string

seo链接

spuRemark

string

商品备注（供商家标记，不会显示到C端）

publishStatus

integer

发布状态,1:发布;0:未发布

isDeleted

integer

是否删除,1:否;2:是

publishTime

date

发布时间

createTime

date

创建时间

updateTime

date

更新时间

productImgDTOs

array

名称	类型	描述
id	long	商品图片主键ID
productId	long	商品ID
shopId	long	店铺ID
alt	string	图片描述
title	string	图片标题
position	integer	位置
imgUrl	string	图片内容
createTime	date	创建时间
updateTime	date	更新时间

商品图片数组

productOptionDTOs

array

名称

类型

示例值

描述

long

属性主键id

productId

long

商品ID

shopId

long

店铺ID

name

string

名称

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

产品ID

optionId

long

属性id

value

string

描述

position

object

位置

createTime

date

创建时间

updateTime

date

更新时间

productOptionValueImgRelationshipDTOs

array

名称	类型	描述
id	long	自增主键
productId	long	产品ID
shopId	long	店铺ID
valueId	long	属性描述ID
imgId	object	图片ID
createTime	date	创建时间
updateTime	date	更新时间

属性描述关联图片数组

属性描述数组

商品属性数组

productCustomizedOptionDTOs

array

名称	类型	描述
id	long	属性主键id
productId	long	商品ID
shopId	long	站点ID
name	string	名称
position	object	位置

商品自定义属性数组

productVariantDTOs

array

名称

类型

示例值

描述

long

自增主键

productId

long

商品ID

shopId

long

店铺ID

imgId

long

图片ID

skuCode

string

商家sku编号

salePrice

bigdecimal

销售价格

compareAtPrice

bigdecimal

参考价

purchasePrice

bigdecimal

成本价格

skuBarcode

string

sku条码

isTrackInventory

integer

是否追踪库存,0:不追踪;1:追踪

optionValueIds

string

sku销售属性id,多个逗号拼接

optionValueNames

string

sku销售属性名称,多个逗号隔开

customizedOptionNames

string

sku自定义属性名称,多个逗号隔开

grams

integer

商品重量(克)

weight

bigdecimal

商品重量

weightUnit

string

商品重量单位 g,kg,oz,lb

createTime

date

创建时间

updateTime

date

更新时间

productVariantInventoryDTO

object

名称	类型	描述
variantId	long	主键id
availableStockQuantity	integer	可用库存数量
lockedStockQuantity	integer	锁定库存数量
isTrackInventory	integer	是否追踪库存,0:追踪;1:不追踪
inventoryPolicy	string	库存政策,deny:不允许超卖;continue:允许超卖

库存对象

sku数组

订单模块

查询订单1.0

接口名(name)：Order.list

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
ids	array	否	订单id
limit	integer	是	每页数
page	integer	是	页码
sinceId	long	否	订单id:查询某订单id之后的订单
createdAtMin	date	否	创建时间:查询开始时间(yyyy-MM-dd HH:mm:ss)
createdAtMax	date	否	创建时间:查询结束时间(yyyy-MM-dd HH:mm:ss)
updatedAtMin	date	否	更新时间:查询开始时间(yyyy-MM-dd HH:mm:ss)
updatedAtMax	date	否	更新时间:查询结束时间(yyyy-MM-dd HH:mm:ss)
payAtMin	date	否	支付时间:查询开始时间(yyyy-MM-dd HH:mm:ss)
payAtMax	date	否	支付时间:查询结束时间(yyyy-MM-dd HH:mm:ss)
orderStatus	integer	是	订单状态:状态,-2:所有状态;-1:支付失败;0:待支付;1:支付成功;2:已发货;3:已取消

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

totalCount

integer

总页数

orders

array

名称

类型

示例值

描述

long

订单id

orderNo

string

订单号

orderName

string

订单序号

token

string

订单token

shopId

long

站点id

string

邮箱

phone

string

电话号码

status

integer

订单状态:状态,-1:支付失败;0:待支付;1:支付成功;2:已发货;3:已取消;4:已完成

fulfillmentStatus

integer

物流状态,0:未发货;1: 部分发货;2: 全部发货;3:部分签收;4:完全签收;

gateway

string

支付类型

currency

string

货币类型

orderShipping

object

名称	类型	描述
shippingId	long	运费配置id
shippingTitle	string	运费配置标题
shipAmount	bigdecimal	运费金额
payShipAmount	bigdecimal	实际支付运费金额

运费信息

itemsAmount

bigdecimal

子订单总金额(子订单金额累计)

payItemAmount

bigdecimal

子订单实际支付金额(子订单实际支付累计)

payTotalAmount

bigdecimal

实付总金额(真实支付)

discountsAmount

bigdecimal

总折扣优惠金额(不包含免邮费用)

totalWeight

bigdecimal

总重量

number

integer

总子单数

taxAmount

bigdecimal

总税费

payTaxAmount

bigdecimal

实际支付税费

shipInsuranceAmount

bigdecimal

总运费险金额

payShipInsuranceAmount

bigdecimal

实际支付运费险金额

taxRate

bigdecimal

税率

totalTipReceived

bigdecimal

收到小费总额

test

boolean

是否为测试订单

clientId

string

浏览器id

clientDetail

object

名称	类型	示例值	描述
browserIp	string		浏览器ip
customerLocale	string		浏览器语言

浏览器信息

customer

object

名称	类型	示例值	描述
email	string		顾客邮箱
acceptsMarketing	boolean		是否接收营销邮件

消费者信息

buyerAcceptsMarketing

boolean

是否接收营销邮箱

tags

string

标签

sourceName

string

用户下单渠道(web、ios、android)

buyerRemark

string

买家备注

sellerRemark

string

卖家备注

landingSite

string

落地页链接

referringSite

string

归因链接

domain

string

下单域名

payTime

date

支付时间

canceledReason

string

取消原因

cancelledTime

date

取消时间

createTime

date

下单时间

updateTime

date

订单更新时间

closedAt

date

订单关闭时间

billingAddress

object

名称	类型	描述
firstName	string	名字
lastName	string	姓名
address1	string	地址1
address2	string	地址2
countryCode	string	国家码
country	string	国家
provinceCode	string	省级码
province	string	省
city	string	城市
zip	string	邮政编号
phone	string	电话号码
company	string	公司

账单地址

shippingAddress

object

名称	类型	描述
firstName	string	收货人名字
lastName	string	收货人姓名
address1	string	地址1
address2	string	地址2
countryCode	string	国家码
country	string	国家
provinceCode	string	省级码
province	string	省
city	string	城市
zip	string	邮政编号
phone	string	电话号码
company	string	公司
taxNo	string	税号
identityNumber	string	身份证号
houseNumber	string	门牌号

收货地址

payment

object

名称	类型	描述
paymentId	string	支付交易流水号
merchantId	string	收款方id
creditCardNumber	string	支付账号
creditCardCompany	string	支付公司

支付账单信息

orderItems

array

名称	类型	描述
id	long	子订单号
productId	long	商品id
variantId	long	sku id
title	string	商品标题
quantity	integer	订单商品数
skuCode	string	sku code
vendor	string	供应商
fulfillmentStatus	string	物流状态，发货：Shipped；待发货：Pending；取消发货：Cancel
financialStatus	string	支付状态，支付失败：Fail；待支付：Pending；已支付：Paid；退款中：Refunding；已退款：Refunded；取消：Cancel
variantOption	string	SKU属性（多个逗号分隔）
variantOptionValue	string	SKU属性值（多个逗号分隔）
variantImgUrl	string	SKU图片链接
variantProductUrl	string	SKU链接
variantCustomizedOption	string	SKU自定义属性
saleAmount	bigdecimal	销售金额
payAmount	bigdecimal	支付金额
variantPrice	bigdecimal	sku价格
totalDiscount	bigdecimal	折扣金额
createTime	date	创建时间
updateTime	date	更新时间
refundStatus	integer	退款状态，-1：退款失败；0：未退款；1：部分退款；2：退款成功
refundQuantity	integer	退货数量
isGift	boolean	是否是赠品
taxAmount	bigdecimal	子订单税费

子订单信息

fulfillments

array

名称

类型

示例值

描述

long

物流id

status

string

物流状态

createTime

date

创建时间

updateTime

date

更新时间

trackingCompany

string

物流公司

trackingNumber

string

物流单号

fulfillmentItems

array

名称	类型	描述
id	long	子物流id
fulfillmentId	long	物流id
variantId	long	sku id
orderItemId	long	子订单id
quantity	integer	商品数量
skuCode	string	sku code

子物流信息

物流信息

discounts

array

名称

类型

示例值

描述

discountId

long

折扣id

code

string

折扣码

type

integer

折扣码类型,1:满件打折；2:搭售；3:满额减；4:捆绑销售；5:满件减；6:首单折扣；7:满额送；8:叠加

title

string

折扣标题

amount

bigdecimal

折扣优惠金额

discountItems

array

名称	类型	描述
orderItemId	long	子订单id
variantId	long	skuId
quantity	integer	当前折扣里，受到优惠的sku数量
totalQuantity	integer	当前折扣里，总的sku数量
discountAmount	bigdecimal	优惠金额

折扣信息明细数组

折扣信息数组

订单列表

{
	"code":"0",
	"data":{
		"orders":[
			{
				"canceledReason":"",
				"payTime":"",
				"clientDetail":{
					"customerLocale":"",
					"browserIp":""
				},
				"orderItems":[
					{
						"saleAmount":"",
						"quantity":"",
						"productId":"",
						"variantOption":"",
						"refundStatus":"",
						"updateTime":"",
						"title":"",
						"refundQuantity":"",
						"variantProductUrl":"",
						"fulfillmentStatus":"",
						"variantCustomizedOption":"",
						"payAmount":"",
						"createTime":"",
						"vendor":"",
						"financialStatus":"",
						"totalDiscount":"",
						"isGift":"",
						"variantPrice":"",
						"id":"",
						"variantId":"",
						"taxAmount":"",
						"skuCode":"",
						"variantImgUrl":"",
						"variantOptionValue":""
					}
				],
				"fulfillmentStatus":"1",
				"number":"",
				"buyerRemark":"",
				"fulfillments":[
					{
						"createTime":"",
						"fulfillmentItems":[
							{
								"fulfillmentId":"",
								"quantity":"",
								"orderItemId":"",
								"id":"",
								"variantId":"",
								"skuCode":""
							}
						],
						"trackingCompany":"",
						"updateTime":"",
						"id":"",
						"trackingNumber":"",
						"status":""
					}
				],
				"payShipInsuranceAmount":"",
				"discounts":[
					{
						"discountItems":[
							{
								"quantity":"",
								"totalQuantity":"",
								"orderItemId":"",
								"discountAmount":"",
								"variantId":""
							}
						],
						"amount":"",
						"code":"",
						"discountId":"",
						"type":"",
						"title":""
					}
				],
				"orderShipping":{
					"payShipAmount":"",
					"shippingId":"",
					"shippingTitle":"",
					"shipAmount":""
				},
				"currency":"",
				"payment":{
					"merchantId":"",
					"paymentId":"",
					"creditCardNumber":"",
					"creditCardCompany":""
				},
				"id":"",
				"shopId":"",
				"landingSite":"",
				"closedAt":"",
				"email":"",
				"orderName":"",
				"orderNo":"",
				"clientId":"",
				"test":"",
				"shipInsuranceAmount":"",
				"payTotalAmount":"",
				"referringSite":"",
				"updateTime":"",
				"totalTipReceived":"",
				"token":"",
				"tags":"",
				"sellerRemark":"",
				"taxRate":"",
				"phone":"",
				"buyerAcceptsMarketing":"",
				"createTime":"",
				"cancelledTime":"",
				"domain":"",
				"itemsAmount":"",
				"payItemAmount":"",
				"discountsAmount":"",
				"totalWeight":"",
				"shippingAddress":{
					"zip":"",
					"lastName":"",
					"country":"",
					"address2":"",
					"city":"",
					"address1":"",
					"provinceCode":"",
					"houseNumber":"",
					"firstName":"",
					"province":"",
					"phone":"",
					"identityNumber":"",
					"countryCode":"",
					"company":"",
					"taxNo":""
				},
				"sourceName":"",
				"billingAddress":{
					"zip":"",
					"firstName":"",
					"lastName":"",
					"country":"",
					"province":"",
					"address2":"",
					"city":"",
					"phone":"",
					"address1":"",
					"countryCode":"",
					"provinceCode":"",
					"company":""
				},
				"taxAmount":"",
				"payTaxAmount":"",
				"gateway":"",
				"status":"1",
				"customer":{
					"acceptsMarketing":"",
					"email":""
				}
			}
		],
		"totalCount":""
	},
	"msg":""
}

查询订单详情1.0

接口名(name)：Order.detail

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
id	long	是		订单id

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

long

订单id

orderNo

string

订单号

orderName

string

订单序号

token

string

订单token

shopId

long

站点id

string

邮箱

phone

string

电话号码

status

integer

订单状态:状态,-1:支付失败;0:待支付;1:支付成功;2:已发货;3:已取消;4:已完成

fulfillmentStatus

integer

物流状态,0:未发货;1: 部分发货;2: 全部发货;3:部分签收;4:完全签收;

gateway

string

支付类型

currency

string

货币类型

orderShipping

object

名称	类型	描述
shippingId	long	运费配置id
shippingTitle	string	运费配置标题
shipAmount	bigdecimal	运费金额
payShipAmount	bigdecimal	实际支付运费金额

运费信息

itemsAmount

bigdecimal

子订单总金额(子订单金额累计)

payItemAmount

bigdecimal

子订单实际支付金额(子订单实际支付累计)

payTotalAmount

bigdecimal

实付总金额(真实支付)

discountsAmount

bigdecimal

总折扣优惠金额(不包含免邮费用)

totalWeight

bigdecimal

总重量

number

integer

总子单数

taxAmount

bigdecimal

总税费

payTaxAmount

bigdecimal

实际支付税费

shipInsuranceAmount

bigdecimal

总运费险金额

payShipInsuranceAmount

bigdecimal

实际支付运费险金额

taxRate

bigdecimal

税率

totalTipReceived

bigdecimal

收到小费总额

test

boolean

是否为测试订单

clientId

string

浏览器id

clientDetail

object

名称	类型	示例值	描述
browserIp	string		浏览器ip
customerLocale	string		浏览器语言

浏览器信息

customer

object

名称	类型	示例值	描述
email	string		顾客邮箱
acceptsMarketing	boolean		是否接收营销邮件

消费者信息

buyerAcceptsMarketing

boolean

是否接收营销邮箱

tags

string

标签

sourceName

string

用户下单渠道(web、ios、android)

buyerRemark

string

买家备注

sellerRemark

string

卖家备注

landingSite

string

落地页链接

referringSite

string

归因链接

domain

string

下单域名

payTime

date

支付时间

canceledReason

string

取消原因

cancelledTime

date

取消时间

createTime

date

下单时间

updateTime

date

订单更新时间

closedAt

date

订单关闭时间

billingAddress

object

名称	类型	描述
firstName	string	名字
lastName	string	姓名
address1	string	地址1
address2	string	地址2
countryCode	string	国家码
country	string	国家
provinceCode	string	省级码
province	string	省
city	string	城市
zip	string	邮政编号
phone	string	电话号码
company	string	公司

账单地址

shippingAddress

object

名称	类型	描述
firstName	string	收货人名字
lastName	string	收货人姓名
address1	string	地址1
address2	string	地址2
countryCode	string	国家码
country	string	国家
provinceCode	string	省级码
province	string	省
city	string	城市
zip	string	邮政编号
phone	string	电话号码
company	string	公司
taxNo	string	税号
identityNumber	string	身份证号
houseNumber	string	门牌号

收货地址

payment

object

名称	类型	描述
paymentId	string	支付交易流水号
merchantId	string	收款方id
creditCardNumber	string	支付账号
creditCardCompany	string	支付公司

支付账单信息

orderItems

array

名称	类型	描述
id	long	子订单号
productId	long	商品id
variantId	long	sku id
title	string	商品标题
quantity	integer	订单商品数
skuCode	string	sku code
vendor	string	供应商
fulfillmentStatus	string	物流状态，发货：Shipped；待发货：Pending；取消发货：Cancel
financialStatus	string	支付状态，支付失败：Fail；待支付：Pending；已支付：Paid；退款中：Refunding；已退款：Refunded；取消：Cancel
variantOption	string	SKU属性（多个逗号分隔）
variantOptionValue	string	SKU属性值（多个逗号分隔）
variantImgUrl	string	SKU图片链接
variantProductUrl	string	SKU链接
variantCustomizedOption	string	SKU自定义属性
saleAmount	bigdecimal	销售金额
payAmount	bigdecimal	支付金额
variantPrice	bigdecimal	sku价格
totalDiscount	bigdecimal	折扣金额
createTime	date	创建时间
updateTime	date	更新时间
refundStatus	integer	退款状态，-1：退款失败；0：未退款；1：部分退款；2：退款成功
refundQuantity	integer	退货数量
isGift	boolean	是否是赠品
taxAmount	bigdecimal	子订单税费

子订单信息

fulfillments

array

名称

类型

示例值

描述

long

物流id

status

string

物流状态

createTime

date

创建时间

updateTime

date

更新时间

trackingCompany

string

物流公司

trackingNumber

string

物流单号

fulfillmentItems

array

名称	类型	描述
id	long	子物流id
fulfillmentId	long	物流id
variantId	long	sku id
orderItemId	long	子订单id
quantity	integer	商品数量
skuCode	string	sku code

子物流信息

物流信息

discounts

array

名称

类型

示例值

描述

discountId

long

折扣id

code

string

折扣码

type

integer

折扣码类型,1:满件打折；2:搭售；3:满额减；4:捆绑销售；5:满件减；6:首单折扣；7:满额送；8:叠加

title

string

折扣标题

amount

bigdecimal

折扣优惠金额

discountItems

array

名称	类型	描述
orderItemId	long	子订单id
variantId	long	skuId
quantity	integer	当前折扣里，受到优惠的sku数量
totalQuantity	integer	当前折扣里，总的sku数量
discountAmount	bigdecimal	优惠金额

折扣信息明细数组

折扣信息数组

{
	"code":"0",
	"data":{
		"canceledReason":"",
		"payTime":"",
		"clientDetail":{
			"customerLocale":"",
			"browserIp":""
		},
		"orderItems":[
			{
				"saleAmount":"",
				"quantity":"",
				"productId":"",
				"variantOption":"",
				"refundStatus":"",
				"updateTime":"",
				"title":"",
				"refundQuantity":"",
				"variantProductUrl":"",
				"fulfillmentStatus":"",
				"variantCustomizedOption":"",
				"payAmount":"",
				"createTime":"",
				"vendor":"",
				"financialStatus":"",
				"totalDiscount":"",
				"isGift":"",
				"variantPrice":"",
				"id":"",
				"variantId":"",
				"taxAmount":"",
				"skuCode":"",
				"variantImgUrl":"",
				"variantOptionValue":""
			}
		],
		"fulfillmentStatus":"1",
		"number":"",
		"buyerRemark":"",
		"fulfillments":[
			{
				"createTime":"",
				"fulfillmentItems":[
					{
						"fulfillmentId":"",
						"quantity":"",
						"orderItemId":"",
						"id":"",
						"variantId":"",
						"skuCode":""
					}
				],
				"trackingCompany":"",
				"updateTime":"",
				"id":"",
				"trackingNumber":"",
				"status":""
			}
		],
		"payShipInsuranceAmount":"",
		"discounts":[
			{
				"discountItems":[
					{
						"quantity":"",
						"totalQuantity":"",
						"orderItemId":"",
						"discountAmount":"",
						"variantId":""
					}
				],
				"amount":"",
				"code":"",
				"discountId":"",
				"type":"",
				"title":""
			}
		],
		"orderShipping":{
			"payShipAmount":"",
			"shippingId":"",
			"shippingTitle":"",
			"shipAmount":""
		},
		"currency":"",
		"payment":{
			"merchantId":"",
			"paymentId":"",
			"creditCardNumber":"",
			"creditCardCompany":""
		},
		"id":"",
		"shopId":"",
		"landingSite":"",
		"closedAt":"",
		"email":"",
		"orderName":"",
		"orderNo":"",
		"clientId":"",
		"test":"",
		"shipInsuranceAmount":"",
		"payTotalAmount":"",
		"referringSite":"",
		"updateTime":"",
		"totalTipReceived":"",
		"token":"",
		"tags":"",
		"sellerRemark":"",
		"taxRate":"",
		"phone":"",
		"buyerAcceptsMarketing":"",
		"createTime":"",
		"cancelledTime":"",
		"domain":"",
		"itemsAmount":"",
		"payItemAmount":"",
		"discountsAmount":"",
		"totalWeight":"",
		"shippingAddress":{
			"zip":"",
			"lastName":"",
			"country":"",
			"address2":"",
			"city":"",
			"address1":"",
			"provinceCode":"",
			"houseNumber":"",
			"firstName":"",
			"province":"",
			"phone":"",
			"identityNumber":"",
			"countryCode":"",
			"company":"",
			"taxNo":""
		},
		"sourceName":"",
		"billingAddress":{
			"zip":"",
			"firstName":"",
			"lastName":"",
			"country":"",
			"province":"",
			"address2":"",
			"city":"",
			"phone":"",
			"address1":"",
			"countryCode":"",
			"provinceCode":"",
			"company":""
		},
		"taxAmount":"",
		"payTaxAmount":"",
		"gateway":"",
		"status":"1",
		"customer":{
			"acceptsMarketing":"",
			"email":""
		}
	},
	"msg":""
}

更新订单1.0

接口名(name)：Order.update

版本号(version)：1.0

请求参数/ 数据模型

名称

类型

是否必须

示例值

描述

orderShippingAddress

object

否

名称	类型	是否必须	描述
id	long	否	收货地址ID
orderNo	string	是	订单号
email	string	否	邮箱地址
acceptsMarketing	boolean	否	是否接收营销邮件
firstName	string	否	姓(未传或已传但值的长度超出256字符则此字段数据不做修改)
lastName	string	否	名(未传或已传但值的长度超出256字符则此字段数据不做修改)
address1	string	否	地址1(未传或已传但值的长度超出256字符则此字段数据不做修改)
address2	string	否	地址2(未传或已传但值的长度超出256字符则此字段数据不做修改)
cityCode	string	否	城市编码
city	string	否	城市(未传或已传但值超出256字符则此字段数据不做修改)
provinceCode	string	否	邮政编码(未传或已传但值不正确则此字段数据不做修改，值不正确即超出64字符或countryCode不存在或countryCode下的provinceCode不存在)
province	string	否	省(未传或已传但值超出256字符则此字段数据不做修改)
countryCode	string	否	国家编码(未传或已传但值不正确则此字段数据不做修改，值不正确即超出64字符或countryCode不存在或countryCode下的provinceCode不存在)
country	string	否	国家(未传或已传但值超出256字符则此字段数据不做修改)
company	string	否	公司(未传或已传但值超出256字符则此字段数据不做修改)
phone	string	否	电话号码(未传或已传但值超出128字符则此字段数据不做修改)
zip	string	否	邮编(未传或已传但值超出24字符则此字段数据不做修改)
createTime	date	否	创建时间
updateTime	date	否	更新时间

收货地址

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
success	boolean		更新的结果(true-成功;false-失败)
errorMsg	string		错误信息

UTM模块

查询UTM1.0

接口名(name)：UTM.list

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
orderNos	array	是		订单号

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

orderUtms

array

名称

类型

示例值

描述

orderNo

string

订单号

utms

array

名称	类型	描述
sessionId	string	会话id
clientId	string	浏览器id
landingPage	string	落地页
utmSource	string	utm source
utmCampaign	string	utm campaign
utmMedium	string	utm medium
utmTerm	string	utm term
utmContent	string	utm content
createTime	date	创建时间

utm信息

查询UTMV21.0

接口名(name)：UTM.listV2

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
orderNos	array	是		订单号

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

orderUtms

array

名称

类型

示例值

描述

orderNo

string

订单号

utms

array

名称	类型	描述
sessionId	string	会话id
clientId	string	浏览器id
landingPage	string	落地页
utmSource	string	utm source
utmCampaign	string	utm campaign
utmMedium	string	utm medium
utmTerm	string	utm term
utmContent	string	utm content
createTime	date	创建时间

utm信息

物流模块

查询物流1.0

接口名(name)：Fulfillment.list

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
orderNo	string	是		订单号

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

fulfillments

array

名称

类型

示例值

描述

long

物流id

status

string

物流状态

createTime

date

创建时间

updateTime

date

更新时间

trackingCompany

string

物流公司

trackingNumber

string

物流单号

fulfillmentItems

array

名称	类型	描述
id	long	子物流id
fulfillmentId	long	物流id
variantId	long	sku id
orderItemId	long	子订单id
quantity	integer	商品数量
skuCode	string	sku code

子物流信息

物流列表

新增物流1.0

接口名(name)：Fulfillment.add

版本号(version)：1.0

请求参数/ 数据模型

名称

类型

是否必须

示例值

描述

orderNo

string

是

订单号

trackingNumber

string

是

物流号

trackingCompany

string

否

物流公司

lineItems

array

否

名称	类型	是否必须	示例值	描述
id	long	是		子订单id

子物流信息

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	描述
id	long	物流Id
orderNo	string	订单号
code	integer	业务响应码，code=0则正常
msg	string	响应详情

更新物流1.0

接口名(name)：Fulfillment.update

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
id	long	是	物流id
orderNo	string	是	订单号
trackingNumber	string	是	物流号
trackingCompany	string	是	物流公司

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	描述
id	long	物流Id
orderNo	string	订单号
code	integer	业务响应码，code=0则正常
msg	string	响应详情

商品系列模块

查询商品系列列表1.0

接口名(name)：collections

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
ids	array	否	主键数组
updatedAtMin	date	否	更新时间:查询开始时间
updatedAtMax	date	否	更新时间:查询结束时间
pageNum	integer	是	第几页
pageSize	integer	是	每页几条数据(最大可设置200)

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

totalCount

integer

总数

collections

array

名称	类型	描述
id	long	专辑主键
title	string	专辑名称
seoUrl	string	专辑访问地址
collectionDesc	string	商品专辑描述
dataType	integer	商品专辑数据类型,1:自动;2:手动
spuIds	string	手动spuId列表（手动专辑必传，spuId逗号分割）
conditionType	integer	自动条件选项,1:满足所有;2:满足任一（自动专辑必传）
filterSpuCodes	string	过滤的spuCode列表,逗号分隔
sortType	integer	排序规则,1:畅销降序;2:点击率降序;3:时间降序;
isManual	integer	是否手动指定排序,1:是;2:否
tag	integer	商品标签,2:sale;3:new
collectionImageUrl	string	专辑图片地址
collectionImageDesc	string	专辑图片描述
seoTitle	string	搜索引擎优化-标题
seoDesc	string	搜索引擎优化-desc
seoKeyword	string	搜索引擎优化-关键字
seoRedirect	integer	是否重定向,1:是;2:否(如有seoUrl的修改，是否创建xxx.com到yyy.com url重定向)
isDeleted	integer	是否删除,1:否;2:是
updateTime	date	专辑更新时间
createTime	date	专辑创建时间

专辑列表

新增商品系列1.0

接口名(name)：collections.add

版本号(version)：1.0

请求参数/ 数据模型

名称

类型

是否必须

示例值

描述

title

string

是

商品专辑标题

collectionDesc

string

否

商品专辑描述

dataType

integer

是

商品专辑数据类型,1:自动;2:手动

spuIds

string

否

手动spuId列表（手动专辑必传，spuId逗号分割）

conditionType

integer

否

自动条件选项,1:满足所有;2:满足任一（自动专辑必传）

filterSpuCodes

string

否

过滤的spuCode列表,逗号分隔

conditions

array

否

名称	类型	是否必须	描述
filterObj	integer	是	筛选对象(1:商品标题;2:商品类目;3:商品库存;4:标签;5:售价)
filterType	integer	是	筛选类型(1:包含;2:不包含;3:等于;4:不等于;5:开头为;6:结尾为;7:小于;8:大于;9:标签-等于;10:售价-存在大于;11:售价-存在小于;12:售价-存在等于;13:售价-存在不等于)
target	string	是	目标值

自动条件列表（自动专辑必传）

sortType

integer

否

排序规则,1:畅销降序;2:点击率降序;3:时间降序;

isManual

integer

是

是否手动指定排序,1:是;2:否

customSortList

array

否

名称	类型	是否必须	示例值	描述
spuId	long	是		指定排序的spuId
sortIndex	integer	是		指定排序的序号下标，从0开始

自定义排序数组

tag

integer

否

商品标签,2:sale;3:new

collectionImageUrl

string

否

专辑图片地址

collectionImageDesc

string

否

专辑图片描述

seoTitle

string

否

搜索引擎优化-标题

seoUrl

string

否

搜索引擎优化-url（商品专辑访问链接）

seoDesc

string

否

搜索引擎优化-desc

seoKeyword

string

否

搜索引擎优化-关键字

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
result	long		商品系列主键id

更新商品系列1.0

接口名(name)：collections.update

版本号(version)：1.0

请求参数/ 数据模型

名称

类型

是否必须

示例值

描述

long

是

商品专辑主键

title

string

否

商品专辑标题

collectionDesc

string

否

商品专辑描述

dataType

integer

否

商品专辑数据类型,1:自动;2:手动

spuIds

string

否

手动spuId列表（手动专辑使用，spuId逗号分割）

conditionType

integer

否

自动条件选项,1:满足所有;2:满足任一（自动专辑使用）

filterSpuCodes

string

否

过滤的spuCode列表,逗号分隔

conditions

array

否

名称	类型	是否必须	描述
filterObj	integer	是	筛选对象(1:商品标题;2:商品类目;3:商品库存;4:标签;5:售价)
filterType	integer	是	筛选类型(1:包含;2:不包含;3:等于;4:不等于;5:开头为;6:结尾为;7:小于;8:大于;9:标签-等于;10:售价-存在大于;11:售价-存在小于;12:售价-存在等于;13:售价-存在不等于)
target	string	是	目标值

自动条件列表（自动专辑使用）

sortType

integer

否

排序规则,1:畅销降序;2:点击率降序;3:时间降序;

isManual

integer

否

是否手动指定排序,1:是;2:否

customSortList

array

否

名称	类型	是否必须	示例值	描述
spuId	long	是		指定排序的spuId
sortIndex	integer	是		指定排序的序号下标，从0开始

自定义排序数组

tag

integer

否

商品标签,2:sale;3:new

collectionImageUrl

string

否

专辑图片地址

collectionImageDesc

string

否

专辑图片描述

seoTitle

string

否

搜索引擎优化-标题

seoUrl

string

否

搜索引擎优化-url（商品专辑访问链接）

seoDesc

string

否

搜索引擎优化-desc

seoKeyword

string

否

搜索引擎优化-关键字

seoRedirect

integer

否

是否重定向,1:是;2:否(如有seoUrl的修改，是否创建xxx.com到yyy.com url重定向)

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
result	long		商品系列主键id

查询商品系列详情1.0

接口名(name)：collections.detail

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
id	long	是	商品专辑主键id
pageNum	integer	否	分页获取对应商品列表-第几页
pageSize	integer	否	分页获取对应商品列表-每页几条数据(最大可设置1000)

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

long

专辑主键

title

string

专辑名称

seoUrl

string

专辑访问地址

collectionDesc

string

商品专辑描述

dataType

integer

商品专辑数据类型,1:自动;2:手动

spuIds

string

手动spuId列表（手动专辑必传，spuId逗号分割）

conditionType

integer

自动条件选项,1:满足所有;2:满足任一（自动专辑必传）

filterSpuCodes

string

过滤的spuCode列表,逗号分隔

conditions

array

名称	类型	描述
filterObj	integer	筛选对象(1:商品标题;2:商品类目;3:商品库存;4:标签;5:售价)
filterType	integer	筛选类型(1:包含;2:不包含;3:等于;4:不等于;5:开头为;6:结尾为;7:小于;8:大于;9:标签-等于;10:售价-存在大于;11:售价-存在小于;12:售价-存在等于;13:售价-存在不等于)
target	string	目标值

自动条件列表（自动专辑必传）

sortType

integer

排序规则,1:畅销降序;2:点击率降序;3:时间降序;

isManual

integer

是否手动指定排序,1:是;2:否

customSortList

array

名称	类型	示例值	描述
spuId	long		指定排序的spuId
sortIndex	integer		指定排序的序号下标，从0开始

自定义排序数组

tag

integer

商品标签,2:sale;3:new

collectionImageUrl

string

专辑图片地址

collectionImageDesc

string

专辑图片描述

seoTitle

string

搜索引擎优化-标题

seoDesc

string

搜索引擎优化-desc

seoKeyword

string

搜索引擎优化-关键字

seoRedirect

integer

是否重定向,1:是;2:否(如有seoUrl的修改，是否创建xxx.com到yyy.com url重定向)

isDeleted

integer

是否删除,1:否;2:是

updateTime

date

专辑更新时间

createTime

date

专辑创建时间

products

array

名称	类型	描述
id	long	商品ID
title	string	商品名称
seoUrl	string	商品访问地址
spuCode	string	spuCode
updateTime	date	商品更新时间
createTime	date	商品上传时间

专辑商品列表明细

productCount

long

专辑商品列表总数

删除商品系列1.0

接口名(name)：collections.delete

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
id	long	是		商品系列主键id

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
result	boolean		删除结果

店铺模块

查询店铺1.0

接口名(name)：merchant

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	描述
id	long	站点id
name	string	站点名称
email	string	站点联系人邮箱
category	string	行业
customerEmail	string	站点客服邮箱
legalPersonName	string	法人姓名
companyName	string	法定公司名称
phone	string	电话
address	string	地址
zip	string	邮编
currency	string	结算货币

客户模块

客户列表1.0

接口名(name)：customer.list

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
ids	string	否	客户ID,多个用英文逗号分隔
email	string	否	邮箱
createdAtMin	date	否	起始创建时间
createdAtMax	date	否	结束创建时间
updatedAtMin	date	否	起始更新时间
updatedAtMax	date	否	结束更新时间
pageNum	integer	是	页码
pageSize	integer	是	每页记录条数

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

totalCount

integer

总条数

customers

array

名称

类型

示例值

描述

long

客户ID

shopId

long

店铺ID

firstName

string

姓

lastName

string

名

string

邮箱

phone

string

手机号

acceptsMarketing

boolean

是否订阅

country

string

国家

countryCode

string

国家代码

province

string

省份

provinceCode

string

省份代码

totalOrderCount

long

总下单数次数

totalOrderAmount

bigdecimal

下单总金额

createTime

date

创建时间

updateTime

date

更新时间

addresses

array

名称	类型	描述
id	long	地址ID
customerId	long	客户ID
shopId	long	店铺ID
firstName	string	姓
lastName	string	名
email	string	邮箱
phone	string	手机号
address1	string	地址1
address2	string	地址2
country	string	国家
countryCode	string	国家编码
province	string	省份
provinceCode	string	省份编码
city	string	城市
cityCode	string	城市编码
zip	string	邮编
isDef	boolean	是否默认地址

地址

客户列表

客户详情1.0

接口名(name)：customer.detail

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
id	long	是		客户ID

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

long

客户ID

shopId

long

店铺ID

firstName

string

姓

lastName

string

名

string

邮箱

phone

string

手机号

acceptsMarketing

boolean

是否订阅

country

string

国家

countryCode

string

国家代码

province

string

省份

provinceCode

string

省份代码

totalOrderCount

long

总下单数次数

totalOrderAmount

bigdecimal

下单总金额

createTime

date

创建时间

updateTime

date

更新时间

addresses

array

名称	类型	描述
id	long	地址ID
customerId	long	客户ID
shopId	long	店铺ID
firstName	string	姓
lastName	string	名
email	string	邮箱
phone	string	手机号
address1	string	地址1
address2	string	地址2
country	string	国家
countryCode	string	国家编码
province	string	省份
provinceCode	string	省份编码
city	string	城市
cityCode	string	城市编码
zip	string	邮编
isDef	boolean	是否默认地址

地址

更新客户1.0

接口名(name)：customer.update

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
id	long	是	客户ID
firstName	string	否	姓
lastName	string	否	名
phone	string	否	手机号
acceptsMarketing	integer	否	是否订阅 0:否 1:是

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

long

客户ID

shopId

long

店铺ID

firstName

string

姓

lastName

string

名

string

邮箱

phone

string

手机号

acceptsMarketing

boolean

是否订阅

country

string

国家

countryCode

string

国家代码

province

string

省份

provinceCode

string

省份代码

totalOrderCount

long

总下单数次数

totalOrderAmount

bigdecimal

下单总金额

createTime

date

创建时间

updateTime

date

更新时间

addresses

array

名称	类型	描述
id	long	地址ID
customerId	long	客户ID
shopId	long	店铺ID
firstName	string	姓
lastName	string	名
email	string	邮箱
phone	string	手机号
address1	string	地址1
address2	string	地址2
country	string	国家
countryCode	string	国家编码
province	string	省份
provinceCode	string	省份编码
city	string	城市
cityCode	string	城市编码
zip	string	邮编
isDef	boolean	是否默认地址

地址

webhook模块

webhook事件列表1.0

接口名(name)：webhook.event

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
events	array		事件类型：products_create/products_update/products_delete/order_create/order_update/customer_create/customer_update

webhook创建1.0

接口名(name)：webhook.create

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
url	string	是	推送地址
event	string	是	事件类型：product_create/product_update/product_delete/order_create/order_update
platform	string	是	平台：Shoplus_BI
apiSecret	string	否	加密密钥

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	描述
id	string	id
shopId	long	店铺ID
url	string	推送地址
event	string	事件类型：product_create/product_update/product_delete/order_create/order_update
platform	string	平台：Shoplus_BI
apiSecret	string	加密密钥
createTime	date	创建时间
updateTime	date	更新时间

webhook更新1.0

接口名(name)：webhook.update

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	描述
id	string	是	webhook ID
url	string	否	推送地址
event	string	否	事件类型：product_create/product_update/product_delete/order_create/order_update
platform	string	否	平台：Shoplus_BI
apiSecret	string	否	加密密钥

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	描述
id	string	id
shopId	long	店铺ID
url	string	推送地址
event	string	事件类型：product_create/product_update/product_delete/order_create/order_update
platform	string	平台：Shoplus_BI
apiSecret	string	加密密钥
createTime	date	创建时间
updateTime	date	更新时间

webhook查询1.0

接口名(name)：webhook.list

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
limit	integer	是		每页数
page	integer	是		页码

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称

类型

示例值

描述

webHookVOList

array

名称	类型	描述
id	string	id
shopId	long	店铺ID
url	string	推送地址
event	string	事件类型：product_create/product_update/product_delete/order_create/order_update
platform	string	平台：Shoplus_BI
apiSecret	string	加密密钥
createTime	date	创建时间
updateTime	date	更新时间

店铺webhook列表

webhook详情1.0

接口名(name)：webhook.detail

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
id	string	是		webhook ID

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	描述
id	string	id
shopId	long	店铺ID
url	string	推送地址
event	string	事件类型：product_create/product_update/product_delete/order_create/order_update
platform	string	平台：Shoplus_BI
apiSecret	string	加密密钥
createTime	date	创建时间
updateTime	date	更新时间

webhook删除1.0

接口名(name)：webhook.delete

版本号(version)：1.0

请求参数/ 数据模型

名称	类型	是否必须	示例值	描述
id	string	是		webhook ID

返回结果/数据模型

名称

类型

描述

code

string

状态值，"0"表示成功，其它都是失败

msg

string

错误信息，出错时显示

data

object

返回的数据，没有则返回{}

名称	类型	示例值	描述
result	boolean		删除结果

开发对接附录

签名算法介绍

签名算法描述如下：
1.将请求参数按参数名升序排序；
2.按请求参数名及参数值相互连接组成一个字符串：<paramName1><paramValue1><paramName2><paramValue2>...；
3.将应用密钥分别添加到以上请求参数串的头部和尾部：<secret><请求参数字符串><secret>；
4.对该字符串进行MD5（全部大写），MD5后的字符串即是这些请求参数对应的签名；
5.该签名值使用sign参数一起和其它请求参数一起发送给服务开放平台。

伪代码:
Map<String,Object> paramsMap = new ...; // 参数

Set<String> keySet = paramsMap.keySet();
List<String> paramNames = new ArrayList<String>(keySet);
// 1.
Collections.sort(paramNames);

StringBuilder paramNameValue = new StringBuilder();
// 2.
for (String paramName : paramNames) {
    paramNameValue.append(paramName).append(paramsMap.get(paramName));
}
// 3.
String source = secret + paramNameValue.toString() + secret;
// 4.
String sign = md5(source);
// 5.
paramsMap.put("sign",sign);

Java代码请求示例

                
<!-- httpclient maven依赖-->
<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.13</version>
</dependency>

                
import com.alibaba.fastjson.JSON;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;
import java.net.URLEncoder;
import java.security.MessageDigest;
import java.text.SimpleDateFormat;
import java.util.*;

/**
 * @Author: shoplus
 * @Date: 2020/10/20 10:39
 * @Description: 查询商品详情1.0
 */
public class TestOpenApi {

    public static void main(String[] args) throws Exception {
        String appKey = "配置项.app_key";
        String secret = "配置项.secret";
        // 业务参数
        Map<String, Object> jsonMap = new HashMap<String, Object>();
        jsonMap.put("id", 19945L);

        String json = JSON.toJSONString(jsonMap);
        json = URLEncoder.encode(json, "utf-8");

        // 系统参数
        Map<String, Object> param = new HashMap<String, Object>();
        // 查询商品详情1.0
        param.put("name", "products.detail");
        param.put("version", "1.0");
        param.put("app_key", appKey);
        param.put("data", json);
        param.put("timestamp", getTime());


        String sign = buildSign(param, secret);
        param.put("sign", sign);

        System.out.println("=====请求数据=====");
        String postJson = JSON.toJSONString(param);
        System.out.println(postJson);

        HttpPost request = new HttpPost("https://api-portal.shoplus.net/open-api");
        CloseableHttpClient httpClient = HttpClients.createDefault();
        request.setEntity(new StringEntity(postJson));
        CloseableHttpResponse response = httpClient.execute(request);
        System.out.println(EntityUtils.toString(response.getEntity()));
    }

    /**
     * 构建签名
     *
     * @param paramsMap 参数
     * @param secret    密钥
     * @return
     * @throws IOException
     */
    public static String buildSign(Map<String, ?> paramsMap, String secret) throws IOException {
        Set<String> keySet = paramsMap.keySet();
        List<String> paramNames = new ArrayList<String>(keySet);

        Collections.sort(paramNames);

        StringBuilder paramNameValue = new StringBuilder();

        for (String paramName : paramNames) {
            paramNameValue.append(paramName).append(paramsMap.get(paramName));
        }

        String source = secret + paramNameValue.toString() + secret;

        return md5(source);
    }

    /**
     * 生成md5,全部大写
     *
     * @param message
     * @return
     */
    public static String md5(String message) {
        try {
            // 1 创建一个提供信息摘要算法的对象，初始化为md5算法对象
            MessageDigest md = MessageDigest.getInstance("MD5");

            // 2 将消息变成byte数组
            byte[] input = message.getBytes();

            // 3 计算后获得字节数组,这就是那128位了
            byte[] buff = md.digest(input);

            // 4 把数组每一字节（一个字节占八位）换成16进制连成md5字符串
            return byte2hex(buff);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * 二进制转十六进制字符串
     *
     * @param bytes
     * @return
     */
    private static String byte2hex(byte[] bytes) {
        StringBuilder sign = new StringBuilder();
        for (int i = 0; i < bytes.length; i++) {
            String hex = Integer.toHexString(bytes[i] & 0xFF);
            if (hex.length() == 1) {
                sign.append("0");
            }
            sign.append(hex.toUpperCase());
        }
        return sign.toString();
    }

    public static String getTime() {
        return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
    }

}

Shoplus-sdk请求示例

                
<!-- shoplus-sdk maven依赖-->
<dependency>
    <groupId>io.gitee.deep_feel</groupId>
    <artifactId>shoplus-sdk</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

                
String url = "https://api-portal.shoplus.net/open-api";
String appKey = "配置项.app_key";
String secret = "配置项.secret";

OpenClient client = new OpenClient(url, appKey, secret);

// 创建请求对象(查询商品详情1.0)
CommonRequest request = new CommonRequest("products.detail", "1.0");
// 请求参数
Map<String, Object> param = new HashMap<>(16);
param.put("id", 19945L);
request.setParam(param);

// 发送请求
CommonResponse response = client.execute(request);

if (response.isSuccess()) {
    // 返回结果
    Map<String, Object> responseData = response.getData();
    System.out.println(responseData.get("title"));
    System.out.println(responseData.get("seoUrl"));
} else {
    System.out.println("errorCode:" + response.getCode() + ",errorMsg:" + response.getMsg());
}

Js代码请求示例

JavaScript版本:js-sdk下载

                
sdk.config({
    url : 'https://api-portal.shoplus.net/open-api'
    ,app_key : '配置项.app_key'
    ,secret : '配置项.secret'
});

sdk.post({
	name:'products.detail' // 接口名
 	,version:'1.0'
	,data  : {'id':19945} // 请求参数
	,callback:function(resp) { // 成功回调
		console.log(resp)
	}
});

webhook对接

前提

    接收webhook需完成webhook的创建
    创建webhook请查看上文的webhook接口

接口

    1、订单webhook

       支持事件:order_create、order_update

       请求method:POST

       headers
                Content-Type:application/json
                WebHook-Event:{事件类型:order_create\order_update}

       body
                {
                    "billingAddress":{
                        "address1":"广州",
                        "address2":"sd",
                        "city":"guangzhou",
                        "country":"China",
                        "countryCode":"CN",
                        "firstName":"chen",
                        "lastName":"dandan",
                        "phone":"22222",
                        "province":"Guangdong",
                        "provinceCode":"CN-GD",
                        "zip":"00000"
                    },
                    "buyerAcceptsMarketing":true,
                    "clientDetail":{
                        "browserIp":"172.17.48.0"
                    },
                    "clientId":"531106138222886912",
                    "createTime":1616488739000,
                    "currency":"USD",
                    "customer":{
                        "acceptsMarketing":true,
                        "email":"czj1@cc.com"
                    },
                    "discounts":[

                    ],
                    "discountsAmount":0,
                    "email":"czj1@cc.com",
                    "gateway":"Stripe",
                    "id":531464955418787840,
                    "itemsAmount":16.05,
                    "number":1,
                    "orderItems":[
                        {
                            "createTime":1606877585000,
                            "financialStatus":"Pending",
                            "fulfillmentStatus":"Shipped",
                            "id":531464955276181500,
                            "payAmount":16.05,
                            "productId":9,
                            "quantity":1,
                            "saleAmount":16.05,
                            "skuCode":"100003875459",
                            "title":"badge canvas shoulder bag college wind student multi-purpose handbag casual candy",
                            "totalDiscount":0,
                            "updateTime":1616503500000,
                            "variantId":37,
                            "variantOptionValue":"134465 White",
                            "variantPrice":16.05,
                            "vendor":"dsp-buy"
                        }
                    ],
                    "orderNo":"5202012027521001",
                    "orderShipping":{
                        "payShipAmount":0,
                        "shipAmount":0,
                        "shippingId":71,
                        "shippingTitle":"Free"
                    },
                    "payItemAmount":16.05,
                    "payTime":1606877591000,
                    "payTotalAmount":16.05,
                    "payment":{
                        "creditCardCompany":"Stripe"
                    },
                    "phone":"22222",
                    "shippingAddress":{
                        "address1":"广州",
                        "address2":"sd",
                        "city":"guangzhou",
                        "country":"China",
                        "countryCode":"CN",
                        "firstName":"chen",
                        "lastName":"dandan",
                        "phone":"22222",
                        "province":"Guangdong",
                        "provinceCode":"CN-GD",
                        "zip":"00000"
                    },
                    "shopId":0,
                    "sourceName":"test",
                    "status":1,
                    "test":false,
                    "token":"ffbb0ff8-ee54-4cfa-8601-838214748cae",
                    "totalWeight":0,
                    "updateTime":1622098157000,
                    "sign":""
                }

    2、商品webhook

       支持事件:product_create、product_update、product_delete

       请求method:POST

       headers
                Content-Type:application/json
                WebHook-Event:{事件类型:order_create\order_update}

       body
                {
                    "createTime":1623835941084,
                    "freightTemplateId":0,
                    "id":47814,
                    "productImgDTOs":[
                        {
                            "createTime":1623835941085,
                            "id":1092091,
                            "imgUrl":"https://test-img.algobuy.net/products/5b2ea7bb42ee45bcb4ddf3b9d634aeb0.jpg",
                            "position":1,
                            "productId":47814,
                            "shopId":0,
                            "updateTime":1623835941085
                        }
                    ],
                    "productLongDesc":"",
                    "productOptionDTOs":[
                        {
                            "createTime":1623835941085,
                            "id":947073,
                            "name":"Color",
                            "position":1,
                            "productId":47814,
                            "productOptionValueDTOs":[
                                {
                                    "createTime":1623835941086,
                                    "id":1124246,
                                    "optionId":947073,
                                    "position":1,
                                    "productId":47814,
                                    "productOptionValueImgRelationshipDTOs":[

                                    ],
                                    "updateTime":1623835941086,
                                    "value":"grey"
                                },
                                {
                                    "createTime":1623835941086,
                                    "id":1124247,
                                    "optionId":947073,
                                    "position":2,
                                    "productId":47814,
                                    "productOptionValueImgRelationshipDTOs":[

                                    ],
                                    "updateTime":1623835941086,
                                    "value":"black"
                                },
                                {
                                    "createTime":1623835941087,
                                    "id":1124248,
                                    "optionId":947073,
                                    "position":3,
                                    "productId":47814,
                                    "productOptionValueImgRelationshipDTOs":[

                                    ],
                                    "updateTime":1623835941087,
                                    "value":"grey*2"
                                },
                                {
                                    "createTime":1623835941087,
                                    "id":1124249,
                                    "optionId":947073,
                                    "position":4,
                                    "productId":47814,
                                    "productOptionValueImgRelationshipDTOs":[

                                    ],
                                    "updateTime":1623835941087,
                                    "value":"black*2"
                                },
                                {
                                    "createTime":1623835941088,
                                    "id":1124250,
                                    "optionId":947073,
                                    "position":5,
                                    "productId":47814,
                                    "productOptionValueImgRelationshipDTOs":[

                                    ],
                                    "updateTime":1623835941088,
                                    "value":"grey*1+black*1"
                                }
                            ],
                            "shopId":0,
                            "updateTime":1623835941085
                        }
                    ],
                    "productShortDesc":"[]",
                    "productType":"Clothing-women clothing-Dresses",
                    "productVariantDTOs":[
                        {
                            "compareAtPrice":20,
                            "createTime":1623835941089,
                            "grams":100,
                            "id":1011698,
                            "isTrackInventory":1,
                            "optionValueIds":"1124246",
                            "optionValueNames":"grey",
                            "productId":47814,
                            "productVariantInventoryDTO":{
                                "availableStockQuantity":0,
                                "inventoryPolicy":"deny",
                                "lockedStockQuantity":0,
                                "variantId":1011698
                            },
                            "salePrice":0.7,
                            "shopId":0,
                            "skuCode":"100004740712",
                            "updateTime":1623835941089,
                            "weight":100,
                            "weightUnit":"g"
                        },
                        {
                            "compareAtPrice":20,
                            "createTime":1623835941090,
                            "grams":100,
                            "id":1011699,
                            "isTrackInventory":0,
                            "optionValueIds":"1124247",
                            "optionValueNames":"black",
                            "productId":47814,
                            "productVariantInventoryDTO":{
                                "availableStockQuantity":29,
                                "inventoryPolicy":"deny",
                                "lockedStockQuantity":0,
                                "variantId":1011699
                            },
                            "salePrice":18,
                            "shopId":0,
                            "skuCode":"100004740713",
                            "updateTime":1623835941090,
                            "weight":100,
                            "weightUnit":"g"
                        },
                        {
                            "compareAtPrice":40,
                            "createTime":1623835941091,
                            "grams":200,
                            "id":1011700,
                            "isTrackInventory":0,
                            "optionValueIds":"1124248",
                            "optionValueNames":"grey*2",
                            "productId":47814,
                            "productVariantInventoryDTO":{
                                "availableStockQuantity":29,
                                "inventoryPolicy":"deny",
                                "lockedStockQuantity":0,
                                "variantId":1011700
                            },
                            "salePrice":36,
                            "shopId":0,
                            "skuCode":"100004740714",
                            "updateTime":1623835941091,
                            "weight":200,
                            "weightUnit":"g"
                        },
                        {
                            "compareAtPrice":40,
                            "createTime":1623835941092,
                            "grams":200,
                            "id":1011701,
                            "isTrackInventory":0,
                            "optionValueIds":"1124249",
                            "optionValueNames":"black*2",
                            "productId":47814,
                            "productVariantInventoryDTO":{
                                "availableStockQuantity":30,
                                "inventoryPolicy":"deny",
                                "lockedStockQuantity":0,
                                "variantId":1011701
                            },
                            "salePrice":36,
                            "shopId":0,
                            "skuCode":"100004740715",
                            "updateTime":1623835941092,
                            "weight":200,
                            "weightUnit":"g"
                        },
                        {
                            "compareAtPrice":40,
                            "createTime":1623835941093,
                            "grams":200,
                            "id":1011702,
                            "isTrackInventory":0,
                            "optionValueIds":"1124250",
                            "optionValueNames":"grey*1+black*1",
                            "productId":47814,
                            "productVariantInventoryDTO":{
                                "availableStockQuantity":29,
                                "inventoryPolicy":"deny",
                                "lockedStockQuantity":0,
                                "variantId":1011702
                            },
                            "salePrice":36,
                            "shopId":0,
                            "skuCode":"100004740716",
                            "updateTime":1623835941093,
                            "weight":200,
                            "weightUnit":"g"
                        }
                    ],
                    "publishStatus":1,
                    "publishTime":1623835941084,
                    "seoDesc":"Buy add. Online Shopping Dresses, The Best  Shoes & Bags. Discover unique designers fashion at dspbuy.pierrebuy.com",
                    "seoTitle":"Dresses - add of  dsp-buy",
                    "seoUrl":"algobuy.net/products/196456-add",
                    "shopId":0,
                    "spuCode":"",
                    "tags":"Dresses,Clothing,women clothing",
                    "title":"add",
                    "updateTime":1623835941084,
                    "vendor":"dsp-buy",
                    "sign":""
                }

        3、客户webhook

       支持事件:customer_create、customer_update

       请求method:POST

       headers
                Content-Type:application/json
                WebHook-Event:{事件类型:customer_create\customer_update}
       body
        {
        "acceptsMarketing":true,
        "addresses":[
            {
                "address1":"338号 Wen Cheng Lu",
                "address2":"wetwt",
                "city":"Mobile",
                "cityCode":"",
                "country":"China",
                "countryCode":"CN",
                "customerId":5360,
                "email":"xiaochanghong@zhizh.com",
                "firstName":"X",
                "id":24216,
                "isDef":false,
                "lastName":"ss",
                "phone":"456974141",
                "province":"Shanghai",
                "provinceCode":"CN-SH",
                "shopId":0,
                "zip":"528200"
            }
        ],
        "createTime":1625119722247,
        "email":"12345xxx@zhizh.com",
        "firstName":"X",
        "id":5360,
        "lastName":"XX",
        "shopId":0,
        "totalOrderAmount":158.77,
        "totalOrderCount":1,
        "updateTime":1625119722248
    }

        4、店铺webhook

       支持事件:shop_update

       请求method:POST

       headers
                Content-Type:application/json
                WebHook-Event:{事件类型:shop_update}
        body
            {
        "address":"建工路4号",
        "category":"1,3,2,5,4,6,7",
        "companyName":"momomo",
        "currency":"USD",
        "customerEmail":"836543420@qq.com",
        "email":"jy18665986483@gmail.com",
        "id":0,
        "legalPersonName":"yang jing",
        "name":"test-algobuy",
        "phone":"0000",
        "zip":"510000"
    }

签名

    请求中均带有sign签名,接收webhook请先检查签名

    sign签名加密方式:
        1、将报文中所有非空参数按照参数名 ASCII 码排序( 字典序)
        2、拼接请求参数的值(value1value2...)
        3、在步骤2拼接完所有值后最后再拼接上api_secret
        4、使用步骤3拼接完的值进行SHA256进行加密

签名加密示例代码

    
        public static String getSHA256Sign(Object obj, String salt){
        Map <String, Object > map = null;
        try {
            map = BasicRequest.bean2map(obj);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
        Map<String, Object> collect = map.entrySet().stream()
                .sorted(Map.Entry.comparingByKey())
                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue,
                        (oldValue, newValue) -> oldValue, LinkedHashMap::new));
        StringBuffer code = new StringBuffer();
        collect.keySet().forEach(key -> {
            if (!"sign".equals(key)) {
                Object value = collect.get(key);
                code.append(value);
            }

        });
        code.append(salt);
        return SHA256Util.getSHA256(code.toString());
    }