管理api
构建应用程序
快速启动
指南
教程
建立渠道
快速启动
指南
教程
建筑店面
管理货币
指南
合作伙伴信息
成为合作伙伴
开始
POS解决方案
ERP解决方案
PIM解决方案
OMS的解决方案
营销解决方案
运输解决方案
支付解决方案

订单退款

V3顺序暴露针对已结算付款订单创建退款的端点。在构建订单管理或支付集成时,这些端点非常有用,因为它们可以将退款功能直接嵌入到应用程序中,而不需要商家返回到他们的BigCommerce控制面板。

本文概述了Order V3的退款功能,并包含了一个创建单独的订单退款

单个订单退款示例

退款订单由两个API请求组成。

请求 操作 端点 描述
1 帖子 / v3 /订单/ {id} / payment_actions / refund_quotes 计算金额和获取付款方式
2 帖子 / v3 /订单/ {id} / payment_actions /退款 创建了退款

本文中的示例请求使用了具有以下属性的订单:

  • 产品:单一产品定价10.00美元
  • 税收:0.83美元
  • 运输:10.00美元

退款金额将包括航运,税,和产品成本(共20.83美元)。我们将创建一个退款报价。然后,我们将创建一个退款的信息创建退款报价响应

创建退款报价

退款报价提供了税款、总退款金额和订单退款的可用支付方式列表。

创建一个退款报价、发送帖子请求/ v3 /订单/ {order_id} / payment_actions / refund_quotes

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /订单/ {order_id} / payment_actions / refund_quotesX-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“项目”:({“item_type”:“产品”,//退货“item_id”:8,//订购产品ID“数量”:1,//退款数量},{“item_type”:“运输”,/ /退款航运“item_id”:9,//订单地址ID“数量”:10,//退款},{“item_type”:“秩序”,//免税订单级别退款“item_id”:9,/ /订单ID“数量”:1,//退款}]}

在请求运行程序中打开

回应:

{“数据”:{“total_refund_amount”:21.83,“total_refund_tax_amount”:0.83,“四舍五入”:0,“调整”:0,“is_tax_included”:,“order_level_refund_amount”:0,“refund_methods”:(({“provider_id”:“布伦特里”,“provider_description”:“商店信贷”,“数量”:21.83,“离线”:,“offline_provider”:,“offline_reason”:”“}],]},“元”:{}}

请注意

  • 为了得到一个item_id,使得到请求v2 /订单/ {order_id} /产品。返回的id值是item_id需要创建一个产品退款报价。返回的order_address_id值是item_id需要创建一个航运退款报价。阅读更多关于使用v2 /订单/ {order_id} /产品端点,请访问订单产品列表
  • 获取订单和他们的ids,向…提出请求把所有的订单

创建一个退款

使用provider_id,,项目退款的话创建一个退款

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /订单/ {order_id} / payment_actions /退款X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“项目”:({“item_type”:“产品”,//退货“item_id”:8,//订购产品ID“数量”:1//退款数量},{“item_type”:“运输”,/ /退款航运“item_id”:9,//订单地址ID“数量”:10//退款},{“item_type”:“秩序”,//免税订单级别退款“item_id”:123,/ /订单ID“数量”:1,//退款}],“支付”:({“provider_id”:“布伦特里”,“数量”:21.83,“离线”:}]}

在请求运行程序中打开

回应:

{“数据”:{“id”:1,“order_id”:21,“user_id”:0,“创建”:”“,“原因”:”“,“total_amount”:20.83,“total_tax”:0.83,“项目”:({“item_type”:“产品”,“item_id”:8,“原因”:”“,“数量”:1,“requested_amount”:10},{“item_type”:“运输”,“item_id”:9,“原因”:”“,“requested_amount”:10}],“支付”:({“id”:1,“provider_id”:“布伦特里”,“数量”:20.83,“离线”:,“is_declined”:,“declined_message”:”“}]},“元”:{}}

在请求运行程序中打开

创建订单级别退款

要在订单级别退还免税关税金额,请设置item_type订单并指定退款。

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /订单/ {order_id} / payment_actions /退款X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“order_id”:1234,“项目”:({“item_type”:“秩序”,//退还免税关税金额“item_id”:1234,/ /订单ID“数量”:1,//退款}],“支付”:(]}

在请求运行程序中打开

退款航运和处理

要退款装运或处理,设置item_type航运处理并指定退款。

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /订单/ {order_id} / payment_actions /退款X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“order_id”:1234,“项目”:({“item_type”:“运输”,/ /退款航运“item_id”:456,//订单地址ID“数量”:1,//退款}],“支付”:(]}

在请求运行程序中打开

退货和礼品包装

要退款的产品或礼品包装,集item_type产品GIFT_WRAPPING并指定数量退款。

文章https://api.bigcommerce.com/stores/ {{STORE_HASH}} / v3 /订单/ {order_id} / payment_actions /退款X-Auth-Token:{{ACCESS_TOKEN}}内容类型:application / json接受:application / json{“order_id”:1234,“项目”:({“item_type”:“产品”,//退货“item_id”:1234,//订购产品ID“数量”:1,//退款数量},{“item_type”:“GIFT_WRAPPING”,//退还礼品包装“item_id”:1234,//订购产品ID“数量”:1,//退款数量}],“支付”:(]}

在请求运行程序中打开

线下订单退款

在BigCommerce之外收取的款项可以在创建退款时被标记为离线。将付款标记为离线是一种跟踪您退款订单的哪一部分的方法。但是,没有收到任何资金。如果您没有通过BigCommerce收到付款,则无法使用BigCommerce的退款端点将资金直接退还到付款源。

常见问题解答

是否可以创建一个退款,而不使用一个项目从订单?

是的。集item_type订单并指定一个退款。有关更多信息,请参见创建订单级别退款

我可以跳过创建报价,直接去处理退款吗?

不需要先创建报价就可以处理退款。报价可以确保你以正确的金额退还给正确的付款供应商。

我在哪里可以找到item_id吗?

使用V2 Orders端点来获取所需的ID:

  • 产品-订单产品ID
  • GIFT_WRAPPING-订单产品ID
  • 航运-订单地址ID
  • 处理-订单地址ID
  • 订单——订单ID

这会触发向购物者发送电子邮件吗?

是的,如果你设置商店在订单状态变为时发送电子邮件退还部分退款

我如何得到一个列表provider_id年代?

邮政退款报价暴露provider_id年代。

退款的物品会被退回到库存中吗?

不,您不能将您通过API退回的物品退回到库存中。您可以直接在产品页面上更新库存或使用控制面板改变库存。

故障排除

  • 您必须收到订单的付款后才能发出退款。
  • 如果你使用支付网关,它必须支持退款。有关支持通过BigCommerce进行退款的支付网关的列表,请参见中的“支持的支付网关”一节处理退款
  • 如果您使用支付网关,您必须结算付款。有些网关需要一定的时间才能处理退款。

相关资源伟德棋牌大全

文章

端点