POST api/OmsInboundReturn

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OrderNumber	string	None.
Items	Collection of InboundReturnItem	None.
ReturnInvoiceNumber	string	None.
ReturnShippingCredit	decimal number	None.
InternalSalesNumber	string	None.
RmaNumber	string	None.
UnknownIdentifier	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:

{
  "OrderNumber": "sample string 1",
  "Items": [
    {
      "SKU": "sample string 1",
      "GTIN": "sample string 2",
      "ItemId": 3,
      "ReturnReasonId": 4,
      "ReturnReasonText": "sample string 5",
      "ReturnTypeId": 6,
      "ReturnNoCredit": true,
      "Quantity": 1,
      "Custom1": "sample string 8",
      "Custom2": "sample string 9",
      "Custom3": "sample string 10",
      "Custom4": "sample string 11",
      "Custom5": "sample string 12",
      "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
        }
      ],
      "PhysicalReturnNotRequired": true,
      "ExternalItemID": "sample string 14"
    },
    {
      "SKU": "sample string 1",
      "GTIN": "sample string 2",
      "ItemId": 3,
      "ReturnReasonId": 4,
      "ReturnReasonText": "sample string 5",
      "ReturnTypeId": 6,
      "ReturnNoCredit": true,
      "Quantity": 1,
      "Custom1": "sample string 8",
      "Custom2": "sample string 9",
      "Custom3": "sample string 10",
      "Custom4": "sample string 11",
      "Custom5": "sample string 12",
      "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
        }
      ],
      "PhysicalReturnNotRequired": true,
      "ExternalItemID": "sample string 14"
    }
  ],
  "ReturnInvoiceNumber": "sample string 2",
  "ReturnShippingCredit": 3.0,
  "InternalSalesNumber": "sample string 4",
  "RmaNumber": "sample string 5",
  "UnknownIdentifier": "sample string 6",
  "ReturnWarehouseCode": "sample string 7",
  "ReturnUser": "sample string 8",
  "IssueRefundToGiftCard": true,
  "GiftCardRecipientName": "sample string 10",
  "GiftCardRecipientEmail": "sample string 11",
  "SiteCode": "sample string 12",
  "VerificationKey": "sample string 13",
  "TimestampUTC": "sample string 14",
  "ResponseCallbackUri": "sample string 15",
  "APIUsername": "sample string 16",
  "IDToken": "sample string 17",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T14:44:19.1189305+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T14:44:19.1189305+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T14:44:19.1189305+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T14:44:19.1189305+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T14:44:19.1189305+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T14:44:19.1189305+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": 18,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<InboundReturn 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 16</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 17</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 15</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 12</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 14</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-20T14:44:19.1189305+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-20T14:44:19.1189305+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T14:44:19.1189305+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T14:44:19.1189305+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T14:44:19.1189305+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-20T14:44:19.1189305+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">18</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 13</VerificationKey>
  <GiftCardRecipientEmail>sample string 11</GiftCardRecipientEmail>
  <GiftCardRecipientName>sample string 10</GiftCardRecipientName>
  <InternalSalesNumber>sample string 4</InternalSalesNumber>
  <IssueRefundToGiftCard>true</IssueRefundToGiftCard>
  <Items>
    <InboundReturnItem>
      <Custom1>sample string 8</Custom1>
      <Custom2>sample string 9</Custom2>
      <Custom3>sample string 10</Custom3>
      <Custom4>sample string 11</Custom4>
      <Custom5>sample string 12</Custom5>
      <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 14</ExternalItemID>
      <GTIN>sample string 2</GTIN>
      <OrderItemID>3</OrderItemID>
      <PhysicalReturnNotRequired>true</PhysicalReturnNotRequired>
      <Quantity>1</Quantity>
      <ReturnNoCredit>true</ReturnNoCredit>
      <ReturnReasonId>4</ReturnReasonId>
      <ReturnReasonText>sample string 5</ReturnReasonText>
      <ReturnTypeId>6</ReturnTypeId>
      <SKU>sample string 1</SKU>
    </InboundReturnItem>
    <InboundReturnItem>
      <Custom1>sample string 8</Custom1>
      <Custom2>sample string 9</Custom2>
      <Custom3>sample string 10</Custom3>
      <Custom4>sample string 11</Custom4>
      <Custom5>sample string 12</Custom5>
      <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 14</ExternalItemID>
      <GTIN>sample string 2</GTIN>
      <OrderItemID>3</OrderItemID>
      <PhysicalReturnNotRequired>true</PhysicalReturnNotRequired>
      <Quantity>1</Quantity>
      <ReturnNoCredit>true</ReturnNoCredit>
      <ReturnReasonId>4</ReturnReasonId>
      <ReturnReasonText>sample string 5</ReturnReasonText>
      <ReturnTypeId>6</ReturnTypeId>
      <SKU>sample string 1</SKU>
    </InboundReturnItem>
  </Items>
  <OrderNumber>sample string 1</OrderNumber>
  <ReturnInvoiceNumber>sample string 2</ReturnInvoiceNumber>
  <ReturnShippingCredit>3</ReturnShippingCredit>
  <ReturnUser>sample string 8</ReturnUser>
  <ReturnWarehouseCode>sample string 7</ReturnWarehouseCode>
  <RmaNumber>sample string 5</RmaNumber>
  <UnknownIdentifier>sample string 6</UnknownIdentifier>
</InboundReturn>

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>