退款单创建

POST

/OrderRefundCreateExtension

特殊说明：该接口需保证幂等，执行异常时，上游会进行重试，可使用 refundId 作为幂等键

请求参数

Body 参数application/json

rootKdtId

integer <int64>

有赞店铺总部Id

必需

appId

string

必需

应用厂商标识appId

globalProps

object (Map«Object»)

全局变量

必需

key

object (key)

可选

extendMap

object (Map«Object»)

必需

上下文扩展信息，透传信息key

key

object (key)

可选

refundOrderItem

array[object (RefundOrderItem) {7}]

退款子订单信息

可选

oid

string

退款明细id

可选

outOid

string

外部订单ID

可选

refundFee

integer <int64>

可选

退款金额单位：分；金额包含邮费

itemNum

integer

退款商品数量

可选

shipped

boolean

是否已发货

可选

subOrderItemNum

integer

子订单商品数量

可选

itemIdentity

object (ItemIdentity)

商品身份

可选

refundFunds

array[object (RefundFund) {7}]

退款资金信息

可选

status

integer

可选

退款资金状态。0:退款中,1:退款失败,2:退款成功

refundId

string

退款ID

可选

payWay

integer

可选

支付渠道。0:默认值,未支付,1:微信自有支付,2:支付宝wap,3:支付宝wap,5:财付通,7:代付,8:联动优势,9:货到付款,10:大账号代销,11:受理模式,12:百付宝,13:sdk支付,14:合并付货款,15:领取赠品,16:优惠兑换,17:自动付货款,18:爱学贷,19:微信wap,20:微信红包支付,21:返利,22:ump红包,24:易宝支付,25:储值卡,27:qq支付,28:有赞E卡支付,29:微信条码,30:支付宝条码,33:礼品卡支付,35:会员余额,36:信用卡银联支付,37:储蓄卡银联支付,40:分期支付,72:微信扫码二维码支付,80:待结算&余额支付,90:礼品卡支付,100:代收账户,300:储值账户,400:保证金账户,101:收款码,102:微信,103:支付宝,104:刷卡,105:二维码台卡,106:储值卡,107:有赞E卡,110:标记收款-自有微信支付,111:标记收款-自有支付宝,112:标记收款-自有POS刷卡,113:通联刷卡支付,114:标记收款-自定义,115:有赞零钱支付,116:优惠全额抵扣,117:商米支付,118:商米支付-支付宝,119:商米pos,200:记账账户,201:现金,202:组合支付,203:外部支付,204:汇款支付

message

string

错误信息

可选

refundMode

integer

可选

退款模式。0:原路退,1:现金退,2:标记退

refundNo

string

退款流水号

可选

refundFee

integer <int64>

可选

退款金额，单位：分；金额包含邮费

modified

string

可选

售后申请修改时间，时间格式：yyyy-MM-dd HH:mm:ss

desc

string

售后说明

可选

refundTicketNum

integer

可选

退款卡券数量。仅在卡券订单退款时有值

consultMessages

array[object (ConsultMessage) {3}]

凭证信息

可选

kdtId

integer <int64>

店铺id

可选

orderNo

string

订单号

可选

attachment

array[string]

凭证

可选

kdtId

integer <int64>

可选

店铺在有赞的id标识，有赞平台生成，在有赞平台唯一，用于判断信息属于哪一个店铺

demand

integer

可选

退款诉求。1.仅退款；2.退货退款；3.换货

refundTicketList

array[string]

退款卡券ID列表

可选

refundFee

integer <int64>

可选

退款金额，单位：分。金额包含邮费

refundFundDesc

string

退款资金说明

可选

created

string

可选

售后申请时间，时间格式：yyyy-MM-dd HH:mm:ss

returnGoods

boolean

可选

是否有退货，true：是，false：否。如果没有退货返回是false

reason

integer

可选

售后申请原因，(仅退款-已收到货申请原因) 0:商家主动退款;1: 买/卖双方协商一致;2: 买错/多买/不想要;3: 商品质量问题;4: 未收到货品';5: 做工粗糙/有瑕疵;11:
质量问题;12: 拍错/多拍/不喜欢;13: 商品描述不符;14: 假货;15: 商家发错货;16: 商品破损/少件;17: 其他;18: 仅退款(收到货)-退运费;19:
协商一致退款;20: 快递一直未送达;21: 未按约定时间发货;22: 拍错/不想要;23: 计划有变无法使用;24: 商家降价; (仅退款-未收到货申请原因) 25:非正品 51:
买错/多买/不想要;52: 快递无记录;53: 少货/空包裹;54: 未按约定时间发货;55: 快递一直未送达;56: 其他;57: 拍错/多拍/不喜欢;58:
(退货退款-申请原因)协商一致退款; 59: 同城订单商家手动拒单;60:仅退款(未收到货) -地址/电话填错了 ;61:仅退款(未收到货) -送达时间选错了;101:
商品破损/少件;102: 商家发错货;103: 商品描述不符;104: 拍错/多拍/不喜欢;105: 质量问题;106: 假货;107: 其他;108: 做工粗糙/有瑕疵;109:
非正品;110: (系统退款原因) 未按约定时间发货;111:退货退款-退运费;112:7天无理由退货;201: 返现退款;202:203:拼团订单扣库存失败退款;
酒店拒单退款;204: 订单关闭退款;205: 代付过期退款;206: 超付退款;207: 外卖拒单退款;208: 拼团未成团退款;209: 团购返现退款;210:美业退款;211:
订单少付退款;212:
小程序拼团退款;213:送礼子订单未被领取退款;214:超付+本金组合退款;215:送礼社群版到期自动退款;216:上云商家一键退款类型;217:群团购团长审核不通过退款;218:群团购未成团退款;219:会员卡发卡失败退款;220:同城订单超时未接单自动关单;221:差价退款;222:重复购买退款;223:教育线上重复购买退款;301:换货-商家发错商品;302:换货-大小/颜色/型号不合适;303:换货-商品损坏;304:换货-其他;401:酒店退款-行程取消;402:酒店退款-信息填错;403:酒店退款-前台价格更优惠;404:酒店退款-其他渠道更便宜;405:酒店退款-对酒店环境不满意;406:酒店退款-卖家告诉满房;407:酒店退款-买多了/买错了/计划有变;408:酒店退款-想要预约的日期预约不上;409:酒店退款-直接预订的价格比使用预售券更优惠;410:酒店退款-预约时联系不上商家;411:酒店退款-商品信息与实际信息不符;412:酒店退款-其他.

refundAccountTime

string <date-time>

退款到账时间

可选

refundPostage

integer <int64>

可选

退还的邮费，单位:分

logistics

object (Logistics)

物流信息

可选

companyCode

string

可选

物流id，物流公司在有赞入驻后，有赞生成的唯一物流公司id，请访问https://developers.youzanyun.com/article/1556781458693

address

string

收件人地址

可选

logisticsNo

string

可选

物流单号，即物流公司的快递单号，请填写准确，真实的快递单号。

mobile

string

收件人电话

可选

receiver

string

收件人

可选

version

integer <int64>

可选

售后版本号，用于售后单相关操接口的入参传入。（version由售后单创建时有赞自动生成）

oid

string

可选

第一个退款商品的订单明细ID，即子订单号，19位随机数字组合，用于判断判断子订单是否发货，退款场景等。对应父级字段tid。一笔订单多种商品对应多个子订单号，按照订单中商品种类生成，不根据商品数量生成（例：一笔订单有3种商品数量6个分别是：香蕉1个，苹果2个，橙子3个，会生成3个子订单号），用于判断判断子订单是否发货，退款场景等。请使用订单api【youzan.trades.sold.get】【youzan.trade.get.4.0.0】获取该字段。如果有多个退款商品，要获取对应商品的oid，可以通过refund_order_item中的oid来获取

refundId

string

可选

维权ID（售后单编号），售后申请时有赞系统自动生成一串数字组合，生成规则：年月日时分秒+10位随机数，用于确认售后详情，使用【youzan.trade.refund.search】【youzan.trade.get】接口可以获取。

outRefundId

string

外部维权单id

可选

refundType

string

可选

退款类型：
BUYER_APPLY_REFUND(买家申请退款)，SELLER_REFUND（商家主动退款），EXCHANGE_GOODS(买家申请换货)，SYSTEM_REFUND（一键退款，特殊类型退款。如超卖，支付回调超时）

status

string

可选

售后状态: WAIT_SELLER_AGREE-买家已经申请退款，等待卖家同意; WAIT_BUYER_RETURN_GOODS-卖家已经同意退款，等待买家退货;
WAIT_SELLER_CONFIRM_GOODS-买家已经退货，等待卖家确认收货; SELLER_REFUSE_BUYER-卖家拒绝退款;
SELLER_REFUSE_BUYER_RETURN_GOODS-卖家未收到货,拒绝退款 ;
SELLER_RETURN_GOODS-商家确认收货并发送换货;CLOSED-退款关闭;SUCCESS-退款成功;

orderInfo

object (OrderInfo)

主订单信息

可选

tid

string

可选

有赞订单号，E开头长度24位字母和数字组合

outTid

string

外部订单号

可选

payType

integer

支付类型

可选

expressType

integer

可选

配送方式（物流类型）， 0:快递发货; 1:到店自提; 2:同城配送; 9:无需发货（虚拟商品订单）

type

integer

可选

主订单类型；0:普通订单; 1:送礼订单; 2:代付; 3:供货商查询时返回表示为分销供货单。; 4:赠品; 5:心愿单; 6:二维码订单; 7:合并付货款; 8:1分钱实名认证;
9:品鉴; 10:拼团; 15:返利; 35:酒店; 40:外卖; 41:堂食点餐; 46:外卖买单; 51:全员开店; 61:线下收银台订单; 71:美业预约单; 72:美业服务单;
75:知识付费; 81:礼品卡;85：直播带货订单（仅指爱逛平台产生的订单）;89-样品订单;100:批发

refundState

integer

可选

订单退款状态； 0:未退款， 2:部分退款成功， 12:全额退款成功。瞬时状态1:部分退款中，11:全额退款中；当查询接口返回1或11状态时，建议重试查询直到出现0、2、12状态为止

updateTime

string <date-time>

可选

订单更新时间，时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒

consignTime

string <date-time>

可选

订单发货时间（当所有商品发货后才会更新），时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒

payTime

string <date-time>

可选

订单支付时间，时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒

successTime

string <date-time>

可选

交易完成时间，时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒

closeType

integer

可选

订单关闭类型 0:未关闭; 1:过期关闭; 2:标记退款; 3:订单取消; 4:买家取消; 5:卖家取消; 6:部分退款; 10:无法联系上买家; 11:买家误拍或重拍了;
12:买家无诚意完成交易; 13:已通过银行线下汇款; 14:已通过同城见面交易; 15:已通过货到付款交易; 16:已通过网上银行直接汇款; 17:已经缺货无法交易; 18:扣款失败;
19:0元关单; 20:社区团购活动结束未付款; 21:0元抽奖订单未中一等奖; 22:拒单退款;

payTypeStr

string

可选

channelType

integer

可选

渠道类型，订单渠道来源；0:有赞内部系统,10:饿了么餐饮系统,20:美团餐饮系统,30:餐道,40:管易,41:宠物家,50:微信小商店,60:伯俊,70:好福兜,80:美创,90:王府井,
91:腾讯慧聚,100:CRM 订单导入后不在有赞商城里面展示，也不能对其进行操作，只在CRM里面展示,
110:通用三方适用于大客、ERP等导入，订单导入后会在有赞商城后台展示，商家能够操作发、退款等,120:饿了么餐饮系统"

status

string

可选

正向状态：主订单状态： WAIT_BUYER_PAY：等待买家付款，定金预售描述：定金待付、等待尾款支付开始、尾款待付， TRADE_PAID：订单已支付
，该状态仅代表当前订单已支付成功，表示瞬时状态，稍后会自动修改成后面的状态。如果不关心此状态请再次请求详情接口获取下一个状态，
WAIT_CONFIRM：待确认，包含待成团、待接单等等。即：买家已付款，等待成团或等待接单， WAIT_SELLER_SEND_GOODS：等待卖家发货，即：买家已付款，
WAIT_BUYER_CONFIRM_GOODS 等待买家确认收货，即：卖家已发货， TRADE_SUCCESS：买家已签收以及订单成功， TRADE_CLOSED：交易关闭

created

string <date-time>

可选

订单创建时间，时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒

packingChargeInfo

object (PackingChargeInfo)

打包费信息

可选

buyerInfo

object (BuyerInfo)

购买人信息

可选

outerUserId

string

可选

微信H5和微信小程序（有赞小程序和小程序插件）的订单会返回微信weixin_openid，三方App（有赞APP开店）的订单会返回open_user_id，2019年1月30号后的订单支持返回该参数

buyerPhone

string

可选

买家手机号，买家在个人中心绑定手机号才会返回。否则为空。

buyerId

integer <int64>

买家id

可选

nickname

string

昵称

可选

yzOpenId

string

有赞客户id

可选

outOpenId

string

三方客户id

可选

sellerInfo

object (SellerInfo)

卖家信息

可选

nodeKdtId

integer <int64>

可选

单店店铺类型返回当前订单的店铺id，连锁店铺返回网店或门店店铺id

shopDisplayNo

string

门店编码

可选

shopName

string

店铺名称

可选

outStoreId

string

三方门店ID

可选

outStoreCode

string

可选

三方门店、仓库的编码

tel

string

卖家手机号

可选

subOrders

array[object (SubOrderItem) {21}]

原单子订单信息

可选

itemIdentity

object (ItemIdentity)

商品身份

可选

alias

string

商品别名

可选

totalFee

integer <int64>

可选

商品总价（扣除商品级优惠）单位：分

num

integer

商品数量

可选

oid

string

订单明细id

可选

outOid

string

外部子订单号

可选

buyerMessages

string

商品留言

可选

pointsPrice

string

可选

商品积分价（非积分商品则为0），如返回值是100则表示100积分。

price

integer <int64>

可选

单商品原价，单位：分

isPresent

boolean

可选

是否赠品，是：true，否：false

promotionDiscount

string

优惠

可选

goodsCostPrice

integer <int64>

可选

商品成本价，单位：分

itemType

integer

可选

商品类型，0:普通商品; 1:拍卖商品; 5:餐饮商品; 10:分销商品; 20:会员卡商品; 21:礼品卡商品; 23:有赞会议商品; 24:周期购; 30:收银台商品;
31:知识付费商品; 35:酒店商品; 40:普通服务类商品; 71:卡项商品;182:普通虚拟商品; 183:电子卡券商品; 201:外部会员卡商品; 202:外部直接收款商品;
203:外部普通商品; 204:外部服务商品;205:mock不存在商品; 206:小程序二维码;207:积分充值商品;208:付费优惠券商品

title

string

商品名称

可选

picPath

string

商品图片地址

可选

payment

integer <int64>

可选

订单明细应付金额，订单上每个商品最终均摊价，单位：分

discountPrice

integer <int64>

可选

单商品现价，减去了商品的优惠金额。单位：分

weight

number

重量（单位:kg)

可选

itemSalesStaffs

array[object (ItemSalesStaff) {4}]

商品导购员工编号

可选

skuAttributes

array[object (SkuAttribute) {2}]

可选

sku属性，（无规格商品为空）

itemProps

string

商品属性

可选

示例

{
    "rootKdtId": 0,
    "appId": "string",
    "globalProps": {
        "key": {}
    },
    "extendMap": {
        "key": {}
    },
    "refundOrderItem": [
        {
            "oid": "string",
            "outOid": "string",
            "refundFee": 0,
            "itemNum": 0,
            "shipped": true,
            "subOrderItemNum": 0,
            "itemIdentity": {
                "itemId": 0,
                "rootItemId": 0,
                "outItemId": "string",
                "itemNo": "string",
                "itemBarcode": "string",
                "skuNo": "string",
                "skuId": 0,
                "rootSkuId": 0,
                "outSkuId": "string",
                "skuBarcode": "string",
                "skuUniqueCode": "string"
            }
        }
    ],
    "refundFunds": [
        {
            "status": 0,
            "refundId": "string",
            "payWay": 0,
            "message": "string",
            "refundMode": 0,
            "refundNo": "string",
            "refundFee": 0
        }
    ],
    "modified": "string",
    "desc": "string",
    "refundTicketNum": 0,
    "consultMessages": [
        {
            "kdtId": 0,
            "orderNo": "string",
            "attachment": [
                "string"
            ]
        }
    ],
    "kdtId": 0,
    "demand": 0,
    "refundTicketList": [
        "string"
    ],
    "refundFee": 0,
    "refundFundDesc": "string",
    "created": "string",
    "returnGoods": true,
    "reason": 0,
    "refundAccountTime": "2019-08-24T14:15:22Z",
    "refundPostage": 0,
    "logistics": {
        "companyCode": "string",
        "address": "string",
        "logisticsNo": "string",
        "mobile": "string",
        "receiver": "string"
    },
    "version": 0,
    "oid": "string",
    "refundId": "string",
    "outRefundId": "string",
    "refundType": "string",
    "status": "string",
    "orderInfo": {
        "tid": "string",
        "outTid": "string",
        "payType": 0,
        "expressType": 0,
        "type": 0,
        "refundState": 0,
        "updateTime": "2019-08-24T14:15:22Z",
        "consignTime": "2019-08-24T14:15:22Z",
        "payTime": "2019-08-24T14:15:22Z",
        "successTime": "2019-08-24T14:15:22Z",
        "closeType": 0,
        "payTypeStr": "string",
        "channelType": 0,
        "status": "string",
        "created": "2019-08-24T14:15:22Z",
        "packingChargeInfo": {
            "name": "string",
            "realPay": 0,
            "pay": 0,
            "refundable": true,
            "originPay": 0,
            "extInfo": {
                "packagingFeeType": 0,
                "itemsFeeDetails": [
                    {
                        "price": 0,
                        "count": 0,
                        "name": "string"
                    }
                ]
            }
        }
    },
    "buyerInfo": {
        "outerUserId": "string",
        "buyerPhone": "string",
        "buyerId": 0,
        "nickname": "string",
        "yzOpenId": "string",
        "outOpenId": "string"
    },
    "sellerInfo": {
        "nodeKdtId": 0,
        "shopDisplayNo": "string",
        "shopName": "string",
        "outStoreId": "string",
        "outStoreCode": "string",
        "tel": "string"
    },
    "subOrders": [
        {
            "itemIdentity": {
                "itemId": 0,
                "rootItemId": 0,
                "outItemId": "string",
                "itemNo": "string",
                "itemBarcode": "string",
                "skuNo": "string",
                "skuId": 0,
                "rootSkuId": 0,
                "outSkuId": "string",
                "skuBarcode": "string",
                "skuUniqueCode": "string"
            },
            "alias": "string",
            "totalFee": 0,
            "num": 0,
            "oid": "string",
            "outOid": "string",
            "buyerMessages": "string",
            "pointsPrice": "string",
            "price": 0,
            "isPresent": true,
            "promotionDiscount": "string",
            "goodsCostPrice": 0,
            "itemType": 0,
            "title": "string",
            "picPath": "string",
            "payment": 0,
            "discountPrice": 0,
            "weight": 0,
            "itemSalesStaffs": [
                {
                    "staffNo": "string",
                    "outGuideId": "string",
                    "yzGuideId": "string",
                    "rate": 0
                }
            ],
            "skuAttributes": [
                {
                    "value": "string",
                    "name": "string"
                }
            ],
            "itemProps": "string"
        }
    ]
}

返回响应

🟢200成功

application/json

Body

success

boolean

可选

标识本次调用是否返回

code

integer

可选

本次调用返回code，一般为错误代码

message

string

可选

本次调用返回的消息，一般为错误消息

requestId

string

请求Id

可选

errorData

object (Map«Object»)

调用失败返回的数据

可选

key

object (key)

可选

data

object (OrderRefundCreateExtResponse)

调用返回的数据

可选

outRefundId

string

外部维权单id

必需

示例

{
  "success": false,
  "code": 0,
  "message": "",
  "requestId": "",
  "errorData": {
    "": {}
  },
  "data": {
    "outRefundId": ""
  }
}

订单信息更新

订单状态更新