POST api/Listrak/SendReturnConfirmationEmail?type={type}

Request Information

URI Parameters

Name	Description	Type	Additional information
type		string	Required

Body Parameters

OrderReturn

Name	Description	Type	Additional information
emailBody		string	None.
returnModel		Return	None.

Request Formats

application/json, text/json

Sample:

{
  "emailBody": "sample string 1",
  "returnModel": {
    "id": "sample string 1",
    "Type": "sample string 2",
    "ReturnNumber": 3,
    "ReturnStatus": "sample string 4",
    "SiteOrderNumber": "sample string 5",
    "NSOrderNumber": "sample string 6",
    "NSOrderInternalId": "sample string 7",
    "NSReturnAuthorizationNumber": "sample string 8",
    "NSReturnInternalId": "sample string 9",
    "NSReturnStatus": "sample string 10",
    "FirstName": "sample string 11",
    "LastName": "sample string 12",
    "EmailAddress": "sample string 13",
    "PaymentMethod": "sample string 14",
    "ReturnReason": "sample string 15",
    "RefundMethod": "sample string 16",
    "ReturnMethod": "sample string 17",
    "Notes": "sample string 18",
    "ErrorMessage": "sample string 19",
    "ReturnItems": [
      {
        "Sku": "sample string 1",
        "NSInternalId": "sample string 2",
        "SiteItemId": "sample string 3",
        "Quantity": 4,
        "Cost": 5.1,
        "ItemTax": 6.1,
        "ItemTotal": 7.1,
        "Weight": 8.1
      },
      {
        "Sku": "sample string 1",
        "NSInternalId": "sample string 2",
        "SiteItemId": "sample string 3",
        "Quantity": 4,
        "Cost": 5.1,
        "ItemTax": 6.1,
        "ItemTotal": 7.1,
        "Weight": 8.1
      }
    ],
    "data": {
      "total_refund_amount": 1.1,
      "total_refund_tax_amount": 2.1,
      "rounding": 3.1,
      "adjustment": 4.1,
      "is_tax_included": true,
      "order_level_refund_amount": 6.1,
      "refund_methods": [
        [
          {
            "provider_id": "sample string 1",
            "provider_description": "sample string 2",
            "amount": 3.1,
            "offline": true,
            "offline_provider": true,
            "offline_reason": "sample string 6"
          },
          {
            "provider_id": "sample string 1",
            "provider_description": "sample string 2",
            "amount": 3.1,
            "offline": true,
            "offline_provider": true,
            "offline_reason": "sample string 6"
          }
        ],
        [
          {
            "provider_id": "sample string 1",
            "provider_description": "sample string 2",
            "amount": 3.1,
            "offline": true,
            "offline_provider": true,
            "offline_reason": "sample string 6"
          },
          {
            "provider_id": "sample string 1",
            "provider_description": "sample string 2",
            "amount": 3.1,
            "offline": true,
            "offline_provider": true,
            "offline_reason": "sample string 6"
          }
        ]
      ]
    },
    "StoreCreditAdjustment": 20.1,
    "ReturnShipping": 21.1,
    "ReturnFee": 22.1,
    "ReturnItems_price_total": 23.1,
    "ReturnItems_tax_total": 24.1,
    "ReturnItems_total_before_any_discount": 25.1,
    "Bonus": 26.1,
    "Discount": 27.1,
    "ReturnTotal": 28.1,
    "RewardsPointsAdjustment": 29,
    "LabelLocation": "sample string 30",
    "ReturnTrackingNumber": "sample string 31",
    "ReturnPackageWeight": 32.1,
    "CreatedDate": "2024-09-11T15:25:55.0424694+00:00",
    "ModifiedDate": "2024-09-11T15:25:55.0424694+00:00",
    "CreatedBy": "sample string 35",
    "ModifiedBy": "sample string 36",
    "ShippingAddress": {
      "Name": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "AddressName": "sample string 4",
      "CompanyName": "sample string 5",
      "AddressLine1": "sample string 6",
      "AddressLine2": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "Zip": "sample string 10",
      "Country": "sample string 11",
      "HomePhone": "sample string 12",
      "MobilePhone": "sample string 13"
    },
    "return_email_sent": "sample string 37",
    "return_complete_email_sent": "sample string 38",
    "InTransitDate": "2024-09-11T15:25:55.0424694+00:00",
    "intransit_email_sent": "sample string 40"
  }
}

application/xml, text/xml

Sample:

<OrderReturn xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <emailBody>sample string 1</emailBody>
  <returnModel>
    <Id>sample string 1</Id>
    <Type>sample string 2</Type>
    <ReturnNumber>3</ReturnNumber>
    <ReturnStatus>sample string 4</ReturnStatus>
    <SiteOrderNumber>sample string 5</SiteOrderNumber>
    <NSOrderNumber>sample string 6</NSOrderNumber>
    <NSOrderInternalId>sample string 7</NSOrderInternalId>
    <NSReturnAuthorizationNumber>sample string 8</NSReturnAuthorizationNumber>
    <NSReturnInternalId>sample string 9</NSReturnInternalId>
    <NSReturnStatus>sample string 10</NSReturnStatus>
    <FirstName>sample string 11</FirstName>
    <LastName>sample string 12</LastName>
    <EmailAddress>sample string 13</EmailAddress>
    <PaymentMethod>sample string 14</PaymentMethod>
    <ReturnReason>sample string 15</ReturnReason>
    <RefundMethod>sample string 16</RefundMethod>
    <ReturnMethod>sample string 17</ReturnMethod>
    <Notes>sample string 18</Notes>
    <ErrorMessage>sample string 19</ErrorMessage>
    <ReturnItems>
      <ReturnItem>
        <Sku>sample string 1</Sku>
        <NSInternalId>sample string 2</NSInternalId>
        <SiteItemId>sample string 3</SiteItemId>
        <Quantity>4</Quantity>
        <Cost>5.1</Cost>
        <ItemTax>6.1</ItemTax>
        <ItemTotal>7.1</ItemTotal>
        <Weight>8.1</Weight>
      </ReturnItem>
      <ReturnItem>
        <Sku>sample string 1</Sku>
        <NSInternalId>sample string 2</NSInternalId>
        <SiteItemId>sample string 3</SiteItemId>
        <Quantity>4</Quantity>
        <Cost>5.1</Cost>
        <ItemTax>6.1</ItemTax>
        <ItemTotal>7.1</ItemTotal>
        <Weight>8.1</Weight>
      </ReturnItem>
    </ReturnItems>
    <data>
      <total_refund_amount>1.1</total_refund_amount>
      <total_refund_tax_amount>2.1</total_refund_tax_amount>
      <rounding>3.1</rounding>
      <adjustment>4.1</adjustment>
      <is_tax_included>true</is_tax_included>
      <order_level_refund_amount>6.1</order_level_refund_amount>
      <refund_methods>
        <ArrayOfBCRefundMethods>
          <BCRefundMethods>
            <provider_id>sample string 1</provider_id>
            <provider_description>sample string 2</provider_description>
            <amount>3.1</amount>
            <offline>true</offline>
            <offline_provider>true</offline_provider>
            <offline_reason>sample string 6</offline_reason>
          </BCRefundMethods>
          <BCRefundMethods>
            <provider_id>sample string 1</provider_id>
            <provider_description>sample string 2</provider_description>
            <amount>3.1</amount>
            <offline>true</offline>
            <offline_provider>true</offline_provider>
            <offline_reason>sample string 6</offline_reason>
          </BCRefundMethods>
        </ArrayOfBCRefundMethods>
        <ArrayOfBCRefundMethods>
          <BCRefundMethods>
            <provider_id>sample string 1</provider_id>
            <provider_description>sample string 2</provider_description>
            <amount>3.1</amount>
            <offline>true</offline>
            <offline_provider>true</offline_provider>
            <offline_reason>sample string 6</offline_reason>
          </BCRefundMethods>
          <BCRefundMethods>
            <provider_id>sample string 1</provider_id>
            <provider_description>sample string 2</provider_description>
            <amount>3.1</amount>
            <offline>true</offline>
            <offline_provider>true</offline_provider>
            <offline_reason>sample string 6</offline_reason>
          </BCRefundMethods>
        </ArrayOfBCRefundMethods>
      </refund_methods>
    </data>
    <StoreCreditAdjustment>20.1</StoreCreditAdjustment>
    <ReturnShipping>21.1</ReturnShipping>
    <ReturnFee>22.1</ReturnFee>
    <ReturnItems_price_total>23.1</ReturnItems_price_total>
    <ReturnItems_tax_total>24.1</ReturnItems_tax_total>
    <ReturnItems_total_before_any_discount>25.1</ReturnItems_total_before_any_discount>
    <Bonus>26.1</Bonus>
    <Discount>27.1</Discount>
    <ReturnTotal>28.1</ReturnTotal>
    <RewardsPointsAdjustment>29</RewardsPointsAdjustment>
    <LabelLocation>sample string 30</LabelLocation>
    <ReturnTrackingNumber>sample string 31</ReturnTrackingNumber>
    <ReturnPackageWeight>32.1</ReturnPackageWeight>
    <CreatedDate>2024-09-11T15:25:55.0424694+00:00</CreatedDate>
    <ModifiedDate>2024-09-11T15:25:55.0424694+00:00</ModifiedDate>
    <CreatedBy>sample string 35</CreatedBy>
    <ModifiedBy>sample string 36</ModifiedBy>
    <ShippingAddress>
      <Name>sample string 1</Name>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <AddressName>sample string 4</AddressName>
      <CompanyName>sample string 5</CompanyName>
      <AddressLine1>sample string 6</AddressLine1>
      <AddressLine2>sample string 7</AddressLine2>
      <City>sample string 8</City>
      <State>sample string 9</State>
      <Zip>sample string 10</Zip>
      <Country>sample string 11</Country>
      <HomePhone>sample string 12</HomePhone>
      <MobilePhone>sample string 13</MobilePhone>
    </ShippingAddress>
    <return_email_sent>sample string 37</return_email_sent>
    <return_complete_email_sent>sample string 38</return_complete_email_sent>
    <InTransitDate>2024-09-11T15:25:55.0424694+00:00</InTransitDate>
    <intransit_email_sent>sample string 40</intransit_email_sent>
  </returnModel>
</OrderReturn>

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.