Y_vip_api_trade_query.php(查询原始订单)
¥增值
1.接口说明
2.调用场景
3.请求参数说明
3.1 请求地址
环境 | HTTP地址 |
---|
测试环境 | https://openapitest.huice.com/openapi/vip_api_trade_query.php |
正式环境 | https://openapi.huice.com/openapi/vip_api_trade_query.php |
3.2 公共请求参数
名称 | 字段 | 类型 | 长度
| 必须 | 描述 |
---|
卖家账号 | 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输入参数签名结果,签名算法介绍单击这里
|
3.3 业务请求参数
字段 | 名称 | Y 字段 | 长度 | 必须 | 描述 |
tid | 原始单号 | tid |
|
| 原始单号 |
start_time | 开始时间 | start_time |
|
| 修改起始时间 |
end_time | 结束时间 | end_time |
|
| 修改结束时间 |
shop_id | 店铺编号 | shop_id |
|
| 店铺编号 |
分页大小 | page_size | page_size |
| 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为100,使用举例单击这里 |
页号 | page_no | page_no |
| 否 | 页号,不传默认从0页开始 |
4.响应参数
4.1 公共响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
条数 | total_count | varchar | 255 | 是 | 符合查询条件的总数量,只有page_no = 0 时才有值。 |
原始单节点 | trade_list | data[] |
| 是 | 业务数据的一级节点,数组形式的订单数据,需要循环读取。 |
4.2 业务响应参数
trade_list
名称 | Y字段 | Y父级字段 | Y类型 | Y枚举 | 是否必须 | 默认值 | 是否可变更(非null变为非null) |
平台订单号 | tid |
| string |
| 是 |
| 否 |
平台id | platform_id |
| int(11) |
| 是 |
| 否 |
平台订单状态 | trade_status |
| int(11) | 平台订单状态:30已支付 50已发货 70已完成 80已退款 90已关闭(付款前取消) | 是 |
| 是 |
店铺id | shop_id |
| int(11) |
| 是 |
| 否 |
发货条件 | delivery_term |
| tinyint(4) | 发货条件 1款到发货 2货到付款(包含部分货到付款) 3分期付款 4挂帐单 | 是 |
| 否 |
担保交易类别 | guarantee_mode |
| tinyint(4) | 担保交易类别:1担保交易2非担保交易3非担保在线交易 | 是 | 1 | 否 |
支付状态 | pay_status |
| tinyint(4) | 支付状态:0未付款 1部分付款 2已付款 | 是 |
| 是 |
支付方式 | pay_method |
| tinyint(4) | 支付方式: 1在线转帐 2现金,3银行转账,4邮局汇款 5预付款 6刷卡 7支付宝 8微信支付 0 未知 | 是 |
| 是 |
支付时间 | pay_time |
| datetime | 时间格式:yyyy-MM-dd HH:mm:ss | 是 |
| 是 |
完成时间 | end_time |
| datetime | 部分平台有,没有的可以传null | 否 |
| 否 |
货品数量 | goods_count |
| decimal(19, 4) |
| 是 |
| 是 |
货款 | goods_amount |
| decimal(19, 4) | 未除优惠 | 是 |
| 是 |
邮费 | post_amount |
| decimal(19, 4) |
| 是 |
| 是 |
优惠 | discount |
| decimal(19, 4) |
| 是 |
| 是 |
实付 | paid |
| decimal(19, 4) |
| 是 |
| 是 |
应收 | receivable |
| decimal(19, 4) |
| 是 |
| 是 |
已收 | received |
| decimal(19, 4) |
| 是 |
| 是 |
币种 | currency |
| string |
| 否 | null | 否 |
退款状态 | refund_status |
| decimal(19, 4) | 退款状态: 0.无退款 1.申请退款 2.部分退款 3.全部退款 | 是 |
| 是 |
买家备注 | buyer_message |
| string |
| 是 |
| 是 |
客服备注 | remark |
| string |
| 是 |
| 是 |
标旗 | remark_flag |
| int(11) | 标旗(1 红、2 黄、3 绿、4 蓝、5 紫 ) | 是 |
| 是 |
最后修改时间 | modified |
| datetime | 时间格式:yyyy-MM-dd HH:mm:ss | 是 |
| 是 |
收件人省 | receiver_province |
| int(11) |
| 是 |
| 是 |
收件人市 | receiver_city |
| int(11) |
| 是 |
| 是 |
收件人区 | receiver_district |
| int(11) |
| 是 |
|
|
明细货品列表 | goods_list |
| array[] |
| 是 |
|
|
平台子订单号 | oid | goods_list | string |
| 是 |
| 否 |
平台id | platform_id | goods_list | int(11) |
| 是 |
| 否 |
平台订单号 | tid | goods_list | string |
| 是 |
| 否 |
平台子单状态 | status | goods_list | int(11) | 平台子单状态:10未确认 20待尾款 30待发货 40部分发货 50已发货 60已签收 70已完成 80已退款 90已关闭 | 是 |
| 是 |
子单完成时间 | end_time | goods_list | datetime | 部分平台有,没有的可以传null | 否 |
| 否 |
平台货品ID | goods_id | goods_list | string |
| 是 |
| 是 |
平台货品编码 | goods_no | goods_list | string |
| 是 |
| 是 |
平台货品名称 | goods_name | goods_list | string |
| 是 |
| 是 |
平台规格ID | spec_id | goods_list | string |
| 是 |
| 是 |
平台规格编码 | spec_no | goods_list | string |
| 是 |
| 是 |
平台规格码 | sku_code | goods_list | string |
| 是 |
| 是 |
平台规格名称 | spec_name | goods_list | string |
| 是 |
| 是 |
货品数量 | num | goods_list | decimal(19, 4) |
| 是 |
| 是 |
分摊邮费 | 无 | goods_list | decimal(19, 4) |
| 否 | null | 是 |
分摊应收 | share_amount | goods_list | decimal(19, 4) |
| 是 |
| 是 |
退款状态 | refund_status | goods_list | tinyint(4) | 退款状态: 0.无退款 1.取消退款 2.已申请退款 3.等待退货 4.等待收货 5.退款成功 | 是 |
| 是 |
子单备注 | remark | goods_list | string |
| 是 |
| 是 |
子单最后修改时间 | modified | goods_list | datetime | 时间格式:yyyy-MM-dd HH:mm:ss | 是 |
| 是 |