名称

thisshop.order.list.get

功能描述

获取订单列表数据

访问路径

/api/shop/router/rest

格式

json

请求方式

Post

数据格式

//备注：appId、nonce、timestamp、token为公共参数

{
    "appId":"TF10000",
    "nonce":"8ds9a921",
    "timestamp":"1564630934531",
    "token":"46DE554983BA4E41BB59A61FA50CCE",
    "method":"thisshop.order.list.get",
    "data":{
        "orderStatus":8,
        "startCreateTime":"2019-08-01 12:30:22",
        "endCreateTime":"2019-08-02 12:30:22",
        "startPayTime":"",
        "endPayTime":"",
        "startUpdateTime":"",
        "endUpdateTime":"",
        "pageNum":1,
        "pageSize":10
    }
}

返回数据

成功

{
    "transactionStatus":{
        "errorCode":"0",
        "replyCode":null,
        "replyText":null,
        "memo":null,
        "appName":"tft-shop-server",
        "success":true
    },
    "page":{
        "count":1,
        "pageSize":10,
        "pageNum":1,
        "orderBy":null,
        "returnCount":true,
        "offset":0,
        "limit":10
    },
    "result":[
        {
            "orderId":"354619924444397568",
            "orderTitle":"Gigabyte H310M S2H (1151)(1 items)",
            "orderTotalAmount":3940,
            "paymentAmount":0,
            "discountAmount":3940,
            "expressAmount":0,
            "submitTime":"2019-08-02 10:54:00",
            "payTime":"2019-08-02 11:01:36",
            "orderStatus":8,
            "payStatus":4
        }
    ]
}

name

thisshop.order.list.get

Function   description

Get   order list data

access   path

/api/shop/router/rest

Format

json

request   method

Post

Data   Format

//Note:   appId , nonce, timestamp, token are public parameters

{
    "appId":"TF10000",
    "nonce":"8ds9a921",
    "timestamp":"1564630934531",
    "token":"46DE554983BA4E41BB59A61FA50CCE",
    "method":"thisshop.order.list.get",
    "data":{
        "orderStatus":8,
        "startCreateTime":"2019-08-01 12:30:22",
        "endCreateTime":"2019-08-02 12:30:22",
        "startPayTime":"",
        "endPayTime":"",
        "startUpdateTime":"",
        "endUpdateTime":"",
        "pageNum":1,
        "pageSize":10
    }
}

return   data

success

{
    "transactionStatus":{
        "errorCode":"0",
        "replyCode":null,
        "replyText":null,
        "memo":null,
        "appName":"tft-shop-server",
        "success":true
    },
    "page":{
        "count":1,
        "pageSize":10,
        "pageNum":1,
        "orderBy":null,
        "returnCount":true,
        "offset":0,
        "limit":10
    },
    "result":[
        {
            "orderId":"354619924444397568",
            "orderTitle":"Gigabyte H310M S2H (1151)(1 items)",
            "orderTotalAmount":3940,
            "paymentAmount":0,
            "discountAmount":3940,
            "expressAmount":0,
            "submitTime":"2019-08-02 10:54:00",
            "payTime":"2019-08-02 11:01:36",
            "orderStatus":8,
            "payStatus":4
        }
    ]
}

orderStatus

Integer

11

订单状态

N

订单状态（

0：已删除

1：已取消

2：待付款

8：待发货

16：待收货

32：完成）

startCreateTime

String

20

订单创建开始时间

N

yyyy-MM-dd HH:mm:ss

endCreateTime

String

20

订单创建结束时间

N

yyyy-MM-dd HH:mm:ss

startPayTime

String

20

订单支付开始时间

N

yyyy-MM-dd HH:mm:ss

endPayTime

String

20

订单支付结束时间

N

yyyy-MM-dd HH:mm:ss

pageNum

Integer

11

当前页码

N

默认pageNum=1

pageSize

Integer

每页条数

N

默认pageSize=10，最大pageSize=100

startUpdateTime

String

20

更新时间范围开始时间

N

yyyy-MM-dd hh:mm:ss

endUpdateTime

String

20

更新时间范围结束时间

N

yyyy-MM-dd hh:mm:ss

orderStatus

Integer

11

Order Status

N

Order Status(

0: deleted

1: Cancelled

2: Pending payment

8: To be shipped

16: To be received

32: Done)

startCreateTime

String

20

Order creation start   time

N

yyyy -MM-dd HH: mm:ss

endCreateTime

String

20

Order creation end time

N

yyyy -MM-dd HH: mm:ss

startPayTime

String

20

Order payment start   time

N

yyyy -MM-dd HH: mm:ss

endPayTime

String

20

Order payment end time

N

yyyy -MM-dd HH: mm:ss

pageNum

Integer

11

current page number

N

Default pageNum =1

pageSize

Integer

Articles per page

N

Default pageSize = 10, maximum   pageSize = 100

startUpdateTime

String

20

Update time range start time

N

yyyy -MM-dd hh: mm:ss

endUpdateTime

String

20

Update time range end time

N

yyyy -MM-dd hh: mm:ss

transactionStatus

Object

交易响应对象

page

Object

页码对象

result

List

订单列表

errorCode

String

错误标识

0：正确；1：错误

replyCode

String

错误代码

replyText

String

错误信息

memo

String

备注

appName

String

服务名称

success

Boolean

是否成功

true:成功 false:失败

count

Integer

总数量

pageSize

Integer

每页条数

pageNum

Integer

当前页数

orderBy

String

排序字段

预留字段

returnCount

Boolean

是否统计总数量

预留字段

offset

Integer

预留字段

limit

Integer

预留字段

orderId

String

订单编号

orderTitle

String

订单标题

orderTotalAmount

BigDecimal

订单总额

未扣除优惠金额

paymentAmount

BigDecimal

订单实付金额

扣除优惠金额

discountAmount

BigDecimal

优惠金额

expressAmount

BigDecimal

快递费

custId

String

客户编号

submitTime

String

下单时间

yyyy-MM-dd HH:mm:ss

payTime

String

支付时间

yyyy-MM-dd HH:mm:ss

updateTime

String

最后更新时间

yyyy-MM-dd HH:mm:ss

orderStatus

Integer

订单状态

订单状态（

0：已删除

1：已取消

2：待付款

8：待发货

16：待收货

32：完成

64：部分发货））

payStatus

Integer

支付状态

付款状态（

1：待支付

2：支付中

4：支付成功

8：支付失败）

riskType

Integer

风控单类型

风控单类型（

1：无风险单

2：疑似风险单

4：确认风险单

）

补充说明：

A.  无风险单可以正常发货，疑似险单和确认风险单不可以发货；

B.  疑似风险单等平台解除风险后可以发货；

C.  风险订单在获取订单详情时，收货地址为空，保证不会误发货造成损失；

transactionStatus

Object

Transaction response object

page

Object

page number object

result

List

Order List

errorCode

String

error flag

0: correct;

1: incorrect

replyCode

String

error code

replyText

String

error message

memo

String

Remark

appName

String

service name

success

Boolean

whether succeed

true: success

false: failure

count

Integer

The total number

pageSize

Integer

Articles per page

pageNum

Integer

current page number

orderBy

String

Sort field

reserved field

returnCount

Boolean

Whether to count the total number

reserved field

offset

Integer

reserved field

limit

Integer

reserved field

orderId

String

order number

orderTitle

String

order title

orderTotalAmount

BigDecimal

total order

Discount amount not deducted

paymentAmount

BigDecimal

Order paid amount

Deduct the discount amount

discountAmount

BigDecimal

Discounted price

expressAmount

BigDecimal

courier fee

custId

String

customer number

submitTime

String

order time

yyyy -MM-dd HH: mm:ss

payTime

String

Payment time

yyyy -MM-dd HH: mm:ss

updateTime

String

Last update time

yyyy -MM-dd HH: mm:ss

orderStatus

Integer

Order Status

Order Status(

0: deleted

1: Cancelled

2: Pending payment

8: To be shipped

16: To be received

32: Done

64: Partially shipped))

payStatus

Integer

Payment status

payment status(

1: To be paid

2: Paying

4: Payment is successful

8: Payment failed)

riskType

Integer

Type of risk control sheet

risk   control sheet (

1:   Risk-free single

2:   Suspected Risk List

4:   Confirm the risk list

)

Additional   instructions:

D.  Risk-free orders can be shipped normally, but suspected insurance   orders and confirmed risk orders cannot be shipped;

E.  Suspected risk orders and other platforms can be shipped after the   risk is removed;

F.  When obtaining the order details for a risk order, the delivery   address is empty to ensure that there will be no losses caused by wrong   delivery;