当前位置: API文档
trade_query.php(查询系统订单)
1.接口说明
1.1 接口描述:查询ERP内订单 |
2.请求参数说明
2.1 请求地址
环境 | HTTP地址 |
---|---|
测试环境 | http://openapitest.huice.com/openapi/trade_query.php |
正式环境 |
2.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输入参数签名结果,签名算法介绍文档中心 |
2.3 业务请求参数
名称 | Y字段 | 描述 |
开始时间 | start_time | 修改起始时间,若无订单号/物流单号,则为必填。示例:“ 2021-11-11 00:00:00” |
结束时间 | end_time | 修改结束时间,上同开始时间。示例:“ 2021-11-11 01:00:00” 开始时间和结束时间最大间隔为3天 |
仓库编号 | warehouse_id | 仓库编号 |
订单状态 | status | 若多个状态则以“,”隔开。订单状态: 4 已取消(可恢复) 5 已取消 25 特殊单 29 预订单 30 已支付 35 待财审 50 待发货 51 待推送 52 推送中 53 推送失败 55 已推送 95 已发货 |
订单编号 | trade_no | 订单编号,多个订单编号之间使用英文逗号分隔 |
店铺编号 | shop_id | 店铺编号 |
物流单号 | logistics_no | 物流单号 |
原始单号 | src_tid | 原始单号, 多个原始单号之间使用英文逗号分隔 |
订单来源 | trade_from | 订单来源1、API抓单2、手工建单3、导入4、复制订单5、接口推送6、补发订单7、PDA选货开单8、分销补发订单 |
系统订单id | trade_ids | 系统订单id, 多个系统订单id之间使用英文逗号分隔 |
remark_flags | 查询对应标旗的数据,标旗取值为0到5,多个之间用逗号,分隔。传入 0 表示无标旗, 1 红色 2 黄色 3 绿色 4 蓝色 5 紫色 | |
分页大小 | page_size | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为100,使用举例 |
页号 | page_no | 页号,不传默认从0页开始 |
3.响应参数
3.1 公共响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
条数 | total_count | varchar | 255 | 是 | 符合查询条件的总数量,只有page_no = 0 时才有值。 |
原始单节点 | trades | data[] | 是 | 业务数据的一级节点,数组形式的订单数据,需要循环读取。 |
3.2 业务响应参数
trades
trades | array[] | ||||||
名称 | Y字段 | 父级字段 | 类型 | 枚举及 描述 | 是否必须 | 默认值 | 是否可变更 |
系统订单id | trade_id | bigint(20) | 是 | 否 | |||
系统订单编号 | trade_no | string | 是 | 否 | |||
系统订单状态 | trade_status | smallint(6) | 4 已取消(可恢复) 5 已取消 25 特殊单 29 预订单 30 待审核(已支付) 35 待财审 50 待发货 51 待推送 52 推送中 53 推送失败 55 已推送 95 已发货 | 否 | |||
店铺id | shop_id | int(11) | 是 | 是 | |||
店铺名称 | shop_name | string(128) | 否 | 是 | |||
平台id | platform_id | int(11) | 是 | 否 | |||
仓库id | warehouse_id | int(11) | 是 | 是 | |||
平台订单号 | src_tids | string(1024) | 合单后是多个平台单号 用,分隔,受限于字段长度可能截取 | 是 | 否 | ||
出库单号 | stockout_no | string | 是 | 是 | |||
订单来源 | trade_from | smallint(6) | 1、API抓单2、手工建单3、导入4、复制订单5、接口推送6、补发订单7、展架下单8、换货订单 | 是 | 否 | ||
支付时间 | pay_time | datetime | 是 | 是 | |||
数量 | goods_count | decimal(19, 4) | 是 | 是 | |||
邮费收入 | post_amount | decimal(19, 4) | 是 | 是 | |||
预估邮资成本 | post_cost | decimal(19, 4) | 否 | 是 | |||
退款状态 | refund_status | smallint(6) | 0、无退款1、申请退款2、部分退款3、全部退款 | 是 | 是 | ||
买家备注 | buyer_message | string | 是 | 是 | |||
客服备注 | cs_remark | string | 是 | 是 | |||
标旗 | remark_flag | int(11) | 是 | 是 | |||
最后修改时间 | modified | datetime | 是 | 是 | |||
物流单号 | logistics_no | string | 返回其中一个 | 否 | 是 | ||
物流公司ID | logistics_id | bigint(20) | 是 | 是 | |||
物流公司类型 | logistics_type | string | 参考旗舰版的物流公司类型编码 | 否 | 是 | ||
物流公司类型名称 | logistics_type_name | string | 物流品牌的名称 | 否 | 是 | ||
订单标签 | tags | array[string] | |||||
下单时间 | trade_time | ||||||
折扣 | discount | decimal(19, 4) | 是 | 是 | |||
应收金额 | receivable | decimal(19, 4) | 是 | 是 | |||
商家实收 | real_amount | decimal(19, 4) | 是 | 是 | |||
退款金额 | refund_amount | decimal(19, 4) | 是 | 是 | |||
买家实付 | paid | decimal(19, 4) | 否 | 是 | |||
是否打印 | is_print | int | 0 未打印 1 已打印 | 否 | 是 | ||
发货时间 | consign_time | datetime | 否 | 是 | |||
创建时间 | created | datetime | 举例:2025-01-01 00:00:00 | 是 | 是 | ||
收件人省 | receiver_province | int(11) | 是 | 是 | |||
收件人市 | receiver_city | int(11) | 是 | 是 | |||
收件人区 | receiver_district | int(11) | 是 | ||||
收件人省市区拼接 名称 | receiver_area | string | 是 | 是 | |||
收件人手机号 | receiver_mobile | string | 是 | ||||
收件人地址 | receiver_address | string | 是 | ||||
收件人姓名 | receiver_name | string | 是 | ||||
货品列表 | goods_list | array[] | 是 | ||||
订单明细id | rec_id | goods_list | bigint(20) | 是 | 否 | ||
平台子单号 | src_oid | goods_list | string | 是 | '' | 否 | |
平台id | platform_id | goods_list | int(11) | 是 | 否 | ||
平台单号 | src_tid | goods_list | string | 是 | 否 | ||
货品明细id | spec_id | goods_list | bigint(20) | 是 | 是 | ||
商家编码 | spec_no | goods_list | string | 是 | 是 | ||
货品编码 | goods_no | goods_list | string | 是 | 是 | ||
规格码 | spec_code | goods_list | string | 是 | 是 | ||
下单数量 | num | goods_list | decimal(19, 4) | 是 | 否 | ||
分摊邮费 | share_post | goods_list | decimal(19, 4) | 否 | null | 是 | |
分摊后总价 | share_amount | goods_list | decimal(19, 4) | 是 | 是 | ||
分摊优惠 | share_discount | goods_list | decimal(19, 4) | 否 | 是 | ||
调整金额,手工改价金额 | adjust | goods_list | decimal(19, 4) | 手工改价金额 手工调整价,正数为加价,负数为减价 | 是 | ||
货品重量 | weight | goods_list | decimal(19, 4) | 单个货品重量 | 是 | 是 | |
退款状态 | refund_status | goods_list | smallint(6) | 0-无退款,1-取消退款,2-已申请退款,3-等待退货,4-等待收货,5-退款成功 | 是 | 是 | |
组合装编码 | suite_no | goods_list | string | 否 | '' | 是 | |
组合装数量 | suite_num | goods_list | decimal(19, 4) | 否 | '' | 是 | |
赠品方式 | gift_type | goods_list | smallint(6) | 0、非赠品1、自动赠送 2、手工赠送 4、周期购赠送 8、平台赠送 | 是 | 否 | |
备注 | remark | goods_list | string | 是 | 是 | ||
最后修改时间 | modified | goods_list | datetime | 是 | 是 | ||
平台货品名称 | api_goods_name | goods_list | string | 是 | 否 | ||
平台规格名称 | api_spec_name | goods_list | string | 是 | 否 | ||
货品id | goods_id | goods_list | bigint(20) | 是 | 是 | ||
商品名称 | goods_name | goods_list | string | 是 | 是 | ||
规格名称 | spec_name | goods_list | string | 是 | 是 | ||
组合装名称 | suite_name | goods_list | string | 否 | '' | 是 | |
组合装ID | suite_id | goods_list | bigint(20) | 否 | 0 | 是 | |
平台货品ID | platform_goods_id | goods_list | string | 是 | 否 | ||
平台货品编码 | api_goods_no | goods_list | string | 是 | 否 | ||
平台规格ID | platform_spec_id | goods_list | string | 是 | 否 | ||
平台规格编码 | api_spec_no | goods_list | string | 是 | 否 | ||
商品单价 | price | goods_list | decimal(19, 4) | 是 | 是 | ||
组合装价格 | suite_amount | goods_list | decimal(19, 4) | 否 | 是 | ||
主播Id | anchor_id | goods_list | string | 否 | 否 | ||
主播名称 | anchor_name | goods_list | string | 否 | 否 | ||
组合装拆合标识 | suit_flag | goods_list | int | 0标识无拆合,其他标识有拆分合并换货 | 否 | 是 | |
订单明细发货状态 | trade_status | goods_list | int | 0 未发货 1 已发货 | 否 | 是 | |
订单明细发货类型 | trade_status_type | goods_list | int | 0:无 1 平台发货 2 erp系统发货 | 否 | 是 | |
是否包装 | is_pacakge | goods_list | int | 0 否 1 是 包装 | 否 | 是 | |
异常列表 | abnormal_list | array[] | 否 | 是 | |||
异常Code值 | abnormal_code | abnormal_list | int | 异常的Code值 | 否 | 是 | |
异常名称 | abnormal_name | abnormal_list | string | 异常名称 | 否 | 是 | |
异常类型 | abnormal_type | abnormal_list | int | 异常类型 1 系统异常 2 客户自定义异常 | 否 | 是 |
4.请求示例
11