POST api/BigCommerce/RefundOrder?orderId={orderId}

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId		string	Required

Body Parameters

BCOrderRefund

Name	Type	Additional information
items	Collection of BCOrderRefundItem	None.
payments	Collection of BCRefundMethodsRefund	None.
merchant_calculated_override	BCMerchantCalculatedOverride	None.

Request Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "item_id": 1,
      "item_type": "sample string 2",
      "quantity": 3,
      "reason": "sample string 4",
      "amount": 5.1
    },
    {
      "item_id": 1,
      "item_type": "sample string 2",
      "quantity": 3,
      "reason": "sample string 4",
      "amount": 5.1
    }
  ],
  "payments": [
    {
      "provider_id": "sample string 1",
      "amount": 2.1,
      "offline": true
    },
    {
      "provider_id": "sample string 1",
      "amount": 2.1,
      "offline": true
    }
  ],
  "merchant_calculated_override": {
    "total_amount": 1.1,
    "total_tax": 2.1
  }
}

application/xml, text/xml

Sample:

<BCOrderRefund xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <items>
    <BCOrderRefundItem>
      <item_id>1</item_id>
      <item_type>sample string 2</item_type>
      <quantity>3</quantity>
      <reason>sample string 4</reason>
      <amount>5.1</amount>
    </BCOrderRefundItem>
    <BCOrderRefundItem>
      <item_id>1</item_id>
      <item_type>sample string 2</item_type>
      <quantity>3</quantity>
      <reason>sample string 4</reason>
      <amount>5.1</amount>
    </BCOrderRefundItem>
  </items>
  <payments>
    <BCRefundMethodsRefund>
      <provider_id>sample string 1</provider_id>
      <amount>2.1</amount>
      <offline>true</offline>
    </BCRefundMethodsRefund>
    <BCRefundMethodsRefund>
      <provider_id>sample string 1</provider_id>
      <amount>2.1</amount>
      <offline>true</offline>
    </BCRefundMethodsRefund>
  </payments>
  <merchant_calculated_override>
    <total_amount>1.1</total_amount>
    <total_tax>2.1</total_tax>
  </merchant_calculated_override>
</BCOrderRefund>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.