参数名称
|
参数名称
|
类型
|
是否必填
|
描述
|
code
|
|
int
|
必填
|
响应码,0成功,其他值为失败
|
message
|
|
String
|
必填
|
响应文案
|
data
|
|
-
|
非必填
|
响应结果信息
|
|
actId
|
Long
|
非必填
|
活动物料id,我要推广-活动推广中第一列的id信息
|
|
skuCount
|
Integer
|
必填
|
查询返回本页的数量合计(无实际使用场景,若查询订单购买商品数可以看返回的dataList中skuCount)
|
|
scrollId
|
String
|
必填
|
分页id,当searchType选择2逐页查询时,出参会返回本字段。用于下一页查询的scrollId字段入参使用
|
dataList
|
-
|
|
非必填
|
数据列表
|
|
businessLine
|
Integer
|
必填
|
业务线,同入参枚举说明
|
|
orderId
|
String
|
必填
|
订单ID
|
|
payTime
|
Integer
|
必填
|
订单支付时间
|
|
payPrice
|
String
|
非必填
|
订单支付价格。针对到店、闪购业务类型,为父订单的支付价格
|
|
updateTime
|
Integer
|
必填
|
订单最近一次的更新时间。
到家券包、闪购、到店券包类型订单时间为用户买券包的更新时间,非每张券的更新时间。针对以上业务类型,建议查询单张券的更新时间
|
|
commissionRate
|
String
|
非必填
|
订单预估佣金比例,300表示3%
|
|
profit
|
String
|
非必填
|
订单整体的预估佣金收入,1.60表示1.6元
|
|
cpaProfit
|
String
|
非必填
|
cpa类型的预估佣金收入,6.50表示6.5元
|
|
sid
|
String
|
非必填
|
二级媒体身份标识,用于渠道效果追踪
|
|
productId
|
String
|
非必填
|
产品ID,对应商品查询接口的skuViewId,目前只支持外卖券包和到店券包业务类型
|
|
productName
|
String
|
非必填
|
产品名称,外卖订单展示店铺名称,非外卖订单展示全部商品名称
|
orderDetail
|
|
-
|
非必填
|
订单详情,只支持到家商品券订单、到家闪购商品子业务订单、到店订单返回数据
|
|
couponStatus
|
String
|
非必填
|
本期只有到家商品券订单、到家闪购商品子业务订单、到店业务类型展示订单明细,表示商品券/子订单推广计佣状态,1、付款,2、完成(或券已核销),3、结算,4、失效(含取消或风控的情况)
|
|
itemOrderId
|
String
|
非必填
|
针对到店商品券,返回商品券的子订单号。其他业务类型不返回
|
|
finishTime
|
String
|
非必填
|
针对到家商品券,返回商品券核销完成履约的实物菜品订单号对应的完成时间
针对到店子订单,返回子订单对应的券核销时间
针对闪购商品,返回商品订单完成时间
|
|
basicAmount
|
String
|
非必填
|
商品的计佣金额,每个商品对应的支付分摊金额
|
|
couponFee
|
String
|
非必填
|
商品的佣金,当推广状态为失效、取消、风控时,佣金值为0
|
|
orderViewId
|
String
|
非必填
|
只对到家商品券有效。商品券的核销完成履约的实物菜品订单号
|
|
refundAmount
|
String
|
非必填
|
到店子订单、闪购商品的退款金额,到家业务类型不返回数据
|
|
refundFee
|
String
|
非必填
|
到店子订单、闪购商品的退款佣金,到家业务类型不返回数据
|
|
refundTime
|
String
|
非必填
|
到店子订单、闪购商品的退款时间,到家业务类型不返回数据
|
|
settleTime
|
String
|
非必填
|
到家商品券/到家闪购商品/到店子订单的结算时间,完成并且进入结算账期时则变为结算状态。若存在多次结算记录则取最新结算时间
|
|
updateTime
|
String
|
非必填
|
到家商品券/到家闪购商品/到店子订单的更新时间
|
|
refundPrice
|
String
|
非必填
|
只对非到店业务类型有效。订单维度退款价格,该笔订单用户发生退款行为时的退款计佣金额之和,超值券包订单本期不返回退款数据
|
|
refundTime
|
String
|
非必填
|
只对非到店业务类型有效。订单维度最新一次发生退款的时间;超值券包订单本期不返回退款数据
|
|
refundProfit
|
String
|
非必填
|
只对非到店业务类型有效。订单维度退款预估佣金,该笔订单用户发生退款行为时的退款预估佣金金额之和;超值券包订单本期不返回退款数据
|
|
cpaRefundProfit
|
String
|
非必填
|
CPA退款预估佣金,单位元
|
|
status
|
String
|
非必填
|
表示订单维度状态,枚举有 2:付款(如果是CPA订单则表示奖励已创建) 3:完成 4:取消 5:风控 6:结算。
针对到家商品券订单、到家闪购订单、到店业务类型订单则为父订单相关状态,枚举有2:付款,父订单仅付款,至少有任意一个子订单未核销; 3:完成,父订单中所有子订单都核销完成; 4:取消,父订单中的子订单全部退款或过期未使用; 5:风控,父订单中的子订单全部变成风控状态; 6:结算,父订单中所有子订单都结算完成。(CPA订单只有到店业务类型有本状态)
说明:
1、若到店业务类型父订单、闪购父订单,含有多个状态混合的子订单,则随机取子订单状态作为父订单状态,建议以orderDetail中每张券状态为准
2、含多个券包的订单不建议使用该字段,实际计佣状态以orderDetail中每张券的计佣状态为准。
|
|
tradeType
|
Integer
|
非必填
|
交易类型,1:cps,2:cpa
|
|
actId
|
Long
|
非必填
|
活动物料id,我要推广-活动推广中第一列的id信息
|
|
appkey
|
String
|
非必填
|
归因到的appKey,对应取链时入参的appkey
|
|
skuCount
|
Integer
|
非必填
|
表示sku数量,团好货和券包类型的CPS订单返回有值,其余类型订单不返回该值
|
|
cityName |
String |
非必填
|
订单所属的城市,目前支持二级城市粒度。目前只支持到家业务类型-商品超值券包业务线。 |
|
categoryId |
Long |
非必填 |
订单品类id。 |
|
categoryName |
String |
非必填 |
|