客如云 API
  1. 订单信息
客如云 API
  • 平台简介
  • 对接流程-API接口对接流程及操作步骤(不上架服务市场)
  • 对接流程-API接口对接流程及操作步骤(上架服务市场)
  • 认证指南-服务商认证
  • 认证指南-品牌商认证
  • 接口能力大图
  • https对接说明
  • 接口请求公共参数
  • 响应参数
  • V2签名规则
  • 订单取消原因表
  • 订单状态
  • 错误码
  • 订单配送状态
  • 订单支付状态表
  • 回调接口编码
  • 支付机构代码
  • 接收菜品分类变更通知
  • 接收菜品变更通知
  • 订单状态推送通知收费
  • 自配送场景介绍
  • 客如云下发配送通知
  • 订单配送状态通知
  • 优惠券核销通知接口-上行
  • 第三方券核销介绍
  • 登录成功回调收费
  • 获取授权码code收费
  • 新手指南
    • 平台简介
    • 对接流程-API接口对接流程及操作步骤(不上架服务市场)
    • 对接流程-API接口对接流程及操作步骤(上架服务市场)
    • 认证指南-服务商认证
    • 认证指南-品牌商认证
  • 接口能力大图
    • 接口能力大图
  • 公共说明
    • https对接说明
    • 接口请求公共参数
    • 响应参数
    • V2签名规则
    • 附录
      • 订单取消原因表
      • 订单状态
      • 错误码
      • 订单配送状态
      • 订单支付状态表
      • 回调接口编码
      • 支付机构代码
    • 获取门店token
  • 接口列表
    • 门店信息
      • 获取服务下可用门店
      • 获取门店列表
      • 获取门店信息
      • 获取门店经营时间
      • 查询门店营业状态
      • 修改门店营业状态
      • 查询桌台信息
      • 附加费配置查询接口
      • 支付类型查询
      • 门店设备列表查询接口
      • 门店设备状态推送接口
    • 菜品
      • 接收菜品分类变更通知
      • 接收菜品变更通知
      • 菜品分类信息查询
      • 菜品父级信息查询
      • 菜品分类查询
      • 菜品分页查询
      • 菜品精确查询
      • 批量修改门店菜品售卖数量
    • 订单信息
      • 订单状态推送通知收费
      • 查询订单详情
        POST
      • 查询订单列表
        POST
    • 后厨管理服务
      • 后厨菜品制作状态变更推送
    • 配送服务
      • 自配送场景介绍
      • 客如云下发配送通知
      • 订单配送状态通知
      • 商家自配送状态推送
    • 会员1.0
      • 会员基本信息1.0
        • 创建顾客
        • 创建/升级会员
        • 查询会员实体卡列表
        • 会员详情查询
        • 修改会员详情
        • 查询品牌下会员等级
        • 修改会员等级信息
      • 会员登录1.0
        • 会员登录
        • 会员登录二维码
        • 获取免登录token
      • 会员充值1.0
        • 会员充值接口
        • 查询门店储值消费金额
        • 会员充值/消费记录查询
      • 积分 1.0
        • 会员积分增加
        • 会员积分扣减
    • 优惠券1.0
      • 优惠券核销通知接口-上行
      • 查询优惠券列表
      • 查询券模板列表
      • 查询优惠券详情
      • 查询门店营销规则
      • 券模板发券接口
      • 客如云券核销
    • 第三方券核销
      • 第三方券核销介绍
      • 券查询
      • 券核销
      • 券反核销
    • 供应链1.0
      • 供应链基础数据1.0
        • 查询供应链物品接口
        • 查询仓库列表
        • 查询物品分类
        • 查询供应链物品库存
        • 查询商品库存收费
        • 接收商品库存变更
        • 查询供应商类别
        • 查询供应商列表
        • 查询交易记录
        • 获取交易凭证
        • 查询商户余额
      • 采购单据1.0
        • 查询采购入库单列表
        • 查询采购订单收费
        • 查询采购入库单明细
        • 查询采购退货单明细
        • 采购退货单列表收费
      • 销售单据1.0
        • 查询非销售单出库明细收费
      • 库存单据1.0
        • 入库单保存
        • 入库详情查询
        • 入库分页查询
        • 收货单详情
        • 收货单分页查询
        • 调拨单详情查询
        • 调拨单分页查询
        • 出库单保存
        • 出库详情查询
        • 出库分页查询
        • 配送签收单修改保存
        • 查询配送签收单详情
        • 配送签收单分页查询
        • 退回单详情查询
        • 退回单分页查询
        • 退回入库单分页查询
        • 退回入库单详情查询
        • 盘点单详情查询
        • 盘点单分页查询
        • 报废单详情查询收费
        • 报废单分页查询
    • 支付收银服务
      • 支付状态查询
      • 扫码支付(主扫)
      • 扫码支付(被扫)
      • 退款状态查询
      • 退款申请
    • OAUTH 授权服务
      • 登录成功回调收费
      • 获取授权码code收费
      • 获取用户信息
      • 获取token
  1. 订单信息

查询订单列表

测试环境
https://gldopenapi.keruyun.com
测试环境
https://gldopenapi.keruyun.com
POST
/open/v1/data/order/export2
(下行接口)导出订单-推荐使用
注: 建议使用支付时间(timeType 取2)查询,结果更准确
请求示例请求示例
Shell
JavaScript
Java
Swift
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
默认值:
{{appKey}}
shopIdenty
string 
必需
客如云门店id (门店维度接口传递门店ID)
默认值:
{{shopIdenty}}
brandId
string 
必需
客如云品牌id(品牌授权的接口传递品牌ID)
默认值:
{{brandId}}
version
string 
必需
版本,默认2.0(1.0版本仍可用)
默认值:
2.0
timestamp
string 
必需
时间戳,单位:秒,时间戳校验签名,开放平台校验签名时用此参数和服务器当前时间戳对比不能大于300秒,我方服务器使用阿里云授时中心
默认值:
{{timestamp}}
sign
string 
必需
签名,64位长度的字符串,获取规则详见签名规则
默认值:
{{sign}}
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

【如客云】API开发者 微信交流群

用微信扫右侧二维码,加入【如客云】API开发者 交流群,互助沟通

扫码加入交流群
上一页
查询订单详情
下一页
后厨菜品制作状态变更推送
Built with