全部
淘宝
拼多多
抖音
京东
快手
当当
1688
淘工厂
小红书
有赞
微店
在线测试
获取分销订单列表(游标方式)
接口地址: http://api.vv-tool.com/tool/erps/ks-cps-list
接口介绍: 获取分销订单列表(游标方式)点击查看详情
必须用户授权 : 需要用户的授权,才能拿到被授权的数据
请求方式: GET
返回格式: JSON
接口收费: 请求次数收费,联系运营
频率限制: 10 次/秒
请求头参数
参数 | 类型 | 必选 | 值 | 示例 |
---|---|---|---|---|
Authorization | string | 是 | 授权 access_token | Bearer 1798c6aadec33d1bc2f5b707f1049aefexxxx |
请求参数
参数 | 类型 | 必选 | 描述 |
---|---|---|---|
shop_id | String | 是 | 店铺 id(可在快手小店获取) |
currentPage | Long | 是 | 当前页 |
pageSize | Integer | 是 | 每页请求数量 最多一页 80 条 |
sort | Integer | 否 | 1 时间降序 2 时间升序 默认降序 |
queryType | Integer | 否 | 1 按创建时间查找 2 按更新时间查找 默认创建时间 |
type | Integer | 否 | 订单状态,0 未知 1 全部 2 已付款 3 已收货 4 已结算 5 已失效 |
pcursor | String | 是 | 游标内容,第一次传空串,之后传上一次的 pcursor 返回值,若返回“nomore”则标识到底 |
distributorId | Long | 是 | 分销者 id |
beginTime | Long | 是 | 订单生成时间的开始时间,单位毫秒,不能小于 90 天前,且需要小于结束时间 |
endTime | Long | 是 | 订单生成时间的截止时间,单位毫秒,不能小于 90 天前,且与开始时间的时间范围不大于 1 天 (与开始时间的时间范围建议做成随时可配置,该范围可能在活动期间随时变化,比如变成小时级或者分钟级) |
vvtype | int | 否 |
请求示例
{
}
请求代码示例
cURL请求代码示例
PHP请求代码示例
JAVA请求代码示例
Pyton请求代码示例
响应参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | Integer | 1 | 返回码 |
data | MerchantOrderListData | {} | 订单列表 |
currentPage | Long | 1 | 当前页,仅第一次调用返回值有效 |
pageSize | Integer | 10 | 一页数据量 |
totalPage | Long | 10 | 总页数,仅第一次调用返回值有效 |
totalSize | Long | 100 | 总数仅第一次调用返回值有效 |
beginTime | Long | 100000 | 开始时间 |
endTime | Long | 200000 | 结束时间 |
pcursor | String | 157356441188_1 | 游标,nomore 代表分页到底 |
orderInfoList | List | {} | 订单列表 |
payTime | Long | 1543843735000 | 付款时间 |
oid | Long | 100011 | 订单号 |
sellerId | Long | 12345 | 卖家 id |
sellerNick | String | 张三 | 卖家昵称 |
expressFee | Long | 20 | 运费(单位分) |
discountFee | Long | 100 | 折扣价格(单位分) |
totalFee | Long | 1200 | 货款, 商家维度,不包括运费 计算公式为:商品总金额(price * num)- 商家承担(merchantBearAmount) |
status | Integer | 10 | 订单状态:[0, "未知状态"], [10, "待付款"], [30, "已付款"], [40, "已发货"], [50, "已签收"], [70, "订单成功"], [80, "订单失败"]; |
sendTime | Long | 1543843735000 | 发货时间 |
refundTime | Long | 1543843735000 | 退款时间(只要买家有申请退款行为) |
createTime | Long | 1543843735000 | 创建时间 |
updateTime | Long | 1543843735000 | 更新时间 |
num | Integer | 1 | sku 商品种类数 |
mobile | String | 123456789 | 收件人手机号(此字段与 address 中 mobile 意义相同,修改 address 中的 mobile,此字段值也会被修改) |
address | String | {"consignee": "不帅", "mobile": 15000000000, "provinceCode": 125620, "province": "北京", "cityCode": 100000, "city": "北京", "districtCode": 123456, "district": "", "address": "" } | {"consignee": "不帅", //收货人姓名 "mobile": 15000000000, //收货人手机 "provinceCode": 125620, //收货人省份编号 "province": "北京", //收货人省份 "cityCode": 100000, //收货人城市编码 "city": "北京", //收货人城市 "districtCode": 123456, //收货人区\县编码 "district": "", //收货人区\县 "address": "" //收货人详细地址 } |
refund | Integer | 0 | 是否申请退款 0 未申请 1 已申请(包括申请后取消) |
remark | String | 尽快发货 | 买家留言 |
sellerNoteList | List | ["请给好评","请给好评"] | 卖家备注,新备注在前 |
theDayOfDeliverGoodsTime | Long | 0 | 发货间隔时间,单位:天 |
promiseTimeStampOfDelivery | Long | 1543843735000 | 仅表示承诺发货时间 |
orderProductInfoList | List | {} | 商品品信息列表 |
id | Long | 123 | id |
oid | Long | 123 | 订单 id |
skuId | Long | 123 | 快手商品 skuid |
relSkuId | Long | 123 | 服务商商品 skuid |
skuDesc | String | null | sku 描述 |
skuNick | String | 苹果 11-白 128g | sku 编码,方便商家管理商品的编码,用于库存管理、多渠道销售分析等 |
itemId | Long | 123 | 快手商品 id |
relItemId | Long | 123 | 服务商商品 id |
itemTitle | String | 西瓜 | 商品名称 |
itemLinkUrl | String | https://... | 商品链接 |
itemPicUrl | String | https://... | 商品图片地址 |
num | Long | 11 | 成交数量 |
originalPrice | Long | 1290 | 商品促销前单价快照 以分为单位 |
discountFee | Long | 100 | 折扣金额 |
price | Long | 1190 | 商品单价快照,以分为单位 |
createTime | Long | 1543843735000 | 毫秒时间戳 |
updateTime | Long | 1543843735000 | 毫秒时间戳 |
refundId | Long | 123 | 退款订单 id |
refundStatus | Integer | 10 | 退款状态 枚举:[10, "买家仅退款申请"] [11, "买家退货退款申请"] [20, "平台介入-买家仅退款申请"] [21, "平台介入-买家退货退款申请"] [22, "平台介入-已确认退货退款"] [30, "商品回寄信息待买家更新"] [40, "商品回寄信息待卖家确认"] [50, "退款执行中"] [60, "退款成功"] [70, "退款失败"] |
itemType | Integer | 1 | 1 自建商品 2 闪电购商品 |
refundList | List | {} | 该 skuId 下的退款列表 |
refundId | Long | 123 | 退款 id |
refundStatus | Integer | 10 | 退款状态:0-未知状态;10-买家仅退款申请;11-买家退货退款申请;20-平台介入-买家仅退款申请;21-平台介入-买家退货退款申请;22-平台介入-已确认退货退款;30-商品回寄信息待买家更新;40-商品回寄信息待卖家确认;50-退款执行中;60-退款成功;70-退款失败。 |
prevInfo | MerchantOrderProductPrevView | {} | 订单修改之前的原订单信息 |
skuId | Long | 123 | 商品 skuId |
relSkuId | Long | 123 | 服务商 skuId |
skuDesc | String | skuDesc | sku 描述信息 |
skuNick | String | 苹果 11-白 128g | sku 编码,方便商家管理商品的编码,用于库存管理、多渠道销售分析等 |
cpsInfo | MerchantCpsInfoView | {} | cps 信息,若订单未支付,则无值。 |
distributorId | Long | 123 | 推广者 id |
distributorName | String | 推广者 1 号 | 推广者昵称 |
commissionRate | Long | 100 | 达人佣金率 |
estimatedIncome | Long | 3455 | 分销金额 |
platformDpRate | Long | 100 | 快手技术服务费的费率。千分比 |
logisticsInfo | MerchantLogisticsInfoView | {} | 物流信息(列表接口无此字段) |
expressNo | String | SF123 | 快递单号 |
expressCode | Integer | 123 | 快递公司 code |
activityType | Integer | 1 | 活动类型 |
cpsType | Integer | 1 | 分销类型 0-全部 1-普通订单 2-分销订单 |
payType | Integer | 1 | 支付方式 1 微信 2 支付宝 |
flagTagCode | String | grey_flag_tag_order | 插旗颜色。red_flag_tag_order:红 grey_flag_tag_order:灰 yellow_flag_tag_order:黄 green_flag_tag_order:绿 blue_flag_tag_order:蓝 purple_flag_tag_order:紫(该字段仅在获取订单详情 API 中返回,不在获取订单列表(游标方式)API 返回) |
validPromiseShipmentTimeStamp | Long | 0 | 预售发货时间/承诺发货时间(该字段仅在获取订单详情 API 中返回,不在获取订单列表(游标方式)API 返回) |
preSale | Integer | 0 | 0:非预售 1:预售(该字段仅在获取订单详情 API 中返回,不在获取订单列表(游标方式)API 返回) |
recvTime | Long | 0 | 确认收货时间(该字段仅在获取订单详情 API 中返回,不在获取订单列表(游标方式)API 返回) |
coType | Integer | 1 | 区分虚拟订单字段。JD = 1; 券包 = 2; 话费充值 = 3; 话费充值 小米 = 5; (该字段仅在获取订单详情 API 中返回,不在获取订单列表(游标方式)API 返回) |
buyerNick | String | 昵称 | 买家昵称。(该字段仅在获取订单详情 API 中返回,不在获取订单列表(游标方式)API 返回) |
commentStatus | Integer | 0 | 评价状态。0 未评价,1 评价(该字段仅在获取订单详情 API 中返回,不在获取订单列表(游标方式)API 返回) |
error_msg | String | SUCCESS | 错误码描述 |
withholding_money | Integer | 该接口扣费金额(点券) |
返回数据
{
"code": 0,
"msg": "操作成功",
"msec": 1469,
"time": 1617270403,
"data": {
"result": 1,
"data": {
"currentPage": 1,
"pageSize": 10,
"totalPage": 10,
"totalSize": 100,
"beginTime": 100000,
"endTime": 200000,
"pcursor": "157356441188_1",
"orderInfoList": [
{
"payTime": 1543843735000,
"oid": 100011,
"sellerId": 12345,
"sellerNick": "张三",
"expressFee": 20,
"discountFee": 100,
"totalFee": 1200,
"status": 10,
"sendTime": 1543843735000,
"refundTime": 1543843735000,
"createTime": 1543843735000,
"updateTime": 1543843735000,
"num": 1,
"mobile": "123456789",
"address": "{\"consignee\": \"不帅\", \"mobile\": 15000000000, \"provinceCode\": 125620, \"province\": \"北京\", \"cityCode\": 100000, \"city\": \"北京\", \"districtCode\": 123456, \"district\": \"\", \"address\": \"\" }",
"refund": 0,
"remark": "尽快发货",
"sellerNoteList": [
"请给好评",
"请给好评"
],
"theDayOfDeliverGoodsTime": 0,
"promiseTimeStampOfDelivery": 1543843735000,
"orderProductInfoList": [
{
"id": 123,
"oid": 123,
"skuId": 123,
"relSkuId": 123,
"skuDesc": "null",
"skuNick": "苹果11-白128g",
"itemId": 123,
"relItemId": 123,
"itemTitle": "西瓜",
"itemLinkUrl": "https://...",
"itemPicUrl": "https://...",
"num": 11,
"originalPrice": 1290,
"discountFee": 100,
"price": 1190,
"createTime": 1543843735000,
"updateTime": 1543843735000,
"refundId": 123,
"refundStatus": 10,
"itemType": 1,
"refundList": [
{
"refundId": 123,
"refundStatus": 10
}
],
"prevInfo": {
"skuId": 123,
"relSkuId": 123,
"skuDesc": "skuDesc",
"skuNick": "苹果11-白128g"
},
"cpsInfo": {
"distributorId": 123,
"distributorName": "推广者1号",
"commissionRate": 100,
"estimatedIncome": 3455,
"platformDpRate": 100
}
}
],
"logisticsInfo": {
"expressNo": "SF123",
"expressCode": 123
},
"activityType": 1,
"cpsType": 1,
"payType": 1,
"flagTagCode": "grey_flag_tag_order",
"validPromiseShipmentTimeStamp": 0,
"preSale": 0,
"recvTime": 0,
"coType": 1
}
]
},
"error_msg": "SUCCESS",
"withholding_money":4
}
}
响应代码
代码 | 代码描述 | 解决方案 |
---|---|---|
0 | 成功 | |
100 | 请求参数错误 | 检查您的请求参数是否正确 |
101 | 请求超时,请重试 | 检查您的网络情况或者联系客服解决 |
103 | 旺旺账号不存在 | 检查您输入的旺旺号是否正确 |
200 | 系统错误,请联系客服 | 检查您的接口地址填写是否正确,其他问题联系客服解决 |
202 | 系统错误,请稍后再试 | 稍后重试,或者联系对接群 |
203 | 暂不支持当前接口 | |
204 | 请求异常:无该接口权限,请前往官网开通正式接口。 | 前往官网开通该接口权限 |
204 | 请求异常:API 调用次数不足,请前往网站兑换次数。 | 前往官网充值该接口调用次数 |
302 | 未授权店铺 | 根据返回链接进行扫码授权 |