POST api/OmsCreateExchange

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
RmaNumber	string	Required String length: inclusive between 0 and 100
CaseNumber	string	String length: inclusive between 0 and 50
Order	ExchangeOrder	Required
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",
  "CaseNumber": "sample string 2",
  "Order": {
    "Address": {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "Address3": "sample string 5",
      "City": "sample string 6",
      "Province": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9"
    },
    "Items": [
      {
        "TrackingNumber": "sample string 1",
        "CarrierCode": "sample string 2",
        "ReturnLabelURL": "sample string 3",
        "ReturnSKU": "sample string 4",
        "ReturnGTIN": "sample string 5",
        "ReturnExternalItemID": "sample string 6",
        "OrderItemID": 7,
        "PhysicalReturnNotRequired": true,
        "ReturnReasonID": 9,
        "ReturnTypeID": 10,
        "Quantity": 11,
        "ReturnReasonText": "sample string 12",
        "ExchangeSKU": "sample string 13",
        "ExchangeGTIN": "sample string 14",
        "ExchangeItemCustom1": "sample string 15",
        "ExchangeItemCustom2": "sample string 16",
        "ExchangeItemCustom3": "sample string 17",
        "ExchangeItemCustom4": "sample string 18",
        "ExchangeItemCustom5": "sample string 19",
        "ExchangeItemImageURL": "sample string 20",
        "ExchangeItemProductSize": "sample string 21",
        "ExchangeItemStyleNumber": "sample string 22",
        "ExchangeItemAttribute": "sample string 23",
        "ExchangeItemExtended": [
          {
            "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
          }
        ],
        "ExchangeItemReturnable": true,
        "DeliveryType": 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
          }
        ]
      },
      {
        "TrackingNumber": "sample string 1",
        "CarrierCode": "sample string 2",
        "ReturnLabelURL": "sample string 3",
        "ReturnSKU": "sample string 4",
        "ReturnGTIN": "sample string 5",
        "ReturnExternalItemID": "sample string 6",
        "OrderItemID": 7,
        "PhysicalReturnNotRequired": true,
        "ReturnReasonID": 9,
        "ReturnTypeID": 10,
        "Quantity": 11,
        "ReturnReasonText": "sample string 12",
        "ExchangeSKU": "sample string 13",
        "ExchangeGTIN": "sample string 14",
        "ExchangeItemCustom1": "sample string 15",
        "ExchangeItemCustom2": "sample string 16",
        "ExchangeItemCustom3": "sample string 17",
        "ExchangeItemCustom4": "sample string 18",
        "ExchangeItemCustom5": "sample string 19",
        "ExchangeItemImageURL": "sample string 20",
        "ExchangeItemProductSize": "sample string 21",
        "ExchangeItemStyleNumber": "sample string 22",
        "ExchangeItemAttribute": "sample string 23",
        "ExchangeItemExtended": [
          {
            "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
          }
        ],
        "ExchangeItemReturnable": true,
        "DeliveryType": 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
          }
        ]
      }
    ],
    "OrderNumber": "sample string 1",
    "ExchangeOrderNumber": "sample string 2",
    "ReturnLabelURL": "sample string 3",
    "ExchangeShippingMethod": "sample string 4"
  },
  "SiteCode": "sample string 3",
  "VerificationKey": "sample string 4",
  "TimestampUTC": "sample string 5",
  "ResponseCallbackUri": "sample string 6",
  "APIUsername": "sample string 7",
  "IDToken": "sample string 8",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T21:35:24.0973122+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T21:35:24.0973122+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T21:35:24.0973122+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T21:35:24.0973122+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T21:35:24.0973122+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T21:35:24.0973122+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": 9,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<CreateExchangeRequest 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 7</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 8</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 6</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 3</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 5</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:35:24.0973122+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:35:24.0973122+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T21:35:24.0973122+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T21:35:24.0973122+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T21:35:24.0973122+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:35:24.0973122+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">9</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 4</VerificationKey>
  <CaseNumber>sample string 2</CaseNumber>
  <Order>
    <Address>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <Address3>sample string 5</Address3>
      <City>sample string 6</City>
      <Country>sample string 9</Country>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <PostalCode>sample string 8</PostalCode>
      <Province>sample string 7</Province>
    </Address>
    <ExchangeOrderNumber>sample string 2</ExchangeOrderNumber>
    <ExchangeShippingMethod>sample string 4</ExchangeShippingMethod>
    <Items>
      <ExchangeItem>
        <CarrierCode>sample string 2</CarrierCode>
        <DeliveryType>WarehouseShip</DeliveryType>
        <ExchangeGTIN>sample string 14</ExchangeGTIN>
        <ExchangeItemAttribute>sample string 23</ExchangeItemAttribute>
        <ExchangeItemCustom1>sample string 15</ExchangeItemCustom1>
        <ExchangeItemCustom2>sample string 16</ExchangeItemCustom2>
        <ExchangeItemCustom3>sample string 17</ExchangeItemCustom3>
        <ExchangeItemCustom4>sample string 18</ExchangeItemCustom4>
        <ExchangeItemCustom5>sample string 19</ExchangeItemCustom5>
        <ExchangeItemExtended xmlns:d5p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Common.Contracts.API">
          <d5p1:ExtendedImport>
            <d5p1:Additional>sample string 5</d5p1:Additional>
            <d5p1:ID>2</d5p1:ID>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:ReadOnly>true</d5p1:ReadOnly>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:ExtendedImport>
          <d5p1:ExtendedImport>
            <d5p1:Additional>sample string 5</d5p1:Additional>
            <d5p1:ID>2</d5p1:ID>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:ReadOnly>true</d5p1:ReadOnly>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:ExtendedImport>
        </ExchangeItemExtended>
        <ExchangeItemImageURL>sample string 20</ExchangeItemImageURL>
        <ExchangeItemProductSize>sample string 21</ExchangeItemProductSize>
        <ExchangeItemReturnable>true</ExchangeItemReturnable>
        <ExchangeItemStyleNumber>sample string 22</ExchangeItemStyleNumber>
        <ExchangeSKU>sample string 13</ExchangeSKU>
        <Extended xmlns:d5p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
          <d5p1:Extended>
            <d5p1:Additional>sample string 5</d5p1:Additional>
            <d5p1:ID>2</d5p1:ID>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:ReadOnly>true</d5p1:ReadOnly>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:Extended>
          <d5p1:Extended>
            <d5p1:Additional>sample string 5</d5p1:Additional>
            <d5p1:ID>2</d5p1:ID>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:ReadOnly>true</d5p1:ReadOnly>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:Extended>
        </Extended>
        <OrderItemID>7</OrderItemID>
        <PhysicalReturnNotRequired>true</PhysicalReturnNotRequired>
        <Quantity>11</Quantity>
        <ReturnExternalItemID>sample string 6</ReturnExternalItemID>
        <ReturnGTIN>sample string 5</ReturnGTIN>
        <ReturnLabelURL>sample string 3</ReturnLabelURL>
        <ReturnReasonID>9</ReturnReasonID>
        <ReturnReasonText>sample string 12</ReturnReasonText>
        <ReturnSKU>sample string 4</ReturnSKU>
        <ReturnTypeID>10</ReturnTypeID>
        <TrackingNumber>sample string 1</TrackingNumber>
      </ExchangeItem>
      <ExchangeItem>
        <CarrierCode>sample string 2</CarrierCode>
        <DeliveryType>WarehouseShip</DeliveryType>
        <ExchangeGTIN>sample string 14</ExchangeGTIN>
        <ExchangeItemAttribute>sample string 23</ExchangeItemAttribute>
        <ExchangeItemCustom1>sample string 15</ExchangeItemCustom1>
        <ExchangeItemCustom2>sample string 16</ExchangeItemCustom2>
        <ExchangeItemCustom3>sample string 17</ExchangeItemCustom3>
        <ExchangeItemCustom4>sample string 18</ExchangeItemCustom4>
        <ExchangeItemCustom5>sample string 19</ExchangeItemCustom5>
        <ExchangeItemExtended xmlns:d5p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Common.Contracts.API">
          <d5p1:ExtendedImport>
            <d5p1:Additional>sample string 5</d5p1:Additional>
            <d5p1:ID>2</d5p1:ID>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:ReadOnly>true</d5p1:ReadOnly>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:ExtendedImport>
          <d5p1:ExtendedImport>
            <d5p1:Additional>sample string 5</d5p1:Additional>
            <d5p1:ID>2</d5p1:ID>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:ReadOnly>true</d5p1:ReadOnly>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:ExtendedImport>
        </ExchangeItemExtended>
        <ExchangeItemImageURL>sample string 20</ExchangeItemImageURL>
        <ExchangeItemProductSize>sample string 21</ExchangeItemProductSize>
        <ExchangeItemReturnable>true</ExchangeItemReturnable>
        <ExchangeItemStyleNumber>sample string 22</ExchangeItemStyleNumber>
        <ExchangeSKU>sample string 13</ExchangeSKU>
        <Extended xmlns:d5p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
          <d5p1:Extended>
            <d5p1:Additional>sample string 5</d5p1:Additional>
            <d5p1:ID>2</d5p1:ID>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:ReadOnly>true</d5p1:ReadOnly>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:Extended>
          <d5p1:Extended>
            <d5p1:Additional>sample string 5</d5p1:Additional>
            <d5p1:ID>2</d5p1:ID>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:ReadOnly>true</d5p1:ReadOnly>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:Extended>
        </Extended>
        <OrderItemID>7</OrderItemID>
        <PhysicalReturnNotRequired>true</PhysicalReturnNotRequired>
        <Quantity>11</Quantity>
        <ReturnExternalItemID>sample string 6</ReturnExternalItemID>
        <ReturnGTIN>sample string 5</ReturnGTIN>
        <ReturnLabelURL>sample string 3</ReturnLabelURL>
        <ReturnReasonID>9</ReturnReasonID>
        <ReturnReasonText>sample string 12</ReturnReasonText>
        <ReturnSKU>sample string 4</ReturnSKU>
        <ReturnTypeID>10</ReturnTypeID>
        <TrackingNumber>sample string 1</TrackingNumber>
      </ExchangeItem>
    </Items>
    <OrderNumber>sample string 1</OrderNumber>
    <ReturnLabelURL>sample string 3</ReturnLabelURL>
  </Order>
  <RmaNumber>sample string 1</RmaNumber>
</CreateExchangeRequest>

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>