查询订单详情 - 客如云 API

(下行接口)客如云批量修改门店菜品信息

响应参数

参数名	类型	是否必填	参数描述
code	Int	是	返回编码，详见错误码
message	String	是	返回信息
messageUuid	String	是	消息uuid
result	List	否	返回响应数据，json对象或数组，可空

OpenOrderExportDetailVO

参数名	类型	是否必填	参数描述
baseInfo	BaseInfo	是	基本信息
deliveryInfo	DeliveryInfo	否	配送信息
dishInfos	List<DishInfo>	否	菜品信息
extraCharges	List<ExtraCharge>	否	附加金额
orderInfo	OrderInfo	否	订单结算信息
payInfos	List<PayInfo>	否	支付信息
privilegeInfos	List<PrivilegeInfo>	否	优惠信息
tableInfos	List<TableInfo>	否	桌台信息
tradeCustomerInfos	List<TradeCustomerInfo>	否	会员信息
tradePlanActivities	List<TradePlanActivity>	否	活动信息

BaseInfo

参数名	类型	是否必填	参数描述
id	Long	否	订单Id
tradeNo	String	否	订单编号，门店下唯一
shopId	Long	否	门店ID
shopName	String	否	门店名称
sourceName	String	否	订单来源
sourceChild	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:安卓自助;)
deliverType	Integer	否	就餐类型(1:内用;2:外送;3:自提;4:外带;15:未知的类型(如无单收银))
paymentTime	Long	否	支付时间
createTime	Long	否	下单时间
tradePayStatus	Integer	否	支付状态(1:未支付;2:支付中;3:已支付;4:退款中;5:已退款;6:退款失败;7:预支付;8:等待退款;9:支付失败;)
tradeStatus	Integer	否	订单状态(1:未处理;2:挂单;3:已确认;4:已完成(全部支付);5:已退货;6:已作废;7:已拒绝;8:已取消;10:已反结账;)
peopleCnt	Integer	否	就餐人数
casherName	String	否	操作人
relateTradeId	Long	否	原单id,(如：退款单对应的原订单ID)
thirdServiceCharge	BigDecimal	否	服务费
thirdSubsidies	BigDecimal	否	补贴
reasonInfo	String	否	订单理由
serialNumber	String	否	序列号
numberPlate	String	否	号牌
pickUpNumber	String	否	自定义取餐号
tpOrderId	String	否	第三方订单号
tpSerialNumber	String	否	第三方流水号
businessType	Integer	否	业务编码
businessTypeName	String	否	业务名称
deviceInfo	String	否	设备信息
tradeMemo	String	否	订单备注
creatorName	String	否	创单人

DeliveryInfo

参数名	类型	是否必填	参数描述述
deliveryAddress	String	否	地址
deliveryPlatformName	String	否	配送方
deliveryStatus	Integer	否	配送状态(0:默认，等待送餐;1:正在配送;2:送餐完成;3:已清账;4:取消配送;)
receiverName	String	否	收货人
receiverPhone	String	否	收货人电话
deliverFee	BigDecimal	否	配送费
expectTime	String	否	期望配送时间

DishInfo

参数名	类型	是否必填	参数描述
dishCode	String	是	菜品编码
uuid	String	是	菜品uuid
dishId	String	是	菜品ID
dishName	String	是	菜品名称
price	BigDecimal	是	单价
quantity	BigDecimal	是	数量
unitName	String	是	单位
amount	BigDecimal	是	总额
dishProperties	List<DishProperty>	否	商品规格属性列表
dishCookingWay	List<DishCookingWay>	否	做法
childNodes	List<ChildNode>	否	套餐子菜
itemId	String	是	菜品项目id
addDishWaiter	String	否	加菜人
giveDishWaiter	String	否	赠菜人

DishProperty

参数名	类型	是否必填	参数描述
type	int	否	规格固定444
dishPropertyName	String	否	商品规格名称

DishCookingWay

参数名	类型	是否必填	参数描述
dishCookingWayName	String	否	制作方式名称
price	Integer	否	单价
quantity	BigDecimal	否	数量
amount	BigDecimal	否	金额

childNodes

参数名	类型	是否必填	参数描述
dishId	String	是	菜品ID
dishCode	String	是	菜品编码
uuid	String	是	菜品uuid
dishName	String	是	菜品名称
price	BigDecimal	是	单价
quantity	BigDecimal	是	数量
unit	String	是	单位
amount	BigDecimal	是	总额
itemId	String	是	菜品项目id
dishProperties	List<DishProperty>	否	商品规格属性列表
childNodes	List<ChildNode>	否	子菜加料

ExtraCharge

参数名	类型	是否必填	参数描述
amount	BigDecimal	是	金额
name	String	否	名称
privilegeAmount	BigDecimal	否	单价

OrderInfo

参数名	类型	是否必填	参数描述
dishTotalAmount	BigDecimal	否	商品总额
extrachargeTotal	BigDecimal	否	附加金额
privilegesTotal	BigDecimal	否	优惠金额
overFlowAmt	BigDecimal	否	四舍五入
molinAmount	BigDecimal	否	抹零金额
tradeOverFlow	BigDecimal	否	溢收金额
custShouldPay	BigDecimal	否	应付金额
custActualPay	BigDecimal	否	顾客实付
originAmount	BigDecimal	否	订单原价

PayInfo

参数名	类型	是否必填	参数描述
paymentItemId	Long	是	支付条目ID
payTranNo	String	是	交易号
payModelId	Long	是	支付方式: -1:会员卡余额,-2:优惠券,-3:现金,-4:银行卡,-5:微信支付,-6:支付宝,-7:百度钱包,-11:银联刷卡,13:百度外卖,-15:实体卡支付,-20:临时卡余额,-22:第三方C端,-23:美团闪惠,-24:美团团购卷,-25:钱包生活,-26:百度糯米团购券,-27:乐富支付 ,-29:金诚app,-30金诚充值卡,-31:支付通支付,-32:工行银行卡支付,-33:钱包生活银行卡支付,-34:锴乐,-35:京东到家C端,-36:口碑团购券,-37:银联银闪付,-38:工行e支付,-39:美大点餐,-40:移动支付,-41:口碑点餐,-42:预支付抵扣,-43:滴滴外卖,-44:招行支付,-45:容易网团购券,-46:微盟云团购券,-47:万科团购券,-48:招行一卡通,-49:饿百零售,-50:饿了么验券,-51:UP+支付,-52:饿了么企业支付,-101:电信翼支付,-102:龙支付,-103:合利宝,-104:澳门中银,-105:澳门通钱包,-106:丰付宝,-107:广发钱包，-108:美团闪购,-109:江苏银行e融支付,-110:极易付备注：<-10000是开放平台的自定义支付
payModeName	String	否	支付名称
custActualPay	BigDecimal	否	支付金额
shopActualAmount	BigDecimal	否	商户实收
payType	Integer	否	支付模式1:手机网页，2:主扫，3:被扫，4:快捷支付(3-22迭代后废弃),5:app支付’,10: 支付宝刷脸支付
paySource	Integer	否	支付来源，1：Cashier 2：Kiosk 3：百度外卖 4：百度糯米 5：百度地图 6： Loyal（短信储值） 7：OnMobile 8：快捷支付 9：熟客 10：portal 11:饿了么 12:大众点评 13：loyal后台 14：美团外卖 15:微信’
payStatus	Integer	否	支付状态,1未支付,2支付中,3已支付,4退款中,5已退款,6退款失败,7预支付,8等待退款,9支付失败
payStartTime	Long	否	支付开始时间
payChannel	Integer	否	结算方, 1:客如云，2:中信银行（威富通），3:支付宝，4:财付通，5:百度钱包，6:新美大，7:饿了么，8:百度糯米，9:百度外卖，10:通联，11: 商户’
cashierBusinessNo	String	是	收银台checkout交易号

PrivilegeInfo

参数名	类型	是否必填	参数描述
privilegeAmount	BigDecimal	否	优惠金额
privilegeValue	String	否	优惠内容
typeDetailName	String	否	优惠细项
typeName	String	否	优惠类别
promoId	Long	否	优惠券id
couponId	Long	否	优惠券模板ID

TableInfo

参数名	类型	是否必填	参数描述
creatorName	String	否	服务员
tableInfo	String	否	桌台号
tableId	String	否	桌台ID

TradeCustomerInfo

参数名	类型	是否必填	参数描述
customerType	Integer	是	来客类型-1:顾客,1:预定顾客,2:登陆的会员,3:登陆实体卡,4:订单归属人
customerId	Long	是	顾客ID
customerName	String	否	顾客昵称
customerSex	Integer	否	性别-1:未知,0:女,1:男
memberId	Long	是	会员标识ID
entitycardNum	String	否	实体卡号

TradePlanActivity

参数名	类型	是否必填	参数描述
ruleId	String	是	活动ID
ruleName	String	是	活动名称

curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/data/order/exportDetail?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign=' \ --header 'Content-Type: application/json' \ --data-raw '{ "shopIdenty":810002790, "ids":[810002,810003] }'

{ "result": [ { "baseInfo": { "tradeNo": "101191230131237779143212", "shopId": 810090162, "shopName": "体验区测试品牌01stor", "sourceName": "Android收银终端", "sourceChild": 1, "deliverType": 1, "paymentTime": 1577682829, "createTime": 1577682758, "tradePayStatus": 3, "tradeStatus": 4, "peopleCnt": 4, "casherName": "小小", "relateTradeId": null, "thirdServiceCharge": 0, "thirdSubsidies": 0, "reasonInfo": null, "serialNumber": "27", "numberPlate": null, "businessType": 2, "businessTypeName": "正餐", "deviceInfo": "c8:94:bb:03:3e:92", "id": 308229159948978200, "tradeMemo": "不要香菜" }, "payInfos": [ { "paymentItemId": 308229458604394500, "payTranNo": "", "payModelId": -3, "payModeName": "现金", "custActualPay": 2300, "shopActualAmount": 2300, "payType": null, "paySource": 1, "payStatus": 3, "payStartTime": 1577682829000, "payChannel": 11, "cashierBusinessNo": "" } ], "dishInfos": [ { "uuid": "d0eb596883ed4073b46688301de6a684", "dishCode": "SKU0086", "dishName": "大波浪薯片", "price": 2300, "quantity": 1, "unitName": "个", "amount": 2300, "dishProperties": [ { "type": 444, "dishPropertyName": "中份" } ], "dishCookingWay": [], "childNodes": null, "itemId": "308229338437584896" } ], "extraCharges": [ { "name": "服务费", "privilegeAmount": 0, "amount": 0 } ], "orderInfo": { "dishTotalAmount": 2300, "extrachargeTotal": 0, "privilegesTotal": 0, "overFlowAmt": 0, "molinAmount": 0, "tradeOverFlow": 0, "custShouldPay": 2300, "custActualPay": 2300, "originAmount": 2300 }, "privilegeInfos": [], "deliveryInfo": { "deliveryStatus": 0, "deliveryPlatformName": null, "receiverName": null, "receiverPhone": null, "deliveryAddress": null, "deliverFee": 0, "expectTime": "1604633002000" }, "tableInfos": [ { "tableInfo": "桌台006/大厅区", "tableId": "37846171552642048", "creatorName": "小小" } ], "tradeCustomerInfos": [] } ], "code": 0, "message": "成功[OK]", "messageUuid": "9a252d03cae44630943f2db8a32e5992", "apiMessage": null }

请求参数

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

客如云门店

必需

ids

array[integer]

必需

客如云订单号（可通过订单列表获取(orderId)，也可通过下单接口返回的参数中获取(tradeId)）,最多20条

示例

返回响应

🟢200成功

application/json

Body

result

array [object {9}]

必需

baseInfo

object

可选

payInfos

array [object {12}]

可选

dishInfos

array [object {11}]

可选

extraCharges

array [object {3}]

可选

orderInfo

object

可选

privilegeInfos

array[string]

可选

deliveryInfo

object

可选

tableInfos

array [object {3}]

可选

tradeCustomerInfos

array[string]

可选

code

integer

必需

message

string

必需

messageUuid

string

必需

apiMessage

null

必需