文档中心 > API类目 > 阿里健康药API

alibaba.alihealth.nrmop.order.refund (一树小鹿退款同步oms)

一树小鹿退款同步oms

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_order_refund_req_dto TopOrderRefundReqDTO 可选 退款主单参数
  • └ channel_order_id
  • String
  • 可选
  • 121
  • 渠道订单id
  • └ is_sale_after
  • Number
  • 可选
  • 1
  • 是否售后退,0否,1是
  • └ channel_refund_id
  • String
  • 可选
  • 112
  • 渠道退单ID
  • └ platform_discount
  • Number
  • 可选
  • 1
  • 平台优惠,单位:分
  • └ biz_type
  • String
  • 可选
  • YSXL
  • 渠道类型,一树小鹿 YSXL
  • └ refund_reason_desc
  • String
  • 可选
  • 临时有事,不想要了
  • 退款原因描述
  • └ refund_mei_dou
  • Number
  • 可选
  • 1
  • 退款总金额中的美豆
  • └ refund_reason
  • String
  • 可选
  • 不想要了
  • 退款原因
  • └ initiator
  • Number
  • 可选
  • 1
  • 发起方,1用户;2商家;3客服;4系统;
  • └ refund_total
  • Number
  • 可选
  • 1
  • 退款总金额,单位:分
  • └ refund_status
  • Number
  • 可选
  • 1
  • 退款状态 0未申请; 1已申请整单退款;2同意整单退款;3拒绝整单退款;4已取消整单退款; 11已申请部分退款;12同意部分退款;13拒绝部分退款;14取消部分退款;
  • └ refund_pictures
  • String
  • 可选
  • http://xxx.com/a.png,http://xxx.com/b.png
  • 退款照片,英文逗号分割
  • └ refund_type
  • Number
  • 可选
  • 1
  • 退款类型,1整单退货退款;2整单仅退款;11部分退货退款;12部分仅退款;
  • └ nrmop_channel_id
  • Number
  • 可选
  • 123
  • 中台渠道ID
  • └ seller_discount
  • Number
  • 可选
  • 1
  • 商户优惠,单位:分
  • └ return_goods_status
  • Number
  • 可选
  • 1
  • 退货状态 0未申请; 1已申请整单退货;2同意整单退货;3拒绝整单退货;4已取消整单退货; 11已申请部分退货;12同意部分退货;13拒绝部分退货;14取消部分退货;
  • sub_refund_order
  • TopSubOrderRefundReqDTO []
  • 可选
  • [{"channelSubRefundId":1}]
  • 退款子单参数
  • └ channel_item_id
  • String
  • 可选
  • 1
  • 退款商品ID
  • └ item_count
  • Number
  • 可选
  • 1
  • 退款商品数量
  • └ item_name
  • String
  • 可选
  • 感冒灵
  • 退款商品名
  • └ refund_mei_dou
  • Number
  • 可选
  • 1
  • 子单实际退款总金额中包含的的美豆
  • └ item_origin_price
  • Number
  • 可选
  • 1
  • 商品原价,单位分
  • └ refund_total
  • Number
  • 可选
  • 1
  • 子单实际退款总金额,即商品实际退款单价*退款商品,单位分
  • └ channel_sub_refund_id
  • String
  • 可选
  • 2313
  • 渠道退单子单ID
  • └ platform_discount
  • Number
  • 可选
  • 1
  • 子单平台优惠
  • └ seller_discount
  • Number
  • 可选
  • 1
  • 子单商家优惠
  • └ out_id
  • String
  • 可选
  • 123123
  • outId
  • └ refund_money
  • Number
  • 可选
  • 1
  • 退款金额
  • └ erp_shop_id
  • String
  • 可选
  • 123
  • 渠道店铺ID
  • └ apply_time
  • Date
  • 可选
  • 2019-01-01 11:11:11
  • 申请时间
  • └ is_last_part_refund
  • Number
  • 可选
  • 1
  • 是否最后一次部分退,0否,1是
  • └ refuse_reason
  • String
  • 可选
  • 超时自动退款
  • 拒绝退款理由
  • └ refund_money
  • Number
  • 可选
  • 1
  • 退款金额

响应参数

名称 类型 示例值 描述
refund_result Boolean true 退款结果
refund_err_code String 1 错误码
refund_err_msg String success 错误提示

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthNrmopOrderRefundRequest req = new AlibabaAlihealthNrmopOrderRefundRequest();
AlibabaAlihealthNrmopOrderRefundRequest.TopOrderRefundReqDTO obj1 = new AlibabaAlihealthNrmopOrderRefundRequest.TopOrderRefundReqDTO();
obj1.setChannelOrderId("121");
obj1.setIsSaleAfter(1L);
obj1.setChannelRefundId("112");
obj1.setPlatformDiscount(1L);
obj1.setBizType("YSXL");
obj1.setRefundReasonDesc("临时有事,不想要了");
obj1.setRefundMeiDou(1L);
obj1.setRefundReason("不想要了");
obj1.setInitiator(1L);
obj1.setRefundTotal(1L);
obj1.setRefundStatus(1L);
obj1.setRefundPictures("http://xxx.com/a.png,http://xxx.com/b.png");
obj1.setRefundType(1L);
obj1.setNrmopChannelId(123L);
obj1.setSellerDiscount(1L);
obj1.setReturnGoodsStatus(1L);
List<AlibabaAlihealthNrmopOrderRefundRequest.TopSubOrderRefundReqDTO> list3 = new ArrayList<AlibabaAlihealthNrmopOrderRefundRequest.TopSubOrderRefundReqDTO>();
AlibabaAlihealthNrmopOrderRefundRequest.TopSubOrderRefundReqDTO obj4 = new AlibabaAlihealthNrmopOrderRefundRequest.TopSubOrderRefundReqDTO();
list3.add(obj4);
obj4.setChannelItemId("1");
obj4.setItemCount(1L);
obj4.setItemName("感冒灵");
obj4.setRefundMeiDou(1L);
obj4.setItemOriginPrice(1L);
obj4.setRefundTotal(1L);
obj4.setChannelSubRefundId("2313");
obj4.setPlatformDiscount(1L);
obj4.setSellerDiscount(1L);
obj4.setOutId("123123");
obj4.setRefundMoney(1L);
obj1.setSubRefundOrder(list3);
obj1.setErpShopId("123");
obj1.setApplyTime(StringUtils.parseDateTime("2019-01-01 11:11:11"));
obj1.setIsLastPartRefund(1L);
obj1.setRefuseReason("超时自动退款");
obj1.setRefundMoney(1L);
req.setTopOrderRefundReqDto(obj1);
AlibabaAlihealthNrmopOrderRefundResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_alihealth_nrmop_order_refund_response>
    <refund_result>true</refund_result>
    <refund_err_code>1</refund_err_code>
    <refund_err_msg>success</refund_err_msg>
</alibaba_alihealth_nrmop_order_refund_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部