POST api/Listrak/SendRefundOrderProcessedEmail

Request Information

URI Parameters

None.

Body Parameters

BCOrderRefundResponseData
NameDescriptionTypeAdditional information
id

integer

None.

order_id

integer

None.

user_id

integer

None.

email_address

string

None.

created

date

None.

reason

string

None.

total_amount

decimal number

None.

total_tax

decimal number

None.

uses_merchant_override_values

boolean

None.

payments

Collection of BCOrderRefundResponsePayment

None.

items

Collection of BCOrderRefundResponseItem

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "order_id": 2,
  "user_id": 3,
  "email_address": "sample string 4",
  "created": "2024-09-04T06:46:41.9474213+00:00",
  "reason": "sample string 6",
  "total_amount": 7.1,
  "total_tax": 8.1,
  "uses_merchant_override_values": true,
  "payments": [
    {
      "id": 1,
      "provider_id": "sample string 2",
      "amount": 3.1,
      "offline": true,
      "is_declined": true,
      "declined_message": "sample string 6"
    },
    {
      "id": 1,
      "provider_id": "sample string 2",
      "amount": 3.1,
      "offline": true,
      "is_declined": true,
      "declined_message": "sample string 6"
    }
  ],
  "items": [
    {
      "item_type": "sample string 1",
      "item_id": 2,
      "quantity": 1,
      "requested_amount": 1.1,
      "reason": "sample string 3"
    },
    {
      "item_type": "sample string 1",
      "item_id": 2,
      "quantity": 1,
      "requested_amount": 1.1,
      "reason": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<BCOrderRefundResponseData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <id>1</id>
  <order_id>2</order_id>
  <user_id>3</user_id>
  <email_address>sample string 4</email_address>
  <created>2024-09-04T06:46:41.9474213+00:00</created>
  <reason>sample string 6</reason>
  <total_amount>7.1</total_amount>
  <total_tax>8.1</total_tax>
  <uses_merchant_override_values>true</uses_merchant_override_values>
  <payments>
    <BCOrderRefundResponsePayment>
      <id>1</id>
      <provider_id>sample string 2</provider_id>
      <amount>3.1</amount>
      <offline>true</offline>
      <is_declined>true</is_declined>
      <declined_message>sample string 6</declined_message>
    </BCOrderRefundResponsePayment>
    <BCOrderRefundResponsePayment>
      <id>1</id>
      <provider_id>sample string 2</provider_id>
      <amount>3.1</amount>
      <offline>true</offline>
      <is_declined>true</is_declined>
      <declined_message>sample string 6</declined_message>
    </BCOrderRefundResponsePayment>
  </payments>
  <items>
    <BCOrderRefundResponseItem>
      <item_type>sample string 1</item_type>
      <item_id>2</item_id>
      <quantity>1</quantity>
      <requested_amount>1.1</requested_amount>
      <reason>sample string 3</reason>
    </BCOrderRefundResponseItem>
    <BCOrderRefundResponseItem>
      <item_type>sample string 1</item_type>
      <item_id>2</item_id>
      <quantity>1</quantity>
      <requested_amount>1.1</requested_amount>
      <reason>sample string 3</reason>
    </BCOrderRefundResponseItem>
  </items>
</BCOrderRefundResponseData>

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.