## 获取单条订单信息(orderRead)
>[info] 场景说明:获取已创建的订单的详细信息,只有当前登录用户是该订单的买家或卖家时才能返回数据
### 是否需要获取用户TOKEN
`是`
*****
### 请求地址
```
POST http://api.xxx.com/order/read
```
### 公共请求参数
| 字段 | 类型 | 是否必填 | 描述 |
| --- | --- | --- | --- |
| appid | string | 必须 | 平台提供的唯一APPID |
| version | string | 必须 | 接口版本号,固定填:v3 |
| sign\_type | string | 必须 | 签名类型,目前只支持md5 |
| timestamp | string | 必须 | 发起时间戳,格式为:yyyy-mm-dd hh::ii::ss |
| format | string | 必须 | 返回的数据格式,只支持json |
| sign | string | 必须 | 请求参数的签名,请参考:[签名规则](signature.md) |
| token | string | 必须 | 用户TOKEN |
| params | string | 必须 | 请求参数的集合,除公共参数外,所有请求参数都必须放在这个参数中传递,json\_encode后送入 |
应用请求参数`params`格式
| 字段 | 类型 | 是否必填 | 描述 |
| --- | --- | --- | --- |
| order\_id | integer | 可选 | 订单ID,订单ID和订单编号二者必传其一 |
| order\_sn | string | 可选 | 订单编号,订单ID和订单编号二者必传其一 |
### 请求示例
```
{
"appid": "您的APPID",
"version": "v3",
"sign_type": "md5",
"timestamp": "2020-8-10 12:00:00",
"format": "json",
"sign": "op0987yhjmngt54rtg2wgdfvcder2765",
"params": {
"order_id": 3
}
}
```
*****
### 公共返回参数
| 字段 | 类型 | 是否必填 | 描述 |
| --- | --- | --- | --- |
| code | integer | 必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) |
| message | string | 必须 | 请求成功/失败的描述信息 |
| data | array | 必须 | 返回结果,如果没有指定用返回空 |
返回`data`参数格式
| 字段 | 类型 | 是否必填 | 描述 |
| --- | --- | --- | --- |
| order\_id | integer | 必须 | 订单ID |
| order\_sn | string | 必须 | 订单编号 |
| gtype | string | 必须 | 商品类型,目前只有值="material" 代表实物商品 |
| otype | string | 必须 | 订单类型,取值:"normal"=普通购物订单、"meal"=搭配购订单、"teambuy"=拼团订单、"guidebuy"=社区团购订单 |
| tradeNo | string | 必须 | 交易号 |
| bizOrderId | string | 必须 | 商户订单号,该值等于order\_sn |
| bizIdentity | string | 必须 | 订单业务类型,这里为值:trade10001,取值参考:[订单业务类型代码](order-code.md) |
| refund\_sn | string | 可选 | 退款编号,该订单有退款的情况下有值 |
| refund\_status | string | 可选 | 退款状态,取值请参考:[退款状态码](response-code.md) |
| buyer\_id | integer | 必须 | 买家ID |
| buyer\_name | string | 必须 | 买家用户名 |
| seller\_id | integer | 必须 | 卖家ID |
| seller\_name | string | 必须 | 卖家用户名 |
| order\_amount | decimal | 必须 | 订单总金额 |
| goods\_amount | decimal | 必须 | 订单商品总额(不含运费) |
| shipping\_fee | decimal | 必须 | 运费金额 |
| status | integer | 必须 | 订单状态,状态值参考:[订单状态码](response-code.md) |
| evaluation\_status | integer | 必须 | 评价状态,1=已评价、0=未评价 |
| payment\_code | string | 必须 | 支付方式代码,具体参考:[支付方式代码](payment-code.md) |
| payment\_name | string | 必须 | 支付方式名称,具体参考:[支付方式代码](payment-code.md) |
| express\_no | string | 可选 | 快递单号,发货之后才会有该值 |
| express\_company | string | 可选 | 快递公司名称 |
| postscript | string | 可选 | 买家下单留言 |
| memo | string | 可选 | 卖家订单备注 |
| add\_time | string | 必须 | 订单提交时间,格式:yyyy-mm-dd hh:ii:ss |
| pay\_time | string | 可选 | 订单付款时间,格式同上 |
| ship\_time | string | 可选 | 订单发货时间 |
| finished\_time | string | 可选 | 订单完成时间 |
| evaluation\_time | string | 可选 | 买家评价订单时间 |
### 返回数据示例
```
{
"code": 0,
"message": "成功",
"data": {
"order_id":3,
"order_sn":"15990694324571092",
"gtype":"material",
"otype":"normal",
"tradeNo": "20200911105418341468",
"bizOrderId": "15990694324571092",
"bizIdentity": "trade10001",
"buyer_id":2,
"buyer_name":"buyer",
"seller_id":2,
"seller_name":"演示店铺",
"order_amount": 399.99,
"goods_amount": 389.99,
"shipping_fee": 10.00,
"status":30,
"evaluation_status":0,
"payment_code": "alipay",
"payment_name": "支付宝",
"express_no": "YT9098987654",
"express_company": "圆通速递",
"postscript": "老板,记得包装好一点",
"memo": "湖南的老客户",
"add_time": "2020-8-2 12:45:39",
"pay_time": "2020-8-2 12:50:20",
"ship_time" "2020-8-2 18:23:45",
"finished_time": "",
"evaluation_time": ""
}
}
```
- 系统概述
- 签名与验签
- 签名规则
- 获取访问TOKEN
- 手机密码登录换取用户TOKEN
- 手机验证码登录换取用户TOKEN
- 微信/QQ/支付宝登录换取用户TOKEN
- H5端微信/支付宝登录换取授权CODE
- 用户API
- 获取用户列表
- 获取单条用户信息
- 更新用户信息
- 修改用户手机号
- 获取用户资产信息
- 修改资金账户支付密码
- 用户绑定微信/QQ账号
- 用户解绑微信/QQ账号
- 商品类目API
- 获取商品分类列表
- 获取单条商品分类信息
- 商品API
- 获取商品列表
- 搜索商品数据(多条件)
- 获取单条商品信息
- 获取商品描述信息
- 获取商品SKU列表
- 获取商品SKU单条信息
- 获取商品SKU价格信息
- 获取商品上下架信息
- 获取商品相册图片列表
- 获取商品相册单张图片信息
- 获取单个商品的属性集合信息
- 获取商品的默认物流配送资费
- 获取单个商品销售记录列表
- 获取单个商品评价记录列表
- 获取单个商品咨询记录列表
- 用户插入商品咨询
- 用户收藏商品/取消收藏
- 获取我收藏的商品列表
- 获取我收藏的商品的数量
- 品牌API
- 获取品牌列表
- 获取单条品牌信息
- 店铺类目API
- 获取店铺分类列表
- 获取单条店铺分类信息
- 店铺API
- 获取店铺列表
- 获取单条店铺信息
- 获取店铺动态评分
- 获取店铺轮播图
- 获取店铺等级列表
- 获取单条店铺等级信息
- 获取我收藏的店铺列表
- 获取我收藏的店铺的数量
- 获取店铺满优惠信息
- 获取店铺满包邮信息
- 用户收藏店铺/取消收藏
- 用户申请开店
- 商家修改店铺信息
- 地区API
- 获取地区列表
- 获取单条地区信息
- 收货地址API
- 获取收货地址列表
- 获取单条收货地址信息
- 新增收货地址
- 更新收货地址信息
- 删除收货地址
- 购物车API
- 获取购物车商品数据
- 选择购物车商品结算
- 插入单个商品到购物车
- 批量插入商品到购物车
- 更新购物车商品
- 移除购物车商品
- 删除整个购物车
- 订单API
- 获取单条订单信息
- 获取单条订单商品数据
- 获取单条订单收货人信息
- 获取单条订单物流跟踪信息
- 获取预提交订单数据集合
- 提交预支付购物订单
- 更新购物订单状态
- 获取卖家管理的订单列表
- 获取卖家订单管理提醒
- 获取我的订单提醒数据
- 获取我购买的订单列表
- 获取我的订单评价列表
- 提交我的订单评价
- 获取卖家管理的订单评价列表
- 卖家提交评价回复
- 物流API
- 获取快递公司列表
- 收银台API
- 获取预支付交易数据集合
- 提交预支付交易订单
- 微信公众号授权回调发起支付
- 查询支付交易状态
- 交易API
- 获取交易记录列表
- 获取单条交易记录
- 获取收支记录列表
- 获取单条收支记录
- 站内余额提现至银行卡
- 支付宝微信等充值到余额
- 获取银行卡列表
- 绑定提现银行卡
- 删除提现银行卡
- 获取银行卡数量
- 退款API
- 创建退款申请
- 查看退款记录
- 修改退款申请
- 取消退款申请
- 卖家同意退款申请
- 卖家拒绝退款申请
- 获取我的退款列表
- 获取卖家管理的退款列表
- 获取退款协商留言记录
- 提交退款协商留言
- 申请平台介入退款争议
- 优惠券API
- 获取可领取的优惠券
- 获取单条优惠券信息
- 用户点击领取优惠券
- 获取我的优惠券列表
- 获取我的优惠券数量
- 积分API
- 获取积分商品列表
- 获取积分用户列表
- 获取我的积分账户信息
- 获取我的积分记录列表
- 用户每日签到领积分
- 充值卡API
- 获取我的充值卡列表
- 绑定/激活充值卡
- 拼团API
- 获取拼团活动列表
- 获取拼团活动单条信息
- 获取拼团商品参团记录
- 秒杀API
- 获取秒杀商品列表
- 获取秒杀商品单条信息
- 搭配购API
- 获取搭配购列表
- 获取搭配购单条信息
- 满优惠API
- 获取满优惠信息
- 设置满优惠信息
- 满包邮API
- 获取满包邮信息
- 设置满包邮信息
- 短信服务API
- 发送一条短信
- 图片上传API
- 上传图片到服务器
- 上传图片到数据库
- 状态码表
- 公共状态码
- 上传文件代码
- 支付方式代码
- 商户业务类型代码
- 银行代码表