{ECShop} 协议文档说明
- api.access.json - 接入
- api.areacode.json - 区号列表
- api.article.json - 文章
- api.auth.base.json - 登录
- api.auth.default.json - 注册（通过用户名、邮箱）
- api.auth.mobile.json - 注册（通过手机号）
- api.auth.social.json - 授权（微信、微博、QQ等）
- api.auth.web.json - 网页第三方授权
- api.banner.json - 广告
- api.base.json - 公共
- api.brand.json - 品牌
- api.cardpage.json - 卡片
- api.cart.json - 购物车
- api.cashgift.json - 红包
- api.category.json - 分类
- api.config.json - 配置
- api.consignee.json - 收货地址
- api.coupon.json - 优惠券
- api.invoice.json - 发票
- api.message.json - 消息
- api.notice.json - 公告
- api.order.json - 订单
- api.payment.json - 支付
- api.product.json - 产品
- api.push.json - 推送
- api.recommend.json - 推荐
- api.region.json - 地区（国家、省、市、区）
- api.review.json - 评价
- api.score.json - 积分
- api.search.json - 搜索
- api.shipping.json - 快递
- api.shop.json - 店铺
- api.site.json - 站点
- api.splash.json - 闪屏
- api.theme.json - 主题
- api.user.json - 用户
- api.version.json - 版本
协议文档结构
文件结构
//
// _/_/_/ _/ _/_/_/_/_/
// _/ _/_/ _/_/ _/ _/ _/ _/_/ _/_/
// _/ _/_/ _/_/_/_/ _/_/_/_/ _/_/ _/ _/ _/ _/ _/
// _/ _/ _/ _/ _/ _/ _/ _/ _/ _/ _/
// _/_/_/ _/_/_/ _/_/_/ _/ _/ _/_/_/_/_/ _/_/ _/_/
//
//
// Copyright (c) 2016-2017, Geek Zoo Studio
// http://www.geek-zoo.com
//
{
"meta" :
{
"title" : "E-Commerce Standard API",
"output" : "product-api",
"author" : "Geek-Zoo Studio",
"source" : "none",
"prefix" : "ECAPI_"
},
"enum" :
{
// 原协议名称
// "PRODUCT_STATUS" :
// 促销状态
"PRODUCT_ACTIVITY_STATUS" :
{
"PREPARING" : 0 // 未开始
// 原名称
// , "ONLINE" : 1 // 已开始
, "ONGOING" : 1 // 已开始
, "FINISHED" : 2 // 已结束
},
},
"model" :
{
// 商品
"PRODUCT":
{
"id" : "12345" // 商品id
, "category" : "12345" // 所属分类id
, "brand" : "{BRAND}" // 所属品牌
, "shop" : "12345" // 所属店铺id
, "tags" : ["{PRODUCT_TAG}"] // 相关标签
, "sku" : "xxxx" // sku
, "name" : "大裤衩" // 名称
, "price" : "100.0" // 价格
, "good_stock" : 100 // 商品总库存
, "current_price" : "85.0" // 现价
, "score" : 50 // 可以使用的积分
, "promos" : ["{PRODUCT_PROMO}"] // 促销信息
, "discount" : "{PRODUCT_DICOUNT}" // 促销价格 // ECShop 二期 客户端不需要，是否由后台处理？
// 原协议名称
, "is_liked" : 1 // 是否收藏过，登录用户才有值
, "sales_count" : 300 // 销售数量
, "comment_count" : 300 // 评论数量
, "sales_count" : 300 // 销售数量
, "photos" : ["{PHOTO}"] // 图片
, "properties" : ["{PRODUCT_PROPERTY}"] // 商品属性
, "stock" : ["{PRODUCT_STOCK}"] // 商品属性组合库存
, "review_rate" : "100%" // 好评率
, "intro_url" : "http://" // 介绍URL
, "share_url" : "http://" // 分享链接URL
, "created_at" : "1466678240" // 创建时间
, "updated_at" : "1466678240" // 更新时间
},
//商品促销信息
"PRODUCT_PROMO" :
{
"name" : "优惠", // 促销名称
"promo" : "满百包邮", // 促销信息
"start_at" : "213231", // 促销信息 // ECShop 二期 客户端不改
"end_at" : "123123", // 促销信息 // ECShop 二期 客户端不改
"promo" : "满百包邮", // 促销信息
"gift" : ["{PRODUCT}"] // 赠品
},
// ECShop 二期 客户端不需要，是否由后台处理？
"PRODUCT_DICOUNT" :
{
"price" : "100.0", // 促销价格
"start_at" : "120986", // 开始时间
"end_at" : "123123", // 结束时间
},
// 商品附件
"PRODUCT_ATTACHMENT" :
{
"id" : "12345" // 附件id
, "name" : "上衣" // 附件名称
, "price" : 100 // 附加价格
, "created_at" : "1466678240" // 创建时间
, "updated_at" : "1466678240" // 更新时间
},
// 商品标签
"PRODUCT_TAG" :
{
"id" : "12345" // 标签id
, "name" : "上衣" // 标签名称
, "created_at" : "1466678240" // 创建时间
, "updated_at" : "1466678240" // 更新时间
},
"PRODUCT_PROPERTY" :
{
"id" : "12345" // 属性id
, "is_multiselect" : true // 是否为多选框
, "name" : "尺寸" // 属性名称
, "attrs" : ["{PRODUCT_ATTRIBUTE}"] // 子属性
} ,
"PRODUCT_ATTRIBUTE" :
{
"id" : "12345" // 子属性id
, "attr_name" : "XL" // 子属性名称
, "attr_price" : "1" // 子属性价格
, "is_multiselect" : true // 是否为多选框
},
"PRODUCT_STOCK" :
{
"id" : "12345" // 属性组合id
, "goods_attr" : "163|245|265" // 商品属性组合id升序拼成字符串
, "goods_attr_price" : "100" // 商品属性组合价格变动
, "stock_number" : 12 // 属性组合库存数量
},
// 澳宝定制
"VALIDATE_PRODUCT" :
{
"product_id" : "(PRODUCT.id)" // 商品id
,"property" : ["(PRODUCT_ATTRIBUTE.id)"] // 用户选择的属性ID
},
},
"controller" :
{
// 商品列表
"POST /v2/ecapi.product.list" :
{
"request" :
{
"brand" : "12345" // 所属品牌id (选填)
, "category" : "12345" // 所属分类id (选填)
, "shop" : "12345" // 所属店铺id(选填)
, "sort_key" : "" // 键
, "sort_value" : "" // 值
, "page" : 1 // 当前第几页
, "per_page" : 10 // 每页多少
},
"response" :
{
"paged" : "{PAGED}" // 分页结果
, "products" : ["{PRODUCT}"]
}
},
// 推荐商品列表
"POST /v2/ecapi.product.recommend.list" :
{
"request" :
{
},
"response" :
{
"hot_products" : ["{PRODUCT}"], // 热销
"new_products" : ["{PRODUCT}"], // 新品
"good_products" : ["{PRODUCT}"], // 精品
}
},
// 商品配件
"POST /v2/ecapi.product.accessory.list" :
{
"request" :
{
"product" : "12" // 商品id
, "page" : 1 // 当前第几页
, "per_page" : 10 // 每页多少
},
"response" :
{
"paged" : "{PAGED}" // 分页结果
, "products" : ["{PRODUCT}"]
}
},
// 商品详情
"POST /v2/ecapi.product.get" :
{
"request" :
{
"product" : "12345" // 商品id
},
"response" :
{
"product" : "{PRODUCT}"
}
},
// 收藏商品
"POST /v2/ecapi.product.like" :
{
"request" :
{
"product" : "12345" // 店铺id
},
"response" :
{
"is_liked" : true
}
},
// 取消收藏商品
"POST /v2/ecapi.product.unlike" :
{
"request" :
{
"product" : "12345" // 店铺id
},
"response" :
{
"is_liked" : true
}
},
// 已收藏的商品
"POST /v2/ecapi.product.liked.list" :
{
"request" :
{
"page" : 1 // 当前第几页
, "per_page" : 10 // 每页多少
},
"response" :
{
"paged" : "{PAGED}" // 分页结果
, "products" : ["{PRODUCT}"]
}
},
// 判断商品是否有效
"POST /v2/ecapi.product.validate" :
{
"request" :
{
"product" : ["{VALIDATE_PRODUCT}"] // 有效商品
},
"response" :
{
// 原协议名称
// "is_validate" : true
"is_valid" : true
}
},
// 立即购买
"POST /v2/ecapi.product.purchase" :
{
"request" :
{
"shop" : "(SHOP.id)" // 店铺ID
, "product" : "(PRODUCT.id)" // 商品ID
, "property" : ["(PRODUCT_ATTRIBUTE.id)"] // 用户选择的属性ID
, "amount" : 100 // 数量
, "consignee" : "(CONSIGNEE.id)" // 收货人ID
, "shipping" : "(SHIPPING_VENDOR.id)" // 快递ID
, "invoice_type" : "(INVOICE_TYPE.id)" // 发票类型ID，如：公司、个人
, "invoice_title" : "Geek-Zoo Studio" // 发票抬头，如：英斯特哈博（北京）科技有限公司
, "invoice_content" : "(INVOICE_CONTENT.id)" // 发票内容ID，如：办公用品、礼品
, "coupon" : "(COUPON.id)" // 优惠券ID
, "cashgift" : "(CASHGIFT.id)" // 红包ID
, "comment" : "快点快点" // 留言
, "score" : 100 // 积分
},
"response" :
{
"order" : "{ORDER}"
}
}
}
}
