抖音接口
点击展开 点击收起快手接口
点击展开 点击收起拼多多接口
点击展开 点击收起京东接口
点击展开 点击收起小红书接口
点击展开 点击收起视频号接口
点击展开 点击收起淘宝接口
点击展开 点击收起|
参数名
|
类型
|
必须
|
详情描述
|
|---|
|
appkey
|
String
|
是
|
平台分配的appId
|
|
timestamp
|
Number
|
是
|
发起请求的Unix时间戳，单位为毫秒
|
|
access_token
|
String
|
是
|
访问token，所有需用户授权API使用code模式获取，不需要用户授权API使用client_credentials获取，详情参考《授权说明》文档
|
|
version
|
Number
|
是
|
请求的API版本号，目前版本为1
|
|
param
|
JSON
|
是
|
业务参数，详见下方的请求入参
|
|
method
|
String
|
是
|
请求的API英文名，详见各API定义
|
|
sign
|
String
|
是
|
API入参的签名结果参数
|
|
signMethod
|
String
|
是
|
签名算法，支持HMAC_SHA256和MD5，推荐使用HMAC_SHA256
|
|
参数名
|
类型
|
必须
|
示例值
|
详情描述
|
|---|
|
orderViewStatus
|
Integer
|
是
|
1
|
订单状态，0未知 1 全部 2
待付款 3
待发货 4 待收货（已发货）5 已收货 6 交易成功订单 7
已关闭订单
|
|
pageSize
|
Integer
|
是
|
10
|
每页请求数量 最多一页50条
|
|
sort
|
Integer
|
否
|
1
|
1时间降序 2时间升序 默认降序
|
|
queryType
|
Integer
|
否
|
1
|
1按创建时间查找 2按更新时间查找
默认创建时间
|
|
beginTime
|
Long
|
是
|
1543817629000
|
订单生成时间的开始时间，单位毫秒，
不能小于90天前，且需要小于结束时间
|
|
endTime
|
Long
|
是
|
1543817629000
|
订单生成时间的截止时间，单位毫秒，与开始时间的时间范围不大于7天
|
|
cpsType
|
Integer
|
否
|
1
|
分销类型 0-全部 1-普通订单
2-分销订单
|
|
cursor
|
String
|
是
|
157356441188_2021345676543
|
游标内容
第一次传空串，之后传上一次的cursor返回值，若返回“nomore”则标识到底
|
| 参数名 | 类型 | 示例值 | 详情描述 |
|---|---|---|---|
| code | String | 1 | 主返回码 |
| msg | String | success | 主返回信息 |
| sub_code | String | 1 | 子返回码 |
| sub_msg | String | success | 子返回信息 |
| result | Integer | 1 | 返回码，1成功 |
| error_msg | String | success | 错误信息 |
| data | OrderListData | {} | 订单列表 |
| pageSize | Integer | 10 | 一页数据量 |
| beginTime | Long | 1630987654322 | 开始时间 |
| endTime | Long | 1634567890000 | 结束时间 |
| cursor | String | 157356441188_202109654321 | 游标，nomore代表分页到底 |
| orderList | OrderList[] | [] | 订单列表 |
| orderBaseInfo | OrderBaseInfo | {} | 订单基础信息 |
| oid | Long | 20210987654327 | 订单id |
| payTime | Long | 1543843735000 | 付款时间 |
| buyerImage | String | https://tx2.a.yximgs.com/uhead/AB/2019/10/28/17/B13123213123.jpg | 买家图像 |
| buyerOpenId | String | 1234567 | 买家id |
| buyerNick | String | 赵四 | 买家昵称 |
| sellerOpenId | String | 12098765 | 卖家id |
| sellerNick | String | 张三 | 卖家昵称 |
| expressFee | Long | 10 | 运费 |
| discountFee | Long | 200 | 促销减价、折扣价格 |
| totalFee | Long | 1200 | 子订单商品总价 |
| status | Integer | 10 | 订单状态：[0, "未知状态"], [10, "待付款"], [30, "已付款"], [40, "已发货"], [50, "已签收"], [70, "订单成功"], [80, "订单失败"];订单取消会转为“订单失败”状态 |
| sendTime | Long | 1543843735000 | 发货时间 |
| refundTime | Long | 1543843735000 | 发起退款时间 |
| createTime | Long | 1543843735000 | 创建时间 |
| updateTime | Long | 1543843735000 | 更新时间 |
| remark | String | 买家留言 | 买家留言 |
| theDayOfDeliverGoodsTime | Long | 0 | 发货超时间隔时间，单位：天 |
| promiseTimeStampOfDelivery | Long | 1543843735000 | 不推荐，固定计算逻辑，订单支付时间+承诺发货时间间隔，只作为无任何特殊场景的普通商品订单的承诺发货时间点，时间戳格式 |
| activityType | Integer | 1 | 【废弃字段】新字段为allActivityType |
| cpsType | Integer | 1 | 分销类型 0-全部 1-普通订单 2-分销订单 |
| validPromiseShipmentTimeStamp | Long | 1543843735000 | 【商家承诺发货时间】 推荐使用，动态计算逻辑计算的实际商家承诺发货时间，所有场景（如普通、延迟发货报备、预售、风控、拼团、车品等）等综合对比计算出的承诺发货时间点，时间戳格式，若值为0表示订单不能发货 |
| preSale | Integer | 0 | 库存预售： 0-非预售 1-预售，该字段为库存预售，定金预售为orderStepInfo.payStepType字段 |
| recvTime | Long | 1543843735000 | 收货时间 |
| coType | Integer | 0 | [未知：0]；[券包：2]；[话费充值：3]；[跨境：8]；[预约有价优惠券：24] |
| commentStatus | Integer | 1 | 评价状态： 0未评价，1评价 |
| payType | Integer | 1 | 支付方式 0:未知, 1:微信, 2:支付宝, 3:平安, 99:银行转账. 88:支付宝先用后付 |
| riskCode | Long | 0 | 风险Code码，10001=黑产订单，不建议商家发货 |
| payChannel | String | 1 | 支付方式 |
| sellerDelayPromiseTimeStamp | Long | 1643843735000 | 商家报备审核后的发货时间，审核通过后，商家发货时效判罚标准以该时间为准 |
| priorityDelivery | Boolean | true | 是否优先发货 |
| remindShipmentSign | Integer | 3 | 催发货次数 |
| remindShipmentTime | Long | 1643843735000 | 最近催发货时间戳 |
| orderSellerRoleInfo | OrderSellerRoleInfo | {} | 订单售卖信息 |
| roleType | Integer | 1 | 售卖人角色类型：[货主：1] [达人：2] [授权号：3] |
| roleId | Long | 256787899 | 售卖人id |
| roleName | String | 小明 | 售卖人昵称 |
| disableDeliveryReasonCode | Integer[] | [1,2] | 【履约拦截标】订单阻塞发货(hold单)code码：[1:多人拼团活动进行中]、[2:支付后风控审核中]，字段有值时不允许发货 |
| multiplePiecesNo | Long | 20210987654327 | 活动订单编号 |
| allActivityType | List<Integer> | [16,17] |
【订单活动类型标】存在多个值，活动类型列表
0:未知, 1:非活动[废弃值，不要关注],
2:0元抽奖,
3:老铁团, 4:一分夺宝, 5:福袋抽奖,
6:定金预售,
7:2022暑期众筹, 8:下单返金币, 9:会员充值,
10:万人讲价, 11:万人讲价-预售版,
12:买样后返,
13:粉丝组合价, 14:搭配购, 15:尾款立减
16:顺手买一件, 17:多人拼团,
18:赠品活动-主品,
19:赠品活动-赠品 20:万人团活动, 21:三元三件 |
| orderLabels | List<Integer> | [1] | 订单标签信息：1-新疆中转 |
| enableSplitDeliveryOrder | Boolean | false | 是否支持拆单发货 |
| allowanceExpressFee | Long | 0 | 运费补贴 |
| orderItemInfo | OrderItemInfo | {} | 订单商品信息 |
| skuId | Long | 120987654 | 快手商品skuid |
| relSkuId | Long | 1209876543 | 服务商商品skuid |
| skuDesc | String | 水果 | sku商品规格快照 |
| skuNick | String | 12098765 | sku编码 |
| itemId | Long | 10987654 | 商品id |
| relItemId | Long | 120987766 | 服务商商品id |
| itemTitle | String | 西瓜 | 商品名称 |
| itemLinkUrl | String | https://... | 商品链接 |
| itemPicUrl | String | https://... | 商品图片地址 |
| num | Integer | 1 | sku数量 |
| originalPrice | Long | 1209 | 商品促销前单价快照，单位为分 |
| discountFee | Long | 100 | 折扣金额，单位为分 |
| price | Long | 1109 | 商品单价快照，单位为分 |
| itemType | Integer | 1 | 1自建商品 2 闪电购商品 |
| itemPrevInfo | OrderItemPrevInfo | {} | sku修改之前原商品信息 |
| skuId | Long | 10987654 | 商品skuId |
| relSkuId | Long | 110987654 | 服务商skuId |
| skuDesc | String | 水果 | sku描述信息 |
| skuNick | String | 12098765 | sku编码 |
| goodsCode | String | 123 | 外部货品编码 |
| warehouseCode | String | 111 | 快手仓库编码 |
| orderItemId | Long | 123 | 订单商品id，原有的id历史冗余字段。商品id请使用itemId |
| goodStoreCode | Long | 13211212321 | 电子凭证券码库ID |
| serviceInfo | ServiceInfo | {} | 服务信息 |
| serviceRule | String | {} | 服务标签 |
| freight | Boolean | true | 是否使用运费险 |
| freightProviderType | Integer | 1 | 运费险提供者类型 |
| firstOrderGuarantee | Boolean | true | 首单保障 |
| instantDelivery | Integer | 1 | 急速发货 1是 0否 |
| instantRefund | Boolean | true | 急速退款 |
| compensateFake | CompensateFake | {} | 假一赔N |
| times | Integer | 9 | 赔付倍数 |
| desc | String | 1 | 假一赔N描述 |
| link | String | 1 | 假一赔N链接 |
| serviceRuleInfo | ServiceRuleInfoDTO | {} | 服务规则 |
| depositRule | String | 1 | 保证金 0 未交 1 已交 |
| refundRule | String | 1 | 退款规则 1 7日无理由退换货 2 3 协商退款 |
| deliverGoodsIntervalTime | Long | 48000 | 发货间隔时间（单位：秒），为预售单的发货时间间隔，若不是预售单，返回值为0 |
| theDayOfDeliverGoodsTime | Long | 30 | 发货间隔时间（单位：天），为预售单的发货时间间隔，若不是预售单，返回值为0 |
| saleFlag | Boolean | true | 预售标志,true: 非预售,false: 预售 |
| promiseDeliveryTime | Long | 12 | 承诺发货时间(单位为s),24/48/72小时,-1表示不承诺 |
| deliveryMethod | String | logistics | 发货方式 logistics：物流配送（默认） certificate：电子凭证 |
| supportVerification | Integer | 1 | 是否支持核销 0：不支持 1：支持 -1：未设置 |
| certMerchantCode | String | ks | 电子凭证码商 |
| certExpireType | Integer | 11 | 电子凭证有效期类型 |
| certStartTime | Long | 1543843735000 | 电子凭证起始时间 |
| certEndTime | Long | 1543843735000 | 电子凭证截止时间 |
| certExpDays | Long | 3 | 电子凭证有效天数 |
| itemExtra | ItemExtra | {} | 扩展信息 |
| categoryInfo | CategoryInfo | {} | 类目信息 |
| itemCid | Long | 1678 | 类目id |
| categoryName | String | 鞋靴 | 名称 |
| orderRefundList | OrderRefundInfo[] | [] | 订单退款信息，返回最新的一个，若要获取当前订单关联所有退款单，可通过退款单列表API获取 |
| refundId | Long | 10987654 | 退款id |
| refundStatus | Integer | 10 | [10, "买家已经申请退款，等待卖家同意"] [12, "卖家已拒绝，等待买家处理"] [20, "协商纠纷，等待平台处理"] [30, "卖家已经同意退款，等待买家退货"] [40, "买家已经退货，等待卖家确认收货"] [45, "卖家已经发货，等待买家确认收货"] [50, "卖家已经同意退款，等待系统执行退款"] [60, "退款成功"] [70, "退款关闭"] |
| orderLogisticsInfo | OrderLogisticsInfo[] | [] | 订单物流信息，发货前也会展示物流轨迹，详情见https://edu.kwaixiaodian.com/bbs/web/article?id=19892&layoutType=4 |
| expressNo | String | SF10987654321 | 快递单号 |
| expressCode | Integer | 1234098765 | 快递公司code |
| logisticsId | Long | 1433 | 包裹id，更新订单物流信息时用做入参 |
| orderNote | OrderNote | {} | 订单插旗备注，按照创建时间逆序，最新的在第一个，最多返回30条 |
| sellerNote | String[] | [] | 【废弃字段】备注信息请使用orderNoteInfo代替 |
| orderNoteInfo | List<OrderNoteInfo> | [] | 卖家备注明细，替代sellerNote字段，最多返回30条 |
| createTime | Long | 1543843735000 | 生成备注时间，时间戳格式 |
| note | String | 注意尽快发货 | 卖家备注信息 |
| flagTagCode | String | grey_flag_tag_order | 插旗信息，2023.7.10 15:00后创建的订单有此字段数据，默认为灰色，订单旗帜编码：[red_flag_tag_order：红色],[yellow_flag_tag_order：黄色],[green_flag_tag_order：绿色],[blue_flag_tag_order：蓝色],[purple_flag_tag_order：紫色],[grey_flag_tag_order：灰色] |
| operatorName | String | 客服小鱼 | 操作人昵称 |
| orderAddress | OrderAddressInfo | {} | 订单地址信息 |
| encryptedConsignee | String | abcdef | 收货人姓名加密密文，若为空请勿发货，disableDeliveryReasonCode有值时表示履约拦截，不返回值，可查看《订单解决方案》 |
| desensitiseConsignee | String | 里* | 收货人姓名脱敏信息，用于展示，disableDeliveryReasonCode有值时表示履约拦截，不返回值 |
| encryptedMobile | String | abcdef | 收货人手机号加密密文，若为空请勿发货，disableDeliveryReasonCode有值时表示履约拦截，不返回值，可查看《订单解决方案》 |
| desensitiseMobile | String | 1********36 | 收货人手机号脱敏信息， 用于展示，disableDeliveryReasonCode有值时表示履约拦截，不返回值 |
| provinceCode | Long | 123455 | 收货省份编码 |
| province | String | 北京 | 收货省 |
| cityCode | Long | 120987 | 收货城市编码 |
| city | String | 北京 | 收货城市 |
| districtCode | Long | 10000 | 收货区编码 |
| district | String | 上地 | 收货区 |
| townCode | Long | 0 | 收货街道编码 |
| town | String | 西北旺镇 | 收货街道 |
| encryptedAddress | String | abcdef |
收货详细地址加密密文，若为空请勿发货，disableDeliveryReasonCode有值时表示履约拦截，不返回值，可查看《订单解决方案》 【返回密文存在差异】同一份数据内容经过加密后，密文会变化但检索串不会变化，即相同收货信息在不同订单中密文不同但检索串是相同的。可以通过收件人的姓名、手机号和详细地址的检索串来进行字符串匹配看是否一致。可查看《对接实践》 |
| desensitiseAddress | String | 快* | 收货详细地址脱敏信息，用于展示，disableDeliveryReasonCode有值时表示履约拦截，不返回值 |
| rechargeAccount | RechargeAccountDTO | {} | 虚拟商品充值信息 |
| account | String | 13455443333 | 手机号 |
| accountType | Integer | 1 | 账号类型 1 手机号 2 QQ号 3 微信号 |
| accountTypeDesc | String | 手机号 | 账号类型说明 |
| desensitiseAccount | String | 123****456 | 脱敏后的账号信息 |
| encryptedAccount | String | qixzosnegybvs | 加密后的账号信息 |
| orderStepInfo | OrderStepInfo | {} | 订单阶段信息 |
| orderPaymentStatus | OrderPaymentStatusInfo | {} | 阶段信息 |
| payStepType | Integer | 1 | 阶段支付类型，1定金预售 |
| orderPayStatus | Integer | 1130230 | 阶段支付状态，阶段支付类型+1+阶段一状态+2+阶段二状态拼接（1+1+30+2+30） |
| orderPaymentSteps | OrderPaymentStepInfo[] | [] | 分阶段详情 |
| id | Long | 222222 | 唯一ID |
| payStepType | Number | 1 | 阶段支付类型，1定金预售 |
| payStepNo | Number | 1 | 阶段编号，定金预售场景下：1定金，2尾款 |
| payStepName | String | 定金 | 阶段名称 |
| payStepStatus | Integer | 10 | 阶段状态:5初始化，10提单待支付、30已支付、80已关闭、90已退款 |
| stepPrice | Long | 100 | 单价 |
| skuNum | Long | 1 | 数量 |
| stepTotalPrice | Long | 1000 | 总价 stepTotalPrice= stepPrice*skuNum |
| discountFee | Long | 100 | 优惠金额（分） |
| expressFee | Long | 100 | 邮费（分） |
| paymentFee | Long | 100 | 支付金额（分） |
| payTime | Long | 1652935234000 | 支付时间 |
| payChannelDesc | String | 支付宝 | 支付渠道描述：微信，支付宝，花呗支付，花呗分期支付，平安银行，支付宝先用后付，微信先用后付 |
| startPayTime | Long | 1652935234000 | 支付开始时间 |
| endPayTime | Long | 1652935234000 | 支付结束时间 |
| orderCpsInfo | OrderCpsInfo | {} | 订单分销信息 |
| distributorId | Long | 2789928980 | 分销者的ID |
| distributorName | String | 达人小红 | 分销者名称 |
| orderDeliveryInfo | OrderDeliveryInfo | {} | 订单发货信息 |
| maxPackageNum | Integer | 10 | 总共追加包裹数量 |
| enableAppendPackage | Boolean | true | 是否可以追加包裹，为true时可追加包裹 |
| totalPackageNum | Integer | 1 | 总包裹数量，主品订单+附属单合单去重包裹数+追加包裹数，上限值50 |
| deliveryNum | Integer | 1 | 已发货商品数量，注意判断是否全部发货（值等于orderItemInfo.num表示已全部发货），必须在商家承诺发货时间前全部发货，否则商家会发货超时 |
| packageNum | Integer | 1 | 不去重包裹数量 |
| serialNumberInfo | LogisticsInfoSerialNumberInfo | {} | 发货SN/IMEI信息 |
| serialType | List<Integer> | [1, 2] |
发货时，无值不传码，有值需传码，有多个值则传多个类型的码 [1: 需要SN], [2: 需要IMEI] |
| serialNumberList | List<String> | ["1111", "222"] | 当前订单SN码列表 |
| imeiList | List<String> | ["1111", "222"] | 当前订单IMEI码列表 |
| subOrderInfo | SubOrderList[] | [] | 附属单信息，赠品订单发货必须使用拆单发货API推进到已发货状态 |
| subOrderBaseInfo | SubOrderDetailBaseInfo | {} | 附属单订单基础信息 |
| oid | Long | 1 | 附属单订单id |
| status | Integer | 10 |
附属单订单状态：[0, "未知状态"], [10,
"待付款"], [30, "已付款"], [40,
"已发货"], [50, "已签收"], [70,
"订单成功"], [80,
"订单失败"]; 订单取消后会转为“订单失败”状态 |
| sendTime | Long | 1543843735000 | 发货时间 |
| updateTime | Long | 1543843735000 | 更新时间 |
| recvTime | Long | 1543843735000 | 收货时间 |
| subOrderItemInfo | SubOrderItemInfo | {} | 附属单订单商品信息 |
| skuId | Long | 120987654 | 快手商品skuid |
| relSkuId | Long | 1209876543 | 服务商商品skuid |
| skuDesc | String | 水果 | sku商品规格快照 |
| skuNick | String | 12098765 | sku编码 |
| itemId | Long | 10987654 | 商品id |
| relItemId | Long | 120987766 | 服务商商品id |
| itemTitle | String | 西瓜 | 商品名称 |
| itemLinkUrl | String | https://... | 商品链接 |
| itemPicUrl | String | https://... | 商品图片地址 |
| num | Integer | 1 | sku数量 |
| originalPrice | Long | 1209 | 商品促销前单价快照，单位为分 |
| discountFee | Long | 100 | 折扣金额，单位为分 |
| price | Long | 1109 | 商品单价快照，单位为分 |
| itemType | Integer | 1 | 1自建商品 2 闪电购商品 |
| itemPrevInfo | OrderItemPrevInfo | {} | sku修改之前原商品信息 |
| skuId | Long | 10987654 | 商品skuId |
| relSkuId | Long | 110987654 | 服务商skuId |
| skuDesc | String | 水果 | sku描述信息 |
| skuNick | String | 12098765 | sku编码 |
| goodsCode | String | 123 | 外部货品编码 |
| warehouseCode | String | 111 | 快手仓库编码 |
| serviceInfo | ServiceInfo | {} | 服务信息 |
| serviceRule | String | {} | 服务标签 |
| freight | Boolean | true | 是否使用运费险 |
| freightProviderType | Integer | 1 | 运费险提供者类型 |
| firstOrderGuarantee | Boolean | true | 首单保障 |
| instantDelivery | Integer | 1 | 急速发货 1是 0否 |
| instantRefund | Boolean | true | 急速退款 |
| compensateFake | CompensateFake | {} | 假一赔N |
| times | Integer | 9 | 赔付倍数 |
| desc | String | 1 | 假一赔N描述 |
| link | String | 1 | 假一赔N链接 |
| serviceRuleInfo | ServiceRuleInfoDTO | {} | 服务规则 |
| depositRule | String | 1 | 保证金 0 未交 1 已交 |
| refundRule | String | 1 | 退款规则 1 7日无理由退换货 2 3 协商退款 |
| deliverGoodsIntervalTime | Long | 48000 | 发货间隔时间（单位：秒），为预售单的发货时间间隔，若不是预售单，返回值为0 |
| theDayOfDeliverGoodsTime | Long | 30 | 发货间隔时间（单位：天），为预售单的发货时间间隔，若不是预售单，返回值为0 |
| saleFlag | Boolean | true | 预售标志,true: 非预售,false: 预售 |
| promiseDeliveryTime | Long | 12 | 承诺发货时间(单位为s),24/48/72小时,-1表示不承诺 |
| deliveryMethod | String | logistics | 发货方式 logistics：物流配送（默认） certificate：电子凭证 |
| supportVerification | Integer | 1 | 是否支持核销 0：不支持 1：支持 -1：未设置 |
| certMerchantCode | String | ks | 电子凭证码商 |
| certExpireType | Integer | 11 | 电子凭证有效期类型 |
| certStartTime | Long | 1543843735000 | 电子凭证起始时间 |
| certEndTime | Long | 1543843735000 | 电子凭证截止时间 |
| certExpDays | Long | 3 | 电子凭证有效天数 |
| itemExtra | ItemExtra | {} | 扩展信息 |
| categoryInfo | CategoryInfo | {} | 类目信息 |
| itemCid | Long | 1678 | 类目id |
| categoryName | String | 鞋靴 | 名称 |
| subOrderLogisticsInfo | OrderLogisticsInfo[] | [] | 附属单物流信息 |
| expressNo | String | SF10987654321 | 快递单号 |
| expressCode | Integer | 1234098765 | 快递公司code |
| logisticsId | Long | 1433 | 包裹id，更新订单物流信息时用做入参 |
| subOrderDeliveryInfo | SubOrderDeliveryInfo | {} | 附属单发货信息 |
| deliveryNum | Integer | 1 | 已经发货的商品数量，注意判断是否全部发货（值等于subOrderItemInfo.num表示已全部发货），必须在商家承诺发货时间前全部发货，否则商家会发货超时 |
| packageNum | Integer | 1 | 包裹数量 |
| subOrderType | Integer | 0 | 附属单订单类型：2（赠品订单） |