当前位置: API文档
Y_vip_api_trade_query.php(查询原始订单)
| 1.1 接口描述:查询平台原始订单 |
1.2注意事项:权限校验:【店铺、仓库权限】 为了达到保护用户隐私数据安全的目的,本接口不返回淘系、拼多多及系统供销平台订单数据,相关平台规则点击这里,淘系及系统供销平台数据获取办法点击这里,拼多多请自行对接平台获取。 本接口中涉及到用户隐私的字段数据仅有自有平台及线下平台订单返回。 |
2.调用场景
| 2.1 查询平台原始订单 |
| 环境 | HTTP地址 |
|---|---|
| 测试环境 | https://openapi.ali.huice.cc/openapi/vip_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 | 原始单号 | 原始单号 | ||
| start_time | 开始时间 | 修改起始时间 | ||
| end_time | 结束时间 | 修改结束时间 最大间隔为 30 天 | ||
| shop_id | 店铺编号 | 店铺编号 | ||
| 分页大小 | page_size | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为100,使用举例单击这里 | |
| 页号 | page_no | 否 | 页号,不传默认从0页开始 | |
| trade_status | 订单状态 | 否 | 平台订单状态: 10 未确认 20待尾款 30已支付 40 部分发货 50已发货 60 已签收 70已完成 80已退款 90已关闭(付款前取消) |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
| 错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
| 错误描述 | message | varchar | 255 | 是 | 错误描述 |
| 条数 | total_count | varchar | 255 | 是 | 符合查询条件的总数量,只有page_no = 0 时才有值。 |
| 原始单节点 | trade_list | data[] | 是 | 业务数据的一级节点,数组形式的订单数据,需要循环读取。 |
trade_list
| 名称 | 字段 | 类型 | 必须 | 描述 |
| 平台订单号 | tid | string | 是 | |
| 平台id | platform_id | int(11) | 是 | 点击查看平台ID详情 |
| 平台订单状态 | trade_status | int(11) | 是 | 平台订单状态:30已支付 50已发货 70已完成 80已退款 90已关闭(付款前取消) |
| 系统状态 | process_stauts | int | 是 | 10-待递交 15-部分发货递交 19-预递交 20-已递交 30-部分发货 40-已发货 60-已完成 70-已取消 |
| 店铺id | shop_id | int(11) | 是 | |
| 发货条件 | delivery_term | tinyint(4) | 是 | 发货条件 1款到发货 2货到付款(包含部分货到付款) 3分期付款 4挂帐单 |
| 担保交易类别 | guarantee_mode | tinyint(4) | 是 | 担保交易类别:1担保交易2非担保交易3非担保在线交易 |
| 支付状态 | 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 |
| 下单时间 | trade_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 | 否 | |
| 退款状态 | 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) | 是 | |
| 收件人省市区拼接 名称 | receiver_area | string | 是 | |
| 收件人手机号 | receiver_mobile | string | 是 | |
| 收件人地址 | receiver_address | string | 是 | |
| 收件人姓名 | receiver_name | string | 是 | |
| 创建时间 | created | datetime | 是 | |
| 明细货品列表 | goods_list | array[] | 是 |
goods_list
| 名称 | 字段 | 类型 | 必须 | 描述 |
| 平台子订单号 | oid | string | 是 | |
| 平台id | platform_id | int(11) | 是 | |
| 平台订单号 | tid | string | 是 | |
| 平台子单状态 | status | int(11) | 是 | 平台子单状态:10未确认 20待尾款 30待发货 40部分发货 50已发货 60已签收 70已完成 80已退款 90已关闭 |
| 子单完成时间 | end_time | datetime | 否 | 部分平台有,没有的可以传null |
| 平台货品ID | goods_id | string | 是 | |
| 平台货品编码 | goods_no | string | 是 | |
| 平台货品名称 | goods_name | string | 是 | |
| 平台规格ID | spec_id | string | 是 | |
| 平台规格编码 | spec_no | string | 是 | |
| 平台规格码 | sku_code | string | 是 | |
| 平台规格名称 | spec_name | string | 是 | |
| 货品数量 | num | decimal(19, 4) | 是 | |
| 平台单价 | price | decimal(19, 4) | 是 | |
| 分摊应收 | share_amount | decimal(19, 4) | 是 | |
| 退款状态 | refund_status | tinyint(4) | 是 | 退款状态: 0.无退款 1.取消退款 2.已申请退款 3.等待退货 4.等待收货 5.退款成功 |
| 子单备注 | remark | string | 是 | |
| 子单最后修改时间 | modified | datetime | 是 | 时间格式:yyyy-MM-dd HH:mm:ss |
| 优惠信息列表 | discount_list | array[] | 否 | 优惠明细数据列表 |
discount_list
| 名称 | 字段 | 类型 | 必须 | 描述 |
| 优惠明细id | rec_id | bigint | 否 | |
| 平台id | platform_id | int(11) | 否 | |
| 平台订单单号 | tid | string | 否 | |
| 平台订单子单号 | oid | string | 否 | |
| 优惠类型 | type | int | 否 | 优惠类型 来源于平台 |
| 是否是优惠卷 | is_bonus | int | 否 | 0 否 1 是 |
| 优惠名称 | name | string | 否 | |
| 优惠明细描述 | detail | string | 否 | |
| 金额 | amount | decimal(19, 4) | 否 | |
| 平台优惠的唯一标识 | sn | string | ||
| 创建时间 | created | datetime | 否 | 时间格式:yyyy-MM-dd HH:mm:ss |
6.1 正常响应示例
6.2 异常响应示例
| JSON | {
"code": 1060,
"message": "充值余额为0或应用已欠费,请联系商务充值 "
} |