GET api/OmsRmaManagement/reporting-model?rmaNumber={rmaNumber}&siteId={siteId}

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
rmaNumber

string

None.
siteId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

RmaManagementModelResponse

NameDescriptionTypeAdditional Information
Model

RmaManagementModel

None.
ResponseCode

APIResponseCodes

None.
Message

string

None.
CorrelationId

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Model": {
    "Sites": null,
    "ReportData": [
      {
        "DateCreatedLocalized": "sample string 1",
        "RmaAutoCancelDateLocalized": "sample string 2",
        "RmaID": 3,
        "RmaNumber": "sample string 4",
        "DateCreatedUTC": "2025-12-20T22:01:03.6849451+00:00",
        "RmaStatus": 1,
        "GracePeriodUTC": "2025-12-20T22:01:03.6849451+00:00",
        "Orders": null,
        "RmaAutoCancelDateUTC": "2025-12-20T22:01:03.6849451+00:00",
        "RmaStatusNameLocalized": "sample string 7",
        "ReturnInvoiceNumber": "sample string 8",
        "RefundToGiftCard": true,
        "GiftCardRecipientName": "sample string 10",
        "GiftCardRecipientEmail": "sample string 11",
        "ExternalReturnId": "sample string 12"
      },
      {
        "DateCreatedLocalized": "sample string 1",
        "RmaAutoCancelDateLocalized": "sample string 2",
        "RmaID": 3,
        "RmaNumber": "sample string 4",
        "DateCreatedUTC": "2025-12-20T22:01:03.6849451+00:00",
        "RmaStatus": 1,
        "GracePeriodUTC": "2025-12-20T22:01:03.6849451+00:00",
        "Orders": null,
        "RmaAutoCancelDateUTC": "2025-12-20T22:01:03.6849451+00:00",
        "RmaStatusNameLocalized": "sample string 7",
        "ReturnInvoiceNumber": "sample string 8",
        "RefundToGiftCard": true,
        "GiftCardRecipientName": "sample string 10",
        "GiftCardRecipientEmail": "sample string 11",
        "ExternalReturnId": "sample string 12"
      }
    ],
    "CurrentSite": 1,
    "RmaNumber": "sample string 2",
    "OrderNumber": "sample string 3",
    "ReportStartDate": "sample string 4",
    "ReportEndDate": "sample string 5",
    "SearchType": 0,
    "RmaStatusID": 6,
    "TimeZone": "sample string 7",
    "SuccessMessage": "sample string 8",
    "RmaStatuses": null,
    "SearchTypes": null,
    "LocaleId": 9
  },
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample: 
<RmaManagementModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 2</CorrelationId>
  <Message xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 1</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">Success</ResponseCode>
  <Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:CurrentSite>1</d2p1:CurrentSite>
    <d2p1:LocaleId>9</d2p1:LocaleId>
    <d2p1:OrderNumber>sample string 3</d2p1:OrderNumber>
    <d2p1:ReportData>
      <d2p1:RmaModel>
        <d2p1:DateCreatedUTC>2025-12-20T22:01:03.6849451+00:00</d2p1:DateCreatedUTC>
        <d2p1:ExternalReturnId>sample string 12</d2p1:ExternalReturnId>
        <d2p1:GiftCardRecipientEmail>sample string 11</d2p1:GiftCardRecipientEmail>
        <d2p1:GiftCardRecipientName>sample string 10</d2p1:GiftCardRecipientName>
        <d2p1:GracePeriodUTC>2025-12-20T22:01:03.6849451+00:00</d2p1:GracePeriodUTC>
        <d2p1:Orders xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:RefundToGiftCard>true</d2p1:RefundToGiftCard>
        <d2p1:ReturnInvoiceNumber>sample string 8</d2p1:ReturnInvoiceNumber>
        <d2p1:RmaAutoCancelDateUTC>2025-12-20T22:01:03.6849451+00:00</d2p1:RmaAutoCancelDateUTC>
        <d2p1:RmaID>3</d2p1:RmaID>
        <d2p1:RmaNumber>sample string 4</d2p1:RmaNumber>
        <d2p1:RmaStatus>New</d2p1:RmaStatus>
        <d2p1:RmaStatusNameLocalized>sample string 7</d2p1:RmaStatusNameLocalized>
        <d2p1:DateCreatedLocalized>sample string 1</d2p1:DateCreatedLocalized>
        <d2p1:RmaAutoCancelDateLocalized>sample string 2</d2p1:RmaAutoCancelDateLocalized>
      </d2p1:RmaModel>
      <d2p1:RmaModel>
        <d2p1:DateCreatedUTC>2025-12-20T22:01:03.6849451+00:00</d2p1:DateCreatedUTC>
        <d2p1:ExternalReturnId>sample string 12</d2p1:ExternalReturnId>
        <d2p1:GiftCardRecipientEmail>sample string 11</d2p1:GiftCardRecipientEmail>
        <d2p1:GiftCardRecipientName>sample string 10</d2p1:GiftCardRecipientName>
        <d2p1:GracePeriodUTC>2025-12-20T22:01:03.6849451+00:00</d2p1:GracePeriodUTC>
        <d2p1:Orders xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:RefundToGiftCard>true</d2p1:RefundToGiftCard>
        <d2p1:ReturnInvoiceNumber>sample string 8</d2p1:ReturnInvoiceNumber>
        <d2p1:RmaAutoCancelDateUTC>2025-12-20T22:01:03.6849451+00:00</d2p1:RmaAutoCancelDateUTC>
        <d2p1:RmaID>3</d2p1:RmaID>
        <d2p1:RmaNumber>sample string 4</d2p1:RmaNumber>
        <d2p1:RmaStatus>New</d2p1:RmaStatus>
        <d2p1:RmaStatusNameLocalized>sample string 7</d2p1:RmaStatusNameLocalized>
        <d2p1:DateCreatedLocalized>sample string 1</d2p1:DateCreatedLocalized>
        <d2p1:RmaAutoCancelDateLocalized>sample string 2</d2p1:RmaAutoCancelDateLocalized>
      </d2p1:RmaModel>
    </d2p1:ReportData>
    <d2p1:ReportEndDate>sample string 5</d2p1:ReportEndDate>
    <d2p1:ReportStartDate>sample string 4</d2p1:ReportStartDate>
    <d2p1:RmaNumber>sample string 2</d2p1:RmaNumber>
    <d2p1:RmaStatusID>6</d2p1:RmaStatusID>
    <d2p1:RmaStatuses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:SearchType>Date</d2p1:SearchType>
    <d2p1:SearchTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:SuccessMessage>sample string 8</d2p1:SuccessMessage>
    <d2p1:TimeZone>sample string 7</d2p1:TimeZone>
  </Model>
</RmaManagementModelResponse>