微信小店API手册培训资料.docx

微信商铺API手册V1.一五

目录
1. 商品管理接口 - 1 -
1.1 增加商品 - 1 -
1.2 删除商品 - 6 -
1.3 修改商品 - 7 -
1.4 查询商品 - 10 -
1.5 获取指定状态的所有商品 - 一三 -
1.6 商品上下架 - 14 -
1.7 获取指定分类的所有子分类 - 一五 -
1.8 获取指定子分类的所有SKU - 16 -
1.9 获取指定分类的所有属性 - 一八 -
2. 库存管理接口 - 21 -
2.1 增加库存 - 21 -
2.2 减少库存 - 22 -
3. 邮费模板管理接口 - 24 -
3.1 增加邮费模板 - 24 -
3.2 删除邮费模板 - 35 -
3.3 修改邮费模板 - 36 -
3.4 获取指定ID的邮费模板 - 37 -
3.5 获取所有邮费模板 - 39 -
4. 分组管理接口 - 41 -
4.1 增加分组 - 41 -
4.2 删除分组 - 42 -
4.3 修改分组属性 - 43 -
4.4 修改分组商品 - 44 -
4.5 获取所有分组 - 45 -
4.6 根据分组ID获取分组信息 - 46 -
5. 货架管理接口 - 48 -
5.1 增加货架 - 48 -
5.2 删除货架 - 56 -
5.3 修改货架 - 57 -
5.4 获取所有货架 - 58 -
5.5 根据货架ID获取货架信息 - 60 -
5.6 开发者将自己的页面作为货架 - 61 -
6. 订单管理接口 - 63 -
6.1 订单付款通知 - 63 -
6.2 根据订单ID获取订单详情 - 63 -
6.3 根据订单状态/创建时间获取订单详情 - 65 -
6.4 设置订单发货信息 - 68 -
6.5 关闭订单 - 69 -
7. 功能接口 - 71 -
7.1 上传图片 - 71 -

1. 商品管理接口
1.1 增加商品
1.1.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/create?access_token=ACCESS_TOKEN
POST数据格式
json
1.1.2 请求参数说明
参数
是否必须
说明
access_token
是
公众号的调用接口凭证，由access_token生成接口获得
POST数据
是
商品详细信息
1.1.3 POST数据
数据示例：
{
"product_base": {
"category_id": [
"537074298"
],
"property": [
{
"id": "107574一八79",
"vid": "1079749967"
},
{
"id": "1075754127",
"vid": "1079795198"
},
{
"id": "1075777334",
"vid": "1079837440"
}
],
"name": "testaddproduct",
"sku_info": [
{
"id": "107574一八73",
"vid": [
"1079742386",
"1079742363"
]
}
],
"main_img": "xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0",
"img": [
"xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0"
],
"detail": [
{
"text": "test first"
},
{
"img": "xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ul1UcLcwxrFdwTKYhH9Q5YZoCfX4Ncx655ZK6ibnlibCCErbKQtReySaVA/0"
},
{
"text": "test again"
}
],
"buy_limit": 10
},
"sku_list": [
{
"sku_id": "107574一八73:1079742386",
"price": 30,
"icon_url": "xmmbiz.qpicx/mmbiz/4whpV1VZl28bJj62XgfHPibY3ORKicN1oJ4CcoIr4BMbfA8LqyyjzOZzqrOGz3f5KWq1QGP3fo6TOTSYD3TBQjuw/0",
"product_code": "testing",
"ori_price": 9000000,
"quantity": 800
},
{
"sku_id": "107574一八73:1079742363",
"price": 30,
"icon_url": "xmmbiz.qpicx/mmbiz/4whpV1VZl28bJj62XgfHPibY3ORKicN1oJ4CcoIr4BMbfA8LqyyjzOZzqrOGz3f5KWq1QGP3fo6TOTSYD3TBQjuw/0",
"product_code": "testingtesting",
"ori_price": 9000000,
"quantity": 800
}
],
"attrext": {
"location": {
"country": "中国",
"province": "广东省",
"city": "广州市",
"address": "T.I.T创意园"
},
"isPostFree": 0,
"isHasReceipt": 1,
"isUnderGuaranty": 0,
"isSupportReplace": 0
},
"delivery_info": {
"delivery_type": 0,
"template_id": 0,
"express": [
{
"id": 10000027,
"price": 100
},
{
"id": 10000028,
"price": 100
},
{
"id": 10000029,
"price": 100
}
]
}
}
字段
是否必选
说明
base_attr

基本属性
name
必选
商品名称
category
必选
商品分类id，商品分类列表请通过《获取指定分类的所有子分类》获取
main_img
必选
商品主图(图片需调用图片上传接口获得图片Url填写至此，否则无法添加商品。图片分辨率推荐尺寸为640×600)
img
必选
商品图片列表(图片需调用图片上传接口获得图片Url填写至此，否则无法添加商品。图片分辨率推荐尺寸为640×600)
detail

必选
商品详情列表，显示在客户端的商品详情页内
text

文字描述
img

图片(图片需调用图片上传接口获得图片Url填写至此，否则无法添加商品)
property

商品属性列表，属性列表请通过《获取指定分类的所有属性》获取
id

属性id
vid

属性值id
sku_info

商品sku定义，SKU列表请通过《获取指定子分类的所有SKU》获取
id

sku属性(SKU列表中id, 支持自定义SKU，格式为"$xxx"，xxx即为显示在客户端中的字符串)
vid

sku值(SKU列表中vid, 如需自定义SKU，格式为"$xxx"，xxx即为显示在客户端中的字符串)
buy_limit

用户商品限购数量
sku_list

sku信息列表(可为多个)，每个sku信息串即为一个确定的商品，比如白色的37码的鞋子
sku_id

sku信息, 参照上述sku_table的定义;
格式 : "id1:vid1;id2:vid2"
规则 : id_info的组合个数必须与sku_table个数一致(若商品无sku信息, 即商品为统一规格，则此处赋值为空字符串即可)
ori_price

sku原价(单位 : 分)
price

sku微信价(单位 : 分, 微信价必须比原价小, 否则添加商品失败)
icon_url

sku iconurl(图片需调用图片上传接口获得图片Url)
quantity

sku库存
product_code

商家商品编码
attrext

商品其他属性
isPostFree

是否包邮(0-否, 1-是), 如果包邮delivery_info字段可省略
isHasReceipt

是否提供发票(0-否, 1-是)
isUnderGuaranty

是否保修(0-否, 1-是)
isSupportReplace

是否支持退换货(0-否, 1-是)
location

商品所在地地址
country

国家(详见《地区列表》说明)
province

省份(详见《地区列表》说明)
city

城市(详见《地区列表》说明)
address

地址
delivery_info

必选
运费信息
delivery_type

运费类型(0-使用下面express字段的默认模板, 1-使用template_id代表的邮费模板, 详见邮费模板相关API)
template_id

邮费模板ID
express

id

快递ID
price

运费(单位 : 分)
1.1.4 返回数据说明
数据示例：
{
"errcode": 0,
"errmsg": "success",
"product_id": "pDF3iYwktviE3BzU3BKiSWWi9Nkw"
}
字段
说明
errcode
错误码
errmsg
错误信息
product_id
商品ID
1.1.5 附：快递列表
id
说明
10000027
平邮
10000028
快递
10000029
EMS
1.2 删除商品
1.2.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/del?access_token=ACCESS_TOKEN
POST数据格式
json
1.2.2 请求参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
商品信息
1.2.3 POST数据
数据示例：
{
"product_id": "pDF3iYwktviE3BzU3BKiSWWi9Nkw"
}
字段
说明
product_id
商品ID
1.2.4 返回数据说明
数据示例：
{
"errcode":0,
"errmsg":"success"
}
字段
说明
errcode
错误码
errmsg
错误信息
1.3 修改商品
1.3.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/update?access_token=ACCESS_TOKEN
POST数据格式
json
1.3.2 请求参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
商品详情信息
1.3.3 POST数据
数据示例：
{
"product_id": "pDF3iY6Kr_BV_CXaiYysoGqJhppQ",
"product_base": {
"category_id": [
"537074298"
],
"property": [
{
"id": "107574一八79",
"vid": "1079749967"
},
{
"id": "1075754127",
"vid": "1079795198"
},
{
"id": "1075777334",
"vid": "1079837440"
}
],
"name": "testaddproduct",
"sku_info": [
{
"id": "107574一八73",
"vid": [
"1079742386",
"1079742363"
]
}
],
"main_img": "xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0",
"img": [
"xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0"
],
"detail": [
{
"img": "xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ul1UcLcwxrFdwTKYhH9Q5YZoCfX4Ncx655ZK6ibnlibCCErbKQtReySaVA/0"
}
],
"buy_limit": 3
},
"sku_list": [
{
"sku_id": "107574一八73:1079742386",
"price": 30,
"icon_url": "xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0",
"product_code": "testing",
"ori_price": 9000000,
"quantity": 800
},
{
"sku_id": "107574一八73:1079742363",
"price": 30,
"icon_url": "xmmbiz.qpicx/mmbiz/4whpV1VZl28bJj62XgfHPibY3ORKicN1oJ4CcoIr4BMbfA8LqyyjzOZzqrOGz3f5KWq1QGP3fo6TOTSYD3TBQjuw/0",
"product_code": "testingtesting",
"ori_price": 9000000,
"quantity": 800
}
],
"attrext": {
"location": {
"country": "中国",
"province": "广东省",
"city": "广州市",
"address": "T.I.T创意园"
},
"isPostFree": 0,
"isHasReceipt": 1,
"isUnderGuaranty": 0,
"isSupportReplace": 0
},
"delivery_info": {
"delivery_type": 0,
"template_id": 0,
"express": [
{
"id": 10000027,
"price": 100
},
{
"id": 10000028,
"price": 100
},
{
"id": 10000029,
"price": 100
}
]
}
}
备注：
product_id表示要更新的商品的ID，其他字段说明请参考增加商品接口。
从未上架的商品所有信息均可修改，否则商品的名称(name)、商品分类(category)、商品属性(property)这三个字段不可修改。
1.3.4 返回数据说明
数据示例：
{
"errcode":0,
"errmsg":"success"
}
字段
说明
errcode
错误码
errmsg
错误信息
1.4 查询商品
1.4.1 接口调用请求说明
协议
https
http请求方式
GET
请求Url
https://api.weixin.qqx/merchant/get?access_token=ACCESS_TOKEN
1.4.2 请求参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
1.4.3 POST数据
数据示例：
{
"product_id": "pDF3iYwktviE3BzU3BKiSWWi9Nkw"
}
字段
说明
product_id
商品ID
1.4.4 返回数据说明
数据示例：
{
"errcode": 0,
"errmsg": "success",
"product_info": {
"product_id": "pDF3iY6Kr_BV_CXaiYysoGqJhppQ",
"product_base": {
"name": "testaddproduct",
"category_id": [
537074298
],
"img": [
"xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0"
],
"property": [
{
"id": "品牌",
"vid": "Fujifilm/富士"
},
{
"id": "屏幕尺寸",
"vid": "1.8英寸"
},
{
"id": "防抖性能",
"vid": "CCD防抖"
}
],
"sku_info": [
{
"id": "107574一八73",
"vid": [
"1079742386",
"1079742363"
]
}
],
"buy_limit": 10,
"main_img": "xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0",
"detail_html": "<div class=\"item_pic_wrp\" style=\"margin-bottom:8px;font-size:0;\"><img class=\"item_pic\" style=\"width:100%;\" alt=\"\" src=\"xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0\" ></div><p style=\"margin-bottom:11px;margin-top:11px;\">test</p><div class=\"item_pic_wrp\" style=\"margin-bottom:8px;font-size:0;\"><img class=\"item_pic\" style=\"width:100%;\" alt=\"\" src=\"xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ul1UcLcwxrFdwTKYhH9Q5YZoCfX4Ncx655ZK6ibnlibCCErbKQtReySaVA/0\" ></div><p style=\"margin-bottom:11px;margin-top:11px;\">test again</p>"
},
"sku_list": [
{
"sku_id": "107574一八73:1079742386",
"price": 30,
"icon_url": "xmmbiz.qpicx/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjD3ulEKogfsiaua49pvLfUS8Ym0GSYjViaLic0FD3vN0V8PILcibEGb2fPfEOmw/0",
"quantity": 800,
"product_code": "testing",
"ori_price": 9000000
},
{
"sku_id": "107574一八73:1079742363",
"price": 30,
"icon_url": "xmmbiz.qpicx/mmbiz/4whpV1VZl28bJj62XgfHPibY3ORKicN1oJ4CcoIr4BMbfA8LqyyjzOZzqrOGz3f5KWq1QGP3fo6TOTSYD3TBQjuw/0",
"quantity": 800,
"product_code": "testingtesting",
"ori_price": 9000000
}
],
"attrext": {
"isPostFree": 0,
"isHasReceipt": 1,
"isUnderGuaranty": 0,
"isSupportReplace": 0,
"location": {
"country": "中国",
"province": "广东省",
"city": "广州市",
"address": "T.I.T创意园"
}
},
"delivery_info": {
"delivery_type": 1,
"template_id": 103312920
}
}
}
字段
说明
errcode
错误码
errmsg
错误信息
product_info
商品详情(字段说明详见增加商品)
1.5 获取指定状态的所有商品
1.5.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/getbystatus?access_token=ACCESS_TOKEN
1.5.2 请求参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
商品详情信息
1.5.3 POST数据
数据示例：
{
"status": 0
}
字段
说明
status
商品状态(0-全部, 1-上架, 2-下架)
1.5.4 返回数据说明
数据示例：
{
"errcode": 0,
"errmsg": "success",
"products_info": [
{
"product_base": ...,
"sku_list": ...,
"attrext": ...,
"delivery_info": ...,
"product_id": "pDF3iY-mql6CncpbVajaB_obC3Bk",
"status": 1
},
{
"product_base": ...,
"sku_list": ...,
"attrext": ...,
"delivery_info": ...,
"product_id": "pDF3iY-mql6CncpbVajaB_obC321",
"status": 1
}
]
}
字段
说明
errcode
错误码
errmsg
错误信息
products_info
指定状态下的所有商品集合
1.6 商品上下架
1.6.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/modproductstatus?access_token=ACCESS_TOKEN
1.6.2 请求参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
商品详情信息
1.6.3 POST数据
数据示例：
{
"product_id": "p0FfkjnSNm4NQj0_4a9l9MtRRxzA",
"status": 0
}
字段
说明
product_id
商品ID
status
商品上下架标识(0-下架, 1-上架)
1.6.4 返回数据说明
数据示例：
{
"errcode":0,
"errmsg":"success"
}
字段
说明
errcode
错误码
errmsg
错误信息
1.7 获取指定分类的所有子分类
1.7.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/category/getsub?access_token=ACCESS_TOKEN
1.7.2 请求参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
商品大分类信息
1.7.3 POST数据
数据示例：
{
"cate_id": 5378749一三
}
字段
说明
cate_id
大分类ID(根节点分类id为1)
1.7.4 返回数据说明
数据示例：
{
"errcode": 0,
"errmsg": "success",
"cate_list": [
{
"id": "537074292",
"name": "数码相机"
},
{
"id": "537074293",
"name": "家用摄像机"
},
{
"id": "537074298",
"name": "单反相机"
},
{
"id": "537082412",
"name": "镜头"
},
{
"id": "537102001",
"name": "单电/微单"
}
]
}
字段
说明
errcode
错误码
errmsg
错误信息
cate_list

子分类列表

id
子分类ID

name
子分类名称
1.8 获取指定子分类的所有SKU
1.8.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/category/getsku?access_token=ACCESS_TOKEN
1.8.2 请求参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
商品子分类信息
1.8.3 POST数据
数据示例：
{
"cate_id": 537074292
}
字段
说明
cate_id
商品子分类ID
1.8.4 返回数据说明
数据示例：
{
"errcode": 0,
"errmsg": "success",
"sku_table": [
{
"id": "107574一八73",
"name": "颜色",
"value_list": [
{
"id": "1079742375",
"name": "撞色"
},
{
"id": "1079742376",
"name": "桔色"
}
]
}
]
}
字段
说明
errcode
错误码
errmsg
错误信息
sku_table

sku列表
id
sku id
name
sku 名称
value_list

sku vid列表
id
vid
name
vid名称
1.9 获取指定分类的所有属性
1.9.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/category/getproperty?access_token=ACCESS_TOKEN
1.9.2 请求参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
商品分类信息
1.9.3 POST数据
数据示例：
{
"cate_id": 537072692
}
字段
说明
cate_id
分类ID
1.9.4 返回数据说明
数据示例：
{
"errcode": 0,
"errmsg": "success",
"properties": [
{
"id": "107574一八79",
"name": "品牌",
"property_value": [
{
"id": "200050867",
"name": "VIC&#38"
},
{
"id": "200050868",
"name": "Kate&#38"
},
{
"id": "200050971",
"name": "M&#38"
},
{
"id": "200050972",
"name": "Black&#38"
}
]
},
{
"id": "123456789",
"name": "颜色",
"property_value": ...
}
]
}
字段
说明
errcode
错误码
errmsg
错误信息
properties

属性列表
id
属性id
name
属性名称
property_value

属性值
id
属性值id
name
属性值名称

2. 库存管理接口
2.1 增加库存
2.1.1 接口调用请求说明
协议
https
http请求方式
POST
请求Url
https://api.weixin.qqx/merchant/stock/add?access_token=ACCESS_TOKEN
POST数据格式
json
2.1.2 请求参数说明
参数
是否必须
说明
access_token
是
公众号的调用接口凭证
POST数据
是
商品库存信息
2.1.3 POST数据
数据示例：
{
"product_id": "pDF3iY5EYkMxs4-tF8xedyES5GQI",
"sku_info": "10000983:10000995;10001007:10001010",
"quantity": 20
}
字段
说明
product_id
商品ID
sku_info
sku信息,格式"id1:vid1;id2:vid2",如商品为统一规格，则此处赋值为空字符串即可
quantity
增加的库存数量
2.1.4 返回数据说明
数据示例：
{
"errcode":0,
"errmsg":"success"
}
字段
说明
errcode
错误码
errmsg
错误信息
2.2 减少库存
2.2.1 接口调用请求说明
协议