# api-doc **Repository Path**: zhaoyshine/api-doc ## Basic Information - **Project Name**: api-doc - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2019-11-07 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ### 发起置换订单 post /users/:user_id/orders #### 参数 ``` goods_ids: [] 心愿单（可以多个） stock_record_ids: [] 背包ID（只能一个） type: 'ExchangeOrder' 固定传值 ``` #### 返回 ``` status 为 'ok' 就行 ``` ### 发起申请订单 post /users/:user_id/orders #### 参数 ``` exchange_order_id: Int 置换订单ID stock_record_ids: [] 背包ID（只能一个） type: 'ChangeOrder' 固定传值 ``` #### 返回 ``` status 为 'ok' 就行 ``` ### 置换大厅（也可为背包选中后查询置换列表，目前不用）get users/orders/exchanges 有分页 #### 参数 ``` # stock_record_ids: [] 可选，背包ID，选中背包藏品，查看置换订单，目前不用 goods_name: '商品名称' 可选，按商品名称筛选 tag_id: 标签ID 可选，按标签ID筛选 ``` #### 返回参数 ``` orders.source_goods, 用户置换订单的商品 orders.target_goods, 用户心愿单 orders.is_exchangeable, 对于当前用户是否可换，未登录没有该字段 orders.exchangeable_stock_records, 对于当前用户可换哪些商品的对应背包ID，未登录没有该字段 ``` ### 取消订单（置换和申请都可用，和以前接口一样） delete /users/:user_id/orders/:order_id/cancel #### 返回 ``` status 为 'ok' 就行 ``` ### 查看置换订单的申请订单 get /users/:user_id/orders/:order_id/change_orders 有分页 ### 置换订单确认和某个申请订单置换 put /users/:user_id/orders/:order_id/exchange #### 参数 ``` change_order_id: Int 申请订单ID ``` #### 返回 ``` status 为 'ok' 就行 ``` ### 获取商品列表（已经过滤端盒、下架、删除的单品） get /users/goods 有分页 #### 参数 ``` name: '单品名称' 可选 tag_name: '标签名称' 可选 ``` ### 置换或申请订单列表（同赠送、邮寄订单接口） get users/:user_id/orders有分页 #### 参数 ``` status: '' 状态 "wait_confirm", "finish", "cancel" type: '' 类型 'ExchangeOrder' 置换订单, 'ChangeOrder' 申请订单 ``` #### 返回 ``` orders.change_orders_sum 为置换订单下的置换申请订单数量，非置换订单，该值为0 ``` --------------------------------------------- ### 更新 users/:user_id/orders/exchanges #### 添加 tag_id 参数 ## 标签 ### 后台 ### 标签列表 get operations/tags 有分页 #### 参数 ``` name: '' 可选，标签名称 tag_type: '' 可选，标签类型 ``` #### 返回 ``` tags: [] ``` ### 新建标签 post operations/tags #### 参数 ``` name: '' 可选，标签名称 tag_type: '' 可选，标签类型 image_id: 可选，图片ID ``` #### 返回 ``` tag: {} ``` ### 更新标签 put operations/tags/:tag_id #### 参数 ``` name: '' 可选，标签名称 tag_type: '' 可选，标签类型 image_id: 可选，图片ID ``` #### 返回 ``` tag: {} ``` ### 删除标签 delete operations/tags/:tag_id #### 返回 ``` status 为 'ok' 就行 ``` ### 小程序 ### 标签列表 get users/tags 有分页 #### 参数 ``` name: '' 可选，标签名称 tag_type: '' 可选，标签类型，默认 'ip' ``` #### 返回 ``` tags: [] ``` ### 交换大厅搜索 ### 搜索ip标签 GET api/v1/users/tags #### 参数 ``` # name 和 tag_type 只传一个就行，返回类型都为ip name: '' 可选，标签名称 tag_type: '' 可选，标签类型，默认 'ip'，为全部ip标签 ``` #### 返回 ``` tags: [] ``` ### 拉取商品品类信息 GET api/v1/users/goods #### 参数 ``` name: String 必需传（兼容线上版本，线上可不传值），上步搜索的name，用来校验标签类型 tag_id: Integer 必填，上步返回值的ID ``` #### 返回 ``` goods: [] ``` ### 置换列表 GET api/v1/users/orders/exchanges #### 参数 ``` goods_name: String 可选，未点击ip时候，值为搜索框的name，当用户点击了商品品类信息时，值为商品名称 tag_id: Integer 可选，点击ip标签的ID，这两个都不填，就是全部 ``` #### 返回 ``` orders: [] ```