微信小店
取消
中文
中文
EN
取消
  • 微信小店

    • # 获取商品

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

    接口英文名：getproduct

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

    • 启用新多级类目树提示：旧的类目树固定为三级类目结构，新的类目树为多级类目结构，过渡期间，新旧类目树兼容使用，请开发者尽快切换到新多级类目树。其中差异请参阅新旧类目树差异。此接口新增 cats_v2 字段支持新类目树，详见参数

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 调用方法：channels.ec.product.get

    • 出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档

    # 第三方调用

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

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

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

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_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_productnull商品草稿数据，结构和product一致，入参data_type==1时不返回该字段
    sale_limit_infoobject当日售卖上限提醒，当店铺受到售卖管控时返回，没有返回本字段表示没有无额外限制

    # Res.product Object Payload

    商品线上数据，入参data_type==2时不返回该字段；入参data_type==3且商品从未上架过，不返回该字段

    参数名类型说明
    product_idnumber小店内部商品ID
    out_product_idstring外部平台自定义商品ID。如果添加时没录入，回包可能不包含该字段
    titlestring标题
    sub_titlestring副标题。如果添加时没录入，回包可能不包含该字段
    head_imgsarray主图,多张,列表,最多9张,每张不超过2MB
    desc_infoobject商品详情
    deliver_methodnumber发货方式：0-快递发货；1-无需快递，手机号发货；3-无需快递，可选发货账号类型，默认为0，若为无需快递，则无需填写运费模版id
    deliver_acct_typenumarray发货账号：1-微信openid；2-QQ号；3-手机号；4-邮箱。只有deliver_method=3时，本参数有意义。且当发货账号为微信、QQ和邮箱时，需要更新订单接口读取详情字段，详情参考订单接口的说明。
    express_infoobject运费信息
    aftersale_descstring售后说明
    limited_infoobject限购信息
    extra_serviceobject额外服务
    statusnumber商品线上状态，edit_product和product都会返回该字段
    edit_statusnumber商品草稿状态，以edit_product字段返回的值为准，product不返回
    min_pricenumber商品 SKU 最小价格（单位：分）
    catsobjarray商品类目（旧）
    cats_v2objarray新类目树--商家需要先申请可使用类目
    attrsobjarray属性键key（属性自定义用）
    spu_codestring商家自定义的商品编码
    brand_idnumber品牌id，无品牌为“2100000000”
    skusobjarraysku信息
    product_typenumber商品类型。1: 小店普通自营商品；2: 福袋抽奖商品；3: 直播间闪电购商品。注意: 福袋抽奖、直播间闪电购类型的商品为只读数据，不支持编辑、上架操作，不支持用data_type=2的参数获取。
    edit_timenumber商品草稿最近一次修改时间
    after_sale_infoobject商品售后信息
    src_product_idnumber当商品类型位福袋抽奖商品（即product_type==2）且该抽奖商品由橱窗的自营商品导入生成时有值，表示导入的来源商品id，其他场景下该字段无值或者值为0。
    product_qua_infosobjarray商品资质列表
    size_chartobject尺码信息

    # Res.sale_limit_info Object Payload

    当日售卖上限提醒，当店铺受到售卖管控时返回，没有返回本字段表示没有无额外限制

    参数名类型说明
    is_limitednumber是否受到管控，商品存在售卖限制时，固定返回1
    titlestring售卖限制标题
    sub_titlestring售卖限制描述

    # Res.product.desc_info Object Payload

    商品详情

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

    # Res.product.express_info Object Payload

    运费信息

    参数名类型说明
    template_idstring运费模板ID。如果添加时没录入，回包可能不包含该字段
    weightnumber商品重量，单位克

    # Res.product.limited_info Object Payload

    限购信息

    参数名类型说明
    period_typenumber限购周期类型，0无限购，1按自然日限购，2按自然周限购，3按自然月限购
    limited_buy_numnumber限购数量

    # Res.product.extra_service Object Payload

    额外服务

    参数名类型说明
    seven_day_returnnumber是否支持七天无理由退货，0-不支持七天无理由，1-支持七天无理由，2-支持七天无理由(定制商品除外)，3-支持七天无理由(使用后不支持)。
    pay_after_usenumber先用后付，0-不支持先用后付，1-支持先用后付。若店铺已开通先用后付，支持先用后付的类目商品将在上架后自动打开先用后付。
    freight_insurancenumber是否支持运费险，0-不支持运费险，1-支持运费险。需要商户开通运费险服务，且当前类目支持运费险才会生效。
    damage_guaranteenumber是否支持假一赔三，0-不支持假一赔三，1-支持假一赔三。
    fake_one_pay_threenumber是否支持坏损包退，0-不支持坏损包退，1-支持坏损包退。

    # Res.product.cats(Array) Object Payload

    商品类目（旧）

    参数名类型说明
    cat_idnumber商家需要先申请可使用类目

    # Res.product.cats_v2(Array) Object Payload

    新类目树--商家需要先申请可使用类目

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

    # Res.product.attrs(Array) Object Payload

    属性键key（属性自定义用）

    参数名类型说明
    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(Array) Object Payload

    sku信息

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

    # Res.product.skus(Array).sku_attrsObject Payload

    sku属性

    参数名类型说明
    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(Array).sku_deliver_info Object Payload

    sku库存情况

    参数名类型说明
    stock_typenumbersku库存情况。0:现货（默认），1:全款预售。部分类目支持全款预售，具体参考文档获取类目信息中的字段attr.pre_sale
    full_payment_presale_delivery_typenumbersku发货节点，该字段仅对stock_type=1有效。0:付款后n天发货，1:预售结束后n天发货
    presale_begin_timenumbersku预售周期开始时间，秒级时间戳，该字段仅对delivery_type=1有效。
    presale_end_timenumbersku预售周期结束时间，秒级时间戳，该字段仅对delivery_type=1有效。
    full_payment_presale_delivery_timenumbersku发货时效，即付款后/预售结束后{full_payment_presale_delivery_time}天内发货，该字段仅对stock_type=1时有效。

    # Res.product.after_sale_info Object Payload

    商品售后信息

    参数名类型说明
    after_sale_address_idstring商品的售后地址id，可使用获取地址详情

    # Res.product.product_qua_infos(Array) Object Payload

    商品资质列表

    参数名类型说明
    qua_idnumber商品资质id，对应获取类目信息中的字段 product_qua_list[].qua_id
    qua_urlarray商品资质图片列表

    # Res.product.size_chart Object Payload

    尺码信息

    参数名类型说明
    enableboolean是否启用尺码表
    specification_listobjarray尺码表

    # Res.product.size_chart.specification_list(Array) Object Payload

    尺码表

    参数名类型说明
    namestring尺码属性名称
    unitstring尺码属性值的单位
    is_rangeboolean尺码属性值是否为区间
    value_listobjarray尺码值与尺码属性值的映射列表

    # Res.product.size_chart.specification_list(Array).value_listObject Payload

    尺码值与尺码属性值的映射列表

    参数名类型说明
    keystring尺码值
    valuestring尺码属性值；尺码属性值为非区间时返回
    leftstring尺码属性值的左边界；尺码属性值为区间时返回
    rightstring尺码属性值的右边界；尺码属性值为区间时返回

    # 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
}

    返回示例

    {
    "errcode": 0,
    "errmsg": "ok",
    "product": {
        "product_id": "123456789",
        "out_product_id": "OUT_PRODUCT_ID_TEST",
        "title": "任天堂 Nintendo Switch 国行续航增强版",
        "sub_title": "【国行Switch，更安心的保修服务，更快的国行服务器】一台主机三种模式，游戏掌机，随时随地，一起趣玩",
        "head_imgs": [
            "https://mmecimage.cn/p/wx37f38d59298839c3/HJE9eJaEc5bJk-eaArVdILSB7MMaHgdK2-JIn51nMQ"
        ],
        "desc_info": {
            "imgs": [
                "https://mmecimage.cn/p/wx37f38d59298839c3/HJE9eJaEc5bJk-eaArVdILSB7MMaHgdK2-JIn51nMQ"
            ]
        },
        "cats": [
            {
                "cat_id": "1"
            },
            {
                "cat_id": "2"
            },
            {
                "cat_id": "3"
            }
        ],
        "cats_v2": [
            {
                "cat_id": "1"
            },
            {
                "cat_id": "2"
            },
            {
                "cat_id": "3"
            },
            {
                "cat_id": "4"
            }
        ],
        "attrs": [
            {
             "attr_key": "产地",
             "attr_value": "四川成都"
            },
            {
             "attr_key": "材质",
             "attr_value": "玻璃"
            },
            {
            "attr_key": "适用人群",
            "attr_value": "青年;中年"
            },
            {
            "attr_key": "数量",
            "attr_value": "33"
            },
            {
            "attr_key": "精度",
            "attr_value": "3.001"
            },
            {
            "attr_key": "重量",
            "attr_value": "38 mg"
            },
            {
           "attr_key": "毛重",
           "attr_value": "380 kg"
            }          
        ],
        "express_info": {
            "template_id": "123456"
        },
        "status": 5,
        "edit_status": 2,
        "skus": [
            {
                "sku_id": "123456001",
                "out_sku_id": "OUT_SKU_ID_TEST",
                "thumb_img": "",
                "sale_price": 1,
                "stock_num": 5,
                "sku_code": "SKU_CODE_TEST",
                "sku_attrs": [
                    {
                        "attr_key": "产地",
                        "attr_value": "四川成都"
                    },
                    {
                        "attr_key": "材质",
                        "attr_value": "玻璃"
                    },
                    {
                        "attr_key": "适用人群",
                        "attr_value": "青年;中年"
                    },
                    {
                        "attr_key": "数量",
                        "attr_value": "33"
                    },
                    {
                        "attr_key": "精度",
                        "attr_value": "3.001"
                    },
                    {
                         "attr_key": "重量",
                         "attr_value": "38 mg"
                    },
                    {
                         "attr_key": "毛重",
                         "attr_value": "380 kg"
                    }         
                ],
                "status": 0
            }
        ],
        "min_price": 1,
        "spu_code": "SPU_CODE_TEST",
        "product_qua_infos": [
            {
                "qua_id": 1111484,
                "qua_url": [
                    "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HCnhqIWMZSIAJzzDRNmevAzRXj5ZCAZw8vGKYF1GW8Y"
                ]
            },
            {
                "qua_id": 1111491,
                "qua_url": [
                    "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HPySAtxADO1LuDHdmJ7wiSwJzyEicLNTSAE-a10swwM"
                ]
            },
            {
                "qua_id": 1111492,
                "qua_url": [
                    "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HGekHKK4yA_s0Ur3wwgil2x_6sZ7RiFpA4JSSfT_gYI",
                    "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HPfiP6fjCN5BeLJ48i9e0zANmKUuv-hyo55nuUk9mBA"
                ]
            }
        ]
    }
}

    # 6. 错误码

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

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

    # 7. 适用范围

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