# 在售商品转赠品
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:setproductasgift
可通过该接口将小店在售商品转为赠品
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/product/gift/onsale/set?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:129
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
product_id | string(uint64) | 是 | 设置为原始商品ID |
skus | object | 是 | skus |
# Body.skus Object Payload
skus
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
sku_id | string | 否 | 设置为原始商品skuID,目前仅支持将单品商品设置为赠品 |
sku_id | number | 是 | 划拨给赠品的库存数量,将直接从原始商品的库存中扣除,且这部分库存不参与售卖 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
product_ids | array(string(uint64)) | 赠品id列表 |
next_key | string | 本次翻页的上下文,用于请求下一页 |
total_num | number | 赠品总数 |
# 4. 注意事项
目前仅支持将单sku商品设置为赠品。
设置为赠品后,将生成新的赠品ID和赠品skuID,并在接口的回包中返回。
设置赠品时会从原始商品划拨库存,之后每次进行库存更新都将从原始商品的库存中进行扣减/归还。
同一个商品只能被设置为赠品一次,删除后可以重新设置。
预售商品不可设置为赠品。
设置在售赠品后,如果原始商品的改动导致不满足赠品准入要求,将会下架对应赠品。
# 5. 代码示例
请求示例
{
"product_id": "10000186383709",
"skus": [
{
"sku_id": "2967856845",
"stock_num": 1
}
]
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"data": {
"src_product_id": "10000186383709",
"gift_product_id": "17000001344346",
"sku_mappings": [
{
"src_sku_id": "2967856845",
"gift_sku_id": "3185803880"
}
]
}
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10020050 | 无权限调用该api,请开发者获取权限后再试 | |
10020051 | 参数有误,请开发者按照文档传参 | |
10020280 | 当前类目不支持设置赠品 | |
10020281 | 预售商品不支持设置赠品 | |
10020282 | 商品已被设置为赠品 | |
10020285 | 原始商品库存不足,请补充后再设置赠品 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。