POST api/Outbound/SubmitRefundRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrderNumber	string	None.
ReferenceID	integer	None.
ReferenceType	string	None.
RefundSubtype	string	None.
CustomerID	integer	None.
BusinessID	integer	None.
ReasonID	integer	None.
Narration	string	None.
CreatedBy	integer	None.
CustomerName	string	None.
CustomerPhone	string	None.
Items	Collection of RefundItem	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderNumber": "sample string 1",
  "ReferenceID": 2,
  "ReferenceType": "sample string 3",
  "RefundSubtype": "sample string 4",
  "CustomerID": 5,
  "BusinessID": 6,
  "ReasonID": 7,
  "Narration": "sample string 8",
  "CreatedBy": 9,
  "CustomerName": "sample string 10",
  "CustomerPhone": "sample string 11",
  "Items": [
    {
      "SKUCode": "sample string 1",
      "SKUName": "sample string 2",
      "Quantity": 3,
      "Amount": 4.0,
      "MaterialReturn": 5
    },
    {
      "SKUCode": "sample string 1",
      "SKUName": "sample string 2",
      "Quantity": 3,
      "Amount": 4.0,
      "MaterialReturn": 5
    }
  ]
}

application/xml, text/xml

Sample:

<SubmitRefundRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <BusinessID>6</BusinessID>
  <CreatedBy>9</CreatedBy>
  <CustomerID>5</CustomerID>
  <CustomerName>sample string 10</CustomerName>
  <CustomerPhone>sample string 11</CustomerPhone>
  <Items>
    <RefundItem>
      <Amount>4</Amount>
      <MaterialReturn>5</MaterialReturn>
      <Quantity>3</Quantity>
      <SKUCode>sample string 1</SKUCode>
      <SKUName>sample string 2</SKUName>
    </RefundItem>
    <RefundItem>
      <Amount>4</Amount>
      <MaterialReturn>5</MaterialReturn>
      <Quantity>3</Quantity>
      <SKUCode>sample string 1</SKUCode>
      <SKUName>sample string 2</SKUName>
    </RefundItem>
  </Items>
  <Narration>sample string 8</Narration>
  <OrderNumber>sample string 1</OrderNumber>
  <ReasonID>7</ReasonID>
  <ReferenceID>2</ReferenceID>
  <ReferenceType>sample string 3</ReferenceType>
  <RefundSubtype>sample string 4</RefundSubtype>
</SubmitRefundRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/11/03 15:58:31",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>