{ECShop} 協(xié)議文檔說明
- api.access.json - 接入
- api.areacode.json - 區(qū)號列表
- api.article.json - 文章
- api.auth.base.json - 登錄
- api.auth.default.json - 注冊（通過用戶名念颈、郵箱）
- api.auth.mobile.json - 注冊（通過手機(jī)號）
- api.auth.social.json - 授權(quán)（微信瞬项、微博瞧预、QQ等）
- api.auth.web.json - 網(wǎng)頁第三方授權(quán)
- 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 - 優(yōu)惠券
- api.invoice.json - 發(fā)票
- api.message.json - 消息
- api.notice.json - 公告
- api.order.json - 訂單
- api.payment.json - 支付
- api.product.json - 產(chǎn)品
- api.push.json - 推送
- api.recommend.json - 推薦
- api.region.json - 地區(qū)（國家月杉、省、市伞插、區(qū)）
- 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 - 版本
協(xié)議文檔結(jié)構(gòu)
文件結(jié)構(gòu)
//
// _/_/_/ _/ _/_/_/_/_/
// _/ _/_/ _/_/ _/ _/ _/ _/_/ _/_/
// _/ _/_/ _/_/_/_/ _/_/_/_/ _/_/ _/ _/ _/ _/ _/
// _/ _/ _/ _/ _/ _/ _/ _/ _/ _/ _/
// _/_/_/ _/_/_/ _/_/_/ _/ _/ _/_/_/_/_/ _/_/ _/_/
//
//
// 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" :
{
// 原協(xié)議名稱
// "PRODUCT_STATUS" :
// 促銷狀態(tài)
"PRODUCT_ACTIVITY_STATUS" :
{
"PREPARING" : 0 // 未開始
// 原名稱
// , "ONLINE" : 1 // 已開始
, "ONGOING" : 1 // 已開始
, "FINISHED" : 2 // 已結(jié)束
},
},
"model" :
{
// 商品
"PRODUCT":
{
"id" : "12345" // 商品id
, "category" : "12345" // 所屬分類id
, "brand" : "{BRAND}" // 所屬品牌
, "shop" : "12345" // 所屬店鋪id
, "tags" : ["{PRODUCT_TAG}"] // 相關(guān)標(biāo)簽
, "sku" : "xxxx" // sku
, "name" : "大褲衩" // 名稱
, "price" : "100.0" // 價格
, "good_stock" : 100 // 商品總庫存
, "current_price" : "85.0" // 現(xiàn)價
, "score" : 50 // 可以使用的積分
, "promos" : ["{PRODUCT_PROMO}"] // 促銷信息
, "discount" : "{PRODUCT_DICOUNT}" // 促銷價格 // ECShop 二期 客戶端不需要萨醒，是否由后臺處理并鸵？
// 原協(xié)議名稱
, "is_liked" : 1 // 是否收藏過，登錄用戶才有值
, "sales_count" : 300 // 銷售數(shù)量
, "comment_count" : 300 // 評論數(shù)量
, "sales_count" : 300 // 銷售數(shù)量
, "photos" : ["{PHOTO}"] // 圖片
, "properties" : ["{PRODUCT_PROPERTY}"] // 商品屬性
, "stock" : ["{PRODUCT_STOCK}"] // 商品屬性組合庫存
, "review_rate" : "100%" // 好評率
, "intro_url" : "http://" // 介紹URL
, "share_url" : "http://" // 分享鏈接URL
, "created_at" : "1466678240" // 創(chuàng)建時間
, "updated_at" : "1466678240" // 更新時間
},
//商品促銷信息
"PRODUCT_PROMO" :
{
"name" : "優(yōu)惠", // 促銷名稱
"promo" : "滿百包郵", // 促銷信息
"start_at" : "213231", // 促銷信息 // ECShop 二期 客戶端不改
"end_at" : "123123", // 促銷信息 // ECShop 二期 客戶端不改
"promo" : "滿百包郵", // 促銷信息
"gift" : ["{PRODUCT}"] // 贈品
},
// ECShop 二期 客戶端不需要捌蚊，是否由后臺處理集畅？
"PRODUCT_DICOUNT" :
{
"price" : "100.0", // 促銷價格
"start_at" : "120986", // 開始時間
"end_at" : "123123", // 結(jié)束時間
},
// 商品附件
"PRODUCT_ATTACHMENT" :
{
"id" : "12345" // 附件id
, "name" : "上衣" // 附件名稱
, "price" : 100 // 附加價格
, "created_at" : "1466678240" // 創(chuàng)建時間
, "updated_at" : "1466678240" // 更新時間
},
// 商品標(biāo)簽
"PRODUCT_TAG" :
{
"id" : "12345" // 標(biāo)簽id
, "name" : "上衣" // 標(biāo)簽名稱
, "created_at" : "1466678240" // 創(chuàng)建時間
, "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 // 屬性組合庫存數(shù)量
},
// 澳寶定制
"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_KEY>" // 鍵
, "sort_value" : "<SORT_VALUE>" // 值
, "page" : 1 // 當(dāng)前第幾頁
, "per_page" : 10 // 每頁多少
},
"response" :
{
"paged" : "{PAGED}" // 分頁結(jié)果
, "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 // 當(dāng)前第幾頁
, "per_page" : 10 // 每頁多少
},
"response" :
{
"paged" : "{PAGED}" // 分頁結(jié)果
, "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 // 當(dāng)前第幾頁
, "per_page" : 10 // 每頁多少
},
"response" :
{
"paged" : "{PAGED}" // 分頁結(jié)果
, "products" : ["{PRODUCT}"]
}
},
// 判斷商品是否有效
"POST /v2/ecapi.product.validate" :
{
"request" :
{
"product" : ["{VALIDATE_PRODUCT}"] // 有效商品
},
"response" :
{
// 原協(xié)議名稱
// "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 // 數(shù)量
, "consignee" : "(CONSIGNEE.id)" // 收貨人ID
, "shipping" : "(SHIPPING_VENDOR.id)" // 快遞ID
, "invoice_type" : "(INVOICE_TYPE.id)" // 發(fā)票類型ID，如：公司缅糟、個人
, "invoice_title" : "Geek-Zoo Studio" // 發(fā)票抬頭挺智，如：英斯特哈博（北京）科技有限公司
, "invoice_content" : "(INVOICE_CONTENT.id)" // 發(fā)票內(nèi)容ID，如：辦公用品窗宦、禮品
, "coupon" : "(COUPON.id)" // 優(yōu)惠券ID
, "cashgift" : "(CASHGIFT.id)" // 紅包ID
, "comment" : "快點快點" // 留言
, "score" : 100 // 積分
},
"response" :
{
"order" : "{ORDER}"
}
}
}
}
