POST api/OmsRmaInboundReturn

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
RmaNumber	string	None.
Items	Collection of RmaReturnInboundItem	None.
ReturnInvoiceNumber	string	None.
ReturnWarehouseCode	string	None.
ReturnUser	string	None.
IssueRefundToGiftCard	boolean	None.
GiftCardRecipientName	string	None.
GiftCardRecipientEmail	string	None.
SiteCode	string	None.
VerificationKey	string	None.
TimestampUTC	string	None.
ResponseCallbackUri	string	None.
APIUsername	string	None.
IDToken	string	None.
UserAccount	Account	None.
UserdID	integer	None.
IsValidJwtToken	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "RmaNumber": "sample string 1",
  "Items": [
    {
      "SKU": "sample string 1",
      "GTIN": "sample string 2",
      "ExternalItemID": "sample string 3",
      "ReturnReasonID": 4,
      "ReturnTypeID": 5,
      "ReturnReasonText": "sample string 6",
      "Quantity": 1,
      "Extended": [
        {
          "ID": 2,
          "Key": "sample string 3",
          "Value": "sample string 4",
          "Additional": "sample string 5",
          "ReadOnly": true
        },
        {
          "ID": 2,
          "Key": "sample string 3",
          "Value": "sample string 4",
          "Additional": "sample string 5",
          "ReadOnly": true
        }
      ],
      "OrderItemID": 7
    },
    {
      "SKU": "sample string 1",
      "GTIN": "sample string 2",
      "ExternalItemID": "sample string 3",
      "ReturnReasonID": 4,
      "ReturnTypeID": 5,
      "ReturnReasonText": "sample string 6",
      "Quantity": 1,
      "Extended": [
        {
          "ID": 2,
          "Key": "sample string 3",
          "Value": "sample string 4",
          "Additional": "sample string 5",
          "ReadOnly": true
        },
        {
          "ID": 2,
          "Key": "sample string 3",
          "Value": "sample string 4",
          "Additional": "sample string 5",
          "ReadOnly": true
        }
      ],
      "OrderItemID": 7
    }
  ],
  "ReturnInvoiceNumber": "sample string 2",
  "ReturnWarehouseCode": "sample string 3",
  "ReturnUser": "sample string 4",
  "IssueRefundToGiftCard": true,
  "GiftCardRecipientName": "sample string 6",
  "GiftCardRecipientEmail": "sample string 7",
  "SiteCode": "sample string 8",
  "VerificationKey": "sample string 9",
  "TimestampUTC": "sample string 10",
  "ResponseCallbackUri": "sample string 11",
  "APIUsername": "sample string 12",
  "IDToken": "sample string 13",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T22:00:23.1063099+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T22:00:23.1063099+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T22:00:23.1063099+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T22:00:23.1063099+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T22:00:23.1063099+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T22:00:23.1063099+00:00",
    "ApiKey": "sample string 21",
    "FederatedID": "sample string 22",
    "FirstName": "sample string 23",
    "LastName": "sample string 24",
    "FullName": "sample string 23sample string 24"
  },
  "UserdID": 14,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<RmaInboundReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <APIUsername xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 12</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 13</IDToken>
  <IsValidJwtToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">true</IsValidJwtToken>
  <ResponseCallbackUri xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 11</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 8</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 10</TimestampUTC>
  <UserAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.Core.Domain.Membership.Models" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">
    <d2p1:ApiKey>sample string 21</d2p1:ApiKey>
    <d2p1:ConfirmationToken>sample string 4</d2p1:ConfirmationToken>
    <d2p1:CreateDate>2025-12-20T22:00:23.1063099+00:00</d2p1:CreateDate>
    <d2p1:FederatedID>sample string 22</d2p1:FederatedID>
    <d2p1:FirstName>sample string 23</d2p1:FirstName>
    <d2p1:IsArchived>true</d2p1:IsArchived>
    <d2p1:IsAuthorized>true</d2p1:IsAuthorized>
    <d2p1:IsConfirmed>true</d2p1:IsConfirmed>
    <d2p1:LastName>sample string 24</d2p1:LastName>
    <d2p1:LastPasswordFailureDate>2025-12-20T22:00:23.1063099+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T22:00:23.1063099+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T22:00:23.1063099+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T22:00:23.1063099+00:00</d2p1:PasswordChangedDate>
    <d2p1:PasswordFailuresSinceLastSuccess>7</d2p1:PasswordFailuresSinceLastSuccess>
    <d2p1:PasswordSalt>sample string 10</d2p1:PasswordSalt>
    <d2p1:PasswordVerificationToken>sample string 11</d2p1:PasswordVerificationToken>
    <d2p1:PasswordVerificationTokenExpirationDate>2025-12-20T22:00:23.1063099+00:00</d2p1:PasswordVerificationTokenExpirationDate>
    <d2p1:SecurityAnswer>sample string 14</d2p1:SecurityAnswer>
    <d2p1:SecurityFailuresSinceLastSuccess>15</d2p1:SecurityFailuresSinceLastSuccess>
    <d2p1:SecurityQuestion>sample string 13</d2p1:SecurityQuestion>
    <d2p1:UserID>1</d2p1:UserID>
    <d2p1:Username>sample string 2</d2p1:Username>
  </UserAccount>
  <UserdID xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">14</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 9</VerificationKey>
  <GiftCardRecipientEmail>sample string 7</GiftCardRecipientEmail>
  <GiftCardRecipientName>sample string 6</GiftCardRecipientName>
  <IssueRefundToGiftCard>true</IssueRefundToGiftCard>
  <Items>
    <RmaReturnInboundItem>
      <Extended xmlns:d4p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
        <d4p1:Extended>
          <d4p1:Additional>sample string 5</d4p1:Additional>
          <d4p1:ID>2</d4p1:ID>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:ReadOnly>true</d4p1:ReadOnly>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:Extended>
        <d4p1:Extended>
          <d4p1:Additional>sample string 5</d4p1:Additional>
          <d4p1:ID>2</d4p1:ID>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:ReadOnly>true</d4p1:ReadOnly>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:Extended>
      </Extended>
      <ExternalItemID>sample string 3</ExternalItemID>
      <GTIN>sample string 2</GTIN>
      <OrderItemID>7</OrderItemID>
      <Quantity>1</Quantity>
      <ReturnReasonID>4</ReturnReasonID>
      <ReturnReasonText>sample string 6</ReturnReasonText>
      <ReturnTypeID>5</ReturnTypeID>
      <SKU>sample string 1</SKU>
    </RmaReturnInboundItem>
    <RmaReturnInboundItem>
      <Extended xmlns:d4p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
        <d4p1:Extended>
          <d4p1:Additional>sample string 5</d4p1:Additional>
          <d4p1:ID>2</d4p1:ID>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:ReadOnly>true</d4p1:ReadOnly>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:Extended>
        <d4p1:Extended>
          <d4p1:Additional>sample string 5</d4p1:Additional>
          <d4p1:ID>2</d4p1:ID>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:ReadOnly>true</d4p1:ReadOnly>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:Extended>
      </Extended>
      <ExternalItemID>sample string 3</ExternalItemID>
      <GTIN>sample string 2</GTIN>
      <OrderItemID>7</OrderItemID>
      <Quantity>1</Quantity>
      <ReturnReasonID>4</ReturnReasonID>
      <ReturnReasonText>sample string 6</ReturnReasonText>
      <ReturnTypeID>5</ReturnTypeID>
      <SKU>sample string 1</SKU>
    </RmaReturnInboundItem>
  </Items>
  <ReturnInvoiceNumber>sample string 2</ReturnInvoiceNumber>
  <ReturnUser>sample string 4</ReturnUser>
  <ReturnWarehouseCode>sample string 3</ReturnWarehouseCode>
  <RmaNumber>sample string 1</RmaNumber>
</RmaInboundReturn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RmaInboundReturnResponse

Name	Type	Additional Information
Items	Collection of RmaReturnItemResponse	None.
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "SKU": "sample string 1",
      "GTIN": "sample string 2",
      "ExternalItemID": "sample string 3",
      "OrderNumber": "sample string 4",
      "ResponseCode": 0,
      "Message": "sample string 5",
      "CorrelationId": "sample string 6"
    },
    {
      "SKU": "sample string 1",
      "GTIN": "sample string 2",
      "ExternalItemID": "sample string 3",
      "OrderNumber": "sample string 4",
      "ResponseCode": 0,
      "Message": "sample string 5",
      "CorrelationId": "sample string 6"
    }
  ],
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<RmaInboundReturnResponse 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>
  <Items>
    <RmaReturnItemResponse>
      <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 6</CorrelationId>
      <Message xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 5</Message>
      <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">Success</ResponseCode>
      <ExternalItemID>sample string 3</ExternalItemID>
      <GTIN>sample string 2</GTIN>
      <OrderNumber>sample string 4</OrderNumber>
      <SKU>sample string 1</SKU>
    </RmaReturnItemResponse>
    <RmaReturnItemResponse>
      <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 6</CorrelationId>
      <Message xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 5</Message>
      <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">Success</ResponseCode>
      <ExternalItemID>sample string 3</ExternalItemID>
      <GTIN>sample string 2</GTIN>
      <OrderNumber>sample string 4</OrderNumber>
      <SKU>sample string 1</SKU>
    </RmaReturnItemResponse>
  </Items>
</RmaInboundReturnResponse>