## 获取单条订单信息(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": "" } } ```