客如云开放平台

查询订单详情收费

(下行接口)查询订单详情

授权方式：门店授权

请求描述

HTTP请求方式：POST
HTTP请求头类型：Content-Type=application/json
URI:  /open/v1/data/order/exportDetail

请求参数

1.公共参数

详情可查看【公共说明】中的公共参数模块

2.业务参数

参数名	类型	是否必填	参数描述
ids	List<Long>	是	客如云订单号（可通过订单列表获取(orderId)，也可通过下单接口返回的参数中获取(tradeId)）,最多20条
shopIdenty	Long	是	客如云门店

注：只支持最近7天数据查询

业务示例（JSON）

{
    "shopIdenty":810002790,
    "ids":[810002,810003]
}

响应参数

参数名	类型	是否必填	参数描述
code	Int	是	返回编码，详见错误码
message	String	是	返回信息
messageUuid	String	是	消息uuid
result	List<OpenOrderExportDetailVO>	否	返回响应数据，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>	否	活动信息
promotions	List<Promotion>	否	支付级优惠信息

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 已反结账（若订单已完成付款还需要添加费用或减免费用，就需要先反结账，再进行费用操作；此时订单会生成一个新的订单ID，订单商品内容和原订单一样，再进行添减费用）;11 挂账（指该订单未收到真实资金）；12 已销账；13 待清账；14 被合单（指两张桌的订单合并成一个订单，其中一个订单金额已废弃且合并到另一个）；)
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	否	业务编码：1：快餐；2：正餐；3：外卖；4：在线充值；5：POS支付；6：微信商品；7：快捷支付；8：实体卡出售；9：实体卡储值；10：临时卡售卡并储值；11：临时卡售卡；12：临时卡储值；13：临时卡退卡；14：销账；15：团餐；16：自助餐；17：换卡；18：预订单；19：尾款单；20：美容美发；21：押金单；22：服务预储；23：酒吧订单；24：权益包出售；25：积分商城商品；26：餐饮押金单；27：企业押金；28：签单结账；29：签单预收款；30：实体卡售卡并储值；
businessTypeName	String	否	业务名称：1：快餐；2：正餐；3：外卖；4：在线充值；5：POS支付；6：微信商品；7：快捷支付；8：实体卡出售；9：实体卡储值；10：临时卡售卡并储值；11：临时卡售卡；12：临时卡储值；13：临时卡退卡；14：销账；15：团餐；16：自助餐；17：换卡；18：预订单；19：尾款单；20：美容美发；21：押金单；22：服务预储；23：酒吧订单；24：权益包出售；25：积分商城商品；26：餐饮押金单；27：企业押金；28：签单结账；29：签单预收款；30：实体卡售卡并储值；
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（付款明细表的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:极易付，-111:Nets，-112:Nets flashpay,-113:NetsQR,-115:Creditcard,116:农业银行,-117:ORG_PAYNOW,118L:ORG_ALIPAY_OVERSEAS,-119:ORG_WEIXINPAY_OVERSEAS,-120:ORG_GRABPAY,-121:ORG_TNG,-122:ORG_IOT,123:阿里工牌支付,-124:口碑券包支付,-125:ORG_LUSOPAY,-126:ORG_ICBC_E,-127:储值补录,-133:蚂蚁工牌支付,-134:抖音团购券,-136:抖音外卖,-135:凭证支付,-140:抖音支付记账,-141:支付宝团购券,备注：<-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	否	优惠细项（优惠类型：1:DISCOUNT:手动折扣,2:REBATE:折让,3:FREE:免单,4:PROMO:优惠活动或者优惠券,5:INTEGRAL:积分抵现,6:AUTODISCOUNT:自动折扣,7:平台优惠,8:商户优惠,9:物流优惠,10:代理商优惠,11:会员特价,12:附加费,13商品营销,14熟客折扣,15微信卡券,16宴请,17问题菜品,18批量赠送,19分享减免,20微信礼品卡,21服务费,22次卡,23拼团,24秒杀,25砍价,26服务次数）
typeName	String	否	优惠类别（优惠类型为1、2、3时为商品名称，否则为优惠类型）
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	是	活动名称

Promotion

参数名	类型	是否必填	参数描述
isReconciliation	Integer	否	是否对账，0 未对账 1 已对账
statusFlag	Integer	否	是否有效
source	Integer	否	来源（1:美团团购;2:美团闪惠;3百度糯米团购,4自定义支付,5微信支付,6支付宝支付,7口碑团购卷支付,8银联云闪付,9工商e支付,10口碑C端支付,11口碑C端支付,12建行龙支付,13第三方团购）
mount	BigDecimal	否	促销金额
platformAmount	BigDecimal	否	平台优惠，如微信、支付宝等支付平台官方优惠，该部分不会分摊到菜品/商品实收单价上
shopActivityAmount	BigDecimal	否	商户活动优惠，如商户在第三方支付平台配置的优惠，也不会分摊到菜品/商品实收单价上
serviceCharge	BigDecimal	否	服务费
shopActualAmount	BigDecimal	否	商户实收
unitActualAmount	BigDecimal	否	自定义支付实收单价，即每张自定义支付卷的实收

响应示例（JSON）

 {
    "result":[
        {
            "baseInfo":{
                "tradeNo":"101230610101139080728610",
                "tradeType":1,
                "shopId":870448151,
                "shopName":"大温室销售",
                "source":10,
                "sourceName":"商户收银终端",
                "sourceChild":1,
                "deliverType":1,
                "paymentTime":1686363109,
                "createTime":1686363110,
                "tradePayStatus":3,
                "tradeStatus":4,
                "peopleCnt":1,
                "casherName":"黄莉",
                "relateTradeId":null,
                "thirdServiceCharge":0,
                "thirdSubsidies":0,
                "reasonInfo":"",
                "serialNumber":"5",
                "numberPlate":null,
                "businessType":1,
                "businessTypeName":"快餐",
                "deviceInfo":"9c:2d:cf:52:d8:66",
                "tradeMark":1,
                "bizDate":1686326400000,
                "tradeMemo":null,
                "tpOrderId":"20230610171516000147990758580073",
                "tpSerialNumber":null,
                "creatorName":"黄莉",
                "pickUpNumber":null,
                "id":764067583815926785
            },
            "payInfos":[
                {
                    "paymentItemId":764067583815926794,
                    "payTranNo":"2023061022001466221416782467",
                    "payModelId":-6,
                    "payModeName":"支付宝",
                    "custActualPay":5200,
                    "shopActualAmount":5250,
                    "payType":3,
                    "paySource":1,
                    "payStatus":3,
                    "payStartTime":1686363110857,
                    "payChannel":61,
                    "cashierBusinessNo":"20230610000000101074491934000073"
                }
            ],
            "dishInfos":[
                {
                    "uuid":"91f2c73a26ec489fb953647dc84c0954",
                    "dishCode":"SKU0257",
                    "dishId":"666967232827695104",
                    "dishName":"儿童票",
                    "price":3500,
                    "quantity":1,
                    "unitName":"张",
                    "amount":3500,
                    "dishProperties":[

                    ],
                    "dishCookingWay":[

                    ],
                    "childNodes":[

                    ],
                    "itemId":"764067583815926789",
                    "addDishWaiter":"黄莉",
                    "giveDishWaiter":null
                },
                {
                    "uuid":"6cc577163fde425c856e66c622b21336",
                    "dishCode":"SKU0450",
                    "dishId":"711620727984202752",
                    "dishName":"老年儿童票",
                    "price":1750,
                    "quantity":1,
                    "unitName":"盆",
                    "amount":1750,
                    "dishProperties":[

                    ],
                    "dishCookingWay":[

                    ],
                    "childNodes":[

                    ],
                    "itemId":"764067583815926790",
                    "addDishWaiter":"黄莉",
                    "giveDishWaiter":null
                }
            ],
            "extraCharges":[

            ],
            "orderInfo":{
                "dishTotalAmount":5250,
                "extrachargeTotal":0,
                "privilegesTotal":0,
                "overFlowAmt":0,
                "molinAmount":0,
                "tradeOverFlow":0,
                "custShouldPay":5250,
                "custActualPay":5200,
                "originAmount":5250
            },
            "privilegeInfos":[

            ],
            "deliveryInfo":{
                "deliveryStatus":0,
                "deliveryPlatformName":"自配送",
                "receiverName":null,
                "receiverPhone":null,
                "deliveryAddress":null,
                "deliverFee":null,
                "expectTime":null
            },
            "tableInfos":[

            ],
            "tradeCustomerInfos":[

            ],
            "taxDetails":[

            ],
            "tradePlanActivities":[

            ],
            "operateUsers":null,
            "promotions":[
                {
                    "tradeId":764067583815926785,
                    "paymentItemId":764067583815926794,
                    "isReconciliation":0,
                    "statusFlag":1,
                    "source":6,
                    "mount":-0.5,
                    "platformAmount":0.5,
                    "shopActivityAmount":0,
                    "serviceCharge":0,
                    "shopActualAmount":null,
                    "unitActualAmount":0
                }
            ]
        }
    ],
    "code":0,
    "message":"成功[OK]",
    "messageUuid":"805319c0-2b4d-45aa-a523-193dca654466",
    "apiMessage":null
}