备课的笔记接口自动化fecshop1

1、Fecshop 接口文档Fecshop 接口文档11、Fecshop Api 登录和验证22、Fecshop 商品接口2查询商品列表2查询商品详情3添加商品4修改商品信息6删除商品9查询订单93、 产品分类接口10查询商品分类列表10商品分类详情11添加商品分类11修改商品分类14删除商品分类17版本号日期说明作者V1.02019-08-26初始版本阳尚连1、Fecshop Api 登录和验证描述：管理用户登录验证接口URL: 接口：/v1/account/loginjsont请求参数：请求样本：username:admin, password:admin123返回数据样本：acs-token

2、:Q8b93gzTGkrBy5Z0-0C2I-ncQdPUmP9p,sus:sucs,code:2002、Fecshop 商品接口2.1 查询商品列表Api 描述：按照分页，得到商品列表URL: http:/ /v1/article/list格式：json方式：getRequest Header 参数:请求格式：请求方式：http:/参数名称是否必须长度描述参数名称是否必须类型描述username必须Stringappadmin管理用户名password必须Stringappadmin用户2.2 查询商品详情Api 描述：根据传递的 id，查询得到一行 product 数据方式：Request

3、 Header 参数:Request JSON Data(Body)：Response JSON Data(Body)：格式：jsonget参数名称是否必须类型描述code必须Number200 代表成功message必须String执行结果的文字描述信息data必须Objectapi 获取的数据保存到 data 中参数名称是否必须类型描述id可选Stringproduct 的表 id，譬如：57937114f656f2f42ce25ca5参数名称是否必须类型描述acs-token必须String登录后获取的 token,如何获取 acs-token，请参考 Fecshop Api 登录和验证

4、URL: HYPERLINK http:/a/ http:/a/v1/product/fetchone格式：json请求参数：参数名称是否必须长度描述page可选默认代表第一页password必须Stringappadmin用户acs-token必须String登录后获取的 token2.3 添加商品Api 描述：根据传递的 json 数据，新增一行 product 数据 HYPERLINK http:/a/ http:/a/v1/product/addone格式：json方式： tRequest Header 参数:Request JSON Data(Body)：参数名称是否必须类型描述na

5、me必须Array【多语言属性】产品的名字spu必须String产品的 spusku必须String产品的 skuweight必须Float产品的重量kgsus可选产品的状态，1 代表激活，2 代表关闭，如果不填写默认为激活qty可选产品的库存，如果不填写，则代表为 0is_in_stock可选产品的上架状态，1 代表上架，2 代表下架，如果不填写，则默认为上架状态category可选Array产品的分类id，该属性是数组属性price必须Float产品的价格spel_price可选Float产品的特价spel_from可选Date产品的特价开始时间参数名称是否必须长度描述acs-token必

6、须String登录后获取的 tokenURL:YVKREZU可选*GZK产品的特价结束时间IUYZEVXOIK可选,RUGZ产品的成本价ZOKXEVXOIK可选XXG_产品的批发价，根据加入购物车的产品的数量，设置不同的价格TKEVXUJIZELXUS可选*GZK作为新产品的开始时间TKEVXUJIZEZU可选*GZK作为新产品的结束时间YNUXZEJKYIXOVZOUT可选XXG_【多语言属性】产品的简短描述GZZXEMXUV必须9ZXOTM产品的属性组XKSGXQ可选9ZXOTM产品的备注，一般作为的一些备注，不用于前台显示的内容IYZUSEUVZOUT可选XXG_产品的自定义属性部分，X

7、KRGZOUTEYQ可选XXG_产品的相关产品，该属性是数组属性，数组的每一个 OZKS 为 YQH_EGRYUEH_EYQ可选XXG_买了这个产品的人还买了那些产品，该属性是数组属性，数组的每一个 OZKS 为 YQYKKEGRYUEYKKEYQ可选XXG_看了这个产品的人还看了那些产品，该属性是数组属性，数组的每一个 OZKS 为 YQXREQK_可选9ZXOTM产品对应的 XR QK_，如果自定义的 XREQK_存在，系统会添加一块字符串来保证唯一ZOZRK可选XXG_【多语言属性】产品 的标题SKZGEQK_UXJY可选XXG_【多语言属性】产品 的 SKZG QK_UXJY2.4 修

8、改商品信息Api 描述：根据传递的 id，更新一行product 数据 HYPERLINK http:/a/ http:/a/v1/product/updateone格式：json方式： tRequest Header 参数:请求参数：参数名称是否必须类型描述id必须Array【多语言属性】产品的名字name可选Array【多语言属性】产品的名字weight可选Float产品的重量kgsus可选产品的状态，1 代表激活，2 代表关闭，如果不填写默认参数名称是否必须长度描述acs-token必须String登录后获取的 tokenURL:meta_description可选Array【多语言属性

9、】产品 的 meta keywordsdescription可选Array【多语言属性】产品的描述image可选Array产品，数组属性，您需要把首先，把通过 ftp 上传到roduct/下面里面填写的是在该路径下的相对路径mon/media/catalog/p为激活WZ_可选产品的库存，如果不填写，则代表为 OYEOTEYZUIQ可选产品的上架状态， 代表上架， 代表下架，如果不填写，则默认为上架状态IGZKMUX_可选XXG_产品的分类OJ，该属性是数组属性VXOIK可选,RUGZ产品的价格YVKREVXOIK可选,RUGZ产品的特价YVKRELXUS可选*GZK产品的特价开始时间YVKR

10、EZU可选*GZK产品的特价结束时间IUYZEVXOIK可选,RUGZ产品的成本价ZOKXEVXOIK可选XXG_产品的批发价，根据加入购物车的产品的数量，设置不同的价格TKEVXUJIZELXUS可选*GZK作为新产品的开始时间TKEVXUJIZEZU可选*GZK作为新产品的结束时间YNUXZEJKYIXOVZOUT可选XXG_【多语言属性】产品的简短描述XKSGXQ可选9ZXOTM产品的备注，一般作为的一些备注，不用于前台显示的内容XKRGZOUTEYQ可选XXG_产品的相关产品，该属性是数组属性，数组的每一个 OZKS为 YQH_EGRYUEH_EYQ可选XXG_买了这个产品的人还买了那

11、些产品，该属性是数组属性，数组的每一个 OZKS 为 YQ产品的数据更新，只能更新一些通用的编辑部分，也就是只有上面列表中展示的产品数据部分， 如果您的产品更新非常的复杂，涉及到很多其他的改动， 譬如 custom option 等，那么您可以使用删除api 删除产品，然后 在通过 addone api新数据。注意：此接口为纯更新接口，填写了那个字段，就更新那个字段，其他的不做改动Request JSON Data(Body Exle)： id:5a1c2b2abfb7ae0a293ee286, name: name_en: test computer444444, name_fr: , na

12、me_de: , name_es: , name_ru: ,name_pt: , name_zh: 测试计算机 , weight: 0.3, sus: 1, qty:334, is_in_stock: 1, category: 57beb586f656f275313bf57a ,price: 33, spel_price: 32, spel_from: 2017-09-09,spel_to: 2018-09-09, cost_price: 10, tier_price: qty:2, price: 30 , qty: 4, price: 28 , new_product_from:2017-1

13、1-05, new_product_to: 2017-12-05, meta_title: meta_title_en: sex sex, meta_title_fr: , meta_title_de: , meta_title_es: , meta_title_ru: , meta_title_pt: , meta_title_zh: , meta_keywords: meta_keywords_en: se meta keywords, meta_keywords_fr: , meta_keywords_de: , meta_keywords_es: , meta_keywords_ru:

14、 , meta_keywords_pt: ,meta_keywords_zh: , meta_description: meta_description_en:semeta keywords semeta keywords se meta_description_de: meta_description_ru:meta_description_zh:meta keywords, , , description:meta_description_fr:meta_description_es: meta_description_pt:, description_en: 3333, descript

15、ion_fr: , description_de: , description_es: , description_ru: , description_pt: , description_zh: , short_description: short_description_en: 334343, short_description_fr: , short_description_de: , short_description_es: , short_description_ru: , short_description_pt: , short_description_zh: , remark:

16、 4444, relation_sku: , buy_also_buy_sku: , see_also_see_sku: see_also_see_sku可选Array看了这个产品的人还看了那些产品，该属性是数组属性，数组的每一个 item 为 skutitle可选Array【多语言属性】产品 的标题meta_keywords可选Array【多语言属性】产品 的 meta keywordsmeta_description可选Array【多语言属性】产品 的 meta keywordsdescription可选Array【多语言属性】产品的描述数据结构和必填的详细说明参看： AppApi 多语言

17、属性说明对于多语言属性的2.5 删除商品Api 描述：根据传递的 id，删除一行product 数据 HYPERLINK http:/a/ http:/a/v1/product/deleteone格式：json方式： tRequest Header 参数:请求参数：请求参数样本： ids: 5a1b6778bfb7ae47c1502bb2,5a1b678fbfb7ae44c26734f4 2.6 查询订单Request Header 参数:请求参数：参数名称是否必须长度描述acs-token必须String登录后获取的 tokenApi 描述：按照分页，得到order 数据的列表URL: HY

18、PERLINK http:/a/v1/order/list http:/a/v1/order/list格式：json方式：get参数名称是否必须类型描述ids必填ArrayStringpage 对应的 id，该值是用来做 update 操作的唯一值参数名称是否必须长度描述acs-token必须String登录后获取的 tokenURL:3、 产品分类接口3.1 查询商品分类列表Api 描述：按照分页，得到分类数据的列表方式：Request Header 参数:Request JSON Data(Body)：get参数名称是否必须类型描述page可选设置获取数据的当前页，如果为空，则代表为第一页

19、参数名称是否必须长度描述acs-token必须String登录后获取的 tokenURL: /v1/category/list格式：json参数名称是否必须类型描述code必须Number200 代表成功message必须String执行结果的文字描述信息data必须Arrayapi 获取的数据保存到 data 中参数名称是否必须类型描述page可选设置获取数据的当前页，如果为空，则代表为第一页Response JSON Data(Body)：格式：json3.2 商品分类详情Api 描述：根据传递的 id 或url_key，查询得到一行 category 数据URL: 方式：Request

20、Header 参数:请求参数：3.3 添加商品分类Api 描述：根据传递的 json 数据，新增一行 page 数据URL: 格式：方式： tRequest Header 参数:http:/gethttp:/参数名称是否必须长度描述acs-token必须String登录后获取的 tokenjson/v1/category/addone参数名称是否必须类型描述id可选Stringcategory 的表 id，当 page在 mongodb 时，id 就是字符串，譬如 mongodb 的_id：57937114f656f2f42ce25ca5url_key可选Stringcategory 的 ur

21、l_key，url_key 是唯一的参数名称是否必须长度描述acs-token必须String登录后获取的 token格式：json/v1/category/fetchone请求参数：参数名称是否必须类型描述url_key可选StringCategory 对应的 url key，如果自定义的 url_key 存在，系统会添加一块字符串来保证唯一title可选String【多语言属性】page 的标题meta_keywords可选String【多语言属性】page 的 meta keywordsmeta_description可选String【多语言属性】page 的 meta keywords

22、parent_id必须String父分类的 idname必须String分类的名字sus可选String分类的状态，1 代表激活，2 代表关闭，如果填写其他值，系统将强制设置为 1description可选String分类的描述_custom可选String菜单的自定义属性，用于一级分类弹出的子分类部分，添加一些展示之类的东西filter_produ ct_attr_selected可选String分类侧栏用于属性过滤的产品属性，填写后，会聚合所有的该分类下的产品对应的所有的该属性filter_product_attr_unsel可选String不聚合的产品属性，对于分类页面的侧栏属性过滤的属

23、性，有一个全局配置，配置后，所有的分类都将存Request JSON Data(Body Exle)： parent_id: 0, name: name_en: Wedding2222, name_fr: ,name_de: , name_es: , name_ru: , name_pt: , name_zh:婚礼 , sus: 1, _show: 1, url_key: /wedding, level:1, thumbnail_image: null, image: null, filter_product_attr_selected:style,dresses-length,pattern

24、-type,sleeve-length,collar,color,filter_product_attr_unselected: , description: description_en:, description_fr:description_ru: , description_de:, description_es: ,description_zh: ,description_pt:_custom_en: , _custom_fr:,/fr/weddingimg/custom/_custom_de: , _custom_pt: , /what_b.jpg_custom_es: ,_cus

25、tom_zh: ,_custom_ru: , title: title_en: Wedding, title_fr: , title_de: ,title_es: , title_ru: , title_pt: , title_zh: , meta_description: meta_description_en: , meta_description_fr: , meta_description_de: , meta_description_es: , meta_description_ru: , meta_description_pt: , meta_description_zh: , m

26、eta_keywords: meta_keywords_en: , meta_keywords_fr: , meta_keywords_de: , meta_keywords_es: ,meta_keywords_ru: , meta_keywords_pt: , meta_keywords_zh: ,ected在该属性的过滤，如果这个值填写了该属性，那么在这个分类下，全局设置将会去除该属性thumbnail_image可选String分类图image可选String分类图对于多语言属性的数据结构和必填的详细说明参看： AppApi 多语言属性说明include_in_: null, is_f

27、eature: null, available_sort_by: null,default_sort_by: null 3.4 修改商品分类Api 描述：根据传递的 id 或url_key，更新一行 page 数据 HYPERLINK http:/a/ http:/a/v1/category/updateone格式：json方式： tRequest Header 参数:请求参数：参数名称是否必须类型描述id必填String分类对应的id，该值是用来做 update 操作的唯一值parent_id可选String分类的父类id，如果是一级分类，那么 parent_id为字符串0name可选Str

28、ing【多语言属性】分类的名字description可选String【多语言属性】分类的描述_custom可选String【多语言属性】分类的一个自定义属性filter_product_attr_selected可选String用于在分类侧栏过滤的产品属性filter_product_可选String不用于在分类侧栏过滤的产品属性（可以从分类参数名称是否必须长度描述acs-token必须String登录后获取的 tokenURL:【请求参数样本】：_custom: _custom_fr:_custom_de:_custom_es:_custom_zh:_custom_pt:_custom_ru:_custom_en:,/custom/woman_a.jpg/spel-occaimg20px;/custom/woman_b.jpg width=244filter_product_attr_selected:style,dresses-length,pattern-type,sleeve-length,collar,color,_show: 1,level: 1,created_user_id: 2,created_at: 1471589401, description: description_fr: description_en: