推送订单 | API文档

# 推送订单

# 接口说明

项	值
URL	`/openapi/v1/order/pushOrder.json`
描述	第三方系统通过API将订单数据推送给本系统
请求方式	POST
需要登录	是
注意事项	无
其他	若orderNo已存在，则会覆盖更新数据

# 请求参数说明

字段名	字段类型	说明	是否必传
orderNo	string	订单号。不能超过48个字符	是
orderStatus	string	订单状态。详见订单状态枚举值	是
shouldPayPrice	number	订单应付金额，单位毫	是
orderCreateTime	number	下单时间。13位毫秒时间戳。默认当前时间	否
originPrice	number	订单原始金额，单位毫	否
discountPrice	number	订单优惠金额，单位毫	否
skuList	array	订单购买的sku信息。详见订单SKU对象	否
couponInfo	array	订单使用的优惠券信息。详见订单优惠券对象	否
payRecord	array	订单支付信息。详见订单支付信息对象	否
refundRecord	array	订单退款信息。详见订单退款信息对象	否
mobile	string	下单客户的手机号	否
unionId	string	下单客户微信unionId	否
gzhAppId	string	下单客户公众号appId	否
gzhOpenId	string	下单客户公众号openId	否
xcxAppId	string	下单客户小程序appId	否
xcxOpenId	string	下单客户小程序openId	否
receiveName	string	收货人姓名	否
receiveMobile	string	收货手机号	否
receiveDetail	string	收货详细完整的地址	否
userId	string	订单业绩归属用户id	否
inviteUserId	string	邀请用户id	否
dxbs	string	短训宝与第三方系统数据追踪打通参数	否
bizNum	string	子商户number。多商户模式下可指定查询具体子商户下的数据	否
customerNum	string	客户唯一编号	否

# 订单状态枚举值

枚举值	说明
wait_pay	待支付
part_pay	部分支付
paid	已支付
cancel	已取消
refund	退款中
refunded	已退款

# 订单SKU对象

字段名	字段类型	说明	是否必传
originPrice	number	SKU原始金额，单位毫	是
skuId	string	短训宝商品编号。不能超过48个字符	否
skuName	string	商品名称。不能超过128个字符	否
thumbImg	string	商品封面图地址。不能超过512个字符	否
skuCount	number	购买数量。默认为1	否
skuDetail	string	SKU快照信息	否

# 订单优惠券对象

字段名	字段类型	说明	是否必传
couponId	string	优惠券编号。不能超过48个字符	是
couponName	string	优惠券名称。不能超过128个字符	是

# 订单支付信息对象

字段名	字段类型	说明	是否必传
payStatus	string	支付状态。详见支付状态枚举值	是
payPrice	number	支付金额，单位毫	是
payChannel	number	支付方式。详见支付方式枚举值	否
payTime	number	支付时间。13位毫秒时间戳。默认当前时间	否
transaction	string	平台支付流水号。不能超过128个字符	否
createTime	number	支付记录创建时间。13位毫秒时间戳。默认当前时间	否

# 支付状态枚举值

枚举值	说明
wait_pay	待支付
paid	已支付
refunded	已退款

# 支付方式枚举值

枚举值	说明
1	微信扫码支付
2	微信APP支付
3	微信手机网站支付
4	微信公众号支付
5	微信小程序支付
6	微信当面付
7	支付宝当面付-扫码支付
8	支付宝APP支付
9	支付宝手机网站支付
10	支付宝电脑网站支付
11	线下现金支付
12	线下POS机刷卡
13	线下企微收款码
14	线下结余支付

# 订单退款信息对象

字段名	字段类型	说明	是否必传
refundPrice	number	退款金额，单位毫	是
refundStatus	string	退款状态。详见退款状态枚举值	是
refundNo	string	退款单号。不能超过48个字符	是
refundType	number	退款方式。详见退款方式枚举值	否
otherPrice	number	其他费用，单位毫	否
reason	string	退款原因。不能超过512个字符	否
remark	string	退款备注。不能超过255个字符	否
refundFailReason	string	退款失败原因。不能超过512个字符	否
refundTime	退款时间。13位毫秒时间戳。默认当前时间	否

# 退款方式枚举值

枚举值	说明
1	原路退回
2	转账

# 退款状态枚举值

枚举值	说明
wait_refund	待退款
refunded	已退款
refund_fail	退款失败

# 请求数据

{
    "orderNo": "20231222103854323000001",
    "orderStatus": "paid",
    "orderCreateTime": 1703129371116,
    "originPrice": 10000,
    "discountPrice": 4000,
    "shouldPayPrice": 6000,
    "skuList": [
      {
        "originPrice": 10000,
        "skuId": "162799182712",
        "skuName": "13天训练营",
        "thumbImg": "https://xxxxxxxxxxxxxx",
        "skuCount": 1,
        "skuDetail": "<html>xxxxxxxxx</html>"
      }
    ],
    "couponInfo": [
      {
        "couponId": "2128362782",
        "couponName": "直减券"
      }
    ],
    "payRecord": [
      {
        "payStatus": "paid",
        "payPrice": 6000,
        "payChannel": 4,
        "payTime": 1703129381116,
        "transaction": "xxxxxxxx",
        "createTime": 1703129371116
      }
    ],
    "refundRecord": []
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : null
}

← 部门直播 →