POST api/OmsInboundReferenceOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OrderNumber	string	None.
SiteCode	string	None.
CustomerID	string	None.
CustomerLocale	string	None.
OrderDate	date	None.
OrderStatusCode	string	None.
ShippingMethod	string	None.
MerchandiseNetTotal	decimal number	None.
MerchandiseGrossTotal	decimal number	None.
AdjustedMerchandiseNetTotal	decimal number	None.
AdjustedMerchandiseGrossTotal	decimal number	None.
ShippingNetTotal	decimal number	None.
ShippingGrossTotal	decimal number	None.
AdjustedShippingNetTotal	decimal number	None.
AdjustedShippingGrossTotal	decimal number	None.
OrderNetTotal	decimal number	None.
OrderGrossTotal	decimal number	None.
OrderTaxes	Collection of ReferenceTaxInput	None.
BillingFirstName	string	None.
BillingLastName	string	None.
BillingEmail	string	None.
BillingPhone	string	None.
BillingAddress	string	None.
BillingAddress2	string	None.
BillingAddress3	string	None.
BillingCity	string	None.
BillingProvince	string	None.
BillingPostalCode	string	None.
BillingCountry	string	None.
ShippingFirstName	string	None.
ShippingLastName	string	None.
ShippingEmail	string	None.
ShippingPhone	string	None.
ShippingAddress	string	None.
ShippingAddress2	string	None.
ShippingAddress3	string	None.
ShippingCity	string	None.
ShippingProvince	string	None.
ShippingPostalCode	string	None.
ShippingCountry	string	None.
OrderSource	string	None.
Custom1	string	None.
Custom2	string	None.
Custom3	string	None.
Custom4	string	None.
Custom5	string	None.
OrderItems	Collection of ReferenceOrderItemInput	None.
CustomAttributes	Collection of ReferenceCustomAttribute	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",
  "SiteCode": "sample string 2",
  "CustomerID": "sample string 3",
  "CustomerLocale": "sample string 4",
  "OrderDate": "2025-12-20T21:42:05.4244081+00:00",
  "OrderStatusCode": "sample string 6",
  "ShippingMethod": "sample string 7",
  "MerchandiseNetTotal": 8.0,
  "MerchandiseGrossTotal": 9.0,
  "AdjustedMerchandiseNetTotal": 10.0,
  "AdjustedMerchandiseGrossTotal": 11.0,
  "ShippingNetTotal": 12.0,
  "ShippingGrossTotal": 13.0,
  "AdjustedShippingNetTotal": 14.0,
  "AdjustedShippingGrossTotal": 15.0,
  "OrderNetTotal": 16.0,
  "OrderGrossTotal": 17.0,
  "OrderTaxes": [
    {
      "TaxType": "sample string 1",
      "TaxTypeID": 0,
      "Amount": 2.0,
      "TaxExempt": true
    },
    {
      "TaxType": "sample string 1",
      "TaxTypeID": 0,
      "Amount": 2.0,
      "TaxExempt": true
    }
  ],
  "BillingFirstName": "sample string 18",
  "BillingLastName": "sample string 19",
  "BillingEmail": "sample string 20",
  "BillingPhone": "sample string 21",
  "BillingAddress": "sample string 22",
  "BillingAddress2": "sample string 23",
  "BillingAddress3": "sample string 24",
  "BillingCity": "sample string 25",
  "BillingProvince": "sample string 26",
  "BillingPostalCode": "sample string 27",
  "BillingCountry": "sample string 28",
  "ShippingFirstName": "sample string 29",
  "ShippingLastName": "sample string 30",
  "ShippingEmail": "sample string 31",
  "ShippingPhone": "sample string 32",
  "ShippingAddress": "sample string 33",
  "ShippingAddress2": "sample string 34",
  "ShippingAddress3": "sample string 35",
  "ShippingCity": "sample string 36",
  "ShippingProvince": "sample string 37",
  "ShippingPostalCode": "sample string 38",
  "ShippingCountry": "sample string 39",
  "OrderSource": "sample string 40",
  "Custom1": "sample string 41",
  "Custom2": "sample string 42",
  "Custom3": "sample string 43",
  "Custom4": "sample string 44",
  "Custom5": "sample string 45",
  "OrderItems": [
    {
      "ItemStatusCode": "sample string 1",
      "GTIN": "sample string 2",
      "SKU": "sample string 3",
      "StyleNumber": "sample string 4",
      "Size": "sample string 5",
      "Attribute": "sample string 6",
      "ImageURL": "sample string 7",
      "NetPrice": 8.0,
      "GrossPrice": 9.0,
      "Custom1": "sample string 10",
      "Custom2": "sample string 11",
      "Custom3": "sample string 12",
      "Custom4": "sample string 13",
      "Custom5": "sample string 14",
      "OrderItemTaxes": [
        {
          "TaxType": "sample string 1",
          "TaxTypeID": 0,
          "Amount": 2.0,
          "TaxExempt": true
        },
        {
          "TaxType": "sample string 1",
          "TaxTypeID": 0,
          "Amount": 2.0,
          "TaxExempt": true
        }
      ],
      "WarehouseCode": "sample string 15",
      "WarehouseID": 0,
      "CustomAttributes": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "MasterNumber": null
    },
    {
      "ItemStatusCode": "sample string 1",
      "GTIN": "sample string 2",
      "SKU": "sample string 3",
      "StyleNumber": "sample string 4",
      "Size": "sample string 5",
      "Attribute": "sample string 6",
      "ImageURL": "sample string 7",
      "NetPrice": 8.0,
      "GrossPrice": 9.0,
      "Custom1": "sample string 10",
      "Custom2": "sample string 11",
      "Custom3": "sample string 12",
      "Custom4": "sample string 13",
      "Custom5": "sample string 14",
      "OrderItemTaxes": [
        {
          "TaxType": "sample string 1",
          "TaxTypeID": 0,
          "Amount": 2.0,
          "TaxExempt": true
        },
        {
          "TaxType": "sample string 1",
          "TaxTypeID": 0,
          "Amount": 2.0,
          "TaxExempt": true
        }
      ],
      "WarehouseCode": "sample string 15",
      "WarehouseID": 0,
      "CustomAttributes": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "MasterNumber": null
    }
  ],
  "CustomAttributes": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "VerificationKey": "sample string 46",
  "TimestampUTC": "sample string 47",
  "ResponseCallbackUri": "sample string 48",
  "APIUsername": "sample string 49",
  "IDToken": "sample string 50",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T21:42:05.4244081+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T21:42:05.4244081+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T21:42:05.4244081+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T21:42:05.4244081+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T21:42:05.4244081+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T21:42:05.4244081+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": 51,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<ReferenceOrderInput 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 49</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 50</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 48</ResponseCallbackUri>
  <SiteCode i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain" />
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 47</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:42:05.4244081+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:42:05.4244081+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T21:42:05.4244081+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T21:42:05.4244081+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T21:42:05.4244081+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:42:05.4244081+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">51</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 46</VerificationKey>
  <AdjustedMerchandiseGrossTotal>11</AdjustedMerchandiseGrossTotal>
  <AdjustedMerchandiseNetTotal>10</AdjustedMerchandiseNetTotal>
  <AdjustedShippingGrossTotal>15</AdjustedShippingGrossTotal>
  <AdjustedShippingNetTotal>14</AdjustedShippingNetTotal>
  <BillingAddress>sample string 22</BillingAddress>
  <BillingAddress2>sample string 23</BillingAddress2>
  <BillingAddress3>sample string 24</BillingAddress3>
  <BillingCity>sample string 25</BillingCity>
  <BillingCountry>sample string 28</BillingCountry>
  <BillingEmail>sample string 20</BillingEmail>
  <BillingFirstName>sample string 18</BillingFirstName>
  <BillingLastName>sample string 19</BillingLastName>
  <BillingPhone>sample string 21</BillingPhone>
  <BillingPostalCode>sample string 27</BillingPostalCode>
  <BillingProvince>sample string 26</BillingProvince>
  <Custom1>sample string 41</Custom1>
  <Custom2>sample string 42</Custom2>
  <Custom3>sample string 43</Custom3>
  <Custom4>sample string 44</Custom4>
  <Custom5>sample string 45</Custom5>
  <CustomAttributes>
    <ReferenceCustomAttribute>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </ReferenceCustomAttribute>
    <ReferenceCustomAttribute>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </ReferenceCustomAttribute>
  </CustomAttributes>
  <CustomerID>sample string 3</CustomerID>
  <CustomerLocale>sample string 4</CustomerLocale>
  <MerchandiseGrossTotal>9</MerchandiseGrossTotal>
  <MerchandiseNetTotal>8</MerchandiseNetTotal>
  <OrderDate>2025-12-20T21:42:05.4244081+00:00</OrderDate>
  <OrderGrossTotal>17</OrderGrossTotal>
  <OrderItems>
    <ReferenceOrderItemInput>
      <Attribute>sample string 6</Attribute>
      <Custom1>sample string 10</Custom1>
      <Custom2>sample string 11</Custom2>
      <Custom3>sample string 12</Custom3>
      <Custom4>sample string 13</Custom4>
      <Custom5>sample string 14</Custom5>
      <CustomAttributes>
        <ReferenceCustomAttribute>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </ReferenceCustomAttribute>
        <ReferenceCustomAttribute>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </ReferenceCustomAttribute>
      </CustomAttributes>
      <GTIN>sample string 2</GTIN>
      <GrossPrice>9</GrossPrice>
      <ImageURL>sample string 7</ImageURL>
      <ItemStatusCode>sample string 1</ItemStatusCode>
      <NetPrice>8</NetPrice>
      <OrderItemTaxes>
        <ReferenceTaxInput>
          <Amount>2</Amount>
          <TaxExempt>true</TaxExempt>
          <TaxType>sample string 1</TaxType>
        </ReferenceTaxInput>
        <ReferenceTaxInput>
          <Amount>2</Amount>
          <TaxExempt>true</TaxExempt>
          <TaxType>sample string 1</TaxType>
        </ReferenceTaxInput>
      </OrderItemTaxes>
      <SKU>sample string 3</SKU>
      <Size>sample string 5</Size>
      <StyleNumber>sample string 4</StyleNumber>
      <WarehouseCode>sample string 15</WarehouseCode>
    </ReferenceOrderItemInput>
    <ReferenceOrderItemInput>
      <Attribute>sample string 6</Attribute>
      <Custom1>sample string 10</Custom1>
      <Custom2>sample string 11</Custom2>
      <Custom3>sample string 12</Custom3>
      <Custom4>sample string 13</Custom4>
      <Custom5>sample string 14</Custom5>
      <CustomAttributes>
        <ReferenceCustomAttribute>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </ReferenceCustomAttribute>
        <ReferenceCustomAttribute>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </ReferenceCustomAttribute>
      </CustomAttributes>
      <GTIN>sample string 2</GTIN>
      <GrossPrice>9</GrossPrice>
      <ImageURL>sample string 7</ImageURL>
      <ItemStatusCode>sample string 1</ItemStatusCode>
      <NetPrice>8</NetPrice>
      <OrderItemTaxes>
        <ReferenceTaxInput>
          <Amount>2</Amount>
          <TaxExempt>true</TaxExempt>
          <TaxType>sample string 1</TaxType>
        </ReferenceTaxInput>
        <ReferenceTaxInput>
          <Amount>2</Amount>
          <TaxExempt>true</TaxExempt>
          <TaxType>sample string 1</TaxType>
        </ReferenceTaxInput>
      </OrderItemTaxes>
      <SKU>sample string 3</SKU>
      <Size>sample string 5</Size>
      <StyleNumber>sample string 4</StyleNumber>
      <WarehouseCode>sample string 15</WarehouseCode>
    </ReferenceOrderItemInput>
  </OrderItems>
  <OrderNetTotal>16</OrderNetTotal>
  <OrderNumber>sample string 1</OrderNumber>
  <OrderSource>sample string 40</OrderSource>
  <OrderStatusCode>sample string 6</OrderStatusCode>
  <OrderTaxes>
    <ReferenceTaxInput>
      <Amount>2</Amount>
      <TaxExempt>true</TaxExempt>
      <TaxType>sample string 1</TaxType>
    </ReferenceTaxInput>
    <ReferenceTaxInput>
      <Amount>2</Amount>
      <TaxExempt>true</TaxExempt>
      <TaxType>sample string 1</TaxType>
    </ReferenceTaxInput>
  </OrderTaxes>
  <ShippingAddress>sample string 33</ShippingAddress>
  <ShippingAddress2>sample string 34</ShippingAddress2>
  <ShippingAddress3>sample string 35</ShippingAddress3>
  <ShippingCity>sample string 36</ShippingCity>
  <ShippingCountry>sample string 39</ShippingCountry>
  <ShippingEmail>sample string 31</ShippingEmail>
  <ShippingFirstName>sample string 29</ShippingFirstName>
  <ShippingGrossTotal>13</ShippingGrossTotal>
  <ShippingLastName>sample string 30</ShippingLastName>
  <ShippingMethod>sample string 7</ShippingMethod>
  <ShippingNetTotal>12</ShippingNetTotal>
  <ShippingPhone>sample string 32</ShippingPhone>
  <ShippingPostalCode>sample string 38</ShippingPostalCode>
  <ShippingProvince>sample string 37</ShippingProvince>
  <SiteCode>sample string 2</SiteCode>
</ReferenceOrderInput>

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>