API 列表

xiaodian.trade.sold.get

  • 免费
  • 需要授权

API功能描述(支持get和post)

查询卖家已卖出的交易数据

公共参数

名称 类型 必选 描述
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 是 openApiOrderDetailReqDto
json格式如下：
{
    "startCreated": "2016-03-01 11:00:00",
    "endCreated": "2016-03-02 11:00:00",
    "startUpdated": "2016-03-01 11:00:00",
    "endUpdated": "2016-03-02 11:00:00",
    "orderStatus": "ORDER_CREATED",
    "page": 1,
    "pageSize": 10
}
前四项的日期格式 格式:yyyy-MM-dd HH:mm:ss。create 和update 的开始结束日期二选一输入， 优先按照create时间查询。选定一组后，另一组为非必填。orderStatus ： String  非必填参数。交易状态，默认查询所有交易状态的数据，除了默认值外每次只能查询一种状态。"ORDER_CREATED": "已下单","ORDER_CANCELLED": "订单取消","ORDER_PAID": "已支付","ORDER_SHIPPED": "已发货","ORDER_RECEIVED": "已收货","ORDER_COMPLETED": "订单完成","ORDER_CLOSED": "订单关闭"page ： Integer  非必填   页码。取值范围:大于零的整数; 默认值:1pageSize : Integer 非必填  每页条数。取值范围:大于零的整数; 默认值:10;最大值:30

返回参数

名称 类型 描述 默认值
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 订单子状态 ORDER_SHIPPED
price Number 商品原价，需要除以100 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 商品名称 测试普通商品
distributorNickName String 分销员名称
distributorTel String 分销员手机号
distributorId Number 分销员Id
distributorUserId Number 分销员用户Id
thirdInnerId String 分销员的员工标识ID
distributorThirdName String 员工姓名
distributorArea String 分销员所在地区
sellerFinalPrice Number 商品级订单卖家实收金额，含平台补贴+买家实付，不包含运费（分）
distriCommissionAmount String 本单分销佣金（元)
inviteCommissionAmount String 本单邀请佣金（元)
realPrice String 本单真实付款（元)（计算佣金后的金额）,三方定制字段，勿用
distributorWechatId String 分销员微信号
distributorShopCode String 分销员所在店铺编码
distributorRemark String 分销员备注
distributorParentName String 分销员邀请人昵称
isDistributeOrder String 是否分销订单：0-否，1-是
skuDistriCommissionAmount String 单个sku商品的分销佣金（元)，skuDistriCommissionAmount = distriCommissionAmount / number;
skuInviteCommissionAmount String 单个sku商品的邀请佣金（元)，skuInviteCommissionAmount = inviteCommissionAmount / number;
skuRealPrice String 单个sku真实付款（元)
brand String 商品品牌
supplier String 商品供应商
skuCustomerRealPrice String 第三方定制订单实际付款金额
integralNum Number 本笔商品订单消费的积分
shopPromotionAmount Number 本单的店铺级优惠分摊金额（分）
itemPromotionAmountSingle Number 单个商品的商品级优惠金额（分）
outLetCode String 门店编码
customExtra String 商家扩展字段json格式，请使用map解析，具体格式单独约定
thirdOutletCode String 三方门店编码
itemOrderPromotionDetail Object 商品单优惠明细，含商品级优惠、店铺级分摊优惠、支付级分摊优惠； JSON 格式，请使用Map解析。key-String（优惠类型），value-Long（优惠金额/分）；以下为优惠枚举： TradePintuanResource - 商品级 - 拼团， TradeTimeLimitDiscountResource - 商品级 - 限时折扣， DepositExpand - 商品级 - 定金膨胀， Bargain - 商品级 - 砍价， TradeFullCut - 店铺级 - 满元减元， TradeFullAmountCutPrice - 店铺级 - 满件减元， TradeFullAmountDiscount - 店铺级 - 满件打折， TradePackagingSell - 店铺级 - 打包卖， IntegralDeduction - 店铺级 - 积分抵扣， TradeShopCouponResource - 店铺级 - 店铺优惠券， FriendsDivisibleCoupon - 店铺级 - 好友瓜分券（优惠券）， FissionCoupon - 店铺级 - 裂变优惠券（优惠券）， TradeModifyOrder - 店铺级 - 订单改价， TradePlatformCouponResource - 支付级 - 平台优惠券，
standardCode String 提供第三方映射的sku的code
actualPrice String  商品的实付款金额 ,分摊后计算出来的实际金额
sharePromotionPrice String 商品的分摊优惠金额 (优惠券等优惠分摊到每个商品的优惠金额)
refundCashAmount Number 退款现金额度
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
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
payTransactionId String 微信支付流水号 微信支付流水号
unionId String 用户的微信unionId 微信unionId
bindMobile String 用户绑定的手机号 用户绑定的手机号
realPrice String 订单实际付款金额（计算佣金后的金额） 0
distributorNickName String 分销员名称
distributorTel String 分销员手机号
distributorId Number 分销员Id
distributorUserId Number 分销员用户Id
thirdInnerId String 分销员的员工标识ID
distributorThirdName String 分销员员工姓名
distributorArea String 分销员所在地区
distributorWechatId String 分销员微信号
distributorShopCode String 分销员所在店铺编码
distributorRemark String 分销员备注
distributorParentName String 分销员邀请人昵称
isDistributeOrder String 是否分销订单：0-否，1-是
integralNum Number 本笔订单使用的积分数
outLetCode String 门店编码
customExtra String 商家扩展字段json格式，请使用map解析，具体格式单独约定
buyerComment String 买家备注
sellerComment String 卖家备注
updatedStr String 订单更新时间格式yyyy-MM-dd HH:mm:ss
vipName String 会员等级名称
receiverAreaCode String 收货人区对应的code
receiverCityCode String 收货人市对应的code
receiverProvinceCode String 收货人省对应的code
thirdMemberId String 第三方会员卡号
customerRealPrice String 第三方定制订单实际付款金额
totalNum Number 搜索到的交易订单总数 7
status Object 查询结果状态表示
code String 状态码 0000000
msg String 查询结果描述 调用成功

请求参数示例

1).
{
	"Params": {
		"endCreated": "2020-11-04 18:04:02",
		"pageSize": "50",
		"page": "1",
		"startCreated": "2020-11-04 18:02:02"
	}
}
2).
{
  "Params": {},
  "userId": ""
}

返回示例

1).
{
    "result": {
        "data": {
            "hasNext": true,
            "openApiOrderDetailResDtos": [
                {
                    "buyerAccountId": "xx",
                    "buyerName": "xx",
                    "buyerUserId": 117602449,
                    "createdStr": "2016-11-01 11:01:02",
                    "updatedStr": "2016-11-02 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,
"skuCustomRealPrice":1,
                            "brand": "",
                            "supplier":"",
                            "refundStatus": "",
                            "skuAttributes": [
                                {
                                    "key": "颜色",
                                    "value": "金色"
                                },
                                {
                                    "key": "尺码",
                                    "value": "均码"
                                }
                            ],
			"customExtra": {
					"channel": "17326075128",
					"orderFrom": "A0000001",
                                        "prizeChannel": 1
				},
                            "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,
"realPrice":10,
"customRealPrice":1,
                    "shopOrderType": "MOGUJIE_MARKET",
                    "shopPromotionAmount": 0,
                    "stageStatus": "ORDER_PAID"
                }
            ],
            "totalNum": 4
        }
    },
    "status": {
        "code": "0000000",
        "msg": "调用成功"
    }
}

异常示例

1).

                {
                "result": {},
                "status": {
                "code": "1200001",
                "msg": "该参数无结果值"
                }
                }

API测试工具