查询订单列表 - 客如云 API

(下行接口)导出订单-推荐使用

注: 建议使用支付时间(timeType 取2)查询,结果更准确

curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/data/order/export2?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign=' \ --header 'Content-Type: application/json' \ --data-raw '{ "shopIdenty":810002790, "startTime":1499147465983, "endTime":1499147465983 }'

{ "code": 0, "message": "OK", "messageUuid": "3b4cce269b0d45a3a2a783e91bed26123", "result": { "totalRows": 360, "pageSize": 200, "items": [ { "orderId": 7512460, "tradeType": 1, "tradeStatus": 4, "tradeNo": "101170114084238432534", "orderTime": 1476433277000, "checkOutTime": 1476374400000, "source": 1, "sourceName": "ANDROID收银终端", "receivedAmount": 19300, "custRealPay": 19300, "tradeAmount": 0, "privilegeAmount": 0 } ] } }

请求参数

Query 参数

appKey

string

必需

开发者申请服务客如云分配的appKey

默认值:

shopIdenty

string

必需

客如云门店id （门店维度接口传递门店ID）

默认值:

brandId

string

必需

客如云品牌id（品牌授权的接口传递品牌ID）

默认值:

version

string

必需

版本,默认2.0（1.0版本仍可用）

默认值:

2.0

timestamp

string

必需

时间戳,单位:秒,时间戳校验签名,开放平台校验签名时用此参数和服务器当前时间戳对比不能大于300秒，我方服务器使用阿里云授时中心

默认值:

sign

string

必需

签名，64位长度的字符串，获取规则详见签名规则

默认值:

Body 参数application/json

shopIdenty

integer

客如云门店ID

必需

startTime

integer

必需

endTime

integer

必需

source

array[integer]

可选

订单来源：1:ANDROID收银终端；2:IPAD自助终端；3:ipad收银终端；31:微信官微；32:微信商微；33:微信快捷支付；41:百度外卖；51:百度直达号；61:百度糯米点菜；71:百度地图；81:呼叫中心；91:必胜客自助；92:味千；111:商户官网；131:loyal；141:OnMobile 客如云；142: onmobile os；151:熟客；161:饿了么；171:点评正餐；181:美团外卖菜；191:安卓自助

field87

string

必需

开始时间，timeType=1此字段代表营业日;timeType=2代表订单支付时间；注：时间单位为毫秒，只支持最近7天数据查询

field88

string

必需

结束时间；timeType=1此字段代表营业日；timeType=2代表订单支付时间；；注：时间单位为毫秒，只支持最近7天数据查询

timeType

integer

可选

页码；从1开始；不传默认为1类型；默认下单时间；1-下单时间；2-支付时间；推荐使用支付时间(返回值当中的checkOutTime)作为分页参数，这样会降低查询靠近当前时间的订单的丢单几率

pageNo

integer

必需

页码；从1开始；不传默认为1

pageSize

integer

必需

每页条数；取值范围10~100,不传默认100

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

messageUuid

string

必需

result

object (Pager)

必需

totalRows

integer

总记录数

必需

pageSize

integer

每页最大记录数

可选

items

array[object (OpenOrderExportVo) {12}]

必需

返回记录明细；详见OpenOrderExportVo