API文档 供应商订单API yhd.supplier.history.orders.get

yhd.supplier.history.orders.get 查询历史订单列表

API接口描述

通过指定的查询条件查询历史订单列表。查询成功,则返回查询成功记录数以及订单信息;查询失败,则返回相应的错误描述信息。
注意:如果不输入时间参数,则默认查询2个月前创建的已完成或已取消的订单,时间间隔一个月。

API用户授权类型

需要

系统级别输入参数

名称 类型 是否必须 描述
appKey String 分配给应用的AppKey
sessionKey String 分配给用户的SessionKey,用户通过登录授权获取。
注:是否必须请参考【API用户授权类型】
sign String 输入参数签名,签名算法介绍请点击这里
format String 返回数据格式 xml/json
ver String 接口版本1.0
method String 接口名称
timestamp String 时间戳,格式为yyyy-MM-dd HH:mm:ss,服务端允许客户端请求时间误差为10分钟。

应用级输入参数

名称 类型 是否必须 示例值 默认值 描述
orderCode String 订单编码
orderStartTime String 2012-10-10 订单开始时间(必须与结束时间同时给出或者都不给出,时间间隔不得大于31天)
orderEndTime String 2012-10-10 订单结束时间(必须与开始时间同时给出或者都不给出,时间间隔不得大于31天)
orderStatus Integer 1 订单状态(1:待发货,2:已发货,3:用户已收到货,4:已完成,5:订单已关闭,6:退换货,7:未支付)
goodReceiverName String 收货人名称
goodReceiverMobile String 收货人手机号码
pageRows Integer 10 20 分页查询每页的个数
curPage Integer 1 1 分页查询第几页
updateStartTime String 2012-10-10 订单更新开始时间(必须与结束时间同时给出或者都不给出,时间间隔不得大于31天)
updataEndTime String 2012-10-10 订单更新结束时间(必须与开始时间同时给出或者都不给出,时间间隔不得大于31天)

返回结果

名称 类型 是否必须 示例值 描述
totalCount Integer 查询成功记录数
errorCount Integer 查询失败记录数
errInfoList ErrDetailInfo[] 错误信息列表
  • └ errorCode
  • String
  • 错误编码
  • └ errorDes
  • String
  • 错误描述
  • └ pkInfo
  • String
  • 发生错误对应的数据的关键字信息
orderDetailInfoList OrderDetailInfo[] 历史订单列表
  • └ id
  • Long
  • 123
  • 订单Id
  • └ orderAmount
  • Double
  • 订购金额=商品金额+运费-优惠,即为顾客应付款(抵用券属于支付手段)
  • └ orderCode
  • String
  • 123FDG23
  • 订单编号
  • └ isB2CDirect
  • Integer
  • 是否是直发订单(0:不是,1:是)
  • └ endUserId
  • Long
  • 用户ID
  • └ orderDeliveryFee
  • Double
  • 运费
  • └ orderCreateTime
  • Date
  • 订单创建日期
  • └ orderDeliveryPerson
  • String
  • 投递人
  • └ orderNeedInvoice
  • Integer
  • 发票需要情况(0:不需要,1:旧版普通,2:新版普通,3:增值税发票)
  • └ goodReceiverName
  • String
  • 收货人姓名
  • └ goodReceiverAddress
  • String
  • 收货人地址
  • └ goodReceiverProvince
  • String
  • 收货人省份
  • └ goodReceiverCity
  • String
  • 收货人城市
  • └ goodReceiverCounty
  • String
  • 收货人地区
  • └ goodReceiverPhone
  • String
  • 收货人电话
  • └ goodReceiverMobile
  • String
  • 收货人手机号
  • └ orderDeliveryPersonMobile
  • String
  • 配送员手机号
  • └ deliveryRemark
  • String
  • 发货备注
  • └ businessType
  • Integer
  • 订单类型(0:前台普通订单,1:团购订单,2:EPP订单,3:处方药订单,4:B2B订单,5:店中店代售,6:平安3g标志,10:定期购订单)
  • └ deliveryMethodType
  • Integer
  • 配送方式类型 {10001:普通快递、20001:EMS、30001:供应商直送、40001:自提、30002:店中店商家直送}
  • └ orderStatus
  • Integer
  • 订单状态(1:待发货,2:已发货,3:用户已收到货,4:已完成,5:订单已关闭,6:退换货,7:未支付)
  • └ orderUpdateTime
  • Date
  • 订单更新时间
  • └ invoiceTitle
  • String
  • 发票抬头
  • └ invoiceContent
  • String
  • 发票内容
  • └ realAmount
  • Double
  • 实收款=产品金额-促销活动立减金额-商家抵用卷金额+运费
  • └ productAmount
  • Double
  • 产品总额=定购金额-运费
  • └ goodReceiverPostCode
  • String
  • 收货人邮编
  • └ purchaserTaxCode
  • String
  • 购买人税号

返回示例

XML数据格式:

 

	
		
			5626130378
			80.0
			121126B3GV3R
			38
			0
			73788431
			0.0
			2013-06-13 00:00:00
			0
			0
			chujie001
			中国人民解 where order_id = 21954109放
			上海
			黄浦区
			延安东路区域
			15511111111
发票抬头
发票内容
90
90
		
	
	1
	0
 

JSON数据格式:

{"response":{"orderDetailInfoList":{"orderDetailInfo":[{"id":5626130378,"orderAmount":80.0,"orderCode":"121126B3GV3R","orderStatus":38,"isB2CDirect":0,"endUserId":73788431,"orderDeliveryFee":0.0,"orderCreateTime":"2013-06-13 00:00:00","orderDeliveryPerson":"0","orderNeedInvoice":0,"goodReceiverName":"chujie001","goodReceiverAddress":"中国人民解 where order_id = 21954109放","goodReceiverProvince":"上海","goodReceiverCity":"黄浦区","goodReceiverCounty":"延安东路区域","goodReceiverMobile":"15511111111","invoiceTitle":"发票抬头","invoiceContent":"发
票内容","realAmount":"90","productAmount":"90"}]},"totalCount":1,"errorCount":0}}

错误码

错误码 错误描述 解决方案
yhd.supplier.history.orders.get.param_invalid 历史订单查询输入参数有误 检查入参格式是否符合规范
yhd.supplier.history.orders.get.system_error 历史订单查询服务异常 系统运行异常,请稍后再试
yhd.supplier.history.orders.date.convert.date_invalid 日期输入参数有误 根据相应的错误提示信息修改输入参数

API工具

FAQ