POST api/refund

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ExternalId	integer	None.
TransactionId	integer	None.
UserID	string	None.
CurrencyCode	string	None.
CountryCode	string	None.
Reason	string	None.
RefundDate	integer	None.
TaxTotal	decimal number	None.
Total	decimal number	None.
RefundItems	Collection of RefundItem	None.
ProcessCount	integer	None.
WebJobId	integer	None.
WebLogId	integer	None.
Route	string	None.
ApiUser	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ExternalId": 1,
  "TransactionId": 2,
  "UserID": "sample string 3",
  "CurrencyCode": "sample string 4",
  "CountryCode": "sample string 5",
  "Reason": "sample string 6",
  "RefundDate": 7,
  "TaxTotal": 1.1,
  "Total": 1.1,
  "RefundItems": [
    {
      "ItemName": "sample string 1",
      "SkuId": "sample string 2",
      "ContentId": "sample string 3",
      "Quantity": 4,
      "AmountBaseCurrency": 5.1,
      "AmountLocalCurrency": 6.1,
      "TaxAmount": 1.1,
      "TaxRate": 1.1,
      "NetAmount": 1.1,
      "PromoCode": "sample string 7",
      "DiscountAmount": 1.1,
      "DiscountTaxRate": 1.1,
      "DiscountTaxAmount": 1.1,
      "GrossAmount": 8.1,
      "OrderType": 9,
      "UpgradeFromItemId": 1,
      "IsRecurring": true,
      "StartDate": 10,
      "EndDate": 11,
      "StartDateStr": "sample string 12",
      "EndDateStr": "sample string 13",
      "StartDateTime": "sample string 14",
      "EndDateTime": "sample string 15"
    },
    {
      "ItemName": "sample string 1",
      "SkuId": "sample string 2",
      "ContentId": "sample string 3",
      "Quantity": 4,
      "AmountBaseCurrency": 5.1,
      "AmountLocalCurrency": 6.1,
      "TaxAmount": 1.1,
      "TaxRate": 1.1,
      "NetAmount": 1.1,
      "PromoCode": "sample string 7",
      "DiscountAmount": 1.1,
      "DiscountTaxRate": 1.1,
      "DiscountTaxAmount": 1.1,
      "GrossAmount": 8.1,
      "OrderType": 9,
      "UpgradeFromItemId": 1,
      "IsRecurring": true,
      "StartDate": 10,
      "EndDate": 11,
      "StartDateStr": "sample string 12",
      "EndDateStr": "sample string 13",
      "StartDateTime": "sample string 14",
      "EndDateTime": "sample string 15"
    }
  ],
  "ProcessCount": 1,
  "WebJobId": 8,
  "WebLogId": 9,
  "Route": "sample string 10",
  "ApiUser": "sample string 11"
}

application/xml, text/xml

Sample:

<RefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EvergentInterface.Core.ApiClasses">
  <ApiUser>sample string 11</ApiUser>
  <CountryCode>sample string 5</CountryCode>
  <CurrencyCode>sample string 4</CurrencyCode>
  <ExternalId>1</ExternalId>
  <ProcessCount>1</ProcessCount>
  <Reason>sample string 6</Reason>
  <RefundDate>7</RefundDate>
  <RefundItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/EvergentInterface.Core.DomainClasses">
    <d2p1:RefundItem>
      <d2p1:AmountBaseCurrency>5.1</d2p1:AmountBaseCurrency>
      <d2p1:AmountLocalCurrency>6.1</d2p1:AmountLocalCurrency>
      <d2p1:ContentId>sample string 3</d2p1:ContentId>
      <d2p1:DiscountAmount>1.1</d2p1:DiscountAmount>
      <d2p1:DiscountTaxAmount>1.1</d2p1:DiscountTaxAmount>
      <d2p1:DiscountTaxRate>1.1</d2p1:DiscountTaxRate>
      <d2p1:EndDate>11</d2p1:EndDate>
      <d2p1:EndDateStr>sample string 13</d2p1:EndDateStr>
      <d2p1:EndDateTime>sample string 15</d2p1:EndDateTime>
      <d2p1:GrossAmount>8.1</d2p1:GrossAmount>
      <d2p1:IsRecurring>true</d2p1:IsRecurring>
      <d2p1:ItemName>sample string 1</d2p1:ItemName>
      <d2p1:NetAmount>1.1</d2p1:NetAmount>
      <d2p1:OrderType>9</d2p1:OrderType>
      <d2p1:PromoCode>sample string 7</d2p1:PromoCode>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:SkuId>sample string 2</d2p1:SkuId>
      <d2p1:StartDate>10</d2p1:StartDate>
      <d2p1:StartDateStr>sample string 12</d2p1:StartDateStr>
      <d2p1:StartDateTime>sample string 14</d2p1:StartDateTime>
      <d2p1:TaxAmount>1.1</d2p1:TaxAmount>
      <d2p1:TaxRate>1.1</d2p1:TaxRate>
      <d2p1:UpgradeFromItemId>1</d2p1:UpgradeFromItemId>
    </d2p1:RefundItem>
    <d2p1:RefundItem>
      <d2p1:AmountBaseCurrency>5.1</d2p1:AmountBaseCurrency>
      <d2p1:AmountLocalCurrency>6.1</d2p1:AmountLocalCurrency>
      <d2p1:ContentId>sample string 3</d2p1:ContentId>
      <d2p1:DiscountAmount>1.1</d2p1:DiscountAmount>
      <d2p1:DiscountTaxAmount>1.1</d2p1:DiscountTaxAmount>
      <d2p1:DiscountTaxRate>1.1</d2p1:DiscountTaxRate>
      <d2p1:EndDate>11</d2p1:EndDate>
      <d2p1:EndDateStr>sample string 13</d2p1:EndDateStr>
      <d2p1:EndDateTime>sample string 15</d2p1:EndDateTime>
      <d2p1:GrossAmount>8.1</d2p1:GrossAmount>
      <d2p1:IsRecurring>true</d2p1:IsRecurring>
      <d2p1:ItemName>sample string 1</d2p1:ItemName>
      <d2p1:NetAmount>1.1</d2p1:NetAmount>
      <d2p1:OrderType>9</d2p1:OrderType>
      <d2p1:PromoCode>sample string 7</d2p1:PromoCode>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:SkuId>sample string 2</d2p1:SkuId>
      <d2p1:StartDate>10</d2p1:StartDate>
      <d2p1:StartDateStr>sample string 12</d2p1:StartDateStr>
      <d2p1:StartDateTime>sample string 14</d2p1:StartDateTime>
      <d2p1:TaxAmount>1.1</d2p1:TaxAmount>
      <d2p1:TaxRate>1.1</d2p1:TaxRate>
      <d2p1:UpgradeFromItemId>1</d2p1:UpgradeFromItemId>
    </d2p1:RefundItem>
  </RefundItems>
  <Route>sample string 10</Route>
  <TaxTotal>1.1</TaxTotal>
  <Total>1.1</Total>
  <TransactionId>2</TransactionId>
  <UserID>sample string 3</UserID>
  <WebJobId>8</WebJobId>
  <WebLogId>9</WebLogId>
</RefundRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.