ttj1314 / API-Interfaces · Commits

Go to a project

Authored by LUOXC
Commit d91256f0527e0f01dd27dee12018883727a798b8 1 parent 758278ab

update

Inline Side-by-side
Showing 1 changed file with 69 additions and 80 deletions
# 订单服务接口
## 接口列表
| 接口名称 | 接口描述 |
| --------| -------- |
|[订单列表](#1)||
|[订单详情](#2)||
|[取消订单](#3)||
|[删除订单](#4)||
|[确认订单](#5)||
|[获取电子票列表](#6)||
|[获取YOHO赠品](#7-yoho)||
|[购物车列表](#8)||
|[获取待处理订单总数](#9)||
|[历史订单列表](#10)||
## 1、订单列表
### 接口说明
## 接口描述
| 接口说明 | 接口说明 |
| :-- | -----: |
| 请求域名 | http://api.yoho.cn/ |
| 接口名 | app.SpaceOrders.get |
| 接口说明 | 获取用户订单列表 |
| http请求方式 | GET/POST |
### 1、订单列表
### 请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 |
| :-- | :-- | :-- | :--| :-- | :-- |
| method | string | 是 | app.SpaceOrders.get |||
| uid | int | 是 | 5772257 |||
| type | int | 是 | 1 || 订单类型 1:全部订单,2:待付款,3:待发货,4:待收货,5:待评论/成功订单,7:失败/取消 |
| page | int | 否 | 1 | 1 | 页数 |
| limit | int | 否 | 10 | 10 | 每页大小 |
#### 说明
订单列表
#### 请求参数
| Param Name | Param Type | Required | Param Value | Desc |
| :-- | --: | --: | --: | --: |
| method | string | true | app.SpaceOrders.get| 请求方法 不可变 |
| uid | int | true | 1 | |
| type | int | true | 1 | 订单类型 1:全部订单,2:待付款,3:待发货,4:待收货,5:待评论/成功订单,7:失败/取消 |
| page | int | false | 1 | 页数 |
| limit | int | false | 10 | 每页大小 |
#### 响应内容
### 正常返回结果
```json
{
"code": 200,
... ... @@ -41,41 +31,68 @@
"id": "5528982",
"order_code": "1519273880",
"parent_order_code": "0",
// 订单类型 1:有货,3:iphone,4:android,5:淘宝,6:h5,7:是换货,9:渠道,20:ipad
"order_type": 1,
// 退货状态（该字段已经废弃了）0:正常订单,1:退货审核中,2:退货审核不通过,3:退货审核通过,4:退货商品寄回,5:退货库房入库,6:财务退款,7:完成
"refund_status": 0,
"uid": "5772257",
// 创建时间
"create_time": "1449633428",
// 更新时间
"update_time": "1449633455",
// 支付超期时间
"pay_expire": "2015-12-09 13:57:08",
// 支付方式编号
"payment": "2",
// 支付状态 Y:已支付,N:未支付
"payment_status": "Y",
// 支付方式 1:在线支付,2:货到付款,3:现金支付,4:抵消支付
"payment_type": "1",
"payment_type_str": "在线支付",
// 状态 0:待付款,1-3:待发货,4-5:待收货(0:未付款,1:已付款,2:备货中,3:配货中,4:已发货,5:运输中,6:已完成)
"status": 1,
// 状态名称
"status_str": "已付款",
"attribute": "5",
// 是否取消 Y:已取消,N:未取消
"is_cancel": "N",
// 是否评论 Y:已评论,N:未评论
"is_comment": "N",
// 订单金额
"amount": "1.00",
// 运费
"shipping_cost": "0.00",
// 使用限购码 Y:使用,N:未使用
"use_limit_code": "N",
// 用户确认支付 Y:是,N:否
"user_confirm_paid": "N",
// 购买商品数量
"buy_total": 1,
// 购买商品
"order_goods": [
{
// 购买商品数量
"buy_number": 1,
"goods_id": 125106,
// 商品默认图片
"goods_image": "http://img10.static.yhbimg.com/goodsimg/2014/06/19/02/0118c2721e4f2219f69539dd389f4bacac.jpg?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
"goods_price": "1.00",
// 商品价格
"goods_price": "1.00",
// 商品类型 ordinary:普通商品
"goods_type": "ordinary",
// 商品总价格
"goods_amount": "1.00",
"product_id": 84230,
"product_name": "004 满版龙纹迷彩七分休闲裤",
"cn_alphabet": "004QiFenBuKu004PA095",
"product_skn": 51055461,
// 退货数量
"refund_num": 0,
"size_name": "M",
// 商品颜色
"color_name": "彩色",
"cn_alphabet": "004QiFenBuKu004PA095",
// 商品尺寸
"size_name": "M",
// 预期到货时间
"expect_arrival_time": ""
}
]
... ... @@ -88,55 +105,27 @@
"message": "ok"
}
```
##### 响应内容描述
| Param Name | Param Type | Desc |
| ---------- | ---------- | ---- |
| page | int | 当前页数 |
| page_total | int | 总页数 |
| total | int | 总记录数 |
| order_list | json | 订单列表 |
| id | string | |
| order_code | string | |
| parent_order_code | string | |
| order_type | int | 订单类型 1:有货,3:iphone,4:android,5:淘宝,6:h5,7:是换货,9:渠道,20:ipad |
| refund_status | int | 退货状态（该字段基本不用了）0:正常订单,1:退货审核中,2:退货审核不通过,3:退货审核通过,4:退货商品寄回,5:退货库房入库,6:财务退款,7:完成 |
| uid | string | |
| create_time| string | 创建时间 |
| update_time| string | 更新时间 |
| pay_expire | string | 支付超期时间 |
| payment | string | 支付方式编号 |
| payment_status | string | 支付状态 Y:已支付,N:未支付 |
| payment_type | string | 支付方式 1:在线支付,2:货到付款,3:现金支付,4:抵消支付 |
| status | int | 状态 0:待付款,1-3:待发货,4-5:待收货(0:未付款,1:已付款,2:备货中,3:配货中,4:已发货,5:运输中,6:已完成)|
| status_str | string | 状态名称 |
| is_cancel | string | 是否取消 Y:已取消,N:未取消 |
| is_comment | string | 是否评论 Y:已评论,N:未评论 |
| amount | string | 订单金额 |
| shipping_cost | string | 运费 |
| use_limit_code | string | 使用限购码 Y:使用,N:未使用 |
| user_confirm_paid| string | 用户确认支付 Y:是,N:否 |
| buy_total | int | 购买商品数量 |
| order_goods| json | 购买商品 |
| buy_number | int | 购买商品数量 |
| goods_id | int | |
| goods_image| string | 商品默认图片 |
| goods_price| string | 商品价格 |
| goods_type | string | 商品类型 ordinary:普通商品 |
| goods_amount | string | 商品总价格 |
| product_id | int | |
| product_name | string | 商品名称 |
| product_skn| int | 商品skn |
| refund_num | int | 退货数量 |
| size_name | string | 商品尺寸 |
| color_name | string | 商品颜色 |
| cn_alphabet| string | |
| expect_arrival_time | string | 预期到货时间 |
## 2、订单详情
#### 正确响应内容
### 2、订单详情
### 接口说明
| 接口说明 | 接口说明 |
| :-- | -----: |
| 请求域名 | http://api.yoho.cn/ |
| 接口名 | app.SpaceOrders.detail |
| 接口说明 | 订单详情 |
| http请求方式 | GET/POST |
### 请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 |
| :-- | :-- | :-- | :--| :-- | :-- |
| method | string | 是 | app.SpaceOrders.detail |||
| uid | int | 是 | 5772257 |||
| order_code | int | 是 | 1519273880 || 订单号 |
#### 正常返回结果
```json
{
"alg": "SALT_MD5",
... ... @@ -277,7 +266,7 @@
| method | app.SpaceOrders.close| 请求方法 |
| order_code | 1061003682 | 订单号 |
#### 响应内容
#### 正常返回结果
```json
{
"code":200,
... ...