POST api/ExecuteReturn

Allows a merchant to create a return

Parameters

* Required
Property Description
Key (Guid)
* The API key provided to you by i-parcel.
ParcelId (Int32)
* The parcel id of the returned quote.
TrackingNumber (String)
* The original tracking number to the order.
Rma (String)
A number internal to your store that we'll add as a reference to the return.
Sku (String)
* The sku of the item to return.
Qty (Int32)
* The quantity to return.
Amount (Decimal)
The amount to return in your shopper's currency.
            This won't be authorized until AuthorizeReturn is called.
Details (Breakdown)
The refund details. Should add up to Amount
ByWho (String)
Records who requested this return.

Request body formats

application/json, text/json

Sample:
{
  "Key": "05bc51b9-9ede-4f5c-97ea-984b8085f751",
  "ParcelId": 2,
  "TrackingNumber": "sample string 3",
  "Rma": "sample string 4",
  "Items": [
    {
      "Sku": "sample string 1",
      "Qty": 2,
      "Value": 3.0,
      "Currency": "sample string 4"
    },
    {
      "Sku": "sample string 1",
      "Qty": 2,
      "Value": 3.0,
      "Currency": "sample string 4"
    },
    {
      "Sku": "sample string 1",
      "Qty": 2,
      "Value": 3.0,
      "Currency": "sample string 4"
    }
  ],
  "Amount": 6.0,
  "Details": {
    "Reason": "sample string 1",
    "ReasonCode": "sample string 2",
    "Currency": "sample string 3",
    "Id": "sample string 4",
    "Rma": "sample string 5",
    "MerchantRma": "sample string 6",
    "LastModify": "2019-02-24T03:53:26.2235454+00:00",
    "ModifiedBy": "sample string 8",
    "Items": [
      {
        "Sku": "sample string 1",
        "Qty": 2,
        "Description": "sample string 3",
        "Cost": 4.0,
        "Shipping": 5.0,
        "Tax": 6.0,
        "TaxDiscount": 7.0,
        "BaseTax": 8.0,
        "Duty": 9.0,
        "DutyDiscount": 10.0,
        "BaseDuty": 11.0,
        "Discount": 12.0
      },
      {
        "Sku": "sample string 1",
        "Qty": 2,
        "Description": "sample string 3",
        "Cost": 4.0,
        "Shipping": 5.0,
        "Tax": 6.0,
        "TaxDiscount": 7.0,
        "BaseTax": 8.0,
        "Duty": 9.0,
        "DutyDiscount": 10.0,
        "BaseDuty": 11.0,
        "Discount": 12.0
      },
      {
        "Sku": "sample string 1",
        "Qty": 2,
        "Description": "sample string 3",
        "Cost": 4.0,
        "Shipping": 5.0,
        "Tax": 6.0,
        "TaxDiscount": 7.0,
        "BaseTax": 8.0,
        "Duty": 9.0,
        "DutyDiscount": 10.0,
        "BaseDuty": 11.0,
        "Discount": 12.0
      }
    ],
    "Shipping": 9.0,
    "ReturnShipping": 10.0,
    "MaxReturnShipping": 1.0,
    "Duty": 11.0,
    "Tax": 12.0,
    "Discount": 13.0,
    "TotalShipping": 9.0,
    "TotalDuty": 11.0,
    "TotalTax": 12.0,
    "TotalProduct": 24.0,
    "TotalDiscount": 13.0,
    "Total": 33.0,
    "SummedTotal": 46.0
  },
  "ByWho": "sample string 7",
  "ServiceLevelId": 8
}

application/xml, text/xml

Sample:
<ApiReturnExecute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.Returns">
  <Amount>6</Amount>
  <ByWho>sample string 7</ByWho>
  <Details xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.Mongo.Refund">
    <Currency xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">sample string 3</Currency>
    <Discount xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">13</Discount>
    <Duty xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">11</Duty>
    <Id xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">sample string 4</Id>
    <Items xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">
      <Item>
        <BaseDuty>11</BaseDuty>
        <BaseTax>8</BaseTax>
        <Cost>4</Cost>
        <Description>sample string 3</Description>
        <Discount>12</Discount>
        <Duty>9</Duty>
        <DutyDiscount>10</DutyDiscount>
        <Qty>2</Qty>
        <Shipping>5</Shipping>
        <Sku>sample string 1</Sku>
        <Tax>6</Tax>
        <TaxDiscount>7</TaxDiscount>
      </Item>
      <Item>
        <BaseDuty>11</BaseDuty>
        <BaseTax>8</BaseTax>
        <Cost>4</Cost>
        <Description>sample string 3</Description>
        <Discount>12</Discount>
        <Duty>9</Duty>
        <DutyDiscount>10</DutyDiscount>
        <Qty>2</Qty>
        <Shipping>5</Shipping>
        <Sku>sample string 1</Sku>
        <Tax>6</Tax>
        <TaxDiscount>7</TaxDiscount>
      </Item>
      <Item>
        <BaseDuty>11</BaseDuty>
        <BaseTax>8</BaseTax>
        <Cost>4</Cost>
        <Description>sample string 3</Description>
        <Discount>12</Discount>
        <Duty>9</Duty>
        <DutyDiscount>10</DutyDiscount>
        <Qty>2</Qty>
        <Shipping>5</Shipping>
        <Sku>sample string 1</Sku>
        <Tax>6</Tax>
        <TaxDiscount>7</TaxDiscount>
      </Item>
    </Items>
    <LastModify xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">2019-02-24T03:53:26.2235454+00:00</LastModify>
    <MaxReturnShipping xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">1</MaxReturnShipping>
    <MerchantRma xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">sample string 6</MerchantRma>
    <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">sample string 8</ModifiedBy>
    <NonNullItems xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">
      <Item>
        <BaseDuty>11</BaseDuty>
        <BaseTax>8</BaseTax>
        <Cost>4</Cost>
        <Description>sample string 3</Description>
        <Discount>12</Discount>
        <Duty>9</Duty>
        <DutyDiscount>10</DutyDiscount>
        <Qty>2</Qty>
        <Shipping>5</Shipping>
        <Sku>sample string 1</Sku>
        <Tax>6</Tax>
        <TaxDiscount>7</TaxDiscount>
      </Item>
      <Item>
        <BaseDuty>11</BaseDuty>
        <BaseTax>8</BaseTax>
        <Cost>4</Cost>
        <Description>sample string 3</Description>
        <Discount>12</Discount>
        <Duty>9</Duty>
        <DutyDiscount>10</DutyDiscount>
        <Qty>2</Qty>
        <Shipping>5</Shipping>
        <Sku>sample string 1</Sku>
        <Tax>6</Tax>
        <TaxDiscount>7</TaxDiscount>
      </Item>
      <Item>
        <BaseDuty>11</BaseDuty>
        <BaseTax>8</BaseTax>
        <Cost>4</Cost>
        <Description>sample string 3</Description>
        <Discount>12</Discount>
        <Duty>9</Duty>
        <DutyDiscount>10</DutyDiscount>
        <Qty>2</Qty>
        <Shipping>5</Shipping>
        <Sku>sample string 1</Sku>
        <Tax>6</Tax>
        <TaxDiscount>7</TaxDiscount>
      </Item>
    </NonNullItems>
    <Reason xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">sample string 1</Reason>
    <ReasonCode xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">sample string 2</ReasonCode>
    <ReturnShipping xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">10</ReturnShipping>
    <Rma xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">sample string 5</Rma>
    <Shipping xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">9</Shipping>
    <Tax xmlns="http://schemas.datacontract.org/2004/07/ModelLibrary.Returns">12</Tax>
  </Details>
  <Email>sample string 5</Email>
  <Items>
    <ReturnItem>
      <Currency>sample string 4</Currency>
      <Qty>2</Qty>
      <Sku>sample string 1</Sku>
      <Value>3</Value>
    </ReturnItem>
    <ReturnItem>
      <Currency>sample string 4</Currency>
      <Qty>2</Qty>
      <Sku>sample string 1</Sku>
      <Value>3</Value>
    </ReturnItem>
    <ReturnItem>
      <Currency>sample string 4</Currency>
      <Qty>2</Qty>
      <Sku>sample string 1</Sku>
      <Value>3</Value>
    </ReturnItem>
  </Items>
  <ParcelId>2</ParcelId>
  <Rma>sample string 4</Rma>
  <ServiceLevelId>8</ServiceLevelId>
  <TrackingNumber>sample string 3</TrackingNumber>
  <Key>05bc51b9-9ede-4f5c-97ea-984b8085f751</Key>
</ApiReturnExecute>