第三方应用开发 服务端API 客户联系 管理商品图册
管理商品图册
最后更新:2023/12/16
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
管理商品图册
最后更新:2023/12/16

目录

  • 概述
  • 权限说明
  • 创建商品图册
  • 获取商品图册
  • 获取商品图册列表
  • 编辑商品图册
  • 删除商品图册
  • 概述

    企业与第三方应用可通过该接口管理商品图册

     

    权限说明

    调用接口的应用需要满足如下的权限:

    应用类型权限要求
    自建应用配置到「客户联系 可调用接口的应用」中
    代开发应用具有「管理商品图册」权限
    第三方应用具有「管理商品图册」权限

    注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

     

    创建商品图册

    企业和第三方应用可以通过此接口增加商品
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_product_album?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"description":"世界上最好的商品",
    	"price":30000,
    	"product_sn":"xxxxxxxx",
    	"attachments":[
    		{
    			"type": "image",
    			"image": {
    				"media_id": "MEDIA_ID"
    			}
    		}
    	]
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    description商品的名称、特色等;不超过300个字
    price商品的价格,单位为分;最大不超过5万元
    product_sn商品编码;不超过128个字节;只能输入数字和字母
    attachments附件类型,仅支持image,最多不超过9个附件
    image.media_id图片的media_id,仅支持通过上传附件资源接口获得的资源

     

    返回结果:

    {
        "errcode":0,
        "errmsg":"ok",
    	"product_id" : "xxxxxxxxxx"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    product_id商品id

    获取商品图册

    企业和第三方应用可以通过此接口获取商品信息
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_product_album?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"product_id" : "xxxxxxxxxx"
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证

    权限说明:

    • 可获取企业内所有企业级的商品图册

    返回结果:

    {
    	"errcode":0,
    	"errmsg":"ok",
    	"product": {
    			"product_id" : "xxxxxxxxxx",
    			"description":"世界上最好的商品",
    			"price":30000,
    			"create_time":1600000000,
    			"product_sn":"xxxxxxxx",
    			"attachments":[
    				{
    					"type": "image",
    					"image": {
    						"media_id": "MEDIA_ID"
    					}
    				}
    			]
    	}
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    product商品详情
    product_id商品id
    product_sn商品编码
    description商品的名称、特色等
    price商品的价格,单位为分
    create_time商品图册创建时间
    attachments附件类型
    attachments.type附件类型,目前仅支持image
    image.media_id图片的media_id,可以通过获取临时素材下载资源

    获取商品图册列表

    企业和第三方应用可以通过此接口导出商品
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_product_album_list?access_token=ACCESS_TOKEN

    请求示例:

    {
       "limit":50,
       "cursor":"CURSOR"
    }
    

    参数说明:

    参数必须说明
    access_token调用接口凭证
    limit返回的最大记录数,整型,最大值100,默认值50,超过最大值时取默认值
    cursor用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填

    权限说明:

    • 自建应用调用,只会返回应用可见范围内用户的情况。

     

    返回结果:

    {
    	"errcode":0,
    	"errmsg":"ok",
    	"next_cursor":"CURSOR",
    	"product_list":[
    		{
    			"product_id" : "xxxxxxxxxx",
    			"description":"世界上最好的商品",
    			"price":30000,
    			"product_sn":"xxxxxxxx",
    			"attachments":[
    				{
    					"type": "image",
    					"image": {
    						"media_id": "MEDIA_ID"
    					}
    				}
    			]
    		}
    	]
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    next_cursor用于分页查询的游标,字符串类型,用于下一次调用
    product_list商品列表
    product_list.product_id商品id
    product_list.product_sn商品编码
    product_list.description商品的名称、特色等
    product_list.price商品的价格,单位为分
    product_list.attachments附件类型
    product_list.attachments.type附件类型,目前仅支持image
    product_list.image.media_id图片的media_id,可以通过获取临时素材下载资源

     

    编辑商品图册

    企业和第三方应用可以通过此接口修改商品信息
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_product_album?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"product_id" : "xxxxxxxxxx",
    	"description":"世界上最好的商品",
    	"price":30000,
    	"product_sn":"xxxxxx",
    	"attachments":[
    		{
    			"type": "image",
    			"image": {
    				"media_id": "MEDIA_ID"
    			}
    		}
    	]
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    product_id商品id
    description商品的名称、特色等;不超过300个字
    price商品的价格,单位为分;最大不超过5万元
    product_sn商品编码;不超过128个字节;只能输入数字和字母
    attachments附件类型,仅支持image
    attachments.type附件类型,目前仅支持image 
    image.media_id图片的media_id,仅支持通过上传附件资源接口的资源
    注:除product_id外,需要更新的字段才填,不需更新的字段可不填。

    权限说明:

    • 应用只修改应用自己创建的商品图册

    返回结果:

    {
    	"errcode":0,
    	"errmsg":"ok"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容

     

    删除商品图册

    企业和第三方应用可以通过此接口删除商品信息
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/delete_product_album?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"product_id" : "xxxxxxxxxx"
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证

    权限说明:

    • 应用只可删除应用自己创建的商品图册

    返回结果:

    {
    	"errcode":0,
    	"errmsg":"ok"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    上一篇
    获客助手事件通知
    下一篇
    管理聊天敏感词