API文档 订单API yhd.orders.get

yhd.orders.get 获取订单列表

API接口描述

根据订单状态和日期类型,时间来查询订单列表信息 查询成功,返回总订单数,和相应的订单列表,查询失败,则返回相应的错误信息描述

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分钟。

应用级输入参数

名称 类型 是否必须 示例值 默认值 描述
orderStatusList String[] 订单状态(逗号分隔):
ORDER_WAIT_PAY:已下单(货款未全收)、
ORDER_PAYED:已下单(货款已收)、
ORDER_WAIT_SEND:可以发货(已送仓库)、
ORDER_ON_SENDING:已出库(货在途)、
ORDER_RECEIVED:货物用户已收到、
ORDER_FINISH:订单完成、
ORDER_CANCEL:订单取消
dateType Integer 1 1 日期类型(1:订单生成日期,2:订单付款日期,3:订单发货日期,4:订单收货日期,5:订单更新日期)
startTime String 2011-12-12 20:10:10 查询开始时间
endTime String 2011-12-12 20:10:10 查询结束时间(查询开始、结束时间跨度不能超过15天)
curPage Integer 1 1 当前页数
pageRows Integer 50 50 每页显示记录数,默认50,最大100

返回结果

名称 类型 是否必须 示例值 描述
totalCount Integer 查询成功记录数
errorCount Integer 查询失败记录数
orderList Order[] 订单信息列表
  • └ orderId
  • Long
  • 订单ID
  • └ orderCode
  • String
  • 订单编码
  • └ orderStatus
  • String
  • 订单状态:
    ORDER_WAIT_PAY:已下单(货款未全收)
    ORDER_PAYED:已下单(货款已收)
    ORDER_TRUNED_TO_DO:可以发货(已送仓库)
    ORDER_OUT_OF_WH:已出库(货在途)
    ORDER_RECEIVED:货物用户已收到
    ORDER_FINISH:订单完成
    ORDER_CANCEL:订单取消
  • └ orderAmount
  • Double
  • 订购金额(=商品总金额-优惠金额+运费,为顾客应付额,抵用券也为支付手段)
  • └ productAmount
  • Double
  • 产品总额
  • └ orderCreateTime
  • Date
  • 订单创建日期
  • └ orderDeliveryFee
  • Double
  • 运费
  • └ orderNeedInvoice
  • Integer
  • 发票需要情况:0不需要,1旧版普通,2新版普通,3增值税发票
  • └ updateTime
  • Date
  • 更新时间
  • └ invoiceTitle
  • String
  • 发票抬头
  • └ invoiceContent
  • String
  • 发票内容
  • └ endUserId
  • Long
  • 用户ID
  • └ warehouseId
  • Long
  • 仓库ID
  • └ isDepositOrder
  • Integer
  • 否为预售订单(1代表预售订单,0代表否)
  • └ isMobileOrder
  • Integer
  • 是否无线端订单(0:PC端订单;1:无线端订单)
  • └ businessType
  • Integer
  • 订单类型
  • └ orderDeposit
  • Double
  • 订单订金
  • └ depositPaidTime
  • Date
  • 订金支付时间
  • └ applyCancel
  • Integer
  • 是否为申请取消订单:1是, 0否
  • └ storeId
  • Long
  • 门店ID
  • └ storeName
  • String
  • 门店名称
  • └ externalStoreId
  • Long
  • 沃尔玛外部门店ID
  • └ deliverySupplierid
  • Long
  • 配送商id
  • └ merchantExpressNbr
  • String
  • 配送单号
  • └ orderProdType
  • Long
  • 订购商品类型
  • └ doCode
  • String
  • do号
  • └ cardNo
  • String
  • 身份证
  • └ mobile
  • String
  • 手机号
  • └ realName
  • String
  • 真实姓名
  • └ spiCode
  • String
  • 分拣号
  • └ deliverySheetCompanyName
  • String
  • 配送商名称
  • └ masterCardNo
  • String
  • 主卡权益码
  • └ childCardNo
  • String
  • 副卡权益码
  • └ paymentNo
  • String
  • 海购订单报关流水号
  • └ gatewayName
  • String
  • 网关名称
  • └ paymentTransaction
  • String
  • 海购订单支付流水号
  • └ travelBaggageTaxAmount
  • Double
  • 行邮税(进口税)金额
  • └ orderProcessStatus
  • Integer
  • orderProcessStatus 成单标志(3:O2O待商家备货成单)
  • └ orderPaymentSignal
  • Integer
  • 支付状态:1.完全支付,2.未支付,3.部分支付,4.待审核
  • └ finalStartPayTime
  • Date
  • 定金预售订单尾款开始支付时间
  • └ finalEndPayTime
  • Date
  • 定金预售订单尾款截止支付时间
  • └ purchaserTaxCode
  • String
  • 购买方税号
errInfoList ErrDetailInfo[] 错误信息列表
  • └ errorCode
  • String
  • 错误编码
  • └ errorDes
  • String
  • 错误描述
  • └ pkInfo
  • String
  • 发生错误对应的数据的关键字信息

返回示例

XML数据格式:

 
	
		
			
				5626152549
				130225Y3HJRL
				ORDER_WAIT_PAY
				123.0
				112.0
				2013-11-12 22:37:45
				11.0
				0
				2013-06-17 15:59:33
				89267177
				14039
			
			
				5626152901
				130226Y3HK3L
				ORDER_PAYED
				123.0
				112.0
				2013-11-12 22:38:20
				11.0
				0
				2013-06-17 15:59:33
				89267177
				14039
			
			
				5626152972
				130226Y3HK5T
				ORDER_TRUNED_TO_DO
				459.0
				424.0
				2013-11-12 22:39:06
				35.0
				0
				2013-12-10 16:23:23
				89267177
				14039
			
		
		61
		0
	
	
 

JSON数据格式:

{
  "response": {
    "orderList": {
      "order": [
        {
          "orderId": "5626152549",
          "orderCode": "130225Y3HJRL",
          "orderStatus": "ORDER_WAIT_PAY",
          "orderAmount": "123.0",
          "productAmount": "112.0",
          "orderCreateTime": "2013-11-12 22:37:45",
          "orderDeliveryFee": "11.0",
          "orderNeedInvoice": "0",
          "updateTime": "2013-06-17 15:59:33",
          "endUserId": "89267177",
          "warehouseId": "14039"
        },
        {
          "orderId": "5626152901",
          "orderCode": "130226Y3HK3L",
          "orderStatus": "ORDER_PAYED",
          "orderAmount": "123.0",
          "productAmount": "112.0",
          "orderCreateTime": "2013-11-12 22:38:20",
          "orderDeliveryFee": "11.0",
          "orderNeedInvoice": "0",
          "updateTime": "2013-06-17 15:59:33",
          "endUserId": "89267177",
          "warehouseId": "14039"
        },
        {
          "orderId": "5626152972",
          "orderCode": "130226Y3HK5T",
          "orderStatus": "ORDER_TRUNED_TO_DO",
          "orderAmount": "459.0",
          "productAmount": "424.0",
          "orderCreateTime": "2013-11-12 22:39:06",
          "orderDeliveryFee": "35.0",
          "orderNeedInvoice": "0",
          "updateTime": "2013-12-10 16:23:23",
          "endUserId": "89267177",
          "warehouseId": "14039"
        }
      ]
    },
    "totalCount": "61",
    "errorCount": "0"
  }
}

错误码

错误码 错误描述 解决方案
yhd.orders.get.param_invaild 参数{0}类型错误或为空 修改开始、结束时间
yhd.orders.get.param_status_invalid 订单状态有误 可选订单状态:、ORDER_WAIT_PAY、ORDER_PAYED、ORDER_WAIT_SEND、ORDER_ON_SENDING、ORDER_RECEIVED、ORDER_FINISH、ORDER_GRT、ORDER_CANCEL
yhd.orders.get.param_time_invalid 查询时间格式有误 时间格式:2011-12-1220:10:10
yhd.orders.get.param_time_range_invalid 查询开始、结束时间范围不超过15天 修改开始、结束时间
yhd.orders.get.param_time_compare_invalid 查询结束时间在开始时间之前 修改开始、结束时间
yhd.orders.get.param_time_missing 开始时间或结束时间为空 输入开始、结束时间
yhd.orders.get.param_time_status_null 开始时间或结束时间或订单状态条件为空 输入必须参数
yhd.orders.get.param_date_type_invalid 日期类型有误 日期类型可选值,1:订单生成日期,2:订单付款日期,3:订单发货日期,4:订单收货日期,5:订单更新日期
yhd.orders.get.not_found 订单列表信息不存在 更换查询条件
yhd.orders.get.error 获取订单列表信息失败 系统运行异常,请稍后再试

API工具

FAQ