当前位置: API文档

trade_query.php(查询系统订单)

¥标准

1.接口说明

1.1 接口描述:查询ERP内订单


2.请求参数说明

  

2.1 请求地址

环境HTTP地址
测试环境http://openapitest.huice.com/openapi/trade_query.php
正式环境https://openapi.huice.com/openapi/trade_query.php


  

2.2 公共请求参数

名称字段类型长度必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString

时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
API输入参数签名结果,签名算法介绍文档中心

   

2.3 业务请求参数

名称Y字段描述
开始时间start_time修改起始时间,若无订单号/物流单号,则为必填。示例:“ 2021-11-11 00:00:00”
结束时间end_time

修改结束时间,上同开始时间。示例:“ 2021-11-11 01:00:00”

开始时间和结束时间最大间隔为3天

仓库编号

warehouse_id

仓库编号
订单状态status

若多个状态则以“,”隔开。订单状态: 已取消(可恢复) 已取消 

 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、分销补发订单
系统订单idtrade_ids系统订单id, 多个系统订单id之间使用英文逗号分隔
标旗列表remark_flags查询对应标旗的数据,标旗取值为0到5,多个之间用逗号,分隔。传入 0 表示无标旗, 1 红色 2 黄色 3 绿色 4 蓝色 5 紫色 
分页大小page_size每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为100,使用举例
页号page_no页号,不传默认从0页开始


3.响应参数

  

3.1 公共响应参数

名称字段类型长度必须描述
错误码codeint11状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
条数 total_countvarchar255符合查询条件的总数量,只有page_no = 0 时才有值。
原始单节点 tradesdata[]
业务数据的一级节点,数组形式的订单数据,需要循环读取。

  

3.2 业务响应参数


  trades



trades
array[]



名称Y字段父级字段类型枚举及 描述是否必须默认值是否可变更
系统订单idtrade_id
bigint(20)

系统订单编号trade_no
string

系统订单状态trade_status
smallint(6)4 已取消(可恢复) 5 已取消 25 特殊单 29 预订单 30 待审核(已支付) 35 待财审 50 待发货 51 待推送 52 推送中 53 推送失败 55 已推送 95 已发货   

店铺idshop_id
int(11)

店铺名称shop_name
string(128)

平台idplatform_id
int(11)

仓库idwarehouse_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返回其中一个
物流公司IDlogistics_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
int0 未打印 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[]


订单明细idrec_idgoods_listbigint(20)

平台子单号src_oidgoods_liststring
''
平台idplatform_idgoods_listint(11)

平台单号src_tidgoods_liststring

货品明细idspec_idgoods_listbigint(20)

商家编码spec_nogoods_liststring

货品编码goods_nogoods_liststring

规格码spec_codegoods_liststring

下单数量numgoods_listdecimal(19, 4)

分摊邮费share_postgoods_listdecimal(19, 4)
null
分摊后总价share_amountgoods_listdecimal(19, 4)

分摊优惠share_discountgoods_listdecimal(19, 4)

调整金额,手工改价金额adjustgoods_listdecimal(19, 4)手工改价金额 手工调整价,正数为加价,负数为减价

货品重量weightgoods_listdecimal(19, 4)单个货品重量
退款状态refund_statusgoods_listsmallint(6)0-无退款,1-取消退款,2-已申请退款,3-等待退货,4-等待收货,5-退款成功
组合装编码suite_nogoods_liststring
''
组合装数量suite_numgoods_listdecimal(19, 4)
''
赠品方式gift_typegoods_listsmallint(6)0、非赠品1、自动赠送 2、手工赠送 4、周期购赠送 8、平台赠送
备注remarkgoods_liststring

最后修改时间modifiedgoods_listdatetime

平台货品名称api_goods_namegoods_liststring

平台规格名称api_spec_namegoods_liststring

货品idgoods_idgoods_listbigint(20)

商品名称goods_namegoods_liststring

规格名称spec_namegoods_liststring

组合装名称suite_namegoods_liststring
''
组合装IDsuite_idgoods_listbigint(20)
0
平台货品IDplatform_goods_idgoods_liststring

平台货品编码api_goods_nogoods_liststring

平台规格IDplatform_spec_idgoods_liststring

平台规格编码api_spec_nogoods_liststring

商品单价pricegoods_listdecimal(19, 4)

组合装价格suite_amountgoods_listdecimal(19, 4)

主播Idanchor_idgoods_liststring

主播名称anchor_namegoods_liststring

组合装拆合标识suit_flaggoods_listint0标识无拆合,其他标识有拆分合并换货
订单明细发货状态trade_statusgoods_listint0 未发货 1 已发货
订单明细发货类型trade_status_typegoods_listint0:无 1 平台发货 2 erp系统发货
是否包装is_pacakgegoods_listint0 否 1 是 包装
异常列表abnormal_list
array[]

异常Code值abnormal_codeabnormal_listint异常的Code值
异常名称abnormal_nameabnormal_liststring异常名称
异常类型abnormal_typeabnormal_listint异常类型 1 系统异常 2 客户自定义异常



4.请求示例

11




常用工具