POST api/OmsOrderSearch

Add new order note to an existing order in OMS

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PaymentDetails	string	None.
BillingFirstName	string	None.
BillingLastName	string	None.
BillingAddress1	string	None.
BillingAddress2	string	None.
BillingAddress3	string	None.
BillingCity	string	None.
BillingProvince	string	None.
BillingPostalCode	string	None.
BillingCountry	string	None.
BillingPhone	string	None.
BillingCompanyName	string	None.
ShippingFirstName	string	None.
ShippingLastName	string	None.
ShippingAddress1	string	None.
ShippingAddress2	string	None.
ShippingAddress3	string	None.
ShippingCity	string	None.
ShippingProvince	string	None.
ShippingPostalCode	string	None.
ShippingCountry	string	None.
ShippingPhone	string	None.
ShippingCompanyName	string	None.
Email	string	None.
RmaNumber	string	None.
OrderCreatedUTCStart	string	None.
OrderCreatedUTCEnd	string	None.
TrackingNumber	string	None.
OrderNumber	string	None.
SiteCodeSearch	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:

{
  "PaymentDetails": "sample string 1",
  "BillingFirstName": "sample string 2",
  "BillingLastName": "sample string 3",
  "BillingAddress1": "sample string 4",
  "BillingAddress2": "sample string 5",
  "BillingAddress3": "sample string 6",
  "BillingCity": "sample string 7",
  "BillingProvince": "sample string 8",
  "BillingPostalCode": "sample string 9",
  "BillingCountry": "sample string 10",
  "BillingPhone": "sample string 11",
  "BillingCompanyName": "sample string 12",
  "ShippingFirstName": "sample string 13",
  "ShippingLastName": "sample string 14",
  "ShippingAddress1": "sample string 15",
  "ShippingAddress2": "sample string 16",
  "ShippingAddress3": "sample string 17",
  "ShippingCity": "sample string 18",
  "ShippingProvince": "sample string 19",
  "ShippingPostalCode": "sample string 20",
  "ShippingCountry": "sample string 21",
  "ShippingPhone": "sample string 22",
  "ShippingCompanyName": "sample string 23",
  "Email": "sample string 24",
  "RmaNumber": "sample string 25",
  "OrderCreatedUTCStart": "sample string 26",
  "OrderCreatedUTCEnd": "sample string 27",
  "TrackingNumber": "sample string 28",
  "OrderNumber": "sample string 29",
  "SiteCodeSearch": "sample string 30",
  "SiteCode": "sample string 31",
  "VerificationKey": "sample string 32",
  "TimestampUTC": "sample string 33",
  "ResponseCallbackUri": "sample string 34",
  "APIUsername": "sample string 35",
  "IDToken": "sample string 36",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T23:39:26.4381847+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T23:39:26.4381847+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T23:39:26.4381847+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T23:39:26.4381847+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T23:39:26.4381847+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T23:39:26.4381847+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": 37,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<OmsOrderSearchRequest 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 35</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 36</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 34</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 31</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 33</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-20T23:39:26.4381847+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-20T23:39:26.4381847+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T23:39:26.4381847+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T23:39:26.4381847+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T23:39:26.4381847+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-20T23:39:26.4381847+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">37</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 32</VerificationKey>
  <BillingAddress1>sample string 4</BillingAddress1>
  <BillingAddress2>sample string 5</BillingAddress2>
  <BillingAddress3>sample string 6</BillingAddress3>
  <BillingCity>sample string 7</BillingCity>
  <BillingCompanyName>sample string 12</BillingCompanyName>
  <BillingCountry>sample string 10</BillingCountry>
  <BillingFirstName>sample string 2</BillingFirstName>
  <BillingLastName>sample string 3</BillingLastName>
  <BillingPhone>sample string 11</BillingPhone>
  <BillingPostalCode>sample string 9</BillingPostalCode>
  <BillingProvince>sample string 8</BillingProvince>
  <Email>sample string 24</Email>
  <OrderCreatedUTCEnd>sample string 27</OrderCreatedUTCEnd>
  <OrderCreatedUTCStart>sample string 26</OrderCreatedUTCStart>
  <OrderNumber>sample string 29</OrderNumber>
  <PaymentDetails>sample string 1</PaymentDetails>
  <RmaNumber>sample string 25</RmaNumber>
  <ShippingAddress1>sample string 15</ShippingAddress1>
  <ShippingAddress2>sample string 16</ShippingAddress2>
  <ShippingAddress3>sample string 17</ShippingAddress3>
  <ShippingCity>sample string 18</ShippingCity>
  <ShippingCompanyName>sample string 23</ShippingCompanyName>
  <ShippingCountry>sample string 21</ShippingCountry>
  <ShippingFirstName>sample string 13</ShippingFirstName>
  <ShippingLastName>sample string 14</ShippingLastName>
  <ShippingPhone>sample string 22</ShippingPhone>
  <ShippingPostalCode>sample string 20</ShippingPostalCode>
  <ShippingProvince>sample string 19</ShippingProvince>
  <SiteCodeSearch>sample string 30</SiteCodeSearch>
  <TrackingNumber>sample string 28</TrackingNumber>
</OmsOrderSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OmsOrderSearchResponse

Name	Type	Additional information
OrderSearchDetails	Collection of IOrderSearchResults	None.
ResponseCode	APIResponseCodes	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderSearchDetails": null,
  "ResponseCode": 0,
  "Message": "sample string 1"
}

application/xml, text/xml

Sample:

<OmsOrderSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <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>
  <OrderSearchDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</OmsOrderSearchResponse>