当前位置: API文档
vip_api_trade_query.php(查询原始订单)
1.1 接口描述:查询电商平台的销售订单数据 |
1.2 适用版本:客户端 V2.4.5.0及以上版本 |
1.3 增量获取:按照旺店通ERP原始订单的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。 |
1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。 |
1.5注意事项:本接口不返回淘系及系统供销平台订单数据,相关平台规则单击这里。淘系及系统供销平台订单数据获取办法单击这里。其他平台的敏感信息会根据平台规则同步调整。 |
隐私字段列表
字段描述 | 字段名 |
---|---|
客户网名 | buyer_nick |
买家支付宝账号 | pay_account |
收货人姓名 | receiver_name |
收货人详细地址 | receiver_address |
收货人手机号码 | receiver_mobile |
收货人电话号码 | receiver_telpho |
收货人邮箱 | receiver_emai |
2.调用场景
2.1 获取原始订单界面的相关数据。 |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/vip_api_trade_query.php |
正式环境 | https://api.wangdian.cn/openapi2/vip_api_trade_query.php |
查询历史原始单地址:
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/vip_his_api_trade_query.php |
正式环境 | https://api.wangdian.cn/openapi2/vip_his_api_trade_query.php |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 | |
时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
签名 | sign | String | 是 | API输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
原始单号 | tid | varchar | 40 | 否 | 商城平台的单号 |
平台id | platform_id | tinyint | 4 | 否 | 平台id ID对应的平台名称单击这里 |
店铺编号 | shop_no | varchar | 40 | 否 | 店铺编号(暂不支持批量查询) |
开始时间 | start_time | datetime | 是 | 按最后修改时间增量查询数据,start_time作为开始时间,时间格式:yyyy-MM-dd HH:mm:ss | |
结束时间 | end_time | datetime | 是 | 按最后修改时间增量查询数据,end_time作为结束时间,时间格式:yyyy-MM-dd HH:mm:ss | |
页号 | page_no | int | 是 | 页号,不传默认从0页开始 | |
分页大小 | page_size | int | 是 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
条数 | total_count | varchar | 255 | 是 | 符合查询条件的总数量,只有page_no = 0 时才有值。 |
原始单节点 | trade_list | data[] | 是 | 业务数据的一级节点,数组形式的订单数据,需要循环读取。 |
trade_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
平台 | platform_id | smallint | 6 | 是 | 平台id 响应值为代表平台的ID数字,ID对应的平台名称单击这里 |
店铺编号 | shop_no | varchar | 40 | 是 | 店铺编号 |
原始单号 | tid | varchar | 40 | 是 | 原始单号 |
平台状态 | trade_status | tinyint | 4 | 是 | 平台状态:10未确认 20待尾款 30待发货 40部分发货 50已发货 60已签收 70已完成 80已退款 90已关闭(付款前取消) |
担保方式 | guarantee_mode | tinyint | 4 | 是 | 担保方式:1担保交易2非担保交易3非担保在线交易 |
支付状态 | pay_status | tinyint | 4 | 是 | 支付状态:0未付款 1部分付款 2已付款 |
发货条件 | delivery_term | tinyint | 4 | 是 | 发货条件:1.款到发货 2.货到付款 3.分期付款 4.挂账单 |
支付方式 | pay_method | tinyint | 4 | 是 | 支付方式:1.在线转账 2.现金 3.银行转账 4.邮局汇款 5.预付款 6.刷卡 7.支付宝 8.微信支付 |
退款状态 | refund_status | tinyint | 4 | 是 | 退款状态: 0.无退款 1.申请退款 2.部分退款 3.全部退款 |
系统状态 | process_status | tinyint | 4 | 是 | 系统状态:10.待递交 15.部分递交 20.已递交 30.部分发货 40.已发货 50.部分结算 60.已完成 70.已取消 |
下单时间 | trade_time | datetime | 是 | 下单时间 时间格式:yyyy-MM-dd HH:mm:ss | |
支付时间 | pay_time | datetime | 是 | 支付时间 时间格式:yyyy-MM-dd HH:mm:ss | |
买家留言 | buyer_message | varchar | 1024 | 是 | 买家留言 |
客服备注 | remark | varchar | 1024 | 是 | 客服备注 |
货款 | goods_amount | decimal | (19,4) | 是 | 货款 |
邮费 | post_amount | decimal | (19,4) | 是 | 邮费 |
其他费用 | other_amount | decimal | (19,4) | 是 | 其他费用 |
优惠 | discount | decimal | (19,4) | 是 | 优惠 |
已付金额 | paid | decimal | (19,4) | 是 | 已付金额 |
平台费用 | platform_cost | decimal | (19,4) | 是 | 平台费用 |
已收金额 | received | decimal | (19,4) | 是 | 已收金额 |
应收金额 | receivable | decimal | (19,4) | 是 | 应收金额 |
款到发货金额 | dap_amount | decimal | (19,4) | 是 | 款到发货金额 |
货到付款金额 | cod_amount | decimal | (19,4) | 是 | 货到付款金额 |
退款金额 | refund_amount | decimal | (19,4) | 是 | 退款金额 |
物流方式 | logistics_type | int | 11 | 是 | 物流方式,-1表示自由选择 |
发票类别 | invoice_type | tinyint | 4 | 是 | 发票类别:0.不需要 1.普通发票 2.普通增值发票 3.专用增值发票 |
发票抬头 | invoice_title | varchar | 255 | 是 | 发票抬头 |
发票内容 | invoice_content | varchar | 255 | 是 | 发票内容 |
结束时间 | end_time | datetime | 是 | 结束时间 时间格式:yyyy-MM-dd HH:mm:ss | |
分销方式 | fenxiao_type | tinyint | 4 | 是 | 分销方式:0.非分销订单 1.转供销 2.代销 3.经销 |
订单来源 | trade_from | tinyint | 4 | 是 | 订单来源:1.API抓单 2.手工建单 3.excel导入 4.现款销售 5.外部推送 |
修改时间 | modified | datetime | 是 | 修改时间 时间格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | created | datetime | 是 | 创建时间 时间格式:yyyy-MM-dd HH:mm:ss | |
订单标记位 | trade_mask | varchar | 11 | 是 | 订单标记位 1使用智选物流 2 航空禁运 4 预订单自动转审核失败 8 预占用待发货库存 16 订单货品指定批次 32 自动流转仓库 64 部分发货 128 全部发货 256 已发过签收消息 512 大单锁定仓库 1024 人工转入预订单 2048因配置先占用待发货库存 4096 顺丰前置发货 8192订单批量合并后标记 16384 达到原始单最大合并限制 32768 物流升级原始单指定物流订单 65536 BIC订单标记 131072 标记货品指定物流 3554432前N有礼订单 67108864预售下沉 |
买家ID | openid | varchar | 40 | 是 | 买家ID(仅快手和抖音平台返值) |
币种 | currency | varchar | 20 | 是 | 币种 |
积分 | score | int | 11 | 是 | 积分 |
交货时间 | to_deliver_time | varchar | 20 | 是 | 默认为'',配送时间,如周一至周五,预计送货时间,最晚揽收时间 周期购使用 |
分期付款金额 | pi_amount | decimal | (19,4) | 是 | 默认为'0.0000',分期付款金额 |
增量id | rec_id | bigint | 20 | 是 | 自动增量 |
店铺id | shop_id | smallint | 6 | 是 | 默认为'0' |
子订单个数 | order_count | smallint | 6 | 是 | 子订单个数 |
货品数量 | goods_count | decimal | (19,4) | 是 | 货品总数量,用于递交时检验 |
客户网名 | buyer_nick | varchar | 100 | 是 | 客户网名 |
买家姓名 | buyer_name | varchar | 40 | 是 | 默认为'',买家姓名 |
买家区域 | buyer_area | varchar | 40 | 是 | 默认为'' |
客户编号 | customer_no | varchar | 40 | 是 | 客户编号 |
收件人姓名 | receiver_name | varchar | 100 | 是 | 收件人姓名(淘系默认为'',拼多多加密) |
收件人国家 | receiver_country | smallint | 6 | 是 | 默认为'0',国家 |
收件人省份 | receiver_province | int | 11 | 是 | 省份ID,按照城市代码表中对应城市代码进行返回 |
收件人城市 | receiver_city | int | 11 | 是 | 城市ID,按照城市代码表中对应城市代码进行返回 |
收件人地址 | receiver_district | int | 11 | 是 | 地区ID,按照城市代码表中对应城市代码进行返回 |
收件人手机 | receiver_mobile | varchar | 40 | 是 | 收件人手机(淘系默认为'',拼多多加密) |
收件人电话 | receiver_telno | varchar | 100 | 是 | 收件人电话(淘系默认为'',拼多多加密) |
收件人省份名称 | receiver_province_name | varchar | 40 | 是 | 收件人省份名称 |
收件人城市名称 | receiver_city_name | varchar | 40 | 是 | 收件人城市名称 |
收件人区县名称 | receiver_district_name | varchar | 40 | 是 | 收件人区县名称 |
收件人省市区地址 | receiver_area | varchar | 128 | 是 | 收件人省市区地址 |
收件人详细地址 | receiver_address | varchar | 256 | 是 | 收件人详细地址 |
标旗 | remark_flag | varchar | 20 | 是 | 标旗 |
平台支付订单id | pay_id | varchar | 40 | 是 | 平台支付订单id,如支付宝的订单号 |
应对消费者开票金额 | invoice_consumer_amount | decimal | (19,4) | 是 | 应对消费者开票金额 |
应对平台开票金额 | invoice_platform_amount | decimal | (19,4) | 是 | 应对平台开票金额 |
主单自动流转wms | is_auto_wms | tinyint | 1 | 是 | 默认为'0',是否已经自动流转到wms |
货品明细 | goods_list | data[ ] | 是 | 业务数据的二级节点,货品明细 | |
优惠明细 | discount_list | data[ ] | 是 | 业务数据的二级节点,优惠明细 |
goods_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
平台 | platform_id | smallint | 6 | 是 | 平台id |
子单原始单号 | tid | varchar | 40 | 是 | 原始单号 |
原始子单号 | oid | varchar | 40 | 是 | 平台订单货品表主键,子订单唯一标识,同一个sid下通过本接口新增订单的oid(子订单编号)要保证唯一;如果oid重复,ERP生成系统单(递交)时会提示“订单货品数量不一致xxxxxx” |
状态 | status | tinyint | 4 | 是 | 状态:10未确认 20待尾款 30待发货 40部分发货 50已发货 60已签收 70已完成 80已退款 90已关闭 |
系统状态 | process_status | tinyint | 4 | 是 | 系统状态:10.待递交 15.部分递交 20.已递交 30.部分发货 40.已发货 50.部分结算 60.已完成 70.已取消 |
退款状态 | refund_status | tinyint | 4 | 是 | 退款状态: 0.无退款 1.取消退款 2.已申请退款 3.等待退货 4.等待收货 5.退款成功 |
子订单类型 | order_type | tinyint | 4 | 是 | 子订单类型:0.正常货品 1.虚拟货品 2.服务 |
平台货品ID | goods_id | varchar | 40 | 是 | 平台货品ID |
平台规格ID | spec_id | varchar | 40 | 是 | 平台规格ID |
平台货品编码 | goods_no | varchar | 40 | 是 | 平台货品编码 |
平台规格编码 | spec_no | varchar | 40 | 是 | 平台规格编码 |
平台货品名称 | goods_name | varchar | 255 | 是 | 平台货品名称 |
平台规格名称 | spec_name | varchar | 255 | 是 | 平台规格名称 |
数量 | num | decimal | (19,4) | 是 | 数量 |
单价 | price | decimal | (19,4) | 是 | 单价 |
调整金额 | adjust_amount | decimal | (19,4) | 是 | 调整金额 |
优惠 | discount | decimal | (19,4) | 是 | 优惠 |
总价 | total_amount | decimal | (19,4) | 是 | 总价 |
分摊优惠 | share_discount | decimal | (19,4) | 是 | 分摊优惠 |
分摊后总价 | share_amount | decimal | (19,4) | 是 | 分摊后总价 |
分摊邮资 | share_post | decimal | (19,4) | 是 | 分摊邮资 |
已付金额 | paid | decimal | (19,4) | 是 | 已付金额 |
发票类别 | invoice_type | tinyint | 4 | 是 | 发票类别:0.不需要 1.普通发票 2.普通增值发票 3.专用增值发票 |
发票内容 | invoice_content | varchar | 255 | 是 | 发票内容 |
关联子订单 | bind_oid | varchar | 40 | 是 | 关联子订单 |
退款单编号 | refund_id | varchar | 40 | 是 | 退款单编号 |
退款单金额 | refund_amount | decimal | (19,4) | 是 | 退款金额 |
备注 | remark | varchar | 255 | 是 | 备注 |
物流单号 | daifa_logistics_no | varchar | 40 | 是 | 物流单号 |
物流类型 | daifa_logistics_type | smallint | 6 | 是 | 物流类型 |
发货时间 | daifa_consign_time | datetime | 是 | 发货时间 时间格式:yyyy-MM-dd HH:mm:ss | |
订单完成时间 | daifa_end_time | datetime | 是 | 订单完成时间 时间格式:yyyy-MM-dd HH:mm:ss | |
修改时间 | modified | datetime | 是 | 修改时间 时间格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | created | datetime | 是 | 创建时间 时间格式:yyyy-MM-dd HH:mm:ss | |
子单完成时间 | end_time | datetime | 是 | 子单完成时间 时间格式:yyyy-MM-dd HH:mm:ss | |
增量id | rec_id | bigint | 20 | 是 | 自动增量 |
处理退款状态 | process_refund_status | tinyint | 4 | 是 | 默认为'0',退款处理状态,1待审核 2已同意 3已拒绝 4待收货 5已完成 6已关闭 |
平台规格码 | spec_code | varchar | 20 | 是 | 默认为'',平台规格码 |
佣金 | commission | decimal | (19,4) | 是 | 默认为'0.0000',佣金 |
结束时间 | stockout_no | varchar | 40 | 是 | 默认为'',end_time,记录结束时间 |
物流单号 | logistics_no | varchar | 40 | 是 | 默认为'',发货后物流单号 |
自动流转wms | is_auto_wms | tinyint | 1 | 是 | 默认为'0',是否已经自动流转到wms |
类目id | cid | int | 11 | 是 | 类目id |
discount_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
平台 | platform_id | smallint | 6 | 是 | 平台id |
原始单号 | tid | varchar | 40 | 是 | 原始单号 |
原始子单号 | oid | varchar | 40 | 是 | 原始子订单编号 |
明细主键 | rec_id | btigin | 20 | 是 | 自动增量 |
优惠类别 | type | varchar | 60 | 是 | 优惠类别 |
是否优惠券 | is_bonus | tinyint | 4 | 是 | 是否优惠券 |
创建时间 | created | datetime | 是 | 创建时间 时间格式:yyyy-MM-dd HH:mm:ss | |
优惠名称 | name | varchar | 255 | 是 | 优惠名称 |
优惠详情 | detail | varchar | 255 | 是 | 优惠详情 |
优惠金额 | amount | decimal | (19,4) | 是 | 优惠金额 |
平台唯一标识 | sn | varchar | 40 | 是 | 平台唯一标识 |
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": 1060, "message": "充值余额为0或应用已欠费,请联系商务充值 " } |