POST api/AuthorizeReturn

Global e-commerce merchants can issue returns with this API

Parameters

* Required
Property Description
Key (Guid)
* The API key provided to you by i-parcel.
OriginalTrackingNumber (String)
* The original tracking number of the parcel.
ReturnTrackingNumber (String)
The tracking number of the return.
Value (Decimal)
* The amount to refund.
Currency (String)
* The currency in which to issue the refund (must be in your shopper's currency).
Reference (String)
* An internal reference that you can apply to the refund.
RefundedBy (String)
* The person authorizing the refund.
Notes (String)
* Notes on this refund.
Details (Breakdown)
Optional details on the refund

Request body formats

application/json, text/json

Sample:
{
  "Key": "d451ddfb-c021-4b2c-b52e-f28c7e5dc74b",
  "OriginalTrackingNumber": "sample string 2",
  "ReturnTrackingNumber": "sample string 3",
  "Value": 4.0,
  "Currency": "sample string 5",
  "Reference": "sample string 6",
  "RefundedBy": "sample string 7",
  "Notes": "sample string 8",
  "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-22T12:32:16.9443857+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
  }
}

application/xml, text/xml

Sample:
<ApiReturnRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Repository">
  <Currency>sample string 5</Currency>
  <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-22T12:32:16.9443857+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>
  <Key>d451ddfb-c021-4b2c-b52e-f28c7e5dc74b</Key>
  <Notes>sample string 8</Notes>
  <OriginalTrackingNumber>sample string 2</OriginalTrackingNumber>
  <Reference>sample string 6</Reference>
  <RefundedBy>sample string 7</RefundedBy>
  <ReturnTrackingNumber>sample string 3</ReturnTrackingNumber>
  <Value>4</Value>
</ApiReturnRequest>