GET api/returnAuthorizations/{rmaNumber}

Retrieves the return authorization associated with the specified RMA number.

Request Information

URI Parameters

Name Type Description Additional information
rmaNumber string

The return merchandise authorization (RMA) number identifying the return authorization to retrieve. Cannot be null or empty.

Required

Body Parameters

None

Response Information

Resource Description

An HTTP response containing the return authorization if found; otherwise, a response indicating that the resource was not found.

ReturnAuthorization
Name Type Description Additional information
Id integer

ClientName string

OriginalOrderNumber string

RmaNumber string

ReturnReason string

Name string

Address1 string

Address2 string

Address3 string

City string

State string

PostalCode string

Country string

Phone string

WarehouseCode string

OutgoingWarehouseCode string

ReturnStatus string

CreateDateTime date

ModifiedDateTime date

Items Collection of ReturnAuthorizationItem

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "ClientName": "sample string 2",
  "OriginalOrderNumber": "sample string 3",
  "RmaNumber": "sample string 4",
  "ReturnReason": "sample string 5",
  "Name": "sample string 6",
  "Address1": "sample string 7",
  "Address2": "sample string 8",
  "Address3": "sample string 9",
  "City": "sample string 10",
  "State": "sample string 11",
  "PostalCode": "sample string 12",
  "Country": "sample string 13",
  "Phone": "sample string 14",
  "WarehouseCode": "sample string 15",
  "OutgoingWarehouseCode": "sample string 16",
  "ReturnStatus": "sample string 17",
  "CreateDateTime": "2026-04-07T17:49:47.7567054+00:00",
  "ModifiedDateTime": "2026-04-07T17:49:47.7567054+00:00",
  "Items": [
    {
      "Id": 1,
      "ReturnAuthorizationId": 2,
      "ItemCode": "sample string 3",
      "Quantity": 4,
      "IsHeavyItem": true,
      "LotNumber": "sample string 6",
      "ExpirationDate": "2026-04-07T17:49:47.7567054+00:00",
      "CreateDateTime": "2026-04-07T17:49:47.7567054+00:00",
      "ModifiedDateTime": "2026-04-07T17:49:47.7567054+00:00",
      "Serials": [
        {
          "Id": 1,
          "ReturnAuthorizationItemId": 2,
          "SerialNumber": "sample string 3",
          "AltSerialNumber": "sample string 4"
        },
        {
          "Id": 1,
          "ReturnAuthorizationItemId": 2,
          "SerialNumber": "sample string 3",
          "AltSerialNumber": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "ReturnAuthorizationId": 2,
      "ItemCode": "sample string 3",
      "Quantity": 4,
      "IsHeavyItem": true,
      "LotNumber": "sample string 6",
      "ExpirationDate": "2026-04-07T17:49:47.7567054+00:00",
      "CreateDateTime": "2026-04-07T17:49:47.7567054+00:00",
      "ModifiedDateTime": "2026-04-07T17:49:47.7567054+00:00",
      "Serials": [
        {
          "Id": 1,
          "ReturnAuthorizationItemId": 2,
          "SerialNumber": "sample string 3",
          "AltSerialNumber": "sample string 4"
        },
        {
          "Id": 1,
          "ReturnAuthorizationItemId": 2,
          "SerialNumber": "sample string 3",
          "AltSerialNumber": "sample string 4"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<ReturnAuthorization xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <ClientName>sample string 2</ClientName>
  <OriginalOrderNumber>sample string 3</OriginalOrderNumber>
  <RmaNumber>sample string 4</RmaNumber>
  <ReturnReason>sample string 5</ReturnReason>
  <Name>sample string 6</Name>
  <Address1>sample string 7</Address1>
  <Address2>sample string 8</Address2>
  <Address3>sample string 9</Address3>
  <City>sample string 10</City>
  <State>sample string 11</State>
  <PostalCode>sample string 12</PostalCode>
  <Country>sample string 13</Country>
  <Phone>sample string 14</Phone>
  <WarehouseCode>sample string 15</WarehouseCode>
  <OutgoingWarehouseCode>sample string 16</OutgoingWarehouseCode>
  <ReturnStatus>sample string 17</ReturnStatus>
  <CreateDateTime>2026-04-07T17:49:47.7567054+00:00</CreateDateTime>
  <ModifiedDateTime>2026-04-07T17:49:47.7567054+00:00</ModifiedDateTime>
  <Items>
    <ReturnAuthorizationItem>
      <Id>1</Id>
      <ReturnAuthorizationId>2</ReturnAuthorizationId>
      <ItemCode>sample string 3</ItemCode>
      <Quantity>4</Quantity>
      <IsHeavyItem>true</IsHeavyItem>
      <LotNumber>sample string 6</LotNumber>
      <ExpirationDate>2026-04-07T17:49:47.7567054+00:00</ExpirationDate>
      <CreateDateTime>2026-04-07T17:49:47.7567054+00:00</CreateDateTime>
      <ModifiedDateTime>2026-04-07T17:49:47.7567054+00:00</ModifiedDateTime>
      <Serials>
        <ReturnAuthorizationItemSerial>
          <Id>1</Id>
          <ReturnAuthorizationItemId>2</ReturnAuthorizationItemId>
          <SerialNumber>sample string 3</SerialNumber>
          <AltSerialNumber>sample string 4</AltSerialNumber>
        </ReturnAuthorizationItemSerial>
        <ReturnAuthorizationItemSerial>
          <Id>1</Id>
          <ReturnAuthorizationItemId>2</ReturnAuthorizationItemId>
          <SerialNumber>sample string 3</SerialNumber>
          <AltSerialNumber>sample string 4</AltSerialNumber>
        </ReturnAuthorizationItemSerial>
      </Serials>
    </ReturnAuthorizationItem>
    <ReturnAuthorizationItem>
      <Id>1</Id>
      <ReturnAuthorizationId>2</ReturnAuthorizationId>
      <ItemCode>sample string 3</ItemCode>
      <Quantity>4</Quantity>
      <IsHeavyItem>true</IsHeavyItem>
      <LotNumber>sample string 6</LotNumber>
      <ExpirationDate>2026-04-07T17:49:47.7567054+00:00</ExpirationDate>
      <CreateDateTime>2026-04-07T17:49:47.7567054+00:00</CreateDateTime>
      <ModifiedDateTime>2026-04-07T17:49:47.7567054+00:00</ModifiedDateTime>
      <Serials>
        <ReturnAuthorizationItemSerial>
          <Id>1</Id>
          <ReturnAuthorizationItemId>2</ReturnAuthorizationItemId>
          <SerialNumber>sample string 3</SerialNumber>
          <AltSerialNumber>sample string 4</AltSerialNumber>
        </ReturnAuthorizationItemSerial>
        <ReturnAuthorizationItemSerial>
          <Id>1</Id>
          <ReturnAuthorizationItemId>2</ReturnAuthorizationItemId>
          <SerialNumber>sample string 3</SerialNumber>
          <AltSerialNumber>sample string 4</AltSerialNumber>
        </ReturnAuthorizationItemSerial>
      </Serials>
    </ReturnAuthorizationItem>
  </Items>
</ReturnAuthorization>