POST api/OmsGetOrdersByItemStatusCode

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
ItemStatusCode	string	None.
PageNumber	integer	None.
OldestOrdersFirst	boolean	None.
RowsPerPage	integer	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:

{
  "ItemStatusCode": "sample string 1",
  "PageNumber": 2,
  "OldestOrdersFirst": true,
  "RowsPerPage": 4,
  "SiteCode": "sample string 5",
  "VerificationKey": "sample string 6",
  "TimestampUTC": "sample string 7",
  "ResponseCallbackUri": "sample string 8",
  "APIUsername": "sample string 9",
  "IDToken": "sample string 10",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T22:00:11.3252009+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T22:00:11.3252009+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T22:00:11.3252009+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T22:00:11.3252009+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T22:00:11.3252009+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T22:00:11.3252009+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": 11,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<OrderByItemStatusCodeRequest 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 9</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 10</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 8</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 5</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 7</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-20T22:00:11.3252009+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-20T22:00:11.3252009+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T22:00:11.3252009+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T22:00:11.3252009+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T22:00:11.3252009+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-20T22:00:11.3252009+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">11</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 6</VerificationKey>
  <ItemStatusCode>sample string 1</ItemStatusCode>
  <OldestOrdersFirst>true</OldestOrdersFirst>
  <PageNumber>2</PageNumber>
  <RowsPerPage>4</RowsPerPage>
</OrderByItemStatusCodeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderByItemStatusCodeResponse

Name	Type	Additional Information
PageNumber	integer	None.
TotalPages	integer	None.
ResponseCode	APIResponseCodes	None.
Message	string	None.
Orders	Collection of IOrderByItemStatusCodeResponses	None.

Response Formats

application/json, text/json

Sample:

{
  "PageNumber": 1,
  "TotalPages": 2,
  "ResponseCode": 0,
  "Message": "sample string 3",
  "Orders": null
}

application/xml, text/xml

Sample:

<OrderByItemStatusCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <Message>sample string 3</Message>
  <Orders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <PageNumber>1</PageNumber>
  <ResponseCode>Success</ResponseCode>
  <TotalPages>2</TotalPages>
</OrderByItemStatusCodeResponse>