下载文档

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

配置项

HTTP请求地址
app_key
secret

商品模块

添加商品1.0

接口名(name):products.add
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
spuCodestring商家spu编号
titlestring商品名称
vendorstring供应商
brandIdinteger品牌ID(预留,暂时没用)
productTypestring商品类别(字符串,由商家自定义)
tagsstring标签(字符串,由商家自定义)
freightTemplateIdlong运费模板ID(预留,暂时没用)
productSizeDescstring商品尺码表(html table格式)
productShortDescstring商品短描述(JSON格式)
productLongDescstring商品长描述(html格式)
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述(访问链接,不传系统自动生成[spucode-title])
seoKeywordstringseo关键字
seoUrlstringseo链接
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布(默认发布状态)
productImagesarray
名称类型是否必须示例值描述
attachmentstringBase64格式图片(attachment/imgUrl二者选传一个)
fileNamestringBase64格式图片名称
imgUrlstring图片url链接(attachment/imgUrl二者选传一个)
altstring图片描述
titlestring图片标题
positioninteger图片展示顺序
商品图片数组
productOptionsarray
名称类型是否必须示例值描述
namestring商品属性名称
positioninteger属性展示位置
productOptionValuesarray
名称类型是否必须示例值描述
valuestring商品属性描述
positioninteger商品属性描述展示位置
imageUrlstring属性图片url
商品属性描述数组
商品属性数组
productCustomizedOptionsarray
名称类型是否必须示例值描述
namestring商品自定义属性名称
positioninteger商品自定义属性展示位置
商品自定义属性数组
productVariantsarray
名称类型是否必须示例值描述
skuCodestring商家sku编号
salePricebigdecimal销售价格
compareAtPricebigdecimal参考价
purchasePricebigdecimal成本价格
skuBarcodestringsku条码
imgUrlstringsku图片
isTrackInventoryinteger是否追踪库存,0:不追踪;1:追踪
optionValueNamesarraysku属性描述数组(需要保证该值在spu属性中存在)
customizedOptionNamesarraysku自定义属性描述数组(需要保证该值在spu自定义属性中存在)
gramsinteger商品重量(克)
weightbigdecimal商品重量
weightUnitstring商品重量单位(g,kg,oz,lb)
availableStockQuantityinteger库存数量
inventoryPolicystring库存政策,deny:不允许超卖, continue:允许超卖
skuRemarkstringsku备注(供商家标记,不会显示到C端)
sku数组
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong商品id
shopIdlong店铺ID
spuCodestring商家spu编号
titlestring标题
vendorstring供应商
brandIdinteger品牌ID
productTypestring商品类别
tagsstring标签
freightTemplateIdlong运费模板ID
productSizeDescobject商品尺码表
productShortDescobject商品短描述
productLongDescobject商品长描述
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述
seoKeywordstringseo关键字
seoUrlstringseo链接
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布
isDeletedinteger是否删除,1:否;2:是
publishTimedate发布时间
createTimedate创建时间
updateTimedate更新时间
productImgDTOsarray
名称类型示例值描述
idlong商品图片主键ID
productIdlong商品ID
shopIdlong店铺ID
altstring图片描述
titlestring图片标题
positioninteger位置
imgUrlstring图片内容
createTimedate创建时间
updateTimedate更新时间
商品图片数组
productOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong店铺ID
namestring名称
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
optionIdlong属性id
valuestring描述
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueImgRelationshipDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
shopIdlong店铺ID
valueIdlong属性描述ID
imgIdobject图片ID
createTimedate创建时间
updateTimedate更新时间
属性描述关联图片数组
属性描述数组
商品属性数组
productCustomizedOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong站点ID
namestring名称
positionobject位置
商品自定义属性数组
productVariantDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong商品ID
shopIdlong店铺ID
imgIdlong图片ID
skuCodestring商家sku编号
salePricebigdecimal销售价格
compareAtPricebigdecimal参考价
purchasePricebigdecimal成本价格
skuBarcodestringsku条码
isTrackInventoryinteger是否追踪库存,0:不追踪;1:追踪
optionValueIdsstringsku销售属性id,多个逗号拼接
optionValueNamesstringsku销售属性名称,多个逗号隔开
customizedOptionNamesstringsku自定义属性名称,多个逗号隔开
gramsinteger商品重量(克)
weightbigdecimal商品重量
weightUnitstring商品重量单位 g,kg,oz,lb
createTimedate创建时间
updateTimedate更新时间
productVariantInventoryDTOobject
名称类型示例值描述
variantIdlong主键id
availableStockQuantityinteger可用库存数量
lockedStockQuantityinteger锁定库存数量
isTrackInventoryinteger是否追踪库存,0:追踪;1:不追踪
inventoryPolicystring库存政策,deny:不允许超卖;continue:允许超卖
库存对象
sku数组


全量更新商品1.0

接口名(name):products.updateAll
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong商品id
spuCodestring商家spu编号
titlestring商品名称
vendorstring供应商
brandIdinteger品牌ID(预留,暂时没用)
productTypestring商品类别(字符串,由商家自定义)
tagsstring标签(字符串,由商家自定义)
freightTemplateIdlong运费模板ID(预留,暂时没用)
productSizeDescstring商品尺码表(html table格式)
productShortDescstring商品短描述(JSON)
productLongDescstring商品长描述(html格式)
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述
seoKeywordstringseo关键字
seoUrlstringseo链接(访问链接,不传系统自动生成[spucode-title])
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布
productImagesarray
名称类型是否必须示例值描述
attachmentstringBase64格式图片(attachment/imgUrl二者选传一个)
fileNamestringBase64格式图片名称
imgUrlstring图片url链接(attachment/imgUrl二者选传一个)
altstring图片描述
titlestring图片标题
positioninteger图片展示顺序
商品图片数组
productOptionsarray
名称类型是否必须示例值描述
namestring商品属性名称
positioninteger属性展示位置
productOptionValuesarray
名称类型是否必须示例值描述
valuestring商品属性描述
positioninteger商品属性描述展示位置
imageUrlstring属性图片url
商品属性描述数组
商品属性数组
productCustomizedOptionsarray
名称类型是否必须示例值描述
namestring商品自定义属性名称
positioninteger商品自定义属性展示位置
商品自定义属性数组
productVariantsarray
名称类型是否必须示例值描述
idlong商家skuId(更新必传)
skuCodestring商家sku编号
salePricebigdecimal销售价格
compareAtPricebigdecimal参考价
purchasePricebigdecimal成本价格
skuBarcodestringsku条码
imgUrlstringsku图片
isTrackInventoryinteger是否追踪库存,0:不追踪;1:追踪
optionValueNamesarraysku属性描述数组(需要保证该值在spu属性中存在)
customizedOptionNamesarraysku自定义属性描述数组(需要保证该值在spu自定义属性中存在)
gramsinteger商品重量(克)
weightbigdecimal商品重量
weightUnitstring商品重量单位(g,kg,oz,lb)
availableStockQuantityinteger库存数量
inventoryPolicystring库存政策,deny:不允许超卖, continue:允许超卖
skuRemarkstringsku备注(供商家标记,不会显示到C端)
sku数组
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong商品id
shopIdlong店铺ID
spuCodestring商家spu编号
titlestring标题
vendorstring供应商
brandIdinteger品牌ID
productTypestring商品类别
tagsstring标签
freightTemplateIdlong运费模板ID
productSizeDescobject商品尺码表
productShortDescobject商品短描述
productLongDescobject商品长描述
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述
seoKeywordstringseo关键字
seoUrlstringseo链接
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布
isDeletedinteger是否删除,1:否;2:是
publishTimedate发布时间
createTimedate创建时间
updateTimedate更新时间
productImgDTOsarray
名称类型示例值描述
idlong商品图片主键ID
productIdlong商品ID
shopIdlong店铺ID
altstring图片描述
titlestring图片标题
positioninteger位置
imgUrlstring图片内容
createTimedate创建时间
updateTimedate更新时间
商品图片数组
productOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong店铺ID
namestring名称
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
optionIdlong属性id
valuestring描述
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueImgRelationshipDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
shopIdlong店铺ID
valueIdlong属性描述ID
imgIdobject图片ID
createTimedate创建时间
updateTimedate更新时间
属性描述关联图片数组
属性描述数组
商品属性数组
productCustomizedOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong站点ID
namestring名称
positionobject位置
商品自定义属性数组
productVariantDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong商品ID
shopIdlong店铺ID
imgIdlong图片ID
skuCodestring商家sku编号
salePricebigdecimal销售价格
compareAtPricebigdecimal参考价
purchasePricebigdecimal成本价格
skuBarcodestringsku条码
isTrackInventoryinteger是否追踪库存,0:不追踪;1:追踪
optionValueIdsstringsku销售属性id,多个逗号拼接
optionValueNamesstringsku销售属性名称,多个逗号隔开
customizedOptionNamesstringsku自定义属性名称,多个逗号隔开
gramsinteger商品重量(克)
weightbigdecimal商品重量
weightUnitstring商品重量单位 g,kg,oz,lb
createTimedate创建时间
updateTimedate更新时间
productVariantInventoryDTOobject
名称类型示例值描述
variantIdlong主键id
availableStockQuantityinteger可用库存数量
lockedStockQuantityinteger锁定库存数量
isTrackInventoryinteger是否追踪库存,0:追踪;1:不追踪
inventoryPolicystring库存政策,deny:不允许超卖;continue:允许超卖
库存对象
sku数组


更新SPU基础信息1.0

接口名(name):products.updateSpuSelective
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong商品id
spuCodestring商家spu编号
titlestring商品名称
vendorstring供应商
brandIdinteger品牌ID(预留,暂时没用)
productTypestring商品类别(字符串,由商家自定义)
tagsstring标签(字符串,由商家自定义)
freightTemplateIdlong运费模板ID(预留,暂时没用)
productSizeDescstring商品尺码表(html table格式)
productShortDescstring商品短描述(JSON)
productLongDescstring商品长描述(html格式)
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述
seoKeywordstringseo关键字
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
resultboolean更新结果


批量更新SPU基础信息1.0

接口名(name):products.updateSpuSelectiveBatch
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
productsarray
名称类型是否必须示例值描述
idlong商品id
spuCodestring商家spu编号
titlestring商品名称
vendorstring供应商
brandIdinteger品牌ID(预留,暂时没用)
productTypestring商品类别(字符串,由商家自定义)
tagsstring标签(字符串,由商家自定义)
freightTemplateIdlong运费模板ID(预留,暂时没用)
productSizeDescstring商品尺码表(html table格式)
productShortDescstring商品短描述(JSON)
productLongDescstring商品长描述(html格式)
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述
seoKeywordstringseo关键字
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布
商品数组
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
resultboolean更新结果


查询商品列表1.0

接口名(name):products
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idsarray 商品ids
fieldsarray 返回字段属性,1:商品图片;2:商品属性;3:sku(默认返回所有信息)
updatedAtMindate起始更新时间
updatedAtMaxdate结束更新时间
pageNuminteger第几页
pageSizeinteger每页几条数据(最大可设置200)
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
totalCountinteger数据总量
productVOsarray
名称类型示例值描述
idlong商品id
shopIdlong店铺ID
spuCodestring商家spu编号
titlestring标题
vendorstring供应商
brandIdinteger品牌ID
productTypestring商品类别
tagsstring标签
freightTemplateIdlong运费模板ID
productSizeDescobject商品尺码表
productShortDescobject商品短描述
productLongDescobject商品长描述
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述
seoKeywordstringseo关键字
seoUrlstringseo链接
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布
isDeletedinteger是否删除,1:否;2:是
publishTimedate发布时间
createTimedate创建时间
updateTimedate更新时间
productImgDTOsarray
名称类型示例值描述
idlong商品图片主键ID
productIdlong商品ID
shopIdlong店铺ID
altstring图片描述
titlestring图片标题
positioninteger位置
imgUrlstring图片内容
createTimedate创建时间
updateTimedate更新时间
商品图片数组
productOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong店铺ID
namestring名称
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
optionIdlong属性id
valuestring描述
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueImgRelationshipDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
shopIdlong店铺ID
valueIdlong属性描述ID
imgIdobject图片ID
createTimedate创建时间
updateTimedate更新时间
属性描述关联图片数组
属性描述数组
商品属性数组
productCustomizedOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong站点ID
namestring名称
positionobject位置
商品自定义属性数组
productVariantDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong商品ID
shopIdlong店铺ID
imgIdlong图片ID
skuCodestring商家sku编号
salePricebigdecimal销售价格
compareAtPricebigdecimal参考价
purchasePricebigdecimal成本价格
skuBarcodestringsku条码
isTrackInventoryinteger是否追踪库存,0:不追踪;1:追踪
optionValueIdsstringsku销售属性id,多个逗号拼接
optionValueNamesstringsku销售属性名称,多个逗号隔开
customizedOptionNamesstringsku自定义属性名称,多个逗号隔开
gramsinteger商品重量(克)
weightbigdecimal商品重量
weightUnitstring商品重量单位 g,kg,oz,lb
createTimedate创建时间
updateTimedate更新时间
productVariantInventoryDTOobject
名称类型示例值描述
variantIdlong主键id
availableStockQuantityinteger可用库存数量
lockedStockQuantityinteger锁定库存数量
isTrackInventoryinteger是否追踪库存,0:追踪;1:不追踪
inventoryPolicystring库存政策,deny:不允许超卖;continue:允许超卖
库存对象
sku数组
商品列表
pageNuminteger1第几页
pageSizeinteger10每页几条数据(最大可设置200)


查询商品详情1.0

接口名(name):products.detail
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong商品id
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong商品id
shopIdlong店铺ID
spuCodestring商家spu编号
titlestring标题
vendorstring供应商
brandIdinteger品牌ID
productTypestring商品类别
tagsstring标签
freightTemplateIdlong运费模板ID
productSizeDescobject商品尺码表
productShortDescobject商品短描述
productLongDescobject商品长描述
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述
seoKeywordstringseo关键字
seoUrlstringseo链接
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布
isDeletedinteger是否删除,1:否;2:是
publishTimedate发布时间
createTimedate创建时间
updateTimedate更新时间
productImgDTOsarray
名称类型示例值描述
idlong商品图片主键ID
productIdlong商品ID
shopIdlong店铺ID
altstring图片描述
titlestring图片标题
positioninteger位置
imgUrlstring图片内容
createTimedate创建时间
updateTimedate更新时间
商品图片数组
productOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong店铺ID
namestring名称
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
optionIdlong属性id
valuestring描述
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueImgRelationshipDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
shopIdlong店铺ID
valueIdlong属性描述ID
imgIdobject图片ID
createTimedate创建时间
updateTimedate更新时间
属性描述关联图片数组
属性描述数组
商品属性数组
productCustomizedOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong站点ID
namestring名称
positionobject位置
商品自定义属性数组
productVariantDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong商品ID
shopIdlong店铺ID
imgIdlong图片ID
skuCodestring商家sku编号
salePricebigdecimal销售价格
compareAtPricebigdecimal参考价
purchasePricebigdecimal成本价格
skuBarcodestringsku条码
isTrackInventoryinteger是否追踪库存,0:不追踪;1:追踪
optionValueIdsstringsku销售属性id,多个逗号拼接
optionValueNamesstringsku销售属性名称,多个逗号隔开
customizedOptionNamesstringsku自定义属性名称,多个逗号隔开
gramsinteger商品重量(克)
weightbigdecimal商品重量
weightUnitstring商品重量单位 g,kg,oz,lb
createTimedate创建时间
updateTimedate更新时间
productVariantInventoryDTOobject
名称类型示例值描述
variantIdlong主键id
availableStockQuantityinteger可用库存数量
lockedStockQuantityinteger锁定库存数量
isTrackInventoryinteger是否追踪库存,0:追踪;1:不追踪
inventoryPolicystring库存政策,deny:不允许超卖;continue:允许超卖
库存对象
sku数组


删除商品1.0

接口名(name):products.delete
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idsarray 商品id数组
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
resultboolean删除结果


新增或更新sku1.0

接口名(name):products.skus.addOrUpdate
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
productIdlong商品id
updateProductVariantsarray
名称类型是否必须示例值描述
idlongskuId(更新必传)
imgIdlongsku关联的图片id
skuCodestringsku编号
salePricebigdecimal销售价格
compareAtPricebigdecimal参考价
purchasePricebigdecimal成本价格
skuBarcodestringsku条码
isTrackInventoryinteger是否追踪库存,0:不追踪;1:追踪
optionValueNamesarraysku属性描述数组(需要保证该值在spu属性中存在)
customizedOptionNamesarraysku自定义属性描述数组(需要保证该值在spu自定义属性中存在)
gramsinteger商品重量(克)
weightbigdecimal商品重量
weightUnitstring商品重量单位(g,kg,oz,lb)
availableStockQuantityinteger库存数量
inventoryPolicystring库存政策,deny:不允许超卖, continue:允许超卖
商品sku数组
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong商品id
shopIdlong店铺ID
spuCodestring商家spu编号
titlestring标题
vendorstring供应商
brandIdinteger品牌ID
productTypestring商品类别
tagsstring标签
freightTemplateIdlong运费模板ID
productSizeDescobject商品尺码表
productShortDescobject商品短描述
productLongDescobject商品长描述
specialReturnDescstring特殊退货政策(html格式)
currencyCodestring货币编码(三位编码)
taxStatusboolean是否收税
seoTitlestringseo标题
seoDescstringset描述
seoKeywordstringseo关键字
seoUrlstringseo链接
spuRemarkstring商品备注(供商家标记,不会显示到C端)
publishStatusinteger发布状态,1:发布;0:未发布
isDeletedinteger是否删除,1:否;2:是
publishTimedate发布时间
createTimedate创建时间
updateTimedate更新时间
productImgDTOsarray
名称类型示例值描述
idlong商品图片主键ID
productIdlong商品ID
shopIdlong店铺ID
altstring图片描述
titlestring图片标题
positioninteger位置
imgUrlstring图片内容
createTimedate创建时间
updateTimedate更新时间
商品图片数组
productOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong店铺ID
namestring名称
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
optionIdlong属性id
valuestring描述
positionobject位置
createTimedate创建时间
updateTimedate更新时间
productOptionValueImgRelationshipDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong产品ID
shopIdlong店铺ID
valueIdlong属性描述ID
imgIdobject图片ID
createTimedate创建时间
updateTimedate更新时间
属性描述关联图片数组
属性描述数组
商品属性数组
productCustomizedOptionDTOsarray
名称类型示例值描述
idlong属性主键id
productIdlong商品ID
shopIdlong站点ID
namestring名称
positionobject位置
商品自定义属性数组
productVariantDTOsarray
名称类型示例值描述
idlong自增主键
productIdlong商品ID
shopIdlong店铺ID
imgIdlong图片ID
skuCodestring商家sku编号
salePricebigdecimal销售价格
compareAtPricebigdecimal参考价
purchasePricebigdecimal成本价格
skuBarcodestringsku条码
isTrackInventoryinteger是否追踪库存,0:不追踪;1:追踪
optionValueIdsstringsku销售属性id,多个逗号拼接
optionValueNamesstringsku销售属性名称,多个逗号隔开
customizedOptionNamesstringsku自定义属性名称,多个逗号隔开
gramsinteger商品重量(克)
weightbigdecimal商品重量
weightUnitstring商品重量单位 g,kg,oz,lb
createTimedate创建时间
updateTimedate更新时间
productVariantInventoryDTOobject
名称类型示例值描述
variantIdlong主键id
availableStockQuantityinteger可用库存数量
lockedStockQuantityinteger锁定库存数量
isTrackInventoryinteger是否追踪库存,0:追踪;1:不追踪
inventoryPolicystring库存政策,deny:不允许超卖;continue:允许超卖
库存对象
sku数组


订单模块

查询订单1.0

接口名(name):Order.list
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idsarray 订单id
limitinteger每页数
pageinteger页码
sinceIdlong订单id:查询某订单id之后的订单
createdAtMindate创建时间:查询开始时间(yyyy-MM-dd HH:mm:ss)
createdAtMaxdate创建时间:查询结束时间(yyyy-MM-dd HH:mm:ss)
updatedAtMindate更新时间:查询开始时间(yyyy-MM-dd HH:mm:ss)
updatedAtMaxdate更新时间:查询结束时间(yyyy-MM-dd HH:mm:ss)
payAtMindate支付时间:查询开始时间(yyyy-MM-dd HH:mm:ss)
payAtMaxdate支付时间:查询结束时间(yyyy-MM-dd HH:mm:ss)
orderStatusinteger订单状态:状态,-2:所有状态;-1:支付失败;0:待支付;1:支付成功;2:已发货;3:已取消
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
totalCountinteger总页数
ordersarray
名称类型示例值描述
idlong订单id
orderNostring订单号
tokenstring订单token
shopIdlong站点id
emailstring邮箱
phonestring电话号码
statusinteger1订单状态:状态,-1:支付失败;0:待支付;1:支付成功;2:已发货;3:已取消;4:已完成
fulfillmentStatusinteger1物流状态,0:未发货;1: 部分发货;2: 全部发货;3:部分签收;4:完全签收;
gatewaystring支付类型
currencystring货币类型
orderShippingobject
名称类型示例值描述
shippingIdlong运费配置id
shippingTitlestring运费配置标题
shipAmountbigdecimal运费金额
payShipAmountbigdecimal实际支付运费金额
运费信息
itemsAmountbigdecimal子订单总金额(子订单金额累计)
payItemAmountbigdecimal子订单实际支付金额(子订单实际支付累计)
payTotalAmountbigdecimal实付总金额(真实支付)
discountsAmountbigdecimal总折扣优惠金额(不包含免邮费用)
totalWeightbigdecimal总重量
numberinteger总子单数
taxAmountbigdecimal总税费
payTaxAmountbigdecimal实际支付税费
shipInsuranceAmountbigdecimal总运费险金额
payShipInsuranceAmountbigdecimal实际支付运费险金额
taxRatebigdecimal税率
totalTipReceivedbigdecimal收到小费总额
testboolean是否为测试订单
clientIdstring浏览器id
clientDetailobject
名称类型示例值描述
browserIpstring浏览器ip
customerLocalestring浏览器语言
浏览器信息
customerobject
名称类型示例值描述
emailstring顾客邮箱
acceptsMarketingboolean是否接收营销邮件
消费者信息
buyerAcceptsMarketingboolean是否接收营销邮箱
tagsstring标签
sourceNamestring用户下单渠道(web、ios、android)
buyerRemarkstring买家备注
sellerRemarkstring卖家备注
landingSitestring落地页链接
referringSitestring归因链接
payTimedate支付时间
canceledReasonstring取消原因
cancelledTimedate取消时间
createTimedate下单时间
updateTimedate订单更新时间
closedAtdate订单关闭时间
billingAddressobject
名称类型示例值描述
firstNamestring名字
lastNamestring姓名
address1string地址1
address2string地址2
countryCodestring国家码
countrystring国家
provinceCodestring省级码
provincestring
citystring城市
zipstring邮政编号
phonestring电话号码
companystring公司
账单地址
shippingAddressobject
名称类型示例值描述
firstNamestring收货人名字
lastNamestring收货人姓名
address1string地址1
address2string地址2
countryCodestring国家码
countrystring国家
provinceCodestring省级码
provincestring
citystring城市
zipstring邮政编号
phonestring电话号码
companystring公司
收货地址
paymentobject
名称类型示例值描述
paymentIdstring支付交易流水号
merchantIdstring收款方id
creditCardNumberstring支付账号
creditCardCompanystring支付公司
支付账单信息
orderItemsarray
名称类型示例值描述
idlong子订单号
productIdlong商品id
variantIdlongsku id
titlestring商品标题
quantityinteger订单商品数
skuCodestringsku code
vendorstring供应商
fulfillmentStatusstring物流状态,发货:Shipped;待发货:Pending;取消发货:Cancel
financialStatusstring支付状态,支付失败:Fail;待支付:Pending;已支付:Paid;退款中:Refunding;已退款:Refunded;取消:Cancel
variantOptionstringSKU属性(多个逗号分隔)
variantOptionValuestringSKU属性值(多个逗号分隔)
variantImgUrlstringSKU图片链接
variantProductUrlstringSKU链接
variantCustomizedOptionstringSKU自定义属性
saleAmountbigdecimal销售金额
payAmountbigdecimal支付金额
variantPricebigdecimalsku价格
totalDiscountbigdecimal折扣金额
createTimedate创建时间
updateTimedate更新时间
refundStatusinteger退款状态,-1:退款失败;0:未退款;1:部分退款;2:退款成功
refundQuantityinteger退货数量
isGiftboolean是否是赠品
taxAmountbigdecimal子订单税费
子订单信息
fulfillmentsarray
名称类型示例值描述
idlong物流id
statusstring物流状态
createTimedate创建时间
updateTimedate更新时间
trackingCompanystring物流公司
trackingNumberstring物流单号
fulfillmentItemsarray
名称类型示例值描述
idlong子物流id
fulfillmentIdlong物流id
variantIdlongsku id
orderItemIdlong子订单id
quantityinteger商品数量
skuCodestringsku code
子物流信息
物流信息
discountsarray
名称类型示例值描述
discountIdlong折扣id
codestring折扣码
typeinteger折扣码类型,1:满件打折;2:搭售;3:满额减;4:捆绑销售;5:满件减;6:首单折扣;7:满额送;8:叠加
titlestring折扣标题
amountbigdecimal折扣优惠金额
discountItemsarray
名称类型示例值描述
orderItemIdlong子订单id
variantIdlongskuId
quantityinteger当前折扣里,受到优惠的sku数量
totalQuantityinteger当前折扣里,总的sku数量
discountAmountbigdecimal优惠金额
折扣信息明细数组
折扣信息数组
订单列表


查询订单详情1.0

接口名(name):Order.detail
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong订单id
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong订单id
orderNostring订单号
tokenstring订单token
shopIdlong站点id
emailstring邮箱
phonestring电话号码
statusinteger1订单状态:状态,-1:支付失败;0:待支付;1:支付成功;2:已发货;3:已取消;4:已完成
fulfillmentStatusinteger1物流状态,0:未发货;1: 部分发货;2: 全部发货;3:部分签收;4:完全签收;
gatewaystring支付类型
currencystring货币类型
orderShippingobject
名称类型示例值描述
shippingIdlong运费配置id
shippingTitlestring运费配置标题
shipAmountbigdecimal运费金额
payShipAmountbigdecimal实际支付运费金额
运费信息
itemsAmountbigdecimal子订单总金额(子订单金额累计)
payItemAmountbigdecimal子订单实际支付金额(子订单实际支付累计)
payTotalAmountbigdecimal实付总金额(真实支付)
discountsAmountbigdecimal总折扣优惠金额(不包含免邮费用)
totalWeightbigdecimal总重量
numberinteger总子单数
taxAmountbigdecimal总税费
payTaxAmountbigdecimal实际支付税费
shipInsuranceAmountbigdecimal总运费险金额
payShipInsuranceAmountbigdecimal实际支付运费险金额
taxRatebigdecimal税率
totalTipReceivedbigdecimal收到小费总额
testboolean是否为测试订单
clientIdstring浏览器id
clientDetailobject
名称类型示例值描述
browserIpstring浏览器ip
customerLocalestring浏览器语言
浏览器信息
customerobject
名称类型示例值描述
emailstring顾客邮箱
acceptsMarketingboolean是否接收营销邮件
消费者信息
buyerAcceptsMarketingboolean是否接收营销邮箱
tagsstring标签
sourceNamestring用户下单渠道(web、ios、android)
buyerRemarkstring买家备注
sellerRemarkstring卖家备注
landingSitestring落地页链接
referringSitestring归因链接
payTimedate支付时间
canceledReasonstring取消原因
cancelledTimedate取消时间
createTimedate下单时间
updateTimedate订单更新时间
closedAtdate订单关闭时间
billingAddressobject
名称类型示例值描述
firstNamestring名字
lastNamestring姓名
address1string地址1
address2string地址2
countryCodestring国家码
countrystring国家
provinceCodestring省级码
provincestring
citystring城市
zipstring邮政编号
phonestring电话号码
companystring公司
账单地址
shippingAddressobject
名称类型示例值描述
firstNamestring收货人名字
lastNamestring收货人姓名
address1string地址1
address2string地址2
countryCodestring国家码
countrystring国家
provinceCodestring省级码
provincestring
citystring城市
zipstring邮政编号
phonestring电话号码
companystring公司
收货地址
paymentobject
名称类型示例值描述
paymentIdstring支付交易流水号
merchantIdstring收款方id
creditCardNumberstring支付账号
creditCardCompanystring支付公司
支付账单信息
orderItemsarray
名称类型示例值描述
idlong子订单号
productIdlong商品id
variantIdlongsku id
titlestring商品标题
quantityinteger订单商品数
skuCodestringsku code
vendorstring供应商
fulfillmentStatusstring物流状态,发货:Shipped;待发货:Pending;取消发货:Cancel
financialStatusstring支付状态,支付失败:Fail;待支付:Pending;已支付:Paid;退款中:Refunding;已退款:Refunded;取消:Cancel
variantOptionstringSKU属性(多个逗号分隔)
variantOptionValuestringSKU属性值(多个逗号分隔)
variantImgUrlstringSKU图片链接
variantProductUrlstringSKU链接
variantCustomizedOptionstringSKU自定义属性
saleAmountbigdecimal销售金额
payAmountbigdecimal支付金额
variantPricebigdecimalsku价格
totalDiscountbigdecimal折扣金额
createTimedate创建时间
updateTimedate更新时间
refundStatusinteger退款状态,-1:退款失败;0:未退款;1:部分退款;2:退款成功
refundQuantityinteger退货数量
isGiftboolean是否是赠品
taxAmountbigdecimal子订单税费
子订单信息
fulfillmentsarray
名称类型示例值描述
idlong物流id
statusstring物流状态
createTimedate创建时间
updateTimedate更新时间
trackingCompanystring物流公司
trackingNumberstring物流单号
fulfillmentItemsarray
名称类型示例值描述
idlong子物流id
fulfillmentIdlong物流id
variantIdlongsku id
orderItemIdlong子订单id
quantityinteger商品数量
skuCodestringsku code
子物流信息
物流信息
discountsarray
名称类型示例值描述
discountIdlong折扣id
codestring折扣码
typeinteger折扣码类型,1:满件打折;2:搭售;3:满额减;4:捆绑销售;5:满件减;6:首单折扣;7:满额送;8:叠加
titlestring折扣标题
amountbigdecimal折扣优惠金额
discountItemsarray
名称类型示例值描述
orderItemIdlong子订单id
variantIdlongskuId
quantityinteger当前折扣里,受到优惠的sku数量
totalQuantityinteger当前折扣里,总的sku数量
discountAmountbigdecimal优惠金额
折扣信息明细数组
折扣信息数组


更新订单1.0

接口名(name):Order.update
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
orderShippingAddressobject
名称类型是否必须示例值描述
idlong收货地址ID
orderNostring订单号
emailstring邮箱地址
acceptsMarketingboolean是否接收营销邮件
firstNamestring姓(未传或已传但值的长度超出256字符则此字段数据不做修改)
lastNamestring名(未传或已传但值的长度超出256字符则此字段数据不做修改)
address1string地址1(未传或已传但值的长度超出256字符则此字段数据不做修改)
address2string地址2(未传或已传但值的长度超出256字符则此字段数据不做修改)
cityCodestring城市编码
citystring城市(未传或已传但值超出256字符则此字段数据不做修改)
provinceCodestring邮政编码(未传或已传但值不正确则此字段数据不做修改,值不正确即超出64字符或countryCode不存在或countryCode下的provinceCode不存在)
provincestring省(未传或已传但值超出256字符则此字段数据不做修改)
countryCodestring国家编码(未传或已传但值不正确则此字段数据不做修改,值不正确即超出64字符或countryCode不存在或countryCode下的provinceCode不存在)
countrystring国家(未传或已传但值超出256字符则此字段数据不做修改)
companystring公司(未传或已传但值超出256字符则此字段数据不做修改)
phonestring电话号码(未传或已传但值超出128字符则此字段数据不做修改)
zipstring邮编(未传或已传但值超出24字符则此字段数据不做修改)
createTimedate创建时间
updateTimedate更新时间
收货地址
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
successboolean更新的结果(true-成功;false-失败)
errorMsgstring错误信息


UTM模块

查询UTM1.0

接口名(name):UTM.list
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
orderNosarray 订单号
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
orderUtmsarray
名称类型示例值描述
orderNostring订单号
utmsarray
名称类型示例值描述
sessionIdstring会话id
clientIdstring浏览器id
landingPagestring落地页
utmSourcestringutm source
utmCampaignstringutm campaign
utmMediumstringutm medium
utmTermstringutm term
utmContentstringutm content
createTimedate创建时间
utm信息
utm信息


查询UTMV21.0

接口名(name):UTM.listV2
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
orderNosarray 订单号
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
orderUtmsarray
名称类型示例值描述
orderNostring订单号
utmsarray
名称类型示例值描述
sessionIdstring会话id
clientIdstring浏览器id
landingPagestring落地页
utmSourcestringutm source
utmCampaignstringutm campaign
utmMediumstringutm medium
utmTermstringutm term
utmContentstringutm content
createTimedate创建时间
utm信息
utm信息


物流模块

查询物流1.0

接口名(name):Fulfillment.list
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
orderNostring订单号
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
fulfillmentsarray
名称类型示例值描述
idlong物流id
statusstring物流状态
createTimedate创建时间
updateTimedate更新时间
trackingCompanystring物流公司
trackingNumberstring物流单号
fulfillmentItemsarray
名称类型示例值描述
idlong子物流id
fulfillmentIdlong物流id
variantIdlongsku id
orderItemIdlong子订单id
quantityinteger商品数量
skuCodestringsku code
子物流信息
物流列表


新增物流1.0

接口名(name):Fulfillment.add
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
orderNostring订单号
trackingNumberstring物流号
trackingCompanystring物流公司
lineItemsarray
名称类型是否必须示例值描述
idlong子订单id
子物流信息
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong物流Id
orderNostring订单号


更新物流1.0

接口名(name):Fulfillment.update
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong物流id
orderNostring订单号
trackingNumberstring物流号
trackingCompanystring物流公司
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong物流Id
orderNostring订单号


商品系列模块

查询商品系列列表1.0

接口名(name):collections
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idsarray 主键数组
updatedAtMindate更新时间:查询开始时间
updatedAtMaxdate更新时间:查询结束时间
pageNuminteger第几页
pageSizeinteger每页几条数据(最大可设置200)
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
totalCountinteger总数
collectionsarray
名称类型示例值描述
idlong专辑主键
titlestring专辑名称
seoUrlstring专辑访问地址
collectionDescstring商品专辑描述
dataTypeinteger商品专辑数据类型,1:自动;2:手动
spuIdsstring手动spuId列表(手动专辑必传,spuId逗号分割)
conditionTypeinteger自动条件选项,1:满足所有;2:满足任一(自动专辑必传)
filterSpuCodesstring过滤的spuCode列表,逗号分隔
sortTypeinteger排序规则,1:畅销降序;2:点击率降序;3:时间降序;
isManualinteger是否手动指定排序,1:是;2:否
taginteger商品标签,2:sale;3:new
collectionImageUrlstring专辑图片地址
collectionImageDescstring专辑图片描述
seoTitlestring搜索引擎优化-标题
seoDescstring搜索引擎优化-desc
seoKeywordstring搜索引擎优化-关键字
seoRedirectinteger是否重定向,1:是;2:否(如有seoUrl的修改,是否创建xxx.com到yyy.com url重定向)
isDeletedinteger是否删除,1:否;2:是
updateTimedate专辑更新时间
createTimedate专辑创建时间
专辑列表


新增商品系列1.0

接口名(name):collections.add
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
titlestring商品专辑标题
collectionDescstring商品专辑描述
dataTypeinteger商品专辑数据类型,1:自动;2:手动
spuIdsstring手动spuId列表(手动专辑必传,spuId逗号分割)
conditionTypeinteger自动条件选项,1:满足所有;2:满足任一(自动专辑必传)
filterSpuCodesstring过滤的spuCode列表,逗号分隔
conditionsarray
名称类型是否必须示例值描述
filterObjinteger筛选对象(1:商品标题;2:商品类目;3:商品库存;4:标签;5:售价)
filterTypeinteger筛选类型(1:包含;2:不包含;3:等于;4:不等于;5:开头为;6:结尾为;7:小于;8:大于;9:标签-等于;10:售价-存在大于;11:售价-存在小于;12:售价-存在等于;13:售价-存在不等于)
targetstring目标值
自动条件列表(自动专辑必传)
sortTypeinteger排序规则,1:畅销降序;2:点击率降序;3:时间降序;
isManualinteger是否手动指定排序,1:是;2:否
customSortListarray
名称类型是否必须示例值描述
spuIdlong指定排序的spuId
sortIndexinteger指定排序的序号下标,从0开始
自定义排序数组
taginteger商品标签,2:sale;3:new
collectionImageUrlstring专辑图片地址
collectionImageDescstring专辑图片描述
seoTitlestring搜索引擎优化-标题
seoUrlstring搜索引擎优化-url(商品专辑访问链接)
seoDescstring搜索引擎优化-desc
seoKeywordstring搜索引擎优化-关键字
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
resultlong商品系列主键id


更新商品系列1.0

接口名(name):collections.update
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong商品专辑主键
titlestring商品专辑标题
collectionDescstring商品专辑描述
dataTypeinteger商品专辑数据类型,1:自动;2:手动
spuIdsstring手动spuId列表(手动专辑使用,spuId逗号分割)
conditionTypeinteger自动条件选项,1:满足所有;2:满足任一(自动专辑使用)
filterSpuCodesstring过滤的spuCode列表,逗号分隔
conditionsarray
名称类型是否必须示例值描述
filterObjinteger筛选对象(1:商品标题;2:商品类目;3:商品库存;4:标签;5:售价)
filterTypeinteger筛选类型(1:包含;2:不包含;3:等于;4:不等于;5:开头为;6:结尾为;7:小于;8:大于;9:标签-等于;10:售价-存在大于;11:售价-存在小于;12:售价-存在等于;13:售价-存在不等于)
targetstring目标值
自动条件列表(自动专辑使用)
sortTypeinteger排序规则,1:畅销降序;2:点击率降序;3:时间降序;
isManualinteger是否手动指定排序,1:是;2:否
customSortListarray
名称类型是否必须示例值描述
spuIdlong指定排序的spuId
sortIndexinteger指定排序的序号下标,从0开始
自定义排序数组
taginteger商品标签,2:sale;3:new
collectionImageUrlstring专辑图片地址
collectionImageDescstring专辑图片描述
seoTitlestring搜索引擎优化-标题
seoUrlstring搜索引擎优化-url(商品专辑访问链接)
seoDescstring搜索引擎优化-desc
seoKeywordstring搜索引擎优化-关键字
seoRedirectinteger是否重定向,1:是;2:否(如有seoUrl的修改,是否创建xxx.com到yyy.com url重定向)
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
resultlong商品系列主键id


查询商品系列详情1.0

接口名(name):collections.detail
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong商品专辑主键id
pageNuminteger分页获取对应商品列表-第几页
pageSizeinteger分页获取对应商品列表-每页几条数据(最大可设置1000)
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong专辑主键
titlestring专辑名称
seoUrlstring专辑访问地址
collectionDescstring商品专辑描述
dataTypeinteger商品专辑数据类型,1:自动;2:手动
spuIdsstring手动spuId列表(手动专辑必传,spuId逗号分割)
conditionTypeinteger自动条件选项,1:满足所有;2:满足任一(自动专辑必传)
filterSpuCodesstring过滤的spuCode列表,逗号分隔
conditionsarray
名称类型示例值描述
filterObjinteger筛选对象(1:商品标题;2:商品类目;3:商品库存;4:标签;5:售价)
filterTypeinteger筛选类型(1:包含;2:不包含;3:等于;4:不等于;5:开头为;6:结尾为;7:小于;8:大于;9:标签-等于;10:售价-存在大于;11:售价-存在小于;12:售价-存在等于;13:售价-存在不等于)
targetstring目标值
自动条件列表(自动专辑必传)
sortTypeinteger排序规则,1:畅销降序;2:点击率降序;3:时间降序;
isManualinteger是否手动指定排序,1:是;2:否
customSortListarray
名称类型示例值描述
spuIdlong指定排序的spuId
sortIndexinteger指定排序的序号下标,从0开始
自定义排序数组
taginteger商品标签,2:sale;3:new
collectionImageUrlstring专辑图片地址
collectionImageDescstring专辑图片描述
seoTitlestring搜索引擎优化-标题
seoDescstring搜索引擎优化-desc
seoKeywordstring搜索引擎优化-关键字
seoRedirectinteger是否重定向,1:是;2:否(如有seoUrl的修改,是否创建xxx.com到yyy.com url重定向)
isDeletedinteger是否删除,1:否;2:是
updateTimedate专辑更新时间
createTimedate专辑创建时间
productsarray
名称类型示例值描述
idlong商品ID
titlestring商品名称
seoUrlstring商品访问地址
spuCodestringspuCode
updateTimedate商品更新时间
createTimedate商品上传时间
专辑商品列表明细
productCountlong专辑商品列表总数


删除商品系列1.0

接口名(name):collections.delete
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong商品系列主键id
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
resultboolean删除结果


店铺模块

查询店铺1.0

接口名(name):merchant
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong站点id
namestring站点名称
emailstring站点联系人邮箱
categorystring行业
customerEmailstring站点客服邮箱
legalPersonNamestring法人姓名
companyNamestring法定公司名称
phonestring电话
addressstring地址
zipstring邮编
currencystring结算货币


客户模块

客户列表1.0

接口名(name):customer.list
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idsstring客户ID,多个用英文逗号分隔
emailstring邮箱
createdAtMindate起始创建时间
createdAtMaxdate结束创建时间
updatedAtMindate起始更新时间
updatedAtMaxdate结束更新时间
pageNuminteger页码
pageSizeinteger每页记录条数
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
totalCountinteger总条数
customersarray
名称类型示例值描述
idlong客户ID
shopIdlong店铺ID
firstNamestring
lastNamestring
emailstring邮箱
phonestring手机号
acceptsMarketingboolean是否订阅
countrystring国家
countryCodestring国家代码
provincestring省份
provinceCodestring省份代码
totalOrderCountlong总下单数次数
totalOrderAmountbigdecimal下单总金额
createTimedate创建时间
updateTimedate更新时间
addressesarray
名称类型示例值描述
idlong地址ID
customerIdlong客户ID
shopIdlong店铺ID
firstNamestring
lastNamestring
emailstring邮箱
phonestring手机号
address1string地址1
address2string地址2
countrystring国家
countryCodestring国家编码
provincestring省份
provinceCodestring省份编码
citystring城市
cityCodestring城市编码
zipstring邮编
isDefboolean是否默认地址
地址
客户列表


客户详情1.0

接口名(name):customer.detail
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong客户ID
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong客户ID
shopIdlong店铺ID
firstNamestring
lastNamestring
emailstring邮箱
phonestring手机号
acceptsMarketingboolean是否订阅
countrystring国家
countryCodestring国家代码
provincestring省份
provinceCodestring省份代码
totalOrderCountlong总下单数次数
totalOrderAmountbigdecimal下单总金额
createTimedate创建时间
updateTimedate更新时间
addressesarray
名称类型示例值描述
idlong地址ID
customerIdlong客户ID
shopIdlong店铺ID
firstNamestring
lastNamestring
emailstring邮箱
phonestring手机号
address1string地址1
address2string地址2
countrystring国家
countryCodestring国家编码
provincestring省份
provinceCodestring省份编码
citystring城市
cityCodestring城市编码
zipstring邮编
isDefboolean是否默认地址
地址


更新客户1.0

接口名(name):customer.update
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idlong客户ID
firstNamestring
lastNamestring
phonestring手机号
acceptsMarketinginteger是否订阅 0:否 1:是
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idlong客户ID
shopIdlong店铺ID
firstNamestring
lastNamestring
emailstring邮箱
phonestring手机号
acceptsMarketingboolean是否订阅
countrystring国家
countryCodestring国家代码
provincestring省份
provinceCodestring省份代码
totalOrderCountlong总下单数次数
totalOrderAmountbigdecimal下单总金额
createTimedate创建时间
updateTimedate更新时间
addressesarray
名称类型示例值描述
idlong地址ID
customerIdlong客户ID
shopIdlong店铺ID
firstNamestring
lastNamestring
emailstring邮箱
phonestring手机号
address1string地址1
address2string地址2
countrystring国家
countryCodestring国家编码
provincestring省份
provinceCodestring省份编码
citystring城市
cityCodestring城市编码
zipstring邮编
isDefboolean是否默认地址
地址


webhook模块

webhook事件列表1.0

接口名(name):webhook.event
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
eventsarray事件类型:products_create/products_update/products_delete/order_create/order_update/customer_create/customer_update


webhook创建1.0

接口名(name):webhook.create
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
urlstring推送地址
eventstring事件类型:product_create/product_update/product_delete/order_create/order_update
platformstring平台:Shoplus_BI
apiSecretstring加密密钥
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idstringid
shopIdlong店铺ID
urlstring推送地址
eventstring事件类型:product_create/product_update/product_delete/order_create/order_update
platformstring平台:Shoplus_BI
apiSecretstring加密密钥
createTimedate创建时间
updateTimedate更新时间


webhook更新1.0

接口名(name):webhook.update
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idstringwebhook ID
urlstring推送地址
eventstring事件类型:product_create/product_update/product_delete/order_create/order_update
platformstring平台:Shoplus_BI
apiSecretstring加密密钥
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idstringid
shopIdlong店铺ID
urlstring推送地址
eventstring事件类型:product_create/product_update/product_delete/order_create/order_update
platformstring平台:Shoplus_BI
apiSecretstring加密密钥
createTimedate创建时间
updateTimedate更新时间


webhook查询1.0

接口名(name):webhook.list
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
limitinteger每页数
pageinteger页码
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
webHookVOListarray
名称类型示例值描述
idstringid
shopIdlong店铺ID
urlstring推送地址
eventstring事件类型:product_create/product_update/product_delete/order_create/order_update
platformstring平台:Shoplus_BI
apiSecretstring加密密钥
createTimedate创建时间
updateTimedate更新时间
店铺webhook列表


webhook详情1.0

接口名(name):webhook.detail
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idstringwebhook ID
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
idstringid
shopIdlong店铺ID
urlstring推送地址
eventstring事件类型:product_create/product_update/product_delete/order_create/order_update
platformstring平台:Shoplus_BI
apiSecretstring加密密钥
createTimedate创建时间
updateTimedate更新时间


webhook删除1.0

接口名(name):webhook.delete
版本号(version):1.0
请求参数/ 数据模型
名称 类型 是否必须 示例值 描述
idstringwebhook ID
返回结果/数据模型
名称 类型 描述
code string 状态值,"0"表示成功,其它都是失败
msg string 错误信息,出错时显示
data object 返回的数据,没有则返回{}
名称 类型 示例值 描述
resultboolean删除结果


开发对接附录

签名算法介绍

签名算法描述如下:
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());
    }