POST api/OmsRmaCreate

Take the importOrder and process it. If its bad, send the errors back to the user.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
RmaNumber	string	None.
Orders	Collection of RmaInboundCreateOrder	None.
ReturnInvoiceNumber	string	None.
RefundToGiftCard	boolean	None.
GiftCardRecipientName	string	None.
GiftCardRecipientEmail	string	None.
ExternalReturnId	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",
  "Orders": [
    {
      "OrderNumber": "sample string 1",
      "OrderId": 2,
      "Items": [
        {
          "TrackingNumber": "sample string 1",
          "CarrierCode": "sample string 2",
          "SKU": "sample string 3",
          "GTIN": "sample string 4",
          "ExternalItemID": "sample string 5",
          "OrderItemID": 6,
          "PhysicalReturnNotRequired": true,
          "ReturnNoCredit": true,
          "ReturnReasonID": 9,
          "ReturnTypeID": 10,
          "Quantity": 1,
          "ReturnReasonText": "sample string 11",
          "ReturnLabelURL": "sample string 12",
          "ReturnLocationID": 13,
          "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
            }
          ]
        },
        {
          "TrackingNumber": "sample string 1",
          "CarrierCode": "sample string 2",
          "SKU": "sample string 3",
          "GTIN": "sample string 4",
          "ExternalItemID": "sample string 5",
          "OrderItemID": 6,
          "PhysicalReturnNotRequired": true,
          "ReturnNoCredit": true,
          "ReturnReasonID": 9,
          "ReturnTypeID": 10,
          "Quantity": 1,
          "ReturnReasonText": "sample string 11",
          "ReturnLabelURL": "sample string 12",
          "ReturnLocationID": 13,
          "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
            }
          ]
        }
      ],
      "ShippingCredit": 3.0,
      "RmaProcessingCharge": 4.0,
      "ReturnLabelURL": "sample string 5"
    },
    {
      "OrderNumber": "sample string 1",
      "OrderId": 2,
      "Items": [
        {
          "TrackingNumber": "sample string 1",
          "CarrierCode": "sample string 2",
          "SKU": "sample string 3",
          "GTIN": "sample string 4",
          "ExternalItemID": "sample string 5",
          "OrderItemID": 6,
          "PhysicalReturnNotRequired": true,
          "ReturnNoCredit": true,
          "ReturnReasonID": 9,
          "ReturnTypeID": 10,
          "Quantity": 1,
          "ReturnReasonText": "sample string 11",
          "ReturnLabelURL": "sample string 12",
          "ReturnLocationID": 13,
          "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
            }
          ]
        },
        {
          "TrackingNumber": "sample string 1",
          "CarrierCode": "sample string 2",
          "SKU": "sample string 3",
          "GTIN": "sample string 4",
          "ExternalItemID": "sample string 5",
          "OrderItemID": 6,
          "PhysicalReturnNotRequired": true,
          "ReturnNoCredit": true,
          "ReturnReasonID": 9,
          "ReturnTypeID": 10,
          "Quantity": 1,
          "ReturnReasonText": "sample string 11",
          "ReturnLabelURL": "sample string 12",
          "ReturnLocationID": 13,
          "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
            }
          ]
        }
      ],
      "ShippingCredit": 3.0,
      "RmaProcessingCharge": 4.0,
      "ReturnLabelURL": "sample string 5"
    }
  ],
  "ReturnInvoiceNumber": "sample string 2",
  "RefundToGiftCard": true,
  "GiftCardRecipientName": "sample string 4",
  "GiftCardRecipientEmail": "sample string 5",
  "ExternalReturnId": "sample string 6",
  "SiteCode": "sample string 7",
  "VerificationKey": "sample string 8",
  "TimestampUTC": "sample string 9",
  "ResponseCallbackUri": "sample string 10",
  "APIUsername": "sample string 11",
  "IDToken": "sample string 12",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T21:59:26.8139678+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T21:59:26.8139678+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T21:59:26.8139678+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T21:59:26.8139678+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T21:59:26.8139678+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T21:59:26.8139678+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": 13,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<RmaInboundCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Common.Contracts.API">
  <APIUsername xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 11</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 12</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 10</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 7</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 9</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-20T21:59:26.8139678+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-20T21:59:26.8139678+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T21:59:26.8139678+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T21:59:26.8139678+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T21:59:26.8139678+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-20T21:59:26.8139678+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">13</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 8</VerificationKey>
  <ExternalReturnId>sample string 6</ExternalReturnId>
  <GiftCardRecipientEmail>sample string 5</GiftCardRecipientEmail>
  <GiftCardRecipientName>sample string 4</GiftCardRecipientName>
  <Orders>
    <RmaInboundCreateOrder>
      <Items>
        <RmaInboundCreateOrderItem>
          <CarrierCode>sample string 2</CarrierCode>
          <Extended xmlns:d6p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
            <d6p1:Extended>
              <d6p1:Additional>sample string 5</d6p1:Additional>
              <d6p1:ID>2</d6p1:ID>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:ReadOnly>true</d6p1:ReadOnly>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:Extended>
            <d6p1:Extended>
              <d6p1:Additional>sample string 5</d6p1:Additional>
              <d6p1:ID>2</d6p1:ID>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:ReadOnly>true</d6p1:ReadOnly>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:Extended>
          </Extended>
          <ExternalItemID>sample string 5</ExternalItemID>
          <GTIN>sample string 4</GTIN>
          <OrderItemID>6</OrderItemID>
          <PhysicalReturnNotRequired>true</PhysicalReturnNotRequired>
          <Quantity>1</Quantity>
          <ReturnLabelURL>sample string 12</ReturnLabelURL>
          <ReturnLocationID>13</ReturnLocationID>
          <ReturnNoCredit>true</ReturnNoCredit>
          <ReturnReasonID>9</ReturnReasonID>
          <ReturnReasonText>sample string 11</ReturnReasonText>
          <ReturnTypeID>10</ReturnTypeID>
          <SKU>sample string 3</SKU>
          <TrackingNumber>sample string 1</TrackingNumber>
        </RmaInboundCreateOrderItem>
        <RmaInboundCreateOrderItem>
          <CarrierCode>sample string 2</CarrierCode>
          <Extended xmlns:d6p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
            <d6p1:Extended>
              <d6p1:Additional>sample string 5</d6p1:Additional>
              <d6p1:ID>2</d6p1:ID>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:ReadOnly>true</d6p1:ReadOnly>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:Extended>
            <d6p1:Extended>
              <d6p1:Additional>sample string 5</d6p1:Additional>
              <d6p1:ID>2</d6p1:ID>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:ReadOnly>true</d6p1:ReadOnly>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:Extended>
          </Extended>
          <ExternalItemID>sample string 5</ExternalItemID>
          <GTIN>sample string 4</GTIN>
          <OrderItemID>6</OrderItemID>
          <PhysicalReturnNotRequired>true</PhysicalReturnNotRequired>
          <Quantity>1</Quantity>
          <ReturnLabelURL>sample string 12</ReturnLabelURL>
          <ReturnLocationID>13</ReturnLocationID>
          <ReturnNoCredit>true</ReturnNoCredit>
          <ReturnReasonID>9</ReturnReasonID>
          <ReturnReasonText>sample string 11</ReturnReasonText>
          <ReturnTypeID>10</ReturnTypeID>
          <SKU>sample string 3</SKU>
          <TrackingNumber>sample string 1</TrackingNumber>
        </RmaInboundCreateOrderItem>
      </Items>
      <OrderId>2</OrderId>
      <OrderNumber>sample string 1</OrderNumber>
      <ReturnLabelURL>sample string 5</ReturnLabelURL>
      <RmaProcessingCharge>4</RmaProcessingCharge>
      <ShippingCredit>3</ShippingCredit>
    </RmaInboundCreateOrder>
    <RmaInboundCreateOrder>
      <Items>
        <RmaInboundCreateOrderItem>
          <CarrierCode>sample string 2</CarrierCode>
          <Extended xmlns:d6p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
            <d6p1:Extended>
              <d6p1:Additional>sample string 5</d6p1:Additional>
              <d6p1:ID>2</d6p1:ID>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:ReadOnly>true</d6p1:ReadOnly>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:Extended>
            <d6p1:Extended>
              <d6p1:Additional>sample string 5</d6p1:Additional>
              <d6p1:ID>2</d6p1:ID>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:ReadOnly>true</d6p1:ReadOnly>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:Extended>
          </Extended>
          <ExternalItemID>sample string 5</ExternalItemID>
          <GTIN>sample string 4</GTIN>
          <OrderItemID>6</OrderItemID>
          <PhysicalReturnNotRequired>true</PhysicalReturnNotRequired>
          <Quantity>1</Quantity>
          <ReturnLabelURL>sample string 12</ReturnLabelURL>
          <ReturnLocationID>13</ReturnLocationID>
          <ReturnNoCredit>true</ReturnNoCredit>
          <ReturnReasonID>9</ReturnReasonID>
          <ReturnReasonText>sample string 11</ReturnReasonText>
          <ReturnTypeID>10</ReturnTypeID>
          <SKU>sample string 3</SKU>
          <TrackingNumber>sample string 1</TrackingNumber>
        </RmaInboundCreateOrderItem>
        <RmaInboundCreateOrderItem>
          <CarrierCode>sample string 2</CarrierCode>
          <Extended xmlns:d6p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
            <d6p1:Extended>
              <d6p1:Additional>sample string 5</d6p1:Additional>
              <d6p1:ID>2</d6p1:ID>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:ReadOnly>true</d6p1:ReadOnly>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:Extended>
            <d6p1:Extended>
              <d6p1:Additional>sample string 5</d6p1:Additional>
              <d6p1:ID>2</d6p1:ID>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:ReadOnly>true</d6p1:ReadOnly>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:Extended>
          </Extended>
          <ExternalItemID>sample string 5</ExternalItemID>
          <GTIN>sample string 4</GTIN>
          <OrderItemID>6</OrderItemID>
          <PhysicalReturnNotRequired>true</PhysicalReturnNotRequired>
          <Quantity>1</Quantity>
          <ReturnLabelURL>sample string 12</ReturnLabelURL>
          <ReturnLocationID>13</ReturnLocationID>
          <ReturnNoCredit>true</ReturnNoCredit>
          <ReturnReasonID>9</ReturnReasonID>
          <ReturnReasonText>sample string 11</ReturnReasonText>
          <ReturnTypeID>10</ReturnTypeID>
          <SKU>sample string 3</SKU>
          <TrackingNumber>sample string 1</TrackingNumber>
        </RmaInboundCreateOrderItem>
      </Items>
      <OrderId>2</OrderId>
      <OrderNumber>sample string 1</OrderNumber>
      <ReturnLabelURL>sample string 5</ReturnLabelURL>
      <RmaProcessingCharge>4</RmaProcessingCharge>
      <ShippingCredit>3</ShippingCredit>
    </RmaInboundCreateOrder>
  </Orders>
  <RefundToGiftCard>true</RefundToGiftCard>
  <ReturnInvoiceNumber>sample string 2</ReturnInvoiceNumber>
  <RmaNumber>sample string 1</RmaNumber>
</RmaInboundCreate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>