# 获取赠品

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getgiftproduct

可通过指定赠品ID获取赠品具体信息

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/product/gift/get?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代微信小店商家调用。

  • 该接口所属的权限集 id 为:129

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商)

# 请求体 Request Payload

参数名类型必填说明
product_idstring商品ID
data_typenumber默认取1 1:获取线上数据 2:获取草稿数据 3:同时获取线上和草稿数据(注意:上架过的商品才有线上数据)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
productobject赠品线上数据,入参data_type==2时返回该字段;入参data_type==3时赠品从未上线过,不返回该字段、
edit_productobject赠品草稿数据,入参data_type==1时不返回该字段(参考product返回字段)

# Res.product Object Payload

赠品线上数据,入参data_type==2时返回该字段;入参data_type==3时赠品从未上线过,不返回该字段、

参数名类型说明
product_idstring小店内部赠品ID
out_product_idstring外部平台自定义赠品ID。如果添加时没录入,回包可能不包含该字段
titlestring标题
head_imgsarray主图,多张,列表,最多9张,每张不超过2MB
desc_infoobject赠品详情
statusnumber赠品线上状态,edit_product和product都会返回该字段
edit_statusnumber赠品草稿状态,以edit_product字段返回的值为准,product不返回,枚举值状态可参考下文 ,在售赠品没有草稿
cats_v2objectcats_v2
attrsobjectattrs
spu_codestring商家自定义的赠品编码
brand_idstring品牌id,无品牌为“2100000000”
skusobjectskus
product_typenumber赠品类型。4: 在售赠品,5: 非卖赠品。注意: 在售赠品为只读数据,不支持编辑、下架操作,不支持用data_type=2的参数获取。
edit_timenumber赠品草稿最近一次修改时间
src_product_idnumber在售赠品的来源商品id,非卖赠品没有该字段

# Res.product.desc_info Object Payload

赠品详情

参数名类型说明
imgsarray赠品详情图片(最多20张)。如果添加时没录入,回包可能不包含该字段
descstring赠品详情文字。如果添加时没录入,回包可能不包含该字段

# Res.product.cats_v2 Object Payload

cats_v2

参数名类型说明
cat_idstring新类目树--商家需要先申请可使用类目

# Res.product.attrs Object Payload

attrs

参数名类型说明
attr_keystring属性键key(属性自定义用)。如果添加时没录入,回包可能不包含该字段
attr_valuestring属性值(属性自定义用)。如果添加时没录入,回包可能不包含该字段,参数规则如下: ● 当获取类目信息接口中返回的type:为 select_many, attr_value的格式:多个选项用分号;隔开 示例:某赠品的适用人群属性,选择了:青年、中年,则 attr_value的值为:青年;中年 ● 当获取类目信息接口中返回的type:为 integer_unit/decimal4_unit attr_value格式:数值 单位,用单个空格隔开 示例:某赠品的重量属性,要求integer_unit属性类型,数值部分为 18,单位选择为kg,则 attr_value的值为:18 kg ● 当获取类目信息接口中返回的type:为 integer/decimal4 attr_value 的格式:字符串形式的数字

# Res.product.skus Object Payload

skus

参数名类型说明
sku_idstringskuID
out_sku_idstring外部平台自定义skuID。如果添加时没录入,回包可能不包含该字段
sale_pricenumber售卖价格,以分为单位
stock_numnumbersku库存
sku_codestring商家自定义的sku编码。如果添加时没录入,回包可能不包含该字段
statusnumbersku状态

# 4. 注意事项

edit_status赠品草稿状态

枚举值 描述
0 初始值
1 编辑中
2 审核中
3 审核失败
4 审核成功
7 商品异步提交,上传中(处于该状态的商品调用上架商品接口会返回10020067)
8 商品异步提交,上传失败(请重新提交)

status赠品线上状态

枚举值 描述
0 初始值
5 上架
6 回收站
9 彻底删除,商品无法再进行任何操作
11 自主下架
13 违规下架/风控系统下架
14 保证金不足下架
15 品牌过期下架
20 商品被封禁

# 5. 代码示例

请求示例

{
    "product_id": "324545",
    "data_type": 1
}

返回示例

{
    "product_id": "1700000000000",
    "title": "宠物玩具5",
    "head_imgs": [
        "https://mmecimage.cn/p/wx37f38d59298839c3/HJE9eJaEc5bJk-eaArVdILSB7MMaHgdK2-JIn51nMQ"
    ],
    "desc_info": {
        "imgs": [
            "https://mmecimage.cn/p/wx37f38d59298839c3/HJE9eJaEc5bJk-eaArVdILSB7MMaHgdK2-JIn51nMQ"
        ],
        "desc": "物美价廉"
    },
    "cats_v2": [
        {
            "cat_id": "10000026"
        },
        {
            "cat_id": "10000032"
        },
        {
            "cat_id": "1246"
        }
    ],
    "attrs": [
        {
            "attr_key": "产品净重(kg)",
            "attr_value": "1"
        }
    ],
    "skus": [
        {
            "sku_id": "462966903",
            "sale_price": 100,
            "stock_diff": {
                "diff_type": 1,
                "num": 1,
            }
        }
    ],
    "spu_code": "SPU_CODE_XXX",
    "brand_id": "2100000000"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
10020050无权限调用该api,请获取权限后再试
10020051参数有误,请按照文档要求传参
10020052商品不存在
10020065商品未上架
10020207该类型的商品无法获取草稿数据

# 7. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。