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.
reason	string	None.
payments	Collection of BCRefundMethods	None.
merchant_calculated_override	BCMerchantCalculatedOverride	None.

Request Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "item_id": 1,
      "item_type": "sample string 2",
      "amount": 3.1,
      "quantity": 4,
      "reason": "sample string 5"
    },
    {
      "item_id": 1,
      "item_type": "sample string 2",
      "amount": 3.1,
      "quantity": 4,
      "reason": "sample string 5"
    }
  ],
  "reason": "sample string 1",
  "payments": [
    {
      "provider_id": "sample string 1",
      "provider_description": "sample string 2",
      "amount": 3.1,
      "offline": true,
      "offline_provider": true,
      "offline_reason": "sample string 6"
    },
    {
      "provider_id": "sample string 1",
      "provider_description": "sample string 2",
      "amount": 3.1,
      "offline": true,
      "offline_provider": true,
      "offline_reason": "sample string 6"
    }
  ],
  "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>
      <amount>3.1</amount>
      <quantity>4</quantity>
      <reason>sample string 5</reason>
    </BCOrderRefundItem>
    <BCOrderRefundItem>
      <item_id>1</item_id>
      <item_type>sample string 2</item_type>
      <amount>3.1</amount>
      <quantity>4</quantity>
      <reason>sample string 5</reason>
    </BCOrderRefundItem>
  </items>
  <reason>sample string 1</reason>
  <payments>
    <BCRefundMethods>
      <provider_id>sample string 1</provider_id>
      <provider_description>sample string 2</provider_description>
      <amount>3.1</amount>
      <offline>true</offline>
      <offline_provider>true</offline_provider>
      <offline_reason>sample string 6</offline_reason>
    </BCRefundMethods>
    <BCRefundMethods>
      <provider_id>sample string 1</provider_id>
      <provider_description>sample string 2</provider_description>
      <amount>3.1</amount>
      <offline>true</offline>
      <offline_provider>true</offline_provider>
      <offline_reason>sample string 6</offline_reason>
    </BCRefundMethods>
  </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.