第三方应用开发 服务端API 客户联系 管理商品图册
管理商品图册

目录

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

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

    接口调用权限说明

    • 允许使用“客户联系”secret调用
    • 允许自建应用:使用配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用(accesstoken如何获取?
    • 允许第三方应用:第三方应用需授权企业客户权限管理商品图册的权限
      第三方应用必须在服务商管理端申请“企业客户权限->客户联系->管理商品图册”权限。
    • 允许代开发自建应用:应用需授权企业客户权限管理商品图册的权限
      应用需授权“企业客户权限->客户联系->管理商品图册”权限。

    创建商品图册

    企业和第三方应用可以通过此接口增加商品
    请求方式: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调用接口凭证

    权限说明:

    • 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
    • 第三方应用或代开发自建应用调用需要企业授权客户联系管理商品图册的权限
    • 可获取企业内所有企业级的商品图册

    返回结果:

    {
    	"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用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填

    权限说明:

    • 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
    • 自建应用调用,只会返回应用可见范围内用户的情况。
    • 第三方应用或代开发自建应用调用需要企业授权客户联系管理商品图册的权限

    返回结果:

    {
    	"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外,需要更新的字段才填,不需更新的字段可不填。

    权限说明:

    • 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
    • 第三方应用或代开发自建应用调用需要企业授权客户联系管理商品图册的权限
    • 应用只修改应用自己创建的商品图册;客户联系系统应用可修改所有商品图册

    返回结果:

    {
    	"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调用接口凭证

    权限说明:

    • 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
    • 第三方应用或代开发自建应用调用需要企业授权客户联系管理商品图册的权限
    • 应用只可删除应用自己创建的商品图册;客户联系系统应用可删除所有商品图册

    返回结果:

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

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    上一篇
    事件格式
    下一篇
    管理聊天敏感词