名称 | 类型 | 必选 | 描述 |
---|---|---|---|
app_key | Long | 是 | 接入时申请的app_key |
method | String | 是 | 接口名称 |
access_token | String | 是 | Oauth2.0授权获得的access_token |
sign | String | 是 | 对 API 调用参数(除sign外)进行 md5 加密获得。参数的顺序为字母表的顺序 |
timestamp | Long | 是 | 时间戳,使用Unix时间戳格式 |
format | String | 是 | 响应格式。默认为json格式,固定 |
sign_method | String | 否 | 参数的加密方法选择,当前只支持Md5 |
version | String | 否 | API协议版本,固定值为:1.0 |
名称 | 类型 | 必选 | 描述 | 示例值 |
---|---|---|---|---|
Params
|
Object | 是 | 查询条件参数,格式如下: { startCreated: String 订单创建时间开始,格式:yyyy-MM-dd HH:mm:ss,与endCreated配对使用 endCreated: String 订单创建时间结束,格式:yyyy-MM-dd HH:mm:ss,与startCreated配对使用 startUpdated: String 订单最后更新时间开始,格式:yyyy-MM-dd HH:mm:ss,与endUpdated配对使用 endUpdated: String 订单最后更新时间结束,格式:yyyy-MM-dd HH:mm:ss,与startUpdated配对使用 orderStatus: String 交易状态,默认查询所有交易状态的数据,除了默认值外每次只能查询一种状态,非必填参数,取值:ORDER_CREATED - 已下单,ORDER_CANCELLED - 订单取消,ORDER_PAID - 已支付,ORDER_SHIPPED - 已发货,ORDER_RECEIVED - 已收货,ORDER_COMPLETED - 订单完成,ORDER_CLOSED - 订单关闭 page: Int 页码,大于零的整数,默认1,非必填 pageSize: Int 每页条数,大于零的整数,默认值:10;最大值:50,非必填 startOrderId:Long 起始id 非必填 orderBy:String 排序类型,值为 ASC 或 DESC 非必填 } 平台目前提供两种查询条件和两种翻页方式,可按需求自行组合使用: 查询条件: 1:startCreated + endCreated + orderStatus ,以订单创建时间和订单状态翻页查询 2:startUpdated + endUpdated + orderStatus ,以订单修改时间和订单状态翻页查询 翻页方式: A:page + pageSize。每页pageSize条记录,查询第page页的记录,page与pagesize的乘积不能超过5000 B:startOrderId + orderBy + pageSize,查询订单ID值大于(orderBy=ASC)或小于(orderBy=DESC)startOrderId,的pageSize条记录,无总量限制 必须一种查询条件和一种翻页方式组合使用: |
|
userId
|
Number | 是 | 用户ID |
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
result
|
Object | 搜索整体结果 | |
data
|
Object | 订单搜索返回结果 | |
hasNext
|
Boolean | 是否存在下一页 | true |
openApiOrderDetailResDtos
|
Object[] | 搜索到的交易信息列表,返回的Trade和Order中包含的具体信息为入参fields请求的字段信息 | |
openApiOrderDetailResDtos_object
|
Object | 单笔订单信息 | |
buyerAccountId
|
String | 买家账户ID,是用户登录的账号,唯一 | 山甲 |
buyerName
|
String | 买家昵称,是用户自己设置的,不唯一 | 山甲 |
buyerUserId
|
Number | 买家ID | 106482509 |
createdStr
|
String | 订单创建时间,格式:yyyy-MM-dd HH:mm:ss | 2017-11-28 12:10:17 |
isRate
|
Boolean | 订单是否已经评价 | false |
itemOrderInfos
|
Object[] | 商家级订单列表 | |
itemOrderInfos_object
|
Object | 商品级订单 | |
img
|
String | 商品图片URL(相对路径) | /mlcdn/c45406/171128_2de073jfj5ki4ld9behj7ccaaiagh_673x725.jpg |
imgUrl
|
String | 商品图片URL(绝对路径) | http://s2.mogucdn.com/mlcdn/c45406/171128_2de073jfj5ki4ld9behj7ccaaiagh_673x725.jpg |
itemCode
|
String | 商品code | |
itemId
|
String | 商品ID | 1llsd02 |
itemOrderId
|
Number | 商品级订单Id | 72654239552509 |
nowPrice
|
Number | 商品现价,需除以100 | 1 |
number
|
Number | 商品数量 | 1 |
orderStatus
|
String | 订单子状态,取值可以参考店铺级订单orderStatus取值 | ORDER_SHIPPED |
price
|
Number | 商品原价 | 1 |
refundStatus
|
String | 退款状态,取值如下: RETURN_GOODS_REQUESTED:买家发起退货,等待卖家同意 RETURN_GOODS_AGREED:卖家同意,等待买家退货 RETURN_GOODS_SHIPPED:买家发货,等待卖家收货 REFUND_REQUESTED:买家发起退款,等待卖家同意 REFUND_OR_RETURN_DEAL_AGREED:买卖家协商一致,等待资金退款 REFUND_OR_RETURN_SELLER_REFUSED:买家退款或退货被卖家拒绝 RETURN_GOODS_SELLER_DECLARE_NOT_RECEIVED:买家发货后,卖家未收到货 EFUND_COMPLETED:退款完成; REFUND_CANCELLED:退款取消 |
|
skuAttributes
|
Object[] | 商品sku描述 | |
skuAttributes_object
|
Object | 商品扩展属性 | |
key
|
String | 属性key | 颜色 |
value
|
String | 属性value | 金色 |
skuCode
|
String | 商品skuCode | |
skuId
|
String | 商品skuId | 1xgfhl8 |
title
|
String | 商品名称 | 测试普通商品 |
sellerFinal
|
Number | 卖家实收,单位:分 | |
supplyPrice
|
Number | 供货价,单位:分 | |
extraMap
|
Object | 额外信息 | |
actorId
|
Number | 主播id | |
actorName
|
String | 主播名 | |
number
|
Number | 包含的商品级订单数量 | 2 |
orderStatus
|
String | 订单状态,取值如下: ORDER_CREATED: 已下单 ORDER_CANCELLED: 订单取消 ORDER_PAID: 已支付 ORDER_SHIPPED: 已发货 ORDER_RECEIVED: 已收货 ORDER_COMPLETED: 订单完成 ORDER_CLOSED: 订单关闭 注:部分发货状态不在主状态,订单主状态还是待发货 |
ORDER_SHIPPED |
orderTags
|
String | 订单标签 | |
payOrderId
|
Number | 支付级订单ID | 72654239532509 |
payTimeStr
|
String | 订单支付时间,格式:yyyy-MM-dd HH:mm:ss | 2017-11-28 12:10:37 |
platformPromotionAmount
|
Number | 平台优惠(分) | 0 |
processResponseDTO
|
Object | 订票流程标签 | |
inputTag
|
String | 入口标识 | 0 |
itemTag
|
String | 商品标 | 0 |
itemTypeTag
|
String | 商品类目标 | 0 |
marketTag
|
String | 市场标 | 8 |
sellerTag
|
String | 卖家标 | 0 |
userTag
|
String | 买家标 | 0 |
promotionAmount
|
Number | 支付级优惠(分) | 0 |
receiveTimeStr
|
String | 订单收货时间,格式:yyyy-MM-dd HH:mm:ss | 1970-01-01 08:00:00 |
receiverAddress
|
String | 收货地址 | 零零落落零零落落了 |
receiverArea
|
String | 收货人区 | 西湖区 |
receiverCity
|
String | 收货人城市 | 杭州市 |
receiverMobile
|
String | 收货人手机 | 18202773577 |
receiverName
|
String | 收货人姓名 | 啦啦啦 |
receiverPhone
|
String | 收货人联系电话 | 18202773577 |
receiverProvince
|
String | 收货人省份 | 浙江省 |
receiverZip
|
String | 收货人邮编 | |
sellerAccountId
|
String | 卖家账户ID | 好人老三 |
sellerName
|
String | 卖家昵称 | 好人老三 |
sellerUserId
|
Number | 卖家ID | 93820149 |
shipExpense
|
String | 运费(分) | 0 |
shipExpressId
|
String | 快递编号 | 987654321 |
shipExpressName
|
String | 快递公司名 | tiantian |
shipTimeStr
|
String | 订单发货时间,格式:yyyy-MM-dd HH:mm:ss | 2017-11-28 12:16:40 |
shipType
|
Number | 发货类型,取值如下: 0 - 快递 1 - 小店卖家直接发货 2 - 海淘-转运 3 - 海淘-商业快件 4 - 虚拟交易 5 - 保税仓 |
0 |
shopOrderId
|
Number | 店铺级订单ID | 72654239542509 |
shopOrderPrice
|
Number | 订单价格(分),商品订单价格之和- 店铺优惠+shipExpense(运费) + tariff(关税)。 含运费和关税,需除以100 | 2 |
shopOrderType
|
String | 订单市场类型,包括:MOGUJIE_MARKET、DEFAULT_MARKET、GO_MARKET。 | MOGUJIE_MARKET |
shopPromotionAmount
|
Number | 店铺优惠(分) | 0 |
stageStatus
|
String | 多阶段订单的状态,目前包括:UN_PRE_PAY、WAITING_TAIL_PAY_OPEN、UN_TAIL_PAY、TAIL_PAY_SUCCESS | ORDER_SHIPPED |
extraMap
|
Object | 跨境专用,其他无需关心,这个结构是Map, 包含的Key有: idCardCode(身份证编号) idCardName(身份证名称) idCardMobile(身份证手机号) payChannelCode(支付企业编码) paymentNo(交易支付流水号) tariff(关税) declareNo(地方版支付报关流水号) declareNoZS(总署版支付报关流水号) identityCheck(跨境订单中订购人和支付人身份是否一致,T:一致;F:不一致,空为未校验) |
|
modifyPrice
|
Number | 店铺单改价差额, shopOrderPrice这是店铺单的实付价格,货款价格-店铺级别优惠+运费+关税, 如果出参中的shopOrderPrice为2,modifyPrice为1,则改价前的价格为3; 如果出参中的shopOrderPrice为70,modifyPrice为-10,则改价前的价格为60 | |
buyerFinalPrice
|
Number | 买家实付金额 | |
totalNum
|
Number | 搜索到的交易订单总数 | 7 |
status
|
Object | 查询结果状态表示 | |
code
|
String | 状态码 | 0000000 |
msg
|
String | 查询结果描述 | 调用成功 |
1)."Params": {
"startCreated":"2018-08-08 12:00:00",
"endCreated":"2018-08-08 19:00:00",
"startUpdated":null,
"endUpdated":null,
"orderStatus":"ORDER_CREATED",
"page":"1",
"pageSize":"5"
}
1).{
"result": {
"data": {
"hasNext": true,
"openApiOrderDetailResDtos": [
{
"buyerAccountId": "xx",
"buyerName": "xx",
"buyerUserId": 117602449,
"createdStr": "2016-11-01 11:01:02",
"isRate": false,
"itemOrderInfos": [
{
"img": "/p2/161028/126947059_31dkih6109aaa3akgf677lb2bh922_1024x819.jpg",
"imgUrl": "http://s11.mogucdn.com/p2/161028/126947059_31dkih6109aaa3akgf677lb2bh922_1024x819.jpg",
"itemCode": "",
"itemId": "1k4bcye",
"itemOrderId": 28705208422449,
"nowPrice": 10,
"number": 1,
"price": 100,
"refundStatus": "",
"skuAttributes": [
{
"key": "颜色",
"value": "金色"
},
{
"key": "尺码",
"value": "均码"
}
],
"skuCode": "",
"skuId": "1o5o97s",
"title": "测试商家审单"
}
],
"number": 1,
"orderStatus": "ORDER_PAID",
"orderTags": [
"WAREHOUSE"
],
"payOrderId": 28705208402449,
"payTimeStr": "2016-11-01 11:01:15",
"platformPromotionAmount": 0,
"processResponseDTO": {
"inputTag": "0",
"itemTag": "0",
"itemTypeTag": "WAREHOUSE",
"marketTag": "8",
"sellerTag": "0",
"userTag": "0"
},
"promotionAmount": 0,
"receiveTimeStr": "1970-01-01 08:00:00",
"receiverAddress": "xxxxxxxxxxxxx",
"receiverArea": "江干区",
"receiverCity": "杭州市",
"receiverMobile": "13706514233",
"receiverName": "xxx",
"receiverPhone": "13706xxx4233",
"receiverProvince": "xxx省",
"receiverZip": "310000",
"sellerAccountId": "x朋",
"sellerName": "x朋",
"sellerUserId": 126947059,
"shipExpense": "0",
"shipExpressId": "",
"shipExpressName": "",
"shipTimeStr": "1970-01-01 08:00:00",
"shipType": 0,
"shopOrderId": 28705208412449,
"shopOrderPrice": 10,
"shopOrderType": "MOGUJIE_MARKET",
"shopPromotionAmount": 0,
"stageStatus": "ORDER_PAID"
}
],
"totalNum": 4
}
},
"status": {
"code": "0000000",
"msg": "调用成功"
}
}
1).{
"result": {},
"status": {
"code": "1200001",
"msg": "该参数无结果值"
}
}