UNPKG

typed-jd-union-cpsapi

Version:
162 lines (161 loc) 9.76 kB
import { JdUnionBase } from '../api-base'; export type QueryAgentOrderParams = { /** 请求对象*/ orderReq: { /** 页码*/ pageIndex: number; /** 每页包含条数,上限为500*/ pageSize: number; /** 订单时间查询类型(1:下单时间,2:完成时间,3:更新时间)*/ type: number; /** 开始时间 格式yyyy-MM-dd HH:mm:ss,与endTime间隔不超过5分钟*/ startTime: string; /** 结束时间 格式yyyy-MM-dd HH:mm:ss,与startTime间隔不超过5分钟*/ endTime: string; /** 筛选出参,多项逗号分隔,目前支持:categoryInfo、goodsInfo*/ fields?: string; }; }; export type QueryAgentOrderResult = { /** 返回码*/ code: number; /** 返回消息*/ message: string; /** 数据明细*/ data: { /** 数据明细*/ orderAgentResp: { /** 标记唯一订单行*/ id: string; /** 订单号*/ orderId: number; /** 父单的订单号:如一个订单拆成多个子订单时,原订单号会作为父单号,拆分的订单号为子单号存储在orderid中。若未发生拆单,该字段为0*/ parentId: number; /** 下单时间,格式yyyy-MM-dd HH:mm:ss*/ orderTime: string; /** 完成时间(购买用户确认收货时间),格式yyyy-MM-dd HH:mm:ss*/ finishTime: string; /** 更新时间,格式yyyy-MM-dd HH:mm:ss*/ modifyTime: string; /** 下单设备 1.pc 2.无线*/ orderEmt: number; /** plus会员 1:是,0:否*/ plus: number; /** 推客ID*/ unionId: number; /** 商品ID*/ skuId: number; /** 商品名称*/ skuName: string; /** 商品数量*/ skuNum: number; /** 商品已退货数量*/ skuReturnNum: number; /** 商品售后中数量*/ skuFrozenNum: number; /** 商品单价*/ price: number; /** 佣金比例(投放的广告主计划比例)*/ commissionRate: number; /** 一级分成比例*/ subSideRate: number; /** 一级补贴比例*/ subsidyRate: number; /** 最终分佣比例(单位:%)=分成比例+补贴比例*/ finalRate: number; /** 预估计佣金额:由订单的实付金额拆分至每个商品的预估计佣金额,不包括运费,以及京券、东券、E卡、余额等虚拟资产支付的金额。该字段仅为预估值,实际佣金以actualCosPrice为准进行计算*/ estimateCosPrice: number; /** 推客的预估佣金(预估计佣金额*佣金比例*最终比例),如订单完成前发生退款,此金额也会更新。*/ estimateFee: number; /** 实际计算佣金的金额。订单完成后,会将误扣除的运费券金额更正。如订单完成后发生退款,此金额会更新。*/ actualCosPrice: number; /** 推客分得的实际佣金(实际计佣金额*佣金比例*最终比例)。如订单完成后发生退款,此金额会更新。*/ actualFee: number; /** sku维度的有效码(-1:未知,2.无效-拆单,3.无效-取消,4.无效-京东帮帮主订单,5.无效-账号异常,6.无效-赠品类目不返佣,7.无效-校园订单,8.无效-企业订单,9.无效-团购订单,11.无效-乡村推广员下单,13. 违规订单-其他,14.无效-来源与备案网址不符,15.待付款,16.已付款,17.已完成(购买用户确认收货),19.无效-佣金比例为0,20.无效-此复购订单对应的首购订单无效,21.无效-云店订单,22.无效-PLUS会员佣金比例为0,23.无效-支付有礼,24.已付定金,25. 违规订单-流量劫持,26. 违规订单-流量异常,27. 违规订单-违反京东平台规则,28. 违规订单-多笔交易异常,29.无效-跨屏跨店,30.无效-累计件数超出类目上限,29.无效-跨屏跨店,30.无效-累计件数超出类目上限*/ validCode: number; /** 同跨店:2同店 3跨店*/ traceType: number; /** 推广位ID*/ positionId: number; /** 应用id(网站id、appid、社交媒体id)*/ siteId: number; /** PID所属母账号平台名称(原第三方服务商来源),两方分佣会有该值*/ unionAlias: string; /** 格式:子推客ID_子站长应用ID_子推客推广位ID*/ pid: string; /** 一级类目id*/ cid1: number; /** 二级类目id*/ cid2: number; /** 三级类目id*/ cid3: number; /** 子联盟ID(需要联系运营开放白名单才能拿到数据)*/ subUnionId: string; /** 联盟标签数据(32位整型二进制字符串:00000000000000000000000000000001。数据从右向左进行,每一位为1表示符合特征,第1位:红包,第2位:组合推广,第3位:拼购,第5位:有效首次购(0000000000011XXX表示有效首购,最终奖励活动结算金额会结合订单状态判断,以联盟后台对应活动效果数据报表https://union.jd.com/active为准),第8位:复购订单,第9位:礼金,第10位:联盟礼金,第11位:推客礼金,第12位:京喜APP首购,第13位:京喜首购,第14位:京喜复购,第15位:京喜订单,第16位:京东极速版APP首购,第17位白条首购,第18位校园订单,第19位是0或1时,均代表普通订单,第20位:预售订单,第21位:学生订单,第22位:全球购订单 ,第23位:京喜拼拼首购订单,第24位:京喜拼拼复购订单 例如:00000000000000000000000000000001:红包订单,00000000000000000000000000000010:组合推广订单,00000000000000000000000000000100:拼购订单,00000000000000000000000000011000:有效首购,00000000000000000000000000000111:红包+组合推广+拼购等) 注:一个订单同时使用礼金和红包,仅礼金位数为1,红包位数为0*/ unionTag: string; /** 商家ID*/ popId: number; /** 推客生成推广链接时传入的扩展字段(需要联系运营开放白名单才能拿到数据)。*/ ext1: string; /** 预估结算时间,订单完成后才会返回,格式:yyyyMMdd,默认:0。表示最新的预估结算日期。当payMonth为当前的未来时间时,表示该订单可结算;当payMonth为当前的过去时间时,表示该订单已结算*/ payMonth: string; /** 招商团活动id:当商品参加了招商团会有该值,为0时表示无活动*/ cpActId: number; /** 站长角色:1 推客 2 团长*/ unionRole: number; /** 礼金分摊金额:使用礼金的订单会有该值*/ giftCouponOcsAmount: number; /** 礼金批次ID:使用礼金的订单会有该值*/ giftCouponKey: string; /** 计佣扩展信息,表示结算月:每月实际佣金变化情况,格式:{20191020:10,20191120:-2},注意:有完成时间的,才会有这个值*/ balanceExt: string; /** 数据签名,用来核对出参数据是否被修改,入参fields中写入sign时返回*/ sign: string; /** 价保赔付金额:订单申请价保或赔付的金额,实际计佣金额已经减去此金额,您无需处理*/ proPriceAmount: number; /** 商品信息,入参传入fields,goodsInfo获取*/ goodsInfo?: { /** sku主图链接*/ imageUrl?: string; /** g=自营,p=pop*/ owner?: string; /** 自营商品主Id(owner=g取此值)*/ mainSkuId?: number; /** 非自营商品主Id(owner=p取此值)*/ productId?: number; /** 店铺名称(或供应商名称)*/ shopName?: string; /** 店铺ID*/ shopId?: number; }; /** 类目信息,入参传入fields,categoryInfo获取*/ categoryInfo?: { /** 一级类目id*/ cid1?: number; /** 二级类目id*/ cid2?: number; /** 三级类目id*/ cid3?: number; /** 一级类目名称*/ cid1Name?: string; /** 二级类目名称*/ cid2Name?: string; /** 三级类目名称*/ cid3Name?: string; }; /** 发货状态(10:待发货,20:已发货)*/ expressStatus?: number; /** 渠道关系ID*/ channelId?: number; /** 目前unionTag为32位,为支持更多标签标识能力,现新增64位标签字段,64位新标签可以兼容32位unionTag,右32位参考 unionTag字段描述*/ skuTag?: string; /** 团长渠道ID,仅限招商团长管理渠道使用,团长开通权限后才可使用。*/ rid?: number; }; }[]; /** 是否还有更多,true:还有数据;false:已查询完毕,没有数据*/ hasMore: boolean; }; export declare class QueryAgentOrderAPI extends JdUnionBase { queryAgentOrder(params: QueryAgentOrderParams): Promise<QueryAgentOrderResult>; }