当前位置: API文档
sales.TradeQuery.queryWithDetail(订单查询)
1.1 接口描述:获取ERP系统内订单信息 |
1.2 适用版本:客户端 V1.5.4.3及以上版本 |
1.3 增量获取:支持 |
1.4 时间跨度:start_time和end_time最大跨度为60分钟。 |
1.5注意事项:权限校验:【店铺权限】 为了达到保护用户隐私数据安全的目的,本接口不返回淘系及系统供销平台订单数据,相关平台规则点击这里,淘系及系统供销平台数据获取办法点击这里。 本接口中涉及到用户隐私的字段数据仅自有平台及线下平台订单返回,具体字段详见下述“隐私字段列表” 通过从后往前翻页的方式可以避免漏单问题。 |
字段描述 | 字段名 |
买家支付宝账号 | pay_account |
买家昵称 | buyer_nick |
收件人姓名 | receiver_name |
收件地址 | receiver_address |
收件人手机 | receiver_mobile |
收件人固话 | receiver_telno |
客户姓名 | customer_name |
2.1 举例说明:财务系统、SAP、数据分析等系统的对接 |
环境 | HTTP地址 |
---|---|
测试环境 | http://47.92.239.46/openapi |
正式环境 | http://wdt.wangdian.cn/openapi |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 卖家账号, 由旺店通分配 | |
接口账号 | key | String | 是 | 由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里 | |
盐 | salt | String | 是 | 由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt. | |
接口名称 | method | String | 是 | 调用的接口名称 | |
版本号 | v | String | 是 | 1.0 | |
秒级时间戳 | timestamp | int | 是 | 秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。 | |
签名 | sign | String | 是 | 签名 | |
分页大小 | page_size | int | 否 | 分页大小,分页查询必传 | |
分页编号 | page_no | int | 否 | 分页编号,分页查询必传,标准接口page_no从0开始 | |
是否计算查询结果的总条数 | calc_total | int | 否 | 是否计算查询结果的总条数, 需要计算则1, 否则填0 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
查询参数 | params | Map<String, Object> | y | 查询参数 | |
分页 | pager | Pager | y | 分页 |
params
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
开始时间 | start_time | String | 40 | y | 修改起始时间,若无订单编号/原始单号/物流单号,则为必填。示例:“ 2021-11-11 00:00:00” |
结束时间 | end_time | String | 40 | y | 修改结束时间,上同开始时间。示例:“ 2021-11-11 01:00:00” |
仓库编号 | warehouse_no | String | 40 | n | 仓库编号 |
订单状态 | status | String | 255 | n | 若多个状态则以“,”隔开。 订单状态: 4 线下退款 5已取消 6 待转预订单(待审核) 7 待转已完成 10未付款 12待尾款 15等未付 16延时审核 19预订单前处理 20 审核前处理 21自流转待发货 23 异常订单 24 换货预订单 25 待处理预订单 27待分配预订单 30待客审 35待财审 40审核中 55已审核 95已发货 96 成本确认(待录入计划成本,订单结算时有货品无计划成本) 101 已过账 110已完成 |
订单编号 | trade_no | String | 40 | n | 订单编号 |
店铺编号 | shop_no | String | 20 | n | 店铺编号(暂不支持批量查询) |
物流单号 | logistics_no | String | 40 | n | 物流单号,(V1.4.9.9版本以上支持按照物流单号查询不传入时间范围) |
原始单号 | src_tid | String | 40 | n | 原始单号, 多个原始单号之间使用英文逗号分隔 |
是否使用从库查询 | is_slave | boolean | 1 | n | 使用:true 不使用:false (仅对开通从库配置客户生效) |
是否计算分摊邮费 | cal_share_post_amount | boolean | 1 | n | 是否计算分摊邮费 默认false 计算:true 不计算:false |
订单来源 | trade_from | String | 40 | n | 订单来源 1、API抓单 2、手工建单 3、导入 4、复制订单 5、接口推送 6、补发订单 7、PDA选货开单 8、分销补发订单 |
排序类型 | order_type | Int | 4 | n | 0:默认排序 1:修改时间降序 |
时间类型 | time_type | Int | 4 | n | 1:修改时间 2:付款时间 默认1 |
pager
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
分页大小 | page_size | Int | 4 | n | 分页大小(单量较大的卖家,page_size建议200以下) |
页号 | page_no | Int | 4 | n | 从0开始 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
状态码 | status | Int | y | 状态码,0表示调用成功 | |
错误信息 | message | String | y | 无错误信息不返回 | |
单据数据 | data | Map<String, Object> | y | 单据数据 |
data
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
单据数据 | order | List<Map<String, Object>> | y | 订单相关数据 | |
总数 | total_count | Int | 11 | n | 查询条件总单据数 |
order
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
订单唯一键 | trade_id | long | y | 订单唯一键 | |
订单编号 | trade_no | String | 40 | y | 订单编号(旺店通系统订单号) |
平台ID | platform_id | Int | 4 | y | 平台ID(请点击平台代码表查看对应关系) |
仓库类型 | warehouse_type | Int | 4 | y | 仓库类型: 1、普通仓库,大于1为委外仓库(如京东仓储,物流宝等),如订单无仓库的话,则不返回该字段 |
原始单号 | src_tids | String | 255 | y | 原始单号(平台订单号),如果有多个,以","分隔,且以增序排列,不重复,过长将被裁剪 |
平台支付帐号 | pay_account | String | 128 | y | 平台支付帐号, (仅自有平台及线下平台返回,其他平台均不返回) |
订单状态 | trade_status | int | 255 | y | 订单状态: 4 线下退款 5已取消 6 待转预订单(待审核) 7 待转已完成 10未付款 12待尾款 15等未付 16延时审核 19预订单前处理 20 审核前处理 21自流转待发货 23 异常订单 24 换货预订单 25 待处理预订单 27待分配预订单 30待客审 35待财审 40审核中 55已审核 95已发货 96 成本确认(待录入计划成本,订单结算时有货品无计划成本) 101 已过账 110已完成 |
订单类型 | trade_type | Int | 4 | y | 订单类型: 1、网店销售 2、线下订单 3、售后换货 4、批发业务 7、现款销售 8、分销订单 101、自定义类型一 102、自定义类型二 103、自定义类型三 104、自定义类型四 105、自定义类型五 106、自定义类型六 107、自定义类型七 108、自定义类型八 109、自定义类型九 110、自定义类型十 (与ERP中自定义类型的映射关系,点击链接查看) |
发货条件 | delivery_term | Int | 4 | y | 发货条件: 1、款到发货 2、货到付款(包含部分货到付款) 3、分期付款 4、挂账 |
京东几环 | receiver_ring | String | 20 | y | 京东几环(淘宝模糊化后的买家昵称) |
冻结原因 | freeze_reason | String | 32 | y | 冻结原因 |
退款状态 | refund_status | Int | 4 | y | 退款状态: 0、无退款 1、申请退款 2、部分退款 3、全部退款 |
分销类别 | fenxiao_type | Int | 4 | y | 分销类别: 0、非分销订单 1、代销 2、经销 |
分销商昵称 | fenxiao_nick | String | 40 | y | 分销商昵称 |
下单时间 | trade_time | String | 40 | y | 下单时间(毫秒级时间戳,例如:1631861379000) |
付款时间 | pay_time | String | 40 | y | 付款时间,例如:2020-10-19 00:00:00 |
发货时间 | consign_time | String | 40 | y | 发货时间,订单未发货不返回该字段(毫秒级时间戳,例如:1631861379000) |
客户网名 | buyer_nick | String | 100 | y | 客户网名(淘宝ouid,淘系平台不返回), (仅自有平台及线下平台返回,其他平台均不返回) |
收货人/收件人 | receiver_name | String | 100 | y | 收货人/收件人, (仅自有平台及线下平台返回,其他平台均不返回) |
省份id | receiver_province | Int | 11 | y | 省份id,可参考城市代码表 |
城市id | receiver_city | Int | 11 | y | 城市id,可参考城市代码表 |
地区id | receiver_district | Int | 11 | y | 地区id,可参考城市代码表 |
地址 | receiver_address | String | 256 | y | 收件人地址, (仅自有平台及线下平台返回,其他平台均不返回) |
手机 | receiver_mobile | String | 40 | y | 手机,(仅自有平台及线下平台返回,其他平台均不返回) |
固话 | receiver_telno | String | 40 | y | 固话, (仅自有平台及线下平台返回,其他平台均不返回) |
邮编 | receiver_zip | String | 20 | y | 邮编 |
地区 | receiver_area | String | 128 | y | 省市区空格分隔 |
大头笔 | receiver_dtb | String | 128 | y | 大头笔 |
异常订单原因 | bad_reason | Int | 11 | y | 异常订单原因(位运算): 2、修改地址 4、修改发票 8、更换仓库 16、修改备注 32、更换货品 128、拦截赠品 256、拦截换货 512、买家留言变化 1024、拦截平台已发货 |
物流单号 | logistics_no | String | 40 | y | 物流单号 |
买家留言 | buyer_message | String | 1024 | y | 买家留言 |
客服备注 | cs_remark | String | 1024 | y | 客服备注 |
标旗 | remark_flag | Int | 4 | y | 标旗(1 红、2 黄、3 绿、4 蓝、5 紫 ) |
打印备注 | print_remark | String | 1024 | y | 打印备注 |
货品种类数 | goods_type_count | Decimal(19,4) | y | 货品种类数 | |
货品总量 | goods_count | Decimal(19,4) | y | 货品总量 | |
总货款 | goods_amount | Decimal(19,4) | y | 总货款(折前总额) | |
邮费 | post_amount | Decimal(19,4) | y | 邮费(买家支付邮费) | |
其他费用 | other_amount | Decimal(19,4) | y | 其他费用 | |
优惠 | discount | Decimal(19,4) | y | 优惠 | |
应收 | receivable | Decimal(19,4) | y | 应收 | |
COD金额 | cod_amount | Decimal(19,4) | y | COD金额(货到付款金额) | |
买家COD费用 | ext_cod_fee | Decimal(19,4) | y | 买家COD费用 | |
预估货品成本 | goods_cost | Decimal(19,4) | y | 货品预估成本 | |
预估邮资成本 | post_cost | Decimal(19,4) | y | 预估邮资成本 | |
预估重量 | weight | Decimal(19,4) | y | 预估重量(kg) | |
预估毛利 | profit | Decimal(19,4) | y | 预估毛利 | |
税额 | tax | Decimal(19,4) | y | 税额 | |
税率 | tax_rate | Decimal(19,4) | y | 税率 | |
佣金 | commission | Decimal(19,4) | y | 佣金 | |
发票类型 | invoice_type | Int | 4 | y | 发票类型: 0:不需要 |
发票抬头 | invoice_title | String | 1024 | y | 发票抬头 |
发票内容 | invoice_content | String | 1024 | y | 发票内容 |
业务员 | salesman_name | String | 40 | y | 业务员 |
审核人 | checker_name | String | 40 | y | 审核人 |
财审人 | fchecker_name | String | 40 | y | 财审人 |
签出人 | checkouter_name | String | 40 | y | 签出人 |
出库单号 | stockout_no | String | 40 | y | 出库单号(系统产生的出库单号) |
标记名称 | flag_name | String | 32 | y | 标记名称 |
订单来源 | trade_from | Int | 4 | y | 订单来源: 1、API抓单 2、手工建单 3、导入 4、复制订单 5、接口推送 6、补发订单 7、PDA选货开单 8、分销补发订单 |
货品商家编码 | single_spec_no | String | 40 | y | 货品商家编码,多种货品为空,组合装时为组合装编码 |
原始货品数量 | raw_goods_count | Decimal(19,4) | y | 原始货品数量 | |
原始货品种类数 | raw_goods_type_count | Int | 6 | y | 原始货品种类数 |
币种 | currency | String | 20 | y | 币种 |
发票ID | invoice_id | Int | 11 | y | 发票ID(自增生成),0代表没有发票或已取消/已冲红 |
版本号 | version_id | Int | 6 | y | 版本号 |
修改时间 | modified | String | 40 | y | 修改时间,例如:2020-10-19 00:00:00 |
递交时间 | created | String | 40 | y | 递交时间(毫秒级时间戳,例如:1631861379000) |
审核时间 | check_time | String | 40 | y | 审核时间 |
证件类别 | id_card_type | Int | 4 | y | 证件类别 |
店铺编号 | shop_no | String | 20 | y | 店铺编号 |
店铺名称 | shop_name | String | 128 | y | 店铺名称 |
店铺备注 | shop_remark | String | 255 | y | 店铺备注 |
仓库编号 | warehouse_no | String | 40 | y | 仓库编号,如订单无仓库的话,则不返回该字段 |
客户姓名 | customer_name | String | 40 | y | 客户姓名 |
客户编码 | customer_no | String | 40 | y | 客户编码 |
物流公司名称 | logistics_name | String | 40 | y | 物流公司名称 |
物流公司编号 | logistics_code | String | 60 | y | 物流公司编号 |
物流类型 | logistics_type_name | String | 64 | y | 物流类型名称 |
送货时间 | to_deliver_time | String | 20 | y | 送货时间,例如:2020-10-19 00:00:00 |
计划发货时间 | delay_to_time | String | 40 | y | 计划发货时间 |
最晚发货时间 | estimate_consign_time | String | 40 | y | 最晚发货时间 |
店铺id | shop_id | Int | 6 | y | 店铺id |
仓库id | warehouse_id | Int | 6 | y | 仓库id |
体积 | volume | Decimal(19,4) | y | 体积 | |
订单标签 | trade_label | String | 40 | y | 订单标签 |
订单掩码 | trade_mask | Int | 11 | y | 1:使用智选物流 2:货品标签 4:预订单自动激活失败 16:订单货品指定批次 32:平台自动流转仓库 64:部分发货 128:全部发货 256:优先占用 512:待分配转审核失败或订单审核失败 1024:催未付款订单短信发送标记 2048:拆分 在判断的时候使用&运算 |
店铺平台id | shop_platform_id | Int | 4 | y | 店铺平台id |
子平台id | sub_platform_id | Int | 4 | y | 子平台id |
包装 | package_name | String | 356 | y | 包装 |
包装id | package_id | Int | 40 | y | 包装id |
包装成本 | package_cost | Decimal(19,4) | y | 包装成本 | |
已付 | paid | Decimal(19,4) | y | 已付 | |
大件类型 | large_type | Int | 4 | y | 大件类型 1:普通套件 2:独立套件 3:分组单发,未使用 -1:非单发件 取子单中的最大值 |
赠品标记 | gift_mask | Int | 4 | y | 赠品标记 1:自动赠送 2:手工赠送 4:回购赠送 8:平台赠送 (注意:如果是3,则表示既有自动赠送也有手工赠送“1+2”) |
客户id | customer_id | Int | 11 | y | 客户id |
其他成本 | other_cost | Decimal(19,4) | y | 其他成本 | |
不可合并拆分 | is_sealed | boolean | 1 | y | 不可合并拆分 |
客户类型 | customer_type | Int | 4 | y | 客户类型(0:普通客户;1:分销商;2:线下批发) |
物流公司id | logistics_id | Int | 11 | y | 物流公司id |
取消原因 | cancel_reason | String | 256 | y | 取消原因 |
驳回原因 | revert_reason | String | 256 | y | 驳回原因 |
订单标签mask | new_trade_label | String | y | 订单标签掩码 | |
分销原始单号 | fenxiao_tid | String | y | 分销原始单号(无长度限制) | |
订单明细 | detail_list | List<Map<String, Object>> | y | 订单明细 |
detail_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
订单唯一键 | trade_id | long | y | 订单唯一键 | |
订单明细唯一键 | rec_id | long | y | 订单明细唯一键 | |
平台ID | platform_id | Int | 4 | y | 平台ID |
原始子单号 | src_oid | String | 40 | y | 原始子单号 |
原始单号 | src_tid | String | 40 | y | 原始单号 |
赠品方式 | gift_type | Int | 4 | y | 赠品方式 0、非赠品 1、自动赠送 2、手工赠送 4、周期购赠送 8、平台赠送 32、阶梯满赠 64、CRM追加赠送 128 主品 |
支付状态 | pay_status | int | 4 | y | 0:未付款 1:部分付款 2:已付款(原始订单的支付状态) |
退款状态 | refund_status | Int | 4 | y | 退款状态: 0、无退款 1、取消退款 2、申请退款 3、待退款 4、待还原 5、退款成功 6、已退(未付款关闭,未付款的取消了) |
退款模式 | guarantee_mode | Int | 4 | y | 退款模式: 1、担保 2、非担保 3、在线非担保 |
子单平台状态 | platform_status | Int | 4 | y | 如果没有对应的原始单明细,则返回0. 平台状态: 10、未确认 20、待尾款 30、待发货 40、部分发货 50、已发货 60、已签收 70、已完成 80、已退款 90、已关闭 |
发货条件 | delivery_term | Int | 4 | y | 发货条件:1、款到发货 2、货到付款(包含部分货到付款) 3、分期付款 |
数量 | num | Decimal(19,4) | y | 数量 | |
标价 | price | Decimal(19,4) | y | 标价,手工新建时使用货品属性中的“零售价” | |
售后退款数量 | refund_num | Decimal(19,4) | y | 售后退款数量 | |
成交价 | order_price | Decimal(19,4) | y | 成交价,原始单折扣及分摊之后的价格 | |
分摊后价格 | share_price | Decimal(19,4) | y | 分摊后价格,进入ERP后再次调整的价格,默认值与order_price一致 | |
手工调整价 | adjust | Decimal(19,4) | y | 手工调整价,正数为加价,负数为减价,暂未处理 | |
优惠 | discount | Decimal(19,4) | y | 优惠 | |
分摊后总价 | share_amount | Decimal(19,4) | y | 分摊后总价=share_price*num | |
税率 | tax_rate | Decimal(19,4) | y | 税率 | |
货品名称 | goods_name | String | 255 | y | 货品名称 |
货品编号 | goods_no | String | 40 | y | 货品编号 |
规格名称 | spec_name | String | 100 | y | 规格名称 |
商家编码 | spec_no | String | 40 | y | 商家编码 |
规格码 | spec_code | String | 40 | y | 规格码 |
组合装编码 | suite_no | String | 40 | y | 组合装编码 |
组合装名称 | suite_name | String | 255 | y | 如果是组合装拆分的,此为组合装名称 |
组合装数量 | suite_num | Decimal(19,4) | y | 组合装数量,不受拆分合并影响 | |
组合装分摊后总价 | suite_amount | Decimal(19,4) | y | 组合装分摊后总价 | |
组合装优惠 | suite_discount | Decimal(19,4) | y | 组合装优惠 | |
平台货品名称 | api_goods_name | String | 255 | y | 平台货品名称 |
平台规格名称 | api_spec_name | String | 100 | y | 平台规格名称 |
平台货品id | api_goods_id | String | 40 | Y | 平台货品id |
平台规格id | api_spec_id | String | 40 | Y | 平台规格id |
货品id | goods_id | Int | 11 | Y | 货品id(系统货品主键) |
单品id | spec_id | Int | 11 | Y | 单品id(系统单品主键) |
佣金 | commission | Decimal(19,4) | y | 佣金 | |
货品类型 | goods_type | Int | 4 | y | 货品类型 1销售商品 2原材料 3包装 4周转材料 5虚拟商品 6固定资产 0其它 |
订单内部来源 | from_mask | Int | 11 | y | 订单内部来源: 1、手机 2、聚划算 |
子单备注 | remark | String | 255 | y | 子单备注 |
修改时间 | modified | String | 40 | y | 修改时间(毫秒级时间戳,例如:1631861379000) |
创建时间 | created | String | 40 | y | 创建时间(毫秒级时间戳,例如:1631861379000) |
自定义属性1 | prop1 | String | 255 | y | 自定义属性1 |
自定义属性2 | prop2 | String | 255 | y | 自定义属性2 |
货品重量 | weight | Decimal(19,4) | y | 货品重量(子单预估货品总重量) | |
图片路径 | img_url | String | 255 | y | 图片路径 |
实发数量 | actual_num | Decimal(19,4) | y | 实发数量(此数量为发货数量,删除操作等于将此值设置为0) | |
条码 | barcode | String | 50 | y | 条码 |
已付 | paid | Decimal(19,4) | y | 已付 | |
组合装id | suite_id | Int | 11 | y | 组合装id |
bind_oid | bind_oid | String | 50 | y | bind_oid |
打印组合装 | print_suite_mode | Int | 4 | y | 打印组合装 0:组合装明细 1:组合装及明细 2:组合装 |
天猫物流升级信息 | flag | Int | 11 | y | 1:天猫物流升级-顺丰配送 2:需要回传 4:天猫物流升级-按需配送 8:天猫物流升级-承诺发货时效 16:天猫物流升级-承诺达时效 32:天猫物流升级-预售下沉 64:天猫物流升级-预计到货时效 128:天猫物流升级-配送线路异常 1024:定金链接 2048:补款链接 4096:确认收货 (mask类型值. 在判断的时候使用&运算) |
库存保留情况 | stock_state | Int | 4 | y | 库存保留情况 0:未保留(取消的订单或完成) 1:无库存记录 2:未付款 3:已保留待审核 4:待发货 5:预订单库存 |
平台已发货 | is_consigned | boolean | 1 | y | 平台已发货 |
是否付款 | is_received | Int | 11 | y | 是否付款 |
平台类目主键 | cid | Int | y | 平台类目主键 | |
最后更新时间 | modified_date | String | y | 最后更新时间,DateTime格式 | |
创建时间 | created_date | String | y | 创建时间,DateTime格式 | |
分摊邮费 | share_post_price | Decimal(19,4) | y | 分摊邮费 | |
发票内容 | invoice_content | String | 255 | y | 发票内容 |
支付时间 | pay_time | String | y | 支付时间,DateTime格式,取自原始订单支付时间 |
JSON | {"status":100,"message":"您的查询时间过宽,查询时间不能大于60分钟"} |