API文档 订单API yhd.order.detail.get

yhd.order.detail.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分钟。

应用级输入参数

名称 类型 是否必须 示例值 默认值 描述
orderCode String 订单编码

返回结果

名称 类型 是否必须 示例值 描述
totalCount Integer 查询成功记录数
errorCount Integer 查询失败记录数
orderInfo OrderInfo 订单详情
  • orderDetail
  • OrderDetail
  • 订单详细信息
  • └ 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增值税发票
  • └ goodReceiverName
  • String
  • 收货人姓名
  • └ goodReceiverAddress
  • String
  • 收货人地址
  • └ goodReceiverProvince
  • String
  • 收货人省份
  • └ goodReceiverCity
  • String
  • 收货人城市
  • └ goodReceiverCounty
  • String
  • 收货人地区
  • └ goodReceiverPostCode
  • String
  • 收货人邮编
  • └ goodReceiverPhone
  • String
  • 收货人电话
  • └ goodReceiverMoblie
  • String
  • 收货人手机号
  • └ deliveryDate
  • Date
  • 发货时间
  • └ receiveDate
  • Date
  • 确认收货时间
  • └ deliveryRemark
  • String
  • 买家留言
  • └ deliverySupplierId
  • Long
  • 配送商ID
  • └ merchantRemark
  • String
  • 卖家备注
  • └ orderPaymentConfirmDate
  • Date
  • 付款确认时间(实际付款时间)
  • └ payServiceType
  • Integer
  • 订单支付方式0:账户支付1:网上支付2:货到付款3:邮局汇款4:银行转账5:pos机6:万里通7:分期付款8:合同账期9:货到转账10:货到付支票 12:货到刷支付宝
  • └ orderPromotionDiscount
  • Double
  • 参加促销活动立减金额
  • └ merchantExpressNbr
  • String
  • 配送商送货编号(运单号)
  • └ updateTime
  • Date
  • 更新时间
  • └ orderCouponDiscount
  • Double
  • 商家抵用券支付金额
  • └ orderPlatformDiscount
  • Double
  • 1mall平台抵用券支付金额
  • └ invoiceTitle
  • String
  • 发票抬头
  • └ invoiceContent
  • String
  • 发票内容
  • └ endUserId
  • Long
  • 用户ID
  • └ realAmount
  • Double
  • 实收款==产品金额-促销活动立减金额 -商家抵用券金额+运费
  • └ warehouseId
  • Long
  • 仓库ID
  • └ isMobileOrder
  • Integer
  • 是否无线端订单(0:PC端订单;1:无线端订单)
  • └ businessType
  • Integer
  • 订单类型:0:前台普通订单1:团购订单 2:EPP订单 3:处方药订单 4:B2B订单 5:店中店代售 6:平安3g标志 10:定期购订单 11:预售订单 12:闪购 13:合约机 14:手机充值 15:选号入网 16:二手品 17:1闪团订单 18:生活团订单 19:定金预售 20:社区团订单 21:微店订单 22:OMO订单 23:跨境通海购订单 24:快拍订单 25:手机流量充值订单 26:支付宝渠道订单 27:门店订单
  • └ orderDeposit
  • Double
  • 订单订金
  • └ isDepositOrder
  • Integer
  • 是否为预售订单
  • └ depositPaidTime
  • Date
  • 订金支付时间
  • └ applyCancel
  • Integer
  • 是否为申请取消订单:1是, 0否
  • └ storeId
  • Long
  • 门店ID
  • └ storeName
  • String
  • 门店名称
  • └ externalStoreId
  • Long
  • 沃尔玛外部门店ID
  • └ collectOnDeliveryAmount
  • Double
  • 货到应收金额(订单支付方式为2、5、12时候有值)
  • └ orderProdType
  • Long
  • 订单商品类型
  • └ paymentNo
  • String
  • 海购订单报关流水号
  • └ gatewayName
  • String
  • 网关名称
  • └ paymentTransaction
  • String
  • 海购订单支付流水号
  • └ orderProcessStatus
  • Integer
  • 成单标志(3:O2O待商家备货成单)
  • └ depositDiscount
  • Double
  • 定金抵用金额
  • └ purchaserTaxCode
  • String
  • 购买方税号
  • orderItemList
  • OrderItem[]
  • 订单明细
  • └ id
  • Long
  • 订单明细ID
  • └ orderId
  • Long
  • 订单ID
  • └ productCName
  • String
  • 产品名称
  • └ orderItemAmount
  • Double
  • 金额
  • └ orderItemNum
  • Integer
  • 数量
  • └ orderItemPrice
  • Double
  • 单价
  • └ originalPrice
  • Double
  • 产品原价
  • └ productId
  • Long
  • 产品id
  • └ groupFlag
  • Integer
  • 团购产品标识,1表示团购产品,0表示非团购产品
  • └ merchantId
  • Long
  • 商家id
  • └ processFinishDate
  • Date
  • 退换货完成时间
  • └ updateTime
  • Date
  • 更新时间
  • └ outerId
  • String
  • 产品外部编码
  • └ deliveryFeeAmount
  • Double
  • 商品运费分摊金额
  • └ promotionAmount
  • Double
  • 促销活动立减分摊金额
  • └ couponAmountMerchant
  • Double
  • 商家抵用券分摊金额
  • └ couponPlatformDiscount
  • Double
  • 1mall平台抵用券分摊金额
  • └ subsidyAmount
  • Double
  • 节能补贴金额
  • └ productDeposit
  • Double
  • 单品订金金额
  • └ discountAmount
  • Double
  • 折扣金额
  • └ isGift
  • Integer
  • 是否赠品,0表示不是,1表示试用中心赠品,2表示送赠品、换购赠品,4表示试用品
errInfoList ErrDetailInfo[] 错误信息列表
  • └ errorCode
  • String
  • 错误编码
  • └ errorDes
  • String
  • 错误描述
  • └ pkInfo
  • String
  • 发生错误对应的数据的关键字信息

返回示例

XML数据格式:

 
	
		
			
				5626152549
				130225Y3HJRL
				ORDER_WAIT_PAY
				123.0
				112.0
				123.0
				2013-11-12 22:37:45
				11.0
				0
				王慧
				asafdsfds
				广东
				广州市
				增城市
				511300
				13545010404
				15102771817
				2013-02-25 20:34:10
				0
				0.0
				999999
				王慧测试备注111**2951***1111
				2013-06-17 15:59:33
				0.0
				0.0
				89267177
				14039
			
			
				
					56560500606
					5626152549
					112.0
					1
					112.0
					你我他 王慧测试帽子20130131单品001
					1800638
					112.0
					9063
					2013-02-26 09:52:54
					0
					11.0
					0.0
					0.0
					0.0
					0.0
				
			
		
		1
		0
	
	
 

JSON数据格式:

{
  "response": {
    "orderInfo": {
      "orderDetail": {
        "orderId": "5626152549",
        "orderCode": "130225Y3HJRL",
        "orderStatus": "ORDER_WAIT_PAY",
        "orderAmount": "123.0",
        "productAmount": "112.0",
        "realAmount": "123.0",
        "orderCreateTime": "2013-11-12 22:37:45",
        "orderDeliveryFee": "11.0",
        "orderNeedInvoice": "0",
        "goodReceiverName": "王慧",
        "goodReceiverAddress": "asafdsfds",
        "goodReceiverProvince": "广东",
        "goodReceiverCity": "广州市",
        "goodReceiverCounty": "增城市",
        "goodReceiverPostCode": "511300",
        "goodReceiverPhone": "13545010404",
        "goodReceiverMoblie": "15102771817",
        "orderPaymentConfirmDate": "2013-02-25 20:34:10",
        "payServiceType": "0",
        "orderPromotionDiscount": "0.0",
        "deliverySupplierId": "999999",
        "merchantRemark": "王慧测试备注111**2951***1111",
        "updateTime": "2013-06-17 15:59:33",
        "orderCouponDiscount": "0.0",
        "orderPlatformDiscount": "0.0",
        "endUserId": "89267177",
        "warehouseId": "14039"
      },
      "orderItemList": {
        "orderItem": {
          "id": "56560500606",
          "orderId": "5626152549",
          "orderItemAmount": "112.0",
          "orderItemNum": "1",
          "orderItemPrice": "112.0",
          "productCName": "你我他 王慧测试帽子20130131单品001",
          "productId": "1800638",
          "originalPrice": "112.0",
          "merchantId": "9063",
          "updateTime": "2013-02-26 09:52:54",
          "groupFlag": "0",
          "deliveryFeeAmount": "11.0",
          "promotionAmount": "0.0",
          "couponAmountMerchant": "0.0",
          "couponPlatformDiscount": "0.0",
          "subsidyAmount": "0.0"
        }
      }
    },
    "totalCount": "1",
    "errorCount": "0"
  }
}

错误码

错误码 错误描述 解决方案
yhd.order.detail.get.param_missing 订单编码为空 输入订单编码信息
yhd.order.detail.get.not_found 订单编码{0}不存在 检查订单编码是否输入有误
yhd.order.detail.get.error 获取单个订单的详细信息失败 系统运行异常,请稍后再试

API工具

FAQ